RubyGems - rack-html5 - Versions diffs - 1.0.0 - Mend

rack-html5 1.0.0

Files changed (13) hide show

data/.gitignore ADDED Viewed

@@ -0,0 +1,5 @@
+.DS_Store
+coverage
+rdoc
+doc
+pkg

data/README.rdoc ADDED Viewed

@@ -0,0 +1,59 @@
+= rack-html5
+This is work in progress.
+Rack::Html5 detects the browser and its version by parsing the user agent. It then matches the features available for the current request.
+== Usage
+  gem install rack-html5
+  require 'rack-html5'
+  use Rack::Html5
+  app = lambda { |env| [200, { 'Content-Type' => 'text/html' }, '<html><body><p></p></body></html>'] }
+  run app
+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)
+== Rails
+I plan on providing some rails helpers in the future.
+=== Configuration for Rails 2
+Add the following lines to the config block in your environment.rb file:
+  config.gem "rack-html5"
+  config.middleware.use "Rack::Html5"
+=== Configuration for Rails 3
+Add the gem dependency to Gemfile:
+  gem 'rack-html5'
+Install the gem with bundler:
+  sudo bundler install
+Add the Rack middleware to config.ru:
+  use Rack::Html5
+== Notices
+* The matching is done based on the information provided on: http://caniuse.com/#eras=farpast,past,now&cats=HTML5&statuses=rec,pr,cr,wd,ietf&nodetails=1
+* 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.
+* It is assumed that future versions will still implement a certain feature if it's implemented now.
+* User agent matching is a dirty thing. Feel free to help improving the matching rules.

data/Rakefile ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ # Load all tasks in rake directory
2	+ Dir[File.join(File.expand_path(File.dirname(__FILE__)), "rake", "*", ".rb")].each { \|file\| require file }

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 1.0.0

data/lib/rack-html5.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ require "rack/html5"

data/lib/rack/html5.rb ADDED Viewed

@@ -0,0 +1,177 @@
+module Rack # :nodoc:
+  # Rack::Html5 sets custom headers for each HTML5 feature the browser supports.
+  # 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)
+  #
+  # 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
+    def initialize(app)
+      @app = app
+    end
+    def generate_headers
+      headers['x-detected-version'] = version
+      headers['x-detected-browser'] = browser.to_s
+      @features.each do |feature|
+        headers["x-html5-#{feature}"] = "true"
+      end
+    end
+    def call(env)
+      status, headers, response = @app.call(env)
+      @user_agent = env['HTTP_USER_AGENT']
+      @features = []
+      @headers = headers
+      detect_browser
+      detect_features
+      generate_headers
+      [status, @headers, response]
+    end
+    # Detects the browser and version based on the user agent
+    def detect_browser
+      user_agent_matcher.each do |browser, regexp|
+        match = @user_agent.match(regexp)
+        version = match.captures.first if match
+        if version
+          @browser = browser
+          @version = version
+          break
+        end
+      end
+    end
+    # Detects the HTML5 features the browser supports
+    def detect_features
+      return unless @browser && @version
+      feature_mapping[browser].each do |feature, version|
+         if version
+           raise "Versions are not comparable: #{version}, #{@version}" if comparable_version(version).length != comparable_version(@version).length
+           if comparable_version(@version) >= comparable_version(version)
+             @features << feature
+           end
+         end
+       end
+    end
+    # New features are only being shipped with major version updated.
+    # So we'll be on the safe side using the first two parts of the version number for comparisation.
+    # eg. version 10.5.6a will be cut down to 10.5, dots will be stripped, return value would be 105
+    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
+      {
+        :firefox => {
+          :wysiwyg => "3.5",
+          :classname => "3.0",
+          :elements => "3.0",
+          :canvas => "3.0",
+          :messaging => "3.0",
+          :audio => "3.5",
+          :video => "3.5",
+          :textapi => "3.5",
+          :draganddrop => "3.5",
+          :offline => "3.5",
+          :forms => nil,
+          :svg => nil
+        },
+        :ie => {
+          :wysiwyg => "6.0",
+          :classname => nil,
+          :elements => nil,
+          :canvas => nil,
+          :messaging => "8.0",
+          :audio => nil,
+          :video => nil,
+          :textapi => nil,
+          :draganddrop => nil,
+          :offline => nil,
+          :forms => nil,
+          :svg => nil
+        },
+        :opera => {
+          :wysiwyg => "10.1",
+          :classname => "10.1",
+          :elements => "10.1",
+          :canvas => "10.1",
+          :messaging => "10.1",
+          :audio => "10.5",
+          :video => "10.5",
+          :textapi => "10.5",
+          :draganddrop => nil,
+          :offline => "10.6",
+          :forms => "10.1",
+          :svg => nil
+        },
+        :chrome => {
+          :wysiwyg => "3.0",
+          :classname => "3.0",
+          :elements => "3.0",
+          :canvas => "3.0",
+          :messaging => "3.0",
+          :audio => "3.0",
+          :video => "3.0",
+          :textapi => "3.0",
+          :draganddrop => "3.0",
+          :offline => "4.0",
+          :forms => nil,
+          :svg => nil
+        },
+        :safari => {
+          :wysiwyg => "3.2",
+          :classname => "3.2",
+          :elements => "3.2",
+          :canvas => "3.2",
+          :messaging => "4.0",
+          :audio => "3.2",
+          :video => "3.2",
+          :textapi => "4.2",
+          :draganddrop => "4.0",
+          :offline => "4.0",
+          :forms => nil,
+          :svg => nil
+        }
+      }
+    end
+    # Browser to user agent matching
+    def user_agent_matcher
+      regexp_version = /((\d+\.?)+)/
+      {
+        :firefox => /Firefox\/#{regexp_version}/, # eg. Firefox/1.5.0.12
+        :ie => /MSIE #{regexp_version}/, # eg. compatible; MSIE 7.0;
+        :chrome => /Chrome\/#{regexp_version}/, # eg. Chrome/5.0.307.11 Safari/532.9
+        :safari => /AppleWebKit\/.*Version\/#{regexp_version}/, # eg. AppleWebKit/531.21.8 Version/4.0.4 Safari/531.21.10
+        :opera => /Opera\/#{regexp_version}/, # eg. Opera/9.80
+      }
+    end
+  end
+end

