rubygems-requirements-system 0.0.1

data/doc/text/lgpl-3.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/doc/text/news.md

@@ -0,0 +1,5 @@
+# News
+
+## 0.0.1 - 2025-01-08
+
+Initial release!!!

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

@@ -0,0 +1,87 @@
+# Copyright (C) 2013-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 "rbconfig"
+
+module RubyGemsRequirementsSystem
+  class ExecutableFinder
+    class << self
+      def find(basename)
+        new(basename).find
+      end
+
+      def exist?(basename)
+        new(basename).exist?
+      end
+    end
+
+    def initialize(basename)
+      @basename = basename
+      @appended_paths = []
+    end
+
+    def find
+      extensions = detect_extensions
+      paths.each do |path|
+        executable_file = File.join(path, @basename)
+        return executable_file if executable?(executable_file)
+        extensions.each do |extension|
+          executable_file_with_extension = executable_file + extension
+          if executable?(executable_file_with_extension)
+            return executable_file_with_extension
+          end
+        end
+      end
+      nil
+    end
+
+    def exist?
+      not find.nil?
+    end
+
+    def append_path(path)
+      @appended_paths << path
+    end
+
+    private
+    def paths
+      path_env = ENV["PATH"]
+      if path_env
+        base_paths = path_env.split(File::PATH_SEPARATOR)
+      else
+        base_paths = ["/usr/local/bin", "/usr/bin", "/bin"]
+      end
+      base_paths + @appended_paths
+    end
+
+    def detect_extensions
+      exts = RbConfig::CONFIG["EXECUTABLE_EXTS"]
+      return exts.split if exts
+      ext = RbConfig::CONFIG["EXEEXT"]
+      return [ext] if ext
+      []
+    end
+
+    def executable?(path)
+      begin
+        stat = File.stat(path)
+      rescue SystemCallError
+        false
+      else
+        stat.file? and stat.executable?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,122 @@
+# Copyright (C) 2017-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 "shellwords"
+
+require "pkg-config"
+
+require_relative "version"
+
+require_relative "platform"
+
+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)
+    end
+  end
+
+  class Installer
+    include Gem::UserInteraction
+
+    def initialize(gemspec)
+      @gemspec = gemspec
+      @platform = Platform.detect
+    end
+
+    def install
+      requirements = parse_requirements(@gemspec.requirements)
+      requirements.all? do |requirement|
+        next true if requirement.satisfied?
+        @platform.install(requirement)
+      end
+    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)
+      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
+      end
+      packages
+    end
+  end
+end

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

@@ -0,0 +1,59 @@
+# Copyright (C) 2021-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 OSRelease
+    include Enumerable
+
+    def initialize
+      parse
+    end
+
+    def each(&block)
+      @variables.each(&block)
+    end
+
+    def [](key)
+      @variables[key]
+    end
+
+    def id
+      self["ID"]
+    end
+
+    def id_like
+      (self["ID_LIKE"] || "").split(/ /)
+    end
+
+    def version
+      self["VERSION"]
+    end
+
+    private
+    def parse
+      @variables = {}
+      path = "/etc/os-release"
+      return unless File.exist?(path)
+      File.foreach(path) do |line|
+        key, value = line.strip.split("=", 2)
+        next if value.nil?
+        if value.start_with?("\"") and value.end_with?("\"")
+          value = value[1..-2]
+        end
+        @variables[key] = value
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# 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
+end

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

@@ -0,0 +1,44 @@
+# Copyright (C) 2023-2024  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 "base"
+
+module RubyGemsRequirementsSystem
+  module Platform
+    class AlpineLinux < Base
+      Platform.register(self)
+
+      class << self
+        def current_platform?
+          os_release = OSRelease.new
+          os_release.id == "alpine"
+        end
+      end
+
+      def target?(platform)
+        platform == "alpine_linux"
+      end
+
+      private
+      def need_super_user_priviledge?
+        true
+      end
+
+      def install_command_line(package)
+        ["apk", "add", package]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# Copyright (C) 2017-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 "base"
+
+module RubyGemsRequirementsSystem
+  module Platform
+    class ALTLinux < Base
+      Platform.register(self)
+
+      class << self
+        def current_platform?
+          os_release = OSRelease.new
+          os_release.id == "altlinux"
+        end
+      end
+
+      def target?(platform)
+        platform == "alt_linux"
+      end
+
+      private
+      def install_command_line(package)
+        [
+          "env",
+          "DEBIAN_FRONTEND=noninteractive",
+          "apt-get",
+          "install",
+          "-V",
+          "-y",
+          package,
+        ]
+      end
+
+      def need_super_user_priviledge?
+        true
+      end
+    end
+  end
+end

data/lib/rubygems-requirements-system/platform/amazon-linux-2.rb

@@ -0,0 +1,50 @@
+# Copyright (C) 2022-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 "red-hat-enterprise-linux"
+
+module RubyGemsRequirementsSystem
+  module Platform
+    class AmazonLinux2 < RedHatEnterpriseLinux
+      Platform.register(self)
+
+      class << self
+        def current_platform?
+          os_release = OSRelease.new
+          os_release.id == "amzn" and os_release.version == "2"
+        end
+      end
+
+      def target?(platform)
+        case platform
+        when "amazon_linux_2", "amazon_linux"
+          true
+        else
+          super
+        end
+      end
+
+      private
+      def install_command_line(package)
+        [
+          "yum",
+          "install",
+          "-y",
+          package,
+        ]
+      end
+    end
+  end
+end

data/lib/rubygems-requirements-system/platform/amazon-linux-2023.rb

@@ -0,0 +1,40 @@
+# Copyright (C) 2023-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 "fedora"
+
+module RubyGemsRequirementsSystem
+  module Platform
+    class AmazonLinux2023 < Fedora
+      Platform.register(self)
+
+      class << self
+        def current_platform?
+          os_release = OSRelease.new
+          os_release.id == "amzn" and os_release.version == "2023"
+        end
+      end
+
+      def target?(platform)
+        case platform
+        when "amazon_linux_2023", "amazon_linux"
+          true
+        else
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# Copyright (C) 2017-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 "base"
+
+module RubyGemsRequirementsSystem
+  module Platform
+    class ArchLinux < Base
+      Platform.register(self)
+
+      class << self
+        def current_platform?
+          ExecutableFinder.exist?("pacman")
+        end
+      end
+
+      def target?(platform)
+        platform == "arch_linux"
+      end
+
+      private
+      def install_command_line(package)
+        ["pacman", "-S", "--noconfirm", package]
+      end
+
+      def need_super_user_priviledge?
+        true
+      end
+    end
+  end
+end