browser_detect 0.0.1 → 0.0.4

data/init.rb

@@ -0,0 +1,5 @@
+if Rails::VERSION::MAJOR == 2
+	ActionView::Base.send(:include, BrowserDetect)
+else
+	require "railtie" if defined?(Rails)
+end

data/lib/browser_detect.rb

@@ -1,2 +1,73 @@
-require 'browser_detect/browser_detect_helper'
-ActionController::Base.send(:include, BrowserDetect::BrowserDetectHelper)
+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
+
+  # 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
+
+		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
+
+  #Gather the user agent and store it for use.
+	def ua
+		@ua ||= begin
+			request.env['HTTP_USER_AGENT'].downcase
+		rescue
+			''
+		end
+	end
+end

data/lib/railtie.rb

@@ -0,0 +1,13 @@
+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
+
+	end
+end

data/test/browser_detect_test.rb

@@ -0,0 +1,55 @@
+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
+end
+
+class BrowserDetectMock
+  include BrowserDetect
+
+	def initialize(user_agent=nil)
+		@user_agent = user_agent
+	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  
+end

data/test/fixtures/user_agents.yml

@@ -0,0 +1,47 @@
+browsers:
+- nickname: ie6
+  ua: "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)"
+  name:
+    - ie
+    - ie6
+- nickname: ie7
+  ua: "Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0)"
+  name:
+    - ie
+    - ie7
+- nickname: ie8
+  ua: "Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1)"
+  name:
+    - ie
+    - ie8
+
+- nickname: googlebot
+  ua: "Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)"
+  name: 
+    - googlebot
+    - robots
+
+- nickname: msnbot
+  ua: "msnbot/1.1 (+http://search.msn.com/msnbot.htm)"
+  name: 
+    - msnbot
+    - robots
+
+- nickname: yahoobot
+  ua: "Mozilla/5.0 (compatible; Yahoo! Slurp; http://help.yahoo.com/help/us/ysearch/slurp)"
+  name:
+    - yahoobot
+    - robots
+
+- nickname: iphone3
+  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
+
+- nickname: safari4_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

data/test/test_helper.rb

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'test/unit'
+require 'yaml'
+
+$LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+module Test::Unit
+  # @ see http://gist.github.com/316780
+	# Used to fix a minor minitest/unit incompatibility in flexmock
+	# AssertionFailedError = Class.new(StandardError)
+
+	class TestCase
+
+		def self.must(name, &block)
+			test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+			defined = instance_method(test_name) rescue false
+			raise "#{test_name} is already defined in #{self}" if defined
+			if block_given?
+				define_method(test_name, &block)
+			else
+				define_method(test_name) do
+					flunk "No implementation provided for #{name}"
+				end
+			end
+		end
+
+	end
+end
+
+# @see http://push.cx/2007/fixtures-in-ruby-unit-tests
+class Test::Unit::TestCase
+	@@fixtures = {}
+	def self.fixtures *args
+		[args].flatten.each do |fixture|
+			self.class_eval do
+				# add a method name for this fixture type
+				define_method(fixture) do |item|
+					# load and cache the YAML
+					@@fixtures[fixture] ||= YAML::load_file("./fixtures/#{fixture.to_s}.yml")
+					@@fixtures[fixture][item.to_s]
+				end
+			end
+		end
+	end
+end

metadata

@@ -5,16 +5,19 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
+- rlivsey
 - faunzy
+- tmlee
+- ggilder
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-10-21 00:00:00 -04:00
+date: 2010-11-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +37,7 @@ dependencies:
         version: 1.0.0.rc.6
   type: :development
   version_requirements: *id001
-description: Client browser detector
+description: "\tSimple rails browser detection based on original plugin by Richard Livsey\"\n"
 email: []
 
 executables: []
@@ -44,16 +47,46 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- .yardopts
 - Gemfile
-- README
+- README.md
 - Rakefile
-- browser_detect-0.0.1.gem
+- VERSION
 - browser_detect.gemspec
+- doc/BrowserDetect.html
+- doc/BrowserDetectHelperTest.html
+- doc/BrowserDetectMock.html
+- doc/BrowserDetectMock/req;.html
+- doc/Test.html
+- doc/Test/Unit.html
+- doc/Test/Unit/TestCase.html
+- doc/Test/browser_detect_test_rb.html
+- doc/Test/test_helper_rb.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/init_rb.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/lib/version_rb.html
+- doc/method_list.html
+- doc/top-level-namespace.html
+- init.rb
 - lib/browser_detect.rb
-- lib/browser_detect/browser_detect_helper.rb
-- lib/browser_detect/version.rb
+- lib/railtie.rb
+- test/browser_detect_test.rb
+- test/fixtures/user_agents.yml
+- test/test_helper.rb
 has_rdoc: true
-homepage: http://rubygems.org/gems/browser_detect
+homepage: http://github.com/traction/browser_detect
 licenses: []
 
 post_install_message: 
@@ -85,6 +118,6 @@ rubyforge_project: browser_detect
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Detects the client's browser
+summary: A simple rails browser detection plugin
 test_files: []
 

data/lib/browser_detect/browser_detect_helper.rb

@@ -1,43 +0,0 @@
-module BrowserDetect
-  module BrowserDetectHelper
-  
-    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' && browser_name == ('safari' or 'chrome' or 'iphone' or 'ipad')
-    end
-  
-    def browser_name
-      @browser_name ||= begin
-  
-        ua = request.env['HTTP_USER_AGENT'].downcase
-        
-        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('ipad') 
-          'ipad'
-        elsif ua.index('iphone') 
-          'iphone'
-        elsif ua.index('chrome/')
-          'chrome'
-        elsif ua.index('applewebkit/')
-          'safari'
-        elsif ua.index('mozilla/')
-          'gecko'
-        end
-      
-      end
-    end  
-  
-  end
-end

data/lib/browser_detect/version.rb

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