device_detector 0.9.1 → 1.0.4

data/lib/device_detector/memory_cache.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class DeviceDetector
   class MemoryCache
-
     DEFAULT_MAX_KEYS = 5000
+    STORES_NIL_VALUE = :__is_nil__
 
     attr_reader :data, :max_keys, :lock
     private :lock
@@ -15,41 +17,46 @@ class DeviceDetector
     def set(key, value)
       lock.synchronize do
         purge_cache
-        data[String(key)] = value
+        # convert nil values into symbol so we know a value is present
+        cache_value = value.nil? ? STORES_NIL_VALUE : value
+        data[String(key)] = cache_value
+        value
       end
     end
 
     def get(key)
-      data[String(key)]
-    end
-
-    def key?(string_key)
-      data.key?(string_key)
+      value, _hit = get_hit(key)
+      value
     end
 
     def get_or_set(key, value = nil)
       string_key = String(key)
 
-      if key?(string_key)
-        get(string_key)
-      else
-        value = yield if block_given?
-        set(string_key, value)
-      end
+      result, hit = get_hit(string_key)
+      return result if hit
+
+      value = yield if block_given?
+      set(string_key, value)
     end
 
     private
 
+    def get_hit(key)
+      value = data[String(key)]
+      is_hit = !value.nil? || value == STORES_NIL_VALUE
+      value = nil if value == STORES_NIL_VALUE
+      [value, is_hit]
+    end
+
     def purge_cache
       key_size = data.size
 
-      if key_size >= max_keys
-        # always remove about 1/3 of keys to reduce garbage collecting
-        amount_of_keys = key_size / 3
+      return if key_size < max_keys
 
-        data.keys.first(amount_of_keys).each { |key| data.delete(key) }
-      end
-    end
+      # always remove about 1/3 of keys to reduce garbage collecting
+      amount_of_keys = key_size / 3
 
+      data.keys.first(amount_of_keys).each { |key| data.delete(key) }
+    end
   end
 end

data/lib/device_detector/metadata_extractor.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 class DeviceDetector
   class MetadataExtractor < Struct.new(:user_agent, :regex_meta)
-
     def call
       regex_meta.any? ? extract_metadata : nil
     end
@@ -8,22 +9,20 @@ class DeviceDetector
     private
 
     def metadata_string
-      message = "#{self.name} (a child of MetadataExtractor) must implement the '#{__method__}' method."
-      fail NotImplementedError, message
+      message = "#{name} (a child of MetadataExtractor) must implement the '#{__method__}' method."
+      raise NotImplementedError, message
     end
 
     def extract_metadata
       user_agent.match(regex) do |match_data|
-        metadata_string.gsub(/\$(\d)/) {
-          match_data[$1.to_i].to_s
-        }.strip
+        metadata_string.gsub(/\$(\d)/) do
+          match_data[Regexp.last_match(1).to_i].to_s
+        end.strip
       end
     end
 
     def regex
       @regex ||= regex_meta[:regex]
     end
-
   end
 end
-

data/lib/device_detector/model_extractor.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 class DeviceDetector
   class ModelExtractor < MetadataExtractor
-
     def call
-      s = super.to_s.gsub('_',' ').strip
+      s = super.to_s.gsub('_', ' ').strip
       s = s.gsub(/ TD$/i, '')
 
       return nil if s == 'Build'
@@ -19,6 +20,5 @@ class DeviceDetector
     def regex
       @regex ||= regex_meta[:regex_model] || regex_meta[:regex]
     end
-
   end
 end

data/lib/device_detector/name_extractor.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 class DeviceDetector
   class NameExtractor < MetadataExtractor
-
     def call
       if /\$[0-9]/ =~ metadata_string
         extract_metadata
@@ -14,6 +15,5 @@ class DeviceDetector
     def metadata_string
       regex_meta[:name]
     end
-
   end
 end

data/lib/device_detector/os.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 require 'set'
 
 class DeviceDetector
   class OS < Parser
-
     def name
       os_info[:name]
     end
@@ -38,125 +39,134 @@ class DeviceDetector
       end
     end
 
