rack-html5 1.0.0 → 1.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Christian Felder
+
+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.rdoc

@@ -14,24 +14,24 @@ Rack::Html5 detects the browser and its version by parsing the user agent. It th
 
 Rack::Html5 then sets the following HTTP headers:
 
-* *X-Detected-Browser:* Browser that has been detected, eg.: Firefox
-* *X-Detected-Version:* Version of the browser that has been detected, eg.: 3.6.6
-* *X-Html5-Wysiwyg:* WYSIWYG editable elements
-* *X-Html5-Classname:* getElementsByClassName
-* *X-Html5-Elements:* Stylable HTML5 elements
-* *X-Html5-Canvas:* Canvas (basic support)
-* *X-Html5-Messaging:* Cross-document messaging
-* *X-Html5-Audio:* Audio element
-* *X-Html5-Video:* Video element
-* *X-Html5-Textapi:* Text API for canvas
-* *X-Html5-Draganddrop:* Drag and drop
-* *X-Html5-Offline:* Offline web applications
-* *X-Html5-Svg:* Inline SVG
-* *X-Html5-Form:* Form features (Web Forms 2.0)
+* HTTP_X_DETECTED_BROWSER: Browser that has been DETECTED, eg.: Firefox
+* HTTP_X_DETECTED_VERSION: Version of the browser that has been DETECTED, eg.: 3.6.6
+* HTTP_X_SUPPORTS_HTML5_WYSIWYG: WYSIWYG editable elements
+* HTTP_X_SUPPORTS_HTML5_CLASSNAME: getElementsByClassName
+* HTTP_X_SUPPORTS_HTML5_ELEMENTS: Stylable HTML5 elements
+* HTTP_X_SUPPORTS_HTML5_CANVAS: Canvas (basic support)
+* HTTP_X_SUPPORTS_HTML5_MESSAGING: Cross-document messaging
+* HTTP_X_SUPPORTS_HTML5_AUDIO: Audio element
+* HTTP_X_SUPPORTS_HTML5_VIDEO: Video element
+* HTTP_X_SUPPORTS_HTML5_TEXTAPI: Text API for canvas
+* HTTP_X_SUPPORTS_HTML5_DRAGANDDROP: Drag and drop
+* HTTP_X_SUPPORTS_HTML5_OFFLINE: Offline web applications
+* HTTP_X_SUPPORTS_HTML5_SVG: Inline SVG
+* HTTP_X_SUPPORTS_HTML5_FORMS: Form features (Web Forms 2.0)
 
 == Rails
 
-I plan on providing some rails helpers in the future.
+The Rack-Html5-rails_helper gem provides Rails helper methods, so you don't have to read the headers by yourself: http://github.com/masone/rack-html5-rails_helper
 
 === Configuration for Rails 2
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/rack/html5.rb

@@ -4,50 +4,49 @@ module Rack # :nodoc:
   # It does this by parsing the user agent and matching the features to the browser version based on information provided on:  http://caniuse.com/#eras=farpast,past,now&cats=HTML5&statuses=rec,pr,cr,wd,ietf&nodetails=1
   #
   # The headers that are being set: 
