slimmer 1.1.4beta7 → 1.1.5

data/README.md

@@ -7,19 +7,17 @@ various other details, such as meta, script, and style tags.
 
 ## Use in a Rails app
 
-Slimmer provides a Railtie so no configuration is necessary should you want to use one
-of the supplied templates. If you want to use your own set of templates you will need
-to specify the appropriate path or host (slimmer can load templates over http) eg.
+Slimmer provides a Railtie so no configuration is necessary. By default it will use the
+Plek gem to look for the 'assets' host for the current environment.
 
-    YourApp::Application.configure do
-      config.slimmer.template_path = '/place/on/file/system'
-    end
+If you want to use your own set of templates you will need to specify the appropriate host
+eg.
 
     YourApp::Application.configure do
-      config.slimmer.template_host = 'http://your.server.somewhere'
+      config.slimmer.asset_host = 'http://your.server.somewhere'
     end
 
-it expects to find templates in a folder called 'templates' on that host or in that folder
+it expects to find templates in a folder called 'templates' on that host.
 
 ## Use elsewhere
 
@@ -29,7 +27,7 @@ Slimmer will work as standard rack middleware:
 
 or
 
-    use Slimmer::App, :template_path => "/path/to/my/templates"
+    use Slimmer::App, :asset_host => "http://my.alternative.host"
 
 ## Specifying a template
 
@@ -60,7 +58,3 @@ To get this, include Slimmer::Template in your controller:
 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.
-
-## Python
-
-The repository also includes a python version but this is not currently maintained.

data/lib/slimmer.rb

@@ -22,4 +22,5 @@ module Slimmer
   autoload :BodyClassCopier, 'slimmer/body_class_copier'
   autoload :UrlRewriter, 'slimmer/url_rewriter'
   autoload :HeaderContextInserter, 'slimmer/header_context_inserter'
+  autoload :GoogleAnalyticsConfigurator, 'slimmer/google_analytics_configurator'
 end

data/lib/slimmer/google_analytics_configurator.rb

@@ -0,0 +1,36 @@
+require "json"
+
+module Slimmer
+  class GoogleAnalyticsConfigurator
+
+    HEADER_MAPPING = {
+      "Section"     => "X-SLIMMER-SECTION",
+      "Format"      => "X-SLIMMER-FORMAT",
+      "NeedID"      => "X-SLIMMER-NEED-ID",
+      "Proposition" => "X-SLIMMER-PROPOSITION",
+    }
+
+    def initialize(headers)
+      @headers = normalise_headers(headers)
+    end
+
+    def filter(src, dest)
+      custom_vars = HEADER_MAPPING.map.with_index(1) { |(name, key), slot|
+        set_custom_var(slot, name, @headers[key])
+      }.compact.join("\n");
+
+      dest.at_css("#ga-params").content += custom_vars
+    end
+
+  private
+    def normalise_headers(headers)
+      Hash[headers.map { |k, v| [k.upcase, v] }]
+    end
+
+    def set_custom_var(slot, name, value)
+      return nil unless value
+      "_gaq.push(#{JSON.dump([ "_setCustomVar", slot, name, value, 3])});"
+    end
+  end
+end
+

data/lib/slimmer/skin.rb

@@ -79,7 +79,7 @@ module Slimmer
         AdminTitleInserter.new,
         FooterRemover.new,
         BodyInserter.new(),
-        BodyClassCopier.new
+        BodyClassCopier.new,
       ]
       process(processors,body,template('admin'))
     end
@@ -91,7 +91,8 @@ module Slimmer
         BodyInserter.new(),
         BodyClassCopier.new,
         HeaderContextInserter.new(),
-        SectionInserter.new()
+        SectionInserter.new(),
+        GoogleAnalyticsConfigurator.new(request.env),
       ]
 
       template_name = request.env.has_key?(TEMPLATE_HEADER) ? request.env[TEMPLATE_HEADER] : 'wrapper'

data/lib/slimmer/version.rb

@@ -1,3 +1,3 @@
 module Slimmer
-  VERSION = '1.1.4beta7'
+  VERSION = '1.1.5'
 end

data/test/fixtures/wrapper.html.erb

@@ -12,5 +12,9 @@
       <div id="wrapper" class="group">
       </div>
     </div>
+
+    <script id="ga-params" type="text/javascript">
+      var _gaq = _gaq || [];
+    </script>
   </body>
 </html>

data/test/google_analytics_test.rb

