device_detector 0.9.1 → 1.0.4

data/spec/device_detector/detector_fixtures_spec.rb

@@ -15,6 +15,11 @@ describe DeviceDetector do
         fail "Failed to parse #{fixture_file}, reason: #{e}"
       end
 
+      def str_or_nil(string)
+        return nil if string == ''
+        string
+      end
+
       fixtures.each do |f|
 
         user_agent = f["user_agent"]
@@ -24,29 +29,64 @@ describe DeviceDetector do
         describe user_agent do
           it "should be detected" do
             if detector.bot?
-              assert_equal f["bot"]["name"], detector.bot_name, "failed bot name detection"
+              assert_equal str_or_nil(f["bot"]["name"]), detector.bot_name, "failed bot name detection"
             else
               if f["client"]
-                assert_equal f["client"]["name"], detector.name, "failed client name detection"
+                assert_equal str_or_nil(f["client"]["name"]), detector.name, "failed client name detection"
               end
-              if f["os_family"] != "Unknown"
-                assert_equal f["os_family"], os.family, "failed os family detection"
-                assert_equal f["os"]["name"], os.name, "failed os name detection"
-                assert_equal f["os"]["short_name"], os.short_name, "failed os short name detection"
-                assert_equal f["os"]["version"], os.full_version, "failed os version detection"
+
+              os_family = str_or_nil(f["os_family"])
+              if os_family != "Unknown"
+                if os_family.nil?
+                  assert_nil os.family, "failed os family detection"
+                else
+                  assert_equal os_family, os.family, "failed os family detection"
+                end
+
+                name = str_or_nil(f["os"]["name"])
+                if name.nil?
+                  assert_nil os.name, "failed os name detection"
+                else
+                  assert_equal name, os.name, "failed os name detection"
+                end
+
+                short_name = str_or_nil(f["os"]["short_name"])
+                if short_name.nil?
+                  assert_nil os.short_name, "failed os short name detection"
+                else
+                  assert_equal short_name, os.short_name, "failed os short name detection"
+                end
+
+                os_version = str_or_nil(f["os"]["version"])
+                if os_version.nil?
+                  assert_nil os.full_version, "failed os version detection"
+                else
+                  assert_equal os_version, os.full_version, "failed os version detection"
+                end
               end
               if f["device"]
-                expected_type = f["device"]["type"]
+                expected_type = str_or_nil(f["device"]["type"])
                 actual_type = detector.device_type
+
                 if expected_type != actual_type
                   # puts "\n", f.inspect, expected_type, actual_type, detector.device_name, regex_meta.inspect
                   # debugger
                   # detector.device_type
                 end
-                assert_equal expected_type, actual_type, "failed device type detection"
-                model = f["device"]["model"]
+                if expected_type.nil?
+                  assert_nil actual_type, "failed device type detection"
+                else
+                  assert_equal expected_type, actual_type, "failed device type detection"
+                end
+
+                model = str_or_nil(f["device"]["model"])
                 model = model.to_s unless model.nil?
-                assert_equal model, detector.device_name, "failed device name detection"
+
+                if model.nil?
+                  assert_nil detector.device_name, "failed device name detection"
+                else
+                  assert_equal model, detector.device_name, "failed device name detection"
+                end
               end
             end
           end

data/spec/device_detector/device_spec.rb

@@ -1,18 +1,18 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 
 describe DeviceDetector::Device do
-
   subject { DeviceDetector::Device.new(user_agent) }
 
-  alias :device :subject
+  alias_method :device, :subject
 
   describe '#name' do
-
     describe 'when models are nested' do
       let(:user_agent) { 'Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_3 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Mobile/12B466 [FBDV/iPhone7,2]' }
 
       it 'finds an Apple iPhone 6' do
-        device.name.must_equal 'iPhone 6'
+        value(device.name).must_equal 'iPhone 6'
       end
     end
 
@@ -20,7 +20,7 @@ describe DeviceDetector::Device do
       let(:user_agent) { 'AIRNESS-AIR99/REV 2.2.1/Teleca Q03B1' }
 
       it 'finds an Airness AIR99' do
-        device.name.must_equal 'AIR99'
+        value(device.name).must_equal 'AIR99'
       end
     end
 
@@ -28,19 +28,17 @@ describe DeviceDetector::Device do
       let(:user_agent) { 'UNKNOWN MODEL NAME' }
 
       it 'returns nil' do
-        device.name.must_be_nil
+        value(device.name).must_be_nil
       end
     end
-
   end
 
   describe '#type' do
-
     describe 'when models are nested' do
       let(:user_agent) { 'Mozilla/5.0 (iPhone; CPU iPhone OS 8_1_3 like Mac OS X) AppleWebKit/600.1.4 (KHTML, like Gecko) Mobile/12B466 [FBDV/iPhone7,2]' }
 
       it 'finds device of Apple iPhone 6' do
