/[gentoo-x86]/eclass/ruby-ng.eclass
Gentoo

Diff of /eclass/ruby-ng.eclass

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.16 Revision 1.43
1# Copyright 1999-2009 Gentoo Foundation 1# Copyright 1999-2011 Gentoo Foundation
2# Distributed under the terms of the GNU General Public License v2 2# Distributed under the terms of the GNU General Public License v2
3# $Header: /var/cvsroot/gentoo-x86/eclass/ruby-ng.eclass,v 1.16 2010/05/22 12:18:07 flameeyes Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/ruby-ng.eclass,v 1.43 2011/10/24 18:20:05 graaff Exp $
4# 4
5# @ECLASS: ruby-ng.eclass 5# @ECLASS: ruby-ng.eclass
6# @MAINTAINER: 6# @MAINTAINER:
7# Ruby herd <ruby@gentoo.org> 7# Ruby herd <ruby@gentoo.org>
8# 8# @AUTHOR:
9# Author: Diego E. Pettenò <flameeyes@gentoo.org> 9# Author: Diego E. Pettenò <flameeyes@gentoo.org>
10#
11# Author: Alex Legler <a3li@gentoo.org> 10# Author: Alex Legler <a3li@gentoo.org>
12#
13# Author: Hans de Graaff <graaff@gentoo.org> 11# Author: Hans de Graaff <graaff@gentoo.org>
14#
15# @BLURB: An eclass for installing Ruby packages with proper support for multiple Ruby slots. 12# @BLURB: An eclass for installing Ruby packages with proper support for multiple Ruby slots.
16# @DESCRIPTION: 13# @DESCRIPTION:
17# The Ruby eclass is designed to allow an easier installation of Ruby packages 14# The Ruby eclass is designed to allow an easier installation of Ruby packages
18# and their incorporation into the Gentoo Linux system. 15# and their incorporation into the Gentoo Linux system.
19# 16#
20# Currently available targets are: 17# Currently available targets are:
21# * ruby18 - Ruby (MRI) 1.8.x 18# * ruby18 - Ruby (MRI) 1.8.x
22# * ruby19 - Ruby (MRI) 1.9.x 19# * ruby19 - Ruby (MRI) 1.9.x
23# * ree18 - Ruby Enterprise Edition 1.8.x 20# * ree18 - Ruby Enterprise Edition 1.8.x
24# * jruby - JRuby 21# * jruby - JRuby
22# * rbx - Rubinius
25# 23#
26# This eclass does not define the implementation of the configure, 24# This eclass does not define the implementation of the configure,
27# compile, test, or install phases. Instead, the default phases are 25# compile, test, or install phases. Instead, the default phases are
28# used. Specific implementations of these phases can be provided in 26# used. Specific implementations of these phases can be provided in
29# the ebuild either to be run for each Ruby implementation, or for all 27# the ebuild either to be run for each Ruby implementation, or for all
31# 29#
32# * each_ruby_configure 30# * each_ruby_configure
33# * all_ruby_configure 31# * all_ruby_configure
34 32
35# @ECLASS-VARIABLE: USE_RUBY 33# @ECLASS-VARIABLE: USE_RUBY
34# @REQUIRED
36# @DESCRIPTION: 35# @DESCRIPTION:
37# This variable contains a space separated list of targets (see above) a package 36# This variable contains a space separated list of targets (see above) a package
38# is compatible to. It must be set before the `inherit' call. There is no 37# is compatible to. It must be set before the `inherit' call. There is no
39# default. All ebuilds are expected to set this variable. 38# default. All ebuilds are expected to set this variable.
40 39
41# @ECLASS-VARIABLE: RUBY_PATCHES 40# @ECLASS-VARIABLE: RUBY_PATCHES
41# @DEFAULT_UNSET
42# @DESCRIPTION: 42# @DESCRIPTION:
43# A String or Array of filenames of patches to apply to all implementations. 43# A String or Array of filenames of patches to apply to all implementations.
44 44
45# @ECLASS-VARIABLE: RUBY_OPTIONAL 45# @ECLASS-VARIABLE: RUBY_OPTIONAL
46# @DESCRIPTION: 46# @DESCRIPTION:
47# Set the value to "yes" to make the dependency on a Ruby interpreter optional. 47# Set the value to "yes" to make the dependency on a Ruby interpreter
48# optional and then ruby_implementations_depend() to help populate
49# DEPEND and RDEPEND.
48 50
51# @ECLASS-VARIABLE: RUBY_S
52# @DEFAULT_UNSET
53# @DESCRIPTION:
54# If defined this variable determines the source directory name after
55# unpacking. This defaults to the name of the package. Note that this
56# variable supports a wildcard mechanism to help with github tarballs
57# that contain the commit hash as part of the directory name.
58
59# @ECLASS-VARIABLE: RUBY_QA_ALLOWED_LIBS
60# @DEFAULT_UNSET
61# @DESCRIPTION:
62# If defined this variable contains a whitelist of shared objects that
63# are allowed to exist even if they don't link to libruby. This avoids
64# the QA check that makes this mandatory. This is most likely not what
65# you are looking for if you get the related "Missing links" QA warning,
66# since the proper fix is almost always to make sure the shared object
67# is linked against libruby. There are cases were this is not the case
68# and the shared object is generic code to be used in some other way
69# (e.g. selenium's firefox driver extension). When set this argument is
70# passed to "grep -E" to remove reporting of these shared objects.
71
49inherit eutils toolchain-funcs 72inherit eutils java-utils-2 toolchain-funcs
50 73
51EXPORT_FUNCTIONS src_unpack src_prepare src_configure src_compile src_test src_install pkg_setup 74EXPORT_FUNCTIONS src_unpack src_prepare src_configure src_compile src_test src_install pkg_setup
52 75
53case ${EAPI} in 76case ${EAPI} in
54 0|1) 77 0|1)
55 die "Unsupported EAPI=${EAPI} (too old) for ruby-ng.eclass" ;; 78 die "Unsupported EAPI=${EAPI} (too old) for ruby-ng.eclass" ;;
56 2) ;; 79 2|3) ;;
80 4)
81 # S is no longer automatically assigned when it doesn't exist.
82 S="${WORKDIR}"
83 ;;
57 *) 84 *)
58 die "Unknown EAPI=${EAPI} for ruby-ng.eclass" 85 die "Unknown EAPI=${EAPI} for ruby-ng.eclass"
59esac 86esac
60 87
61# @FUNCTION: ruby_implementation_depend 88# @FUNCTION: ruby_implementation_depend
85 rubypn="dev-lang/ruby-enterprise" 112 rubypn="dev-lang/ruby-enterprise"
86 rubyslot=":1.8" 113 rubyslot=":1.8"
87 ;; 114 ;;
88 jruby) 115 jruby)
89 rubypn="dev-java/jruby" 116 rubypn="dev-java/jruby"
117 rubyslot=""
118 ;;
119 rbx)
120 rubypn="dev-lang/rubinius"
90 rubyslot="" 121 rubyslot=""
91 ;; 122 ;;
92 *) die "$1: unknown Ruby implementation" 123 *) die "$1: unknown Ruby implementation"
93 esac 124 esac
94 125
110 done 141 done
111 142
112 echo "[${res%,}]" 143 echo "[${res%,}]"
113} 144}
114 145
115_ruby_implementation_depend() {
116 echo "ruby_targets_${1}? ( ${2}[ruby_targets_${1}] )"
117}
118
119_ruby_atoms_samelib() { 146_ruby_atoms_samelib_generic() {
120 local samelib=$(ruby_samelib) 147 eshopts_push -o noglob
121 148 echo "RUBYTARGET? ("
122 for token in $*; do 149 for token in $*; do
123 case "$token" in 150 case "$token" in
124 "||" | "(" | ")" | *"?") 151 "||" | "(" | ")" | *"?")
125 echo "${token}" ;; 152 echo "${token}" ;;
153 *])
154 echo "${token%[*}[RUBYTARGET,${token/*[}" ;;
126 *) 155 *)
127 echo "${token}${samelib}" ;; 156 echo "${token}[RUBYTARGET]" ;;
128 esac 157 esac
158 done
159 echo ")"
160 eshopts_pop
161}
162
163# @FUNCTION: ruby_implementation_command
164# @RETURN: the path to the given ruby implementation
165# @DESCRIPTION:
166# Not all implementations have the same command basename as the
167# target; namely Ruby Enterprise 1.8 uses ree18 and rubyee18
168# respectively. This function translate between the two
169ruby_implementation_command() {
170 local _ruby_name=$1
171
172 # Add all USE_RUBY values where the flag name diverts from the binary here
173 case $1 in
174 ree18)
175 _ruby_name=rubyee18
176 ;;
177 esac
178
179 echo $(type -p ${_ruby_name} 2>/dev/null)
180}
181
182_ruby_atoms_samelib() {
183 local atoms=$(_ruby_atoms_samelib_generic "$*")
184
185 for _ruby_implementation in $USE_RUBY; do
186 echo "${atoms//RUBYTARGET/ruby_targets_${_ruby_implementation}}"
129 done 187 done
130} 188}
131 189
132_ruby_wrap_conditions() { 190_ruby_wrap_conditions() {
133 local conditions="$1" 191 local conditions="$1"
134 local atoms="$2" 192 local atoms="$2"
135 193
136 for condition in $conditions; do 194 for condition in $conditions; do
137 hasq $condition "$IUSE" || IUSE="${IUSE} $condition"
138 atoms="${condition}? ( ${atoms} )" 195 atoms="${condition}? ( ${atoms} )"
139 done 196 done
140 197
141 echo "$atoms" 198 echo "$atoms"
142} 199}
170 227
171 RDEPEND="${RDEPEND} $dependency" 228 RDEPEND="${RDEPEND} $dependency"
172 229
173 # Add the dependency as a test-dependency since we're going to 230 # Add the dependency as a test-dependency since we're going to
174 # execute the code during test phase. 231 # execute the code during test phase.
175 DEPEND="${DEPEND} $(_ruby_wrap_conditions test "${dependency}")" 232 DEPEND="${DEPEND} test? ( ${dependency} )"
233 has test "$IUSE" || IUSE="${IUSE} test"
176} 234}
177 235
178# @FUNCTION: ruby_add_bdepend 236# @FUNCTION: ruby_add_bdepend
179# @USAGE: dependencies 237# @USAGE: dependencies
180# @DESCRIPTION: 238# @DESCRIPTION:
198 esac 256 esac
199 257
200 local dependency=$(_ruby_atoms_samelib "$1") 258 local dependency=$(_ruby_atoms_samelib "$1")
201 259
202 DEPEND="${DEPEND} $dependency" 260 DEPEND="${DEPEND} $dependency"
261 RDEPEND="${RDEPEND}"
203} 262}
204 263
264# @FUNCTION: ruby_get_use_implementations
265# @DESCRIPTION:
266# Gets an array of ruby use targets enabled by the user
267ruby_get_use_implementations() {
268 local i implementation
269 for implementation in ${USE_RUBY}; do
270 use ruby_targets_${implementation} && i+=" ${implementation}"
271 done
272 echo $i
273}
274
275# @FUNCTION: ruby_get_use_targets
276# @DESCRIPTION:
277# Gets an array of ruby use targets that the ebuild sets
278ruby_get_use_targets() {
279 local t implementation
280 for implementation in ${USE_RUBY}; do
281 t+=" ruby_targets_${implementation}"
282 done
283 echo $t
284}
285
286if [[ ${EAPI:-0} -ge 4 && ${RUBY_OPTIONAL} != "yes" ]]; then
287 REQUIRED_USE=" || ( $(ruby_get_use_targets) )"
288fi
289
290# @FUNCTION: ruby_implementations_depend
291# @RETURN: Dependencies suitable for injection into DEPEND and RDEPEND.
292# @DESCRIPTION:
293# Produces the dependency string for the various implementations of ruby
294# which the package is being built against. This should not be used when
295# RUBY_OPTIONAL is unset but must be used if RUBY_OPTIONAL=yes. Do not
296# confuse this function with ruby_implementation_depend().
297#
298# @EXAMPLE:
299# EAPI=4
300# RUBY_OPTIONAL=yes
301#
302# inherit ruby-ng
303# ...
304# DEPEND="ruby? ( $(ruby_implementations_depend) )"
305# RDEPEND="${DEPEND}"
306ruby_implementations_depend() {
307 local depend
308 for _ruby_implementation in ${USE_RUBY}; do
309 depend="${depend}${depend+ }ruby_targets_${_ruby_implementation}? ( $(ruby_implementation_depend $_ruby_implementation) )"
310 done
311 echo "${depend}"
312}
313
205for _ruby_implementation in $USE_RUBY; do 314for _ruby_implementation in ${USE_RUBY}; do
206 IUSE="${IUSE} ruby_targets_${_ruby_implementation}" 315 IUSE="${IUSE} ruby_targets_${_ruby_implementation}"
207
208 # If you specify RUBY_OPTIONAL you also need to take care of
209 # ruby useflag and dependency.
210 if [[ ${RUBY_OPTIONAL} != "yes" ]]; then
211 DEPEND="${DEPEND} ruby_targets_${_ruby_implementation}? ( $(ruby_implementation_depend $_ruby_implementation) )"
212 RDEPEND="${RDEPEND} ruby_targets_${_ruby_implementation}? ( $(ruby_implementation_depend $_ruby_implementation) )"
213 fi
214done 316done
317# If you specify RUBY_OPTIONAL you also need to take care of
318# ruby useflag and dependency.
319if [[ ${RUBY_OPTIONAL} != yes ]]; then
320 DEPEND="${DEPEND} $(ruby_implementations_depend)"
321 RDEPEND="${RDEPEND} $(ruby_implementations_depend)"
322fi
215 323
216_ruby_invoke_environment() { 324_ruby_invoke_environment() {
217 old_S=${S} 325 old_S=${S}
326 case ${EAPI} in
327 4)
328 if [ -z ${RUBY_S} ]; then
329 sub_S=${P}
330 else
331 sub_S=${RUBY_S}
332 fi
333 ;;
334 *)
218 sub_S=${S#${WORKDIR}/} 335 sub_S=${S#${WORKDIR}/}
336 ;;
337 esac
219 338
220 # Special case, for the always-lovely GitHub fetches. With this, 339 # Special case, for the always-lovely GitHub fetches. With this,
221 # we allow the star glob to just expand to whatever directory it's 340 # we allow the star glob to just expand to whatever directory it's
222 # called. 341 # called.
223 if [[ ${sub_S} = *"*" ]]; then 342 if [[ ${sub_S} = *"*"* ]]; then
343 case ${EAPI} in
344 2|3)
345 #The old method of setting S depends on undefined package
346 # manager behaviour, so encourage upgrading to EAPI=4.
347 eqawarn "Using * expansion of S is deprecated. Use EAPI and RUBY_S instead."
348 ;;
349 esac
224 pushd "${WORKDIR}"/all &>/dev/null 350 pushd "${WORKDIR}"/all &>/dev/null
225 sub_S=$(eval ls -d ${sub_S} 2>/dev/null) 351 sub_S=$(eval ls -d ${sub_S} 2>/dev/null)
226 popd &>/dev/null 352 popd &>/dev/null
227 fi 353 fi
228 354
250 local invoked=no 376 local invoked=no
251 for _ruby_implementation in ${USE_RUBY}; do 377 for _ruby_implementation in ${USE_RUBY}; do
252 # only proceed if it's requested 378 # only proceed if it's requested
253 use ruby_targets_${_ruby_implementation} || continue 379 use ruby_targets_${_ruby_implementation} || continue
254 380
255 local _ruby_name=$_ruby_implementation 381 RUBY=$(ruby_implementation_command ${_ruby_implementation})
256
257 # Add all USE_RUBY values where the flag name diverts from the binary here
258 case $_ruby_implementation in
259 ree18)
260 _ruby_name=rubyee18
261 ;;
262 esac
263
264 RUBY=$(type -p $_ruby_name 2>/dev/null)
265 invoked=yes 382 invoked=yes
266 383
267 if [[ -n "$1" ]]; then 384 if [[ -n "$1" ]]; then
268 _ruby_invoke_environment $_ruby_implementation "$@" 385 _ruby_invoke_environment ${_ruby_implementation} "$@"
269 fi 386 fi
270 387
271 unset RUBY 388 unset RUBY
272 done 389 done
273 390
280ruby-ng_pkg_setup() { 397ruby-ng_pkg_setup() {
281 # This only checks that at least one implementation is present 398 # This only checks that at least one implementation is present
282 # before doing anything; by leaving the parameters empty we know 399 # before doing anything; by leaving the parameters empty we know
283 # it's a special case. 400 # it's a special case.
284 _ruby_each_implementation 401 _ruby_each_implementation
402
403 has ruby_targets_jruby ${IUSE} && use ruby_targets_jruby && java-pkg_setup-vm
285} 404}
286 405
287# @FUNCTION: ruby-ng_src_unpack 406# @FUNCTION: ruby-ng_src_unpack
288# @DESCRIPTION: 407# @DESCRIPTION:
289# Unpack the source archive. 408# Unpack the source archive.
380 type all_ruby_test &>/dev/null && \ 499 type all_ruby_test &>/dev/null && \
381 _ruby_invoke_environment all all_ruby_test 500 _ruby_invoke_environment all all_ruby_test
382} 501}
383 502
384_each_ruby_check_install() { 503_each_ruby_check_install() {
504 local scancmd=scanelf
505 # we have a Mach-O object here
506 [[ ${CHOST} == *-darwin ]] && scancmd=scanmacho
507
508 has "${EAPI}" 2 && ! use prefix && EPREFIX=
509
385 local libruby_basename=$(${RUBY} -rrbconfig -e 'puts Config::CONFIG["LIBRUBY_SO"]') 510 local libruby_basename=$(${RUBY} -rrbconfig -e 'puts RbConfig::CONFIG["LIBRUBY_SO"]')
386 local libruby_soname=$(scanelf -qS "/usr/$(get_libdir)/${libruby_basename}" | awk '{ print $1 }') 511 local libruby_soname=$(basename $(${scancmd} -F "%S#F" -qS "${EPREFIX}/usr/$(get_libdir)/${libruby_basename}") 2>/dev/null)
387 local sitedir=$(${RUBY} -rrbconfig -e 'puts Config::CONFIG["sitedir"]') 512 local sitedir=$(${RUBY} -rrbconfig -e 'puts RbConfig::CONFIG["sitedir"]')
388 local sitelibdir=$(${RUBY} -rrbconfig -e 'puts Config::CONFIG["sitelibdir"]') 513 local sitelibdir=$(${RUBY} -rrbconfig -e 'puts RbConfig::CONFIG["sitelibdir"]')
389 514
390 # Look for wrong files in sitedir 515 # Look for wrong files in sitedir
391 if [[ -d "${D}${sitedir}" ]]; then 516 # if [[ -d "${D}${sitedir}" ]]; then
392 local f=$(find "${D}${sitedir}" -mindepth 1 -maxdepth 1 -not -wholename "${D}${sitelibdir}") 517 # local f=$(find "${D}${sitedir}" -mindepth 1 -maxdepth 1 -not -wholename "${D}${sitelibdir}")
393 if [[ -n ${f} ]]; then 518 # if [[ -n ${f} ]]; then
394 eerror "Found files in sitedir, outsite sitelibdir:" 519 # eerror "Found files in sitedir, outsite sitelibdir:"
395 eerror "${f}" 520 # eerror "${f}"
396 die "Misplaced files in sitedir" 521 # die "Misplaced files in sitedir"
397 fi 522 # fi
398 fi 523 # fi
399 524
400 # The current implementation lacks libruby (i.e.: jruby) 525 # The current implementation lacks libruby (i.e.: jruby)
401 [[ -z ${libruby_soname} ]] && return 0 526 [[ -z ${libruby_soname} ]] && return 0
402 527
403 scanelf -qnR "${D}${sitedir}" \ 528 # Check also the gems directory, since we could be installing compiled
529 # extensions via ruby-fakegem; make sure to check only in sitelibdir, since
530 # that's what changes between two implementations (otherwise you'd get false
531 # positives now that Ruby 1.9.2 installs with the same sitedir as 1.8)
532 ${scancmd} -qnR "${D}${sitelibdir}" "${D}${sitelibdir/site_ruby/gems}" \
404 | fgrep -v "${libruby_soname}" \ 533 | fgrep -v "${libruby_soname}" \
534 | grep -E -v "${RUBY_QA_ALLOWED_LIBS}" \
405 > "${T}"/ruby-ng-${_ruby_implementation}-mislink.log 535 > "${T}"/ruby-ng-${_ruby_implementation}-mislink.log
406 536
407 if [[ -s "${T}"/ruby-ng-${_ruby_implementation}-mislink.log ]]; then 537 if [[ -s "${T}"/ruby-ng-${_ruby_implementation}-mislink.log ]]; then
408 ewarn "Extensions installed for ${_ruby_implementation} with missing links to ${libruby_soname}" 538 ewarn "Extensions installed for ${_ruby_implementation} with missing links to ${libruby_soname}"
409 ewarn $(< "${T}"/ruby-ng-${_ruby_implementation}-mislink.log ) 539 ewarn $(< "${T}"/ruby-ng-${_ruby_implementation}-mislink.log )
428 558
429# @FUNCTION: ruby_rbconfig_value 559# @FUNCTION: ruby_rbconfig_value
430# @USAGE: rbconfig item 560# @USAGE: rbconfig item
431# @RETURN: Returns the value of the given rbconfig item of the Ruby interpreter in ${RUBY}. 561# @RETURN: Returns the value of the given rbconfig item of the Ruby interpreter in ${RUBY}.
432ruby_rbconfig_value() { 562ruby_rbconfig_value() {
433 echo $(${RUBY} -rrbconfig -e "puts Config::CONFIG['$1']") 563 echo $(${RUBY} -rrbconfig -e "puts RbConfig::CONFIG['$1']")
434} 564}
435 565
436# @FUNCTION: doruby 566# @FUNCTION: doruby
437# @USAGE: file [file...] 567# @USAGE: file [file...]
438# @DESCRIPTION: 568# @DESCRIPTION:
439# Installs the specified file(s) into the sitelibdir of the Ruby interpreter in ${RUBY}. 569# Installs the specified file(s) into the sitelibdir of the Ruby interpreter in ${RUBY}.
440doruby() { 570doruby() {
441 [[ -z ${RUBY} ]] && die "\$RUBY is not set" 571 [[ -z ${RUBY} ]] && die "\$RUBY is not set"
572 has "${EAPI}" 2 && ! use prefix && EPREFIX=
442 ( # don't want to pollute calling env 573 ( # don't want to pollute calling env
443 insinto $(ruby_rbconfig_value 'sitelibdir') 574 sitelibdir=$(ruby_rbconfig_value 'sitelibdir')
575 insinto ${sitelibdir#${EPREFIX}}
444 insopts -m 0644 576 insopts -m 0644
445 doins "$@" 577 doins "$@"
446 ) || die "failed to install $@" 578 ) || die "failed to install $@"
447} 579}
448 580
449# @FUNCTION: ruby_get_libruby 581# @FUNCTION: ruby_get_libruby
450# @RETURN: The location of libruby*.so belonging to the Ruby interpreter in ${RUBY}. 582# @RETURN: The location of libruby*.so belonging to the Ruby interpreter in ${RUBY}.
451ruby_get_libruby() { 583ruby_get_libruby() {
452 ${RUBY} -rrbconfig -e 'puts File.join(Config::CONFIG["libdir"], Config::CONFIG["LIBRUBY"])' 584 ${RUBY} -rrbconfig -e 'puts File.join(RbConfig::CONFIG["libdir"], RbConfig::CONFIG["LIBRUBY"])'
453} 585}
454 586
455# @FUNCTION: ruby_get_hdrdir 587# @FUNCTION: ruby_get_hdrdir
456# @RETURN: The location of the header files belonging to the Ruby interpreter in ${RUBY}. 588# @RETURN: The location of the header files belonging to the Ruby interpreter in ${RUBY}.
457ruby_get_hdrdir() { 589ruby_get_hdrdir() {
482 echo "ree" 614 echo "ree"
483 ;; 615 ;;
484 *jruby*) 616 *jruby*)
485 echo "jruby" 617 echo "jruby"
486 ;; 618 ;;
619 *rubinius*)
620 echo "rbx"
621 ;;
487 *) 622 *)
488 echo "mri" 623 echo "mri"
489 ;; 624 ;;
490 esac 625 esac
491} 626}

Legend:
Removed from v.1.16  
changed lines
  Added in v.1.43

  ViewVC Help
Powered by ViewVC 1.1.20