-    DESKTOP_OSS = Set.new(['AmigaOS', 'IBM', 'GNU/Linux', 'Mac', 'Unix', 'Windows', 'BeOS', 'Chrome OS'])
+    DESKTOP_OSS = Set.new(
+      [
+        'AmigaOS', 'IBM', 'GNU/Linux', 'Mac', 'Unix', 'Windows', 'BeOS', 'Chrome OS'
+      ]
+    )
 
     # OS short codes mapped to long names
     OPERATING_SYSTEMS = {
-        'AIX' => 'AIX',
-        'AND' => 'Android',
-        'AMG' => 'AmigaOS',
-        'ATV' => 'Apple TV',
-        'ARL' => 'Arch Linux',
-        'BTR' => 'BackTrack',
-        'SBA' => 'Bada',
-        'BEO' => 'BeOS',
-        'BLB' => 'BlackBerry OS',
-        'QNX' => 'BlackBerry Tablet OS',
-        'BMP' => 'Brew',
-        'CES' => 'CentOS',
-        'COS' => 'Chrome OS',
-        'CYN' => 'CyanogenMod',
-        'DEB' => 'Debian',
-        'DFB' => 'DragonFly',
-        'FED' => 'Fedora',
-        'FOS' => 'Firefox OS',
-        'BSD' => 'FreeBSD',
-        'GNT' => 'Gentoo',
-        'GTV' => 'Google TV',
-        'HPX' => 'HP-UX',
-        'HAI' => 'Haiku OS',
-        'IRI' => 'IRIX',
-        'INF' => 'Inferno',
-        'KNO' => 'Knoppix',
-        'KBT' => 'Kubuntu',
-        'LIN' => 'GNU/Linux',
-        'LBT' => 'Lubuntu',
-        'VLN' => 'VectorLinux',
-        'MAC' => 'Mac',
-        'MAE' => 'Maemo',
-        'MDR' => 'Mandriva',
-        'SMG' => 'MeeGo',
-        'MCD' => 'MocorDroid',
-        'MIN' => 'Mint',
-        'MLD' => 'MildWild',
-        'MOR' => 'MorphOS',
-        'NBS' => 'NetBSD',
-        'MTK' => 'MTK / Nucleus',
-        'WII' => 'Nintendo',
-        'NDS' => 'Nintendo Mobile',
-        'OS2' => 'OS/2',
-        'T64' => 'OSF1',
-        'OBS' => 'OpenBSD',
-        'PSP' => 'PlayStation Portable',
-        'PS3' => 'PlayStation',
-        'RHT' => 'Red Hat',
-        'ROS' => 'RISC OS',
-        'REM' => 'Remix OS',
-        'RZD' => 'RazoDroiD',
-        'SAB' => 'Sabayon',
-        'SSE' => 'SUSE',
-        'SAF' => 'Sailfish OS',
-        'SLW' => 'Slackware',
-        'SOS' => 'Solaris',
-        'SYL' => 'Syllable',
-        'SYM' => 'Symbian',
-        'SYS' => 'Symbian OS',
-        'S40' => 'Symbian OS Series 40',
-        'S60' => 'Symbian OS Series 60',
-        'SY3' => 'Symbian^3',
-        'TDX' => 'ThreadX',
-        'TIZ' => 'Tizen',
-        'UBT' => 'Ubuntu',
-        'WTV' => 'WebTV',
-        'WIN' => 'Windows',
-        'WCE' => 'Windows CE',
-        'WMO' => 'Windows Mobile',
-        'WPH' => 'Windows Phone',
-        'WRT' => 'Windows RT',
-        'XBX' => 'Xbox',
-        'XBT' => 'Xubuntu',
-        'YNS' => 'YunOs',
-        'IOS' => 'iOS',
-        'POS' => 'palmOS',
-        'WOS' => 'webOS'
-       }
-
-    DOWNCASED_OPERATING_SYSTEMS = OPERATING_SYSTEMS.each_with_object({}){|(short,long),h| h[long.downcase] = short}
+      'AIX' => 'AIX',
+      'AND' => 'Android',
+      'AMG' => 'AmigaOS',
+      'ATV' => 'Apple TV',
+      'ARL' => 'Arch Linux',
+      'BTR' => 'BackTrack',
+      'SBA' => 'Bada',
+      'BEO' => 'BeOS',
+      'BLB' => 'BlackBerry OS',
+      'QNX' => 'BlackBerry Tablet OS',
+      'BMP' => 'Brew',
+      'CES' => 'CentOS',
+      'COS' => 'Chrome OS',
+      'CYN' => 'CyanogenMod',
+      'DEB' => 'Debian',
+      'DFB' => 'DragonFly',
+      'FED' => 'Fedora',
+      'FOS' => 'Firefox OS',
+      'FIR' => 'Fire OS',
+      'BSD' => 'FreeBSD',
+      'GNT' => 'Gentoo',
+      'GTV' => 'Google TV',
+      'HPX' => 'HP-UX',
+      'HAI' => 'Haiku OS',
+      'IRI' => 'IRIX',
+      'INF' => 'Inferno',
+      'KOS' => 'KaiOS',
+      'KNO' => 'Knoppix',
+      'KBT' => 'Kubuntu',
+      'LIN' => 'GNU/Linux',
+      'LBT' => 'Lubuntu',
+      'VLN' => 'VectorLinux',
+      'MAC' => 'Mac',
+      'MAE' => 'Maemo',
+      'MDR' => 'Mandriva',
+      'SMG' => 'MeeGo',
+      'MCD' => 'MocorDroid',
+      'MIN' => 'Mint',
+      'MLD' => 'MildWild',
+      'MOR' => 'MorphOS',
+      'NBS' => 'NetBSD',
+      'MTK' => 'MTK / Nucleus',
+      'WII' => 'Nintendo',
+      'NDS' => 'Nintendo Mobile',
+      'OS2' => 'OS/2',
+      'T64' => 'OSF1',
+      'OBS' => 'OpenBSD',
+      'ORD' => 'Ordissimo',
+      'PSP' => 'PlayStation Portable',
+      'PS3' => 'PlayStation',
+      'RHT' => 'Red Hat',
+      'ROS' => 'RISC OS',
+      'REM' => 'Remix OS',
+      'RZD' => 'RazoDroiD',
+      'SAB' => 'Sabayon',
+      'SSE' => 'SUSE',
+      'SAF' => 'Sailfish OS',
+      'SLW' => 'Slackware',
+      'SOS' => 'Solaris',
+      'SYL' => 'Syllable',
+      'SYM' => 'Symbian',
+      'SYS' => 'Symbian OS',
+      'S40' => 'Symbian OS Series 40',
+      'S60' => 'Symbian OS Series 60',
+      'SY3' => 'Symbian^3',
+      'TDX' => 'ThreadX',
+      'TIZ' => 'Tizen',
+      'TOS' => 'TmaxOS',
+      'UBT' => 'Ubuntu',
+      'WTV' => 'WebTV',
+      'WIN' => 'Windows',
+      'WCE' => 'Windows CE',
+      'WIO' => 'Windows IoT',
+      'WMO' => 'Windows Mobile',
+      'WPH' => 'Windows Phone',
+      'WRT' => 'Windows RT',
+      'XBX' => 'Xbox',
+      'XBT' => 'Xubuntu',
+      'YNS' => 'YunOs',
+      'IOS' => 'iOS',
+      'POS' => 'palmOS',
+      'WOS' => 'webOS'
+    }.freeze
+
+    DOWNCASED_OPERATING_SYSTEMS = OPERATING_SYSTEMS.each_with_object({}) do |(short, long), h|
+      h[long.downcase] = short
+    end
 
     OS_FAMILIES = {
-        'Android'               => ['AND', 'CYN', 'REM', 'RZD', 'MLD', 'MCD', 'YNS'],
-        'AmigaOS'               => ['AMG', 'MOR'],
-        'Apple TV'              => ['ATV'],
-        'BlackBerry'            => ['BLB', 'QNX'],
-        'Brew'                  => ['BMP'],
-        'BeOS'                  => ['BEO', 'HAI'],
-        'Chrome OS'             => ['COS'],
-        'Firefox OS'            => ['FOS'],
-        'Gaming Console'        => ['WII', 'PS3'],
-        'Google TV'             => ['GTV'],
-        'IBM'                   => ['OS2'],
-        'iOS'                   => ['IOS'],
-        'RISC OS'               => ['ROS'],
-        'GNU/Linux'             => ['LIN', 'ARL', 'DEB', 'KNO', 'MIN', 'UBT', 'KBT', 'XBT', 'LBT', 'FED', 'RHT', 'VLN', 'MDR', 'GNT', 'SAB', 'SLW', 'SSE', 'CES', 'BTR', 'SAF'],
-        'Mac'                   => ['MAC'],
-        'Mobile Gaming Console' => ['PSP', 'NDS', 'XBX'],
-        'Real-time OS'          => ['MTK', 'TDX'],
-        'Other Mobile'          => ['WOS', 'POS', 'SBA', 'TIZ', 'SMG', 'MAE'],
-        'Symbian'               => ['SYM', 'SYS', 'SY3', 'S60', 'S40'],
-        'Unix'                  => ['SOS', 'AIX', 'HPX', 'BSD', 'NBS', 'OBS', 'DFB', 'SYL', 'IRI', 'T64', 'INF'],
-        'WebTV'                 => ['WTV'],
-        'Windows'               => ['WIN'],
-        'Windows Mobile'        => ['WPH', 'WMO', 'WCE', 'WRT']
-    }
-
-    FAMILY_TO_OS = OS_FAMILIES.each_with_object({}) do |(family,oss),h|
-      oss.each{|os| h[os] = family}
+      'Android' => %w[AND CYN FIR REM RZD MLD MCD YNS],
+      'AmigaOS' => %w[AMG MOR],
+      'Apple TV' => ['ATV'],
+      'BlackBerry' => %w[BLB QNX],
+      'Brew' => ['BMP'],
+      'BeOS' => %w[BEO HAI],
+      'Chrome OS' => ['COS'],
+      'Firefox OS' => %w[FOS KOS],
+      'Gaming Console' => %w[WII PS3],
+      'Google TV' => ['GTV'],
+      'IBM' => ['OS2'],
+      'iOS' => ['IOS'],
+      'RISC OS' => ['ROS'],
+      'GNU/Linux' => %w[LIN ARL DEB KNO MIN UBT KBT XBT LBT FED RHT VLN MDR GNT SAB SLW SSE CES BTR SAF ORD TOS],
+      'Mac' => ['MAC'],
+      'Mobile Gaming Console' => %w[PSP NDS XBX],
+      'Real-time OS' => %w[MTK TDX],
+      'Other Mobile' => %w[WOS POS SBA TIZ SMG MAE],
+      'Symbian' => %w[SYM SYS SY3 S60 S40],
+      'Unix' => %w[SOS AIX HPX BSD NBS OBS DFB SYL IRI T64 INF],
+      'WebTV' => ['WTV'],
+      'Windows' => ['WIN'],
+      'Windows Mobile' => %w[WPH WMO WCE WRT WIO]
+    }.freeze
+
+    FAMILY_TO_OS = OS_FAMILIES.each_with_object({}) do |(family, oss), h|
+      oss.each { |os| h[os] = family }
     end
 
     def filenames
       ['oss.yml']
     end
