slimmer 12.1.0 → 13.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4fe9e4eda5103f993a3fa049fe354360ee1d61ea
-  data.tar.gz: b674f301bcc0452d3ce81634a4ab280625b6d69d
+  metadata.gz: 668e43ea2579afcef2047274b110c10f7a377560
+  data.tar.gz: eb7f475b36cda8923e92c230bb190121cea7badb
 SHA512:
-  metadata.gz: 130dff1f1186dce4297636f1bdb037f0a1d6448f61cd14a28bda29447ca41d310a92e9afa1952d1dc43adbe651d15645ee8434756fa65d0933009f4591f5b4b1
-  data.tar.gz: bddee67fbe4cef3c30bbc058c7bdec7cecd0d2974d802877190bba9131c3ce1051311fa8dfdcb72cd6723b519d898f95bf79127cb9b30fdd0730de6cda6cdb80
+  metadata.gz: d02f1d56e8dd317087cc6a237cedb52df633e7baad7e35cb36f5ec934d2adf6610d272fa1c76d05b2ee8883c553cc1d0cadf44c0932457ecb1e27e6448c157e4
+  data.tar.gz: 3937badf8181de169406b57a6ba2eed98250d49239f727e3fd1e5d80899872e53c2da45f7af7324777117a599935f414e658b800a53bf0ed6db041db30c9498a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 13.0.0
+
+* Drop cache TTL to 60 seconds.
+* BREAKING: Remove the component system, components are now consumed via the [govuk_publishing_components gem](https://github.com/alphagov/govuk_publishing_components)
+
 # 12.1.0
 
 * Make sure that the metatags defined in the application are inserted at the

data/README.md

@@ -15,8 +15,7 @@ Slimmer provides a Railtie so no configuration is necessary.
 
 ## Caching
 
-Slimmer makes HTTP requests to `static` for templates, components and locales. These
-are cached for 15 minutes. Slimmer uses `Rails.cache` for this.
+Slimmer makes HTTP requests to `static` for templates. These are cached using `Rails.cache`.
 
 ## Asset tag helpers
 
@@ -82,54 +81,6 @@ YourApp::Application.configure do
 end
 ```
 
-## GOV.UK Components
-
-To use [shared template components](https://govuk-static.herokuapp.com/component-guide) you need to include the GOV.UK component module:
-
-```rb
-class ApplicationController < ActionController::Base
-  include Slimmer::GovukComponents
-end
-```
-
-This will make calls out to static when you try and render a partial prefixed with `govuk_component`:
-
-```erb
-<%= render partial: 'govuk_component/example_component' %>
-```
-
-You will need a copy of static running for the templates to be loaded from.
-
-### Testing components
-
-In test mode (when `Rails.env.test?` returns `true`), shared components are not
-fetched from Static. Instead they are rendered as a dummy tag which contains a
-JSON dump of the `locals` - the arguments passed to the component.
-
-A test helper is included which returns a CSS selector for finding a given
-component to assert that it was used. You can make it available in your tests
-with:
-
-```rb
-require 'slimmer/test_helpers/govuk_components'
-include Slimmer::TestHelpers::GovukComponents
-```
-
-And then assert that the component has been used:
-
-```rb
-page.should have_css(shared_component_selector('metadata'))
-```
-
-Or look for one of the arguments to the component which will have been
-`JSON.dump`ed inside the tag:
-
-```rb
-within(shared_component_selector('title')) do
-  expect(page).to have_content(expected_title_text)
-end
-```
-
 ### Cucumber
 
 Add the following code to features/support:

data/lib/slimmer.rb

@@ -7,7 +7,7 @@ require 'slimmer/version'
 require 'slimmer/railtie' if defined? Rails
 
 module Slimmer
-  CACHE_TTL = 900
+  CACHE_TTL = 60
 
   def self.cache
     @cache ||= defined?(Rails) ? Rails.cache : NoCache.new
@@ -27,13 +27,6 @@ module Slimmer
   autoload :Headers, 'slimmer/headers'
   autoload :HTTPClient, 'slimmer/http_client'
 
-  autoload :GovukComponents, 'slimmer/govuk_components'
-  autoload :LocalGovukComponents, 'slimmer/local_govuk_components'
-  autoload :ComponentResolver, 'slimmer/component_resolver'
-  autoload :NetworkComponentResolver, 'slimmer/network_component_resolver'
-  autoload :LocalComponentResolver, 'slimmer/local_component_resolver'
-  autoload :I18nBackend, 'slimmer/i18n_backend'
-
   module Processors
     autoload :BodyClassCopier, 'slimmer/processors/body_class_copier'
     autoload :BodyInserter, 'slimmer/processors/body_inserter'

data/lib/slimmer/cucumber.rb

@@ -1,10 +1,3 @@
 require 'cucumber'
 
 require 'slimmer/test'
-require 'slimmer/test_helpers/govuk_components'
-
-World(Slimmer::TestHelpers::GovukComponents)
-
-Before do
-  stub_shared_component_locales
-end

data/lib/slimmer/rspec.rb

@@ -2,10 +2,3 @@ require 'rspec/core'
 
 require 'slimmer'
 require 'slimmer/test'
-require 'slimmer/test_helpers/govuk_components'
-
-RSpec.configure do |config|
-  config.include Slimmer::TestHelpers::GovukComponents
-
-  config.before { stub_shared_component_locales }
-end

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '12.1.0'
+  VERSION = '13.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 12.1.0
+  version: 13.0.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-19 00:00:00.000000000 Z
+date: 2018-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -234,16 +234,10 @@ files:
 - bin/render_slimmer_error
 - lib/slimmer.rb
 - lib/slimmer/app.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/local_component_resolver.rb
-- lib/slimmer/local_govuk_components.rb
-- lib/slimmer/network_component_resolver.rb
 - lib/slimmer/processors/body_class_copier.rb
 - lib/slimmer/processors/body_inserter.rb
 - lib/slimmer/processors/conditional_comment_mover.rb
@@ -262,7 +256,6 @@ files:
 - lib/slimmer/skin.rb
 - lib/slimmer/template.rb
 - lib/slimmer/test.rb
-- lib/slimmer/test_helpers/govuk_components.rb
 - lib/slimmer/test_templates/header_footer_only.html
 - lib/slimmer/test_templates/proposition_menu.html
 - lib/slimmer/test_templates/wrapper.html

data/lib/slimmer/component_resolver.rb

@@ -1,26 +0,0 @@
-module Slimmer
-  class ComponentResolver < ::ActionView::Resolver
-    TEST_TAG_NAME = 'test-govuk-component'
-
-    def find_templates(name, prefix, partial, details, outside_app_allowed = false)
-      return [] unless prefix == 'govuk_component'
-      template_path = [prefix, name].join('/')
-      details = {
-        :format => 'text/html',
-        :updated_at => Time.now,
-        :virtual_path => template_path
-      }
-
-      [ActionView::Template.new(template_body(template_path), template_path, erb_handler, details)]
-    end
-
-  private
-    def erb_handler
-      @erb_handler ||= ActionView::Template.registered_template_handler(:erb)
-    end
-
-    def template_body(_template_path)
-      raise NotImplementedError, "Use NetworkComponentResolver or LocalComponentResolver"
-    end
-  end
-end

data/lib/slimmer/govuk_components.rb

@@ -1,57 +0,0 @@
-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 GovukComponents.expiring_resolver_cache.resolver
-
-      return if slimmer_backend_included?
-      I18n.backend = I18n::Backend::Chain.new(I18n.backend, Slimmer::I18nBackend.new)
-    end
-
-    # @private
-    def self.expiring_resolver_cache
-      @expiring_resolver_cache ||= TimedExpirationResolverCache.new
-    end
-
-  private
-
-    def slimmer_backend_included?
-      I18n.backend.is_a?(I18n::Backend::Chain) &&
-        I18n.backend.backends.any? { |b| b.is_a? Slimmer::I18nBackend }
-    end
-
-    # Slimmer::ComponentResolver instantiates a lot of large objects and leaks
-    # memory. This class will cache the resolver so that it doesn't have to
-    # create new ActionView::Template objects for each request. The cache is
-    # timed to allow frontends to pick up changes made to components in `static`.
-    class TimedExpirationResolverCache
-      def initialize
-        @cache_last_reset = Time.now
-      end
-
-      def resolver
-        if (@cache_last_reset + Slimmer::CACHE_TTL) < Time.now
-          @resolver = nil
-          @cache_last_reset = Time.now
-        end
-
-        @resolver ||= Slimmer::NetworkComponentResolver.new
-      end
-    end
-  end
-end

data/lib/slimmer/i18n_backend.rb

@@ -1,56 +0,0 @@
-require 'json'
-require 'i18n'
-
-module Slimmer
-  class I18nBackend
-    include I18n::Backend::Base, I18n::Backend::Flatten
-
-    def available_locales
-      Slimmer.cache.fetch("available_locales", expires_in: Slimmer::CACHE_TTL) do
-        locale_json = fetch(static_locales_url)
-        JSON.parse(locale_json).map(&:to_sym)
-      end
-    end
-
-    def lookup(locale, key, scope = [], options = {})
-      key = normalize_flat_keys(locale, key, scope, options[:separator])
-      translations = translations(locale)
-      translations["#{locale}.#{key}".to_sym]
-    end
-
-  private
-
-    def translations(locale)
-      Slimmer.cache.fetch("translations/#{locale}", expires_in: Slimmer::CACHE_TTL) do
-        fetch_translations(locale)
-      end
-    end
-
-    def static_locales_url(locale=nil)
-      [static_host, "templates", "locales", locale].compact.join('/')
-    end
-
-    def static_host
-      @static_host ||= Plek.new.find('static')
-    end
-
-    def fetch_translations(locale)
-      url = static_locales_url(locale)
-      json_data = fetch(url)
-      translations = JSON.parse(json_data)
-      flatten_translations(locale, translations, false, false)
-    rescue TemplateNotFoundException
-      {}
-    end
-
-    def fetch(url)
-      HTTPClient.get(url)
-    rescue RestClient::Exception => e
-      raise TemplateNotFoundException, "Unable to fetch: '#{url}' because #{e}", caller
-    rescue Errno::ECONNREFUSED => e
-      raise CouldNotRetrieveTemplate, "Unable to fetch: '#{url}' because #{e}", caller
-    rescue SocketError => e
-      raise CouldNotRetrieveTemplate, "Unable to fetch: '#{url}' because #{e}", caller
-    end
-  end
-end

data/lib/slimmer/local_component_resolver.rb

@@ -1,19 +0,0 @@
-module Slimmer
-  class LocalComponentResolver < ComponentResolver
-  private
-
-    def template_body(template_path)
-      File.read(template_file(template_path))
-    end
-
-    def template_file(template_path)
-      path = template_path.sub(/\.raw(\.html\.erb)?$/, '')
-
-      if defined?(Rails)
-        Rails.root.join("app", "views", "#{path}.raw.html.erb")
-      else
-        "#{path}.raw.html.erb"
-      end
-    end
-  end
-end

data/lib/slimmer/local_govuk_components.rb

@@ -1,49 +0,0 @@
-module Slimmer
-  # @api public
-  #
-  # Include this module to avoid loading components over the network
-  # @example
-  #   class ApplicationController < ActionController::Base
-  #     include Slimmer::LocalGovukComponents
-  #   end
-  #
-  #   # In your views:
-  #
-  #   <%= render partial: 'govuk_component/example_component' %>
-  module LocalGovukComponents
-    def self.included into
-      into.before_action :add_govuk_components
-    end
-
-    # @private
-    def add_govuk_components
-      append_view_path LocalGovukComponents.expiring_resolver_cache.resolver
-    end
-
-    # @private
-    def self.expiring_resolver_cache
-      @expiring_resolver_cache ||= TimedExpirationResolverCache.new
-    end
-
-  private
-
-    # Slimmer::ComponentResolver instantiates a lot of large objects and leaks
-    # memory. This class will cache the resolver so that it doesn't have to
-    # create new ActionView::Template objects for each request. The cache is
-    # timed to allow frontends to pick up changes made to components in `static`.
-    class TimedExpirationResolverCache
-      def initialize
-        @cache_last_reset = Time.now
-      end
-
-      def resolver
-        if (@cache_last_reset + Slimmer::CACHE_TTL) < Time.now
-          @resolver = nil
-          @cache_last_reset = Time.now
-        end
-
-        @resolver ||= Slimmer::LocalComponentResolver.new
-      end
-    end
-  end
-end

data/lib/slimmer/network_component_resolver.rb

@@ -1,45 +0,0 @@
-require 'slimmer/govuk_request_id'
-require 'active_support/core_ext/string/inflections'
-
-module Slimmer
-  class NetworkComponentResolver < ComponentResolver
-  private
-
-    def template_body(template_path)
-      if test?
-        test_body(template_path)
-      else
-        Slimmer.cache.fetch(template_path, expires_in: Slimmer::CACHE_TTL) do
-          fetch(template_url(template_path))
-        end
-      end
-    end
-
-    def test?
-      defined?(Rails) && Rails.env.test?
-    end
-
-    def fetch(template_url)
-      HTTPClient.get(template_url)
-    rescue RestClient::Exception => e
-      raise TemplateNotFoundException, "Unable to fetch: '#{template_url}' because #{e}", caller
-    rescue Errno::ECONNREFUSED => e
-      raise CouldNotRetrieveTemplate, "Unable to fetch: '#{template_url}' because #{e}", caller
-    rescue SocketError => e
-      raise CouldNotRetrieveTemplate, "Unable to fetch: '#{template_url}' because #{e}", caller
-    end
-
-    def template_url(template_path)
-      path = template_path.sub(/\.raw(\.html\.erb)?$/, '')
-      [static_host, "templates", "#{path}.raw.html.erb"].join('/')
-    end
-
-    def static_host
-      @static_host ||= Plek.new.find('static')
-    end
-
-    def test_body(path)
-      %{<#{TEST_TAG_NAME} data-template="#{path.parameterize}"><%= JSON.dump(local_assigns) %></#{TEST_TAG_NAME}>}
-    end
-  end
-end

data/lib/slimmer/test_helpers/govuk_components.rb

@@ -1,18 +0,0 @@
-require 'webmock'
-
-module Slimmer
-  module TestHelpers
-    module GovukComponents
-      def stub_shared_component_locales
-        stub_request(:get, /https?:\/\/\S+.gov.uk\/templates\/locales\/.+/).
-          to_return(status: 400, headers: {})
-        stub_request(:get, /https?:\/\/\S+.gov.uk\/templates\/locales/).
-          to_return(status: 200, body: '{}', headers: {})
-      end
-
-      def shared_component_selector(name)
-        "#{Slimmer::ComponentResolver::TEST_TAG_NAME}[data-template='govuk_component-#{name}']"
-      end
-    end
-  end
-end