browser2 1.0.0

data/lib/browser/methods/platform.rb

@@ -0,0 +1,142 @@
+class Browser
+  module Platform
+    # Detect if browser is Android.
+    def android?(version = nil)
+      !!(ua =~ /Android/ && !opera?) && detect_version?(android_version, version)
+    end
+
+    # Detect Android version.
+    def android_version
+      ua[/Android ([\d.]+)/, 1]
+    end
+
+    # Return the iOS version.
+    def ios_version
+      ua[/OS (\d)/, 1]
+    end
+
+    # Detect if browser is ios?.
+    def ios?(version = nil)
+      (ipod? || ipad? || iphone?) && detect_version?(ios_version, version)
+    end
+
+    # Detect if is iOS4.
+    def ios4?
+      deprecate "Browser##{__method__} is deprecated; use Browser#ios?(version) instead"
+      ios?(4)
+    end
+
+    # Detect if is iOS5.
+    def ios5?
+      deprecate "Browser##{__method__} is deprecated; use Browser#ios?(version) instead"
+      ios?(5)
+    end
+
+    # Detect if is iOS6.
+    def ios6?
+      deprecate "Browser##{__method__} is deprecated; use Browser#ios?(version) instead"
+      ios?(6)
+    end
+
+    # Detect if is iOS7.
+    def ios7?
+      deprecate "Browser##{__method__} is deprecated; use Browser#ios?(version) instead"
+      ios?(7)
+    end
+
+    # Detect if is iOS8.
+    def ios8?
+      deprecate "Browser##{__method__} is deprecated; use Browser#ios?(version) instead"
+      ios?(8)
+    end
+
+    # Detect if is iOS9.
+    def ios9?
+      deprecate "Browser##{__method__} is deprecated; use Browser#ios?(version) instead"
+      ios?(9)
+    end
+
+    # Detect if current platform is Macintosh.
+    def mac?
+      !!(ua =~ /Mac OS X/ && !ios?)
+    end
+
+    # Detect if current platform is Windows.
+    def windows?
+      !!(ua =~ /Windows/)
+    end
+
+    ## More info here => http://msdn.microsoft.com/fr-FR/library/ms537503.aspx#PltToken
+    def windows_xp?
+      windows? && !!(ua =~ /Windows NT 5.1/)
+    end
+
+    def windows_vista?
+      windows? && !!(ua =~ /Windows NT 6.0/)
+    end
+
+    def windows7?
+      windows? && !!(ua =~ /Windows NT 6.1/)
+    end
+
+    def windows8?
+      windows? && !!(ua =~ /Windows NT 6.[2-3]/)
+    end
+
+    def windows8_1?
+      windows? && !!(ua =~ /Windows NT 6\.3/)
+    end
+
+    def windows10?
+      windows? && !!(ua =~ /Windows NT 10/)
+    end
+
+    def windows_rt?
+      windows8? && !!(ua =~ /ARM/)
+    end
+
+    # Detect if current platform is Windows Mobile.
+    def windows_mobile?
+      !!(ua =~ /Windows CE/)
+    end
+
+    # Detect if current platform is Windows Phone.
+    def windows_phone?
+      !!(ua =~ /Windows Phone/)
+    end
+
+    # Detect if current platform is Windows in 64-bit architecture.
+    def windows_x64?
+      windows? && !!(ua =~ /(Win64|x64)/) && !!(ua =~ /x64/)
+    end
+
+    def windows_wow64?
+      windows? && !!(ua =~ /WOW64/i)
+    end
+
+    def windows_x64_inclusive?
+      windows_x64? || windows_wow64?
+    end
+
+    # Detect if current platform is Linux flavor.
+    def linux?
+      in_ua? 'Linux'
+    end
+
+    # Detect if current platform is ChromeOS
+    def chrome_os?
+      in_ua? 'CrOS'
+    end
+
+    # Return the platform.
+    def platform
+      case
+      when linux?     then :linux
+      when mac?       then :mac
+      when windows?   then :windows
+      else
+        :other
+      end
+    end
+  end
+end

data/lib/browser/methods/tv.rb

@@ -0,0 +1,8 @@
+class Browser
+  module Tv
+    # Detect if browser is Television
+    def tv?
+      !!(ua =~ /(tv|Android.*?ADT-1|Nexus Player)/i)
+    end
+  end
+end

data/lib/browser/middleware/context/additions.rb

