{{admon/tip|Suggestions by Ruby SIG|Comments marked as this one are notes to FPC changes from Ruby SIG.}}

{{admon/tip|Suggestions by Ruby SIG|Comments marked as this one are notes to FPC changes from Ruby SIG.}}

−

{{admon/warning|Different guidelines for older Fedora and RHEL| In RHEL 4, 5, and 6 and Fedora before Fedora 16, a ruby version that does not have all the features needed to support these guidelines exists. If you're packaging for those distributions you should follow the [[Packaging:Old_Ruby | old ruby guidelines]] instead.}}

+

{{admon/warning|Different guidelines for packages in RHEL and Fedora 16| In RHEL 5 and 6, a ruby version that does not have all the features needed to support these guidelines exists. If you're packaging for those distributions you should follow the [[Packaging:Old_Ruby | old ruby guidelines]] instead.}}

+

+

{{admon/warning|Different Guidelines for Fedora 17 and 18| In Fedora 17 and 18 the ruby guidelines were slightly different. Some of the macros and practices listed here did not work. Please see this [[https://fedoraproject.org/w/index.php?title=Packaging:Ruby&oldid=306009 earlier version of the guidelines]] if you want your package to work on those versions of Fedora}}

{{admon/note|JRuby Gems| Although Fedora 19 has fully functioning JRuby integrated with system RubyGems, we have decided to not include the JRuby specific packaging guidelines here, as they need some more work. They will appear here as soon as we feel that we've got everything covered properly. You can contact us on [https://lists.fedoraproject.org/mailman/listinfo/ruby-sig Ruby-SIG mailing list] in case of any questions about the prepared JRuby packaging guidelines.}}

{{admon/note|JRuby Gems| Although Fedora 19 has fully functioning JRuby integrated with system RubyGems, we have decided to not include the JRuby specific packaging guidelines here, as they need some more work. They will appear here as soon as we feel that we've got everything covered properly. You can contact us on [https://lists.fedoraproject.org/mailman/listinfo/ruby-sig Ruby-SIG mailing list] in case of any questions about the prepared JRuby packaging guidelines.}}

Line 19:

Line 21:

Requires: ruby(release) >= 1.9.1

Requires: ruby(release) >= 1.9.1

</pre>

</pre>

−

{{admon/note|Alternate interpreters| Alternate Ruby interpreters (currently JRuby) also <code>Provide: ruby(release)</code>. This implies, that pure RubyGems packages (these are shared among interpreters) '''must not''' have <code>Requires: ruby</code> or <code>Requires: jruby</code> to have their dependencies satisfied by any of these interpreters.}}

+

{{admon/note|Alternate interpreters| Alternate Ruby interpreters (currently JRuby) also <code>Provide: ruby(release)</code>. This implies, that pure RubyGems packages (these are shared among interpreters) '''should not''' have <code>Requires: ruby</code> or <code>Requires: jruby</code> to have their dependencies satisfied by any of these interpreters.}}

+

+

{{admon/warning|Over specified ruby(release) versioning| Please note, that if the <code>ruby(release)</code> version requirement is too specific, it may cause an unexpected interpreter to be drawn in. E.g. <code>ruby(release) &#61; 1.8</code> will require JRuby package, since it is the only package that provides it.}}

+

+

{{Anchor|interpreters_compatibility}}

+

+

=== Different Interpreters Compatibility ===

+

Most of the pure Ruby packages will work on all Ruby interpreters. There are however cases, when the packages use interpreter-specific functions (like <code>fork()</code>) and won't run on other interpreters (JRuby). In this case, the package '''should''' require that interpreter. For example, a package that uses <code>fork</code> should explicitly specify <code>Requires: ruby</code>.

+

In case of such package, packager '''should''' file a bug to ask upstream to provide support for other interpreter(s). This '''should''' be documented in specfile.

+

+

=== Shebang lines ===

+

+

On Fedora, <code>/usr/bin/ruby</code> is implemented via [https://github.com/bkabrda/rubypick Rubypick]. Rubypick is a tool similar to RVM or rbenv. It allows choosing interpreter to execute Ruby script. Rubypick routes anything executed via <code>/usr/bin/ruby</code> to <code>/usr/bin/ruby-mri</code> or <code>/usr/bin/jruby</code>. By default, it runs MRI (Matz's Ruby Implementation), but user can explicitly specify the interpreter by using <code>_mri_</code> or <code>_jruby_</code> as a first parameter. For example:

+

+

<pre>

+

ruby _jruby_ jruby_script.rb

+

gem _mri_ install foo

+

rails _jruby_ s

+

</pre>

+

+

Using the <code>RUBYPICK</code> environment variable can achieve the same results. The environment variable can be used to set one interpreter as the global default:

+

+

<pre>

+

export RUBYPICK=_jruby_

+

ruby jruby_script.rb # Will use jruby

+

gem install foo # Will also use jruby

+

</pre>

−

{{admon/note|Over specified ruby(release) versioning| Please note, that if the <code>ruby(release)</code> version requirement is too specific, it may cause an unexpected interpreter to be drawn in. E.g. <code>ruby(release) &#61; 1.8</code> will require JRuby package, since it is the only package that provides it.}}

+

Ruby executables that are known to only run on one Ruby implementation '''should''' use that specific implementation in their shebang - <code>#!/usr/bin/ruby-mri</code> or <code>#!/usr/bin/jruby</code> to ensure that they run using that implementation. All other code '''should''' use <code>#!/usr/bin/ruby</code>.

{{Anchor|ruby_naming}}

{{Anchor|ruby_naming}}

Line 93:

Line 121:

=== Interpreter independence and directory macros ===

=== Interpreter independence and directory macros ===

−

You may have noticed that the table above has different directories for non-gem libraries on different ruby interpreters but only a single set of directories for rubygem libraries. This is because code written for one ruby interpreter will often run on all ruby interpreters that Fedora ships (ruby, jruby, etc). However, some code uses methods that are not available on all interpreters (for instance, <code>fork</code>). Rubygems have a facility to ship different versions of the code in the same gem so that the gem can run on all versions of the interpreter so we only need to have one common directory for rubygems that all the interpreters can use.

+

You may have noticed that the table above has different directories for non-gem libraries on different ruby interpreters but only a single set of directories for rubygem libraries. This is because code written for one ruby interpreter will often run on all ruby interpreters that Fedora ships (ruby, jruby, etc). However, some code uses methods that are not available on all interpreters (see [[#interpreter_compatibility|Different Interpreters Compatibility]]). Rubygems have a facility to ship different versions of the code in the same gem so that the gem can run on all versions of the interpreter so we only need to have one common directory for rubygems that all the interpreters can use.

The standard ruby <code>%{vendorlib}</code> directories lack this facility. For this reason, non-gem libraries need to be placed in per-interpreter directories and must have a separate subpackage (or package depending on upstream) for each interpreter that they support.

The standard ruby <code>%{vendorlib}</code> directories lack this facility. For this reason, non-gem libraries need to be placed in per-interpreter directories and must have a separate subpackage (or package depending on upstream) for each interpreter that they support.

Line 111:

Line 139:

* The package '''must''' <code>BuildRequires: rubygems-devel</code> to pull in the macros needed to build.

* The package '''must''' <code>BuildRequires: rubygems-devel</code> to pull in the macros needed to build.

* The package '''must''' <code>Requires: rubygems</code>, since it owns the RubyGems directory structure.

* The package '''must''' <code>Requires: rubygems</code>, since it owns the RubyGems directory structure.

−

* If the package is pure Ruby, it '''must not''' <code>Requires: ruby</code> or <code>Requires: jruby</code> (but be aware of implementation specific methods, such as <code>fork</code>).

==== Building gems ====

==== Building gems ====

Line 129:

Line 156:

%build

%build

−

mkdir -p ./%{gem_dir}

−

# Create the gem as gem install only works on a gem file

# Create the gem as gem install only works on a gem file

gem build %{gem_name}.gemspec

gem build %{gem_name}.gemspec

−

export CONFIGURE_ARGS="--with-cflags='%{optflags}'"

+

# %%gem_install compiles any C extensions and installs the gem into ./%%gem_dir

−

# gem install compiles any C extensions and installs into a directory

+

# by default, so that we can move it into the buildroot in %%install

−

# We set that to be a local directory so that we can move it into the

+

%gem_install

−

# buildroot in %%install

+

−

gem install -V \

+

−

--local \

+

−

--install-dir ./%{gem_dir} \

+

−

--bindir ./%{_bindir} \

+

−

--force \

+

−

--rdoc \

+

−

%{gem_name}-%{version}.gem

+

%install

%install

Line 178:

Line 195:

===== %build =====

===== %build =====

−

Next we build the gem. The first step is to create directories in which to temporarily install the built sources. We do this because the <code>gem install</code> command both builds and installs the code in one step so we need to have a temporary directory to place the built sources before installing them in <code>%install</code>. Because <code>gem install</code> only operates on gem archives, we next recreate the gem with <code>gem build</code>. The gem file that is created is then used by <code>gem install</code> to build and install the code into the temporary directory we created earlier.

+

Next we build the gem. Because <code>%gem_install</code> only operates on gem archives, we next recreate the gem with <code>gem build</code>. The gem file that is created is then used by <code>%gem_install</code> to build and install the code into the temporary directory, which is <code>./%{gem_dir}</code> by default. We do this because the <code>%gem_install</code> command both builds and installs the code in one step so we need to have a temporary directory to place the built sources before installing them in <code>%install</code> section.

+

+

<code>%gem_install</code> macro accepts two additional options:

+

;<code>-n <gem_file></code>

+

:Allows to override gem used for installation. This might get useful for converting legacy spec, so you might specify %{SOURCE0} as a gem for installation.

+

;<code>-d <install_dir></code>

+

:Might override the gem installation destination. However we do not suggest to use this option.

+

+

{{admon/note||The %gem_install macro '''must not''' be used to install into the <code>%{buildroot}</code>}}

+

===== %install =====

===== %install =====

Line 342:

Line 368:

{{admon/note|Do not ship tests|Normally tests are only run at package buildtime. They should not be included in the binary rpms that users install on their systems. You may make an exception for this if the package makes public use of the test suite at runtime (for instance, an application package that has a <code>--selftest</code> command line switch that runs its testsuite.)}}

{{admon/note|Do not ship tests|Normally tests are only run at package buildtime. They should not be included in the binary rpms that users install on their systems. You may make an exception for this if the package makes public use of the test suite at runtime (for instance, an application package that has a <code>--selftest</code> command line switch that runs its testsuite.)}}

+

+

=== Testing With Different Ruby Implementations ===

+

To run tests with different Ruby implementation such as JRuby, you need to <code>BuildRequires: jruby</code>. Then use Rubypick's interpreter switching:

+

+

<pre>

+

testrb _jruby_ -Ilib test

+

</pre>

+

+

If your package is running unittests for ruby-mri and it is intended to run under alternate interpreters then it needs to run the unittests under all alternate interpreters as well. This is the only method we have to check compatibility of the code under each interpreter. The same rules apply that you can omit this if libraries you need are unavailable for a specific alternate interpreter but you must have a comment to explain.

=== Testing frameworks usage ===

=== Testing frameworks usage ===

Line 375:

Line 410:

rspec -Ilib spec

rspec -Ilib spec

</pre>

</pre>

+

=== Test suites not included in the package ===

=== Test suites not included in the package ===

Line 408:

Line 444:

* Run the tests as you normally would.

* Run the tests as you normally would.

−

== Questions ==

+

[[Category:Packaging guidelines]]

−

* Only reason we could see not to go with shared modules would be the difficulty of knowing that a module would run on all the interpreters. To mitigate that, could we change the testing section with recipes to run the unittests under both ruby and jruby? (And probably need to BuildRequire: both ruby and jruby).

+

−

*

+

Revision as of 11:47, 30 April 2013

This page is a draft only It is still under construction and content may change. Do not rely on the information on this page.

Suggestions by Ruby SIGComments marked as this one are notes to FPC changes from Ruby SIG.

Different guidelines for packages in RHEL and Fedora 16In RHEL 5 and 6, a ruby version that does not have all the features needed to support these guidelines exists. If you're packaging for those distributions you should follow the old ruby guidelines instead.

Different Guidelines for Fedora 17 and 18In Fedora 17 and 18 the ruby guidelines were slightly different. Some of the macros and practices listed here did not work. Please see this [earlier version of the guidelines] if you want your package to work on those versions of Fedora

JRuby GemsAlthough Fedora 19 has fully functioning JRuby integrated with system RubyGems, we have decided to not include the JRuby specific packaging guidelines here, as they need some more work. They will appear here as soon as we feel that we've got everything covered properly. You can contact us on Ruby-SIG mailing list in case of any questions about the prepared JRuby packaging guidelines.

There are three basic categories of ruby packages: ruby gems, non-gem ruby packages, and applications written in ruby. These guidelines contain sections common to all of these as well as sections which apply to each one individually. Be sure to read all the guidelines relevant to the type of ruby package you are building.

Ruby Compatibility

Each Ruby package must indicate it depends on a Ruby interpreter. Use ruby(release) virtual requirement to achieve that:

Requires: ruby(release)

If the package requires Ruby of certain version(s), make the requirement versioned like this:

Requires: ruby(release) >= 1.9.1

Alternate interpretersAlternate Ruby interpreters (currently JRuby) also Provide: ruby(release). This implies, that pure RubyGems packages (these are shared among interpreters) should not have Requires: ruby or Requires: jruby to have their dependencies satisfied by any of these interpreters.

Over specified ruby(release) versioningPlease note, that if the ruby(release) version requirement is too specific, it may cause an unexpected interpreter to be drawn in. E.g. ruby(release) = 1.8 will require JRuby package, since it is the only package that provides it.

Different Interpreters Compatibility

Most of the pure Ruby packages will work on all Ruby interpreters. There are however cases, when the packages use interpreter-specific functions (like fork()) and won't run on other interpreters (JRuby). In this case, the package should require that interpreter. For example, a package that uses fork should explicitly specify Requires: ruby.
In case of such package, packager should file a bug to ask upstream to provide support for other interpreter(s). This should be documented in specfile.

Shebang lines

On Fedora, /usr/bin/ruby is implemented via Rubypick. Rubypick is a tool similar to RVM or rbenv. It allows choosing interpreter to execute Ruby script. Rubypick routes anything executed via /usr/bin/ruby to /usr/bin/ruby-mri or /usr/bin/jruby. By default, it runs MRI (Matz's Ruby Implementation), but user can explicitly specify the interpreter by using _mri_ or _jruby_ as a first parameter. For example:

ruby _jruby_ jruby_script.rb
gem _mri_ install foo
rails _jruby_ s

Using the RUBYPICK environment variable can achieve the same results. The environment variable can be used to set one interpreter as the global default:

export RUBYPICK=_jruby_
ruby jruby_script.rb # Will use jruby
gem install foo # Will also use jruby

Ruby executables that are known to only run on one Ruby implementation should use that specific implementation in their shebang - #!/usr/bin/ruby-mri or #!/usr/bin/jruby to ensure that they run using that implementation. All other code should use #!/usr/bin/ruby.

Naming Guidelines

Packages that contain Ruby Gems must be called rubygem-%{gem_name}.

The name of a ruby extension/library package must start with the interpreter it is built for (ruby, jruby, etc) and then the UPSTREAM name. For example: ruby-UPSTREAM. If the upstream name UPSTREAM contains ruby, that should be dropped from the name. For example, the SQLite database driver for ruby is called sqlite3-ruby. The corresponding Fedora package should be called ruby-sqlite3, and not ruby-sqlite3-ruby.

Application packages that mainly provide user-level tools that happen to be written in Ruby must follow the general NamingGuidelines instead.

Interpreter independence and directory macros

You may have noticed that the table above has different directories for non-gem libraries on different ruby interpreters but only a single set of directories for rubygem libraries. This is because code written for one ruby interpreter will often run on all ruby interpreters that Fedora ships (ruby, jruby, etc). However, some code uses methods that are not available on all interpreters (see Different Interpreters Compatibility). Rubygems have a facility to ship different versions of the code in the same gem so that the gem can run on all versions of the interpreter so we only need to have one common directory for rubygems that all the interpreters can use.

The standard ruby %{vendorlib} directories lack this facility. For this reason, non-gem libraries need to be placed in per-interpreter directories and must have a separate subpackage (or package depending on upstream) for each interpreter that they support.

Libraries

These guidelines only apply to Ruby packages whose main purpose is providing a Ruby library; packages that mainly provide user-level tools that happen to be written in Ruby must follow the ruby applications guidelines instead.

RubyGems

RubyGems are Ruby's own packaging format. Gems contain a lot of the same metadata that RPM's need, making fairly smooth interoperation between RPM and Gems possible. This guideline ensures that Gems are packaged as RPM's in a way that such RPM's fit cleanly with the rest of the distribution and to make it possible for the end user to satisfy dependencies of a Gem by installing the appropriate RPM-packaged Gem.

Both RPM's and Gems use similar terminology --- there are specfiles, package names, dependencies etc. for both. To keep confusion to a minimum, terms relating to Gem concepts will be explicitly refereed to with the word 'Gem' prefixed, eg 'Gem specification' (.gemspec). An unqualified 'package' in the following always means an RPM.

Spec files must contain a definition of %{gem_name} which is the name from the Gem's specification.

The Source of the package must be the full URL to the released Gem archive; the version of the package must be the Gem's version.

The package mustBuildRequires: rubygems-devel to pull in the macros needed to build.

The package mustRequires: rubygems, since it owns the RubyGems directory structure.

Building gems

Since gems aren't a standard archive format that rpm knows about and they encapsulate both an archive format and information to build the ruby library building an rpm from a gem looks a little different from other rpms.

A sample spec for building gems would look like this:

%prep
gem unpack %{SOURCE0}
%setup -q -D -T -n %{gem_name}-%{version}
gem spec %{SOURCE0} -l --ruby > %{gem_name}.gemspec
# Modify the gemspec if necessary with a patch or sed
# Also apply patches to code if necessary
%patch0 -p1
%build
# Create the gem as gem install only works on a gem file
gem build %{gem_name}.gemspec
# %%gem_install compiles any C extensions and installs the gem into ./%%gem_dir
# by default, so that we can move it into the buildroot in %%install
%gem_install
%install
mkdir -p %{buildroot}%{gem_dir}
cp -a ./%{gem_dir}/* %{buildroot}%{gem_dir}/
# If there were programs installed:
mkdir -p %{buildroot}%{_bindir}
cp -a ./%{_bindir}/* %{buildroot}%{_bindir}
# If there are C extensions, mv them to the extdir.
# You must replace REQUIRE_PATHS according to your gem specifics.
mkdir -p %{buildroot}%{gem_extdir_mri}/REQUIRE_PATHS
mv %{buildroot}%{gem_instdir}/REQUIRE_PATHS/shared_object.so %{buildroot}%{gem_extdir_mri}/REQUIRE_PATHS/

You should replace REQUIRE_PATHS with the first value of the require_paths field in the gemspec file. It will typically be either "lib" or "ext". For instance if you find following line in your gemspec file:

%prep

Since gems aren't an archive format that rpm recognizes, the first thing we have to do is explicitly use gem unpack to extract the source from the gem. Then we call %setup -n %{gem_name}-%{version} to tell rpm what the directory the gem has unpacked into. The -T and -D flags tell %setup that we've already unpacked the code

We then run gem spec to output the metadata from the gem into a file. This .gemspec file will be used to rebuild the gem later. If we need to modify the .gemspec (for instance, if the version of dependencies is wrong for Fedora or the .gemspec is using old, no longer supported fields) we would do it here. Patches to the code itself can also be done here.

%build

Next we build the gem. Because %gem_install only operates on gem archives, we next recreate the gem with gem build. The gem file that is created is then used by %gem_install to build and install the code into the temporary directory, which is ./%{gem_dir} by default. We do this because the %gem_install command both builds and installs the code in one step so we need to have a temporary directory to place the built sources before installing them in %install section.

%gem_install macro accepts two additional options:

-n <gem_file>

Allows to override gem used for installation. This might get useful for converting legacy spec, so you might specify %{SOURCE0} as a gem for installation.

-d <install_dir>

Might override the gem installation destination. However we do not suggest to use this option.

The %gem_install macro must not be used to install into the %{buildroot}

%install

Here we actually install into the %{buildroot}. We create the directories that we need and then copy what was installed into the temporary directories into the %{buildroot} hierarchy. Finally, if this ruby gem creates shared objects the shared objects are moved into the arch specific %{gem_extdir_mri} path.

Patching required gem versions

One common patching need is to change overly strict version requirements in the upstream gemspec. This may be because upstream's gemspec only mentions versions that they've explicitly tested against but we know that a different version will also work or because we know that the packages we ship have applied fixes for problematic behaviour without bumping the version number (for instance, backported fixes). To fix these issues, find the add_runtime_dependency call in the gemspec and patch it with the corrected version similar to this:

Be sure to testDo not simply change versions without testing that the new version works. There are times the upstream is overly strict but there are also times when the version requirement was specified because a specific bug was encountered or the API changed in a minor release.

Packaging for Gem and non-Gem use

Packaging for non-Gem use is no longer neededOriginally, rubygem modules were not placed in ruby's library path, so we packaged rubygems for use with both gems and non-gems. This allowed code that used require('ARubyModulePackagedAsAGem'); to function. The current rubygem module adds all gems to the ruby library path when it is require'd. So, packagers must not create non-Gem subpackages of rubygems for new packages. Since the majority of Ruby packages in Fedora are now packaged as installed gems, you may need to patch the code to use require('rubygem') as early in the program as possible to ensure that these ruby components are properly found. Packages for ruby gems that currently create a non-gem subpackage should be adapted to stop shipping the non-gem subpackage (with a proper Obsoletes and Provides in the main rubygem package).

Non-Gem Packages

Non-Gem Ruby packages must require ruby-devel package at build time with a BuildRequires: ruby-devel, and may indicate the minimal ruby version they need for building.

Build Architecture and File Placement

The following only affects the files that the package installs into %{ruby_vendorarchdir} and %{ruby_vendorlibdir} (the actual Ruby library files). All other files in a Ruby package must adhere to the general Fedora packaging conventions.

Site versus VendorPreviously, %{ruby_sitelibdir} and %{ruby_sitearchdir} were used. However, as they are meant only for local installations, please use %{ruby_vendorlibdir} and %{ruby_vendorarchdir} instead.

Pure Ruby packages

Pure Ruby packages must be built as noarch packages.

The Ruby library files in a pure Ruby package must be placed into %{ruby_vendorlibdir} (or its proper subdirectory). The specfile must use this macro.

Ruby packages with binary content/shared libraries

For packages with binary content, e.g., database drivers or any other Ruby bindings to C libraries, the package must be architecture specific.

The binary files in a Ruby package with binary content must be placed into %{ruby_vendorarchdir} (or its proper subdirectory). The Ruby files in such a package should be placed into %{ruby_vendorlibdir}. The specfile must use these macros.

For packages which create C shared libraries using extconf.rb

export CONFIGURE_ARGS="--with-cflags='%{optflags}'"

should be used to pass CFLAGS to Makefile correctly. Also, to place the files into the correct folders during build, pass --vendor to extconf.rb like this:

extconf.rb --vendor

Applications

Applications are

programs that provide user-level tools or

web applications, typically built using Rails, Sinatra or similar frameworks.

The RPM packages must obey FHS rules. They should be installed into %{_datadir}. The following macro can help you:

%global app_root %{_datadir}/%{name}

These packages typically have no "Provides" section, since no other libraries or applications depend on them.

Note, that although the source is a RubyGem, we have to install the files manually under %{_datadir}/%{name}, %{_bindir}, etc. to follow FHS and general packaging guidelines. If additional Fedora specific files (systemd .service files, configurations) are required, they should be

added via another %SOURCE tags

Source1: deltacloudd-fedora

placed into appropriate locations during %install stage

install -m 0755 %{SOURCE1} %{buildroot}%{_bindir}/deltacloudd

Running test suites

If there is test suite available for the package (even separately, for example not included in the gem but available in the upstream repository), it should be run in %check. The test suite is the only automated tool which can assure basic functionality of the package. Running it is especially helpful when mass rebuilds are required. You may skip test suite execution when not all build dependencies are met but this must be documented in the specfile. The missing build dependencies to enable the test suite should be packaged for Fedora as soon as possible and the test suite re-enabled.

The tests should not be run using Rake - Rake almost always draws in some unnecessary dependencies like hoe or gemcutter.

Do not ship testsNormally tests are only run at package buildtime. They should not be included in the binary rpms that users install on their systems. You may make an exception for this if the package makes public use of the test suite at runtime (for instance, an application package that has a --selftest command line switch that runs its testsuite.)

Testing With Different Ruby Implementations

To run tests with different Ruby implementation such as JRuby, you need to BuildRequires: jruby. Then use Rubypick's interpreter switching:

testrb _jruby_ -Ilib test

If your package is running unittests for ruby-mri and it is intended to run under alternate interpreters then it needs to run the unittests under all alternate interpreters as well. This is the only method we have to check compatibility of the code under each interpreter. The same rules apply that you can omit this if libraries you need are unavailable for a specific alternate interpreter but you must have a comment to explain.

Testing frameworks usage

The Ruby community supports many testing frameworks. The following sections demonstrate how several to execute several of the more common test suites.

MiniTest

MiniTest is the default testing framework shipped with Ruby. It is unbundled in Fedora (you must use BuildRequires: rubygem-minitest). To run tests using MiniTest you can use something like:

%check
testrb -Ilib test

Test::UNIT

To run tests using Test::Unit you must BuildRequires: rubygem-test-unit- and use something like this:

%check
testrb2 -Ilib test

Test suites which run using Test::UNIT can typically also be executed by MiniTest. In that case, please prefer MiniTest.

RSpec

To run tests using RSpec >= 2 you must BuildRequires: rubygem-rspec and use something like:

%check
rspec -Ilib spec

Test suites not included in the package

Sometimes you have to get the tests separately from upstream's gem package. As an example lets suppose you're packaging rubygem-delorean, version 1.2.0, which is hosted on Github. Tests are not included in the Gem itself, so you need to get them and adjust the specfile accordingly:

Make sure to include the version of the tests in the source name, so that when updating to new version, rpmbuild will fail because it won't find the proper %{SOURCE1} (and this will remind you to update the tests, too).

Add the commands you used to get the tests into the specfile as comments. This will make it a lot easier the next time you will need to get them.