rack-modernizr 0.0.1 → 0.0.2

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.8.7@rack-modernizr

data/README.md

@@ -4,24 +4,62 @@
 
 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:
+# Installation
+
+Include it in your application.rb like so:
+
+    module ModernizrTestApp
+      class Application < Rails::Application
+        config.middleware.use Rack::Modernizr
+      end
+    end
+
+or in your config.ru:
+
+    # Initialize the rails application
+    MyApp::Application.initialize!
 
     # This file is used by Rack-based servers to start the application.
     
     require ::File.expand_path('../config/environment',  __FILE__)
     require 'modernizr'
+
+    # WARNING: session storage is not working properly with config.ru initialization :/
     use Rack::Modernizr
     
     run MyApp::Application
 
-or environment.rb
+# Usage
 
-    # Load the rails application
-    require File.expand_path('../application', __FILE__)
-    
-    config.middleware.use Rack::Modernizr
-    
-    # Initialize the rails application
-    MyApp::Application.initialize!
+In your rails code, Modernizr's client side detected browser functionality is now available from the Rack environment.  (w00t!)
+
+    <%= request.env['X-rack-modernizr'].inspect %>
+
+or
+
+    if 1==request.env['X-rack-modernizr']['video']['h264']
+      # do stuff
+    end
+
+# Features
+
+Rack-modernizr chews up 1k of cookie data (yikes!).  If you are storing session data in the database or memcache, you can avoid the cookie tax by pushing modernizr data into the session:
+
+    module ModernizrTestApp
+      class Application < Rails::Application
+        config.middleware.use Rack::Modernizr, :storage => "session"
+      end
+    end
+
+# TODO
+
+(in no particular order)
+- Cool kid .accessorize method, like [rack-flash](http://nakajima.github.com/rack-flash/).
+- Better unit testing for sessions and cookies.
+- Rails helper to clean up retrieval syntax
+- compression to cut down on 1k cookie storage size
+
+# Thanks
+
+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.
 
-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/lib/rack-modernizr.rb

@@ -2,33 +2,79 @@ require 'rack'
 
 module Rack
   class Modernizr
-    include Rack::Utils
+    attr_accessor :stash
 
     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"
+      @options[:key_name] ||= "Modernizr"
+      @options[:storage] ||= "cookie"
     end
 
     def call(env)
       @req = Rack::Request.new(env)
+
+      load_modernizr_from_storage if have_modernizr?
+
+      if env['PATH_INFO'] == "/rack-modernizr-endpoint.gif"
+        return persist_modernizr
+      end
+
       status, headers, response = @app.call(env)
-      
+
       if should_add_modernizr?(status, headers, response)
-        response = add_modernizr(response)
+        response = add_modernizr response 
         fix_content_length(headers, response)
       end
 
+
       [status, headers, response]
     end
 
+    def have_modernizr?
+      !storage[@options[:key_name]].nil?
+    end
+
+    def load_modernizr_from_storage
+      puts "load_modernizr_from_storage"
+      @req.env['X-rack-modernizr'] = Rack::Utils.parse_nested_query(storage[@options[:key_name]])
+    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")
+      !storage.has_key?( @options[:key_name] ) &&
+      status==200 &&
+      headers["Content-Type"] && 
+      headers["Content-Type"].include?("text/html")
+    end
+
+    def persist_modernizr
+      response = Rack::Response.new ["OK"], 200, {}
+
+      s = @req.env['QUERY_STRING']
+
+      case @options[:storage]
+      when "session"
+        @req.env["rack.session"][@options[:key_name]] = s
+      when "cookies"
+      when "cookie"
+        response.set_cookie(@options[:key_name], {:value => s, :path => "/"})
+      end
+
+      response.finish # finish writes out the response in the expected format.
     end
-    
+
+    def storage
+      case @options[:storage]
+      when "session"
+        @req.env["rack.session"] ||= {}
+        @req.env["rack.session"]
+      when "cookies"
+      when "cookie"
+        @req.cookies ||= {}
+        @req.cookies
+      end
+    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']
@@ -41,32 +87,27 @@ module Rack
       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>"
+      "<div id='modernizr_img'></div><script src=\"#{@options[:modernizr_js_url]}\" type=\"text/javascript\"></script>" +
+      "<script type='text/javascript'>#{set_modernizr_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){}" +
-      ""
+
+    def set_modernizr_js
+      "var m=Modernizr,c='';" +
+      "for(var f in m){" +
+      "if(f[0]=='_'){continue;}" +
+      "var t=typeof m[f];" +
+      "if(t=='function'){continue;}" +
+      "if(t=='object'){" +
+      "for(var s in m[f]){" +
+      "c+='&'+f+'['+s+']='+(m[f][s]?'1':'0');" +
+      "}" +
+      "}else{" +
+      "c+='&'+f+'='+(m[f]?'1':'0');" +
+      "}" +
+      "}" +
+      "document.getElementById('modernizr_img').innerHTML = \"<img src='/rack-modernizr-endpoint.gif?\"+c+\"'></img>\";"
     end
   end
-end
+end

data/lib/rack-modernizr/version.rb

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

data/test/spec_rack_modernizr.rb

@@ -36,15 +36,16 @@ context "Rack::Modernizr" do
       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"
+      body[0].should.include? "http://distinctive.domain.com/modernizr.js"
     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"
+      request = Rack::MockRequest.env_for("/rack-modernizr-endpoint.gif?a=b&c=d&e=f")
+      status, headers, response = Rack::Modernizr.new(app, {:key_name => "distinctive_name", :storage => "cookie"}).call(request)
+      headers['Set-Cookie'].should.not.be.nil
+      headers['Set-Cookie'].should.include? "distinctive_name"
     end
     
     specify "should work if request body is fragmented" do
@@ -80,15 +81,14 @@ context "Rack::Modernizr" do
     end
   end
 
-  
+  # cookie storage
   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"
+      request = Rack::MockRequest.env_for("/test.html", "HTTP_COOKIE" => "Modernizr=a")
+      status, headers, response = Rack::Modernizr.new(app, :storage => 'cookie').call(request)
+      response[0].should.not.include? "script"
     end
   end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rack-modernizr
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Marshall Yount
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-08 00:00:00 -06:00
+date: 2010-11-14 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -38,6 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 59
         segments: 
         - 0
         - 9
@@ -53,6 +56,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -69,6 +73,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -92,6 +97,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -100,6 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"