slimmer 0.8.0 → 0.9.0.beta1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 0.9.0
+
+* Moved templates into slimmer rather than using separate static project
+* Added railtie so that slimmer can be dropped into a rails app without configuration
+* Began to write *gasp* tests!

data/README.md

@@ -0,0 +1,66 @@
+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 one of its templates. It also transfers
+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.
+
+    YourApp::Application.configure do
+      config.slimmer.template_path = '/place/on/file/system'
+    end
+
+    YourApp::Application.configure do
+      config.slimmer.template_host = 'http://your.server.somewhere'
+    end
+
+it expects to find templates in a folder called 'templates' on that host or in that folder
+
+## Use elsewhere
+
+Slimmer will work as standard rack middleware:
+
+    use Slimmer::App
+
+or
+
+    use Slimmer::App, :template_path => "/path/to/my/templates"
+
+## Specifying a template
+
+A specific template can be requested by giving its name in the X-Slimmer-Template HTTP header
+
+eg in a rails app
+
+    class MyController < ApplicationController
+      def index
+        headers['X-Slimmer-Template'] = 'homepage'
+      end
+    end
+
+There's also a macro style method:
+
+    class YourController < ApplicationController
+      slimmer_template :admin
+    end
+
+To get this, include Slimmer::Template in your controller:
+
+    class ApplicationController < ActionController::Base
+      include Slimmer::Template
+    end
+
+## 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 
+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/Rakefile

@@ -1,15 +1,19 @@
 # -*- encoding: utf-8 -*-
 
-require "rubygems"
-require "rake/gempackagetask"
+require "bundler/gem_tasks"
+require "rdoc/task"
+require 'rake/testtask'
 
-spec = Gem::Specification.load('slimmer.gemspec')
-
-Rake::GemPackageTask.new(spec) do
-end
-
-Rake::RDocTask.new do |rd|
+RDoc::Task.new do |rd|
   rd.rdoc_files.include("lib/**/*.rb")
   rd.rdoc_dir = "rdoc"
 end
 
+Rake::TestTask.new("test") do |t|
+  t.ruby_opts << "-rubygems"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+task :default => :test

data/lib/slimmer/railtie.rb

@@ -0,0 +1,9 @@
+module Slimmer
+  class Railtie < Rails::Railtie
+    config.slimmer = ActiveSupport::OrderedOptions.new
+
+    initializer "slimmer.configure" do |app|
+      app.middleware.use Slimmer::App, app.config.slimmer.to_hash
+    end
+  end
+end

data/lib/slimmer/template.rb

@@ -6,9 +6,9 @@ module Slimmer
 
     module ClassMethods
       def slimmer_template template_name
-	after_filter do
-	  response.headers[Slimmer::TEMPLATE_HEADER] = template_name.to_s
-	end
+        after_filter do
+          response.headers[Slimmer::TEMPLATE_HEADER] = template_name.to_s
+        end
       end
     end
   end

data/lib/slimmer/version.rb

@@ -0,0 +1,3 @@
+module Slimmer
+  VERSION = '0.9.0.beta1'
+end

data/lib/slimmer.rb

@@ -1,6 +1,7 @@
-require 'nokogiri'
-require 'open-uri'
 require 'slimmer/template'
+require 'slimmer/railtie' if defined?(Rails)
+
+require 'nokogiri'
 require 'erb'
 
 module Slimmer
@@ -9,14 +10,15 @@ module Slimmer
 
   class App
 
-    def initialize(app,options = {})
+    def initialize(app, *args, &block)
+      options = args.first || {}
       @app = app
       @skin = Skin.new(options[:asset_host], options[:template_path])
     end
 
     def call(env)
-      status,env2,body = @app.call(env)
-      rewrite_response(env,[status,env2,body])
+      status, headers, body = @app.call(env)
+      rewrite_response(env, [status, headers, body])
     end
 
     def on_success(request,body)