@@ -0,0 +1,16 @@
+require "browser/middleware/context/url_methods"
+
+class Browser
+  class Middleware
+    class Context
+      module Additions
+        extend ActiveSupport::Concern
+
+        included do
+          include Rails.application.routes.url_helpers
+          include UrlMethods
+        end
+      end
+    end
+  end
+end

data/lib/browser/middleware/context/url_methods.rb

@@ -0,0 +1,13 @@
+class Browser
+  class Middleware
+    class Context
+      module UrlMethods
+        def default_url_options
+          Rails.configuration.browser.default_url_options ||
+          Rails.configuration.action_mailer.default_url_options ||
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/browser/middleware/context.rb

@@ -0,0 +1,20 @@
+class Browser
+  class Middleware
+    class Context
+      attr_reader :browser, :request
+
+      def initialize(request)
+        @request = request
+
+        @browser = Browser.new(
+          ua: request.user_agent,
+          accept_language: request.env["HTTP_ACCEPT_LANGUAGE"]
+        )
+      end
+
+      def redirect_to(path)
+        throw :redirected, path.to_s
+      end
+    end
+  end
+end

data/lib/browser/middleware.rb

@@ -0,0 +1,66 @@
+require "uri"
+
+class Browser
+  class Middleware
+    # Detect the most common assets.
+    ASSETS_REGEX = /\.(css|png|jpe?g|gif|js|svg|ico|flv|mov|m4v|ogg|swf)\z/i
+
+    # Detect the ACCEPT header. IE8 send */*.
+    ACCEPT_REGEX = %r[(text/html|\*/\*)]
+
+    def initialize(app, &block)
+      fail ArgumentError, "Browser::Middleware requires a block" unless block
+
+      @app = app
+      @block = block
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+
+      # Only apply verification on HTML requests.
+      # This ensures that images, CSS and JavaScript
+      # will be rendered.
+      return run_app(env) unless process?(request)
+
+      path = catch(:redirected) do
+        Context.new(request).instance_eval(&@block)
+      end
+
+      # No path, no match.
+      return run_app(env) unless path
+
+      resolve_redirection(env, request.path, path)
+    end
+
+    def resolve_redirection(env, current_path, path)
+      uri = URI.parse(path)
+
+      if uri.path == current_path
+        run_app(env)
+      else
+        redirect(path)
+      end
+    end
+
+    def redirect(path)
+      [302, {"Content-Type" => "text/html", "Location" => path}, []]
+    end
+
+    def run_app(env)
+      @app.call(env)
+    end
+
+    def process?(request)
+      html?(request) && !assets?(request)
+    end
+
+    def html?(request)
+      request.env["HTTP_ACCEPT"].to_s.match(ACCEPT_REGEX)
+    end
+
+    def assets?(request)
+      request.path.match(ASSETS_REGEX)
+    end
+  end
+end

data/lib/browser/rails.rb

@@ -0,0 +1,14 @@
+require "rails/railtie"
+require "browser/action_controller"
+require "browser/middleware/context/additions"
+
+class Browser
+  class Railtie < Rails::Railtie
+    config.browser = ActiveSupport::OrderedOptions.new
+
+    initializer "browser" do
+      ::ActionController::Base.send :include, Browser::ActionController
+      Browser::Middleware::Context.send :include, Browser::Middleware::Context::Additions
+    end
+  end
+end

data/lib/browser/version.rb

@@ -0,0 +1,8 @@
+class Browser
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/lib/browser.rb

