rubygems-requirements-system 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b4f3b0dc17cf9b76958081357cc6f9cf1ab338e86a88aad5ed4643d9bca8766
+  data.tar.gz: 4ebf3a4f17907e0c5ac6ce55a857eeddc5265cb85c6cd229a19f89ca5b738eb2
+SHA512:
+  metadata.gz: dabaddfe7338b0918888b16933b8c110a2bd6a7de9b626e425fab0736b6314d70f3daf48814f4c69d778f6d178f3da2b5e05a626ceec3c37090125f0fc35586e
+  data.tar.gz: 6f6caa567e5e2d34c680e86e8ba08ca60b1d8f0d6cdfcde0314c90b5db86ae39314796fefe938b009d919a97d9f2c25be1b704144660b034a08222be529d1e6b

data/README.md

@@ -0,0 +1,141 @@
+# rubygems-requirements-system
+
+## Summary
+
+This is a RubyGems plugin. This installs system packages that are
+needed by a gem automatically.
+
+This is convenient for both of users and developers.
+
+Users don't need to install gem dependencies separately.
+
+Developers don't need to write documents how to install gem
+dependencies.
+
+## Motivation
+
+Bindings are helpful for developers because developers don't need to
+re-implement existing features. But users need to install not only
+bindings but also dependencies.
+
+There are some approaches to reduce the inconvenience:
+
+1. Installs dependencies automatically
+2. Bundles dependencies (a.k.a. fat gem)
+
+The 1. approach is used by Ruby-GNOME packages such as glib2 gem and
+gtk4 gem.
+
+The 2. approach is used by Nokogiri.
+
+If gems that use the 2. approach are maintained actively, there are
+not much problems. There are several problems otherwise. For example,
+security concerns and new CRuby support.
+
+See also:
+https://slide.rabbit-shocker.org/authors/kou/rubykaigi-takeout-2020/
+
+The 1. approach will reduce maintenance costs. It will help both of
+developers and users. If we can reduce maintenance costs for
+developers, developers can focus on new features and bug fixes than
+releases.
+
+## Usage
+
+Add `rubygems-requirements-system` to your gem's runtime dependencies:
+
+```ruby
+Gem::Specification.new do |spec|
+  # ...
+  spec.add_runtime_dependency("rubygems-requirements-system")
+  # ...
+end
+```
+
+Add dependency information to `Gem::Specification#requirements`:
+
+```ruby
+Gem::Specification.new do |spec|
+  # ...
+
+  # Install GObject. Package ID is pkg-config's package name for now.
+  # We'll add support for other package system's name such as CMake
+  # package's name.
+  # We can specify package names for each platform.
+  spec.requirements << "system: gobject-2.0: alt_linux: glib2-devel"
+  spec.requirements << "system: gobject-2.0: arch_linux: glib2"
+  spec.requirements << "system: gobject-2.0: conda: glib"
+  spec.requirements << "system: gobject-2.0: debian: libglib2.0-dev"
+  spec.requirements << "system: gobject-2.0: gentoo_linux: dev-libs/glib"
+  spec.requirements << "system: gobject-2.0: homebrew: glib"
+  spec.requirements << "system: gobject-2.0: macports: glib2"
+  # We can omit the Red Hat Enterprise Linux family case because
+  # "pkgconfig(gobject-2.0)" can be generated automatically.
+  spec.requirements << "system: gobject-2.0: rhel: pkgconfig(gobject-2.0)"
+
+  # ...
+end
+```
+
+You can require dependency A or B. For example, you can require
+`mysqlclient` or `libmariadb`.
+
+```ruby
+Gem::Specification.new do |spec|
+  # ...
+
+  # We need mysqliclient or libmariadb for this gem.
+  spec.requirements << "system: mysqlclient|libmariadb: arch_linux: mariadb-libs"
+  spec.requirements << "system: mysqlclient|libmariadb: debian: libmysqlclient-dev"
+  spec.requirements << "system: mysqlclient|libmariadb: debian: libmariadb-dev"
+
+  # ...
+end
+```
+
+You can install multiple packages for a dependency.
+
+```ruby
+Gem::Specification.new do |spec|
+  # ...
+
+  # We need to install multiple packages to use cairo with conda.
+  spec.requirements << "system: cairo: conda: cairo"
+  spec.requirements << "system: cairo: conda: expat"
+  spec.requirements << "system: cairo: conda: xorg-kbproto"
+  spec.requirements << "system: cairo: conda: xorg-libxau"
+  spec.requirements << "system: cairo: conda: xorg-libxext"
+  spec.requirements << "system: cairo: conda: xorg-libxrender"
+  spec.requirements << "system: cairo: conda: xorg-renderproto"
+  spec.requirements << "system: cairo: conda: xorg-xextproto"
+  spec.requirements << "system: cairo: conda: xorg-xproto"
+  spec.requirements << "system: cairo: conda: zlib"
+
+  # ...
+end
+```
+
+## Requirements
+
+RubyGems 3.5.0 or later is required. RubyGems can load installed
+plugin immediately since 3.5.0.
+
+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.
+
+## History
+
+This is based on
+[native-package-installer](https://github.com/ruby-gnome/native-package-installer)
+gem. We could add support for RubyGems plugin to
+native-package-installer but we didn't. Because "native" package isn't
+a natural name for a package on the target platform. We want to use
+other word than "native". So we create a new gem.
+
+## License
+
+Copyright (C) 2013-2025  Ruby-GNOME Project Team
+
+LGPL-3 or later. See doc/text/lgpl-3.txt for details.

data/Rakefile

@@ -0,0 +1,35 @@
+# -*- ruby -*-
+#
+# Copyright (C) 2025  Ruby-GNOME Project Team
+#
+# This library 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 "bundler/gem_helper"
+
+base_dir = File.dirname(__FILE__)
+helper = Bundler::GemHelper.new(base_dir)
+def helper.version_tag
+  version
+end
+helper.install
+
+release_task = Rake.application["release"]
+# We use Trusted Publishing.
+release_task.prerequisites.delete("build")
+release_task.prerequisites.delete("release:rubygem_push")
+release_task_comment = release_task.comment
+if release_task_comment
+  release_task.clear_comments
+  release_task.comment = release_task_comment.gsub(/ and build.*$/, "")
+end