rubygems-requirements-system 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 598b91ef023d6606d97e7bfc74168cef0316de0897c63266c7371ef844322d6a
-  data.tar.gz: 99fe81ea125044711118147950372853e17377a25306b09e20f9ca0f3369e43e
+  metadata.gz: 0271d5e7218e5a925f41e5d890ad4eed1194572fbb2a140578df4bef80bbc666
+  data.tar.gz: 9631386ad89e63d5534cc0e5e463aa7231f777ec3c3738c80a9dbcbedd94d779
 SHA512:
-  metadata.gz: b0dbff35b8e7ccfd004b78bfcf26efe011afd87106c646ba02093c4c7e076f568ebc8d65b96dc3ce15d2ed739780de8504557a412f5e4a1e21a2a38c15e6f735
-  data.tar.gz: 89933a20c0aa2129b871df4a70d445bb856258959889a225849f25030d55de60252470db5e540e3a3fd12cedc4773ca5c78712d170183aa393948267419ea2b2
+  metadata.gz: f3d2ac2e6e04d60114008135395b83c563251810bd5157af728dd0fd28dc1100610a7621895400f298f9ed2747122c21483ea3f43e4447ad92cde70aba7ce15f
+  data.tar.gz: b0679db240aa4a3c1feb263da1e36f17d2a984b7e29431e4d0159c1cfce3642e40d8498d99da652001789ead7965ee6decbbd073aecb4050bbde7c4fcf950867

data/README.md

@@ -40,21 +40,33 @@ developers and users. If we can reduce maintenance costs for
 developers, developers can focus on new features and bug fixes than
 releases.
 
-## Usage
+## Usage for users
 
-Add `rubygems-requirements-system` to your gem's runtime dependencies:
+If you're using Bundler, add the following line to your `Gemfile`:
 
 ```ruby
-Gem::Specification.new do |spec|
-  # ...
-  spec.add_runtime_dependency("rubygems-requirements-system")
-  # ...
-end
+plugin "rubygems-requirements-system"
 ```
 
+If you're not using Bundler, install `rubygems-requirements-system`:
+
+```bash
+gem install rubygems-requirements-system
+```
+
+## Usage for developers
+
+Add dependency information to `Gem::Specification#requirements`.
+
 ### Basic usage
 
-Add dependency information to `Gem::Specification#requirements`:
+In most cases, you can just specify the followings:
+
+1. Package ID
+2. Platform ID
+3. Package name on the platform
+
+See the following example:
 
 ```ruby
 Gem::Specification.new do |spec|
@@ -173,7 +185,7 @@ Gem::Specification.new do |spec|
   #
   # On Ubuntu 24.04:
   #   https://packages.groonga.org/%{distribution}/groonga-apt-source-latest-%{code_name}.deb ->
-  #   https://packages.groonga.org/ubuntu/groonga-apt-source-latest-nobole.deb
+  #   https://packages.groonga.org/ubuntu/groonga-apt-source-latest-noble.deb
   spec.requirements << "system: groonga: debian: https://packages.groonga.org/%{distribution}/groonga-apt-source-latest-%{code_name}.deb"
   # Install libgroonga-dev from the registered repository.
   spec.requirements << "system: groonga: debian: libgroonga-dev"
@@ -207,15 +219,141 @@ Gem::Specification.new do |spec|
 end
 ```
 
