fedora-docs-l10n/packaging-guidelines/master/pages/Ruby

Zen

Source string Source string

English

Macros

Needs editing

The string is read only.

Skip

	English	Actions
	Requires: ruby(release) >= 1.9.1
	Alternate interpreters: Alternate 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) versioning: Please note that if the `ruby(release)` version requirement is too specific, it might 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 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 `/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 xref:Naming.adoc[Naming Guidelines] instead.
	Macros
	Non-gem ruby packages and ruby gem packages install to certain standard locations. The `ruby-devel` and `rubygems-devel` packages contain macros useful for the respective package types. Alternate ruby interpreters will have equivalent locations (to be added to this table later).
	\|Macro \|Expanded path \|Usage 3+\|From ruby-devel; intended for non-gem packages. \|`+%{ruby_vendorarchdir}+` \|`+/usr/lib{64}/ruby/vendor_ruby+` \|Place for architecture specific (e.g. .so) files. \|`+%{ruby_vendorlibdir}+` \|`+/usr/share/ruby/vendor_ruby+` \|Place for architecture independent (e.g. .rb) files. \|`+%{ruby_sitearchdir}+` \|`+/usr/local/lib{64}/ruby/site_ruby+` \|Place for local architecture specific (e.g. .so) files. \|`+%{ruby_sitelibdir}+` \|`+/usr/local/share/ruby/site_ruby+` \|Place for local architecture independent (e.g. .rb) files. 3+\|From rubygems-devel; intended for gem packages. \|`+%{gem_dir}+` \|`+/usr/share/gems+` \|Top directory for the Gem structure. \|`+%{gem_instdir}+` \|`+%{gem_dir}/gems/%{gem_name}-%{version}+` \|Directory with the actual content of the Gem. \|`+%{gem_libdir}+` \|`+%{gem_instdir}/lib+` \|The `lib` folder of the Gem. \|`+%{gem_cache}+` \|`+%{gem_dir}/cache/%{gem_name}-%{version}.gem+` \|The cached Gem. \|`+%{gem_spec}+` \|`+%{gem_dir}/specifications/%{gem_name}-%{version}.gemspec+` \|The Gem specification file. \|`+%{gem_docdir}+` \|`+%{gem_dir}/doc/%{gem_name}-%{version}+` \|The rdoc documentation of the Gem. \|`+%{gem_extdir_mri}+` \|`+%{_libdir}/gems/ruby/%{gem_name}-%{version}+` \|The directory for MRI Ruby Gem extensions.
	Interpreter independence and directory macros
	You might 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 <<Applications,Ruby applications Guidelines>> instead.
	RubyGems
	https://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 RPMs in a way that such RPMs fit cleanly with the rest of the distribution and makes 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 referred to with the word "Gem" prefixed, e.g., "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 MUST have `BuildRequires: rubygems-devel` to pull in the macros needed to build.
	There SHOULD NOT be any rubygem `Requires` nor `Provides` listed, since those are autogenerated.
	There SHOULD NOT be `Requires: ruby(release)`, unless you want to explicitly specify Ruby version compatibility. The automatically generated dependency on RubyGems (`Requires: ruby(rubygems)`) is enough.

Loading…

None

Source string added

English 0 characters edited

4 years ago

Browse all string changes

Things to check

Multiple failing checks

Following checks are failing:
Unchanged translation: French, Finnish

Reset

Glossary

English	English
No related strings found in the glossary.

1000166 String information

Source string description

type: Title ==

Flags

no-wrap, read-only

Source string location

./pages/Ruby.adoc:124

String age

4 years ago

Last updated

a year ago

Source string age

4 years ago

Translation file

pot/master/pages/Ruby.pot, string 23

Shortcut	Action
`?`	Open available keyboard shortcuts.
`Alt` + `Home`	Navigate to the first translation in the current search.
`Alt` + `End`	Navigate to the last translation in the current search.
`Alt` + `PageUp` or `Ctrl` + `↑` or `Alt` + `↑` or `Cmd` + `↑` or	Navigate to the last translation in the current search.
`Alt` + `PageDown` or `Ctrl` + `↓` or `Alt` + `↓` or `Cmd` + `↓` or	Navigate to the next translation in the current search.
`Ctrl` + `Enter` or `Cmd` + `Enter`	Submit current form; this works the same as pressing Save and continue while editing translation.
`Ctrl` + `Shift` + `Enter` or `Cmd` + `Shift` +`Enter`	Unmark translation as Needing edit and submit it.
`Alt` + `Enter` or `Option` + `Enter`	Submit the string as a suggestion; this works the same as pressing Suggest while editing translation.
`Ctrl` + `E` or `Cmd` + `E`	Focus on translation editor.
`Ctrl` + `U` or `Cmd` + `U`	Focus on comment editor.
`Ctrl` + `M` or `Cmd` + `M`	Shows Automatic suggestions tab.
`Ctrl` + `1` to `Ctrl` + `9` or `Cmd` + `1` to `Cmd` + `9`	Copies placeable of a given number from source string.
`Ctrl` + `M` followed by `1` to `9` or `Cmd` + `M` followed by `1` to `9`	Copy the machine translation of a given number to current translation.
`Ctrl` + `I` followed by `1` to `9` or `Cmd` + `I` followed by `1` to `9`	Ignore one item in the list of failing checks.
`Ctrl` + `J` or `Cmd` + `J`	Shows the Nearby strings tab.
`Ctrl` + `S` or `Cmd` + `S`	Focus on search field.
`Ctrl` + `O` or `Cmd` + `O`	Copy the source string.
`Ctrl` + `Y` or `Cmd` + `Y`	Toggle the Needs editing checkbox.
`→`	Browse the next translation string.
`←`	Browse the previous translation string.