@@ -27,12 +29,12 @@ module Slimmer
       @skin.admin(request,body)
     end
 
-    def on_error(request,status, body)
-      @skin.error(request, '500')
+    def on_error(request, status, body)
+      @skin.error(request, '500', body)
     end
 
     def on_404(request,body)
-      @skin.error(request, '404')
+      @skin.error(request, '404', body)
     end
 
     def s(body)
@@ -59,7 +61,7 @@ module Slimmer
         when 404
           rewritten_body = on_404(request,s(app_body))
         else
-          rewritten_body = on_error(request,status, s(app_body))
+          rewritten_body = on_error(request,status,s(app_body))
         end
       else
         rewritten_body = app_body
@@ -197,7 +199,7 @@ module Slimmer
       dest.at_css(@path).replace(body)
     end
   end
-  
+
   class BodyClassCopier
     def filter(src, dest)
       src_body_tag = src.at_css("body")
@@ -231,8 +233,8 @@ module Slimmer
   class Skin
 
     def initialize(asset_host = nil, template_path = nil)
+      @template_path = template_path || File.expand_path("../../templates", __FILE__)
       @asset_host = asset_host
-      @template_path = template_path
       @template = {}
     end
 
@@ -254,7 +256,7 @@ module Slimmer
     end
 
     def templates_are_local?
-      File.exists? template_path
+      File.exists?(template_path)
     end
 
     def unparse_esi(doc)
@@ -265,11 +267,11 @@ module Slimmer
       doc.gsub("<include","<esi:include").gsub(/><\/(esi:)?include>/, ' />')
     end
 
-    def error(request, template_name)
+    def error(request, template_name, body)
       processors = [
         TitleInserter.new()
       ]
-      self.process(processors,"<html></html>",template(template_name))
+      self.process(processors, body, template(template_name))
     end
 
     def process(processors,body,template)

data/lib/tasks/slimmer.rake

@@ -3,13 +3,13 @@ require 'rake'
 namespace :slimmer do
   desc "Symlink from public directory to static directory"
   task :link do
-      path_to_static = "../static/public"
-      path_to_public = "public"
-      commands = ["cd #{path_to_public}"]
-      dirs_to_link = Dir.glob("../static/public/*") {|f|
-        commands << "ln -s #{path_to_static}/#{f}"
-      }
-      commands << ["cd .."]
-      run commands.join(" && ")
+    path_to_static = "../static/public"
+    path_to_public = "public"
+    commands = ["cd #{path_to_public}"]
+    dirs_to_link = Dir.glob("../static/public/*") {|f|
+      commands << "ln -s #{path_to_static}/#{f}"
+    }
+    commands << ["cd .."]
+    run commands.join(" && ")
   end
 end

data/test/processors/body_inserter_test.rb

