slimmer 4.1.1 → 4.2.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 4.2.0
+
+* Add ability to load shared erb templates over the network
+
 # 4.1.1
 
 * Assets are loaded from production instead of preview environment in test mode

data/README.md

@@ -1,5 +1,5 @@
-Slimmer provides Rack middleware for applying a standard header and footer around pages 
-returned by a Ruby (Rack) application. 
+Slimmer provides Rack middleware for applying a standard header and footer around pages
+returned by a Ruby (Rack) application.
 
 It does this by taking the page rendered by the application, extracting the contents of
 a `div` with id 'wrapper' and inserting that into a `div` with the same id in one of its
@@ -31,7 +31,7 @@ or
 
 ## Asset tag helpers
 
-To get asset tag helpers to point to your external asset server, add 
+To get asset tag helpers to point to your external asset server, add
 
     config.action_controller.asset_host = "http://my.alternative.host"
     
@@ -39,7 +39,7 @@ to `application.rb`.
 
 ## Specifying a template
 
-A specific template can be requested by giving its name in the `X-Slimmer-Template` HTTP header. 
+A specific template can be requested by giving its name in the `X-Slimmer-Template` HTTP header.
 
 In a controller action, you can do this by calling `slimmer_template`.
 
@@ -81,8 +81,30 @@ By default if you pass in a logger with its log level set to `debug`, slimmer wi
       config.slimmer.enable_debugging = true
     end
 
+## Shared components
+
+To use shared template components you need to include the shared template resolver
+
+    class ApplicationController < ActionController::Base
+      include Slimmer::SharedTemplates
+    end
+
+This will make calls out to static when you try and render a partial prefixed with `govuk-component`:
+
+    <%= render partial: 'govuk-component/example_component' %>
+
+You will need a copy of static running for the templates to be loaded from.
+
+### Testing shared components
+
+There is a test helper which can produce a CSS selector for a given component.
+This can then be incorporated into your test framework of choice to assert that
+the component is called. For example:
+
+    page.should have_css(shared_component_selector('metadata'))
+
 ## 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 
+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/lib/slimmer.rb

@@ -22,6 +22,9 @@ module Slimmer
   autoload :Headers, 'slimmer/headers'
   autoload :Artefact, 'slimmer/artefact'
 
+  autoload :SharedTemplates, 'slimmer/shared_templates'
+  autoload :ComponentResolver, 'slimmer/component_resolver'
+
   module Processors
     autoload :AlphaLabelInserter, 'slimmer/processors/alpha_label_inserter'
     autoload :BetaNoticeInserter, 'slimmer/processors/beta_notice_inserter'

data/lib/slimmer/component_resolver.rb

@@ -0,0 +1,59 @@
+require 'slimmer/govuk_request_id'
+require 'active_support/core_ext/string/inflections'
+
+module Slimmer
+  class ComponentResolver < ::ActionView::Resolver
+    def find_templates(name, prefix, partial, details)
+      return [] unless prefix == 'govuk_component'
+
+      template_path = [prefix, name].join('/')
+      if test?
+        template_body = test_body(template_path)
+      else
+        template_body = fetch(template_url(template_path))
+      end
+
+      details = {
+        :format => 'text/html',
+        :updated_at => Time.now,
+        :virtual_path => template_path
+      }
+
+      [ActionView::Template.new(template_body, 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)
+      headers = {}
+      headers[:govuk_request_id] = GovukRequestId.value if GovukRequestId.set?
+      response = RestClient.get(template_url, headers)
+      response.body
+    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)
+      [static_host, "templates", "#{template_path}.raw.html.erb"].join('/')
+    end
+
+    def static_host
+      @static_host ||= Plek.new.find('static')
+    end
+
+    def test_body(path)
+      %Q{<div class="#{path.parameterize}"><%= local_assigns.keys.join(' ') %></div>}
+    end
+  end
+end

data/lib/slimmer/shared_templates.rb