@@ -0,0 +1,88 @@
+require "test_helper"
+require "v8"
+
+module GoogleAnalyticsTest
+
+  GENERIC_DOCUMENT = <<-END
+    <html>
+      <head>
+        <title>The title of the page</title>
+      </head>
+      <body class="body_class">
+        <div id="wrapper">The body of the page</div>
+      </body>
+    </html>
+  END
+
+  module JavaScriptAssertions
+    def gaq
+      js = Nokogiri::HTML(last_response.body).at_css("#ga-params").text
+      context = V8::Context.new
+      context.eval(js)
+      context.eval("_gaq");
+    end
+
+    def assert_custom_var(slot, name, value, page_level)
+      # Ruby Racer JS arrays don't accept range indexing, so we must
+      # use a slightly longer workaround
+      vars = gaq.select { |a| a[0] == "_setCustomVar" }.
+                 map { |a| (1..4).map { |i| a[i] } }
+      assert_includes vars, [slot, name, value, page_level]
+    end
+
+    def refute_custom_var(name)
+      vars = gaq.select { |a| a[0] == "_setCustomVar" }.map { |a| a[2] }
+      refute_includes vars, name
+    end
+  end
+
+  class WithHeadersTest < SlimmerIntegrationTest
+    include JavaScriptAssertions
+
+    headers = {
+      "X-Slimmer-Section"     => "rhubarb",
+      "X-Slimmer-Format"      => "custard",
+      "X-Slimmer-Need-ID"     => "42",
+      "X-Slimmer-Proposition" => "trifle"
+    }
+    given_response 200, GENERIC_DOCUMENT, headers
+
+    def test_should_pass_section_to_GA
+      assert_custom_var 1, "Section", "rhubarb", 3
+    end
+
+    def test_should_pass_internal_format_name_to_GA
+      assert_custom_var 2, "Format", "custard", 3
+    end
+
+    def test_should_pass_need_ID_to_GA
+      assert_custom_var 3, "NeedID", "42", 3
+    end
+
+    def test_should_pass_proposition_to_GA
+      assert_custom_var 4, "Proposition", "trifle", 3
+    end
+  end
+
+  class WithoutHeadersTest < SlimmerIntegrationTest
+    include JavaScriptAssertions
+
+    given_response 200, GENERIC_DOCUMENT, {}
+
+    def test_should_omit_section
+      refute_custom_var "Section"
+    end
+
+    def test_should_omit_internal_format_name
+      refute_custom_var "Format"
+    end
+
+    def test_should_omit_need_ID
+      refute_custom_var "NeedID"
+    end
+
+    def test_should_omit_proposition
+      refute_custom_var "Proposition"
+    end
+  end
+end

data/test/{slimmer_test.rb → skin_test.rb}

@@ -1,6 +1,6 @@
 require "test_helper"
 
-class TestSlimmer < MiniTest::Unit::TestCase
+class SkinTest < MiniTest::Unit::TestCase
   def test_template_can_be_loaded
     skin = Slimmer::Skin.new "http://example.local/"
     expected_url = "http://example.local/templates/example.html.erb"

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 1.1.4beta7
-  prerelease: 5
+  version: 1.1.5
+  prerelease: 
 platform: ruby
 authors:
 - Ben Griffiths
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-29 00:00:00.000000000Z
+date: 2011-12-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70214553530820 !ruby/object:Gem::Requirement
+  requirement: &70317042052480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70214553530820
+  version_requirements: *70317042052480
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70214553528460 !ruby/object:Gem::Requirement
+  requirement: &70317042051600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 1.3.5
   type: :runtime
   prerelease: false
-  version_requirements: *70214553528460
+  version_requirements: *70317042051600
 - !ruby/object:Gem::Dependency
   name: plek
-  requirement: &70214553516400 !ruby/object:Gem::Requirement
+  requirement: &70317042050180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,21 @@ dependencies:
         version: 0.1.8
   type: :runtime
   prerelease: false
-  version_requirements: *70214553516400
+  version_requirements: *70317042050180
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70317042048980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70317042048980
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70214553504100 !ruby/object:Gem::Requirement
+  requirement: &70317042047100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +66,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *70214553504100
+  version_requirements: *70317042047100
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70214553496520 !ruby/object:Gem::Requirement
+  requirement: &70317042039160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +77,10 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *70214553496520
+  version_requirements: *70317042039160
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70214553492360 !ruby/object:Gem::Requirement
+  requirement: &70317042038140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +88,10 @@ dependencies:
         version: 0.9.12
   type: :development
   prerelease: false
-  version_requirements: *70214553492360
+  version_requirements: *70317042038140
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70214553484460 !ruby/object:Gem::Requirement
+  requirement: &70317042037200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,7 +99,18 @@ dependencies:
         version: '1.7'
   type: :development
   prerelease: false
-  version_requirements: *70214553484460
+  version_requirements: *70317042037200
+- !ruby/object:Gem::Dependency
+  name: therubyracer
+  requirement: &70317042036560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70317042036560
 description: Rack middleware for skinning pages using a specific template
 email:
 - bengriffiths@gmail.com
@@ -104,6 +126,7 @@ files:
 - lib/slimmer/body_class_copier.rb
 - lib/slimmer/body_inserter.rb
 - lib/slimmer/footer_remover.rb
+- lib/slimmer/google_analytics_configurator.rb
 - lib/slimmer/header_context_inserter.rb
 - lib/slimmer/railtie.rb
 - lib/slimmer/section_inserter.rb
@@ -120,9 +143,10 @@ files:
 - test/fixtures/404.html.erb
 - test/fixtures/500.html.erb
 - test/fixtures/wrapper.html.erb
+- test/google_analytics_test.rb
 - test/processors/body_inserter_test.rb
 - test/processors/header_context_inserter_test.rb
-- test/slimmer_test.rb
+- test/skin_test.rb
 - test/test_helper.rb
 - test/typical_usage_test.rb
 homepage: http://github.com/alphagov/slimmer
@@ -140,9 +164,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
@@ -153,8 +177,9 @@ test_files:
 - test/fixtures/404.html.erb
 - test/fixtures/500.html.erb
 - test/fixtures/wrapper.html.erb
+- test/google_analytics_test.rb
 - test/processors/body_inserter_test.rb
 - test/processors/header_context_inserter_test.rb
-- test/slimmer_test.rb
+- test/skin_test.rb
 - test/test_helper.rb
 - test/typical_usage_test.rb