slimmer 11.0.2 → 11.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0bf16d4e2f2259c21173a5fd0015a810adb3f34c
-  data.tar.gz: 02012c14551c9b5111bce08210a024aa25929075
+  metadata.gz: 387557200b31b5f4fa4cda08f9286ce17dee3f7e
+  data.tar.gz: 944392917f3c40742d123597aa9618d3034bbf9e
 SHA512:
-  metadata.gz: 49b50c6ce47b18d9e68950e15facdec3823429a046a4847f3737a92c85bb1f18867d52c53fe8b36f4aa52a9b05f3c734fecc05ce9d43698d7e05b54f97f0f6ac
-  data.tar.gz: c0f31d7cc3f946664e1d258f308e8099c822e49c63c3ce4e14cb585f3e85999a51560945666c1f7d59f550683d368bbc2d59e927e5cc7d283453655dc64c7926
+  metadata.gz: 500f77c015043040668fb179f29579de3595bfc7ea36c46f3a7d72fb73714469631d3bccf0aff83fe048e8a128f84527f949db0e8525f046095bd73df69bbee9
+  data.tar.gz: 252d342dbb50d38f6fab78738850298d18ef20cbd917ea0963bb5fa1f877e8b02b1c5511a0bea8cebae0f5d0751dd6d897ed179b177d1d9cb4ee9f04be0992b9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 11.1.0
+
+* Allow components in static to be loaded locally rather than over the network (#208)
+* Replace deprecated `after_filter` in slimmer_template (#209)
+
 # 11.0.2
 
 * Add missing class tags to test templates for including Slimmer in tests

data/lib/slimmer/component_resolver.rb

@@ -1,61 +1,26 @@
-require 'slimmer/govuk_request_id'
-require 'active_support/core_ext/string/inflections'
-
 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('/')
-      if test?
-        template_body = test_body(template_path)
-      else
-        template_body = Slimmer.cache.fetch(template_path, expires_in: Slimmer::CACHE_TTL) do
-          fetch(template_url(template_path))
-        end
-      end
-
       details = {
         :format => 'text/html',
         :updated_at => Time.now,
         :virtual_path => template_path
       }
 
-      [ActionView::Template.new(template_body, template_path, erb_handler, details)]
+      [ActionView::Template.new(template_body(template_path), template_path, erb_handler, details)]
     end
 
   private
-    def test?
-      defined?(Rails) && Rails.env.test?
-    end
-
     def erb_handler
       @erb_handler ||= ActionView::Template.registered_template_handler(:erb)
     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)
-      %Q{<#{TEST_TAG_NAME} data-template="#{path.parameterize}"><%= JSON.dump(local_assigns) %></#{TEST_TAG_NAME}>}
+    def template_body(_template_path)
+      raise NotImplementedError, "Use NetworkComponentResolver or LocalComponentResolver"
     end
   end
 end

data/lib/slimmer/govuk_components.rb

@@ -50,7 +50,7 @@ module Slimmer
           @cache_last_reset = Time.now
         end
 
-        @resolver ||= Slimmer::ComponentResolver.new
+        @resolver ||= Slimmer::NetworkComponentResolver.new
       end
     end
   end

data/lib/slimmer/local_component_resolver.rb

@@ -0,0 +1,19 @@
+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

@@ -0,0 +1,49 @@
+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

@@ -0,0 +1,45 @@
+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/template.rb

@@ -11,7 +11,7 @@ module Slimmer
 
     module ClassMethods
       def slimmer_template template_name
-        after_filter do
+        after_action do
           response.headers[Slimmer::Headers::TEMPLATE_HEADER] ||= template_name.to_s
         end
       end

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '11.0.2'
+  VERSION = '11.1.0'
 end

data/lib/slimmer.rb

@@ -28,7 +28,10 @@ module Slimmer
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 11.0.2
+  version: 11.1.0
 platform: ruby
 authors:
 - GOV.UK Dev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -241,6 +241,9 @@ files:
 - 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