device_detector 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b1d7d2d1f51f584026667fa8fff86b9d4cf994d
-  data.tar.gz: dc71e14d78d7432fd03ea583fbaaf039a1aa3242
+  metadata.gz: 3831c0674436e07a0133b2396d2662d9e7c557e7
+  data.tar.gz: 913f71fc60c565076298fd8eb9a6c93184e048b0
 SHA512:
-  metadata.gz: 956b2f1762edd6106dd96a8c920b88d0e1b323552790ba46d533063028802c4ca91f739a4c49d95a4ade4f273f1abad48a2a73781177ccdfd776857c45e087cc
-  data.tar.gz: 49a4bbc2a254452296f155e11837772afb3a4399308a18eb035c98ab0f7ead38ab850f0650b802043c4701afe077788ebae5a1ae33d52e4a2d2d6926281f6de6
+  metadata.gz: 9f1fb95f6cfda05b85d7ae536c592f59098ba36075eff80ddbaca323505c4177023fdf9b879e3a2c769e085c25df5f61d5dababa019f1a15afc67e84d6f147d8
+  data.tar.gz: c29d2e75eaf37b83201b95ceeed6118157388c58e340c0d489beca60b0936250002e0b72759295b27d80229af900d3674d511208d1cf325fd2fdbed54bfa92f2

data/README.md

@@ -48,6 +48,19 @@ client.os_full_version # => '10_8_5'
 
 `DeviceDetector` will return `nil` on all attributes, if the `user_agent` is unknown.
 
