browser 5.3.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 837e072e8544da56ee51cf187b35850444d17c931c535115cf50c679d2227a7c
-  data.tar.gz: b789e49dbd45164c42ff5a25c5bd5a5d0c54a32ac945bcbf97ee41682ca23693
+  metadata.gz: 955928c52746af052fa9e4acb5555ba3d438326670ee5b587f7a66eff89193f5
+  data.tar.gz: a9a9a822b3dcac0fa8b5a1f946e60c1c4eef3bc2801c41b990b33c496bb635ed
 SHA512:
-  metadata.gz: 4adb59b646efa17033f385ad0b935f067c9b67a8718a1362f0c5ef49a3c28decd064ec788739c4d38f9969a2189ffc7090ae5d62d3979c249e3237f6b547bfe1
-  data.tar.gz: c0712d54d08e48522b26ce1c162a238711f20bced68b578e300657ec25ff313d9637a2a881dd2797cd8295b90d100a60789364b17cb9b008e4e3da092e071d0a
+  metadata.gz: b35967db554e9dc880c4998418fde96e2fd8c75283ebc9549c948754ce9b9b383fc5977cfe1008ae176e4e00c7ecf1318d0ed8bc31f987ed19aaef294cbb669b
+  data.tar.gz: 845a5a586f88a402f967a1c5ce43cdb3f736c33aa78288e23972f4ee14e07d81fa805bef169000979d14dcb9d24299ef008d452c29c04b88b50e3516f76b3baf

data/{FUNDING.yml → .github/FUNDING.yml}

@@ -1,3 +1,4 @@
 # These are supported funding model platforms
-
+---
 github: [fnando]
+custom: ["https://paypal.me/nandovieira/🍕"]

data/.github/workflows/{tests.yml → ruby-tests.yml}

@@ -1,48 +1,47 @@
-name: Tests
+---
+name: ruby-tests
 
 on:
-  pull_request:
-    branches:
-      - main
+  pull_request_target:
   push:
     branches:
       - main
-
-  schedule:
-    - cron: "0 10 * * *"
+  workflow_dispatch:
+    inputs: {}
 
 jobs:
   build:
     name: Tests with Ruby ${{ matrix.ruby }} and ${{ matrix.gemfile }}
     runs-on: "ubuntu-latest"
+    if: |
+      github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target' ||
+      github.actor != 'dependabot[bot]'
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["3.0.x", "2.7.x", "2.6.x", "2.5.x"]
+        ruby: ["3.2", "3.3"]
         gemfile:
           - Gemfile
-          - gemfiles/rails6_1.gemfile
-          - gemfiles/rails6_0.gemfile
+          - gemfiles/7_1.gemfile
+          - gemfiles/6_1.gemfile
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2.4.0
 
       - uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: >
-            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles(matrix.gemfile) }}
-          restore-keys: >
-            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{ hashFiles(matrix.gemfile) }}
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
 
       - name: Set up Ruby
-        uses: actions/setup-ruby@v1
+        uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
 
       - name: Install gem dependencies
         env:
-          RAILS_ENV: test
           BUNDLE_GEMFILE: ${{ matrix.gemfile }}
         run: |
           gem install bundler
@@ -51,7 +50,8 @@ jobs:
 
       - name: Run Tests
         env:
-          RAILS_ENV: test
+          PGHOST: localhost
+          PGUSER: postgres
           BUNDLE_GEMFILE: ${{ matrix.gemfile }}
         run: |
           bundle exec rake

data/.rubocop.yml

@@ -4,6 +4,7 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 2.5
+  NewCops: enable
   Exclude:
     - bin/**/*
     - gemfiles/**/*
@@ -13,29 +14,8 @@ AllCops:
     - "*.gemspec"
     - config.ru
 
-Metrics/ClassLength:
-  Enabled: false
-
-Layout/LineLength:
-  Max: 80
-
-Metrics/MethodLength:
-  Enabled: false
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Lint/RedundantCopDisableDirective:
-  Enabled: false
-
-Metrics/AbcSize:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
+Naming/VariableNumber:
   Enabled: false
 
