browser_detect 0.0.4 → 0.0.5

data/.gitignore

@@ -1,4 +1,5 @@
 *.gemspec
 .svn
 .yardoc/
-.bundle/
+.bundle/
+.rvmrc

data/History.txt

@@ -0,0 +1,29 @@
+=== 0.0.5 2011-10-6
+
+* 2 Bugs fixed:
+  * Fixed Rails 3 Railtie support (thanks to eric1234)
+  * Fix detection of Safari
+  
+=== 0.0.4 2010-11-07
+
+* 1 major enhancement:
+  * Initial support for Rails 3 via Railtie
+  
+=== 0.0.3 2010-11-03
+
+* 2 major enhancements:
+  * Moved documentation from RDoc to Yard
+  * Changed Module name to BrowserDetect
+
+=== 0.0.2 2010-11-01
+
+* 4 major enhancements:
+  * fixed webkit detection and added webkit version querying 
+  * merge changes with tmlee
+  * added ios name and changed browser_name to return 'unknown' if nothing matches 
+  * corrected issues with test mocking, added tests for robots 
+
+=== 0.0.1 2010-10-21
+
+* 1 major enhancement:
+  * Added chrome, iphone, ipad to list of browsers and added support for these browsers to the browser_is? method

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/browser_detect_test.rb
+script/console
+script/destroy
+script/generate
+test/test_browser_detect_test.rb
+test/test_helper.rb

data/README.md

@@ -1,77 +1,69 @@
-Browser Detect
-==============
+# Browser Detect
 _It's like a crystal ball for user agents._
 
-Detect it.
-----------
+Browser Detect identifies the client browser using the user agent string that was supplied in the page request. Browser Detect searches the user agent string for any string you provide, and it also supports some special groupings and shortcuts:
 
-Detects the client browser using the user agent string that was used to make the page request. 
+  * ie (Any version of IE, excluding browsers like Opera and WebTV that identify themselves as IE)
+  * ie{integer} (A specific major version of IE — "ie6", "ie7", "ie8", etc.)
+  * robot (Google bot, MSN bot, Yahoo! bot)
+  * ios (iPhone, iPod, iPad)
+  * webkit (Any WebKit based browser)
+  * mobile (Any modern mobile browser — iOS, Android, Palm webOS)
 
-Browser Detect currently supports the following browsers and platforms:
+## Install it.
 
-Browsers:
+Using Bundler, all you need to do is add the source to your Gemfile:
 
-  * ie
-  * gecko
-  * konqueror
-  * opera
-  * ipad
-  * ipod
-  * iphone
-  * chrome
-  * safari
+	gem "browser_detect"
 
-Robots:
+Then run:
 
-  * googlebot
-  * msnbot
-  * yahoo!
+	bundle install
 
-Operating Systems:
+or, install it as a plugin using Rails 2:
 
-  * TODO
+	script/plugin install git://github.com/traction/browser_detect.git
 
-Install it:
------------
+## Wield it.
 
-Using Bundler, all you need to do is add the source to your Gemfile:
+To check if a particular browser made the request, use browser_is?(name)
 
-	gem "browser_detect", :require => "browser_detect", :git => 'git://github.com/traction/browser_detect.git'
+	def index
+		if browser_is?("chrome")
+			# load some chrome-specific content
+		end
+	end
 
-Then run:
+or in a view:
 
-	bundle install
-	
-or, install it as a plugin:
+	<%= browser_is?(:chrome) ? "secrets" : "buzz off" %>
 
-	script/plugin install git://github.com/traction/browser_detect.git
-	
-Wield it.
----------
+Don't forget you can use the special groupings listed above to target IE, robots, iOS, etc.
+
+	<%= stylesheet_link_tag "ugly_styles" if browser_is?('ie') %>
+	<%= stylesheet_link_tag "even_uglier_styles" if browser_is?('ie6') %>
+	<%= render "seo_spam_content" if browser_is?('robot') %>
 
-To check the type of browser, use browser_name
-@browser_name will return either 'ie', 'gecko', 'opera', 'konqueror', 'ipod', 'ipad', 'iphone', 'chrome', 'safari', 'googlebot', 'msnbot', 'yahoobot'
+There's also a convenience method `browser_is_mobile?` which is just a shortcut to `browser_is?('mobile')`
 
 	def index
-		@browser_name = browser_name
+		if browser_is_mobile?
+			# redirect to the mobile site
+		end
 	end
 
-To check if a particular browser made the request, use browser_name?(name)
-If the browser used is chrome, it will return True
+For WebKit-based browsers, you can also check the WebKit version using `browser_webkit_version`. This can be useful for determining what rendering capabilities the browser has. For instance, early versions of Mobile WebKit crash intermittently when you use multiple faces or weights of web fonts. So you might prevent your web fonts from rendering on old WebKit versions:
 
