slimmer 10.0.0 → 10.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7b991ffcdf6cdee0c893b13695537a444d9272a
-  data.tar.gz: 06bfc18db4b43fd71a9348ea4d2bf0b24113311a
+  metadata.gz: 8d8d3bf6c4191d2dbb60bdb4859ae313ddc7e25a
+  data.tar.gz: 3ad0fc97a4e40aa30de1911e50668ec1d364c828
 SHA512:
-  metadata.gz: 9edba40f3ccaf964d893580121058a6b5aeba3d7d0112b068006c15251d941ac4960efeebeaec8347550b02364935daa82c602c1102951c47ac8e5cb7b5558dd
-  data.tar.gz: 46e4d0f6bab847439aca310d7e00d4b080e3b0ee2d6d44afc321b0d973550af13c7f4eedaaa3139b487810b3d10c50b812a4fee003868598d8185c7cadd68231
+  metadata.gz: 846af91deeafea3f421ee027ba1a8fafdb3986009ce5ebf26ac3aa3a16051d935fe5231cae0e86ccbf15875c3ee68fdc94fbaf65439904e875949eb9b1a25c00
+  data.tar.gz: fa20c579b4a3dcf79242f350fb0a270d0fd2bcdcc25bf577202689266fd9fee941b82496093baf19bae97b6ccd762089844d449ae4c44338fc1f1ab4886d5d70

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 10.1.0
+
+* Use `Rails.cache` as the cache for templates, locales and components. You can
+  remove `config.slimmer.use_cache` for your application, as you can no longer
+  opt-out of caching.
+* Add a `User-Agent` header to all outgoing API requests
+
 # 10.0.0
 
 * Removes the need_id meta tag, which is no longer used.

data/README.md

@@ -7,35 +7,16 @@ It does this by taking the page rendered by the application, extracting the cont
 a `div` with id 'wrapper' and inserting that into a `div` with the same id in one of its
 templates. It also transfers various other details, such as `meta`, `script`, and `style` tags.
 
