Class: Browser

Inherits:
Object
  • Object
show all
Includes:
Devices, IE, Language, Mobile, Platform
Defined in:
lib/browser.rb,
lib/browser/rails.rb,
lib/browser/meta/id.rb,
lib/browser/meta/ie.rb,
lib/browser/version.rb,
lib/browser/meta/ios.rb,
lib/browser/meta/base.rb,
lib/browser/methods/ie.rb,
lib/browser/middleware.rb,
lib/browser/meta/mobile.rb,
lib/browser/meta/modern.rb,
lib/browser/meta/safari.rb,
lib/browser/meta/webkit.rb,
lib/browser/meta/platform.rb,
lib/browser/methods/mobile.rb,
lib/browser/methods/devices.rb,
lib/browser/methods/language.rb,
lib/browser/methods/platform.rb,
lib/browser/action_controller.rb,
lib/browser/middleware/context.rb,
lib/browser/meta/generic_browser.rb,
lib/browser/middleware/context/additions.rb,
lib/browser/middleware/context/url_methods.rb

Defined Under Namespace

Modules: ActionController, Devices, IE, Language, Meta, Mobile, Platform, Version Classes: Middleware, Railtie

Constant Summary collapse

NAMES = 
{
  :android    => "Android",
  :blackberry => "BlackBerry",
  :chrome     => "Chrome",
  :core_media => "Apple CoreMedia",
  :firefox    => "Firefox",
  :ie         => "Internet Explorer",
  :ipad       => "iPad",
  :iphone     => "iPhone",
  :ipod       => "iPod Touch",
  :opera      => "Opera",
  :phantom_js => "PhantomJS",
  :psp        => "PlayStation Portable",
  :quicktime  => "QuickTime",
  :safari     => "Safari",

  # This must be last item, since Ruby 1.9+ has ordered keys.
  :other      => "Other",
}
VERSIONS = 
{
  :default => %r[(?:Version|MSIE|Firefox|Chrome|CriOS|QuickTime|BlackBerry[^/]+|CoreMedia v|PhantomJS)[/ ]?([a-z0-9.]+)]i,
  :opera => %r[(?:Opera/.*? Version/([\d.]+)|Chrome/([\d.]+).*?OPR)]
}

Constants included from Language

Language::LANGUAGES

Constants included from IE

IE::TRIDENT_VERSION_REGEX

Instance Attribute Summary collapse

Attributes included from Language

#accept_language

Instance Method Summary collapse

Methods included from Devices

#ipad?, #iphone?, #ipod?, #kindle?, #playbook?, #psp?, #surface?, #tablet?

Methods included from Mobile

#blackberry?, #mobile?, #opera_mini?

Methods included from Platform

#android?, #ios4?, #ios5?, #ios6?, #ios?, #linux?, #mac?, #platform, #windows8?, #windows?, #windows_rt?

Methods included from IE

#compatibility_view?, #ie10?, #ie6?, #ie7?, #ie8?, #ie9?, #ie?

Constructor Details

#initialize(options = {}) {|_self| ... } ⇒ Browser

Create a new browser instance and set the UA and Accept-Language headers.

browser = Browser.new({
  :ua => "Safari",
  :accept_language => "pt-br"
})

Yields:

  • (_self)

Yield Parameters:

  • _self (Browser) —

    the object that the method was called on



69
70
71
72
73
74
 
# File 'lib/browser.rb', line 69

def initialize(options = {}, &block)
  self.user_agent = (options[:user_agent] || options[:ua]).to_s
  self.accept_language = options[:accept_language].to_s

  yield self if block_given?
end

Instance Attribute Details

#user_agent ⇒ Object Also known as: ua

Set browser’s UA string.



32
33
34
 
# File 'lib/browser.rb', line 32

def user_agent
  @user_agent
end

Instance Method Details

#chrome? ⇒ Boolean

Detect if browser is Chrome.

Returns:

  • (Boolean) 


138
139
140
 
# File 'lib/browser.rb', line 138

def chrome?
  !!(ua =~ /Chrome|CriOS/) && !opera?
end

#core_media? ⇒ Boolean

Detect if browser is Apple CoreMedia.

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/browser.rb', line 118

def core_media?
  !!(ua =~ /CoreMedia/)
end

#firefox? ⇒ Boolean

Detect if browser is Firefox.

Returns:

  • (Boolean) 


133
134
135
 
# File 'lib/browser.rb', line 133

def firefox?
  !!(ua =~ /Firefox/)
end

#full_version ⇒ Object

Return the full version.



93
94
95
96
 
# File 'lib/browser.rb', line 93

def full_version
  _, *v = *ua.match(VERSIONS.fetch(id, VERSIONS[:default]))
  v.compact.first || "0.0"
end

#id ⇒ Object

Get the browser identifier.



82
83
84
85
 
# File 'lib/browser.rb', line 82

def id
  NAMES.keys
    .find {|id| respond_to?("#{id}?") ? public_send("#{id}?") : id }
end

#meta ⇒ Object Also known as: to_a

Return a meta info about this browser.



153
154
155
156
157
158
 
# File 'lib/browser.rb', line 153

def meta
  Meta.constants.each_with_object(Set.new) do |meta_name, meta|
    meta_class = Meta.const_get(meta_name)
    meta.merge(meta_class.new(self).to_a)
  end.to_a
end

#modern? ⇒ Boolean

Return true if browser is modern (Webkit, Firefox 17+, IE9+, Opera 12+).

Returns:

  • (Boolean) 


99
100
101
102
103
104
105
 
# File 'lib/browser.rb', line 99

def modern?
  webkit? ||
  (firefox? && version.to_i >= 17) ||
  (ie? && version.to_i >= 9) ||
  (opera? && version.to_i >= 12) ||
  (firefox? && tablet? && android? && version.to_i >= 14)
end

#name ⇒ Object

Get readable browser name.



77
78
79
 
# File 'lib/browser.rb', line 77

def name
  NAMES[id]
end

#opera? ⇒ Boolean

Detect if browser is Opera.

Returns:

  • (Boolean) 


143
144
145
 
# File 'lib/browser.rb', line 143

def opera?
  !!(ua =~ /(Opera|OPR)/)
end

#phantom_js? ⇒ Boolean

Detect if browser is PhantomJS

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/browser.rb', line 123

def phantom_js?
  !!(ua =~ /PhantomJS/)
end

#quicktime? ⇒ Boolean

Detect if browser is QuickTime

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/browser.rb', line 113

def quicktime?
  !!(ua =~ /QuickTime/i)
end

#safari? ⇒ Boolean

Detect if browser is Safari.

Returns:

  • (Boolean) 


128
129
130
 
# File 'lib/browser.rb', line 128

def safari?
  ua =~ /Safari/ && ua !~ /Chrome|CriOS|PhantomJS/
end

#silk? ⇒ Boolean

Detect if browser is Silk.

Returns:

  • (Boolean) 


148
149
150
 
# File 'lib/browser.rb', line 148

def silk?
  !!(ua =~ /Silk/)
end

#to_s ⇒ Object

Return meta representation as string.



163
164
165
 
# File 'lib/browser.rb', line 163

def to_s
  meta.to_a.join(" ")
end

#version ⇒ Object

Return major version.



88
89
90
 
# File 'lib/browser.rb', line 88

def version
  full_version.to_s.split(".").first
end

#webkit? ⇒ Boolean

Detect if browser is WebKit-based.

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/browser.rb', line 108

def webkit?
  !!(ua =~ /AppleWebKit/i)
end