-## Requirements
+### Install repositories
+
+You can install APT/Yum repositories by specifying metadata.
+
+You need to specify multiple metadata for one repository. So you need
+to use multiple `spec.requirements` for one repository. Here is the
+syntax for one repository:
+
+```ruby
+spec.requirements << "system: #{package}: #{platform}: repository: #{key1}: #{value1}"
+spec.requirements << "system: #{package}: #{platform}: repository: #{key2}: #{value2}"
+# ...
+```
+
+You must specify at least `id` as `key`. For example:
+
+```
+spec.requirements << "system: libpq: debian: repository: id: pgdg"
+```
+
+You can start another repository metadata by starting `id` metadata
+for another repository:
+
+```ruby
+spec.requirements << "system: #{package}: #{platform}: repository: id: repository1"
+spec.requirements << "system: #{package}: #{platform}: repository: #{key1_1}: #{value1_1}"
+spec.requirements << "system: #{package}: #{platform}: repository: #{key1_2}: #{value1_2}"
+# ...
+spec.requirements << "system: #{package}: #{platform}: repository: id: repository2"
+spec.requirements << "system: #{package}: #{platform}: repository: #{key2_1}: #{value2_1}"
+spec.requirements << "system: #{package}: #{platform}: repository: #{key2_2}: #{value2_2}"
+# ...
+```
+
+Here are metadata for a APT repository:
+
+* `compoennts`: Optional. The default is `main`.
+* `signed-by`: Optional. The URL of armored keyring that is used for
+  signing this repository.
+* `suites`: Optional. The default is `%{code_name}`.
+* `types`: Optional. The default is `deb`.
+* `uris`: Required. The URLs that provide this repository.
+
+See also: https://wiki.debian.org/SourcesList
+
+Here are metadata for a Yum repository:
+
+* `baseurl`: Required. The base URL that provides this repository.
+* `gpgkey`: Optional. The URL of GPG key that is used for signing this
+  repository.
+* `name`: Optional. The name of this repository.
+
+See also: TODO: Is there any URL that describes the specification of
+`.repo` file?
+
+You can use placeholder for metadata values with `%{KEY}` format.
+
+Here are available placeholders:
+
+`debian` family platforms:
+
+* `distribution`: The `ID` value in `/etc/os-release`. It's `debian`,
+  `ubuntu` and so on.
+* `code_name`: The `VERSION_CODENAME` value in `/etc/os-release`. It's
+  `bookworm`, `noble` and so on.
+* `version`: The `VERSION_ID` value in `/etc/os-release`. It's `12`,
+  `24.04` and so on.
+
+`fedora` family platforms:
+
+* `distribution`: The `ID` value in `/etc/os-release`. It's `fedora`,
+  `rhel`, `almalinux` and so on.
+* `major_version`: The major part of `VERSION_ID` value in
+  `/etc/os-release`. It's `41`, `9` and so on.
+* `version`: The `VERSION_ID` value in `/etc/os-release`. It's `41`,
+  `9.5` and so on.
+
+Here is an example that uses this feature for adding a new repository:
+
+```ruby
+Gem::Specification.new do |spec|
+  # ...
+
+  # Install PostgreSQL's APT repository on Debian family platforms.
+  #
+  # %{code_name} is placeholders.
+  #
+  # On Debian GNU/Linux bookworm:
+  #   %{code_name}-pgdg ->
+  #   bookworm-pgdg
+  #
+  # On Ubuntu 24.04:
+  #   %{code_name}-pgdg ->
+  #   noble-pgdg
+  spec.requirements << "system: libpq: debian: repository: id: pgdg"
+  spec.requirements << "system: libpq: debian: repository: uris: https://apt.postgresql.org/pub/repos/apt"
+  spec.requirements << "system: libpq: debian: repository: signed-by: https://www.postgresql.org/media/keys/ACCC4CF8.asc"
+  spec.requirements << "system: libpq: debian: repository: suites: %{code_name}-pgdg"
+  spec.requirements << "system: libpq: debian: repository: components: main"
+  # Install libpq-dev from the registered repository.
+  spec.requirements << "system: libpq: debian: libpq-dev"
+
+  # Install PostgreSQL's Yum repository on RHEL family platforms:
+  spec.requirements << "system: libpq: rhel: repository: id: pgdg17"
+  spec.requirements << "system: libpq: rhel: repository: name: PostgreSQL 17 $releasever - $basearch"
+  spec.requirements << "system: libpq: rhel: repository: baseurl: https://download.postgresql.org/pub/repos/yum/17/redhat/rhel-$releasever-$basearch"
+  spec.requirements << "system: libpq: rhel: repository: gpgkey: https://download.postgresql.org/pub/repos/yum/keys/PGDG-RPM-GPG-KEY-RHEL"
+  # You can disable built-in "postgresql" module by "module: disable:
+  # postgresql".
+  spec.requirements << "system: libpq: rhel: module: disable: postgresql"
+  # Install postgresql17-devel from the registered repository. But
+  # users can't find "libpq.pc" provided by postgresql17-devel without
+  # PKG_CONFIG_PATH=/usr/pgsql-17/lib/pkgconfig ...
+  spec.requirements << "system: libpq: rhel: postgresql17-devel"
+
+  # ...
+end
+```
+
+## Configurations
+
+### Disable
+
+If you want to install system packages automatically, you need to
+install rubygems-requirements-system gem explicitly (opt-in). You can
+disable rubygems-requirements-system gem even when you install this
+explicitly:
 