-## Use in a Rails app
-
-Slimmer provides a Railtie so no configuration is necessary. By default it will use the
-Plek gem to look for the 'static' (previously 'assets') host for the current environment.
-
-If you want to use your own set of templates you will need to specify the appropriate host
-eg.
-
-```rb
-YourApp::Application.configure do
-  config.slimmer.asset_host = 'http://your.server.somewhere'
-end
-```
-
-it expects to find templates in a folder called 'templates' on that host.
+[View documentation](http://www.rubydoc.info/gems/slimmer)
 
-## Use elsewhere
-
-Slimmer will work as standard rack middleware:
+## Use in a Rails app
 
-```rb
-use Slimmer::App
-```
+Slimmer provides a Railtie so no configuration is necessary.
 
-or
+## Caching
 
-```rb
-use Slimmer::App, :asset_host => "http://my.alternative.host"
-```
+Slimmer makes HTTP requests to `static` for templates, components and locales. These
+are cached for 15 minutes. Slimmer uses `Rails.cache` for this.
 
 ## Asset tag helpers
 
@@ -164,9 +145,3 @@ Add the following code to spec/spec_helper:
 ```rb
 require 'slimmer/rspec'
 ```
-
-## The name
-
-Slimmer was extracted from a much larger project called 'skinner'. 'slimmer' referred to the size
-of its code compared to skinner (which also acted as an HTTP proxy and mixed in a few other
-concerns). Over time the codebase has grown a little, but the name stuck.

data/Rakefile

@@ -18,10 +18,4 @@ Rake::TestTask.new("test") do |t|
   t.verbose = true
 end
 
-require "gem_publisher"
-task :publish_gem do |t|
-  gem = GemPublisher.publish_if_updated("slimmer.gemspec", :rubygems)
-  puts "Published #{gem}" if gem
-end
-
 task :default => [:test, :lint]

data/lib/slimmer.rb

@@ -7,15 +7,25 @@ require 'slimmer/version'
 require 'slimmer/railtie' if defined? Rails
 
 module Slimmer
+  CACHE_TTL = 900
+
+  def self.cache
+    @cache ||= defined?(Rails) ? Rails.cache : NoCache.new
+  end
+
+  class NoCache
+    def fetch(*)
+      yield
+    end
+  end
 
   autoload :Railtie, 'slimmer/railtie'
   autoload :Skin, 'slimmer/skin'
 
-  autoload :Cache, 'slimmer/cache'
-
   autoload :Template, 'slimmer/template'
   autoload :App, 'slimmer/app'
   autoload :Headers, 'slimmer/headers'
+  autoload :HTTPClient, 'slimmer/http_client'
 
   autoload :GovukComponents, 'slimmer/govuk_components'
   autoload :ComponentResolver, 'slimmer/component_resolver'

data/lib/slimmer/app.rb

@@ -28,10 +28,7 @@ module Slimmer
         options[:asset_host] = Plek.current.find("static")
       end
 
-      cache = Cache.instance
-      cache.use_cache = options[:use_cache] if options[:use_cache]
-
-      @skin = Skin.new options.merge(logger: self.logger, cache: cache)
+      @skin = Skin.new options.merge(logger: self.logger)
     end
 
     def call(env)

data/lib/slimmer/component_resolver.rb

@@ -13,13 +13,12 @@ module Slimmer
 
     def find_templates(name, prefix, partial, details, outside_app_allowed = false)
       return [] unless prefix == 'govuk_component'
-      cache = Cache.instance
 
       template_path = [prefix, name].join('/')
       if test?
         template_body = test_body(template_path)
       else
-        template_body = cache.fetch(template_path) do
+        template_body = Slimmer.cache.fetch(template_path, expires_in: Slimmer::CACHE_TTL) do
           fetch(template_url(template_path))
         end
       end
@@ -43,10 +42,7 @@ module Slimmer
     end
 
     def fetch(template_url)
-      headers = {}
-      headers[:govuk_request_id] = GovukRequestId.value if GovukRequestId.set?
-      response = RestClient.get(template_url, headers)
-      response.body
+      HTTPClient.get(template_url)
     rescue RestClient::Exception => e
       raise TemplateNotFoundException, "Unable to fetch: '#{template_url}' because #{e}", caller
     rescue Errno::ECONNREFUSED => e

data/lib/slimmer/govuk_components.rb

@@ -1,9 +1,21 @@
 module Slimmer
+  # @api public
+  #
+  # Include this module to add the GOV.UK Components to your app.
+  # @example
+  #   class ApplicationController < ActionController::Base
+  #     include Slimmer::GovukComponents
+  #   end
+  #
+  #   # In your views:
+  #
+  #   <%= render partial: 'govuk_component/example_component' %>
   module GovukComponents
     def self.included into
       into.before_action :add_govuk_components
     end
 
+    # @private
     def add_govuk_components
       append_view_path Slimmer::ComponentResolver.new
 

data/lib/slimmer/govuk_request_id.rb

@@ -1,10 +1,6 @@
 module Slimmer
   class GovukRequestId
     class << self
-      def set?
-        !(value.nil? || value.empty?)
-      end
-
       def value
         Thread.current[:slimmer_govuk_request_id]
       end
@@ -15,4 +11,3 @@ module Slimmer
     end
   end
 end
-

data/lib/slimmer/headers.rb

@@ -1,9 +1,13 @@
 module Slimmer
+  # @api public
   module Headers
+    # @private
     InvalidHeader = Class.new(RuntimeError)
 
+    # @private
     HEADER_PREFIX = "X-Slimmer"
 
+    # @private
     SLIMMER_HEADER_MAPPING = {
       application_name:     "Application-Name",
       format:               "Format",
@@ -19,19 +23,57 @@ module Slimmer
       remove_search:        "Remove-Search",
     }
 
+    # @private
     APPLICATION_NAME_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:application_name]}"
+
+    # @private
     FORMAT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:format]}"
+
+    # @private
     ORGANISATIONS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:organisations]}"
+
+    # @private
     REPORT_A_PROBLEM_FORM = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:report_a_problem]}"
+
+    # @private
     WORLD_LOCATIONS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:world_locations]}"
+
+    # @private
     PAGE_OWNER_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:page_owner]}"
+
+    # @private
     RESULT_COUNT_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:result_count]}"