-  # * *X-Detected-Browser:* Browser that has been detected, eg.: Firefox
-  # * *X-Detected-Version:* Version of the browser that has been detected, eg.: 3.6.6
-  # * *X-Html5-Wysiwyg:* WYSIWYG editable elements
-  # * *X-Html5-Classname:* getElementsByClassName
-  # * *X-Html5-Elements:* Stylable HTML5 elements
-  # * *X-Html5-Canvas:* Canvas (basic support)
-  # * *X-Html5-Messaging:* Cross-document messaging
-  # * *X-Html5-Audio:* Audio element
-  # * *X-Html5-Video:* Video element
-  # * *X-Html5-Textapi:* Text API for canvas
-  # * *X-Html5-Draganddrop:* Drag and drop
-  # * *X-Html5-Offline:* Offline web applications
-  # * *X-Html5-Svg:* Inline SVG
-  # * *X-Html5-Form:* Form features (Web Forms 2.0)
+  # * HTTP_X_DETECTED_BROWSER: Browser that has been DETECTED, eg.: Firefox
+  # * HTTP_X_DETECTED_VERSION: Version of the browser that has been DETECTED, eg.: 3.6.6
+  # * HTTP_X_SUPPORTS_HTML5_WYSIWYG: WYSIWYG editable elements
+  # * HTTP_X_SUPPORTS_HTML5_CLASSNAME: getElementsByClassName
+  # * HTTP_X_SUPPORTS_HTML5_ELEMENTS: Stylable HTML5 elements
+  # * HTTP_X_SUPPORTS_HTML5_CANVAS: Canvas (basic support)
+  # * HTTP_X_SUPPORTS_HTML5_MESSAGING: Cross-document messaging
+  # * HTTP_X_SUPPORTS_HTML5_AUDIO: Audio element
+  # * HTTP_X_SUPPORTS_HTML5_VIDEO: Video element
+  # * HTTP_X_SUPPORTS_HTML5_TEXTAPI: Text API for canvas
+  # * HTTP_X_SUPPORTS_HTML5_DRAGANDDROP: Drag and drop
+  # * HTTP_X_SUPPORTS_HTML5_OFFLINE: Offline web applications
+  # * HTTP_X_SUPPORTS_HTML5_SVG: Inline SVG
+  # * HTTP_X_SUPPORTS_HTML5_FORMS: Form features (Web Forms 2.0)
   #
   # Please note:
   # * If the feature is not supported, the header will not be set.
   # * If a browser implements a feature only partially, the corresponding header will not be set.
   class Html5
-    attr_accessor :version, :browser, :user_agent, :features, :headers
+    attr_accessor :version, :browser, :user_agent, :features, :env
     
     def initialize(app)
       @app = app
+      @features = []      
     end
     
     def generate_headers
-      headers['x-detected-version'] = version
-      headers['x-detected-browser'] = browser.to_s
+      @env['HTTP_X_DETECTED_VERSION'] = version
+      @env['HTTP_X_DETECTED_BROWSER'] = browser.to_s
       @features.each do |feature|
-        headers["x-html5-#{feature}"] = "true"
+        @env["HTTP_X_SUPPORTS_HTML5_#{feature.upcase}"] = "true"
       end
     end
 
     def call(env)
-      status, headers, response = @app.call(env)
-      @user_agent = env['HTTP_USER_AGENT']
-      @features = []
-      @headers = headers
+      @env = env      
+      @user_agent = @env['HTTP_USER_AGENT']
       
       detect_browser
       detect_features
       generate_headers
       
-      [status, @headers, response]
+      @app.call(@env)
     end
 
     # Detects the browser and version based on the user agent
@@ -82,8 +81,6 @@ module Rack # :nodoc:
     def comparable_version(v)
       v.split(".")[0..1].join
     end
-    
-  private
 
     # Feature to browser version mapping according to the information provided on: http://caniuse.com/#eras=farpast,past,now&cats=HTML5&statuses=rec,pr,cr,wd,ietf&nodetails=1
     def feature_mapping

data/rack-html5.gemspec