@@ -0,0 +1,255 @@
+# frozen_string_literal: true
+
+require "multi_json"
+require "pathname"
+require "set"
+require "yaml"
+
+require "browser/data/bots"
+require "browser/data/languages"
+require "browser/data/search_engines"
+
+require "browser/middleware"
+require "browser/middleware/context"
+require "browser/rails" if defined?(::Rails)
+
+require "browser/methods/ie"
+require "browser/methods/blackberry"
+require "browser/methods/platform"
+require "browser/methods/mobile"
+require "browser/methods/devices"
+require "browser/methods/consoles"
+require "browser/methods/language"
+require "browser/methods/bots"
+require "browser/methods/tv"
+
+require "browser/meta/base"
+require "browser/meta/generic_browser"
+require "browser/meta/id"
+require "browser/meta/ie"
+require "browser/meta/ios"
+require "browser/meta/mobile"
+require "browser/meta/modern"
+require "browser/meta/platform"
+require "browser/meta/safari"
+require "browser/meta/webkit"
+
+class Browser
+  include IE
+  include BlackBerry
+  include Platform
+  include Mobile
+  include Devices
+  include Consoles
+  include Language
+  include Bots
+  include Tv
+
+  # Get the browser's UA string; this is immutable after initialization.
+  attr_reader :user_agent
+  alias_method :ua, :user_agent
+
+  NAMES = {
+    edge: "Microsoft Edge",   # Must come before everything
+    ie: "Internet Explorer",  # Must come before android
+    chrome: "Chrome",         # Must come before android
+    firefox: "Firefox",       # Must come before android
+    android: "Android",
+    blackberry_running_safari: "Safari",
+    blackberry: "BlackBerry",
+    core_media: "Apple CoreMedia",
+    ipad: "iPad",             # Must come before safari
+    iphone: "iPhone",         # Must come before safari
+    ipod: "iPod Touch",       # Must come before safari
+    nintendo: "Nintendo",
+    opera: "Opera",
+    phantom_js: "PhantomJS",
+    psp: "PlayStation Portable",
+    playstation: "PlayStation",
+    quicktime: "QuickTime",
+    safari: "Safari",
+    xbox: "Xbox",
+
+    # This must be last item, since Ruby 1.9+ has ordered keys.
+    other: "Other",
+  }
+
+  VERSIONS = {
+    edge: %r[Edge/([\d.]+)],
+    chrome: %r[(?:Chrome|CriOS)/([\d.]+)],
+    default: %r[(?:Version|MSIE|Firefox|QuickTime|BlackBerry[^/]+|CoreMedia v|PhantomJS|AdobeAIR)[/ ]?([a-z0-9.]+)]i,
+    opera: %r[(?:Opera/.*? Version/([\d.]+)|Chrome/.*?OPR/([\d.]+))],
+    ie: %r[(?:MSIE |Trident/.*?; rv:)([\d.]+)]
+  }
+
+  # Define the rules which define a modern browser.
+  # A rule must be a proc/lambda or any object that implements the method
+  # === and accepts the browser object.
+  #
+  # To redefine all rules, clear the existing rules before adding your own.
+  #
+  #   # Only Chrome Canary is considered modern.
+  #   Browser.modern_rules.clear
+  #   Browser.modern_rules << -> b { b.chrome? && b.version >= '37' }
+  #
+  def self.modern_rules
+    @modern_rules ||= []
+  end
+
+  self.modern_rules.tap do |rules|
+    rules << -> b { b.webkit? }
+    rules << -> b { b.firefox? && b.version.to_i >= 17 }
+    rules << -> b { b.ie? && b.version.to_i >= 9 && !b.compatibility_view? }
+    rules << -> b { b.edge? && !b.compatibility_view? }
+    rules << -> b { b.opera? && b.version.to_i >= 12 }
+    rules << -> b { b.firefox? && b.tablet? && b.android? && b.version.to_i >= 14 }
+  end
+
+  # Create a new browser instance and set
+  # the UA and Accept-Language headers.
+  #
+  #   browser = Browser.new({
+  #     :ua => "Safari",
+  #     :accept_language => "pt-br"
+  #   })
+  #
+  def initialize(options = {})
+    user_agent = options[:user_agent] || options[:ua]
+    unless user_agent
+      raise ArgumentError, 'Must receive a :user_agent or :ua option'
+    end
+
+    @user_agent = user_agent.to_s
+    self.accept_language = options[:accept_language].to_s
+
+    yield self if block_given?
+  end
+
+  # Get readable browser name.
+  def name
+    NAMES[id]
+  end
+
+  # Get the browser identifier.
+  def id
+    @id ||=
+      NAMES.keys
+        .find {|id| respond_to?("#{id}?", true) ? send("#{id}?") : id }
+  end
+
+  # Return major version.
+  def version
+    if ie?
+      ie_version
+    else
+      full_version.to_s.split(".").first
+    end
+  end
+
+  # Return the full version.
+  def full_version
+    @full_version ||=
+      if ie?
+        ie_full_version
+      else
+        _, *v = *ua.match(VERSIONS.fetch(id, VERSIONS[:default]))
+        v.compact.first || "0.0"
+      end
+  end
+
+  # Return true if browser is modern (Webkit, Firefox 17+, IE9+, Opera 12+).
+  def modern?
+    self.class.modern_rules.any? { |rule| rule.call self }
+  end
+
+  # Detect if browser is WebKit-based.
+  def webkit?
+    ua =~ /AppleWebKit/i && !edge?
+  end
+
+  # Detect if browser is QuickTime
+  def quicktime?
+    !!(ua =~ /QuickTime/i)
+  end
+
+  # Detect if browser is Apple CoreMedia.
+  def core_media?
+    !!(ua =~ /CoreMedia/)
+  end
+
+  # Detect if browser is PhantomJS
+  def phantom_js?
+    !!(ua =~ /PhantomJS/)
+  end
+
+  # Detect if browser is Safari.
+  def safari?
+    (in_ua?('Safari') || safari_webapp_mode?) && ua !~ /Android|Chrome|CriOS|PhantomJS/
+  end
+
+  def safari_webapp_mode?
+    (ipad? || iphone?) && in_ua?('AppleWebKit')
+  end
+
+  # Detect if browser is Firefox.
+  def firefox?
+    in_ua? 'Firefox'
+  end
+
+  # Detect if browser is Chrome.
+  def chrome?
+    (in_ua?('Chrome') || in_ua?('CriOS')) && !opera? && !edge?
+  end
+
+  # Detect if browser is Opera.
+  def opera?
+    in_ua?('Opera') || in_ua?('OPR')
+  end
+
+  # Detect if browser is Silk.
+  def silk?
+    in_ua? 'Silk'
+  end
+
+  # Detect if browser is Yandex.
+  def yandex?
+    in_ua? 'YaBrowser'
+  end
+
+  def known?
+    id != :other
+  end
+
+  # Return a meta info about this browser.
+  def meta
+    @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
+
+  alias_method :to_a, :meta
+
+  # Return meta representation as string.
+  def to_s
+    meta.to_a.join(" ")
+  end
+
+  private
+
+  def detect_version?(actual_version, expected_version)
+    return true unless expected_version
+    actual_version.to_s.start_with?(expected_version.to_s)
+  end
+
+  # Private shorthand for checking if a given string is in the user agent.
+  def in_ua? string
+    ua.include? string
+  end
+
+  def deprecate(message)
+    offender = caller[1].to_s[/^(.*?\.rb:\d+).*?$/, 1]
+    $stderr << "\n#{message} (called from #{offender})\n"
+  end
+end

