rack-modernizr 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in modernizr.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    rack-modernizr (0.0.1)
+      rack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    rack (1.2.1)
+    test-spec (0.10.0)
+    test-unit (2.1.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack
+  rack-modernizr!
+  test-spec (>= 0.9.0)
+  test-unit

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2010 Marshall C Yount; http://yountlabs.com
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,27 @@
+# rack-modernizr
+
+[Modernizr](http://modernizr.com) is a javascript utility that interrogates a user's web browser to determine its capabilities.  Unfortunately, all this delicious data is only available client-side.
+
+rack-modernizr is a Rack Middleware that includes the Modernizr javascript and stuffs Modernizr's output into a cookie on the first page request.
+
+Include it in your config.ru like so:
+
+    # This file is used by Rack-based servers to start the application.
+    
+    require ::File.expand_path('../config/environment',  __FILE__)
+    require 'modernizr'
+    use Rack::Modernizr
+    
+    run MyApp::Application
+
+or environment.rb
+
+    # Load the rails application
+    require File.expand_path('../application', __FILE__)
+    
+    config.middleware.use Rack::Modernizr
+    
+    # Initialize the rails application
+    MyApp::Application.initialize!
+
+rack-modernizr was inspired by [jamesgpearce](https://github.com/jamesgpearce)'s super awesome [modernizr-server](https://github.com/jamesgpearce/modernizr-server).  Some javascript was used from that project.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require "net/https"
+require "uri"
+
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+desc "Run all the tests"
+task :default => [:test]
+
+desc "Run specs with test/unit style output"
+task :test do
+  sh "specrb -Ilib:test -w #{ENV['TEST'] || '-a'} #{ENV['TESTOPTS']}"
+end
+
+desc "Run specs with specdoc style output"
+task :spec do
+  sh "specrb -Ilib:test -s -w #{ENV['TEST'] || '-a'} #{ENV['TESTOPTS']}"
+end
+
+desc "Run all the tests"
+task :fulltest do
+  sh "specrb -Ilib:test -w #{ENV['TEST'] || '-a'} #{ENV['TESTOPTS']}"
+end

data/lib/rack-modernizr.rb

@@ -0,0 +1,72 @@
+require 'rack'
+
+module Rack
+  class Modernizr
+    include Rack::Utils
+
+    def initialize(app, options = {})
+      @app, @options = app, options
+      @options[:modernizr_js_url] ||= "http://cachedcommons.org/cache/modernizr/1.5.0/javascripts/modernizr-min.js"
+      @options[:cookie_name] ||= "Modernizr"
+    end
+
+    def call(env)
+      @req = Rack::Request.new(env)
+      status, headers, response = @app.call(env)
+      
+      if should_add_modernizr?(status, headers, response)
+        response = add_modernizr(response)
+        fix_content_length(headers, response)
+      end
+
+      [status, headers, response]
+    end
+
+    def should_add_modernizr?(status, headers, response)
+      !@req.cookies.has_key?( @options[:cookie_name] ) &&
+        status==200 &&
+        headers["Content-Type"] && 
+        headers["Content-Type"].include?("text/html")
+    end
+    
+    def fix_content_length(headers, response)
+      # Set new Content-Length, if it was set before we mutated the response body
+      if headers['Content-Length']
+        length = response.to_ary.inject(0) { |len, part| len + bytesize(part) }
+        headers['Content-Length'] = length.to_s
+      end
+    end
+
+    def add_modernizr(response, body = "")
+      response.each{ |s| body << s.to_s }
+      [body.gsub(/\<\/body\>/, "#{modernizr_js}</body>")]
+    end
+    
+    def modernizr_js
+      "<script src=\"#{@options[:modernizr_js_url]}\" type=\"text/javascript\"></script>" +
+      "<script type=\"text/javascript\">#{set_cookie_js}</script>"
+    end
+    
+    def set_cookie_js
+        "var m=Modernizr,c='';" +
+        "for(var f in m){" +
+          "if(f[0]=='_'){continue;}" +
+          "var t=typeof m[f];" +
+          "if(t=='function'){continue;}" +
+          "c+=(c?'|':'#{@options[:cookie_name]}=')+f+':';" +
+          "if(t=='object'){" +
+            "for(var s in m[f]){" +
+              "c+='/'+s+':'+(m[f][s]?'1':'0');" +
+            "}" +
+          "}else{" +
+            "c+=m[f]?'1':'0';" +
+          "}" +
+        "}" +
+        "c+=';path=/';" +
+        "try{" +
+          "document.cookie=c;" +
+        "}catch(e){}" +
+      ""
+    end
+  end
+end

data/lib/rack-modernizr/version.rb

@@ -0,0 +1,3 @@
+module Modernizr
+  VERSION = "0.0.1"
+end

data/modernizr.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack-modernizr/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-modernizr"
+  s.version     = Modernizr::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Marshall Yount"]
+  s.email       = ["marshall@yountlabs.com"]
+  s.homepage    = "http://rubygems.org/gems/rack-modernizr"
+  s.summary     = %q{a Rack middleware that brings the power of the Modernizr javascript framework server-side}
+  s.description = %q{Rack::Modernizr is a Rack middleware that automagically includes the Modernizr javascript framework and exposes the results to your server-side scripts.}
+
+  s.rubyforge_project = "rack-modernizr"
+
+  s.add_dependency 'rack'
+  s.add_development_dependency 'test-spec', '>= 0.9.0'
+  s.add_development_dependency 'test-unit'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/spec_rack_modernizr.rb

@@ -0,0 +1,94 @@
+require 'test/spec'
+require 'rack/mock'
+require 'rack-modernizr'
+
+context "Rack::Modernizr" do
+
+  context "when a modernizr cookie has not been set" do
+    specify "should insert script tag" do
+      test_body = "<html><body>Hello World</body></html>"
+      app = lambda { |env| [200, {'Content-Type' => 'text/html'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/test.html")
+      body = Rack::Modernizr.new(app).call(request).last
+      body[0].should.include? "script"
+    end
+
+    specify "should correct Content-Length header" do
+      test_body = "<html><body>Hello World</body></html>"
+      app = lambda { |env| [200, {'Content-Type' => 'text/html', 'Content-Length' => 37}, [test_body]] }
+      request = Rack::MockRequest.env_for("/test.html")
+      status, headers, body = Rack::Modernizr.new(app).call(request)
+      
+      body[0].length.should.not.equal test_body.length
+      body[0].length.should.equal body[0].length
+    end
+    
+    specify "should insert code when charset is specified" do
+      test_body = "<html><body>Hello World</body></html>"
+      app = lambda { |env| [200, {'Content-Type' => 'text/html; charset=utf-8'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/test.html")
+      body = Rack::Modernizr.new(app).call(request).last
+      body[0].should.include? "script"
+    end
+
+    specify "should insert correct URL if initialized" do
+      test_body = "<html><body>Hello World</body></html>"
+      app = lambda { |env| [200, {'Content-Type' => 'text/html; charset=utf-8'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/test.html")
+      body = Rack::Modernizr.new(app, :modernizr_js_url => "http://distinctive.domain.com/modernizr.js").call(request).last
+      body[0].should.include? "distinctive.domain.com"
+    end
+    
+    specify "should use cookie name if initialized" do
+      test_body = "<html><body>Hello World</body></html>"
+      app = lambda { |env| [200, {'Content-Type' => 'text/html; charset=utf-8'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/test.html")
+      body = Rack::Modernizr.new(app, :cookie_name => "distinctive_name").call(request).last
+      body[0].should.include? "distinctive_name"
+    end
+    
+    specify "should work if request body is fragmented" do
+      test_body = ["<html><body>Hello World</bo", "dy></html>"]
+      app = lambda { |env| [200, {'Content-Type' => 'text/html; charset=utf-8'}, test_body] }
+      request = Rack::MockRequest.env_for("/test.html")
+      body = Rack::Modernizr.new(app).call(request).last
+      body[0].should.include? "script"
+    end
+    
+    specify "should not insert code if error response" do
+      test_body = "<html><body>Not Found!</body></html>"
+      app = lambda { |env| [404, {'Content-Type' => 'text/html'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/test.html")
+      body = Rack::Modernizr.new(app).call(request).last
+      body[0].should.not.include? "script"
+    end
+    
+    specify "should not insert code if non-html response" do
+      test_body = "<html><body>Silly invalid html document that somehow gets stamped to text/css</body></html>"
+      app = lambda { |env| [200, {'Content-Type' => 'text/css'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/test.css")
+      body = Rack::Modernizr.new(app).call(request).last
+      body[0].should.not.include? "script"
+    end
+    
+    specify "should not insert code if there is no body tag" do
+      test_body = "<html>Malformed document</html>"
+      app = lambda { |env| [200, {'Content-Type' => 'text/html'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/test.html")
+      body = Rack::Modernizr.new(app).call(request).last
+      body[0].should.not.include? "script"
+    end
+  end
+
+  
+  context "when a modernizr cookie has already been set" do
+    specify "should not mess with the response in any way" do
+      test_body = "<html><body>Hello World</body></html>"
+      app = lambda { |env| [200, {'Content-Type' => 'text/html'}, [test_body]] }
+      request = Rack::MockRequest.env_for("/test.html", "HTTP_COOKIE" => "Modernizr=blarghfasel")
+      body = Rack::Modernizr.new(app).call(request).last
+      puts body[0]
+      body[0].should.not.include? "script"
+    end
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification 
+name: rack-modernizr
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Marshall Yount
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-08 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: test-spec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Rack::Modernizr is a Rack middleware that automagically includes the Modernizr javascript framework and exposes the results to your server-side scripts.
+email: 
+- marshall@yountlabs.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-modernizr.rb
+- lib/rack-modernizr/version.rb
+- modernizr.gemspec
+- test/spec_rack_modernizr.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/rack-modernizr
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rack-modernizr
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: a Rack middleware that brings the power of the Modernizr javascript framework server-side
+test_files: 
+- test/spec_rack_modernizr.rb