+
+    # @private
     SEARCH_PATH_HEADER = "#{HEADER_PREFIX}-Search-Path"
+
+    # @private
     SEARCH_PARAMETERS_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:search_parameters]}"
+
+    # @private
     SKIP_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:skip]}"
+
+    # @private
     TEMPLATE_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:template]}"
+
+    # @private
     REMOVE_SEARCH_HEADER = "#{HEADER_PREFIX}-#{SLIMMER_HEADER_MAPPING[:remove_search]}"
 
+    # Set the "slimmer headers" to configure the page
+    #
+    # @param hash [Hash] the options
+    # @option hash [String] application_name
+    # @option hash [String] format
+    # @option hash [String] organisations
+    # @option hash [String] page_owner
+    # @option hash [String] remove_search
+    # @option hash [String] report_a_problem
+    # @option hash [String] result_count
+    # @option hash [String] search_parameters
+    # @option hash [String] section
+    # @option hash [String] skip
+    # @option hash [String] template
+    # @option hash [String] world_locations
     def set_slimmer_headers(hash)
       raise InvalidHeader if (hash.keys - SLIMMER_HEADER_MAPPING.keys).any?
       SLIMMER_HEADER_MAPPING.each do |hash_key, header_suffix|

data/lib/slimmer/http_client.rb

@@ -0,0 +1,16 @@
+require "slimmer/govuk_request_id"
+require "restclient"
+
+module Slimmer
+  class HTTPClient
+    def self.get(url)
+      headers = {
+        user_agent: "slimmer/#{Slimmer::VERSION} (#{ENV['GOVUK_APP_NAME']})",
+        govuk_request_id: GovukRequestId.value,
+      }
+
+      response = RestClient.get(url, headers)
+      response.body
+    end
+  end
+end

data/lib/slimmer/i18n_backend.rb

@@ -5,7 +5,7 @@ module Slimmer
     include I18n::Backend::Base, I18n::Backend::Flatten
 
     def available_locales
-      cache.fetch("available_locales") do
+      Slimmer.cache.fetch(template_path, expires_in: Slimmer::CACHE_TTL) do
         locale_json = fetch(static_locales_url)
         locales = JSON.parse(locale_json).map(&:to_sym)
       end
@@ -19,12 +19,8 @@ module Slimmer
 
   private
 
-    def cache
-      Cache.instance
-    end
-
     def translations(locale)
-      cache.fetch("translations/#{locale}") do
+      Slimmer.cache.fetch("translations/#{locale}", expires_in: Slimmer::CACHE_TTL) do
         fetch_translations(locale)
       end
     end
@@ -47,10 +43,7 @@ module Slimmer
     end
 
     def fetch(url)
-      headers = {}
-      headers[:govuk_request_id] = GovukRequestId.value if GovukRequestId.set?
-      response = RestClient.get(url, headers)
-      response.body
+      HTTPClient.get(url)
     rescue RestClient::Exception => e
       raise TemplateNotFoundException, "Unable to fetch: '#{url}' because #{e}", caller
     rescue Errno::ECONNREFUSED => e

data/lib/slimmer/skin.rb

@@ -3,29 +3,25 @@ require 'slimmer/govuk_request_id'
 
 module Slimmer
   class Skin
-    attr_accessor :template_cache, :asset_host, :logger, :strict, :options
+    attr_accessor :asset_host, :logger, :strict, :options
 
     def initialize options = {}
       @options = options
       @asset_host = options[:asset_host]
-      @template_cache = options[:cache]
 
       @logger = options[:logger] || NullLogger.instance
       @strict = options[:strict] || (%w{development test}.include?(ENV['RACK_ENV']))
     end
 
     def template(template_name)
-      template_cache.fetch(template_name) do
+      Slimmer.cache.fetch(template_name, expires_in: Slimmer::CACHE_TTL) do
         load_template(template_name)
       end
     end
 
     def load_template(template_name)
       url = template_url(template_name)