-Naming/VariableNumber:
+Minitest/EmptyLineBeforeAssertionMethods:
   Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 6.0.0
+
+- Add `Browser::Base#chromium_based?`.
+- Change how browser detection works to avoid re-instantiating classes.
+- Bump up minimum required ruby version to 3.2.0.
+
 ## 5.3.1
 
 - Remove Stripe webhooks from bot list.

data/LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License (MIT)
+
+Copyright (c) 2010 Nando Vieira
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,7 +1,6 @@
 # Browser
 
-[![Tests](https://github.com/fnando/browser/workflows/Tests/badge.svg)](https://github.com/fnando/browser)
-[![Code Climate](https://codeclimate.com/github/fnando/browser/badges/gpa.svg)](https://codeclimate.com/github/fnando/browser)
+[![Tests](https://github.com/fnando/browser/workflows/ruby-tests/badge.svg)](https://github.com/fnando/browser)
 [![Gem](https://img.shields.io/gem/v/browser.svg)](https://rubygems.org/gems/browser)
 [![Gem](https://img.shields.io/gem/dt/browser.svg)](https://rubygems.org/gems/browser)
 
@@ -23,6 +22,7 @@ browser = Browser.new("Some User Agent", accept_language: "en-us")
 # General info
 browser.bot?
 browser.chrome?
+browser.chromium_based?
 browser.core_media?
 browser.duck_duck_go?
 browser.edge?                # Newest MS browser
@@ -53,7 +53,6 @@ browser.yandex?
 browser.wechat?
 browser.qq?
 browser.weibo?
-browser.yandex?
 browser.sputnik?
 browser.sougou_browser?
 
@@ -323,6 +322,14 @@ Browser::Bot.matchers.delete(Browser::Bot::KeywordMatcher)
 Browser::Bot.matchers.delete(Browser::Bot::EmptyUserAgentMatcher)
 ```
 
+To extend the bot list, you can manipulate the methods below:
+
+```ruby
+Browser::Bot.bots.merge!(new_bots_hash)
+Browser::Bot.bot_exceptions += new_exceptions
+Browser::Bot.search_engines.merge!(new_search_engines_hash)
+```
+
 ### Middleware
 
 You can use the `Browser::Middleware` to redirect user agents.

data/browser.gemspec

@@ -7,27 +7,26 @@ Gem::Specification.new do |s|
   s.version               = Browser::VERSION
   s.platform              = Gem::Platform::RUBY
   s.authors               = ["Nando Vieira"]
-  s.email                 = ["fnando.vieira@gmail.com"]
+  s.email                 = ["me@fnando.com"]
   s.homepage              = "https://github.com/fnando/browser"
   s.summary               = "Do some browser detection with Ruby."
   s.description           = s.summary
   s.license               = "MIT"
-  s.required_ruby_version = ">= 2.5.0"
+  s.required_ruby_version = ">= 3.2.0"
 
+  s.metadata["rubygems_mfa_required"] = "true"
   s.metadata["changelog_uri"] = "https://github.com/fnando/browser/blob/main/CHANGELOG.md"
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- exe/*`
                     .split("\n")
                     .map {|f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "bundler", ">= 0"
+  s.add_development_dependency "bundler"
   s.add_development_dependency "minitest"
   s.add_development_dependency "minitest-autotest"
   s.add_development_dependency "minitest-utils"
-  s.add_development_dependency "pry-meta"
   s.add_development_dependency "rack-test"
   s.add_development_dependency "rails"
   s.add_development_dependency "rake"

data/gemfiles/{rails6_0.gemfile → 7_0.gemfile}

@@ -3,4 +3,4 @@
 source "https://rubygems.org"
 gemspec path: ".."
 
-gem "rails", "~> 6.0"
+gem "rails", "~> 7.0.0"

data/gemfiles/{rails6_1.gemfile → 7_1.gemfile}

@@ -3,4 +3,4 @@
 source "https://rubygems.org"
 gemspec path: ".."
 
-gem "rails", "~> 6.1"
+gem "rails", "~> 7.1.0"

data/lib/browser/accept_language.rb

@@ -55,7 +55,7 @@ module Browser
 
     private def quality_value
       qvalue = part[/;q=([\d.]+)/, 1]
-      qvalue = /\A0\.0?\z/.match?(qvalue) ? "0.0" : qvalue
+      qvalue = "0.0" if /\A0\.0?\z/.match?(qvalue)
       qvalue = qvalue.squeeze(".") if qvalue
       qvalue
     end

data/lib/browser/base.rb

@@ -26,7 +26,7 @@ module Browser
       end
     end
 
-    alias_method :to_a, :meta
+    alias to_a meta
 
     # Return meta representation as string.
     def to_s
@@ -59,13 +59,13 @@ module Browser
 
     # Detect if browser is Microsoft Internet Explorer.
     def ie?(expected_version = nil)
-      InternetExplorer.new(ua).match? &&
+      instance_of?(InternetExplorer) &&
         detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Microsoft Edge.
     def edge?(expected_version = nil)
-      Edge.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(Edge) && detect_version?(full_version, expected_version)
     end
 
     def compatibility_view?
@@ -82,32 +82,32 @@ module Browser
 
     # Detect if browser is Instagram.
     def instagram?(expected_version = nil)
-      Instagram.new(ua).match? &&
+      instance_of?(Instagram) &&
         detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Snapchat.
     def snapchat?(expected_version = nil)
-      Snapchat.new(ua).match? &&
+      instance_of?(Snapchat) &&
         detect_version?(full_version, expected_version)
     end
 
     # Detect if browser if Facebook.
     def facebook?(expected_version = nil)
-      Facebook.new(ua).match? &&
+      instance_of?(Facebook) &&
         detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Otter.
     def otter?(expected_version = nil)
-      Otter.new(ua).match? &&
+      instance_of?(Otter) &&
         detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is WebKit-based.
     def webkit?(expected_version = nil)
       ua.match?(/AppleWebKit/i) &&
-        (!edge? || Edge.new(ua).chrome_based?) &&
+        (!edge? || chromium_based?) &&
         detect_version?(webkit_full_version, expected_version)
     end
 
@@ -124,13 +124,13 @@ module Browser
 
     # Detect if browser is PhantomJS
     def phantom_js?(expected_version = nil)
-      PhantomJS.new(ua).match? &&
+      instance_of?(PhantomJS) &&
         detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Safari.
     def safari?(expected_version = nil)
-      Safari.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(Safari) && detect_version?(full_version, expected_version)
     end
 
     def safari_webapp_mode?
@@ -139,55 +139,55 @@ module Browser
 
     # Detect if browser is Firefox.
     def firefox?(expected_version = nil)
-      Firefox.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(Firefox) && detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Chrome.
     def chrome?(expected_version = nil)
-      Chrome.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(Chrome) && detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Opera.
     def opera?(expected_version = nil)
-      Opera.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(Opera) && detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Sputnik.
     def sputnik?(expected_version = nil)
-      Sputnik.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(Sputnik) && detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Yandex.
     def yandex?(expected_version = nil)
-      Yandex.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(Yandex) && detect_version?(full_version, expected_version)
     end
-    alias_method :yandex_browser?, :yandex?
+    alias yandex_browser? yandex?
 
     # Detect if browser is UCBrowser.
     def uc_browser?(expected_version = nil)
-      UCBrowser.new(ua).match? &&
+      instance_of?(UCBrowser) &&
         detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Nokia S40 Ovi Browser.
     def nokia?(expected_version = nil)
-      Nokia.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(Nokia) && detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is MicroMessenger.
     def micro_messenger?(expected_version = nil)
-      MicroMessenger.new(ua).match? &&
+      instance_of?(MicroMessenger) &&
         detect_version?(full_version, expected_version)
     end
 
-    alias_method :wechat?, :micro_messenger?
+    alias wechat? micro_messenger?
 
     def weibo?(expected_version = nil)
-      Weibo.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(Weibo) && detect_version?(full_version, expected_version)
     end
 
     def alipay?(expected_version = nil)
-      Alipay.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(Alipay) && detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Opera Mini.
@@ -210,29 +210,29 @@ module Browser
 
     # Detect if browser is Huawei.
     def huawei_browser?(expected_version = nil)
-      HuaweiBrowser.new(ua).match? &&
+      instance_of?(HuaweiBrowser) &&
         detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Xiaomi Miui.
     def miui_browser?(expected_version = nil)
-      MiuiBrowser.new(ua).match? &&
+      instance_of?(MiuiBrowser) &&
         detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Maxthon.
     def maxthon?(expected_version = nil)
-      Maxthon.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(Maxthon) && detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is QQ.
     def qq?(expected_version = nil)
-      QQ.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(QQ) && detect_version?(full_version, expected_version)
     end
 
     # Detect if browser is Sougou.
     def sougou_browser?(expected_version = nil)
-      SougouBrowser.new(ua).match? &&
+      instance_of?(SougouBrowser) &&
         detect_version?(full_version, expected_version)
     end
 
@@ -241,6 +241,11 @@ module Browser
       ua.include?("GSA") && detect_version?(full_version, expected_version)
     end
 
+    # Detect if browser is Chromium-based.
+    def chromium_based?
+      false
+    end
+
     def webkit_full_version
       ua[%r{AppleWebKit/([\d.]+)}, 1] || "0.0"
     end
@@ -260,12 +265,12 @@ module Browser
 
     # Detect if the browser is Electron.
     def electron?(expected_version = nil)
-      Electron.new(ua).match? && detect_version?(full_version, expected_version)
+      instance_of?(Electron) && detect_version?(full_version, expected_version)
     end
 
     private def validate_size(subject, input)
       actual_bytesize = input.bytesize
-      size_limit = Browser.public_send("#{subject}_size_limit")
+      size_limit = Browser.public_send(:"#{subject}_size_limit")
 
       return if actual_bytesize < size_limit
 

data/lib/browser/browser.rb

@@ -101,8 +101,9 @@ module Browser
   end
 
   def self.new(user_agent, **kwargs)
-    matchers
-      .map {|klass| klass.new(user_agent || EMPTY_STRING, **kwargs) }
-      .find(&:match?)
+    matchers.each do |matcher_class|
+      matcher = matcher_class.new(user_agent || EMPTY_STRING, **kwargs)
+      return matcher if matcher.match?
+    end
   end
 end

data/lib/browser/chrome.rb

@@ -19,6 +19,10 @@ module Browser
         "0.0"
     end
 
+    def chromium_based?
+      true
+    end
+
     def match?
       ua.match?(/Chrome|CriOS/) &&
         !ua.match?(/PhantomJS|FxiOS|ArchiveBot/) &&

data/lib/browser/device.rb

@@ -96,7 +96,7 @@ module Browser
     def ipod_touch?
       id == :ipod_touch
     end
-    alias_method :ipod?, :ipod_touch?
+    alias ipod? ipod_touch?
 
     def iphone?
       id == :iphone
@@ -105,12 +105,12 @@ module Browser
     def ps3?
       id == :ps3
     end
-    alias_method :playstation3?, :ps3?
+    alias playstation3? ps3?
 
     def ps4?
       id == :ps4
     end
-    alias_method :playstation4?, :ps4?
+    alias playstation4? ps4?
 
     def psp?
       id == :psp
@@ -119,8 +119,8 @@ module Browser
     def playstation_vita?
       id == :psvita
     end
-    alias_method :vita?, :playstation_vita?
-    alias_method :psp_vita?, :playstation_vita?
+    alias vita? playstation_vita?
+    alias psp_vita? playstation_vita?
 
     def kindle?
       id == :kindle || kindle_fire?
@@ -133,22 +133,22 @@ module Browser
     def nintendo_wii?
       id == :wii
     end
-    alias_method :wii?, :nintendo_wii?
+    alias wii? nintendo_wii?
 
     def nintendo_wiiu?
       id == :wiiu
     end
-    alias_method :wiiu?, :nintendo_wiiu?
+    alias wiiu? nintendo_wiiu?
 
     def nintendo_switch?
       id == :switch
     end
-    alias_method :switch?, :nintendo_switch?
+    alias switch? nintendo_switch?
 
     def blackberry_playbook?
       id == :playbook
     end
-    alias_method :playbook?, :blackberry_playbook?
+    alias playbook? blackberry_playbook?
 
     def surface?
       id == :surface

data/lib/browser/edge.rb

@@ -18,7 +18,7 @@ module Browser
       ua.match?(%r{((?:Edge|Edg|EdgiOS|EdgA)/[\d.]+|Trident/8)})
     end
 
-    def chrome_based?
+    def chromium_based?
       match? && ua.match?(/\bEdg\b/)
     end
   end

data/lib/browser/meta/base.rb

@@ -37,7 +37,7 @@ module Browser
       end
 
       def to_a
-        meta.to_s.squeeze(" ").split(" ")
+        meta.to_s.squeeze(" ").split
       end
     end
   end

data/lib/browser/platform.rb

@@ -138,7 +138,7 @@ module Browser
     def android_app?
       android? && ua.match?(/\bwv\b/)
     end
-    alias_method :android_webview?, :android_app?
+    alias android_webview? android_app?
 
     # http://msdn.microsoft.com/fr-FR/library/ms537503.aspx#PltToken
     def windows_xp?

data/lib/browser/testing.rb

@@ -16,9 +16,9 @@ module Browser
   end
 
   def self.search_engine_user_agents
-    @search_engine_user_agents ||= begin
-      YAML.load_file(Browser.root.join("test/ua_search_engines.yml"))
-    end
+    @search_engine_user_agents ||= YAML.load_file(
+      Browser.root.join("test/ua_search_engines.yml")
+    )
   end
 
   def self.[](key)

data/lib/browser/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Browser
-  VERSION = "5.3.1"
+  VERSION = "6.0.0"
 end

data/lib/browser.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
 require_relative "browser/browser"
-require_relative "browser/rails" if defined?(::Rails)
+require_relative "browser/rails" if defined?(Rails)

data/search_engines.yml

@@ -1,3 +1,4 @@
+---
 ask jeeves: "Ask Jeeves"
 baidu: "Chinese search engine"
 bingbot: "Microsoft bing bot"

data/test/browser_test.rb

@@ -8,7 +8,7 @@ class BrowserTest < Minitest::Test
     assert_equal "Safari", browser.ua
   end
 
-  test "don't fail with nil user agent" do
+  test "does not fail with nil user agent" do
     browser = Browser.new(nil)
     refute browser.known?
   end
@@ -25,7 +25,7 @@ class BrowserTest < Minitest::Test
     Safari
     UCBrowser
   ].each do |ua|
-    test "don't fail when have no version info (#{ua})" do
+    test "does not fail when have no version info (#{ua})" do
       browser = Browser.new(ua)
       assert_equal "0", browser.version
       assert_equal "0.0", browser.full_version
@@ -117,7 +117,7 @@ class BrowserTest < Minitest::Test
 
   test "returns empty language set for missing accept language" do
     browser = Browser.new("")
-    assert_equal [], browser.accept_language
+    assert_empty browser.accept_language
   end
 
   test "sets accept language while instantiating object" do

data/test/rails_test.rb

@@ -26,7 +26,7 @@ class RailsTest < Minitest::Test
                           "HTTP_ACCEPT_LANGUAGE" => "en-US;q=0.8"
 
     assert_equal 200, last_response.status
-    assert_equal true, JSON.parse(last_response.body)["isBot"]
+    assert JSON.parse(last_response.body)["isBot"]
     assert_equal "en-US", JSON.parse(last_response.body)["acceptLanguages"][0]
   end
 end