browserino 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2ae02d6780d0cef93f9a41bb022a147dba31557
-  data.tar.gz: 3225266d8e2fbf37d3ea436bac8d3928779bba45
+  metadata.gz: 8f392dc373a4a65f8091c0a80772e098d93a7132
+  data.tar.gz: f6d67b00f1d80d5a9dad9f99234bded0fa5358be
 SHA512:
-  metadata.gz: af7551c42f54dc920a7bd309baab7106f69375e1914d1669a49f2bca63cfaf308d944b771e7f11dd4fe1bf73eae2ebec0f4b8978855871d3a446d7b4630dcb94
-  data.tar.gz: 78d2fca76155ac213f4c04dd81b9fe5fbd2ebba65ae73bc107cc2f767782c2509b888f6612dfd85f72376eaabe07bafa18d4370ff9072b0290723f8568129326
+  metadata.gz: b0e4b698e954091489aba295f223d4cb6c48cb7d438db514c04731de975416215420ddcaf261cbe3321ba45dc2d16d1f766516d5a5b3b5ca8730f9e4ad90e5e5
+  data.tar.gz: 562b3de888cf132cfe05200590478293c6bbf20433354dbdd60447259ffa86b823b9b7f6b70e0ed9875d38218219bbbf856dc37ac9c5a6dd4cf4cbef710f5198

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## CHANGELOG
 _dates are in dd-mm-yyyy format_  
 
+#### 31-12-2015 VERSION 1.5.2
+
+- Added user agents
+- Patterns could falsely identify a 64bit system, made the pattern more strict
+- using `X11` in a user agent as a synonym to a `#linux?` system
+
 #### 23-12-2015 VERSION 1.5.1.1
 
 - Removed print statements from method

data/README.md

