From 17ce697586f6a5f4eb27f167b11f28a1b598007e Mon Sep 17 00:00:00 2001 From: Sutou Kouhei Date: Mon, 6 Jan 2025 17:50:07 +0900 Subject: [PATCH] Import --- .github/dependabot.yml | 21 + .github/workflows/release.yml | 62 ++ .github/workflows/test.yml | 93 +++ .gitignore | 17 + Gemfile | 25 + README.md | 141 ++++ Rakefile | 25 + compose.yaml | 172 +++++ doc/text/gpl-3.txt | 674 ++++++++++++++++++ doc/text/lgpl-3.txt | 165 +++++ dockerfiles/almalinux.dockerfile | 42 ++ dockerfiles/alpine-linux.dockerfile | 47 ++ dockerfiles/alt-linux.dockerfile | 38 + dockerfiles/amazon-linux-2.dockerfile | 43 ++ dockerfiles/amazon-linux-2023.dockerfile | 41 ++ dockerfiles/arch-linux.dockerfile | 39 + dockerfiles/conda.dockerfile | 22 + dockerfiles/debian.dockerfile | 40 ++ dockerfiles/fedora.dockerfile | 39 + dockerfiles/gentoo-linux.dockerfile | 33 + dockerfiles/opensuse.dockerfile | 36 + dockerfiles/pld-linux.dockerfile | 36 + dockerfiles/run-test-gentoo-linux.sh | 31 + dockerfiles/run-test.sh | 32 + dockerfiles/ubuntu.dockerfile | 40 ++ .../executable-finder.rb | 87 +++ lib/rubygems-requirements-system/installer.rb | 114 +++ .../os-release.rb | 59 ++ lib/rubygems-requirements-system/package.rb | 17 + lib/rubygems-requirements-system/platform.rb | 72 ++ .../platform/alpine-linux.rb | 44 ++ .../platform/alt-linux.rb | 52 ++ .../platform/amazon-linux-2.rb | 50 ++ .../platform/amazon-linux-2023.rb | 40 ++ .../platform/arch-linux.rb | 43 ++ .../platform/base.rb | 135 ++++ .../platform/conda.rb | 43 ++ .../platform/debian.rb | 67 ++ .../platform/fedora.rb | 44 ++ .../platform/freebsd.rb | 43 ++ .../platform/gentoo-linux.rb | 50 ++ .../platform/homebrew.rb | 43 ++ .../platform/macports.rb | 43 ++ .../platform/pld-linux.rb | 43 ++ .../platform/red-hat-enterprise-linux.rb | 67 ++ .../platform/suse.rb | 51 ++ .../platform/ubuntu.rb | 41 ++ .../platform/unknown.rb | 31 + lib/rubygems-requirements-system/version.rb | 18 + lib/rubygems_plugin.rb | 21 + rubygems-requirements-system.gemspec | 42 ++ test/fixture/dummy-cairo/dummy-cairo.gemspec | 54 ++ .../dummy-cairo/ext/dummy-cairo/extconf.rb | 24 + 53 files changed, 3392 insertions(+) create mode 100644 .github/dependabot.yml create mode 100644 .github/workflows/release.yml create mode 100644 .github/workflows/test.yml create mode 100644 .gitignore create mode 100644 Gemfile create mode 100644 README.md create mode 100644 Rakefile create mode 100644 compose.yaml create mode 100644 doc/text/gpl-3.txt create mode 100644 doc/text/lgpl-3.txt create mode 100644 dockerfiles/almalinux.dockerfile create mode 100644 dockerfiles/alpine-linux.dockerfile create mode 100644 dockerfiles/alt-linux.dockerfile create mode 100644 dockerfiles/amazon-linux-2.dockerfile create mode 100644 dockerfiles/amazon-linux-2023.dockerfile create mode 100644 dockerfiles/arch-linux.dockerfile create mode 100644 dockerfiles/conda.dockerfile create mode 100644 dockerfiles/debian.dockerfile create mode 100644 dockerfiles/fedora.dockerfile create mode 100644 dockerfiles/gentoo-linux.dockerfile create mode 100644 dockerfiles/opensuse.dockerfile create mode 100644 dockerfiles/pld-linux.dockerfile create mode 100755 dockerfiles/run-test-gentoo-linux.sh create mode 100755 dockerfiles/run-test.sh create mode 100644 dockerfiles/ubuntu.dockerfile create mode 100644 lib/rubygems-requirements-system/executable-finder.rb create mode 100644 lib/rubygems-requirements-system/installer.rb create mode 100644 lib/rubygems-requirements-system/os-release.rb create mode 100644 lib/rubygems-requirements-system/package.rb create mode 100644 lib/rubygems-requirements-system/platform.rb create mode 100644 lib/rubygems-requirements-system/platform/alpine-linux.rb create mode 100644 lib/rubygems-requirements-system/platform/alt-linux.rb create mode 100644 lib/rubygems-requirements-system/platform/amazon-linux-2.rb create mode 100644 lib/rubygems-requirements-system/platform/amazon-linux-2023.rb create mode 100644 lib/rubygems-requirements-system/platform/arch-linux.rb create mode 100644 lib/rubygems-requirements-system/platform/base.rb create mode 100644 lib/rubygems-requirements-system/platform/conda.rb create mode 100644 lib/rubygems-requirements-system/platform/debian.rb create mode 100644 lib/rubygems-requirements-system/platform/fedora.rb create mode 100644 lib/rubygems-requirements-system/platform/freebsd.rb create mode 100644 lib/rubygems-requirements-system/platform/gentoo-linux.rb create mode 100644 lib/rubygems-requirements-system/platform/homebrew.rb create mode 100644 lib/rubygems-requirements-system/platform/macports.rb create mode 100644 lib/rubygems-requirements-system/platform/pld-linux.rb create mode 100644 lib/rubygems-requirements-system/platform/red-hat-enterprise-linux.rb create mode 100644 lib/rubygems-requirements-system/platform/suse.rb create mode 100644 lib/rubygems-requirements-system/platform/ubuntu.rb create mode 100644 lib/rubygems-requirements-system/platform/unknown.rb create mode 100644 lib/rubygems-requirements-system/version.rb create mode 100644 lib/rubygems_plugin.rb create mode 100644 rubygems-requirements-system.gemspec create mode 100644 test/fixture/dummy-cairo/dummy-cairo.gemspec create mode 100644 test/fixture/dummy-cairo/ext/dummy-cairo/extconf.rb diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..b648216 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,21 @@ +# 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 . + +version: 2 +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..31b2a5f --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,62 @@ +# 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 . + +name: Release +on: + push: + tags: + - "*" +jobs: + github: + name: GitHub + runs-on: ubuntu-latest + timeout-minutes: 10 + steps: + - uses: actions/checkout@v4 + - name: Extract release note + run: | + ruby \ + -e 'print("## rubygems-requirements-system "); \ + puts(ARGF.read.split(/^## /)[1]. \ + gsub(/ {.+?}/, ""). \ + gsub(/\[(.+?)\]\[.+?\]/) {$1})' \ + doc/text/news.md > release-note.md + - name: Upload to release + run: | + title=$(head -n1 release-note.md | sed -e 's/^## //') + tail -n +2 release-note.md > release-note-without-version.md + gh release create ${GITHUB_REF_NAME} \ + --discussion-category Announcements \ + --notes-file release-note-without-version.md \ + --title "${title}" + env: + GH_TOKEN: ${{ github.token }} + rubygems: + name: RubyGems + runs-on: ubuntu-latest + timeout-minutes: 10 + permissions: + id-token: write + environment: release + steps: + - uses: actions/checkout@v4 + - uses: ruby/setup-ruby@v1 + with: + ruby-version: ruby + bundler-cache: true + - uses: rubygems/configure-rubygems-credentials@v1.0.0 + - name: Push gems + run: | + bundle exec rake release:rubygem_push diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..fe0b39b --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,93 @@ +# 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 . + +name: Test +on: + - push + - pull_request +jobs: + docker: + name: ${{ matrix.distribution }} + strategy: + fail-fast: false + matrix: + distribution: + - almalinux-9 + - alpine-linux + - alt-linux + - amazon-linux-2 + - amazon-linux-2023 + - arch-linux + - conda + - debian-bookworm + - fedora + - gentoo-linux + - opensuse + - pld-linux + - ubuntu-20.04 + - ubuntu-22.04 + - ubuntu-24.04 + runs-on: ubuntu-latest + timeout-minutes: 60 + steps: + - uses: actions/checkout@v4 + - name: Prepare cache for Gentoo Linux + if: | + matrix.distribution == 'gentoo-linux' + run: | + docker pull gentoo/portage + gentoo_portage_id=$(docker image inspect gentoo/portage | jq -r ".[0].Id") + echo "GENTOO_PORTAGE_ID=${gentoo_portage_id}" >> "${GITHUB_ENV}" + - name: Cache binary packages for Gentoo Linux + if: | + matrix.distribution == 'gentoo-linux' + uses: actions/cache@v4 + with: + path: .cache + key: ${{ matrix.distribution }}-${{ env.GENTOO_PORTAGE_ID }} + restore-keys: ${{ matrix.distribution }}- + - name: Build Docker image + run: | + docker compose build ${{ matrix.distribution }} + - name: Run + run: | + docker compose run --rm ${{ matrix.distribution }} + native: + name: ${{ matrix.ruby-version }} on ${{ matrix.runs-on }} + strategy: + fail-fast: false + matrix: + runs-on: + - macos + - ubuntu + ruby-version: + - "3.4" + - "3.3" + - "3.2" + - "3.1" + runs-on: ${{ matrix.runs-on }}-latest + timeout-minutes: 15 + steps: + - uses: actions/checkout@v4 + - uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{ matrix.ruby-version }} + bundler-cache: true + - name: Install + run: bundle exec rake install + - name: Install glib2 gem + run: | + MAKEFLAGS="-j$(ruby -r etc -e 'puts Etc.nprocessors')" \ + gem install glib2 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d8b0c09 --- /dev/null +++ b/.gitignore @@ -0,0 +1,17 @@ +# 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 . + +/.cache/ +/pkg/ diff --git a/Gemfile b/Gemfile new file mode 100644 index 0000000..47dd8c6 --- /dev/null +++ b/Gemfile @@ -0,0 +1,25 @@ +# -*- 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 . + +source "https://rubygems.org/" + +gemspec + +gem "bundler" +gem "rake" + +gem "cairo", path: File.join(__dir__, "rcairo") diff --git a/README.md b/README.md new file mode 100644 index 0000000..d51768f --- /dev/null +++ b/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. diff --git a/Rakefile b/Rakefile new file mode 100644 index 0000000..82ee022 --- /dev/null +++ b/Rakefile @@ -0,0 +1,25 @@ +# -*- 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 . + +require "bundler/gem_helper" + +base_dir = File.dirname(__FILE__) +helper = Bundler::GemHelper.new(base_dir) +def helper.version_tag + version +end +helper.install diff --git a/compose.yaml b/compose.yaml new file mode 100644 index 0000000..5222247 --- /dev/null +++ b/compose.yaml @@ -0,0 +1,172 @@ +# 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 . + +services: + almalinux-9: + build: + context: . + dockerfile: dockerfiles/almalinux.dockerfile + args: + VERSION: "9" + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh + + alpine-linux: + build: + context: . + dockerfile: dockerfiles/alpine-linux.dockerfile + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh + + alt-linux: + build: + context: . + dockerfile: dockerfiles/alt-linux.dockerfile + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh + + amazon-linux-2: + build: + context: . + dockerfile: dockerfiles/amazon-linux-2.dockerfile + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh + + amazon-linux-2023: + build: + context: . + dockerfile: dockerfiles/amazon-linux-2023.dockerfile + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh + + arch-linux: + build: + context: . + dockerfile: dockerfiles/arch-linux.dockerfile + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh + + conda: + build: + context: . + dockerfile: dockerfiles/conda.dockerfile + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh + + debian-bookworm: + build: + context: . + dockerfile: dockerfiles/debian.dockerfile + args: + CODE_NAME: "bookworm" + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh + + fedora: + build: + context: . + dockerfile: dockerfiles/fedora.dockerfile + args: + VERSION: "latest" + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh + + gentoo-linux-portage: + image: gentoo/portage + command: + /bin/true + + gentoo-linux: + build: + context: . + dockerfile: dockerfiles/gentoo-linux.dockerfile + volumes: + - .:/host:delegated + - .cache/gentoo-linux/binpkgs:/var/cache/binpkgs:delegated + volumes_from: + - gentoo-linux-portage + command: + /host/dockerfiles/run-test-gentoo-linux.sh + + opensuse: + build: + context: . + dockerfile: dockerfiles/opensuse.dockerfile + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh + + pld-linux: + build: + context: . + dockerfile: dockerfiles/pld-linux.dockerfile + volumes: + - .:/host:delegated + security_opt: + - seccomp:unconfined + command: + /host/dockerfiles/run-test.sh + + ubuntu-20.04: + build: + context: . + dockerfile: dockerfiles/ubuntu.dockerfile + args: + VERSION: "20.04" + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh + + ubuntu-22.04: + build: + context: . + dockerfile: dockerfiles/ubuntu.dockerfile + args: + VERSION: "22.04" + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh + + ubuntu-24.04: + build: + context: . + dockerfile: dockerfiles/ubuntu.dockerfile + args: + VERSION: "24.04" + volumes: + - .:/host:delegated + command: + /host/dockerfiles/run-test.sh diff --git a/doc/text/gpl-3.txt b/doc/text/gpl-3.txt new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/doc/text/gpl-3.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/doc/text/lgpl-3.txt b/doc/text/lgpl-3.txt new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/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. + 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. diff --git a/dockerfiles/almalinux.dockerfile b/dockerfiles/almalinux.dockerfile new file mode 100644 index 0000000..79dd0d6 --- /dev/null +++ b/dockerfiles/almalinux.dockerfile @@ -0,0 +1,42 @@ +# 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 . + +ARG VERSION +FROM almalinux:${VERSION} + +RUN \ + dnf install -y \ + gcc \ + make \ + redhat-rpm-config \ + ruby-devel \ + sudo \ + which && \ + dnf clean all + +RUN \ + gem install --no-user-install \ + bundler \ + rake + +RUN \ + useradd --user-group --create-home devel + +RUN \ + echo "devel ALL=(ALL:ALL) NOPASSWD:ALL" | \ + EDITOR=tee visudo -f /etc/sudoers.d/devel + +USER devel +WORKDIR /home/devel diff --git a/dockerfiles/alpine-linux.dockerfile b/dockerfiles/alpine-linux.dockerfile new file mode 100644 index 0000000..2c28516 --- /dev/null +++ b/dockerfiles/alpine-linux.dockerfile @@ -0,0 +1,47 @@ +# 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 . + +FROM alpine + +RUN \ + apk update && apk upgrade && \ + apk add \ + bash \ + build-base \ + gcc \ + make \ + ruby \ + ruby-dev \ + openssl \ + openssl-dev \ + zlib \ + zlib-dev \ + sudo \ + which + +RUN \ + gem install --no-user-install \ + bundler \ + rake + +RUN \ + adduser devel -G wheel -D -h /home/devel + +RUN \ + echo "devel ALL=(ALL:ALL) NOPASSWD:ALL" | \ + EDITOR=tee visudo -f /etc/sudoers.d/devel + +USER devel +WORKDIR /home/devel diff --git a/dockerfiles/alt-linux.dockerfile b/dockerfiles/alt-linux.dockerfile new file mode 100644 index 0000000..5a57221 --- /dev/null +++ b/dockerfiles/alt-linux.dockerfile @@ -0,0 +1,38 @@ +# 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 . + +FROM alt + +RUN \ + apt-get update && \ + apt-get install -y \ + gcc \ + libruby-devel \ + libpcre-devel \ + make \ + rake \ + ruby \ + sudo \ + which + +RUN \ + useradd --user-group --groups wheel --create-home devel + +RUN \ + echo "devel ALL=(ALL:ALL) NOPASSWD:ALL" | \ + EDITOR=tee visudo -f /etc/sudoers.d/devel + +USER devel +WORKDIR /home/devel diff --git a/dockerfiles/amazon-linux-2.dockerfile b/dockerfiles/amazon-linux-2.dockerfile new file mode 100644 index 0000000..9d72c78 --- /dev/null +++ b/dockerfiles/amazon-linux-2.dockerfile @@ -0,0 +1,43 @@ +# 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 . + +FROM amazonlinux:2 + +RUN \ + amazon-linux-extras install -y ruby3.0 && \ + yum install -y \ + gcc \ + make \ + redhat-rpm-config \ + ruby-devel \ + shadow-utils \ + sudo \ + which && \ + yum clean all + +RUN \ + gem install --no-user-install \ + bundler \ + rake + +RUN \ + useradd --user-group --create-home devel + +RUN \ + echo "devel ALL=(ALL:ALL) NOPASSWD:ALL" | \ + EDITOR=tee visudo -f /etc/sudoers.d/devel + +USER devel +WORKDIR /home/devel diff --git a/dockerfiles/amazon-linux-2023.dockerfile b/dockerfiles/amazon-linux-2023.dockerfile new file mode 100644 index 0000000..6331961 --- /dev/null +++ b/dockerfiles/amazon-linux-2023.dockerfile @@ -0,0 +1,41 @@ +# 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 . + +FROM amazonlinux:2023 + +RUN \ + dnf install -y \ + gcc \ + make \ + ruby-devel \ + shadow-utils \ + sudo \ + which && \ + dnf clean all + +RUN \ + gem install --no-user-install \ + bundler \ + rake + +RUN \ + useradd --user-group --create-home devel + +RUN \ + echo "devel ALL=(ALL:ALL) NOPASSWD:ALL" | \ + EDITOR=tee visudo -f /etc/sudoers.d/devel + +USER devel +WORKDIR /home/devel diff --git a/dockerfiles/arch-linux.dockerfile b/dockerfiles/arch-linux.dockerfile new file mode 100644 index 0000000..ebb770b --- /dev/null +++ b/dockerfiles/arch-linux.dockerfile @@ -0,0 +1,39 @@ +# 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 . + +FROM archlinux + +RUN \ + pacman --sync --noconfirm --refresh --sysupgrade && \ + pacman --sync --noconfirm \ + gcc \ + make \ + ruby \ + sudo \ + which + +RUN \ + gem install --no-user-install bundler rake + + +RUN \ + useradd --user-group --create-home devel + +RUN \ + echo "devel ALL=(ALL:ALL) NOPASSWD:ALL" | \ + EDITOR=tee visudo -f /etc/sudoers.d/devel + +USER devel +WORKDIR /home/devel diff --git a/dockerfiles/conda.dockerfile b/dockerfiles/conda.dockerfile new file mode 100644 index 0000000..e825f18 --- /dev/null +++ b/dockerfiles/conda.dockerfile @@ -0,0 +1,22 @@ +# 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 . + +FROM continuumio/miniconda3 + +RUN \ + conda install -c conda-forge -y --quiet \ + compilers \ + make \ + ruby diff --git a/dockerfiles/debian.dockerfile b/dockerfiles/debian.dockerfile new file mode 100644 index 0000000..1a26595 --- /dev/null +++ b/dockerfiles/debian.dockerfile @@ -0,0 +1,40 @@ +# 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 . + +ARG CODE_NAME +FROM debian:${CODE_NAME} + +RUN \ + echo "debconf debconf/frontend select Noninteractive" | \ + debconf-set-selections + +RUN \ + apt-get update && \ + apt-get install -y \ + gcc \ + make \ + ruby-bundler \ + ruby-dev \ + sudo + +RUN \ + useradd --user-group --create-home devel + +RUN \ + echo "devel ALL=(ALL:ALL) NOPASSWD:ALL" | \ + EDITOR=tee visudo -f /etc/sudoers.d/devel + +USER devel +WORKDIR /home/devel diff --git a/dockerfiles/fedora.dockerfile b/dockerfiles/fedora.dockerfile new file mode 100644 index 0000000..fe61669 --- /dev/null +++ b/dockerfiles/fedora.dockerfile @@ -0,0 +1,39 @@ +# 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 . + +ARG VERSION +FROM fedora:${VERSION} + +RUN \ + dnf install -y \ + gcc \ + make \ + redhat-rpm-config \ + ruby-devel \ + rubygem-bundler \ + rubygem-rake \ + sudo \ + which && \ + dnf clean all + +RUN \ + useradd --user-group --create-home native-package-installer + +RUN \ + echo "native-package-installer ALL=(ALL:ALL) NOPASSWD:ALL" | \ + EDITOR=tee visudo -f /etc/sudoers.d/native-package-installer + +USER native-package-installer +WORKDIR /home/native-package-installer diff --git a/dockerfiles/gentoo-linux.dockerfile b/dockerfiles/gentoo-linux.dockerfile new file mode 100644 index 0000000..65ab4bb --- /dev/null +++ b/dockerfiles/gentoo-linux.dockerfile @@ -0,0 +1,33 @@ +# 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 . + +FROM gentoo/stage3 + +RUN \ + ( \ + echo "BINPKG_FORMAT=\"gpkg\""; \ + echo "FEATURES=\"buildpkg\""; \ + echo "MAKEOPTS=\"-j$(($(nproc) +1))\""; \ + ) >> /etc/portage/make.conf + +RUN \ + useradd --user-group --create-home devel + +# RUN \ +# echo "devel ALL=(ALL:ALL) NOPASSWD:ALL" | \ +# EDITOR=tee visudo -f /etc/sudoers.d/devel + +# USER devel +# WORKDIR /home/devel diff --git a/dockerfiles/opensuse.dockerfile b/dockerfiles/opensuse.dockerfile new file mode 100644 index 0000000..81edb18 --- /dev/null +++ b/dockerfiles/opensuse.dockerfile @@ -0,0 +1,36 @@ +# 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 . + +FROM opensuse/leap + +RUN \ + zypper --non-interactive install \ + gcc \ + make \ + ruby2.5-devel \ + ruby2.5-rubygem-bundler \ + ruby2.5-rubygem-rake \ + sudo \ + which + +RUN \ + useradd --user-group --create-home devel + +RUN \ + echo "devel ALL=(ALL:ALL) NOPASSWD:ALL" | \ + EDITOR=tee visudo -f /etc/sudoers.d/devel + +USER devel +WORKDIR /home/devel diff --git a/dockerfiles/pld-linux.dockerfile b/dockerfiles/pld-linux.dockerfile new file mode 100644 index 0000000..8026459 --- /dev/null +++ b/dockerfiles/pld-linux.dockerfile @@ -0,0 +1,36 @@ +# 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 . + +FROM registry.gitlab.com/pld-linux/pld + +RUN \ + poldek --noask --update --upgrade \ + gcc \ + make \ + ruby \ + ruby-bundler \ + ruby-rake \ + sudo \ + which + +RUN \ + adduser -S devel + +RUN \ + echo "devel ALL=(ALL:ALL) NOPASSWD:ALL" | \ + EDITOR=tee visudo -f /etc/sudoers.d/devel + +USER devel +WORKDIR /home/devel diff --git a/dockerfiles/run-test-gentoo-linux.sh b/dockerfiles/run-test-gentoo-linux.sh new file mode 100755 index 0000000..e4aaca2 --- /dev/null +++ b/dockerfiles/run-test-gentoo-linux.sh @@ -0,0 +1,31 @@ +#!/bin/bash +# +# 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 . + +set -eux + +emerge \ + --usepkg \ + app-admin/sudo \ + dev-lang/ruby + +mkdir -p /etc/sudoers.d +echo "devel ALL=(ALL:ALL) NOPASSWD:ALL" | \ + EDITOR=tee visudo -f /etc/sudoers.d/devel + +cd ~devel +sudo -u devel -H \ + $(dirname $0)/run-test.sh --no-user-install "$@" diff --git a/dockerfiles/run-test.sh b/dockerfiles/run-test.sh new file mode 100755 index 0000000..88a48b9 --- /dev/null +++ b/dockerfiles/run-test.sh @@ -0,0 +1,32 @@ +#!/bin/bash -l +# +# 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 . + +set -eux + +rm -rf build +cp -r /host build +cd build + +if sudo which rake; then + sudo rake install +else + rake install +fi + +cd test/fixture/dummy-cairo +gem build *.gemspec +gem install --user-install ./*.gem "$@" diff --git a/dockerfiles/ubuntu.dockerfile b/dockerfiles/ubuntu.dockerfile new file mode 100644 index 0000000..29d4381 --- /dev/null +++ b/dockerfiles/ubuntu.dockerfile @@ -0,0 +1,40 @@ +# 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 . + +ARG VERSION +FROM ubuntu:${VERSION} + +RUN \ + echo "debconf debconf/frontend select Noninteractive" | \ + debconf-set-selections + +RUN \ + apt-get update && \ + apt-get install -y \ + gcc \ + make \ + ruby-bundler \ + ruby-dev \ + sudo + +RUN \ + useradd --user-group --create-home devel + +RUN \ + echo "devel ALL=(ALL:ALL) NOPASSWD:ALL" | \ + EDITOR=tee visudo -f /etc/sudoers.d/devel + +USER devel +WORKDIR /home/devel diff --git a/lib/rubygems-requirements-system/executable-finder.rb b/lib/rubygems-requirements-system/executable-finder.rb new file mode 100644 index 0000000..5113d72 --- /dev/null +++ b/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 . + +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 diff --git a/lib/rubygems-requirements-system/installer.rb b/lib/rubygems-requirements-system/installer.rb new file mode 100644 index 0000000..1e8802d --- /dev/null +++ b/lib/rubygems-requirements-system/installer.rb @@ -0,0 +1,114 @@ +# 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 . + +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) + 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? + + next unless @platform.target?(platform) + requirements[packages] ||= [] + requirements[packages] << system_package + 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 diff --git a/lib/rubygems-requirements-system/os-release.rb b/lib/rubygems-requirements-system/os-release.rb new file mode 100644 index 0000000..5a46647 --- /dev/null +++ b/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 . + +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 diff --git a/lib/rubygems-requirements-system/package.rb b/lib/rubygems-requirements-system/package.rb new file mode 100644 index 0000000..ca61ea0 --- /dev/null +++ b/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 . + +module RubyGemsRequirementsSystem +end diff --git a/lib/rubygems-requirements-system/platform.rb b/lib/rubygems-requirements-system/platform.rb new file mode 100644 index 0000000..cf89436 --- /dev/null +++ b/lib/rubygems-requirements-system/platform.rb @@ -0,0 +1,72 @@ +# 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 . + +module RubyGemsRequirementsSystem + module Platform + PLATFORM_CLASSES = [] + + class << self + def register(platform_class) + PLATFORM_CLASSES << platform_class + end + + def detect + PLATFORM_CLASSES.reverse_each do |platform_class| + return platform_class.new if platform_class.current_platform? + end + Unknown.new + end + end + end +end + +require_relative "platform/base" + +# macOS +require_relative "platform/macports" + + +# FreeBSD +require_relative "platform/freebsd" + + +# Linux +require_relative "platform/arch-linux" +require_relative "platform/gentoo-linux" + +require_relative "platform/debian" +require_relative "platform/ubuntu" +require_relative "platform/alt-linux" + +require_relative "platform/pld-linux" + +require_relative "platform/fedora" +require_relative "platform/red-hat-enterprise-linux" +require_relative "platform/amazon-linux-2" +require_relative "platform/amazon-linux-2023" + +require_relative "platform/suse" + +require_relative "platform/alpine-linux" + + +# Platform independent +require_relative "platform/homebrew" +require_relative "platform/conda" +# TODO: Conan +# TODO: vcpkg + +# Fallback +require_relative "platform/unknown" diff --git a/lib/rubygems-requirements-system/platform/alpine-linux.rb b/lib/rubygems-requirements-system/platform/alpine-linux.rb new file mode 100644 index 0000000..5b79150 --- /dev/null +++ b/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 . + +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 diff --git a/lib/rubygems-requirements-system/platform/alt-linux.rb b/lib/rubygems-requirements-system/platform/alt-linux.rb new file mode 100644 index 0000000..f609eac --- /dev/null +++ b/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 . + +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 diff --git a/lib/rubygems-requirements-system/platform/amazon-linux-2.rb b/lib/rubygems-requirements-system/platform/amazon-linux-2.rb new file mode 100644 index 0000000..708a899 --- /dev/null +++ b/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 . + +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 diff --git a/lib/rubygems-requirements-system/platform/amazon-linux-2023.rb b/lib/rubygems-requirements-system/platform/amazon-linux-2023.rb new file mode 100644 index 0000000..f9e0186 --- /dev/null +++ b/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 . + +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 diff --git a/lib/rubygems-requirements-system/platform/arch-linux.rb b/lib/rubygems-requirements-system/platform/arch-linux.rb new file mode 100644 index 0000000..8f19515 --- /dev/null +++ b/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 . + +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 diff --git a/lib/rubygems-requirements-system/platform/base.rb b/lib/rubygems-requirements-system/platform/base.rb new file mode 100644 index 0000000..4027caf --- /dev/null +++ b/lib/rubygems-requirements-system/platform/base.rb @@ -0,0 +1,135 @@ +# 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 . + +require "fileutils" + +require_relative "../executable-finder" +require_relative "../os-release" + +module RubyGemsRequirementsSystem + module Platform + class Base + include Gem::UserInteraction + + def target?(platform) + raise NotImpelementedError + end + + def install(requirement) + synchronize do + target_packages(requirement).any? do |package| + install_package(package) and requirement.satisfied? + end + end + end + + private + def sudo + if have_priviledge? + nil + else + @sudo ||= ExecutableFinder.find("sudo") + end + end + + def synchronize + if Gem.respond_to?(:state_home) + state_home = Gem.state_home + else + state_home = + ENV["XDG_STATE_HOME"] || + File.join(Gem.user_home, ".local", "state") + end + lock_file_path = File.join(state_home, + "gem", + "requirements_system_lock") + FileUtils.mkdir_p(File.dirname(lock_file_path)) + File.open(lock_file_path, "w") do |lock_file| + lock_file.flock(File::LOCK_EX) + yield + end + end + + def super_user? + Process.uid.zero? + end + + def need_super_user_priviledge? + raise NotImpelementedError + end + + def have_priviledge? + return true unless need_super_user_priviledge? + super_user? + end + + def target_packages(requirement) + requirement.system_packages + end + + def install_package(package) + command_line = prepare_command_line(package) + if command_line + unless run_command_line(package, "prepare", command_line) + return false + end + end + run_command_line(package, "install", install_command_line(package)) + end + + def run_command_line(package, action, command_line) + failed_to_get_super_user_priviledge = false + command_line = install_command_line(package) + if have_priviledge? + succeeded = system(*command_line) + else + if sudo + prompt = "[sudo] password for %u to #{action} <#{package}>: " + command_line = [sudo, "-p", prompt, *command_line] + succeeded = system(*command_line) + else + succeeded = false + failed_to_get_super_user_priviledge = true + end + end + if failed_to_get_super_user_priviledge + result_message = "require super user privilege" + else + result_message = succeeded ? "succeeded" : "failed" + end + say("#{action.capitalize} '#{package}' system package: #{result_message}") + + unless succeeded + escaped_command_line = command_line.collect do |part| + Shellwords.escape(part) + end + alert_warning("'#{package}' system package is required.") + alert_warning("Run the following command " + + "to #{action} required system package: " + + escaped_install_command.join(" ")) + end + succeeded + end + + def prepare_command_line(package) + nil + end + + def install_command_line(package) + raise NotImpelementedError + end + end + end +end diff --git a/lib/rubygems-requirements-system/platform/conda.rb b/lib/rubygems-requirements-system/platform/conda.rb new file mode 100644 index 0000000..3736a60 --- /dev/null +++ b/lib/rubygems-requirements-system/platform/conda.rb @@ -0,0 +1,43 @@ +# 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 . + +require_relative "base" + +module RubyGemsRequirementsSystem + module Platform + class Conda < Base + Platform.register(self) + + class << self + def current_platform? + ENV["CONDA_PREFIX"] && ExecutableFinder.exist?("conda") + end + end + + def target?(platform) + platform == "conda" + end + + private + def install_command_line(package) + ["conda", "install", "-c", "conda-forge", "-y", package] + end + + def need_super_user_priviledge? + false + end + end + end +end diff --git a/lib/rubygems-requirements-system/platform/debian.rb b/lib/rubygems-requirements-system/platform/debian.rb new file mode 100644 index 0000000..0faafde --- /dev/null +++ b/lib/rubygems-requirements-system/platform/debian.rb @@ -0,0 +1,67 @@ +# 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 . + +require_relative "base" + +module RubyGemsRequirementsSystem + module Platform + class Debian < Base + Platform.register(self) + + class << self + def current_platform? + os_release = OSRelease.new + case os_release.id + when "debian", "raspbian" + return true + else + return true if os_release.id_like.include?("debian") + end + false + end + end + + def target?(platform) + case platform + when "debian", "raspbian" + true + else + false + end + end + + private + def prepare_command_line(package) + ["apt-get", "update"] + end + + 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 diff --git a/lib/rubygems-requirements-system/platform/fedora.rb b/lib/rubygems-requirements-system/platform/fedora.rb new file mode 100644 index 0000000..b1bbf6f --- /dev/null +++ b/lib/rubygems-requirements-system/platform/fedora.rb @@ -0,0 +1,44 @@ +# 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 . + +require_relative "red-hat-enterprise-linux" + +module RubyGemsRequirementsSystem + module Platform + class Fedora < RedHatEnterpriseLinux + Platform.register(self) + + class << self + def current_platform? + os_release = OSRelease.new + os_release.id == "fedora" or os_release.id_like.include?("fedora") + end + end + + def target?(platform) + platform == "fedora" || super + end + + private + def install_command_line(package) + ["dnf", "install", "-y", package] + end + + def need_super_user_priviledge? + true + end + end + end +end diff --git a/lib/rubygems-requirements-system/platform/freebsd.rb b/lib/rubygems-requirements-system/platform/freebsd.rb new file mode 100644 index 0000000..ab0c36f --- /dev/null +++ b/lib/rubygems-requirements-system/platform/freebsd.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 . + +require_relative "base" + +module RubyGemsRequirementsSystem + module Platform + class FreeBSD < Base + Platform.register(self) + + class << self + def current_platform? + ExecutableFinder.exist?("pkg") + end + end + + def target?(platform) + platform == "freebsd" + end + + private + def install_command_line(package) + ["pkg", "install", "-y", package] + end + + def need_super_user_priviledge? + true + end + end + end +end diff --git a/lib/rubygems-requirements-system/platform/gentoo-linux.rb b/lib/rubygems-requirements-system/platform/gentoo-linux.rb new file mode 100644 index 0000000..1343e30 --- /dev/null +++ b/lib/rubygems-requirements-system/platform/gentoo-linux.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 . + +require_relative "base" + +module RubyGemsRequirementsSystem + module Platform + class GentooLinux < Base + Platform.register(self) + + class << self + def current_platform? + os_release = OSRelease.new + case os_release.id + when "gentoo" + return true + else + return true if os_release.id_like.include?("gentoo") + end + false + end + end + + def target?(platform) + platform == "gentoo_linux" + end + + private + def install_command_line(package) + ["emerge", "--getbinpkg", "--usepkg", package] + end + + def need_super_user_priviledge? + true + end + end + end +end diff --git a/lib/rubygems-requirements-system/platform/homebrew.rb b/lib/rubygems-requirements-system/platform/homebrew.rb new file mode 100644 index 0000000..f873825 --- /dev/null +++ b/lib/rubygems-requirements-system/platform/homebrew.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 . + +require_relative "base" + +module RubyGemsRequirementsSystem + module Platform + class Homebrew < Base + Platform.register(self) + + class << self + def current_platform? + ExecutableFinder.exist?("brew") + end + end + + def target?(platform) + platform == "homebrew" + end + + private + def install_command_line(package) + ["brew", "install", package] + end + + def need_super_user_priviledge? + false + end + end + end +end diff --git a/lib/rubygems-requirements-system/platform/macports.rb b/lib/rubygems-requirements-system/platform/macports.rb new file mode 100644 index 0000000..0d6b9f1 --- /dev/null +++ b/lib/rubygems-requirements-system/platform/macports.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 . + +require_relative "base" + +module RubyGemsRequirementsSystem + module Platform + class MacPorts < Base + Platform.register(self) + + class << self + def current_platform? + ExecutableFinder.exist?("port") + end + end + + def target?(platform) + platform == "macports" + end + + private + def install_command_line(package) + ["port", "install", "-y", package] + end + + def need_super_user_priviledge? + true + end + end + end +end diff --git a/lib/rubygems-requirements-system/platform/pld-linux.rb b/lib/rubygems-requirements-system/platform/pld-linux.rb new file mode 100644 index 0000000..5072704 --- /dev/null +++ b/lib/rubygems-requirements-system/platform/pld-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 . + +require_relative "base" + +module RubyGemsRequirementsSystem + module Platform + class PLDLinux < Base + Platform.register(self) + + class << self + def current_platform? + ExecutableFinder.exist?("poldek") + end + end + + def target?(platform) + platform == "pld_linux" + end + + private + def install_command_line(package) + ["poldek", "--up", "-u", package] + end + + def need_super_user_priviledge? + true + end + end + end +end diff --git a/lib/rubygems-requirements-system/platform/red-hat-enterprise-linux.rb b/lib/rubygems-requirements-system/platform/red-hat-enterprise-linux.rb new file mode 100644 index 0000000..d656bd0 --- /dev/null +++ b/lib/rubygems-requirements-system/platform/red-hat-enterprise-linux.rb @@ -0,0 +1,67 @@ +# 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 . + +require_relative "base" + +module RubyGemsRequirementsSystem + module Platform + class RedHatEnterpriseLinux < Base + Platform.register(self) + + class << self + def current_platform? + os_release = OSRelease.new + os_release.id_like.include?("rhel") + end + end + + def target?(platform) + case platform + when "rhel" + true + when "redhat" # For backward compatibility + true + else + false + end + end + + private + def target_packages(requirement) + super + + requirement.packages.collect {|package| "pkgconfig(#{package.id})"} + end + + def install_command_line(package) + if major_version >= 9 + ["dnf", "install", "--enablerepo=crb", "-y", package] + elsif major_version >= 8 + ["dnf", "install", "--enablerepo=powertools", "-y", package] + else + ["yum", "install", "-y", package] + end + end + + def need_super_user_priviledge? + true + end + + def major_version + major_version_string = File.read("/etc/redhat-release")[/(\d+)/, 0] + Integer(major_version_string, 10) + end + end + end +end diff --git a/lib/rubygems-requirements-system/platform/suse.rb b/lib/rubygems-requirements-system/platform/suse.rb new file mode 100644 index 0000000..1127162 --- /dev/null +++ b/lib/rubygems-requirements-system/platform/suse.rb @@ -0,0 +1,51 @@ +# 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 . + +require_relative "base" + +module RubyGemsRequirementsSystem + module Platform + class SUSE < Base + Platform.register(self) + + class << self + def current_platform? + os_release = OSRelease.new + os_release.id_like.include?("suse") + end + end + + def target?(platform) + case platform + when "suse" + true + when "fedora", "rhel", "redhat" + true # Most packages have the same name with Fedora/RHEL's one + else + false + end + end + + private + def install_command_line(package) + ["zypper", "--non-interactive", "install", package] + end + + def need_super_user_priviledge? + true + end + end + end +end diff --git a/lib/rubygems-requirements-system/platform/ubuntu.rb b/lib/rubygems-requirements-system/platform/ubuntu.rb new file mode 100644 index 0000000..15e394a --- /dev/null +++ b/lib/rubygems-requirements-system/platform/ubuntu.rb @@ -0,0 +1,41 @@ +# 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 . + +require_relative "debian" + +module RubyGemsRequirementsSystem + module Platform + class Ubuntu < Debian + Platform.register(self) + + class << self + def current_platform? + os_release = OSRelease.new + case os_release.id + when "ubuntu" + return true + else + return true if os_release.id_like.include?("ubuntu") + end + false + end + end + + def target?(platform) + platform == "ubuntu" || super + end + end + end +end diff --git a/lib/rubygems-requirements-system/platform/unknown.rb b/lib/rubygems-requirements-system/platform/unknown.rb new file mode 100644 index 0000000..baa503a --- /dev/null +++ b/lib/rubygems-requirements-system/platform/unknown.rb @@ -0,0 +1,31 @@ +# 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 . + +require_relative "base" + +module RubyGemsRequirementsSystem + module Platform + class Unknown < Base + def target?(platform) + false + end + + private + def need_super_user_priviledge? + false + end + end + end +end diff --git a/lib/rubygems-requirements-system/version.rb b/lib/rubygems-requirements-system/version.rb new file mode 100644 index 0000000..4fab162 --- /dev/null +++ b/lib/rubygems-requirements-system/version.rb @@ -0,0 +1,18 @@ +# 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 . + +module RubyGemsRequirementsSystem + VERSION = "1.0.0" +end diff --git a/lib/rubygems_plugin.rb b/lib/rubygems_plugin.rb new file mode 100644 index 0000000..30fd33b --- /dev/null +++ b/lib/rubygems_plugin.rb @@ -0,0 +1,21 @@ +# 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 . + +require_relative "rubygems-requirements-system/installer" + +Gem.pre_install do |installer| + installer = RubyGemsRequirementsSystem::Installer.new(installer.spec) + installer.install +end diff --git a/rubygems-requirements-system.gemspec b/rubygems-requirements-system.gemspec new file mode 100644 index 0000000..1194d91 --- /dev/null +++ b/rubygems-requirements-system.gemspec @@ -0,0 +1,42 @@ +# 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 . + +require_relative "lib/rubygems-requirements-system/version" + +Gem::Specification.new do |spec| + spec.name = "rubygems-requirements-system" + spec.version = RubyGemsRequirementsSystem::VERSION + spec.authors = ["Sutou Kouhei"] + spec.email = ["kou@clear-code.com"] + spec.summary = "Users can install system packages automatically on \"gem install\"" + spec.description = <<-DESCRIPTION.strip +Users need to install system packages to install an extension library +that depends on system packages. It bothers users because users need to +install system packages and an extension library separately. + +rubygems-requirements-system helps to install system packages on "gem install". +Users can install both system packages and an extension library by one action, +"gem install". + DESCRIPTION + spec.homepage = "https://github.com/ruby-gnome/rubygems-requirements-system" + spec.licenses = ["LGPL-3.0+"] + spec.require_paths = ["lib"] + + spec.files = ["README.md", "Rakefile"] + spec.files += Dir.glob("lib/**/*.rb") + spec.files += Dir.glob("doc/text/**/*.*") + + spec.add_runtime_dependency("pkg-config") +end diff --git a/test/fixture/dummy-cairo/dummy-cairo.gemspec b/test/fixture/dummy-cairo/dummy-cairo.gemspec new file mode 100644 index 0000000..67b2d0d --- /dev/null +++ b/test/fixture/dummy-cairo/dummy-cairo.gemspec @@ -0,0 +1,54 @@ +# -*- 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 . + +Gem::Specification.new do |spec| + spec.name = "dummy-cairo" + spec.version = "1.0.0" + spec.authors = ["Sutou Kouhei"] + spec.email = ["kou@cozmixng.org"] + spec.licenses = ["LGPL-3.0+"] + spec.summary = "Dummy gem that uses cairo" + spec.description = "This is for testing rubygems-requirements-system" + spec.extensions = ["ext/dummy-cairo/extconf.rb"] + spec.files = ["ext/dummy-cairo/extconf.rb"] + + spec.add_runtime_dependency("rubygems-requirements-system") + + spec.requirements << "system: cairo >= 1.2.0: alpine_linux: cairo-dev" + spec.requirements << "system: cairo >= 1.2.0: alt_linux: bzlib-devel" + spec.requirements << "system: cairo >= 1.2.0: alt_linux: libXdmcp-devel" + spec.requirements << "system: cairo >= 1.2.0: alt_linux: libbrotli-devel" + spec.requirements << "system: cairo >= 1.2.0: alt_linux: libcairo-devel" + spec.requirements << "system: cairo >= 1.2.0: alt_linux: libexpat-devel" + spec.requirements << "system: cairo >= 1.2.0: alt_linux: libpixman-devel" + spec.requirements << "system: cairo >= 1.2.0: arch_linux: cairo" + spec.requirements << "system: cairo >= 1.2.0: conda: cairo" + spec.requirements << "system: cairo >= 1.2.0: conda: expat" + spec.requirements << "system: cairo >= 1.2.0: conda: xorg-kbproto" + spec.requirements << "system: cairo >= 1.2.0: conda: xorg-libxau" + spec.requirements << "system: cairo >= 1.2.0: conda: xorg-libxext" + spec.requirements << "system: cairo >= 1.2.0: conda: xorg-libxrender" + spec.requirements << "system: cairo >= 1.2.0: conda: xorg-renderproto" + spec.requirements << "system: cairo >= 1.2.0: conda: xorg-xextproto" + spec.requirements << "system: cairo >= 1.2.0: conda: xorg-xproto" + spec.requirements << "system: cairo >= 1.2.0: conda: zlib" + spec.requirements << "system: cairo >= 1.2.0: debian: libcairo2-dev" + spec.requirements << "system: cairo >= 1.2.0: gentoo_linux: cairo" + spec.requirements << "system: cairo >= 1.2.0: homebrew: cairo" + spec.requirements << "system: cairo >= 1.2.0: macports: cairo" + spec.requirements << "system: cairo >= 1.2.0: rhel: cairo-devel" +end diff --git a/test/fixture/dummy-cairo/ext/dummy-cairo/extconf.rb b/test/fixture/dummy-cairo/ext/dummy-cairo/extconf.rb new file mode 100644 index 0000000..65d3686 --- /dev/null +++ b/test/fixture/dummy-cairo/ext/dummy-cairo/extconf.rb @@ -0,0 +1,24 @@ +# 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 . + +require "mkmf" + +require "pkg-config" + +unless PKGConfig.have_package("cairo") + exit(false) +end + +create_makefile("dummy_cairo")