@@ -0,0 +1,30 @@
+require "test_helper"
+
+class BodyInserterTest < MiniTest::Unit::TestCase
+  def test_should_replace_contents_of_wrapper_in_template
+    template = as_nokogiri %{
+      <html><body><div><div id="wrapper"></div></div></body></html>
+    }
+    source = as_nokogiri %{
+      <html><body><nav></nav><div id="wrapper"><p>this should be moved</p></div></body></html>
+    }
+
+    Slimmer::BodyInserter.new.filter(source, template)
+    assert_in template, "#wrapper", %{<p>this should be moved</p>}
+  end
+
+  def test_should_allow_replacement_of_arbitrary_wrappers
+    template = as_nokogiri %{
+      <html><body><div>
+      <div id="wrapper">don't touch this</div>
+      <div id="some_other_id"></div></div></body></html>
+    }
+    source = as_nokogiri %{
+      <html><body><div id="some_other_id"><p>this should be moved</p></div></body></html>
+    }
+
+    Slimmer::BodyInserter.new("#some_other_id").filter(source, template)
+    assert_in template, "#wrapper", %{don't touch this}
+    assert_in template, "#some_other_id", %{<p>this should be moved</p>}
+  end
+end

data/test/slimmer_test.rb

@@ -0,0 +1,8 @@
+require "test_helper"
+
+class TestSlimmer < MiniTest::Unit::TestCase
+  def test_template_can_be_loaded
+    s = Slimmer::Skin.new
+    assert s.load_template('wrapper')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,47 @@
+require_relative '../lib/slimmer'
+require 'minitest/autorun'
+require 'rack/test'
+
+class MiniTest::Unit::TestCase
+  def as_nokogiri(html_string)
+    Nokogiri::HTML.parse(html_string.strip)
+  end
+
+  def assert_in(template, selector, content, message=nil)
+    assert_equal content, template.at_css(selector).inner_html.to_s, message
+  end
+end
+
+class SlimmerIntegrationTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def self.given_response(code, body)
+    define_method(:app) do
+      inner_app = proc { |env|
+        [code, {"Content-Type" => "text/html"}, body]
+      }
+      Slimmer::App.new(inner_app)
+    end
+
+    define_method(:setup) { get "/" }
+  end
+
+  private
+
+  def assert_not_rendered_in_template(content)
+    refute_match /#{Regexp.escape(content)}/, last_response.body
+  end
+
+  def assert_rendered_in_template(selector, content=nil, message=nil)
+    unless message
+      if content
+        message = "Expected to find #{content.inspect} at #{selector.inspect} in the output template"
+      else
+        message = "Expected to find #{selector.inspect} in the output template"
+      end
+    end
+    element = Nokogiri::HTML.parse(last_response.body).at_css(selector)
+    assert element, message
+    assert_equal content, element.inner_html.to_s, message if content
+  end
+end

data/test/typical_usage_test.rb

@@ -0,0 +1,142 @@
+require "test_helper"
+
+module TypicalUsage
+  class NormalResponseTest < SlimmerIntegrationTest
+
+    given_response 200, %{
+      <html>
+      <head><title>The title of the page</title>
+      <meta name="something" content="yes">
+      <meta name="x-section-name" content="This section">
+      <meta name="x-section-link" content="/this_section">
+      <script src="blah.js"></script>
+      <link href="app.css" rel="stylesheet" type="text/css">
+      </head>
+      <body class="body_class">
+      <div id="wrapper">The body of the page</div>
+      </body>
+      </html>
+    }
+
+    def test_should_replace_the_wrapper_using_the_app_response
+      assert_rendered_in_template "#wrapper", "The body of the page"
+    end
+
+    def test_should_replace_the_title_using_the_app_response
+      assert_rendered_in_template "head title", "The title of the page"
+    end
+
+    def test_should_move_script_tags_into_the_head
+      assert_rendered_in_template "head script[src='blah.js']"
+    end
+
+    def test_should_move_meta_tags_into_the_head
+      assert_rendered_in_template "head meta[name='something']"
+    end
+
+    def test_should_move_stylesheet_tags_into_the_head
+      assert_rendered_in_template "head link[href='app.css']"
+    end
+
+    def test_should_copy_the_class_of_the_body_element
+      assert_rendered_in_template "body.body_class"
+    end
+
+    def test_should_insert_meta_navigation_links_into_the_navigation
+      assert_rendered_in_template "nav[role=navigation] li a[href='/this_section']", "This section"
+    end
+  end
+
+  class Error500ResponseTest < SlimmerIntegrationTest
+    include Rack::Test::Methods
+
+    given_response 500, %{
+      <html>
+      <head><title>500 Error</title>
+      <meta name="something" content="yes">
+      <meta name="x-section-name" content="This section">
+      <meta name="x-section-link" content="/this_section">
+      <script src="blah.js"></script>
+      <link href="app.css" rel="stylesheet" type="text/css">
+      </head>
+      <body class="body_class">
+      <div id="wrapper"><p class='message'>Something bad happened</p></div>
+      </body>
+      </html>
+    }
+
+    def test_should_not_replace_the_wrapper_using_the_app_response
+      assert_not_rendered_in_template "Something bad happened"
+    end
+
+    def test_should_include_default_500_error_message
+      assert_rendered_in_template "body .content header h1", "We seem to be having a problem."
+    end
+
+    def test_should_replace_the_title_using_the_app_response
+      assert_rendered_in_template "head title", "500 Error"
+    end
+  end
+
+  class Error404ResponseTest < SlimmerIntegrationTest
+    include Rack::Test::Methods
+
+    given_response 404, %{
+      <html>
+      <head><title>404 Missing</title>
+      <meta name="something" content="yes">
+      <meta name="x-section-name" content="This section">
+      <meta name="x-section-link" content="/this_section">
+      <script src="blah.js"></script>
+      <link href="app.css" rel="stylesheet" type="text/css">
+      </head>
+      <body class="body_class">
+      <div id="wrapper"><p class='message'>Something bad happened</p></div>
+      </body>
+      </html>
+    }
+
+    def test_should_not_replace_the_wrapper_using_the_app_response
+      assert_not_rendered_in_template "Something bad happened"
+    end
+
+    def test_should_include_default_404_error_message
+      assert_rendered_in_template "body .content header h1", "Oops! We can't find what you're looking for."
+    end
+
+    def test_should_replace_the_title_using_the_app_response
+      assert_rendered_in_template "head title", "404 Missing"
+    end
+  end
+
+  class Error406ResponseTest < SlimmerIntegrationTest
+    include Rack::Test::Methods
+
+    given_response 406, %{
+      <html>
+      <head><title>406 Not Acceptable</title>
+      <meta name="something" content="yes">
+      <meta name="x-section-name" content="This section">
+      <meta name="x-section-link" content="/this_section">
+      <script src="blah.js"></script>
+      <link href="app.css" rel="stylesheet" type="text/css">
+      </head>
+      <body class="body_class">
+      <div id="wrapper"><p class='message'>Something bad happened</p></div>
+      </body>
+      </html>
+    }
+
+    def test_should_not_replace_the_wrapper_using_the_app_response
+      assert_not_rendered_in_template "Something bad happened"
+    end
+
+    def test_should_include_default_non_404_error_message
+      assert_rendered_in_template "body .content header h1", "We seem to be having a problem."
+    end
+
+    def test_should_replace_the_title_using_the_app_response
+      assert_rendered_in_template "head title", "406 Not Acceptable"
+    end
+  end
+end

data/test/unparse_esi_test.rb

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

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: slimmer
 version: !ruby/object:Gem::Version
-  version: 0.8.0
-  prerelease: 
+  version: 0.9.0.beta1
+  prerelease: 6
 platform: ruby
 authors:
 - Ben Griffiths
@@ -10,19 +10,63 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-01 00:00:00.000000000Z
+date: 2011-11-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70264965293060 !ruby/object:Gem::Requirement
+  requirement: &70366350084360 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: *70264965293060
+  version_requirements: *70366350084360
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70366350083660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: *70366350083660
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70366350082840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70366350082840
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &70366350076560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: *70366350076560
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70366350075780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: *70366350075780
 description: Rack middleware for skinning pages using a specific template
 email:
 - bengriffiths@gmail.com
@@ -31,10 +75,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- CHANGELOG.md
+- lib/slimmer/railtie.rb
 - lib/slimmer/template.rb
+- lib/slimmer/version.rb
 - lib/slimmer.rb
 - lib/tasks/slimmer.rake
 - Rakefile
+- 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: 
@@ -50,13 +103,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: slimmer
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Thinner than the skinner
-test_files: []
+test_files:
+- test/processors/body_inserter_test.rb
+- test/slimmer_test.rb
+- test/test_helper.rb
+- test/typical_usage_test.rb
+- test/unparse_esi_test.rb