@@ -0,0 +1,11 @@
+module Slimmer
+  module SharedTemplates
+    def self.included into
+      into.before_filter :add_shared_templates
+    end
+
+    def add_shared_templates
+      append_view_path Slimmer::ComponentResolver.new
+    end
+  end
+end

data/lib/slimmer/test_helpers/shared_templates.rb

@@ -0,0 +1,9 @@
+module Slimmer
+  module TestHelpers
+    module SharedTemplates
+      def shared_component_selector(name)
+        "div[class='govuk_component-#{name}']"
+      end
+    end
+  end
+end

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '4.1.1'
+  VERSION = '4.2.0'
 end

data/test/component_resolver_test.rb

@@ -0,0 +1,29 @@
+require_relative "test_helper"
+
+describe Slimmer::ComponentResolver do
+  describe "find_templates" do
+    before do
+      @resolver = Slimmer::ComponentResolver.new
+    end
+
+    it "should return nothing if the prefix doesn't match 'govuk_component'" do
+      assert_equal [], @resolver.find_templates('name', 'prefix', false, {})
+    end
+
+    it "should request a valid template from the server" do
+      expected_url = "http://static.dev.gov.uk/templates/govuk_component/name.raw.html.erb"
+      stub_request(:get, expected_url).to_return :body => "<foo />"
+
+      templates = @resolver.find_templates('name', 'govuk_component', false, {})
+      assert_requested :get, expected_url
+      assert_equal '<foo />', templates.first.args[0]
+    end
+
+    it "should return a known template in test mode" do
+      @resolver.expects(:test?).returns(true)
+
+      templates = @resolver.find_templates('name', 'govuk_component', false, {})
+      assert_match /<div class="govuk_component-name">/, templates.first.args[0]
+    end
+  end
+end

data/test/test_helper.rb

@@ -42,6 +42,23 @@ end
 require 'webmock/minitest'
 WebMock.disable_net_connect!
 
+# Including action_view is dificualt because it depends on rails and internal
+# ~*magic*~. To avoid depending on the whole of rails mock out the method we
+# need so we can tests the internal implementations which don't depend on rails
+module ActionView
+  class Resolver
+  end
+  class Template
+    attr_reader :args
+    def initialize(*args)
+      @args = args
+    end
+    def self.registered_template_handler(*args)
+      args
+    end
+  end
+end
+
 class SlimmerIntegrationTest < MiniTest::Unit::TestCase
   include Rack::Test::Methods
   include GdsApi::TestHelpers::ContentApi

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 4.1.1
+  version: 4.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -252,6 +252,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.13
 description: Rack middleware for skinning pages using a specific template
 email:
 - bengriffiths@gmail.com
@@ -274,9 +290,12 @@ files:
 - lib/slimmer/test_templates/beta_label.html
 - lib/slimmer/test.rb
 - lib/slimmer/version.rb
+- lib/slimmer/test_helpers/shared_templates.rb
 - lib/slimmer/artefact.rb
+- lib/slimmer/shared_templates.rb
 - lib/slimmer/govuk_request_id.rb
 - lib/slimmer/template.rb
+- lib/slimmer/component_resolver.rb
 - lib/slimmer/processors/header_context_inserter.rb
 - lib/slimmer/processors/navigation_mover.rb
 - lib/slimmer/processors/google_analytics_configurator.rb
@@ -298,6 +317,7 @@ files:
 - lib/tasks/slimmer.rake
 - lib/slimmer.rb
 - Rakefile
+- test/component_resolver_test.rb
 - test/changelog_test.rb
 - test/typical_usage_test.rb
 - test/skin_test.rb
@@ -343,7 +363,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3014844610957979413
+      hash: 3545050969228992216
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -352,7 +372,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3014844610957979413
+      hash: 3545050969228992216
 requirements: []
 rubyforge_project: slimmer
 rubygems_version: 1.8.23
@@ -360,6 +380,7 @@ signing_key:
 specification_version: 3
 summary: Thinner than the skinner
 test_files:
+- test/component_resolver_test.rb
 - test/changelog_test.rb
 - test/typical_usage_test.rb
 - test/skin_test.rb