-	def index
-		@browser_type = browser_is?("chrome")
-	end
-	
-or in a view using ERB:
-	
-	<%= browser_is?(:chrome) ? "secrets" : "buzz off" %>
-	
-Or choose from the following groupings:
+	<%= stylesheet_link_tag "fonts" unless (browser_is?('ios') and browser_webkit_version < 532) %>
+
+## Contribute!
+
+Additions to the text fixtures (list of user agent strings for testing) are always welcome, as are new definitions of browser groupings. Please fork and submit a pull request!
+
+## Authors
 
- * mozilla
- * ie
- * webkit 
- * robots
-	
+Originally based on work by [rlivsey](http://github.com/rlivsey). Current contributors:
 
+  * [faunzy](http://github.com/faunzy)
+  * [ggilder](http://github.com/ggilder)
+  * [tmlee](http://github.com/tmlee)

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/browser_detect.rb

@@ -1,73 +1,56 @@
 module BrowserDetect
-  #Browser groupings
-	def browser_is? name
-		name = name.to_s.strip
-		return true if browser_name == name
-		return true if name == 'mozilla' && browser_name == 'gecko'
-		return true if name == 'ie' && browser_name.index('ie')
-		return true if name == 'webkit' && %w{safari chrome iphone ipad ipod}.include?(browser_name)
-		return true if name == 'ios' && %w{iphone ipad ipod}.include?(browser_name)
-		return true if name == 'robots' && %w{googlebot msnbot yahoobot}.include?(browser_name)
-	end
+  # Define browser groupings (mobile, robots, etc.)
+  # Also define complex queries like IE where we weed out user agents that pose as IE
+  # The default case just checks if the user agent contains the query string
+  def browser_is? query
+    query = query.to_s.strip.downcase
+    result = case query
+    when /^ie(\d+)$/
+      ua.index("msie #{$1}") && !ua.index('opera') && !ua.index('webtv')
+    when 'ie'
+      ua.match(/msie \d/) && !ua.index('opera') && !ua.index('webtv')
+    when 'yahoobot'
+      ua.index('yahoo! slurp')
+    when 'mozilla'
+      ua.index('gecko') || ua.index('mozilla')
+    when 'webkit'
+      ua.match(/webkit|iphone|ipad|ipod/)
+    when 'safari'
+      ua.index('safari') && !ua.index('chrome')
+    when 'ios'
+      ua.match(/iphone|ipad|ipod/)
+    when /^robot(s?)$/
+      ua.match(/googlebot|msnbot/) || browser_is?('yahoobot')
+    when 'mobile'
+      browser_is?('ios') || ua.match(/android|webos|mobile/)
+    else
+      ua.index(query)
+    end
+    not (result.nil? || result == false)
+  end
 
-  # Returns the user agent string as determined by the plugin
-	def browser_name
-		@browser_name ||= begin
-			if ua.index('msie') && !ua.index('opera') && !ua.index('webtv')
-				'ie'+ua[ua.index('msie')+5].chr
-			elsif ua.index('gecko/')
-				'gecko'
-			elsif ua.index('opera')
-				'opera'
-			elsif ua.index('konqueror')
-				'konqueror'
-			elsif ua.index('ipod')
-				'ipod'
-			elsif ua.index('ipad')
-				'ipad'
-			elsif ua.index('iphone')
-				'iphone'
-			elsif ua.index('chrome/')
-				'chrome'
-			elsif ua.index('applewebkit/')
-				'safari'
-			elsif ua.index('googlebot/')
-				'googlebot'
-			elsif ua.index('msnbot')
-				'msnbot'
-			elsif ua.index('yahoo! slurp')
-				'yahoobot'
-			#Everything thinks it's mozilla, so this goes last
-			elsif ua.index('mozilla/')
-				'gecko'
-			else
-				'unknown'
-			end
+  # Determine the version of webkit.
+  # Useful for determing rendering capabilities
+  # For instance, Mobile Webkit versions lower than 532 don't handle webfonts very well (intermittent crashing when using multiple faces/weights)
+  def browser_webkit_version
+    if browser_is? 'webkit'
+      match = ua.match(%r{\bapplewebkit/([\d\.]+)\b})
+      match[1].to_f if (match)
+    end or 0
+  end
 
-		end
-	end
-	
-	# Determine the version of webkit.
-	# Useful for determing rendering capabilties
-	def browser_webkit_version
-		if browser_is? 'webkit'
-			match = ua.match(%r{\bapplewebkit/([\d\.]+)\b})
-			if (match)
-				match[1].to_f
-			else
-				nil
-			end
-		else
-			nil
-		end
-	end
+  def browser_is_mobile?
+    browser_is? 'mobile'
+  end
 
-  #Gather the user agent and store it for use.
-	def ua
-		@ua ||= begin
-			request.env['HTTP_USER_AGENT'].downcase
-		rescue
-			''
-		end
-	end
-end
+  # Gather the user agent and store it for use.
+  def ua
+    @ua ||= begin
+      request.env['HTTP_USER_AGENT'].downcase
+    rescue
+      ''
+    end
+  end
+end
+
+require 'railtie' if defined? Rails

data/lib/railtie.rb

@@ -1,10 +1,6 @@
-require 'browser_detect'
-require 'rails'
-
 # lib/browser_detect/railtie.rb
 module BrowserDetectHelper
 	class Railtie < Rails::Railtie
-	  railtie_name :browser_detect
     initializer "browser_detect.configure_rails_initialization" do
       ApplicationController.send(:include, BrowserDetect)
     end

data/test/browser_detect_test.rb

@@ -2,54 +2,76 @@ require File.expand_path(File.dirname(__FILE__)+'/test_helper')
 require '../lib/browser_detect'
 
 class BrowserDetectTest < Test::Unit::TestCase
-	fixtures :user_agents
-	
-	def mock_browser(ua=nil)
-		BrowserDetectMock.new(ua)
-	end
-	
-	must "deal with nil user agent gracefully" do
-		assert_nothing_raised do
-			mock_browser.browser_name
-		end
-	end
-	
-	must "correctly mock a user agent string" do
-		mock = mock_browser("Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)")
-		assert_equal("Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)", mock.request.env['HTTP_USER_AGENT'])
-	end
-	
-	must "identify googlebot" do
-		mock = mock_browser("Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)")
-		assert_equal('googlebot', mock.browser_name)
-	end
-	
-	must "correctly identify known user agents" do
-		user_agents(:browsers).each do |browser|
-			mock = mock_browser(browser['ua'])
-			browser['name'].each do |name|
-				assert(mock.browser_is?(name), "Browser '#{browser['nickname']}' did not match name '#{name}'!")
-			end
-		end
-	end
+  fixtures :user_agents
+  
+  def mock_browser(ua=nil)
+    BrowserDetectMock.new(ua)
+  end
+  
+  must "deal with nil user agent gracefully" do
+    assert_nothing_raised do
+      mock_browser.browser_is?('something')
+    end
+  end
+  
+  must "correctly mock a user agent string" do
+    mock = mock_browser("Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)")
+    assert_equal("Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)", mock.request.env['HTTP_USER_AGENT'])
+  end
+  
+  must "identify googlebot" do
+    mock = mock_browser("Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)")
+    assert(mock.browser_is?('googlebot'))
+  end
+  
+  must "correctly identify known user agents" do
+    user_agents(:browsers).each do |browser|
+      mock = mock_browser(browser['ua'])
+      browser['name'].each do |name|
+        assert(mock.browser_is?(name), "Browser '#{browser['nickname']}' did not match name '#{name}'!")
+      end
+    end
+  end
+  
+  must "correctly identify webkit versions" do
+    mock = mock_browser("Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_7; en-us) AppleWebKit/533.4 (KHTML, like Gecko) Version/4.1 Safari/533.4")
+    assert(mock.browser_is?('webkit'))
+    assert_equal(533.4, mock.browser_webkit_version)
+  end
+  
+  must "not identify chrome as safari" do
+    mock = mock_browser("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_1) AppleWebKit/535.2 (KHTML, like Gecko) Chrome/15.0.874.81 Safari/535.2")
+    assert(mock.browser_is?('webkit'))
+    assert_equal(false, mock.browser_is?('safari'))
+    assert(mock.browser_is?('chrome'))
+    
+    assert_equal(535.2, mock.browser_webkit_version)
+  end
+
+  must "handle strange user agent strings for iOS apps" do
+    mock = mock_browser("Times/(null) (iPad; http://www.acrylicapps.com/pulp/)")
+    assert(mock.browser_is?('ios'))
+    assert(mock.browser_is?('webkit'))
+    assert_equal(0, mock.browser_webkit_version)
+  end
 end
 
 class BrowserDetectMock
   include BrowserDetect
 
-	def initialize(user_agent=nil)
-		@user_agent = user_agent
-	end
+  def initialize(user_agent=nil)
+    @user_agent = user_agent
+  end
 
-	def request
-		@req ||= mock_req
-	end
+  def request
+    @req ||= mock_req
+  end
 
-	def mock_req
-		req = Object.new
-		metaclass = class << req; self; end
-		user_agent = @user_agent
-		metaclass.send :define_method, :env, Proc.new { {'HTTP_USER_AGENT' => user_agent} }
-		req
-	end  
+  def mock_req
+    req = Object.new
+    metaclass = class << req; self; end
+    user_agent = @user_agent
+    metaclass.send :define_method, :env, Proc.new { {'HTTP_USER_AGENT' => user_agent} }
+    req
+  end  
 end

data/test/fixtures/user_agents.yml

@@ -26,6 +26,7 @@ browsers:
   name: 
     - msnbot
     - robots
+    - robot
 
 - nickname: yahoobot
   ua: "Mozilla/5.0 (compatible; Yahoo! Slurp; http://help.yahoo.com/help/us/ysearch/slurp)"
@@ -33,15 +34,72 @@ browsers:
     - yahoobot
     - robots
 
-- nickname: iphone3
+- nickname: "iphone 3"
   ua: "Mozilla/5.0 (iPhone; U; CPU iPhone OS 3_0 like Mac OS X; en-us) AppleWebKit/528.18 (KHTML, like Gecko) Version/4.0 Mobile/7A341 Safari/528.16"
   name:
     - iphone
     - ios
     - webkit
+    - mobile
+    - safari
+    
+- nickname: "iphone 4"
+  ua: "Mozilla/5.0 (iPhone; U; CPU iPhone OS 4_0 like Mac OS X; en-us) AppleWebKit/532.9 (KHTML, like Gecko) Version/4.0.5 Mobile/8A293 Safari/6531.22.7"
+  name:
+    - iphone
+    - ios
+    - webkit
+    - mobile
+    - safari
 
-- nickname: safari4_1
+- nickname: "safari 4.1"
   ua: "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_7; en-us) AppleWebKit/533.4 (KHTML, like Gecko) Version/4.1 Safari/533.4"
   name:
     - safari
-    - webkit
+    - webkit
+
+- nickname: "safari 4.0.4"
+  ua: "Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10_6_3; en-us) AppleWebKit/531.21.11 (KHTML, like Gecko) Version/4.0.4 Safari/531.21.10"
+  name:
+    - safari
+    - webkit
+
+- nickname: "Android G1"
+  ua: "Mozilla/5.0 (Linux; U; Android 1.1; en-gb; dream) AppleWebKit/525.10+ (KHTML, like Gecko) Version/3.0.4 Mobile Safari/523.12.2"
+  name:
+    - webkit
+    - safari
+    - mobile
+    - android
+
+- nickname: "Android Emulator"
+  ua: "Mozilla/5.0 (Linux; U; Android 1.0; en-us; generic) AppleWebKit/525.10+ (KHTML, like Gecko) Version/3.0.4 Mobile Safari/523.12.2"
+  name:
+    - webkit
+    - safari
+    - mobile
+    - android
+
+- nickname: "Android Nexus"
+  ua: "Mozilla/5.0 (Linux; U; Android 2.1; en-us; Nexus One Build/ERD62) AppleWebKit/530.17 (KHTML, like Gecko) Version/4.0 Mobile Safari/530.17"
+  name:
+    - webkit
+    - safari
+    - mobile
+    - android
+
+- nickname: "Palm Pre"
+  ua: "Mozilla/5.0 (webOS/1.4.0; U; en-US) AppleWebKit/532.2 (KHTML, like Gecko) Version/1.0 Safari/532.2 Pre/1.1"
+  name:
+    - webkit
+    - safari
+    - webos
+    - mobile
+
+- nickname: "Palm Pixi"
+  ua: "Mozilla/5.0 (webOS/1.4.0; U; en-US) AppleWebKit/532.2 (KHTML, like Gecko) Version/1.0 Safari/532.2 Pixi/1.1"
+  name:
+    - webkit
+    - safari
+    - webos
+    - mobile

metadata

@@ -1,14 +1,10 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: browser_detect
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - rlivsey
 - faunzy
 - tmlee
@@ -16,40 +12,31 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-11-08 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70213866353640 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
-        - 0
-        - rc
-        - 6
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.0.rc.6
   type: :development
-  version_requirements: *id001
-description: "\tSimple rails browser detection based on original plugin by Richard Livsey\"\n"
+  prerelease: false
+  version_requirements: *70213866353640
+description: ! "\tSimple rails browser detection based on original plugin by Richard
+  Livsey\"\n"
 email: []
-
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .yardopts
 - Gemfile
+- History.txt
+- Manifest.txt
 - README.md
 - Rakefile
 - VERSION
@@ -85,39 +72,28 @@ files:
 - test/browser_detect_test.rb
 - test/fixtures/user_agents.yml
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/traction/browser_detect
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: browser_detect
-rubygems_version: 1.3.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A simple rails browser detection plugin
 test_files: []
-