rubygems-requirements-system 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22a3a8081ff1e94f151748798d5ef76a8486e443bba0fb1eff8beba737117ceb
-  data.tar.gz: 6fd217d604fa0ca5e14d46621579c4def3ee907e729fd5c49d5b158db37bc436
+  metadata.gz: 8f87b213f67bfe68b6caa65cc7d6f5f26afcd296be4c8175ab6c60e34ce5a6e0
+  data.tar.gz: fcb778b18e788a332e523f299f9af433997c42cad62bcf132b6c6451fc902f81
 SHA512:
-  metadata.gz: 7d38029bf367d24f6dca168d661a75fe5b1571f9e41bbde5d9aaeed641bcbf9ef45c7e3035969a72edf3b30faf89e3aa5693d66e6be2c5b96dee1bf7a7f0beb6
-  data.tar.gz: 76f55fc9787328c0892da26a4f623c424d1d8cbdae9787fe8d5864bbe0fae0880707bcb41c32eab003ccdb2abca35c1ac3e9b749c3893a18c0ecec007b28d89b
+  metadata.gz: c59501b4dd04061d6ae9551569462619aeef6764f506edb1c1be42958499d3737dd45381eece9012c57837e16d063ba61825349e697dc0ec4ee230466afd3987
+  data.tar.gz: 2b25b9acf564e5d02c26052e6a199711865c0c84d26bee7468dd7c3553c872f82fb165aa1ff16d51e0c9638eb978fd43fac192dd099334eb69b90e371bb98a77

data/README.md

@@ -62,7 +62,7 @@ Add dependency information to `Gem::Specification#requirements`.
 
 In most cases, you can just specify the followings:
 
-1. Package ID
+1. Package ID as dependency
 2. Platform ID
 3. Package name on the platform
 