data/rack-html5.gemspec ADDED Viewed

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{rack-html5}
+  s.version = "1.0.0"
+  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.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"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/rack-html5.rb",
+     "lib/rack/html5.rb",
+     "rack-html5.gemspec",
+     "rake/jeweler.rb",
+     "rake/rdoc.rb",
+     "rake/test.rb",
+     "test/rack/html5_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/masone/rack-html5}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Rack::Html5 sets custom headers for each HTML5 feature the browser supports.}
+  s.test_files = [
+    "test/rack/html5_test.rb",
+     "test/test_helper.rb"
+  ]
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end

data/rake/jeweler.rb ADDED Viewed

@@ -0,0 +1,15 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "rack-html5"
+    s.summary = "Rack::Html5 sets custom headers for each HTML5 feature the browser supports."
+    s.description = "Rack::Html5 sets custom headers for each HTML5 feature the browser supports."
+    s.email = "ema@rh-productions.ch"
+    s.homepage = "http://github.com/masone/rack-html5"
+    s.authors = ["Christian Felder (masone)"]
+    s.add_development_dependency "shoulda"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/rake/rdoc.rb ADDED Viewed

@@ -0,0 +1,16 @@
+require 'hanna/rdoctask'
+desc 'Generate RDoc documentation'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_files.include('README.rdoc').
+    include('*.rb').
+    include('lib/**/*.rb').
+    exclude('test/*').
+    exclude('rake/*').
+    exclude('pkg/*')
+  rdoc.main = "README.rdoc" # page to start on
+  rdoc.title = "Rack::Html5"
+  rdoc.rdoc_dir = 'doc' # rdoc output folder
+end

data/rake/test.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require 'rake'
+require 'rake/testtask'
+desc 'Run test suite'
+task :test do
+  Rake::TestTask.new do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose = true
+  end
+end

data/test/rack/html5_test.rb ADDED Viewed