-      headers = {}
-      headers[:govuk_request_id] = GovukRequestId.value if GovukRequestId.set?
-      response = RestClient.get(url, headers)
-      response.body
+      HTTPClient.get(url)
     rescue RestClient::Exception => e
       raise TemplateNotFoundException, "Unable to fetch: '#{template_name}' from '#{url}' because #{e}", caller
     rescue Errno::ECONNREFUSED, SocketError, OpenSSL::SSL::SSLError => e

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '10.0.0'
+  VERSION = '10.1.0'
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 10.0.0
+  version: 10.1.0
 platform: ruby
 authors:
-- Ben Griffiths
-- James Stewart
+- GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-15 00:00:00.000000000 Z
+date: 2017-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -115,6 +114,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -185,20 +198,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.18.0
-- !ruby/object:Gem::Dependency
-  name: gem_publisher
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -229,8 +228,7 @@ dependencies:
         version: 0.5.1
 description: Rack middleware for skinning pages using a specific template
 email:
-- bengriffiths@gmail.com
-- james.stewart@digital.cabinet-office.gov.uk
+- govuk-dev@digital.cabinet-office.gov.uk
 executables:
 - render_slimmer_error
 extensions: []
@@ -242,12 +240,12 @@ files:
 - bin/render_slimmer_error
 - lib/slimmer.rb
 - lib/slimmer/app.rb
-- lib/slimmer/cache.rb
 - lib/slimmer/component_resolver.rb
 - lib/slimmer/cucumber.rb
 - lib/slimmer/govuk_components.rb
 - lib/slimmer/govuk_request_id.rb
 - lib/slimmer/headers.rb
+- lib/slimmer/http_client.rb
 - lib/slimmer/i18n_backend.rb
 - lib/slimmer/processors/body_class_copier.rb
 - lib/slimmer/processors/body_inserter.rb
@@ -274,31 +272,6 @@ files:
 - lib/slimmer/version.rb
 - lib/tasks/lint.rake
 - lib/tasks/slimmer.rake
-- test/cache_test.rb
-- test/changelog_test.rb
-- test/component_resolver_test.rb
-- test/fixtures/404.html.erb
-- test/fixtures/410.html.erb
-- test/fixtures/500.html.erb
-- test/fixtures/core_layout.html.erb
-- test/fixtures/proposition_menu.html.erb
-- test/fixtures/report_a_problem.raw.html.erb
-- test/headers_test.rb
-- test/processors/body_inserter_test.rb
-- test/processors/header_context_inserter_test.rb
-- test/processors/inside_header_inserter_test.rb
-- test/processors/metadata_inserter_test.rb
-- test/processors/navigation_mover_test.rb
-- test/processors/report_a_problem_inserter_test.rb
-- test/processors/search_parameter_inserter_test.rb
-- test/processors/search_path_setter_test.rb
-- test/processors/search_remover_test.rb
-- test/processors/tag_mover_test.rb
-- test/skin_test.rb
-- test/test_helper.rb
-- test/test_helpers/govuk_components_test.rb
-- test/test_template_dependency_on_static_test.rb
-- test/typical_usage_test.rb
 homepage: http://github.com/alphagov/slimmer
 licenses:
 - MIT
@@ -323,29 +296,4 @@ rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Thinner than the skinner
-test_files:
-- test/headers_test.rb
-- test/processors/body_inserter_test.rb
-- test/processors/search_path_setter_test.rb
-- test/processors/navigation_mover_test.rb
-- test/processors/report_a_problem_inserter_test.rb
-- test/processors/inside_header_inserter_test.rb
-- test/processors/tag_mover_test.rb
-- test/processors/search_parameter_inserter_test.rb
-- test/processors/search_remover_test.rb
-- test/processors/metadata_inserter_test.rb
-- test/processors/header_context_inserter_test.rb
-- test/test_template_dependency_on_static_test.rb
-- test/test_helper.rb
-- test/typical_usage_test.rb
-- test/skin_test.rb
-- test/component_resolver_test.rb
-- test/fixtures/core_layout.html.erb
-- test/fixtures/report_a_problem.raw.html.erb
-- test/fixtures/410.html.erb
-- test/fixtures/404.html.erb
-- test/fixtures/500.html.erb
-- test/fixtures/proposition_menu.html.erb
-- test/test_helpers/govuk_components_test.rb
-- test/cache_test.rb
-- test/changelog_test.rb
+test_files: []