@@ -10,6 +10,13 @@ This gem aims to provide information about the browser that your visitor is usin
 _dates are in dd-mm-yyyy format_  
 _older changes can be found in the [CHANGELOG.md](https://github.com/SidOfc/browserino/blob/master/CHANGELOG.md)_
 
+#### 03-01-2016 VERSION 2.0.0
+
+- **IMPORTANT** Changed behaviour of all dynamic methods to include version as an argument rather than in the method name.
+- **IMPORTANT** Changed the behaviour of version checking to be more strict
+- Changed tests to reflect new behaviour
+- Added convenience methods `#win?`, `#osx?` and `#bb?`
+
 #### 03-01-2016 VERSION 1.6.0
 
 - Added more tests
@@ -27,15 +34,9 @@ _older changes can be found in the [CHANGELOG.md](https://github.com/SidOfc/brow
 - Added blackberry support
 - Added tests for blackberry user agent strings
 
-#### 31-12-2015 VERSION 1.5.2
-
-- Added user agents
-- Patterns could falsely identify a 64bit system, made the pattern more strict
-- using `X11` in a user agent as a synonym to a `#linux?` system
-
 ## Installation
 
-*supports ruby 1.9.3+*
+*supports ruby 1.9.3+*  
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -125,13 +126,32 @@ agent.to_h # => {
 
 It is now also possible to call methods to determine a specific OS or browser if it's supported, a `noMethodError` will be thrown otherwise
 The function uses the names of the `Browserino::Mapping.constants(true)` or `Browserino::PATTERNS[:browser].keys` output to identify wether or not to throw this exception.
+Versions are also supported as an argument to the function, for operating systems versions could include a string, symbol or float / integer to indicate a version.
+_(examples given for windows, android and ios, for a full list of versions check the **maps** folder)_
+Browsers can also accept a float / integer to check for a specific version.
+
+### DEPRECATION NOTICE
+
+**Methods that include a version number in their name (`agent.android4?`) are deprecated as of version 2.0.0. Supply the version as argument instead `agent.android?(4)`**
 
 Supported systems
 
 ```ruby
 agent.android?
+# check for android jellybean
+# agent.android?(:jellybean) or agent.android?('jellybean') or agent.android?(4.1)
 agent.ios?
+# check version of iOS (v1.x.x)
+# agent.ios9?
+# check version of iOS (v2.x.x)
+# agent.ios?(9)
 agent.windows?
+# check for windows Vista (v1.x.x)
+# agent.windows60?
+# check for windows Vista (v2.x.x)
+# agent.windows?(6) - based on NT version
+# agent.windows?(6.0) - based on NT version
+# agent.windows?(:vista) or agent.windows?('vista')
 agent.macintosh?
 agent.blackberry?
 agent.linux?
@@ -139,16 +159,29 @@ agent.linux?
 
 You could also invert these questions by using the `.not` method
 
-
 ```ruby
 agent.not.android?
+# check for android jellybean
+# agent.not.android?(:jelly_bean) or agent.not.android?('jelly bean') or agent.not.android?(4.1)
 agent.not.ios?
+# check if iOS version isn't 9 (v1.4.0+)
+# agent.not.ios9?
+# check if iOS version isn't 9 (v2.x.x)
+# agent.not.ios?(9)
 agent.not.windows?
+# check if not windows vista (v1.4.0+)
+# agent.not.windows60?
+# check if not windows vista (v2.x.x)
+# agent.not.windows?(6) - based on NT version
+# agent.not.windows?(6.0) - based on NT version
+# agent.not.windows?(:vista) or agent.not.windows?('vista')
 agent.not.macintosh?
 agent.not.blackberry?
 agent.not.linux?
 ```
 
+The `#windows?`, `#macintosh?` and `#blackberry?` each have a shortcut method to allow for easier access, `#win?`, `#osx?`, `#bb?`
+
 Supported browsers  
 
 ```ruby
@@ -167,19 +200,10 @@ agent.safari?
 
 agent.not.opera?
 agent.not.maxthon?
-
 # etc etc...
 
 ```
 
-Since linux doesn't have any supported versions all you can pretty much do is check if `agent.linux?` is true if you want to check for linux systems. Also - `X11` in a user agent string will now also cause the OS to be set to linux. The others do have versions so if you wanted to check for windows 10 you could do:
-
-```ruby
-agent.windows10?
-```
-
-**note** Windows versions use their respective *NT* versioning so `agent.windows6?` equals `Vista` - I have yet to make changes to fix that. Browser versions use their actual version which always matches up with their real version, the same goes for the other systems.
-
 ## Development
 
 The tests are dynamically produced and quite easy to write.
@@ -192,7 +216,6 @@ If I wanted to add a test case for a different browser for instance (just pickin
 ```ruby
 module UserAgents
   FIREFOX = {
-    mac: {},
     win: {
       'Mozilla/5.0 (Windows NT 6.1; WOW64; rv:40.0) Gecko/20100101 Firefox/40.1' => {
         browser_name: 'Firefox',
@@ -201,10 +224,13 @@ module UserAgents
         engine_version: '40.0',
         system_name: ['windows', '7'],
         system_version: '6.1',
-        system_architecture: 'x64'
-      },
-    },
-    linux: {}
+        system_architecture: 'x64',
+        x64?: true,
+        x32?: false,
+        known?: true,
+        mobile: false
+      }
+    }
   }
 end
 ```
@@ -213,17 +239,18 @@ Valid browser names are defined by __/lib/browserino/patterns.rb__ (the keys are
 
 #### browser_name examples
 ```ruby
-'unknown'
 'ie'
 'firefox'
 'chrome'
 'opera'
+'opera_mini'
+'bolt'
+'ucbrowser'
 'maxthon'
 ```
 
 #### engine_name examples
 ```ruby
-'unknown'
 'gecko'
 'webkit'
 'trident'
@@ -231,24 +258,22 @@ Valid browser names are defined by __/lib/browserino/patterns.rb__ (the keys are
 
 #### system_name examples
 
-_The main reason for not having Linux distro's / versions <strike>yet</strike> is because of the fact that there are MANY different distro's with no real structured release system. <strike>(going to work on that whenever there's free time!)</strike>_
+_The main reason for not having Linux distro's / versions is because of the fact that there are MANY different distro's with no real structured release system. The best I can do here is allow a `linux?` system to be found atleast_
 
 ```ruby
 ['windows', '7'] # where the 'windows' part is the name of the OS and the '7' is the actual version release (e.g. NT 6.1)
 ['macintosh', 'yosemite'] # same as above but OSX has different names ofcourse.
-['android', 'lollipop'] # etcetera...
-['unknown', 'unknown'] # in case it isn't known or in case of Linux
+['android', 'lollipop 22'] # etcetera...
+['linux', nil] # in every linux case, the version will be missing on system_name full: true
+[nil, nil] # when nothing about the agent could be found
 ```
 
 #### system_architecture examples
 ```ruby
-'unknown'
 'x32'
 'x64'
 ```
 
-__The value of unknown is a default error value that will always be available to test against. If it ain't known it's unknown__
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/SidOfc/browserino. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

data/bin/console

@@ -3,13 +3,13 @@
 require "bundler/setup"
 require "browserino"
 require "pry"
-ua = 'Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; BOLT/2.800) AppleWebKit/534.6 (KHTML, like Gecko) Version/5.0 Safari/534.6.3'
+ua = 'UCBROWSER -> Mozilla/5.0 (Linux; U; Android 4.1.2; en-us; SM-T210R Build/JZO54K) AppleWebKit/534.30 (KHTML, like Gecko) Version/4.0 Safari/534.30 UCBrowser/2.3.2.300'
 @agent = Browserino::parse(ua)
 
 puts "> @agent variable available parsed with: '#{ua}'\n\n"
 puts "> You can create a fresh object by using\n"
 puts "> Browserino::parse((string) ua, (any) unknown_alt = nil)\n\n"
 puts "> ua          - The user agent you'd actually want to parse as a string"
-puts "> unknown_alt - A default value for unknown properties, default nil\n\n"
+puts "> unknown_alt - A default value for unknown properties, default nil (recommended)\n\n"
 
 Pry.start

data/lib/browserino/agent.rb

@@ -71,53 +71,43 @@ module Browserino
     end
 
     def known?
-      browser_name != @unknown
+      res = !@not && browser_name != @unknown
+      @not = false
+      res
     end
 
     def mobile?
-      !!(ua =~ /bolt|nokia|samsung|mobi(?:le)?|android|ip(?:[ao]d|hone)|bb\d+|blackberry|iemobile|fennec|bada|meego|vodafone|t\-mobile|opera\sm(?:ob|in)i/i)
+      allow_inverted_return !!(ua =~ /bolt|nokia|samsung|mobi(?:le)?|android|ip(?:[ao]d|hone)|bb\d+|blackberry|iemobile|fennec|bada|meego|vodafone|t\-mobile|opera\sm(?:ob|in)i/i)
     end
 
     def x64?
-      system_architecture == 'x64'
+      allow_inverted_return(system_architecture == 'x64')
     end
 
     def x32?
-      system_architecture == 'x32'
+      allow_inverted_return(system_architecture == 'x32')
     end
 
-    def correct_system?(name, version = nil)
-      os_equal = (name == system_name)
-      if version
-        os_equal && version == system_version.to_s[0..(version.size - 1)]
-      else
-        os_equal
-      end
+    def osx?(*arg)
+      macintosh?(*arg)
     end
 
-    def correct_browser?(name, version = nil)
-      browser_equal = (name.gsub(/_/, ' ') == browser_name)
-      if version
-        browser_equal && version == browser_version.to_s[0..(version.size - 1)]
-      else
-        browser_equal
-      end
+    def win?(*arg)
+      windows?(*arg)
+    end
+
+    def bb?(*arg)
+      blackberry?(*arg)
     end
 
     def method_missing(method_sym, *args, &block)
-      criteria = method_sym.to_s.gsub('?', '').split(/(?<=[a-zA-Z_])(?=\d+)/)
-      name = criteria[0]
+      name = method_sym.to_s.gsub('?', '')
       res = case browser_or_system?(method_sym)
-      when :system then correct_system?(criteria[0], criteria[1])
-      when :browser then correct_browser?(criteria[0], criteria[1])
+      when :system then correct_system?(name, *args)
+      when :browser then correct_browser?(name, *args)
       else super
       end
-      if @not
-        @not = false
-        !res
-      else
-        res
-      end
+      allow_inverted_return res
     end
 
     def respond_to?(method_sym)
@@ -160,8 +150,45 @@ module Browserino
 
     private
 
+    def allow_inverted_return(res)
+      if @not
+        @not = false
+        !res
+      else
+        res
+      end
+    end
+
+    def compare_versions(a, b)
+      b = b.to_s.split('.')
+      !a.to_s.split('.').map { |v| v == b.shift }.include?(false)
+    end
+
+    def correct_system?(name, version = nil)
+      sys_name = name.to_s.downcase.gsub(/\s/, '_')
+      sys_name_compare = system_name(full: true).join.downcase.gsub(/\s/, '_')
+      name_variations = [sys_name_compare, sys_name_compare.gsub(/^[\s_]+|\d|[\s_]+$/, '')]
+
+      if (name_variations.include?((sys_name + version.to_s).gsub(/\s/, '_').downcase) ||
+          (sys_name == system_name.gsub(/\s/, '_') && compare_versions(version, system_version)) ||
+          (!version && sys_name == system_name.gsub(/\s/, '_')))
+        true
+      else
+        false
+      end
+    end
+
+    def correct_browser?(name, version = nil)
+      browser_equal = (name.gsub(/_/, ' ') == browser_name)
+      if version
+        browser_equal && compare_versions(version, browser_version)
+      else
+        browser_equal
+      end
+    end
+
     def browser_or_system?(method_sym)
-      name = method_sym.to_s.gsub('?', '').split(/(?<=[a-zA-Z])(?=\d+)/).first
+      name = method_sym.to_s.gsub('?', '').split(/_/).first
       sys = Browserino::Mapping.constants(true).include?(name.upcase.to_sym)
       browser = Browserino::PATTERNS[:browser].keys.include?(name.to_sym)
       if sys

data/lib/browserino/version.rb

@@ -1,3 +1,3 @@
 module Browserino
-  VERSION = "1.6.0"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browserino
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Sidney Liebrand