User:Bkabrda/Ruby Packaging Update

From FedoraProject

< User:Bkabrda(Difference between revisions)
Jump to: navigation, search
(First bunch of changes for JRuby)
 
(Replaced content with "How can I delete a page? :)")
 
Line 1: Line 1:
= Ruby Packaging Guidelines =
+
How can I delete a page? :)
 
+
{{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.}}
+
 
+
There are three basic categories of ruby packages: [[#RubyGems | ruby gems]], [[#Non-Gem Packages | non-gem ruby packages]], and [[#ruby_applications| 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 ABI ==
+
 
+
Each Ruby package '''must''' indicate the Ruby ABI version it depends on with a line like
+
<pre>
+
Requires: ruby(abi) = 1.9.1
+
</pre>
+
 
+
{{admon/note|Alternate interpreters| Alternate Ruby interpreters (currently JRuby) also <code>Provide: ruby(abi)</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.}}
+
 
+
{{Anchor|ruby_naming}}
+
 
+
== Naming Guidelines ==
+
 
+
* Packages that contain Ruby Gems '''must''' be called <code>rubygem-%{gem_name}</code>.
+
 
+
* The name of a ruby extension/library package '''must''' start with the interpreter it is built for (ruby, jruby, etc) and then the <code>UPSTREAM</code> name.  For example: <code>ruby-UPSTREAM</code>. If the upstream name <code>UPSTREAM</code> contains <code>ruby</code>, that '''should''' be dropped from the name. For example, the SQLite database driver for ruby is called <code>sqlite3-ruby</code>. The corresponding Fedora package should be called <code>ruby-sqlite3</code>, and not <code>ruby-sqlite3-ruby</code>.
+
 
+
* Application packages that mainly provide user-level tools that happen to be written in Ruby '''must''' follow the general [[Packaging/NamingGuidelines|  NamingGuidelines]]  instead.
+
 
+
== Macros ==
+
 
+
Non-gem ruby packages and ruby gem packages install to certain standard locations.  The <code>ruby-devel</code> and <code>rubygems-devel</code> packages contain macros useful for the respective package types.
+
 
+
{| border="1" cellpadding="20" cellspacing="0"
+
!Macro
+
!Expanded path
+
!Usage
+
|-
+
! colspan="3"|From ruby-devel; intended for non-gem packages. Alternate ruby interpreters will have equivalent locations (To be added to this table later)
+
|-
+
|<code>%{ruby_vendorarchdir}</code>
+
|/usr/lib{64}/ruby/vendor_ruby
+
|Place for architecture specific (e.g. *.so) files.
+
|-
+
|<code>%{ruby_vendorlibdir}</code>
+
|/usr/share/ruby/vendor_ruby
+
|Place for architecture independent (e.g. *.rb) files.
+
|-
+
|<code>%{ruby_sitearchdir}</code>
+
|/usr/local/lib{64}/ruby/site_ruby
+
|Place for local architecture specific (e.g. *.so) files.
+
|-
+
|<code>%{ruby_sitelibdir}</code>
+
|/usr/local/share/ruby/site_ruby
+
|Place for local architecture independent (e.g. *.rb) files.
+
|-
+
! colspan="3" | From rubygems-devel; intended for gem packages
+
|-
+
|<code>%{gem_dir}</code>
+
|/usr/share/rubygems
+
|Top directory for the Gem structure.
+
|-
+
|<code>%{gem_instdir}</code>
+
|%{gem_dir}/gems/%{gem_name}-%{version}
+
|Directory with the actual content of the Gem.
+
|-
+
|<code>%{gem_libdir}</code>
+
|%{gem_instdir}/lib
+
|The <code>lib</code> folder of the Gem.
+
|-
+
|<code>%{gem_cache}</code>
+
|%{gem_dir}/cache/%{gem_name}-%{version}.gem
+
|The cached Gem.
+
|-
+
|<code>%{gem_spec}</code>
+
|%{gem_dir}/specifications/%{gem_name}-%{version}.gemspec
+
|The Gem specification file.
+
|-
+
|<code>%{gem_docdir}</code>
+
|%{gem_dir}/doc/%{gem_name}-%{version}
+
|The rdoc documentation of the Gem.
+
|-
+
|<code>%{gem_extdir}</code>
+
|%{_libdir}/gems/ruby/%{gem_name}-%{version}
+
|The directory for MRI Ruby Gem extensions.
+
|-
+
|<code>%{gem_extdir_jruby_pure}</code>
+
|%{gem_dir}/jruby/%{gem_name}-%{version}
+
|The directory for JRuby Gem extensions.
+
|-
+
! colspan="3" | From rubygems-devel; intended for JRuby gem packages from gems that contain extensions for multiple runtimes
+
|-
+
|<code>%{gem_instdir_jruby}</code>
+
|%{gem_dir}/gems/%{gem_name}-%{version}-java
+
|Directory with the actual content of the Gem.
+
|-
+
|<code>%{gem_libdir_jruby}</code>
+
|%{gem_instdir_jruby}/lib
+
|The <code>lib</code> folder of the Gem.
+
|-
+
|<code>%{gem_cache_jruby}</code>
+
|%{gem_dir}/cache/%{gem_name}-%{version}-java.gem
+
|The cached Gem.
+
|-
+
|<code>%{gem_spec_jruby}</code>
+
|%{gem_dir}/specifications/%{gem_name}-%{version}-java.gemspec
+
|The Gem specification file.
+
|-
+
|<code>%{gem_extdir_jruby}</code>
+
|%{_libdir}/gems/exts/%{gem_name}-%{version}
+
|The directory for binary Gem extensions.
+
|}
+
 
+
=== 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.
+
 
+
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.
+
 
+
== 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|ruby applications guidelines]] instead.
+
 
