browserslist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e1ce91dfa243f4772858fff74007ef575b06a20b2ea01376f93efb468551df6
+  data.tar.gz: 1833f0572f2e06925a13d81d3d01a3a47166b2e1bbe9e130aad6b3f043fa8a3f
+SHA512:
+  metadata.gz: df291f6fe75afd776f77e1701df632a789c885b060ea85fa37d2ac7fa6db9219d08b95504e9064c9ab53cca5a07d3e71bc831a299224910ed58ebc45e1116e70
+  data.tar.gz: 8895668fed04949e9bbcd62b02c54c570b26c342516c09b568b01deba01ecbb41538c3f675d2c190ad669334ce956e1201a594ce534e53a5923cb752e3378507

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-08-27
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 hschne
+
+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,146 @@
+# Browserslist Ruby
+
+Bring [browserslist](https://github.com/browserslist/browserslist) to Ruby. Use your existing browserslist config and convert it to a Ruby hash for use with [Rails allowed browsers](https://github.com/rails/rails/pull/50505).
+
+```ruby
+allow_browser versions: Browserslist.browsers
+```
+
+## Installation
+
+Add `browserslist` to your `Gemfile`:
+
+```bash
+bundle add browserslist
+```
+
+## Usage
+
+### Generating a Browserslist
+
+`browserslist-rb` reads from a `.browserslist.json` file that must be generated upfront or at build time. This gem ships with a generator that requires `npm/npx` to be installed. If you generate the file upfront you must make sure it's available at runtime.
+
+```bash
+# Generate default .browserslist.json file
+bundle exec browserslist generate
+```
+
+#### Build-Time Generation
+
+For Rails applications using modern bundlers, you can generate the browserslist file at build time, depending on your tooling.
+
+<details>
+<summary>Vite Ruby</summary>
+
+Add to `vite.config.ts` using a plugin:
+
+```typescript
+import { defineConfig } from 'vite'
+import { execSync } from 'child_process'
+
+export default defineConfig({
+  plugins: [
+    {
+      name: 'browserslist-generator',
+      configResolved() {
+        execSync('npx browserslist --json > .browserslist.json')
+      }
+    }
+  ]
+})
+```
+</details>
+
+<details>
+<summary>esbuild</summary>
+
+Use a build plugin in your esbuild configuration:
+
+```javascript
+require('esbuild').build({
+  plugins: [{
+    name: 'browserslist-generator',
+    setup(build) {
+      build.onStart(() => {
+        const browserslist = require('browserslist')
+        const fs = require('fs')
+        fs.writeFileSync('./.browserslist.json', JSON.stringify(browserslist()))
+      })
+    }
+  }]
+})
+```
+</details>
+
+<details>
+<summary>Asset Precompilation</summary>
+
+You may use the built-in rake task to hook into your asset precompilation process. First require the Rake tasks, then enhance your asset precompilation. Add this to your `lib/tasks/assets.rake`:
+
+```ruby
+require 'browserslist/rake'
+
+Rake::Task['assets:precompile'].enhance(['browserslist:update'])
+```
+</details>
+
+### Using the API
+
+Once you have generated your browserslist file, the gem provides a hash of minimum required browser versions:
+
+```ruby
+Browserslist.browsers
+# => {chrome: 119.0, firefox: 128.0, edge: 138.0, safari: 18.4, opera: 80.0, ie: false}
+```
+For example with Rails 8.0+ allowed browsers:
+
+```ruby
+allow_browser versions: Browserslist.browsers
+```
+
+You may preview the resulting hash using 
+
+```bash
+bundle exec browserslist browsers
+# => {chrome: 119.0, firefox: 128.0, edge: 138.0, safari: 18.4, opera: 80.0, ie: false}
+```
+
+
+## Configuration
+
+Configure the gem like so:
+
+```ruby
+Browserslist.configure do |config|
+  # Set custom file path 
+  config.file_path = ".browserslist.json"
+  
+  # Enable/disable strict mode 
+  # When strict mode is enabled, missing browsers hash value will be set to false, which in conjunction with `allow_browser` means they will be forbidden from accessing your application.
+  config.strict = true
+end
+```
+
+## Browser Support
+
+The gem supports these browsers:
+- **Chrome** (`chrome`, `and_chr`)
+- **Firefox** (`firefox`, `and_ff`) 
+- **Safari** (`safari`, `ios_saf`)
+- **Edge** (`edge`)
+- **Opera** (`opera`, `op_mob`)
+- **Internet Explorer** (`ie`)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hschne/browserslist-rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/exe/browserslist

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "browserslist"
+
+Browserslist::Cli.new(ARGV).run

data/lib/browserslist/browsers.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Browserslist
+  class Browsers
+    def self.parse(content = nil)
+      new.parse(content)
+    end
+
+    def parse(content = nil)
+      content ||= file_contents
+      return {} if content.nil?
+
+      parse_content(content)
+    end
+
+    def file_contents
+      file_path = Browserslist.configuration.file_path
+
+      unless File.exist?(file_path)
+        puts "Warning: Browserslist file '#{file_path}' not found. Run 'browserslist:update' to generate it."
+        return nil
+      end
+
+      File.read(file_path)
+    end
+
+    private
+
+    def parse_content(file_content)
+      parsed_json = JSON.parse(file_content)
+      browser_list = parsed_json["browsers"]
+
+      result = {}
+      browser_list.each do |browser_version|
+        browser, version = browser_version.split(" ", 2)
+        next unless browser && version
+
+        normalized_browser = normalize_browser_name(browser)
+        next if normalized_browser.nil?
+
+        clean_version = extract_min_version(version)
+        gem_version = Gem::Version.new(clean_version)
+
+        if result[normalized_browser].nil? || gem_version < Gem::Version.new(result[normalized_browser].to_s)
+          result[normalized_browser] = gem_version.version.to_f
+        end
+      end
+
+      add_missing_browsers_if_strict(result)
+    end
+
+    def add_missing_browsers_if_strict(result)
+      return result unless Browserslist.configuration.strict
+
+      all_browsers = [:chrome, :firefox, :safari, :edge, :opera, :ie]
+
+      all_browsers.each do |browser|
+        result[browser] = false unless result.key?(browser)
+      end
+
+      result
+    end
+
+    def normalize_browser_name(browser)
+      case browser
+      when "chrome", "and_chr"
+        :chrome
+      when "firefox", "and_ff"
+        :firefox
+      when "safari", "ios_saf"
+        :safari
+      when "edge"
+        :edge
+      when "opera", "op_mob"
+        :opera
+      when "ie"
+        :ie
+      end
+    end
+
+    def extract_min_version(version_string)
+      if version_string.include?("-")
+        min_version, _max_version = version_string.split("-", 2)
+        min_version
+      else
+        version_string
+      end
+    end
+  end
+end

data/lib/browserslist/cli.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Browserslist
+  class Cli
+    def initialize(argv)
+      @argv = argv.dup
+      @options = {}
+    end
+
+    def run
+      parser.parse!(@argv)
+
+      case @argv[0]
+      when "generate", nil
+        generate_command
+      when "browsers"
+        browsers_command
+      else
+        puts "Unknown command: #{@argv[0]}"
+        puts parser.help
+        exit 1
+      end
+    rescue Browserslist::Error => e
+      puts "Error: #{e.message}"
+      exit 1
+    end
+
+    private
+
+    def parser
+      @parser ||= OptionParser.new do |opts|
+        opts.banner = <<~BANNER
+          Usage: browserslist [command] [options]
+
+          Commands:
+              generate [query]    Generate .browserslist.json file
+              browsers            Show supported browsers (from existing file)
+
+          Options:
+        BANNER
+
+        opts.on("-f", "--file PATH", "Output file path (default: .browserslist.json)") do |path|
+          @options[:file_path] = path
+        end
+
+        opts.on("-h", "--help", "Show this help") do
+          puts opts
+          exit
+        end
+      end
+    end
+
+    def generate_command
+      query = @argv[1]
+      @options[:query] = query if query
+
+      file_path = Browserslist.generate(@options)
+      puts "Generated browserslist file: #{file_path}"
+    end
+
+    def browsers_command
+      browsers = Browserslist.browsers
+
+      if browsers.empty?
+        puts "No browsers found. Run 'browserslist generate' first."
+        exit 1
+      end
+
+      puts browsers.inspect
+    end
+  end
+end

data/lib/browserslist/configuration.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Browserslist
+  class Configuration
+    DEFAULT_FILE_PATH = ".browserslist.json"
+
+    attr_accessor :file_path, :strict
+
+    def initialize
+      @file_path = DEFAULT_FILE_PATH
+      @strict = true
+    end
+
+    def self.instance
+      @instance ||= new
+    end
+
+    def self.configure
+      yield(instance) if block_given?
+    end
+  end
+end

data/lib/browserslist/generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module Browserslist
+  class Generator
+    def self.generate(options = {})
+      new.generate(options)
+    end
+
+    def generate(options = {})
+      query = options[:query]
+      file_path = options[:file_path] || Browserslist.configuration.file_path
+
+      output = fetch_browserslist_data(query)
+      File.write(file_path, output)
+      file_path
+    end
+
+    private
+
+    def fetch_browserslist_data(query = nil)
+      check_npx_availability!
+
+      cmd = ["npx", "browserslist", "--json"]
+      cmd << query if query
+
+      stdout, stderr, status = Open3.capture3(*cmd)
+
+      if status.success?
+        stdout.strip
+      else
+        raise Error, "Failed to run browserslist: #{stderr}"
+      end
+    end
+
+    def check_npx_availability!
+      return if system("which npx > /dev/null 2>&1")
+
+      raise Error, "npx is not available. Please install Node.js and npm."
+    end
+  end
+end

data/lib/browserslist/rake.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "../browserslist"
+
+namespace :browserslist do
+  desc "Generate .browserslist.json file"
+  task :update do
+    file_path = Browserslist.generate
+    puts "Generated browserslist file: #{file_path}"
+  rescue Browserslist::Error => e
+    puts "Error: #{e.message}"
+    exit 1
+  end
+end
+

data/lib/browserslist/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Browserslist
+  VERSION = "0.1.0"
+end

data/lib/browserslist.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "browserslist/version"
+require_relative "browserslist/configuration"
+require_relative "browserslist/cli"
+require_relative "browserslist/browsers"
+require_relative "browserslist/generator"
+
+module Browserslist
+  class Error < StandardError; end
+
+  def self.configuration
+    Configuration.instance
+  end
+
+  def self.configure(&block)
+    Configuration.configure(&block)
+  end
+
+  def self.browsers
+    @browsers ||= Browsers.parse
+  end
+
+  def self.generate(options = {})
+    Generator.generate(options)
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: browserslist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hschne
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Bring browserslist to Ruby. Use your existing browserslist config and
+  convert it to a Ruby hash for use with Rails allowed browsers or other browser support
+  detection.
+email:
+- hello@hansschnedlitz.com
+executables:
+- browserslist
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- exe/browserslist
+- lib/browserslist.rb
+- lib/browserslist/browsers.rb
+- lib/browserslist/cli.rb
+- lib/browserslist/configuration.rb
+- lib/browserslist/generator.rb
+- lib/browserslist/rake.rb
+- lib/browserslist/version.rb
+homepage: https://github.com/hschne/browserslist-rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/hschne/browserslist-rb
+  source_code_uri: https://github.com/hschne/browserslist-rb
+  changelog_uri: https://github.com/hschne/browserslist-rb/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Bring browserslist to Ruby
+test_files: []