@@ -338,6 +338,36 @@ Gem::Specification.new do |spec|
 end
 ```
 
+### Executable dependency
+
+Dependency (the `DEPENDENCY` part in `system: DEPENDENCY: ...`) is
+package ID of pkg-config by default. But you can use an executable as
+dependency. For example, [graphviz
+gem](https://rubygems.org/gems/graphviz) uses the `dot` command. It
+means that the `dot` command is a runtime dependency of graphviz gem.
+
+We can use rubygems-requirements-system for this use case. We can use
+`executable(name)` for the `DEPENDENCY` part:
+
+```ruby
+Gem::Specification.new do |spec|
+  # ...
+
+  # Install dot before this gem is installed.
+  spec.requirements << "system: executable(dot): alt_linux: graphviz"
+  spec.requirements << "system: executable(dot): arch_linux: graphviz"
+  spec.requirements << "system: executable(dot): conda: graphviz"
+  spec.requirements << "system: executable(dot): debian: graphviz"
+  spec.requirements << "system: executable(dot): gentoo_linux: media-gfx/graphviz"
+  spec.requirements << "system: executable(dot): homebrew: graphviz"
+  spec.requirements << "system: executable(dot): macports: graphviz"
+  spec.requirements << "system: executable(dot): rhel: graphviz"
+
+  # ...
+end
+```
+
+
 ## Configurations
 
 ### Disable

data/doc/text/news.md

@@ -1,5 +1,11 @@
 # News
 
+## 0.0.8 - 2025-04-05
+
+### Improvements
+
+  * Added support for an executable as a dependency.
+
 ## 0.0.7 - 2025-03-22
 
 ### Fixes

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

@@ -0,0 +1,24 @@
+# Copyright (C) 2025  Ruby-GNOME Project Team
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require_relative "executable-finder"
+
+module RubyGemsRequirementsSystem
+  Executable = Struct.new(:name) do
+    def installed?
+      ExecutableFinder.exist?(name)
+    end
+  end
+end

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

@@ -19,6 +19,7 @@ require_relative "version"
 
 require_relative "platform"
 require_relative "requirements-parser"
+require_relative "ui"
 
 module RubyGemsRequirementsSystem
   pkg_config_rb = File.join(__dir__, "pkg-config.rb")
@@ -31,17 +32,16 @@ module RubyGemsRequirementsSystem
   end
 
   class Installer
-    include Gem::UserInteraction
-
-    def initialize(gemspec)
+    def initialize(gemspec, ui)
       @gemspec = gemspec
-      @platform = Platform.detect
+      @ui = UI.new(ui)
+      @platform = Platform.detect(@ui)
     end
 
     def install
       return true unless enabled?
 
-      parser = RequirementsParser.new(@gemspec.requirements, @platform)
+      parser = RequirementsParser.new(@gemspec.requirements, @platform, @ui)
       requirements = parser.parse
       requirements.all? do |requirement|
         next true if requirement.satisfied?

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

@@ -15,16 +15,15 @@
 
 module RubyGemsRequirementsSystem
   Package = Struct.new(:id, :operator, :required_version) do
-    class << self
-      def parse(input)
-        new(*input.split(/\s*(==|>=|>|<=|<)\s*/, 3))
+    def installed?
+      package_config = PKGConfig.package_config(id)
+      begin
+        package_config.cflags
+      rescue PackageConfig::NotFoundError
+        return false
       end
-    end
 
-    def valid?
-      return false if id.empty?
-      return false if operator and required_version.nil?
-      true
+      satisfied?(package_config.version)
     end
 
     def satisfied?(target_version)

data/lib/rubygems-requirements-system/platform/base.rb

@@ -15,7 +15,6 @@
 
 require "fileutils"
 require "open-uri"
-require "rubygems/user_interaction"
 require "tempfile"
 
 require_relative "../executable-finder"
@@ -24,7 +23,9 @@ require_relative "../os-release"
 module RubyGemsRequirementsSystem
   module Platform
     class Base
-      include Gem::UserInteraction
+      def initialize(ui)
+        @ui = ui
+      end
 
       def target?(platform)
         raise NotImpelementedError
@@ -122,8 +123,8 @@ module RubyGemsRequirementsSystem
         else
           package_label = package
         end
-        prefix = "requirements: system: #{package_label}: #{action}"
-        say("#{prefix}: Start")
+        prefix = "#{package_label}: #{action}"
+        @ui.info("#{prefix}: Start")
         failed_to_get_super_user_priviledge = false
         if have_priviledge?
           succeeded = system(*command_line)
@@ -142,16 +143,16 @@ module RubyGemsRequirementsSystem
         else
           result_message = succeeded ? "succeeded" : "failed"
         end
-        say("#{prefix}: #{result_message}")
+        @ui.info("#{prefix}: #{result_message}")
 
         unless succeeded
           escaped_command_line = command_line.collect do |part|
-            Shellwords.escape(part)
+            Shellwobrds.escape(part)
           end
-          alert_warning("#{prefix}: Failed.")
-          alert_warning("Run the following command " +
-                        "to #{action} required system package: " +
-                        escaped_command_line.join(" "))
+          @ui.error("#{prefix}: Failed.")
+          @ui.error("Run the following command " +
+                    "to #{action} required system package: " +
+                    escaped_command_line.join(" "))
         end
         succeeded
       end

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

@@ -22,11 +22,11 @@ module RubyGemsRequirementsSystem
         PLATFORM_CLASSES << platform_class
       end
 
-      def detect
+      def detect(ui)
         PLATFORM_CLASSES.reverse_each do |platform_class|
-          return platform_class.new if platform_class.current_platform?
+          return platform_class.new(ui) if platform_class.current_platform?
         end
-        Unknown.new
+        Unknown.new(ui)
       end
     end
   end

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

@@ -14,23 +14,11 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module RubyGemsRequirementsSystem
-  Requirement = Struct.new(:packages, :system_packages) do
+  Requirement = Struct.new(:dependencies, :system_packages) do
     def satisfied?
-      packages.any? do |package|
-        installed?(package)
+      dependencies.any? do |dependency|
+        dependency.installed?
       end
     end
-
-    private
-    def installed?(package)
-      package_config = PKGConfig.package_config(package.id)
-      begin
-        package_config.cflags
-      rescue PackageConfig::NotFoundError
-        return false
-      end
-
-      package.satisfied?(package_config.version)
-    end
   end
 end

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

@@ -13,65 +13,97 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+require_relative "executable"
 require_relative "package"
 require_relative "requirement"
 require_relative "system-repository"
 
 module RubyGemsRequirementsSystem
   class RequirementsParser
-    def initialize(gemspec_requirements, platform)
+    def initialize(gemspec_requirements, platform, ui)
       @gemspec_requirements = gemspec_requirements
       @platform = platform
+      @ui = ui
     end
 
     def parse
-      all_packages_set = {}
+      all_dependencies_set = {}
       requirements = {}
       @gemspec_requirements.each do |gemspec_requirement|
         components = gemspec_requirement.split(/:\s*/, 4)
         next unless components.size == 4
 
-        id, raw_packages, platform, system_package = components
+        id, raw_dependencies, platform, system_package = components
         next unless id == "system"
 
-        packages = parse_packages(raw_packages)
-        next if packages.empty?
+        dependencies = parse_dependencies(raw_dependencies)
+        next if dependencies.empty?
 
-        all_packages_set[packages] = true
+        all_dependencies_set[dependencies] = true
 
         next unless @platform.target?(platform)
-        requirements[packages] ||= []
-        requirements[packages] << system_package
+        requirements[dependencies] ||= []
+        requirements[dependencies] << system_package
       end
-      (all_packages_set.keys - requirements.keys).each do |not_used_packages|
+      (all_dependencies_set.keys - requirements.keys).each do |not_used_deps|
+        not_used_packages = not_used_deps.select do |dependency|
+          dependency.is_a?(Package)
+        end
+        next if not_used_packages.empty?
         system_packages = @platform.default_system_packages(not_used_packages)
         next if system_packages.nil?
-        requirements[not_used_packages] = system_packages
+        requirements[not_used_deps] = system_packages
       end
-      requirements.collect do |packages, system_packages|
+      requirements.collect do |dependencies, system_packages|
         system_packages = detect_system_repositories(system_packages)
-        Requirement.new(packages, system_packages)
+        Requirement.new(dependencies, system_packages)
       end
     end
 
     private
-    def parse_packages(raw_packages)
-      packages = raw_packages.split(/\s*\|\s*/).collect do |raw_package|
-        Package.parse(raw_package)
+    def parse_dependencies(raw_dependencies)
+      dependencies = []
+      raw_dependencies.split(/\s*\|\s*/).each do |raw_dependency|
+        match_data = /\A([^(]+)\((.+)\)\z/.match(raw_dependency)
+        if match_data
+          type = match_data[1]
+          value = match_data[2]
+        else
+          type = "pkgconfig"
+          value = raw_dependency
+        end
+        dependency = parse_dependency(type, value, raw_dependency)
+        next if dependency.nil?
+        dependencies << dependency
       end
-      # Ignore this requirement if any invalid package is included.
-      # We must not report an error for this because
+      dependencies
+    end
+
+    def parse_dependency(type, value, raw_dependency)
+      # We must not report an error for invalid dependency 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 []
+      # "system: ..." but not for this plugin. We can report a warning
+      # instead.
+      case type
+      when "executable"
+        Executable.new(value)
+      when "pkgconfig"
+        id, operator, required_version = value.split(/\s*(==|>=|>|<=|<)\s*/, 3)
+        if id.empty?
+          @ui.warn("Ignore invalid package: no ID: #{raw_dependency}")
+          return nil
+        end
+        if operator and required_version.nil?
+          @ui.warn("Ignore invalid package: " +
+                   "no required version with operator: #{raw_dependency}")
+          return nil
         end
+        Package.new(id, operator, required_version)
+      else
+        @ui.warn("Ignore unsupported type: #{type}: #{raw_dependency}")
+        nil
       end
-      packages
     end
 
     def detect_system_repositories(original_system_packages)

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

@@ -0,0 +1,44 @@
+# Copyright (C) 2025  Ruby-GNOME Project Team
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module RubyGemsRequirementsSystem
+  class UI
+    def initialize(ui)
+      @ui = ui
+    end
+
+    def debug(message)
+      log(:debug, message)
+    end
+
+    def info(message)
+      log(:info, message)
+    end
+
+    def warn(message)
+      log(:warn, message)
+    end
+
+    private
+    def log(level, message)
+      message = "requirements: system: #{message}"
+      if @ui.respond_to?(level)
+        @ui.__send__(level, message)
+      else
+        @ui.say(message)
+      end
+    end
+  end
+end

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

@@ -14,5 +14,5 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module RubyGemsRequirementsSystem
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/lib/rubygems_plugin.rb

@@ -19,6 +19,7 @@ Gem.pre_install do |gem_installer|
 
   require_relative "rubygems-requirements-system/installer"
 
-  installer = RubyGemsRequirementsSystem::Installer.new(gem_installer.spec)
+  ui = Gem.ui
+  installer = RubyGemsRequirementsSystem::Installer.new(gem_installer.spec, ui)
   installer.install
 end

data/plugins.rb

@@ -20,7 +20,8 @@ Bundler::Plugin::API.hook(Bundler::Plugin::Events::GEM_BEFORE_INSTALL_ALL) do |d
 
     require_relative "lib/rubygems-requirements-system/installer"
 
-    installer = RubyGemsRequirementsSystem::Installer.new(gem_installer.spec)
+    ui = Bundler.ui
+    installer = RubyGemsRequirementsSystem::Installer.new(gem_installer.spec, ui)
     installer.install
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubygems-requirements-system
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Sutou Kouhei
 bindir: bin
 cert_chain: []
-date: 2025-03-22 00:00:00.000000000 Z
+date: 2025-04-05 00:00:00.000000000 Z
 dependencies: []
 description: |-
   Users need to install system packages to install an extension library
@@ -29,6 +29,7 @@ files:
 - doc/text/lgpl-3.txt
 - doc/text/news.md
 - lib/rubygems-requirements-system/executable-finder.rb
+- lib/rubygems-requirements-system/executable.rb
 - lib/rubygems-requirements-system/installer.rb
 - lib/rubygems-requirements-system/os-release.rb
 - lib/rubygems-requirements-system/package.rb
@@ -55,6 +56,7 @@ files:
 - lib/rubygems-requirements-system/requirement.rb
 - lib/rubygems-requirements-system/requirements-parser.rb
 - lib/rubygems-requirements-system/system-repository.rb
+- lib/rubygems-requirements-system/ui.rb
 - lib/rubygems-requirements-system/version.rb
 - lib/rubygems_plugin.rb
 - plugins.rb