slimmer 0.9.0.beta4 → 1.0.0

data/lib/slimmer.rb

@@ -15,7 +15,14 @@ module Slimmer
     def initialize(app, *args, &block)
       options = args.first || {}
       @app = app
-      @skin = Skin.new(options[:asset_host], options[:template_path])
+
+      if options.key? :template_path
+        raise "Template path should not be used. Use asset_host instead."
+      end
+
+      raise "Provide an asset_host" unless options[:asset_host]
+
+      @skin = Skin.new options[:asset_host]
     end
 
     def call(env)
@@ -149,6 +156,9 @@ module Slimmer
       meta_link = dest.at_css('meta[name="x-section-link"]')
       list = dest.at_css('nav[role=navigation] ol')
 
+      # FIXME: Presumably this is meant to stop us adding a 'current section'
+      # link if we're missing navigation, or x-section-* meta tags.
+      # It doesn't work: #at_css will return a truthy object in any case.
       if meta_name && meta_link && list
         link_node = Nokogiri::XML::Node.new('a', dest)
         link_node['href'] = meta_link['content']
@@ -237,48 +247,53 @@ module Slimmer
   end
 
   class Skin
+    attr_accessor :templated_cache
+    private :templated_cache=, :templated_cache
+
+    attr_accessor :asset_host
+    private :asset_host=, :asset_host
 
-    def initialize(asset_host = nil, template_path = nil)
-      @template_path = template_path || File.expand_path("../../templates", __FILE__)
-      @asset_host = asset_host
-      @template = {}
+    def initialize asset_host
+      self.asset_host = asset_host
+      self.templated_cache = {}
     end
 
     def template(template_name)
-      if templates_are_local?
-        load_template(template_name)
-      else
-        @template[template_name] ||= load_template(template_name)
-      end
+      return cached_template(template_name) if template_cached? template_name
+      load_template template_name
     end
 
-    def load_template(template_name)
-      source = open("#{template_path}/#{template_name}.html.erb", "r:UTF-8").read
-      ERB.new(source).result binding
+    def template_cached? name
+      !cached_template(name).nil?
     end
 
-    def template_path
-      return (@asset_host.to_s + '/templates') unless @asset_host.nil?
-      @template_path
+    def cached_template name
+      templated_cache[name]
     end
 
-    def templates_are_local?
-      !@asset_host.nil?
+    def cache name, template
+      templated_cache[name] = template
     end
 
-    def unparse_esi(doc)
-      ## HTML doesn't really have namespaces, and nokogiri's
-      ## default behaviour is to strip the namespace, but to
-      ## leave the tag name intact. Ugly hack here to reverse
-      ## that for ESI includes
-      doc.gsub("<include","<esi:include").gsub(/><\/(esi:)?include>/, ' />')
+    def load_template template_name
+      url = template_url template_name
+      source = open(url, "r:UTF-8").read
+      template = ERB.new(source).result binding
+      cache template_name, template
+      template
+    end
+
+    def template_url template_name
+      host = asset_host.dup
+      host += '/' unless host =~ /\/$/
+      "#{host}templates/#{template_name}.html.erb"
     end
 
     def error(request, template_name, body)
       processors = [
         TitleInserter.new()
       ]
-      self.process(processors, body, template(template_name))
+      process(processors, body, template(template_name))
     end
 
     def process(processors,body,template)
@@ -289,7 +304,7 @@ module Slimmer
         p.filter(src,dest)
       end
 
-      return unparse_esi(dest.to_html)
+      return dest.to_html
     end
 
     def admin(request,body)
@@ -301,11 +316,10 @@ module Slimmer
         BodyInserter.new(),
         BodyClassCopier.new
       ]
-      self.process(processors,body,template('admin'))
+      process(processors,body,template('admin'))
     end
 
     def success(request,body)
-
       processors = [
         TitleInserter.new(),
         TagMover.new(),
@@ -315,7 +329,7 @@ module Slimmer
       ]
 
       template_name = request.env.has_key?(TEMPLATE_HEADER) ? request.env[TEMPLATE_HEADER] : 'wrapper'
-      self.process(processors,body,template(template_name))
+      process(processors,body,template(template_name))
     end
   end
 

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '0.9.0.beta4'
+  VERSION = '1.0.0'
 end

data/test/fixtures/404.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Slimmer, yay!</title>
+  </head>
+  <body>
+    <div class="content">
+      <header><h1>Oops! We can't find what you're looking for.</h1></header>
+      <div id="wrapper" class="group">
+      </div>
+    </div>
+  </body>
+</html>

data/test/fixtures/500.html.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Slimmer, yay!</title>
+  </head>
+  <body>
+    <div class="content">
+      <header><h1>We seem to be having a problem.</h1></header>
+      <div id="wrapper" class="group">
+      </div>
+    </div>
+  </body>
+</html>

data/test/fixtures/wrapper.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Slimmer, yay!</title>
+  </head>
+  <body>
+    <div class="content">
+      <header><h1>I AM A TITLE</h1></header>
+      <nav role="navigation"><ol><li>MySite</li></ol></nav>
+      <div id="wrapper" class="group">
+      </div>
+    </div>
+  </body>
+</html>