-RubyGems 3.5.0 or later is required. RubyGems can load installed
-plugin immediately since 3.5.0.
+1. Set `RUBYGEMS_REQUIREMENTS_SYSTEM=false`
+2. Add the following configuration to `~/.gemrc`:
 
-If `gem install glib2` installs rubygems-requirements-system gem as a
-dependency, old RubyGems doesn't use a RubyGems plugin in
-rubygems-requirements-system gem while installing glib2 gem. So glib2
-gem dependencies aren't installed automatically.
+   ```yaml
+   requirements_system:
+     enabled: false
+   ```
 
 ## History
 

data/Rakefile

@@ -16,6 +16,8 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 require "bundler/gem_helper"
+require "json"
+require "open-uri"
 
 base_dir = File.dirname(__FILE__)
 helper = Bundler::GemHelper.new(base_dir)
@@ -24,6 +26,35 @@ def helper.version_tag
 end
 helper.install
 
+def github_api(path)
+  URI("https://api.github.com/#{path}").open do |response|
+    JSON.parse(response.read)
+  end
+end
+
+def github_content(repository, tag, path, &block)
+  uri = "https://raw.githubusercontent.com/#{repository}/" +
+        "refs/tags/#{tag}/#{path}"
+  URI(uri).open(&block)
+end
+
+namespace :vendor do
+  namespace :pkg_config do
+    desc "Update vendored pkg-config"
+    task :update do
+      latest = github_api("repos/ruby-gnome/pkg-config/releases/latest")
+      github_content("ruby-gnome/pkg-config",
+                     latest["tag_name"],
+                     "lib/pkg-config.rb") do |response|
+        output_path = "lib/rubygems-requirements-system/pkg-config.rb"
+        File.open(output_path, "w") do |output|
+          IO.copy_stream(response, output)
+        end
+      end
+    end
+  end
+end
+
 release_task = Rake.application["release"]
 # We use Trusted Publishing.
 release_task.prerequisites.delete("build")

data/doc/text/news.md

@@ -1,5 +1,28 @@
 # News
 
+## 0.0.4 - 2025-03-05
+
+### Improvements
+
+  * Bundled `pkg-config` gem.
+
+  * Changed to opt-in style. Each user must install this gem
+    explicitly.
+
+  * Added support for Bundler.
+
+## 0.0.3 - 2025-01-13
+
+### Improvements
+
+  * Added support for opt-out.
+
+  * debian: Added support for adding APT repository by raw metadata.
+
+  * fedora: Added support for adding Yum repository by raw metadata.
+
+  * fedora: Added support for enabling/disabling module.
+
 ## 0.0.2 - 2025-01-08
 
 ### Improvements

data/lib/rubygems-requirements-system/installer.rb

@@ -15,42 +15,18 @@
 
 require "shellwords"
 
-require "pkg-config"
-
 require_relative "version"
 
 require_relative "platform"
+require_relative "requirements-parser"
 
 module RubyGemsRequirementsSystem