@@ -5,18 +5,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rack-html5}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christian Felder (masone)"]
-  s.date = %q{2010-07-14}
+  s.date = %q{2010-07-15}
   s.description = %q{Rack::Html5 sets custom headers for each HTML5 feature the browser supports.}
   s.email = %q{ema@rh-productions.ch}
   s.extra_rdoc_files = [
-    "README.rdoc"
+    "LICENSE",
+     "README.rdoc"
   ]
   s.files = [
     ".gitignore",
+     "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",

data/rake/jeweler.rb

@@ -7,7 +7,7 @@ begin
     s.email = "ema@rh-productions.ch"
     s.homepage = "http://github.com/masone/rack-html5"
     s.authors = ["Christian Felder (masone)"]
-    s.add_development_dependency "shoulda"        
+    s.add_development_dependency "shoulda"
   end
   Jeweler::GemcutterTasks.new  
 rescue LoadError

data/test/rack/html5_test.rb

@@ -90,28 +90,66 @@ class Rack::Html5Test < Test::Unit::TestCase
   
   context "headers" do
 
-    should "set the x-detected-version header to 5.0.307.11" do
+    should "set the HTTP_X_DETECTED_VERSION header to 5.0.307.11" do
       env = { 'HTTP_USER_AGENT' => "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_2; en-US) AppleWebKit/532.9 (KHTML, like Gecko) Chrome/5.0.307.11 Safari/532.9" }
-      status, headers, response = @rack.call(env)
-      assert_equal "5.0.307.11", headers['x-detected-version']
+      @rack.call(env)
+      assert_equal "5.0.307.11", @rack.env['HTTP_X_DETECTED_VERSION']
     end
     
-    should "set the x-detected-browser header to " do
+    should "set the HTTP_X_DETECTED_BROWSER header to " do
       env = { 'HTTP_USER_AGENT' => "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_2; en-US) AppleWebKit/532.9 (KHTML, like Gecko) Chrome/5.0.307.11 Safari/532.9" }
-      status, headers, response = @rack.call(env)
-      assert_equal "chrome", headers['x-detected-browser']
+      @rack.call(env)
+      assert_equal "chrome", @rack.env['HTTP_X_DETECTED_BROWSER']
     end    
     
-    should "set the x-html5-elements header to true for Firefox 5.0" do
+    should "set the HTTP_X_SUPPORTS_HTML5_ELEMENTS header to true for Firefox 5.0" do
       env = { 'HTTP_USER_AGENT' => "Mozilla/5.0 (X11; U; Darwin Power Macintosh; en-US; rv:1.8.0.12) Gecko/20070803 Firefox/5.0.10 Fink Community Edition" }    
-      status, headers, response = @rack.call(env)
-      assert_equal "true", headers['x-html5-elements']
+      @rack.call(env)  
+      assert_equal "true", @rack.env['HTTP_X_SUPPORTS_HTML5_ELEMENTS']
     end    
       
     should "not include the x headers if user agent cannot be detected properly" do
       env = { 'HTTP_USER_AGENT' => "Mozilla/5.0 Gecko/20070803 Notabrowser/9.9.99" }    
       status, headers, response = @rack.call(env)    
-      assert_equal false, headers.include?('x-html5-wysiwyg')      
+      assert_equal false, @rack.env.has_key?('HTTP_X_SUPPORTS_HTML5_WYSIWYG')      
     end
   end
+  
+  context "feature_mapping" do
+    
+    setup do
+      @features = [:wysiwyg, :classname, :elements, :canvas, :messaging, :audio, :video, :textapi, :draganddrop, :offline, :forms, :svg]
+    end
+    
+    should "map exactly the same number of elements as expected" do
+      @rack.feature_mapping.each do |browser, features|
+        assert_equal @features.length, features.keys.length, "Wrong number of elements for #{browser}"
+      end
+    end
+    
+    should "contain all necessary elements for each browser" do            
+      @rack.feature_mapping.each do |browser, features|
+        @features.each do |feature|
+          assert features.has_key?(feature), "Element #{feature} is missing for #{browser}"          
+        end
+      end      
+    end
+  end
+  
+  context "comparable version" do
+    
+    should "return 105 for 10.5" do
+      assert_equal "105", @rack.comparable_version("10.5")
+    end
+    
+    should "return 1050 for 10.50.2.0" do
+      assert_equal "1050", @rack.comparable_version("10.50.2.0")
+    end
+    
+    should "return 7 for 7" do
+      assert_equal "7", @rack.comparable_version("7")
+    end    
+    
+  end
+  
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Christian Felder (masone)
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-14 00:00:00 +02:00
+date: 2010-07-15 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,9 +37,11 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
+- LICENSE
 - README.rdoc
 files: 
 - .gitignore
+- LICENSE
 - README.rdoc
 - Rakefile
 - VERSION