+
=== RubyGems ===
+
 
+
[http://www.rubygems.org/ 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 <code>%{gem_name}</code> which is the name from the Gem's specification.
+
* The <code>Source</code> 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 '''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.
+
* If the package is pure Ruby, it '''must not''' <code>Requires: ruby</code> or <code>Requires: jruby</code>.
+
 
+
Rules for extension packages:
+
 
+
* If the package contains extension for one runtime, it '''must''' <code>Requires: ruby</code> or <code>Requires: jruby</code>.
+
* If the package ships with extensions for multiple runtimes, it '''must''' contain the MRI Ruby extension in basic package and all the subpackages with other extension '''must''' depend on it.
+
* The names of extension subpackages for JRuby must be suffixed with -jruby.
+
* The extension packages must contain their own gemspecs and libdirs (use the macros suffixed with <code>_jruby</code> for this).
+
 
+
==== 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:
+
<pre>
+
%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
+
mkdir -p ./%{gem_dir}
+
 
+
# Create the gem as gem install only works on a gem file
+
gem build %{gem_name}.gemspec
+
 
+
export CONFIGURE_ARGS="--with-cflags='%{optflags}'"
+
# gem install compiles any C extensions and installs into a directory
+
# We set that to be a local directory so that we can move it into the
+
# buildroot in %%install
+
gem install -V \
+
        --local \
+
        --install-dir ./%{gem_dir} \
+
        --bindir ./%{_bindir} \
+
        --force \
+
        --rdoc \
+
        %{gem_name}-%{version}.gem
+
 
+
%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}/REQUIRE_PATHS
+
mv %{buildroot}%{gem_instdir}/REQUIRE_PATHS/shared_object.so %{buildroot}%{gem_extdir}/REQUIRE_PATHS/
+
</pre>
+
 
+
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:
+
<pre>
+
  s.require_paths = ["lib"]
+
</pre>
+
 
+
then the example above would look like:
+
<pre>
+
mkdir -p %{buildroot}%{gem_extdir}/lib
+
mv %{buildroot}%{gem_instdir}/lib/shared_object.so %{buildroot}%{gem_extdir}/lib/
+
</pre>
+
 
+
===== Building Gems with JRuby extensions =====
+
When building Gems with JRuby extensions (.jar files), you '''must''' remove all the .jar files and rebuild them from source. Please see [[Packaging:Java]] for instructions on building Java code.
+
 
+
===== %prep =====
+
Since gems aren't an archive format that rpm recognizes, the first thing we have to do is explicitly use <code>gem unpack</code> to extract the source from the gem.  Then we call <code>%setup -n %{gem_name}-%{version}</code> to tell rpm what the directory the gem has unpacked into.  The [http://www.rpm.org/max-rpm/s1-rpm-inside-macros.html#S3-RPM-INSIDE-SETUP-T-OPTION <code>-T</code>] and [http://www.rpm.org/max-rpm/s1-rpm-inside-macros.html#S3-RPM-INSIDE-SETUP-D-OPTION <code>-D</code>] flags tell <code>%setup</code> that we've already unpacked the code
+
 
+
We then run <code>gem spec</code> to output the metadata from the gem into a file.  This <code>.gemspec</code> file will be used to rebuild the gem later.  If we need to modify the <code>.gemspec</code> (for instance, if the version of dependencies is wrong for Fedora or the <code>.gemspec</code> 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.  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.
+
 
+
===== %install =====
+
Here we actually install into the <code>%{buildroot}</code>.  We create the directories that we need and then copy what was installed into the temporary directories into the <code>%{buildroot}</code> hierarchy.  Finally, if this ruby gem creates shared objects the shared objects are moved into the arch specific <code>%{gem_extdir}</code> 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 <code>add_runtime_dependency</code> call in the gemspec and patch it with the corrected version similar to this:
+
 
+
<pre>
+
Gem::Specification.new do |s|
+
  # [...]
+
-  s.add_runtime_dependency(%q<mail>, ["~> 2.2.19"])
+
+  s.add_runtime_dependency(%q<mail>, [">= 2.3.0"])
+
  # [...]
+
end
+
</pre>
+
 
+
{{admon/warning|Be sure to test|Do 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 ===
+
 
+
{{admon/caution|Packaging for non-Gem use is no longer needed| Originally, 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 <code>require('ARubyModulePackagedAsAGem');</code> to function.  The current <code>rubygem</code> module adds all gems to the ruby library path when it is <code>require</code>'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 <code>require('rubygem')</code> 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 [[Packaging:Guidelines#Renaming.2FReplacing_Existing_Packages | 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 <code>BuildRequires: ruby-devel</code>, 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 <code>%{ruby_vendorarchdir} </code> and <code>%{ruby_vendorlibdir}</code> (the actual Ruby library files). All other files in a Ruby package must adhere to the general Fedora packaging conventions.
+
 
+
 
+
{{admon/warning|Site versus Vendor|Previously, %{ruby_sitelibdir} and %{ruby_sitearchdir} were used. However, as they are meant only for local installations, please use <code>%{ruby_vendorlibdir}</code> and <code>%{ruby_vendorarchdir}</code> 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 <code>%{ruby_vendorlibdir}</code> (or its proper subdirectory). The specfile '''must''' use this macro.
+
 
+
{{Anchor|ruby_vendorarchdir}}
+
 
+
==== 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 <code>%{ruby_vendorarchdir}</code> (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 <code>extconf.rb</code>
+
{{Anchor|configure_args}}
+
<pre>
+
export CONFIGURE_ARGS="--with-cflags='%{optflags}'"
+
</pre>
+
'''should''' be used to pass <code>CFLAGS</code> to <code>Makefile</code> correctly. Also, to place the files into the correct folders during build, pass <code>--vendor</code> to <code>extconf.rb</code> like this:
+
<pre>
+
extconf.rb --vendor
+
</pre>
+
 
+
{{Anchor|ruby_applications}}
+
 
+
== 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 <code>%{_datadir}</code>. The following macro can help you:
+
<pre>
+
%global app_root %{_datadir}/%{name}
+
</pre>
+
 
+
These packages typically have no "Provides" section, since no other libraries or applications depend on them.
+
 
+
Here's an abbreviated example:
+
 
+
<pre>
+
%global app_root %{_datadir}/%{name}
+
 
+
Summary: Deltacloud REST API
+
Name: deltacloud-core
+
Version: 0.3.0
+
Release: 3%{?dist}
+
Group: Development/Languages
+
License: ASL 2.0 and MIT
+
URL: http://incubator.apache.org/deltacloud
+
Source0: http://gems.rubyforge.org/gems/%{name}-%{version}.gem
+
Requires: rubygem-haml
+
#...
+
Requires(post):  chkconfig
+
#...
+
BuildRequires: rubygem-haml
+
#...
+
BuildArch: noarch
+
 
+
%description
+
The Deltacloud API is built as a service-based REST API.
+
You do not directly link a Deltacloud library into your program to use it.
+
Instead, a client speaks the Deltacloud API over HTTP to a server
+
which implements the REST interface.
+
 
+
%package doc
+
Summary: Documentation for %{name}
+
Group: Documentation
+
Requires:%{name} = %{version}-%{release}
+
 
+
%description doc
+
Documentation for %{name}
+
 
+
%prep
+
gem unpack -V %{SOURCE0}
+
%setup -q -D -T -n %{name}-%{version}
+
 
+
%build
+
 
+
%install
+
mkdir -p %{buildroot}%{app_root}
+
mkdir -p %{buildroot}%{_initddir}
+
mkdir -p %{buildroot}%{_bindir}
+
cp -r * %{buildroot}%{app_root}
+
mv %{buildroot}%{app_root}/support/fedora/%{name} %{buildroot}%{_initddir}
+
find %{buildroot}%{app_root}/lib -type f | xargs chmod -x
+
chmod 0755 %{buildroot}%{_initddir}/%{name}
+
chmod 0755 %{buildroot}%{app_root}/bin/deltacloudd
+
rm -rf %{buildroot}%{app_root}/support
+
rdoc --op %{buildroot}%{_defaultdocdir}/%{name}
+
 
+
%post
+
# This adds the proper /etc/rc*.d links for the script
+
/sbin/chkconfig --add %{name}
+
 
+
%files
+
%{_initddir}/%{name}
+
%{_bindir}/deltacloudd
+
%dir %{app_root}/
+
%{app_root}/bin
+
#...
+
 
+
%files doc
+
%{_defaultdocdir}/%{name}
+
%{app_root}/tests
+
%{app_root}/%{name}.gemspec
+
%{app_root}/Rakefile
+
 
+
%changelog
+
#...
+
</pre>
+
 
+
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 <code>.service</code> files, configurations) are required, they '''should''' be
+
* added via another <code>%SOURCE</code> tags
+
<pre>
+
Source1: deltacloudd-fedora
+
</pre>
+
* placed into appropriate locations during <code>%install</code> stage
+
<pre>
+
install -m 0755 %{SOURCE1} %{buildroot}%{_bindir}/deltacloudd
+
</pre>
+
 
+
== 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 <code>%check</code>. 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.
+
 
+
{{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 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 <code>BuildRequires: rubygem-minitest</code>). To run tests using MiniTest you can use something like:
+
 
+
<pre>
+
%check
+
testrb -Ilib test
+
</pre>
+
 
+
==== Test::UNIT ====
+
 
+
To run tests using Test::Unit you must <code>BuildRequires: rubygem-test-unit-</code> and use something like this:
+
 
+
<pre>
+
%check
+
testrb2 -Ilib test
+
</pre>
+
 
+
{{admon/note|| 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 <code>BuildRequires: rubygem-rspec</code> and use something like:
+
 
+
<pre>
+
%check
+
rspec -Ilib spec
+
</pre>
+
 
+
=== 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 <code>rubygem-delorean</code>, 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:
+
 
+
<pre>
+
# git clone https://github.com/bebanjo/delorean.git && cd delorean
+
# git checkout v1.2.0
+
# tar -czf rubygem-delorean-1.2.0-specs.tgz spec/
+
Source1: %{name}-%{version}-specs.tgz
+
 
+
# ...
+
%prep
+
%setup -q -D -T -n %{gem_name}-%{version}
+
 
+
tar -xzf %{SOURCE1}
+
 
+
# ...
+
 
+
%check
+
cp -pr spec/ ./%{gem_instdir}
+
pushd ./%{gem_instdir}
+
# Run tests
+
rm -rf spec
+
popd
+
 
+
# ...
+
 
+
</pre>
+
* 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 <code>%{SOURCE1}</code> (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.
+
* Run the tests as you normally would.
+

Latest revision as of 11:59, 6 December 2012

How can I delete a page? :)