@@ -0,0 +1,117 @@
+require 'test_helper'
+require 'rack/html5'
+class Rack::Html5Test < Test::Unit::TestCase
+  def setup
+    @app = lambda { |env| [200, {}, [""]] }
+    @rack = Rack::Html5.new(@app)
+  end
+  context "browser detection" do
+    should "detect firefox from Firefox/3.6.6" do
+      env = { 'HTTP_USER_AGENT' => "Mozilla/5.0 (X11; U; Darwin Power Macintosh; en-US; rv:1.8.0.12) Gecko/20070803 Firefox/3.6.6 Fink Community Edition" }
+      @rack.call(env)
+      assert_equal :firefox, @rack.browser
+    end
+    should "detect ie from MSIE 7.0" do
+      env = { 'HTTP_USER_AGENT' => "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; GTB6.4; .NET CLR 1.1.4322; FDM; .NET CLR 2.0.50727; .NET CLR 3.0.04506.30; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729)" }
+      @rack.call(env)
+      assert_equal :ie, @rack.browser
+    end
+    should "detect opera from Opera/9.80" do
+      env = { 'HTTP_USER_AGENT' => "Opera/9.62 (Windows NT 5.1; U; en) Presto/2.1.1" }
+      @rack.call(env)
+      assert_equal :opera, @rack.browser
+    end
+    should "detect safari from AppleWebKit/525.19" do
+      env = { 'HTTP_USER_AGENT' => "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/525.19 (KHTML, like Gecko) Version/3.1.2 Safari/525.21" }
+      @rack.call(env)
+      assert_equal :safari, @rack.browser
+    end
+    should "detect chrome from Chrome/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" }
+      @rack.call(env)
+      assert_equal :chrome, @rack.browser
+    end
+  end
+  context "version detection" do
+    should "detect 3.6.6 from Firefox/3.6.6" do
+      env = { 'HTTP_USER_AGENT' => "Mozilla/5.0 (X11; U; Darwin Power Macintosh; en-US; rv:1.8.0.12) Gecko/20070803 Firefox/3.6.6 Fink Community Edition" }
+      @rack.call(env)
+      assert_equal "3.6.6", @rack.version
+    end
+    should "detect 7.0 from MSIE 7.0" do
+      env = { 'HTTP_USER_AGENT' => "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1; GTB6.4; .NET CLR 1.1.4322; FDM; .NET CLR 2.0.50727; .NET CLR 3.0.04506.30; .NET CLR 3.0.4506.2152; .NET CLR 3.5.30729)" }
+      @rack.call(env)
+      assert_equal "7.0", @rack.version
+    end
+    should "detect 9.80 from Opera/9.80" do
+      env = { 'HTTP_USER_AGENT' => "Opera/9.80 (Windows NT 5.1; U; en) Presto/2.1.1" }
+      @rack.call(env)
+      assert_equal "9.80", @rack.version
+    end
+    should "detect 3.1.2 from AppleWebKit/525.19 Version/3.1.2" do
+      env = { 'HTTP_USER_AGENT' => "Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US) AppleWebKit/525.19 (KHTML, like Gecko) Version/3.1.2 Safari/525.21" }
+      @rack.call(env)
+      assert_equal "3.1.2", @rack.version
+    end
+    should "detect 5.0.307.11 from Chrome/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" }
+      @rack.call(env)
+      assert_equal "5.0.307.11", @rack.version
+    end
+  end
+  context "features" do
+    should "detect features 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 @rack.features.length > 0
+    end
+    # TODO: mock features and test them
+  end
+  context "headers" do
+    should "set the 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']
+    end
+    should "set the 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']
+    end
+    should "set the x-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']
+    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')
+    end
+  end
+end

data/test/test_helper.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ require 'test/unit'
2	+ require 'shoulda'

metadata ADDED Viewed

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: rack-html5
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors:
+- Christian Felder (masone)
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-07-14 00:00:00 +02:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Rack::Html5 sets custom headers for each HTML5 feature the browser supports.
+email: ema@rh-productions.ch
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rack-html5.rb
+- lib/rack/html5.rb
+- rack-html5.gemspec
+- rake/jeweler.rb
+- rake/rdoc.rb
+- rake/test.rb
+- test/rack/html5_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/masone/rack-html5
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+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:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Rack::Html5 sets custom headers for each HTML5 feature the browser supports.
+test_files:
+- test/rack/html5_test.rb
+- test/test_helper.rb