-
   end
-
 end

data/lib/device_detector/parser.rb

@@ -1,7 +1,17 @@
+# frozen_string_literal: true
+
 class DeviceDetector
-  class Parser < Struct.new(:user_agent)
+  class Parser
+    ROOT = File.expand_path('../..', __dir__)
+
+    REGEX_CACHE = ::DeviceDetector::MemoryCache.new({})
+    private_constant :REGEX_CACHE
+
+    def initialize(user_agent)
+      @user_agent = user_agent
+    end
 
-    ROOT = File.expand_path('../../..', __FILE__)
+    attr_reader :user_agent
 
     def name
       from_cache(['name', self.class.name, user_agent]) do
@@ -32,17 +42,17 @@ class DeviceDetector
     end
 
     def filenames
-      fail NotImplementedError
+      raise NotImplementedError
     end
 
     def filepaths
       filenames.map do |filename|
-        [ filename.to_sym, File.join(ROOT, 'regexes', filename) ]
+        [filename.to_sym, File.join(ROOT, 'regexes', filename)]
       end
     end
 
     def regexes_for(file_paths)
-      from_cache(['regexes', self.class]) do
+      REGEX_CACHE.get_or_set(file_paths) do
         load_regexes(file_paths).flat_map { |path, regex| parse_regexes(path, regex) }
       end
     end
@@ -54,16 +64,20 @@ class DeviceDetector
     def symbolize_keys!(object)
       case object
       when Array
-        object.map!{ |v| symbolize_keys!(v) }
+        object.map! { |v| symbolize_keys!(v) }
       when Hash
-        object.keys.each{ |k| object[k.to_sym] = symbolize_keys!(object.delete(k)) if k.is_a?(String) }
+        keys = object.keys
+        keys.each do |k|
+          object[k.to_sym] = symbolize_keys!(object.delete(k)) if k.is_a?(String)
+        end
       end
       object
     end
 
     def parse_regexes(path, raw_regexes)
       raw_regexes.map do |meta|
-        fail "invalid device spec: #{meta.inspect}" unless meta[:regex].is_a? String
+        raise "invalid device spec: #{meta.inspect}" unless meta[:regex].is_a? String
+
         meta[:regex] = build_regex(meta[:regex])
         meta[:path] = path
         meta
@@ -77,6 +91,5 @@ class DeviceDetector
     def from_cache(key)
       DeviceDetector.cache.get_or_set(key) { yield }
     end
-
   end
 end