data/test/slimmer_test.rb

@@ -2,7 +2,13 @@ require "test_helper"
 
 class TestSlimmer < MiniTest::Unit::TestCase
   def test_template_can_be_loaded
-    s = Slimmer::Skin.new
-    assert s.load_template('wrapper')
+    skin = Slimmer::Skin.new "http://example.local/"
+    expected_url = "http://example.local/templates/example.html.erb"
+    stub_request(:get, expected_url).to_return :body => "<foo />"
+
+    template = skin.load_template 'example'
+
+    assert_requested :get, "http://example.local/templates/example.html.erb"
+    assert_equal "<foo />", template
   end
-end
+end

data/test/test_helper.rb

@@ -1,6 +1,9 @@
 require_relative '../lib/slimmer'
 require 'minitest/autorun'
 require 'rack/test'
+require 'webmock/minitest'
+
+WebMock.disable_net_connect!
 
 class MiniTest::Unit::TestCase
   def as_nokogiri(html_string)
@@ -20,10 +23,25 @@ class SlimmerIntegrationTest < MiniTest::Unit::TestCase
       inner_app = proc { |env|
         [code, headers.merge("Content-Type" => "text/html"), body]
       }
-      Slimmer::App.new(inner_app)
+      Slimmer::App.new inner_app, :asset_host => "http://template.local"
+    end
+
+    define_method :teardown do
+      WebMock.reset!
     end
 
-    define_method(:setup) { get "/" }
+    define_method(:setup) do
+      template_name = case code
+      when 200 then 'wrapper'
+      when 404 then '404'
+      else          '500'
+      end
+
+      template = File.read File.dirname(__FILE__) + "/fixtures/#{template_name}.html.erb"
+      stub_request(:get, "http://template.local/templates/#{template_name}.html.erb").
+        to_return(:body => template)
+      get "/"
+    end
   end
 
   private
@@ -44,4 +62,4 @@ class SlimmerIntegrationTest < MiniTest::Unit::TestCase
     assert element, message
     assert_equal content, element.inner_html.to_s, message if content
   end
-end
+end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 0.9.0.beta4
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Ben Griffiths
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-23 00:00:00.000000000Z
+date: 2011-11-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70276692208060 !ruby/object:Gem::Requirement
+  requirement: &70176912260840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70276692208060
+  version_requirements: *70176912260840
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70276692192860 !ruby/object:Gem::Requirement
+  requirement: &70176912260080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 1.3.5
   type: :runtime
   prerelease: false
-  version_requirements: *70276692192860
+  version_requirements: *70176912260080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70276692178740 !ruby/object:Gem::Requirement
+  requirement: &70176912259180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70276692178740
+  version_requirements: *70176912259180
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70276692176660 !ruby/object:Gem::Requirement
+  requirement: &70176912258520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *70276692176660
+  version_requirements: *70176912258520
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70276692174440 !ruby/object:Gem::Requirement
+  requirement: &70176912257880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,7 +66,18 @@ dependencies:
         version: 0.9.12
   type: :development
   prerelease: false
-  version_requirements: *70276692174440
+  version_requirements: *70176912257880
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70176912257140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70176912257140
 description: Rack middleware for skinning pages using a specific template
 email:
 - bengriffiths@gmail.com
@@ -83,11 +94,13 @@ files:
 - lib/slimmer.rb
 - lib/tasks/slimmer.rake
 - Rakefile
+- test/fixtures/404.html.erb
+- test/fixtures/500.html.erb
+- test/fixtures/wrapper.html.erb
 - test/processors/body_inserter_test.rb
 - test/slimmer_test.rb
 - test/test_helper.rb
 - test/typical_usage_test.rb
-- test/unparse_esi_test.rb
 homepage: http://github.com/alphagov/slimmer
 licenses: []
 post_install_message: 
@@ -103,9 +116,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: slimmer
 rubygems_version: 1.8.10
@@ -113,8 +126,10 @@ signing_key:
 specification_version: 3
 summary: Thinner than the skinner
 test_files:
+- test/fixtures/404.html.erb
+- test/fixtures/500.html.erb
+- test/fixtures/wrapper.html.erb
 - test/processors/body_inserter_test.rb
 - test/slimmer_test.rb
 - test/test_helper.rb
 - test/typical_usage_test.rb
-- test/unparse_esi_test.rb

data/test/unparse_esi_test.rb

@@ -1,17 +0,0 @@
-require "test_helper"
-
-class UnparseESITest < MiniTest::Unit::TestCase
-  def test_unparse_esi
-    options = [
-      "<include src='/blah/blah'></include>",
-      "<esi:include src='/blah/blah'></esi:include>",
-      "<esi:include src='/blah/blah' />",
-      "<include src='/blah/blah' />"
-    ]
-
-    options.each do |doc|
-      s = Slimmer::Skin.new('blah')
-      assert_equal "<esi:include src='/blah/blah' />", s.unparse_esi(doc)
-    end
-  end
-end