browserx 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b8b37f466da96715f58be6f7581204d5a46fe12ed3ea96995b46cbcc48a95e1f
+  data.tar.gz: ff7419bb6d7162a3abcf82dfac7e851dd50d55605dbea351eac97b11d819cacb
+SHA512:
+  metadata.gz: be7daa1b157872be556fe319352180b12f978f42aedf23e9e43eb880905e4d6d849cf7ea268281ca86cf56d3baf46707f4aafd785ab0c589a5fdef57d99e650f
+  data.tar.gz: 19d21da9ee4eb84763cb4609c2b160f9ac71f6656a783ec4d31d87c2558ee71a7d27e99f4e5437119998dcc2f13c2c00abb8ce478e8d8314b1012c76773cc1fd

data/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+## [Unreleased]
+
+## [1.0.0] — 2026-11-04
+
+First release as `browserx`, forked from browser 6.2.0 (`dd88933`). Same API: `gem "browserx"` replaces
+`gem "browser"` without touching a call site. Earlier versions are browser's: see its
+[changelog](https://github.com/fnando/browser/blob/main/CHANGELOG.md).
+
+**Breaking**
+- Requires Ruby 3.3 or later: 3.2 reached its end of life on 2026-03-31.
+- Tested against Rails 8.0 and 8.1 only: 7.0, 7.1 and 7.2 reached their end of life.
+
+**Faster**
+- Bots are detected through one prefix-trie regexp instead of one match per entry, and without detecting the
+  browser twice; platform and device matchers are built lazily. A request takes 45% less time and half the
+  allocations.
+
+**Fixed**
+- The railtie loads Rails, not only itself, so it works without a preloaded ActiveSupport.
+- `lib/browserx.rb` exists, so Bundler's auto-require loads the gem.
+
+**New**
+- A corpus of 20,328 user agents, with snapshot and diff scripts proving answers match upstream, and a
+  request benchmark.
+
+[Unreleased]: https://github.com/next-gen-gems/browserx/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/next-gen-gems/browserx/releases/tag/v1.0.0

data/LICENSE.md

@@ -0,0 +1,21 @@
+# The MIT License (MIT)
+
+Copyright (c) 2010 Nando Vieira
+Copyright (c) 2026 Level UP Solutions
+
+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

@@ -0,0 +1,438 @@
+# BrowserX
+
+Browser detection for Ruby, with ActionController integration. BrowserX is a drop-in replacement for the
+[browser](https://rubygems.org/gems/browser) gem: put `gem "browserx"` in your Gemfile instead of
+`gem "browser"`, and every call site keeps working — same `Browser` namespace, same `require "browser"`, same
+predicates. It answers nearly twice as fast (61 µs and 129 objects per request instead of 110 µs and 245 on
+Ruby 4.0 with YJIT), and its bot list is meant to be kept fresh from permissively licensed sources
+([crawler-user-agents](https://github.com/monperrus/crawler-user-agents),
+[ai.robots.txt](https://github.com/ai-robots-txt/ai.robots.txt)).
+
+Site: https://next-gen-gems.github.io/browserx/
+
+## Installation
+
+```ruby
+gem "browserx"
+```
+
+## Usage
+
+```ruby
+require "browser"
+
+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
+browser.electron?            # Electron Framework
+browser.firefox?
+browser.full_version
+browser.ie?
+browser.ie?(6)               # detect specific IE version
+browser.ie?([">8", "<10"])   # detect specific IE (IE9).
+browser.known?               # has the browser been successfully detected?
+browser.unknown?             # the browser wasn't detected.
+browser.meta                 # an array with several attributes
+browser.name                 # readable browser name
+browser.nokia?
+browser.opera?
+browser.opera_mini?
+browser.phantom_js?
+browser.quicktime?
+browser.safari?
+browser.safari_webapp_mode?
+browser.samsung_browser?
+browser.to_s            # the meta info joined by space
+browser.uc_browser?
+browser.version         # major version number
+browser.webkit?
+browser.webkit_full_version
+browser.yandex?
+browser.wechat?
+browser.qq?
+browser.weibo?
+browser.sputnik?
+browser.sougou_browser?
+browser.epiphany?
+
+# Get bot info
+browser.bot.name
+browser.bot.search_engine?
+browser.bot?
+browser.bot.why? # shows which matcher detected this user agent as a bot.
+Browser::Bot.why?(ua)
+
+# Get device info
+browser.device
+browser.device.id
+browser.device.name
+browser.device.unknown?
+browser.device.blackberry_playbook?
+browser.device.console?
+browser.device.ipad?
+browser.device.iphone?
+browser.device.ipod_touch?
+browser.device.kindle?
+browser.device.kindle_fire?
+browser.device.mobile?
+browser.device.nintendo?
+browser.device.playstation?
+browser.device.ps3?
+browser.device.ps4?
+browser.device.psp?
+browser.device.silk?
+browser.device.surface?
+browser.device.tablet?
+browser.device.tv?
+browser.device.vita?
+browser.device.wii?
+browser.device.wiiu?
+browser.device.samsung?
+browser.device.switch?
+browser.device.xbox?
+browser.device.xbox_360?
+browser.device.xbox_one?
+
+# Get platform info
+browser.platform
+browser.platform.id
+browser.platform.name
+browser.platform.version  # e.g. 9 (for iOS9)
+browser.platform.adobe_air?
+browser.platform.android?
+browser.platform.android?(4.2)   # detect Android Jelly Bean 4.2
+browser.platform.android_app?     # detect webview in an Android app
+browser.platform.android_webview? # alias for android_app?
+browser.platform.blackberry?
+browser.platform.blackberry?(10) # detect specific BlackBerry version
+browser.platform.chrome_os?
+browser.platform.firefox_os?
+browser.platform.ios?     # detect iOS
+browser.platform.ios?(9)  # detect specific iOS version
+browser.platform.ios_app?     # detect webview in an iOS app
+browser.platform.ios_webview? # alias for ios_app?
+browser.platform.linux?
+browser.platform.mac?
+browser.platform.unknown?
+browser.platform.windows10?
+browser.platform.windows7?
+browser.platform.windows8?
+browser.platform.windows8_1?
+browser.platform.windows?
+browser.platform.windows_mobile?
+browser.platform.windows_phone?
+browser.platform.windows_rt?
+browser.platform.windows_touchscreen_desktop?
+browser.platform.windows_vista?
+browser.platform.windows_wow64?
+browser.platform.windows_x64?
+browser.platform.windows_x64_inclusive?
+browser.platform.windows_xp?
+browser.platform.kai_os?
+```
+
+### Aliases
+
+To add aliases like `mobile?` and `tablet?` to the base object (e.g
+`browser.mobile?`), require the `browser/aliases` file and extend the
+Browser::Base object like the following:
+
+```ruby
+require "browser/aliases"
+Browser::Base.include(Browser::Aliases)
+
+browser = Browser.new("Some user agent")
+browser.mobile? #=> false
+```
+
+### What's being detected?
+
+- For a list of platform detections, check
+  [lib/browser/platform.rb](lib/browser/platform.rb)
+- For a list of device detections, check
+  [lib/browser/device.rb](lib/browser/device.rb)
+- For a list of bot detections, check
+  [bots.yml](bots.yml)
+
+### Detecting modern browsers
+
+To detect whether a browser can be considered as modern or not, create a method
+that abstracts your versioning constraints. The following example will consider
+any of the following browsers as a modern:
+
+```ruby
+# Expects an Browser instance,
+# like in `Browser.new(user_agent, accept_language: language)`.
+def modern_browser?(browser)
+  [
+    browser.chrome?(">= 65"),
+    browser.safari?(">= 10"),
+    browser.firefox?(">= 52"),
+    browser.ie?(">= 11") && !browser.compatibility_view?,
+    browser.edge?(">= 15"),
+    browser.opera?(">= 50"),
+    browser.facebook?
+      && browser.safari_webapp_mode?
+      && browser.webkit_full_version.to_i >= 602
+  ].any?
+end
+```
+
+### Migrating from browser
+
+Replace `gem "browser"` with `gem "browserx"` in the Gemfile, nothing else: `require "browser"`, the `Browser`
+namespace and every predicate stay. To roll back, put `gem "browser"` back. BrowserX requires Ruby 3.3 or later
+and is tested on Rails 8.0 and 8.1.
+
+### Rails integration
+
+Just add it to the Gemfile.
+
+```ruby
+gem "browserx"
+```
+
+This adds a helper method called `browser`, that inspects your current user
+agent.
+
+```erb
+<% if browser.ie?(6) %>
+  <p class="disclaimer">You're running an older IE version. Please update it!</p>
+<% end %>
+```
+
+If you want to use Browser on your Rails app but don't want to taint your
+controller, use the following line on your Gemfile:
+
+```ruby
+gem "browserx", require: "browser/browser"
+```
+
+### Accept Language
+
+Parses the accept-language header from an HTTP request and produces an array of
+language objects sorted by quality.
+
+```ruby
+browser = Browser.new("Some User Agent", accept_language: "en-us")
+
+browser.accept_language.class
+#=> Array
+
+language = browser.accept_language.first
+
+language.code
+#=> "en"
+
+language.region
+#=> "US"
+
+language.full
+#=> "en-US"
+
+language.quality
+#=> 1.0
+
+language.name
+#=> "English/United States"
+```
+
+Result is always sorted in quality order from highest to lowest. As per the HTTP
+spec:
+
+- omitting the quality value implies 1.0.
+- quality value equal to zero means that is not accepted by the client.
+
+### Internet Explorer
+
+Internet Explorer has a compatibility view mode that allows newer versions
+(IE8+) to run as an older version. Browser will always return the navigator
+version, ignoring the compatibility view version, when defined. If you need to
+get the engine's version, you have to use `Browser#msie_version` and
+`Browser#msie_full_version`.
+
+So, let's say an user activates compatibility view in a IE11 browser. This is
+what you'll get:
+
+```ruby
+browser.version
+#=> 11
+
+browser.full_version
+#=> 11.0
+
+browser.msie_version
+#=> 7
+
+browser.msie_full_version
+#=> 7.0
+
+browser.compatibility_view?
+#=> true
+```
+
+This behavior changed in browser v1.0.0; previously there wasn't a way of getting the
+real browser version.
+
+### Safari
+
+iOS webviews and web apps aren't detected as Safari anymore, so be aware of that
+if that's your case. You can use a combination of platform and webkit detection
+to do whatever you want.
+
+```ruby
+# iPad's Safari running as web app mode.
+browser = Browser.new("Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405")
+
+browser.safari?
+#=> false
+
+browser.webkit?
+#=> true
+
+browser.platform.ios?
+#=> true
+```
+
+### Bots
+
+The bot detection is quite aggressive. Anything that matches at least one of the
+following requirements will be considered a bot.
+
+- Empty user agent string
+- User agent that matches `/crawl|fetch|search|monitoring|spider|bot/`
+- Any known bot listed under
+  [bots.yml](bots.yml)
+
+To add custom matchers, you can add a callable object to
+`Browser::Bot.matchers`. The following example matches everything that has a
+`externalhit` substring on it. The bot name will always be `General Bot`.
+
+```ruby
+Browser::Bot.matchers << ->(ua, _browser) { ua.match?(/externalhit/i) }
+```
+
+To clear all matchers, including the ones that are bundled, use
+`Browser::Bot.matchers.clear`. You can re-add built-in matchers by doing the
+following:
+
+```ruby
+Browser::Bot.matchers += Browser::Bot.default_matchers
+```
+
+To restore v2's bot detection, remove the following matchers:
+
+```ruby
+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.
+
+```ruby
+use Browser::Middleware do
+  redirect_to "/upgrade" if browser.ie?
+end
+```
+
+If you're using Rails, you can use the route helper methods. Just add something
+like the following to a initializer file (`config/initializers/browser.rb`).
+
+```ruby
+Rails.configuration.middleware.use Browser::Middleware do
+  redirect_to upgrade_path if browser.ie?
+end
+```
+
+If you need access to the `Rack::Request` object (e.g. to exclude a path), you
+can do so with `request`.
+
+```ruby
+Rails.configuration.middleware.use Browser::Middleware do
+  redirect_to upgrade_path if browser.ie? && request.env["PATH_INFO"] != "/exclude_me"
+end
+```
+
+### Restrictions
+
+- User agent has a size limit of 2048 bytes. This can be customized through
+  `Browser.user_agent_size_limit=(size)`.
+- Accept-Language has a size limit of 2048 bytes. This can be customized through
+  `Browser.accept_language_size_limit=(size)`.
+
+If size is not respected, then `Browser::Error` is raised.
+
+```ruby
+Browser.user_agent_size_limit = 4096
+Browser.accept_language_size_limit = 4096
+```
+
+## Performance
+
+`bench/request.rb` replays what a web request asks (name, version, `bot?`, platform, device, accept-language) over
+2,000 distinct user agents of the corpus and over 20 repeated ones, median of 7. On Ruby 4.0.9 with YJIT, browser
+6.2.0 takes 110 µs and 245 objects per request, BrowserX 1.0.0 61 µs and 129 objects.
+
+```bash
+ruby --yjit -I path/to/upstream/lib bench/request.rb
+ruby --yjit -I lib bench/request.rb
+```
+
+## Development
+
+```bash
+bundle install
+bundle exec rake test
+bundle exec rubocop
+```
+
+A change that is not meant to change an answer proves it on the corpus of 20,000 user agents, against a plain
+clone of [fnando/browser](https://github.com/fnando/browser) at `dd88933`:
+
+```bash
+ruby -I path/to/upstream/lib script/corpus_snapshot.rb > /tmp/upstream.jsonl
+ruby -I lib script/corpus_snapshot.rb > /tmp/browserx.jsonl
+ruby script/corpus_diff.rb /tmp/upstream.jsonl /tmp/browserx.jsonl
+```
+
+To add a bot, add its user agent to `test/ua_bots.yml` and its readable name to `bots.yml`, keyed by a
+lowercased string the user agent contains. A search engine goes in `test/ua_search_engines.yml`,
+`test/ua_bots.yml` and `search_engines.yml`.
+
+### Releasing
+
+Changes go under `## [Unreleased]` in `CHANGELOG.md` as they land. To release them, from an up-to-date `main`
+whose CI is green:
+
+```sh
+bin/release minor --dry-run   # the notes and the changes, nothing written
+bin/release minor             # or patch, major, or an exact version such as 1.2.0
+```
+
+`bin/release` dates the Unreleased section, bumps the version, commits, and pushes the commit with a signed tag
+`vX.Y.Z`. The tag starts the Release workflow, which publishes the gem to RubyGems through trusted publishing and
+creates the GitHub release with the version's notes and the `.gem`.
+
+## License
+
+MIT, by Level UP Solutions, see [LICENSE.md](LICENSE.md). Originally written by Nando Vieira as
+[fnando/browser](https://github.com/fnando/browser) (MIT). The corpus gathers user agents from
+[ua-parser/uap-core](https://github.com/ua-parser/uap-core) (Apache 2.0),
+[crawler-user-agents](https://github.com/monperrus/crawler-user-agents) (MIT) and browser's test fixtures: see
+[corpus/SOURCES.md](corpus/SOURCES.md).

data/bot_exceptions.yml

@@ -0,0 +1,5 @@
+---
+- ruby build
+- pinterest/android
+- pinterest/ios
+- yandexsearchbrowser