-        device.type.must_equal 'smartphone'
+        value(device.type).must_equal 'smartphone'
       end
     end
 
@@ -48,7 +46,7 @@ describe DeviceDetector::Device do
       let(:user_agent) { 'AIRNESS-AIR99/REV 2.2.1/Teleca Q03B1' }
 
       it 'finds the device of Airness AIR99' do
-        device.type.must_equal 'feature phone'
+        value(device.type).must_equal 'feature phone'
       end
     end
 
@@ -56,96 +54,78 @@ describe DeviceDetector::Device do
       let(:user_agent) { 'UNKNOWN MODEL TYPE' }
 
       it 'returns nil' do
-        device.type.must_be_nil
+        value(device.type).must_be_nil
       end
-
     end
 
     describe 'device not specified in nested block' do
-
       let(:user_agent) { 'Mozilla/5.0 (Linux; Android 4.4.2; es-us; SAMSUNG SM-G900F Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko)' }
 
       it 'falls back to top-level device' do
-        device.type.must_equal 'smartphone'
+        value(device.type).must_equal 'smartphone'
       end
-
     end
-
   end
 
   describe 'concrete device types' do
-
     describe 'mobiles' do
-
       let(:user_agent) { 'Mozilla/5.0 (Linux; Android 4.4.2; es-us; SAMSUNG SM-G900F Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko)' }
 
       it 'identifies the device' do
-        device.name.must_equal 'GALAXY S5'
-        device.type.must_equal 'smartphone'
-        device.brand.must_equal 'Samsung'
+        value(device.name).must_equal 'GALAXY S5'
+        value(device.type).must_equal 'smartphone'
+        value(device.brand).must_equal 'Samsung'
       end
-
     end
 
     describe 'cameras' do
-
       let(:user_agent) { 'Mozilla/5.0 (Linux; U; Android 4.0; xx-xx; EK-GC100 Build/IMM76D) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Mobile Safari/534.30' }
 
       it 'identifies the device' do
-        device.name.must_equal 'GALAXY Camera'
-        device.type.must_equal 'camera'
-        device.brand.must_equal 'Samsung'
+        value(device.name).must_equal 'GALAXY Camera'
+        value(device.type).must_equal 'camera'
+        value(device.brand).must_equal 'Samsung'
       end
-
     end
 
     describe 'car browsers' do
-
       let(:user_agent) { 'Mozilla/5.0 (X11; Linux) AppleWebKit/534.34 (KHTML, like Gecko) QtCarBrowser Safari/534.34' }
 
       it 'identifies the device' do
-        device.name.must_equal 'Model S'
-        device.type.must_equal 'car browser'
-        device.brand.must_be_nil
+        value(device.name).must_equal 'Model S'
+        value(device.type).must_equal 'car browser'
+        value(device.brand).must_equal 'Tesla'
       end
-
     end
 
     describe '(gaming) consoles' do
-
       let(:user_agent) { 'Opera/9.30 (Nintendo Wii; U; ; 2047-7;en)' }
 
       it 'identifies the device' do
-        device.name.must_equal 'Wii'
-        device.type.must_equal 'console'
-        device.brand.must_be_nil
+        value(device.name).must_equal 'Wii'
+        value(device.type).must_equal 'console'
+        value(device.brand).must_be_nil
       end
-
     end
 
     describe 'portable media players' do
-
       let(:user_agent) { 'Mozilla/5.0 (iPod touch; CPU iPhone OS 7_0_6 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Version/7.0 Mobile/11B651 Safari/9537.53' }
 
       it 'identifies the device' do
-        device.name.must_equal 'iPod Touch'
-        device.type.must_equal 'portable media player'
-        device.brand.must_equal 'Apple'
+        value(device.name).must_equal 'iPod Touch'
+        value(device.type).must_equal 'portable media player'
+        value(device.brand).must_equal 'Apple'
       end
-
     end
 
     describe 'televisions' do
-
       let(:user_agent) { 'Mozilla/5.0 (Unknown; Linux armv7l) AppleWebKit/537.1+ (KHTML, like Gecko) Safari/537.1+ HbbTV/1.1.1 ( ;LGE ;NetCast 4.0 ;03.10.81 ;1.0M ;)' }
 
       it 'identifies the device' do
-        device.name.must_equal 'NetCast 4.0'
-        device.type.must_equal 'tv'
-        device.brand.must_equal 'LG'
+        value(device.name).must_equal 'NetCast 4.0'
+        value(device.type).must_equal 'tv'
+        value(device.brand).must_equal 'LG'
       end
-
     end
   end
-
 end

data/spec/device_detector/memory_cache_spec.rb

@@ -1,73 +1,103 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 
 describe DeviceDetector::MemoryCache do