+### Memory cache
+
+`DeviceDetector` will cache up 5,000 user agent strings to boost parsing performance.
+You can tune the amount of keys that will get saved in the cache:
+
+```ruby
+
+# You have to call this code **before** you initialize the Detector
+DeviceDetector.configure do |config|
+  config.max_cache_keys = 20_000 # if you have enough RAM, proceed with care
+end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/device_detector/fork )

data/lib/device_detector.rb

@@ -5,6 +5,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'device_detector/version'
 require 'device_detector/version_extractor'
+require 'device_detector/memory_cache'
 require 'device_detector/parser'
 require 'device_detector/bot'
 require 'device_detector/client'
@@ -46,6 +47,33 @@ class DeviceDetector
     bot.name
   end
 
+  class << self
+
+    class Configuration
+      attr_accessor :max_cache_keys
+
+      def to_hash
+        {
+          max_cache_keys: max_cache_keys
+        }
+      end
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def cache
+      @cache ||= MemoryCache.new(config.to_hash)
+    end
+
+    def configure(&block)
+      @config = Configuration.new
+      yield(config)
+    end
+
+  end
+
   private
 
   def bot

data/lib/device_detector/memory_cache.rb

@@ -0,0 +1,56 @@
+class DeviceDetector
+  class MemoryCache
+
+    DEFAULT_MAX_KEYS = 5000
+
+    attr_reader :data, :max_keys
+
+    def initialize(config)
+      @data = {}
+      @max_keys = config[:max_cache_keys] || DEFAULT_MAX_KEYS
+      @lock = Mutex.new
+    end
+
+    def set(key, value)
+      lock.synchronize do
+        purge_cache
+        data[String(key)] = value
+      end
+    end
+
+    def get(key)
+      data[String(key)]
+    end
+
+    def key?(string_key)
+      data.key?(string_key)
+    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
+    end
+
+    private
+
+    attr_reader :lock
+
+    def purge_cache
+      key_size = data.keys.size
+
+      if key_size >= max_keys
+        # 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
+end

data/lib/device_detector/parser.rb

@@ -1,6 +1,8 @@
 class DeviceDetector
   class Parser < Struct.new(:user_agent)
 
+    ROOT = Pathname.new(File.expand_path('../../..', __FILE__))
+
     def name
       regex_meta['name']
     end
@@ -16,11 +18,13 @@ class DeviceDetector
     end
 
     def matching_regex
-      regexes.find { |r| user_agent =~ Regexp.new(r['regex']) }
+      DeviceDetector.cache.get_or_set([self.class.name, user_agent]) do
+        regexes.find { |r| user_agent =~ Regexp.new(r['regex']) }
+      end
     end
 
     def regexes
-      YAML.load(filepaths.map { |filepath| File.read(filepath) }.join)
+      self.class.regexes_for(filepaths)
     end
 
     def filenames
@@ -29,12 +33,15 @@ class DeviceDetector
 
     def filepaths
       filenames.map do |filename|
-        File.join(root, 'regexes', filename)
+        File.join(ROOT, 'regexes', filename)
       end
     end
 
-    def root
-      Pathname.new(File.expand_path('../../..', __FILE__))
+    # This is a performance optimization.
+    # We cache the regexes on the class for better performance
+    # Thread-safety shouldn't be an issue, as we do only perform reads
+    def self.regexes_for(filepaths)
+      @regexes ||= YAML.load(filepaths.map { |filepath| File.read(filepath) }.join)
     end
 
   end

data/lib/device_detector/version.rb

@@ -1,3 +1,3 @@
 class DeviceDetector
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/device_detector/memory_cache_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+RSpec.describe DeviceDetector::MemoryCache do
+
+  let(:subject) { DeviceDetector::MemoryCache.new(config) }
+
+  let(:config) { {} }
+
+  describe '#set' do
+
+    context 'string key' do
+
+      let(:key) { 'string' }
+
+      it 'sets the value under the key' do
+        subject.set(key, 'value')
+
+        expect(subject.data[key]).to eq('value')
+      end
+
+    end
+
+    context 'array key' do
+
+      let(:key) { ['string1', 'string2'] }
+
+      it 'sets the value under the key' do
+        subject.set(key, 'value')
+
+        expect(subject.data[String(key)]).to eq('value')
+      end
+
+    end
+
+  end
+
+  describe '#get' do
+
+    context 'string key' do
+
+      let(:key) { 'string' }
+
+      it 'gets the value for the key' do
+        subject.data[key] = 'value'
+
+        expect(subject.get(key)).to eq('value')
+      end
+
+    end
+
+    context 'array key' do
+
+      let(:key) { ['string1', 'string2'] }
+
+      it 'gets the value for the key' do
+        subject.data[String(key)] = 'value'
+
+        expect(subject.get(key)).to eq('value')
+      end
+
+    end
+
+  end
+
+  describe '#get_or_set' do
+
+    let(:key) { 'string' }
+
+    context 'value already present' do
+
+      it 'gets the value for the key from cache' do
+        subject.data[key] = 'value'
+
+        block_called = false
+        value = subject.get_or_set(key) do
+          block_called = true
+        end
+
+        expect(value).to eq('value')
+        expect(block_called).to eq(false)
+      end
+
+    end
+
+    context 'value not yet present' do
+
+      it 'evaluates the block and sets the result' do
+        block_called = false
+        subject.get_or_set(key) do
+          block_called = true
+        end
+
+        expect(block_called).to eq(true)
+        expect(subject.data[key]).to eq(true)
+      end
+
+    end
+
+  end
+
+  describe 'cache purging' do
+
+    let(:config) { { max_cache_keys: 3 } }
+
+    it 'purges the cache when key size arrives at max' do
+      subject.set('1', 'foo')
+      subject.set('2', 'bar')
+      subject.set('3', 'baz')
+      subject.set('4', 'boz')
+
+      expect(subject.data.keys.size).to eq(3)
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: device_detector
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mati Sójka
@@ -62,6 +62,7 @@ files:
 - lib/device_detector.rb
 - lib/device_detector/bot.rb
 - lib/device_detector/client.rb
+- lib/device_detector/memory_cache.rb
 - lib/device_detector/os.rb
 - lib/device_detector/parser.rb
 - lib/device_detector/version.rb
@@ -75,6 +76,7 @@ files:
 - regexes/mobile_apps.yml
 - regexes/oss.yml
 - regexes/pim.yml
+- spec/device_detector/memory_cache_spec.rb
 - spec/device_detector/version_extractor_spec.rb
 - spec/device_detector_spec.rb
 - spec/spec_helper.rb
@@ -103,6 +105,7 @@ signing_key:
 specification_version: 4
 summary: Universal Device Detection
 test_files:
+- spec/device_detector/memory_cache_spec.rb
 - spec/device_detector/version_extractor_spec.rb
 - spec/device_detector_spec.rb
 - spec/spec_helper.rb