data/test/benchmark_test.rb

@@ -0,0 +1,83 @@
+require 'test_helper'
+
+require 'benchmark'
+require 'minitest/benchmark'
+
+class BenchmarkTest < Minitest::Benchmark
+  def self.bench_range
+    [100, 10_000]
+  end
+
+  def bench_chrome
+    assert_browser_performance($ua['CHROME']) do |browser|
+      assert_equal "Chrome", browser.name
+      assert browser.chrome?
+      refute browser.safari?
+      assert browser.webkit?
+      assert browser.modern?
+      assert_equal "5.0.375.99", browser.full_version
+      assert_equal "5", browser.version
+    end
+  end
+
+  def bench_firefox
+    assert_browser_performance($ua["FIREFOX_MODERN"]) do |browser|
+      assert_equal :firefox, browser.id
+      assert_equal "Firefox", browser.name
+      assert browser.firefox?
+      assert browser.modern?
+      assert_equal "17.0", browser.full_version
+      assert_equal "17", browser.version
+    end
+  end
+
+  def bench_bots
+    assert_browser_performance($ua['GOOGLE_BOT']) do |browser|
+      assert browser.bot?
+      assert_equal browser.bot_name, 'Googlebot'
+    end
+  end
+
+  private
+
+  WARMUP        = 1_000
+  ITERATIONS    = 10_000
+  GC_ITERATIONS = 1_00
+
+  def assert_browser_performance ua, &test_block
+    block = proc do
+      browser = Browser.new ua: ua
+
+      test_block.call browser
+    end
+
+    WARMUP.times &block
+
+    time = Benchmark.realtime do
+      ITERATIONS.times &block
+    end
+
+    objects = benchmark_memory &block
+
+    print "#{name}\t%10.5f seconds\t%d objects\n" % [time, objects]
+  end
+
+  def validation_noop
+    proc { }
+  end
+
+  def benchmark_memory &block
+    GC.start
+
+    before_allocated = GC.stat[:total_allocated_objects]
+    GC.disable
+
+    GC_ITERATIONS.times &block
+
+    after_allocated = GC.stat[:total_allocated_objects]
+    GC.enable
+
+    return after_allocated - before_allocated
+  end
+
+end