Difference between revisions of "Ruby Gem package guidelines"

From ArchWiki
Jump to: navigation, search
m (Notes: typo)
(update Pkg/AUR templates (https://github.com/lahwaacz/wiki-scripts/blob/master/update-package-templates.py))
 
(18 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
[[Category:Package development]]
 
[[Category:Package development]]
[[it:Ruby Gem Package Guidelines]]
+
[[it:Ruby Gem package guidelines]]
{{Package Guidelines}}
+
{{Package guidelines}}
  
 
Writing [[PKGBUILD]]s for software written in [[Ruby]].
 
Writing [[PKGBUILD]]s for software written in [[Ruby]].
  
== Package Naming ==
+
== Package naming ==
For libraries, use {{Ic|ruby-gemname}}. For applications, use the program name. In either case, the name should be entirely lowercase
+
For libraries, use {{Ic|ruby-$gemname}}. For applications, use the program name. In either case, the name should be entirely lowercase.
 +
 
 +
Always use {{Ic|ruby-}} prefix even if {{Ic|$gemname}} already starts with word {{Ic|ruby}}. It is needed to avoid future name clashes in case if a gem with shorter name appear. It also makes names more easily parseble by tools (think about PKGBUILD generators/version or dependency checkers, etc...). Examples: {{AUR|ruby-ruby-protocol-buffers}}{{Broken package link|{{aur-mirror|ruby-ruby-protocol-buffers}}}}.
 +
 
 +
===Versioned packages===
 +
If you need to add a versioned package then use {{Ic|ruby-$gemname-$version}}, e.g. {{Ic|ruby-builder-3.2.1}}. So rubygem dependency {{Ic|builder=3.2.1}} will turn into {{Ic|ruby-builder-3.2.1}} Arch package.
 +
 
 +
In case if you need to resolve "approximately greater" dependency {{Ic|~>}} then package should use version without the last part, e.g. rubygem dependency {{Ic|builder~>3.2.1}} will turn into {{Ic|ruby-builder-3.2}}. An exception for this rule is when "approximately greater" dependency matches the latest version of the gem - in this case avoid introducing a new versioned package and use just {{Ic|ruby-$gemname}} instead (the HEAD version).
 +
 
 +
Another problem with versioned packages is that it can conflict with other versions, e.g. because the packages install the same files in {{ic|/usr/bin}}. One solution for this problem is that versioned packages should not install such files - only HEAD version package can do this.
  
 
== Examples ==
 
== Examples ==
For examples, please see {{AUR|github-gem}} {{AUR|ruby-json_pure}} {{AUR|ruby-hpricot}}.
+
For examples, please see {{AUR|ruby-rethinkdb}}{{Broken package link|{{aur-mirror|ruby-rethinkdb}}}} {{AUR|ruby-json_pure}} {{Pkg|ruby-hpricot}}.
  
 
== Notes ==
 
== Notes ==
Line 16: Line 25:
 
{{Note|Usage of {{ic|--no-user-install}} '''gem''' argument is mandatory since latest Ruby versions (See {{Bug|28681}} for details).}}
 
{{Note|Usage of {{ic|--no-user-install}} '''gem''' argument is mandatory since latest Ruby versions (See {{Bug|28681}} for details).}}
  
== Example PKGBUILD ==
+
=== Quarry ===
An example PKGBUILD can be found at {{Ic|/usr/share/pacman/PKGBUILD-rubygem.proto}}, which is in the {{Pkg|abs}} package.
+
 
 +
As an alternative to manually managing gemfiles, you might also want to consider quarry, a non-official repository of pre-built binary arch packages. See [[Quarry]] for details.
 +
 
 +
== Gotchas ==
 +
=== Package contains reference to $pkgdir ===
 +
Sometimes when you build the package you can see following warning {{Ic|WARNING: Package contains reference to $pkgdir}}. Some packed files contain absolute path of directory where you built the package. To find these files run {{ic|cd pkg && grep -R "$(pwd)" .}} Most likely the reason will be hardcoded path in {{Ic|.../ext/Makefile}}.
 +
{{note|folder {{ic|ext}} contains native extension code usually written in C. During the package installation rubygems generates a Makefile using {{ic|mkmf}} library. Then {{Ic|make}} is called, it compiles a shared library and copies one to {{ic|lib}} gem directory.}}
 +
After {{ic|gem install}} is over the {{Ic|Makefile}} is not needed anymore. In fact none of the files in {{Ic|ext}} is needed and it can be completely removed by adding {{ic|rm -rf "$pkgdir/$_gemdir/gems/$_gemname-$pkgver/ext"}} to {{ic|package()}} function.
  
 
== Automation ==
 
== Automation ==
 
The gem installation can be automated completely with the tool {{AUR|pacgem}} which creates a temporary PKGBUILD, calls [[makepkg]] and [[namcap]]. The resulting package is then installed with {{Ic|sudo pacman}}.
 
The gem installation can be automated completely with the tool {{AUR|pacgem}} which creates a temporary PKGBUILD, calls [[makepkg]] and [[namcap]]. The resulting package is then installed with {{Ic|sudo pacman}}.
  
There are also multiple gem2arch tools which aid in automating the process of creating a ruby gem PKGBUILD. Make sure to manually check the PKGBUILD after generation. The [http://github.com/abhidg/gem2arch/ original version] is by Abhishek Dasgupta. Search for other versions of this tool in AUR ([https://aur.archlinux.org/packages.php?K=gem2arch Search for gem2arch]).
+
There is also {{AUR|gem2arch}} tools which aid in automating the process of creating a ruby gem PKGBUILD. Make sure to manually check the PKGBUILD after generation.

Latest revision as of 21:16, 9 November 2015

Package creation guidelines

CLRCrossEclipseFree PascalGNOMEGoHaskellJavaKDEKernelLispMinGWNode.jsNonfreeOCamlPerlPHPPythonRubyVCSWebWine

Writing PKGBUILDs for software written in Ruby.

Package naming

For libraries, use ruby-$gemname. For applications, use the program name. In either case, the name should be entirely lowercase.

Always use ruby- prefix even if $gemname already starts with word ruby. It is needed to avoid future name clashes in case if a gem with shorter name appear. It also makes names more easily parseble by tools (think about PKGBUILD generators/version or dependency checkers, etc...). Examples: ruby-ruby-protocol-buffersAUR[broken link: archived in aur-mirror].

Versioned packages

If you need to add a versioned package then use ruby-$gemname-$version, e.g. ruby-builder-3.2.1. So rubygem dependency builder=3.2.1 will turn into ruby-builder-3.2.1 Arch package.

In case if you need to resolve "approximately greater" dependency ~> then package should use version without the last part, e.g. rubygem dependency builder~>3.2.1 will turn into ruby-builder-3.2. An exception for this rule is when "approximately greater" dependency matches the latest version of the gem - in this case avoid introducing a new versioned package and use just ruby-$gemname instead (the HEAD version).

Another problem with versioned packages is that it can conflict with other versions, e.g. because the packages install the same files in /usr/bin. One solution for this problem is that versioned packages should not install such files - only HEAD version package can do this.

Examples

For examples, please see ruby-rethinkdbAUR[broken link: archived in aur-mirror] ruby-json_pureAUR ruby-hpricot.

Notes

Add --verbose to gem arguments to receive additional information in case of troubles.

Note: Usage of --no-user-install gem argument is mandatory since latest Ruby versions (See FS#28681 for details).

Quarry

As an alternative to manually managing gemfiles, you might also want to consider quarry, a non-official repository of pre-built binary arch packages. See Quarry for details.

Gotchas

Package contains reference to $pkgdir

Sometimes when you build the package you can see following warning WARNING: Package contains reference to $pkgdir. Some packed files contain absolute path of directory where you built the package. To find these files run cd pkg && grep -R "$(pwd)" . Most likely the reason will be hardcoded path in .../ext/Makefile.

Note: folder ext contains native extension code usually written in C. During the package installation rubygems generates a Makefile using mkmf library. Then make is called, it compiles a shared library and copies one to lib gem directory.

After gem install is over the Makefile is not needed anymore. In fact none of the files in ext is needed and it can be completely removed by adding rm -rf "$pkgdir/$_gemdir/gems/$_gemname-$pkgver/ext" to package() function.

Automation

The gem installation can be automated completely with the tool pacgemAUR which creates a temporary PKGBUILD, calls makepkg and namcap. The resulting package is then installed with sudo pacman.

There is also gem2archAUR tools which aid in automating the process of creating a ruby gem PKGBUILD. Make sure to manually check the PKGBUILD after generation.