-  Package = Struct.new(:id, :operator, :version) do
-    def valid?
-      return false if id.empty?
-      return false if operator and version.nil?
-      true
-    end
-  end
-
-  Requirement = Struct.new(:packages, :system_packages) do
-    def satisfied?
-      packages.any? do |package|
-        installed?(package)
-      end
-    end
-
-    private
-    def installed?(package)
-      package_config = PKGConfig.package_config(package.id)
-      begin
-        package_config.cflags
-      rescue PackageConfig::NotFoundError
-        return false
-      end
-
-      return true if package.version.nil?
-
-      current_version = Gem::Version.new(package_config.version)
-      required_version = Gem::Version.new(package.version)
-      current_version.__send__(package.operator, required_version)
+  pkg_config_rb = File.join(__dir__, "pkg-config.rb")
+  load(pkg_config_rb, self)
+  unless const_defined?(:PKGConfig)
+    # Ruby < 3.1
+    File.open(pkg_config_rb) do |pkg_config_rb_file|
+      module_eval(pkg_config_rb_file.read, pkg_config_rb)
     end
   end
 
@@ -63,7 +39,10 @@ module RubyGemsRequirementsSystem
     end
 
     def install
-      requirements = parse_requirements(@gemspec.requirements)
+      return true unless enabled?
+
+      parser = RequirementsParser.new(@gemspec.requirements, @platform)
+      requirements = parser.parse
       requirements.all? do |requirement|
         next true if requirement.satisfied?
         @platform.install(requirement)
@@ -71,52 +50,21 @@ module RubyGemsRequirementsSystem
     end
 
     private
-    def parse_requirements(gemspec_requirements)
-      all_packages_set = {}
-      requirements = {}
-      gemspec_requirements.each do |gemspec_requirement|
-        components = gemspec_requirement.split(/: +/, 4)
-        next unless components.size == 4
-
-        id, raw_packages, platform, system_package = components
-        next unless id == "system"
-
-        packages = parse_packages(raw_packages)
-        next if packages.empty?
-
-        all_packages_set[packages] = true
-
-        next unless @platform.target?(platform)
-        requirements[packages] ||= []
-        requirements[packages] << system_package
-      end
-      (all_packages_set.keys - requirements.keys).each do |not_used_packages|
-        system_packages = @platform.default_system_packages(not_used_packages)
-        next if system_packages.nil?
-        requirements[not_used_packages] = system_packages
-      end
-      requirements.collect do |packages, system_packages|
-        Requirement.new(packages, system_packages)
+    def enabled?
+      case ENV["RUBYGEMS_REQUIREMENTS_SYSTEM"]
+      when "0", "no", "NO", "false", "FALSE"
+        return false
       end
-    end
 
-    def parse_packages(raw_packages)
-      packages = raw_packages.split(/\s*\|\s*/).collect do |raw_package|
-        Package.new(*raw_package.split(/\s*(==|!=|>=|>|<=|<)\s*/, 3))
-      end
-      # Ignore this requirement if any invalid package is included.
-      # We must not report an error for this because
-      # Gem::Specification#requirements is a free form
-      # configuration. So there are configuration values that use
-      # "system: ..." but not for this plugin. We can report a
-      # warning instead.
-      packages.each do |package|
-        unless package.valid?
-          # TODO: Report a warning
-          return []
-        end
+      requirements_system = Gem.configuration["requirements_system"] || {}
+      case requirements_system["enabled"]
+      when false
+        return false
+      when "false" # "true"/"false" isn't converted to boolean with old RubyGems
+        return false
       end
-      packages
+
+      true
     end
   end
 end

data/lib/rubygems-requirements-system/os-release.rb

@@ -34,7 +34,7 @@ module RubyGemsRequirementsSystem
     end
 
     def id_like
-      (self["ID_LIKE"] || "").split(/ /)
+      (self["ID_LIKE"] || "").split(/\s+/)
     end
 
     def version

data/lib/rubygems-requirements-system/package.rb

@@ -14,4 +14,25 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module RubyGemsRequirementsSystem
+  Package = Struct.new(:id, :operator, :required_version) do
+    class << self
+      def parse(input)
+        new(*input.split(/\s*(==|>=|>|<=|<)\s*/, 3))
+      end
+    end
+
+    def valid?
+      return false if id.empty?
+      return false if operator and required_version.nil?
+      true
+    end
+
+    def satisfied?(target_version)
+      return true if required_version.nil?
+
+      target = Gem::Version.new(target_version)
+      required = Gem::Version.new(required_version)
+      target.__send__(operator, required)
+    end
+  end
 end