-
   let(:subject) { DeviceDetector::MemoryCache.new(config) }
 
   let(:config) { {} }
 
   describe '#set' do
-
     describe 'string key' do
-
       let(:key) { 'string' }
 
       it 'sets the value under the key' do
         subject.set(key, 'value')
 
-        subject.data[key].must_equal 'value'
+        value(subject.data[key]).must_equal 'value'
       end
 
+      it 'returns the value' do
+        value(subject.set(key, 'value')).must_equal 'value'
+        value(subject.set(key, false)).must_equal false
+        assert_nil subject.set(key, nil)
+      end
     end
 
     describe 'array key' do
-
-      let(:key) { ['string1', 'string2'] }
+      let(:key) { %w[string1 string2] }
 
       it 'sets the value under the key' do
         subject.set(key, 'value')
 
-        subject.data[String(key)].must_equal 'value'
+        value(subject.data[String(key)]).must_equal 'value'
       end
+    end
+
+    describe 'nil value' do
+      let(:key) { 'string' }
+      let(:internal_value) { DeviceDetector::MemoryCache::STORES_NIL_VALUE }
+
+      it 'sets the value under the key' do
+        subject.set(key, nil)
 
+        value(subject.data[String(key)]).must_equal internal_value
+        assert_nil subject.get(key)
+      end
+
+      it 'sets the value under the key' do
+        subject.get_or_set(key, nil)
+
+        value(subject.data[String(key)]).must_equal internal_value
+        assert_nil subject.get(key)
+      end
     end
 
+    describe 'false value' do
+      let(:key) { 'string' }
+
+      it 'sets the value under the key' do
+        subject.set(key, false)
+
+        value(subject.data[String(key)]).must_equal false
+        value(subject.get(key)).must_equal false
+      end
+
+      it 'sets the value under the key' do
+        subject.get_or_set(key, false)
+
+        value(subject.data[String(key)]).must_equal false
+        value(subject.get(key)).must_equal false
+      end
+    end
   end
 
   describe '#get' do
-
     describe 'string key' do
-
       let(:key) { 'string' }
 
       it 'gets the value for the key' do
         subject.data[key] = 'value'
 
-        subject.get(key).must_equal 'value'
+        value(subject.get(key)).must_equal 'value'
       end
-
     end
 
     describe 'array key' do
-
-      let(:key) { ['string1', 'string2'] }
+      let(:key) { %w[string1 string2] }
 
       it 'gets the value for the key' do
         subject.data[String(key)] = 'value'
 
-        subject.get(key).must_equal 'value'
+        value(subject.get(key)).must_equal 'value'
       end
-
     end
-
   end
 
   describe '#get_or_set' do
-
     let(:key) { 'string' }
 
     describe 'value already present' do
-
       it 'gets the value for the key from cache' do
         subject.data[key] = 'value'
 
@@ -76,30 +106,34 @@ describe DeviceDetector::MemoryCache do
           block_called = true
         end
 
-        value.must_equal 'value'
-        block_called.must_equal false
+        value(value).must_equal 'value'
+        value(block_called).must_equal false
       end
 
+      it 'returns the value' do
+        subject.data[key] = 'value2'
+        value(subject.get_or_set(key, 'value')).must_equal 'value2'
+      end
     end
 
     describe '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
 
-        block_called.must_equal true
-        subject.data[key].must_equal true
+        value(block_called).must_equal true
+        value(subject.data[key]).must_equal true
       end
 
+      it 'returns the value' do
+        value(subject.get_or_set(key, 'value')).must_equal 'value'
+      end
     end
-
   end
 
   describe 'cache purging' do
-
     let(:config) { { max_cache_keys: 3 } }
 
     it 'purges the cache when key size arrives at max' do
@@ -108,9 +142,7 @@ describe DeviceDetector::MemoryCache do
       subject.set('3', 'baz')
       subject.set('4', 'boz')
 
-      subject.data.keys.size.must_equal 3
+      value(subject.data.keys.size).must_equal 3
     end
-
   end
-
 end

data/spec/device_detector/model_extractor_spec.rb

@@ -23,7 +23,7 @@ describe DeviceDetector::ModelExtractor do
         let(:device_name) { 'iPhone' }
 
         it 'returns the textual portion without trailing whitespace' do
-          extractor.call.must_equal device_name
+          value(extractor.call).must_equal device_name
         end
 
       end
@@ -33,7 +33,7 @@ describe DeviceDetector::ModelExtractor do
         let(:device_name) { 'iPhone 5S' }
 
         it 'returns the full device name' do
-          extractor.call.must_equal device_name
+          value(extractor.call).must_equal device_name
         end
 
       end
@@ -53,7 +53,7 @@ describe DeviceDetector::ModelExtractor do
       end
 
       it 'returns the model name' do
-        extractor.call.must_equal device_name
+        value(extractor.call).must_equal device_name
       end
 
     end