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

Diff of /eclass/ruby-fakegem.eclass

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

Revision 1.28 Revision 1.37
1# Copyright 1999-2009 Gentoo Foundation 1# Copyright 1999-2012 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-fakegem.eclass,v 1.28 2011/03/05 06:58:00 graaff Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/ruby-fakegem.eclass,v 1.37 2012/08/19 07:45:02 graaff Exp $
4# 4
5# @ECLASS: ruby-fakegem.eclass 5# @ECLASS: ruby-fakegem.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# @BLURB: An eclass for installing Ruby packages to behave like RubyGems. 11# @BLURB: An eclass for installing Ruby packages to behave like RubyGems.
14# @DESCRIPTION: 12# @DESCRIPTION:
15# This eclass allows to install arbitrary Ruby libraries (including Gems), 13# This eclass allows to install arbitrary Ruby libraries (including Gems),
16# providing integration into the RubyGems system even for "regular" packages. 14# providing integration into the RubyGems system even for "regular" packages.
17#
18 15
19inherit ruby-ng 16inherit ruby-ng
20 17
21# @ECLASS-VARIABLE: RUBY_FAKEGEM_NAME 18# @ECLASS-VARIABLE: RUBY_FAKEGEM_NAME
22# @DESCRIPTION: 19# @DESCRIPTION:
31# @ECLASS-VARIABLE: RUBY_FAKEGEM_TASK_DOC 28# @ECLASS-VARIABLE: RUBY_FAKEGEM_TASK_DOC
32# @DESCRIPTION: 29# @DESCRIPTION:
33# Specify the rake(1) task to run to generate documentation. 30# Specify the rake(1) task to run to generate documentation.
34# RUBY_FAKEGEM_TASK_DOC="rdoc" 31# RUBY_FAKEGEM_TASK_DOC="rdoc"
35 32
33# @ECLASS-VARIABLE: RUBY_FAKEGEM_RECIPE_TEST
34# @DESCRIPTION:
35# Specify one of the default testing function for ruby-fakegem:
36# - rake (default; see also RUBY_FAKEGEM_TASK_TEST)
37# - rspec (calls ruby-ng_rspec, adds dev-ruby/rspec:2 to the dependencies)
38# - cucumber (calls ruby-ng_cucumber, adds dev-util/cucumber to the
39# dependencies; does not work on JRuby).
40# - none
41# RUBY_FAKEGEM_RECIPE_TEST="rake"
42
36# @ECLASS-VARIABLE: RUBY_FAKEGEM_TASK_TEST 43# @ECLASS-VARIABLE: RUBY_FAKEGEM_TASK_TEST
37# @DESCRIPTION: 44# @DESCRIPTION:
38# Specify the rake(1) task used for executing tests. 45# Specify the rake(1) task used for executing tests. Only valid
46# if RUBY_FAKEGEM_RECIPE_TEST is set to "rake" (the default).
39# RUBY_FAKEGEM_TASK_TEST="test" 47# RUBY_FAKEGEM_TASK_TEST="test"
48
49# @ECLASS-VARIABLE: RUBY_FAKEGEM_RECIPE_DOC
50# @DESCRIPTION:
51# Specify one of the default API doc building function for ruby-fakegem:
52# - rake (default; see also RUBY_FAKEGEM_TASK_DOC)
53# - rdoc (calls `rdoc-2`, adds dev-ruby/rdoc to the dependencies);
54# - none
55# RUBY_FAKEGEM_RECIPE_DOC="rake"
40 56
41# @ECLASS-VARIABLE: RUBY_FAKEGEM_DOCDIR 57# @ECLASS-VARIABLE: RUBY_FAKEGEM_DOCDIR
42# @DESCRIPTION: 58# @DESCRIPTION:
43# Specify the directory under which the documentation is built; 59# Specify the directory under which the documentation is built;
44# if empty no documentation will be installed automatically. 60# if empty no documentation will be installed automatically.
61# Note: if RUBY_FAKEGEM_RECIPE_DOC is set to `rdoc`, this variable is
62# hardwired to `doc`.
45# RUBY_FAKEGEM_DOCDIR="" 63# RUBY_FAKEGEM_DOCDIR=""
46 64
47# @ECLASS-VARIABLE: RUBY_FAKEGEM_EXTRADOC 65# @ECLASS-VARIABLE: RUBY_FAKEGEM_EXTRADOC
48# @DESCRIPTION: 66# @DESCRIPTION:
49# Extra documentation to install (readme, changelogs, …). 67# Extra documentation to install (readme, changelogs, …).
50# RUBY_FAKEGEM_EXTRADOC="" 68# RUBY_FAKEGEM_EXTRADOC=""
51 69
70# @ECLASS-VARIABLE: RUBY_FAKEGEM_DOC_SOURCES
71# @DESCRIPTION:
72# Allow settings defined sources to scan for documentation.
73# This only applies if RUBY_FAKEGEM_DOC_TASK is set to `rdoc`.
74# RUBY_FAKEGEM_DOC_SOURCES="lib"
75
52# @ECLASS-VARIABLE: RUBY_FAKEGEM_BINWRAP 76# @ECLASS-VARIABLE: RUBY_FAKEGEM_BINWRAP
53# @DESCRIPTION: 77# @DESCRIPTION:
54# Binaries to wrap around (relative to the bin/ directory) 78# Binaries to wrap around (relative to the bin/ directory)
55# RUBY_FAKEGEM_BINWRAP="*" 79# RUBY_FAKEGEM_BINWRAP="*"
56 80
61 85
62# @ECLASS-VARIABLE: RUBY_FAKEGEM_GEMSPEC 86# @ECLASS-VARIABLE: RUBY_FAKEGEM_GEMSPEC
63# @DESCRIPTION: 87# @DESCRIPTION:
64# Filename of .gemspec file to install instead of generating a generic one. 88# Filename of .gemspec file to install instead of generating a generic one.
65# RUBY_FAKEGEM_GEMSPEC="" 89# RUBY_FAKEGEM_GEMSPEC=""
90
91# @ECLASS-VARIABLE: RUBY_FAKEGEM_EXTRAINSTALL
92# @DESCRIPTION:
93# List of files and directories relative to the top directory that also
94# get installed. Some gems provide extra files such as version information,
95# Rails generators, or data that needs to be installed as well.
96# RUBY_FAKEGEM_EXTRAINSTALL=""
66 97
67RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}" 98RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}"
68RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV/_pre/.pre}}" 99RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV/_pre/.pre}}"
69RUBY_FAKEGEM_SUFFIX="${RUBY_FAKEGEM_SUFFIX:-}" 100RUBY_FAKEGEM_SUFFIX="${RUBY_FAKEGEM_SUFFIX:-}"
70 101
102RUBY_FAKEGEM_RECIPE_DOC="${RUBY_FAKEGEM_RECIPE_DOC-rake}"
71RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}" 103RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}"
104RUBY_FAKEGEM_DOC_SOURCES="${RUBY_FAKEGEM_DOC_SOURCES-lib}"
105
106RUBY_FAKEGEM_RECIPE_TEST="${RUBY_FAKEGEM_RECIPE_TEST-rake}"
72RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}" 107RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}"
73 108
74RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}" 109RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}"
75 110
76if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then 111[[ ${RUBY_FAKEGEM_TASK_DOC} == "" ]] && RUBY_FAKEGEM_RECIPE_DOC="none"
112
113case ${RUBY_FAKEGEM_RECIPE_DOC} in
114 rake)
77 IUSE="$IUSE doc" 115 IUSE+=" doc"
78 ruby_add_bdepend "doc? ( dev-ruby/rake )" 116 ruby_add_bdepend "doc? ( dev-ruby/rake )"
79fi 117 ;;
80 118 rdoc)
81if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]]; then
82 IUSE="$IUSE doc" 119 IUSE+=" doc"
83fi 120 ruby_add_bdepend "doc? ( dev-ruby/rdoc )"
121 RUBY_FAKEGEM_DOCDIR="doc"
122 ;;
123 none)
124 [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && IUSE+=" doc"
125 ;;
126esac
84 127
85if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then 128[[ ${RUBY_FAKEGEM_TASK_TEST} == "" ]] && RUBY_FAKEGEM_RECIPE_TEST="none"
129
130case ${RUBY_FAKEGEM_RECIPE_TEST} in
131 rake)
86 IUSE="$IUSE test" 132 IUSE+=" test"
87 ruby_add_bdepend "test? ( dev-ruby/rake )" 133 ruby_add_bdepend "test? ( dev-ruby/rake )"
88fi 134 ;;
135 rspec)
136 IUSE+=" test"
137 ruby_add_bdepend "test? ( dev-ruby/rspec:2 )"
138 ;;
139 cucumber)
140 IUSE+=" test"
141 # Unfortunately as of August 2012, cucumber is not supported on
142 # JRuby. We work it around here to avoid repeating the same
143 # code over and over again.
144 USE_RUBY="${USE_RUBY/jruby/}" ruby_add_bdepend "test? ( dev-util/cucumber )"
145 ;;
146 *)
147 RUBY_FAKEGEM_RECIPE_TEST="none"
148 ;;
149esac
89 150
90SRC_URI="mirror://rubygems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${RUBY_FAKEGEM_SUFFIX:+-${RUBY_FAKEGEM_SUFFIX}}.gem" 151SRC_URI="mirror://rubygems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${RUBY_FAKEGEM_SUFFIX:+-${RUBY_FAKEGEM_SUFFIX}}.gem"
91 152
92ruby_add_bdepend dev-ruby/rubygems 153ruby_add_bdepend virtual/rubygems
93ruby_add_rdepend dev-ruby/rubygems 154ruby_add_rdepend virtual/rubygems
94 155
95# @FUNCTION: ruby_fakegem_gemsdir 156# @FUNCTION: ruby_fakegem_gemsdir
96# @RETURN: Returns the gem data directory 157# @RETURN: Returns the gem data directory
97# @DESCRIPTION: 158# @DESCRIPTION:
98# This function returns the gems data directory for the ruby 159# This function returns the gems data directory for the ruby
182# @DESCRIPTION: 243# @DESCRIPTION:
183# Generates an installable version of the specification indicated by 244# Generates an installable version of the specification indicated by
184# the metadata distributed by the gem itself. This is similar to how 245# the metadata distributed by the gem itself. This is similar to how
185# rubygems creates an installation from a .gem file. 246# rubygems creates an installation from a .gem file.
186ruby_fakegem_metadata_gemspec() { 247ruby_fakegem_metadata_gemspec() {
248 case ${RUBY} in
249 *ruby19)
250 ${RUBY} -r yaml -e "puts Gem::Specification.from_yaml(File::open('$1', :encoding => 'UTF-8').read).to_ruby" > $2
251 ;;
252 *)
187 ${RUBY} -r yaml -e "puts Gem::Specification.from_yaml(File::open('$1').read).to_ruby" > $2 253 ${RUBY} -r yaml -e "puts Gem::Specification.from_yaml(File::open('$1').read).to_ruby" > $2
254 ;;
255 esac
188} 256}
189 257
190# @FUNCTION: ruby_fakegem_genspec 258# @FUNCTION: ruby_fakegem_genspec
191# @USAGE: output-gemspec 259# @USAGE: output-gemspec
192# @DESCRIPTION: 260# @DESCRIPTION:
210 # copies with different implementations; while for now we're using 278 # copies with different implementations; while for now we're using
211 # the same exact content, we might have differences in the future, 279 # the same exact content, we might have differences in the future,
212 # so better taking this into consideration. 280 # so better taking this into consideration.
213 local quoted_description=${DESCRIPTION//\"/\\\"} 281 local quoted_description=${DESCRIPTION//\"/\\\"}
214 cat - > $1 <<EOF 282 cat - > $1 <<EOF
215# generated by ruby-fakegem.eclass $Revision: 1.28 $ 283# generated by ruby-fakegem.eclass $Revision: 1.37 $
216Gem::Specification.new do |s| 284Gem::Specification.new do |s|
217 s.name = "${RUBY_FAKEGEM_NAME}" 285 s.name = "${RUBY_FAKEGEM_NAME}"
218 s.version = "${RUBY_FAKEGEM_VERSION}" 286 s.version = "${RUBY_FAKEGEM_VERSION}"
219 s.summary = "${quoted_description}" 287 s.summary = "${quoted_description}"
220 s.homepage = "${HOMEPAGE}" 288 s.homepage = "${HOMEPAGE}"
260 328
261 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF 329 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF
262#!${rubycmd} 330#!${rubycmd}
263# This is a simplified version of the RubyGems wrapper 331# This is a simplified version of the RubyGems wrapper
264# 332#
265# Generated by ruby-fakegem.eclass $Revision: 1.28 $ 333# Generated by ruby-fakegem.eclass $Revision: 1.37 $
266 334
267require 'rubygems' 335require 'rubygems'
268 336
269load Gem::default_path[-1] + "/gems/${relativegembinary}" 337load Gem::default_path[-1] + "/gems/${relativegembinary}"
270 338
278# @FUNCTION: all_fakegem_compile 346# @FUNCTION: all_fakegem_compile
279# @DESCRIPTION: 347# @DESCRIPTION:
280# Build documentation for the package if indicated by the doc USE flag 348# Build documentation for the package if indicated by the doc USE flag
281# and if there is a documetation task defined. 349# and if there is a documetation task defined.
282all_fakegem_compile() { 350all_fakegem_compile() {
283 if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]] && use doc; then 351 if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && use doc; then
352 case ${RUBY_FAKEGEM_RECIPE_DOC} in
353 rake)
284 rake ${RUBY_FAKEGEM_TASK_DOC} || die "failed to (re)build documentation" 354 rake ${RUBY_FAKEGEM_TASK_DOC} || die "failed to (re)build documentation"
355 ;;
356 rdoc)
357 rdoc ${RUBY_FAKEGEM_DOC_SOURCES} || die "failed to (re)build documentation"
358 ;;
359 esac
285 fi 360 fi
286} 361}
287 362
288# @FUNCTION: all_ruby_unpack 363# @FUNCTION: all_ruby_unpack
289# @DESCRIPTION: 364# @DESCRIPTION:
293 # extracted twice and the mtime from the archive _has_ to be 368 # extracted twice and the mtime from the archive _has_ to be
294 # ignored (it's always set to epoch 0). 369 # ignored (it's always set to epoch 0).
295 for archive in ${A}; do 370 for archive in ${A}; do
296 case "${archive}" in 371 case "${archive}" in
297 *.gem) 372 *.gem)
298 # Make sure that we're not running unoack for more than 373 # Make sure that we're not running unpack for more than
299 # one .gem file, since we won't support that at all. 374 # one .gem file, since we won't support that at all.
300 [[ -d "${S}" ]] && die "Unable to unpack ${archive}, ${S} exists" 375 [[ -d "${S}" ]] && die "Unable to unpack ${archive}, ${S} exists"
301 376
302 ebegin "Unpacking .gem file..." 377 ebegin "Unpacking .gem file..."
303 tar -mxf ${DISTDIR}/${archive} || die 378 tar -mxf ${DISTDIR}/${archive} || die
340 415
341# @FUNCTION: each_fakegem_test 416# @FUNCTION: each_fakegem_test
342# @DESCRIPTION: 417# @DESCRIPTION:
343# Run tests for the package for each ruby target if the test task is defined. 418# Run tests for the package for each ruby target if the test task is defined.
344each_fakegem_test() { 419each_fakegem_test() {
345 local rubyflags= 420 case ${RUBY_FAKEGEM_RECIPE_TEST} in
421 rake)
346 ${RUBY} ${rubyflags} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed" 422 ${RUBY} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed"
423 ;;
424 rspec)
425 ruby-ng_rspec
426 ;;
427 cucumber)
428 ruby-ng_cucumber
429 ;;
430 none)
431 ewarn "each_fakegem_test called, but \${RUBY_FAKEGEM_RECIPE_TEST} is 'none'"
432 ;;
433 esac
347} 434}
348 435
349if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then 436if [[ ${RUBY_FAKEGEM_RECIPE_TEST} != none ]]; then
350 # @FUNCTION: each_ruby_test 437 # @FUNCTION: each_ruby_test
351 # @DESCRIPTION: 438 # @DESCRIPTION:
352 # Run the tests for this package. 439 # Run the tests for this package.
353 each_ruby_test() { 440 each_ruby_test() {
354 each_fakegem_test 441 each_fakegem_test
355 } 442 }
356fi 443fi
357 444
358# @FUNCTION: each_fakegem_install 445# @FUNCTION: each_fakegem_install
359# @DESCRIPTION: 446# @DESCRIPTION:
360# Install the package for each ruby target. 447# Install the package for each ruby target.

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

  ViewVC Help
Powered by ViewVC 1.1.20