/[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.5 Revision 1.37
1# Copyright 1999-2004 Gentoo Foundation 1# Copyright 1999-2009 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.5 2009/12/06 13:01:26 graaff Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/ruby-ng.eclass,v 1.37 2011/07/22 09:10:22 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#
31# 31#
32# * each_ruby_configure 32# * each_ruby_configure
33# * all_ruby_configure 33# * all_ruby_configure
34 34
35# @ECLASS-VARIABLE: USE_RUBY 35# @ECLASS-VARIABLE: USE_RUBY
36# @REQUIRED
36# @DESCRIPTION: 37# @DESCRIPTION:
37# This variable contains a space separated list of targets (see above) a package 38# 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 39# is compatible to. It must be set before the `inherit' call. There is no
39# default. All ebuilds are expected to set this variable. 40# default. All ebuilds are expected to set this variable.
40 41
41# @ECLASS-VARIABLE: RUBY_PATCHES 42# @ECLASS-VARIABLE: RUBY_PATCHES
43# @DEFAULT_UNSET
42# @DESCRIPTION: 44# @DESCRIPTION:
43# A String or Array of filenames of patches to apply to all implementations. 45# A String or Array of filenames of patches to apply to all implementations.
44 46
45# @ECLASS-VARIABLE: RUBY_OPTIONAL 47# @ECLASS-VARIABLE: RUBY_OPTIONAL
46# @DESCRIPTION: 48# @DESCRIPTION:
47# Set the value to "yes" to make the dependency on a Ruby interpreter optional. 49# Set the value to "yes" to make the dependency on a Ruby interpreter optional.
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.
48 71
49inherit eutils toolchain-funcs 72inherit eutils 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
110 done 137 done
111 138
112 echo "[${res%,}]" 139 echo "[${res%,}]"
113} 140}
114 141
142_ruby_atoms_samelib_generic() {
143 eshopts_push -o noglob
144 echo "RUBYTARGET? ("
145 for token in $*; do
146 case "$token" in
147 "||" | "(" | ")" | *"?")
148 echo "${token}" ;;
149 *])
150 echo "${token%[*}[RUBYTARGET,${token/*[}" ;;
151 *)
152 echo "${token}[RUBYTARGET]" ;;
153 esac
154 done
155 echo ")"
156 eshopts_pop
157}
158
159# @FUNCTION: ruby_implementation_command
160# @RETURN: the path to the given ruby implementation
161# @DESCRIPTION:
162# Not all implementations have the same command basename as the
163# target; namely Ruby Enterprise 1.8 uses ree18 and rubyee18
164# respectively. This function translate between the two
115_ruby_implementation_depend() { 165ruby_implementation_command() {
116 echo "ruby_targets_${1}? ( ${2}[ruby_targets_${1}] )" 166 local _ruby_name=$1
117}
118 167
119_ruby_add_bdepend() { 168 # Add all USE_RUBY values where the flag name diverts from the binary here
120 local atom=$1 169 case $1 in
170 ree18)
171 _ruby_name=rubyee18
172 ;;
173 esac
174
175 echo $(type -p ${_ruby_name} 2>/dev/null)
176}
177
178_ruby_atoms_samelib() {
179 local atoms=$(_ruby_atoms_samelib_generic "$*")
180
181 for _ruby_implementation in $USE_RUBY; do
182 echo "${atoms//RUBYTARGET/ruby_targets_${_ruby_implementation}}"
183 done
184}
185
186_ruby_wrap_conditions() {
121 local conditions=$2 187 local conditions="$1"
188 local atoms="$2"
122 189
123 for condition in $conditions; do 190 for condition in $conditions; do
124 atom="${condition}? ( ${atom} )" 191 atoms="${condition}? ( ${atoms} )"
125 done 192 done
126 193
127 DEPEND="${DEPEND} ${atom}" 194 echo "$atoms"
128 RDEPEND="${RDEPEND}"
129}
130
131_ruby_add_rdepend() {
132 local atom=$1
133 local conditions=$2
134
135 for condition in $conditions; do
136 atom="${condition}? ( ${atom} )"
137 done
138
139 RDEPEND="${RDEPEND} ${atom}"
140 _ruby_add_bdepend "$atom" test
141} 195}
142 196
143# @FUNCTION: ruby_add_rdepend 197# @FUNCTION: ruby_add_rdepend
144# @USAGE: [conditions] atom 198# @USAGE: dependencies
145# @DESCRIPTION: 199# @DESCRIPTION:
146# Adds the specified atom(s) with optional use condition(s) to 200# Adds the specified dependencies, with use condition(s) to RDEPEND,
147# RDEPEND, taking the current set of ruby targets into account. This 201# taking the current set of ruby targets into account. This makes sure
148# makes sure that all ruby dependencies of the package are installed 202# that all ruby dependencies of the package are installed for the same
149# for the same ruby targets. Use this function for all ruby 203# ruby targets. Use this function for all ruby dependencies instead of
150# dependencies instead of setting RDEPEND yourself. Both atom and 204# setting RDEPEND yourself. The list of atoms uses the same syntax as
151# conditions can be a space-separated list of atoms or conditions. 205# normal dependencies.
206#
207# Note: runtime dependencies are also added as build-time test
208# dependencies.
152ruby_add_rdepend() { 209ruby_add_rdepend() {
153 local atoms=
154 local conditions=
155 case $# in 210 case $# in
156 1) 211 1) ;;
157 atoms=$1
158 ;;
159 2) 212 2)
160 conditions=$1 213 [[ "${GENTOO_DEV}" == "yes" ]] && eqawarn "You can now use the usual syntax in ruby_add_rdepend for $CATEGORY/$PF"
161 atoms=$2 214 ruby_add_rdepend "$(_ruby_wrap_conditions "$1" "$2")"
215 return
162 ;; 216 ;;
163 *) 217 *)
164 die "bad number of arguments to $0" 218 die "bad number of arguments to $0"
165 ;; 219 ;;
166 esac 220 esac
167 221
168 for atom in $atoms; do 222 local dependency=$(_ruby_atoms_samelib "$1")
169 _ruby_add_rdepend "${atom}$(ruby_samelib)" "$conditions" 223
170 done 224 RDEPEND="${RDEPEND} $dependency"
225
226 # Add the dependency as a test-dependency since we're going to
227 # execute the code during test phase.
228 DEPEND="${DEPEND} test? ( ${dependency} )"
229 has test "$IUSE" || IUSE="${IUSE} test"
171} 230}
172 231
173# @FUNCTION: ruby_add_bdepend 232# @FUNCTION: ruby_add_bdepend
174# @USAGE: [conditions] atom 233# @USAGE: dependencies
175# @DESCRIPTION: 234# @DESCRIPTION:
176# Adds the specified atom(s) with optional use condition(s) to both 235# Adds the specified dependencies, with use condition(s) to DEPEND,
177# DEPEND and RDEPEND, taking the current set of ruby targets into 236# taking the current set of ruby targets into account. This makes sure
178# account. This makes sure that all ruby dependencies of the package 237# that all ruby dependencies of the package are installed for the same
179# are installed for the same ruby targets. Use this function for all 238# ruby targets. Use this function for all ruby dependencies instead of
180# ruby dependencies instead of setting DEPEND and RDEPEND 239# setting DEPEND yourself. The list of atoms uses the same syntax as
181# yourself. Both atom and conditions can be a space-separated list of 240# normal dependencies.
182# atoms or conditions.
183ruby_add_bdepend() { 241ruby_add_bdepend() {
184 local atoms=
185 local conditions=
186 case $# in 242 case $# in
187 1) 243 1) ;;
188 atoms=$1
189 ;;
190 2) 244 2)
191 conditions=$1 245 [[ "${GENTOO_DEV}" == "yes" ]] && eqawarn "You can now use the usual syntax in ruby_add_bdepend for $CATEGORY/$PF"
192 atoms=$2 246 ruby_add_bdepend "$(_ruby_wrap_conditions "$1" "$2")"
247 return
193 ;; 248 ;;
194 *) 249 *)
195 die "bad number of arguments to $0" 250 die "bad number of arguments to $0"
196 ;; 251 ;;
197 esac 252 esac
198 253
199 for atom in $atoms; do 254 local dependency=$(_ruby_atoms_samelib "$1")
200 _ruby_add_bdepend "${atom}$(ruby_samelib)" "$conditions" 255
201 done 256 DEPEND="${DEPEND} $dependency"
257 RDEPEND="${RDEPEND}"
202} 258}
259
260# @FUNCTION: ruby_get_use_implementations
261# @DESCRIPTION:
262# Gets an array of ruby use targets enabled by the user
263ruby_get_use_implementations() {
264 local i implementation
265 for implementation in ${USE_RUBY}; do
266 use ruby_targets_${implementation} && i+=" ${implementation}"
267 done
268 echo $i
269}
270
271# @FUNCTION: ruby_get_use_targets
272# @DESCRIPTION:
273# Gets an array of ruby use targets that the ebuild sets
274ruby_get_use_targets() {
275 local t implementation
276 for implementation in ${USE_RUBY}; do
277 t+=" ruby_targets_${implementation}"
278 done
279 echo $t
280}
281
282if [[ ${EAPI:-0} -ge 4 && ${RUBY_OPTIONAL} != "yes" ]]; then
283 REQUIRED_USE=" || ( $(ruby_get_use_targets) )"
284fi
203 285
204for _ruby_implementation in $USE_RUBY; do 286for _ruby_implementation in $USE_RUBY; do
205 IUSE="${IUSE} ruby_targets_${_ruby_implementation}" 287 IUSE="${IUSE} ruby_targets_${_ruby_implementation}"
206 288
207 # If you specify RUBY_OPTIONAL you also need to take care of 289 # If you specify RUBY_OPTIONAL you also need to take care of
212 fi 294 fi
213done 295done
214 296
215_ruby_invoke_environment() { 297_ruby_invoke_environment() {
216 old_S=${S} 298 old_S=${S}
299 case ${EAPI} in
300 4)
301 if [ -z ${RUBY_S} ]; then
302 sub_S=${P}
303 else
304 sub_S=${RUBY_S}
305 fi
306 ;;
307 *)
217 sub_S=${S#${WORKDIR}} 308 sub_S=${S#${WORKDIR}/}
309 ;;
310 esac
311
312 # Special case, for the always-lovely GitHub fetches. With this,
313 # we allow the star glob to just expand to whatever directory it's
314 # called.
315 if [[ ${sub_S} = *"*"* ]]; then
316 case ${EAPI} in
317 2|3)
318 #The old method of setting S depends on undefined package
319 # manager behaviour, so encourage upgrading to EAPI=4.
320 eqawarn "Using * expansion of S is deprecated. Use EAPI and RUBY_S instead."
321 ;;
322 esac
323 pushd "${WORKDIR}"/all &>/dev/null
324 sub_S=$(eval ls -d ${sub_S} 2>/dev/null)
325 popd &>/dev/null
326 fi
218 327
219 environment=$1; shift 328 environment=$1; shift
220 329
221 my_WORKDIR="${WORKDIR}"/${environment} 330 my_WORKDIR="${WORKDIR}"/${environment}
222 S="${my_WORKDIR}"/"${sub_S}" 331 S="${my_WORKDIR}"/"${sub_S}"
240 local invoked=no 349 local invoked=no
241 for _ruby_implementation in ${USE_RUBY}; do 350 for _ruby_implementation in ${USE_RUBY}; do
242 # only proceed if it's requested 351 # only proceed if it's requested
243 use ruby_targets_${_ruby_implementation} || continue 352 use ruby_targets_${_ruby_implementation} || continue
244 353
245 RUBY=$(type -p $_ruby_implementation 2>/dev/null) 354 RUBY=$(ruby_implementation_command ${_ruby_implementation})
246 invoked=yes 355 invoked=yes
247 356
248 if [[ -n "$1" ]]; then 357 if [[ -n "$1" ]]; then
249 _ruby_invoke_environment $_ruby_implementation "$@" 358 _ruby_invoke_environment ${_ruby_implementation} "$@"
250 fi 359 fi
251 360
252 unset RUBY 361 unset RUBY
253 done 362 done
254 363
316 # almost every other ebuild. 425 # almost every other ebuild.
317 find . -name '._*' -delete 426 find . -name '._*' -delete
318 427
319 _ruby_invoke_environment all _ruby_apply_patches 428 _ruby_invoke_environment all _ruby_apply_patches
320 429
430 _PHASE="source copy" \
321 _ruby_each_implementation _ruby_source_copy 431 _ruby_each_implementation _ruby_source_copy
322 432
323 if type each_ruby_prepare &>/dev/null; then 433 if type each_ruby_prepare &>/dev/null; then
324 _ruby_each_implementation each_ruby_prepare 434 _ruby_each_implementation each_ruby_prepare
325 fi 435 fi
326} 436}
360 type all_ruby_test &>/dev/null && \ 470 type all_ruby_test &>/dev/null && \
361 _ruby_invoke_environment all all_ruby_test 471 _ruby_invoke_environment all all_ruby_test
362} 472}
363 473
364_each_ruby_check_install() { 474_each_ruby_check_install() {
475 local scancmd=scanelf
476 # we have a Mach-O object here
477 [[ ${CHOST} == *-darwin ]] && scancmd=scanmacho
478
479 has "${EAPI}" 2 && ! use prefix && EPREFIX=
480
365 local libruby_basename=$(${RUBY} -rrbconfig -e 'puts Config::CONFIG["LIBRUBY_SO"]') 481 local libruby_basename=$(${RUBY} -rrbconfig -e 'puts Config::CONFIG["LIBRUBY_SO"]')
366 local libruby_soname=$(scanelf -qS "/usr/$(get_libdir)/${libruby_basename}" | awk '{ print $1 }') 482 local libruby_soname=$(basename $(${scancmd} -F "%S#F" -qS "${EPREFIX}/usr/$(get_libdir)/${libruby_basename}") 2>/dev/null)
367 local sitedir=$(${RUBY} -rrbconfig -e 'puts Config::CONFIG["sitedir"]') 483 local sitedir=$(${RUBY} -rrbconfig -e 'puts Config::CONFIG["sitedir"]')
368 local sitelibdir=$(${RUBY} -rrbconfig -e 'puts Config::CONFIG["sitelibdir"]') 484 local sitelibdir=$(${RUBY} -rrbconfig -e 'puts Config::CONFIG["sitelibdir"]')
369 485
370 # Look for wrong files in sitedir 486 # Look for wrong files in sitedir
371 if [[ -d "${D}${sitedir}" ]]; then 487 # if [[ -d "${D}${sitedir}" ]]; then
372 local f=$(find "${D}${sitedir}" -mindepth 1 -maxdepth 1 -not -wholename "${D}${sitelibdir}") 488 # local f=$(find "${D}${sitedir}" -mindepth 1 -maxdepth 1 -not -wholename "${D}${sitelibdir}")
373 if [[ -n ${f} ]]; then 489 # if [[ -n ${f} ]]; then
374 eerror "Found files in sitedir, outsite sitelibdir:" 490 # eerror "Found files in sitedir, outsite sitelibdir:"
375 eerror "${f}" 491 # eerror "${f}"
376 die "Misplaced files in sitedir" 492 # die "Misplaced files in sitedir"
377 fi 493 # fi
378 fi 494 # fi
379 495
380 # The current implementation lacks libruby (i.e.: jruby) 496 # The current implementation lacks libruby (i.e.: jruby)
381 [[ -z ${libruby_soname} ]] && return 0 497 [[ -z ${libruby_soname} ]] && return 0
382 498
383 scanelf -qnR "${D}${sitedir}" \ 499 # Check also the gems directory, since we could be installing compiled
500 # extensions via ruby-fakegem; make sure to check only in sitelibdir, since
501 # that's what changes between two implementations (otherwise you'd get false
502 # positives now that Ruby 1.9.2 installs with the same sitedir as 1.8)
503 ${scancmd} -qnR "${D}${sitelibdir}" "${D}${sitelibdir/site_ruby/gems}" \
384 | fgrep -v "${libruby_soname}" \ 504 | fgrep -v "${libruby_soname}" \
505 | grep -E -v "${RUBY_QA_ALLOWED_LIBS}" \
385 > "${T}"/ruby-ng-${_ruby_implementation}-mislink.log 506 > "${T}"/ruby-ng-${_ruby_implementation}-mislink.log
386 507
387 if [[ -s "${T}"/ruby-ng-${_ruby_implementation}-mislink.log ]]; then 508 if [[ -s "${T}"/ruby-ng-${_ruby_implementation}-mislink.log ]]; then
388 ewarn "Extensions installed for ${_ruby_implementation} with missing links to ${libruby}" 509 ewarn "Extensions installed for ${_ruby_implementation} with missing links to ${libruby_soname}"
389 ewarn $(< "${T}"/ruby-ng-${_ruby_implementation}-mislink.log ) 510 ewarn $(< "${T}"/ruby-ng-${_ruby_implementation}-mislink.log )
390 die "Missing links to ${libruby}" 511 die "Missing links to ${libruby_soname}"
391 fi 512 fi
392} 513}
393 514
394# @FUNCTION: ruby-ng_src_install 515# @FUNCTION: ruby-ng_src_install
395# @DESCRIPTION: 516# @DESCRIPTION:
404 525
405 _PHASE="check install" \ 526 _PHASE="check install" \
406 _ruby_each_implementation _each_ruby_check_install 527 _ruby_each_implementation _each_ruby_check_install
407} 528}
408 529
530# @FUNCTION: ruby_rbconfig_value
531# @USAGE: rbconfig item
532# @RETURN: Returns the value of the given rbconfig item of the Ruby interpreter in ${RUBY}.
533ruby_rbconfig_value() {
534 echo $(${RUBY} -rrbconfig -e "puts Config::CONFIG['$1']")
535}
536
409# @FUNCTION: doruby 537# @FUNCTION: doruby
410# @USAGE: file [file...] 538# @USAGE: file [file...]
411# @DESCRIPTION: 539# @DESCRIPTION:
412# Installs the specified file(s) into the sitelibdir of the Ruby interpreter in ${RUBY}. 540# Installs the specified file(s) into the sitelibdir of the Ruby interpreter in ${RUBY}.
413doruby() { 541doruby() {
414 [[ -z ${RUBY} ]] && die "\$RUBY is not set" 542 [[ -z ${RUBY} ]] && die "\$RUBY is not set"
543 has "${EAPI}" 2 && ! use prefix && EPREFIX=
415 ( # don't want to pollute calling env 544 ( # don't want to pollute calling env
416 insinto $(${RUBY} -rrbconfig -e 'print Config::CONFIG["sitelibdir"]') 545 sitelibdir=$(ruby_rbconfig_value 'sitelibdir')
546 insinto ${sitelibdir#${EPREFIX}}
417 insopts -m 0644 547 insopts -m 0644
418 doins "$@" 548 doins "$@"
419 ) || die "failed to install $@" 549 ) || die "failed to install $@"
420} 550}
421 551
426} 556}
427 557
428# @FUNCTION: ruby_get_hdrdir 558# @FUNCTION: ruby_get_hdrdir
429# @RETURN: The location of the header files belonging to the Ruby interpreter in ${RUBY}. 559# @RETURN: The location of the header files belonging to the Ruby interpreter in ${RUBY}.
430ruby_get_hdrdir() { 560ruby_get_hdrdir() {
431 local rubyhdrdir=$(${RUBY} -rrbconfig -e 'puts Config::CONFIG["rubyhdrdir"]') 561 local rubyhdrdir=$(ruby_rbconfig_value 'rubyhdrdir')
432 562
433 if [[ "${rubyhdrdir}" = "nil" ]] ; then 563 if [[ "${rubyhdrdir}" = "nil" ]] ; then
434 rubyhdrdir=$(${RUBY} -rrbconfig -e 'puts Config::CONFIG["archdir"]') 564 rubyhdrdir=$(ruby_rbconfig_value 'archdir')
435 fi 565 fi
436 566
437 echo "${rubyhdrdir}" 567 echo "${rubyhdrdir}"
438} 568}
569
570# @FUNCTION: ruby_get_version
571# @RETURN: The version of the Ruby interpreter in ${RUBY}, or what 'ruby' points to.
572ruby_get_version() {
573 local ruby=${RUBY:-$(type -p ruby 2>/dev/null)}
574
575 echo $(${ruby} -e 'puts RUBY_VERSION')
576}
577
578# @FUNCTION: ruby_get_implementation
579# @RETURN: The implementation of the Ruby interpreter in ${RUBY}, or what 'ruby' points to.
580ruby_get_implementation() {
581 local ruby=${RUBY:-$(type -p ruby 2>/dev/null)}
582
583 case $(${ruby} --version) in
584 *Enterprise*)
585 echo "ree"
586 ;;
587 *jruby*)
588 echo "jruby"
589 ;;
590 *)
591 echo "mri"
592 ;;
593 esac
594}

Legend:
Removed from v.1.5  
changed lines
  Added in v.1.37

  ViewVC Help
Powered by ViewVC 1.1.20