/[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.27 Revision 1.40
1# Copyright 1999-2009 Gentoo Foundation 1# Copyright 1999-2013 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.27 2010/12/28 12:07:15 graaff Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/ruby-fakegem.eclass,v 1.40 2013/11/09 10:22:06 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# - yard (calls `yard`, adds dev-ruby/yard to the dependencies);
55# - none
56# RUBY_FAKEGEM_RECIPE_DOC="rake"
40 57
41# @ECLASS-VARIABLE: RUBY_FAKEGEM_DOCDIR 58# @ECLASS-VARIABLE: RUBY_FAKEGEM_DOCDIR
42# @DESCRIPTION: 59# @DESCRIPTION:
43# Specify the directory under which the documentation is built; 60# Specify the directory under which the documentation is built;
44# if empty no documentation will be installed automatically. 61# if empty no documentation will be installed automatically.
62# Note: if RUBY_FAKEGEM_RECIPE_DOC is set to `rdoc`, this variable is
63# hardwired to `doc`.
45# RUBY_FAKEGEM_DOCDIR="" 64# RUBY_FAKEGEM_DOCDIR=""
46 65
47# @ECLASS-VARIABLE: RUBY_FAKEGEM_EXTRADOC 66# @ECLASS-VARIABLE: RUBY_FAKEGEM_EXTRADOC
48# @DESCRIPTION: 67# @DESCRIPTION:
49# Extra documentation to install (readme, changelogs, …). 68# Extra documentation to install (readme, changelogs, …).
50# RUBY_FAKEGEM_EXTRADOC="" 69# RUBY_FAKEGEM_EXTRADOC=""
51 70
71# @ECLASS-VARIABLE: RUBY_FAKEGEM_DOC_SOURCES
72# @DESCRIPTION:
73# Allow settings defined sources to scan for documentation.
74# This only applies if RUBY_FAKEGEM_DOC_TASK is set to `rdoc`.
75# RUBY_FAKEGEM_DOC_SOURCES="lib"
76
52# @ECLASS-VARIABLE: RUBY_FAKEGEM_BINWRAP 77# @ECLASS-VARIABLE: RUBY_FAKEGEM_BINWRAP
53# @DESCRIPTION: 78# @DESCRIPTION:
54# Binaries to wrap around (relative to the bin/ directory) 79# Binaries to wrap around (relative to the bin/ directory)
55# RUBY_FAKEGEM_BINWRAP="*" 80# RUBY_FAKEGEM_BINWRAP="*"
56 81
61 86
62# @ECLASS-VARIABLE: RUBY_FAKEGEM_GEMSPEC 87# @ECLASS-VARIABLE: RUBY_FAKEGEM_GEMSPEC
63# @DESCRIPTION: 88# @DESCRIPTION:
64# Filename of .gemspec file to install instead of generating a generic one. 89# Filename of .gemspec file to install instead of generating a generic one.
65# RUBY_FAKEGEM_GEMSPEC="" 90# RUBY_FAKEGEM_GEMSPEC=""
91
92# @ECLASS-VARIABLE: RUBY_FAKEGEM_EXTRAINSTALL
93# @DESCRIPTION:
94# List of files and directories relative to the top directory that also
95# get installed. Some gems provide extra files such as version information,
96# Rails generators, or data that needs to be installed as well.
97# RUBY_FAKEGEM_EXTRAINSTALL=""
66 98
67RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}" 99RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}"
68RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV/_pre/.pre}}" 100RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV/_pre/.pre}}"
69RUBY_FAKEGEM_SUFFIX="${RUBY_FAKEGEM_SUFFIX:-}" 101RUBY_FAKEGEM_SUFFIX="${RUBY_FAKEGEM_SUFFIX:-}"
70 102
103RUBY_FAKEGEM_RECIPE_DOC="${RUBY_FAKEGEM_RECIPE_DOC-rake}"
71RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}" 104RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}"
105RUBY_FAKEGEM_DOC_SOURCES="${RUBY_FAKEGEM_DOC_SOURCES-lib}"
106
107RUBY_FAKEGEM_RECIPE_TEST="${RUBY_FAKEGEM_RECIPE_TEST-rake}"
72RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}" 108RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}"
73 109
74RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}" 110RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}"
75 111
76if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then 112[[ ${RUBY_FAKEGEM_TASK_DOC} == "" ]] && RUBY_FAKEGEM_RECIPE_DOC="none"
113
114case ${RUBY_FAKEGEM_RECIPE_DOC} in
115 rake)
77 IUSE="$IUSE doc" 116 IUSE+=" doc"
78 ruby_add_bdepend "doc? ( dev-ruby/rake )" 117 ruby_add_bdepend "doc? ( dev-ruby/rake )"
79fi 118 RUBY_FAKEGEM_DOCDIR="doc"
80 119 ;;
81if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]]; then 120 rdoc)
82 IUSE="$IUSE doc" 121 IUSE+=" doc"
83fi 122 ruby_add_bdepend "doc? ( dev-ruby/rdoc )"
123 RUBY_FAKEGEM_DOCDIR="doc"
124 ;;
125 yard)
126 IUSE+="doc"
127 ruby_add_bdepend "doc? ( dev-ruby/yard )"
128 RUBY_FAKEGEM_DOCDIR="doc"
129 ;;
130 none)
131 [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && IUSE+=" doc"
132 ;;
133esac
84 134
85if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then 135[[ ${RUBY_FAKEGEM_TASK_TEST} == "" ]] && RUBY_FAKEGEM_RECIPE_TEST="none"
136
137case ${RUBY_FAKEGEM_RECIPE_TEST} in
138 rake)
86 IUSE="$IUSE test" 139 IUSE+=" test"
87 ruby_add_bdepend "test? ( dev-ruby/rake )" 140 ruby_add_bdepend "test? ( dev-ruby/rake )"
88fi 141 ;;
142 rspec)
143 IUSE+=" test"
144 ruby_add_bdepend "test? ( dev-ruby/rspec:2 )"
145 ;;
146 cucumber)
147 IUSE+=" test"
148 # Unfortunately as of August 2012, cucumber is not supported on
149 # JRuby. We work it around here to avoid repeating the same
150 # code over and over again.
151 USE_RUBY="${USE_RUBY/jruby/}" ruby_add_bdepend "test? ( dev-util/cucumber )"
152 ;;
153 *)
154 RUBY_FAKEGEM_RECIPE_TEST="none"
155 ;;
156esac
89 157
90SRC_URI="mirror://rubygems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${RUBY_FAKEGEM_SUFFIX:+-${RUBY_FAKEGEM_SUFFIX}}.gem" 158SRC_URI="mirror://rubygems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${RUBY_FAKEGEM_SUFFIX:+-${RUBY_FAKEGEM_SUFFIX}}.gem"
91 159
92ruby_add_bdepend dev-ruby/rubygems 160ruby_add_bdepend virtual/rubygems
93ruby_add_rdepend dev-ruby/rubygems 161ruby_add_rdepend virtual/rubygems
94 162
95# @FUNCTION: ruby_fakegem_gemsdir 163# @FUNCTION: ruby_fakegem_gemsdir
96# @RETURN: Returns the gem data directory 164# @RETURN: Returns the gem data directory
97# @DESCRIPTION: 165# @DESCRIPTION:
98# This function returns the gems data directory for the ruby 166# This function returns the gems data directory for the ruby
159 ruby_fakegem_metadata_gemspec ${metadata} ${gemspec} 227 ruby_fakegem_metadata_gemspec ${metadata} ${gemspec}
160 else 228 else
161 ruby_fakegem_genspec ${gemspec} 229 ruby_fakegem_genspec ${gemspec}
162 fi 230 fi
163 fi 231 fi
164 ) || "Unable to generate gemspec file." 232 ) || die "Unable to generate gemspec file."
165 233
166 insinto $(ruby_fakegem_gemsdir)/specifications 234 insinto $(ruby_fakegem_gemsdir)/specifications
167 newins ${gemspec} ${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}.gemspec || die "Unable to install gemspec file." 235 newins ${gemspec} ${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}.gemspec || die "Unable to install gemspec file."
168} 236}
169 237
182# @DESCRIPTION: 250# @DESCRIPTION:
183# Generates an installable version of the specification indicated by 251# Generates an installable version of the specification indicated by
184# the metadata distributed by the gem itself. This is similar to how 252# the metadata distributed by the gem itself. This is similar to how
185# rubygems creates an installation from a .gem file. 253# rubygems creates an installation from a .gem file.
186ruby_fakegem_metadata_gemspec() { 254ruby_fakegem_metadata_gemspec() {
255 case ${RUBY} in
256 *ruby19)
257 ${RUBY} -r yaml -e "puts Gem::Specification.from_yaml(File::open('$1', :encoding => 'UTF-8').read).to_ruby" > $2
258 ;;
259 *)
187 ${RUBY} -r yaml -e "puts Gem::Specification.from_yaml(File::open('$1').read).to_ruby" > $2 260 ${RUBY} -r yaml -e "puts Gem::Specification.from_yaml(File::open('$1').read).to_ruby" > $2
261 ;;
262 esac
188} 263}
189 264
190# @FUNCTION: ruby_fakegem_genspec 265# @FUNCTION: ruby_fakegem_genspec
191# @USAGE: output-gemspec 266# @USAGE: output-gemspec
192# @DESCRIPTION: 267# @DESCRIPTION:
210 # copies with different implementations; while for now we're using 285 # copies with different implementations; while for now we're using
211 # the same exact content, we might have differences in the future, 286 # the same exact content, we might have differences in the future,
212 # so better taking this into consideration. 287 # so better taking this into consideration.
213 local quoted_description=${DESCRIPTION//\"/\\\"} 288 local quoted_description=${DESCRIPTION//\"/\\\"}
214 cat - > $1 <<EOF 289 cat - > $1 <<EOF
215# generated by ruby-fakegem.eclass $Revision: 1.27 $ 290# generated by ruby-fakegem.eclass $Revision: 1.40 $
216Gem::Specification.new do |s| 291Gem::Specification.new do |s|
217 s.name = "${RUBY_FAKEGEM_NAME}" 292 s.name = "${RUBY_FAKEGEM_NAME}"
218 s.version = "${RUBY_FAKEGEM_VERSION}" 293 s.version = "${RUBY_FAKEGEM_VERSION}"
219 s.summary = "${quoted_description}" 294 s.summary = "${quoted_description}"
220 s.homepage = "${HOMEPAGE}" 295 s.homepage = "${HOMEPAGE}"
260 335
261 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF 336 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF
262#!${rubycmd} 337#!${rubycmd}
263# This is a simplified version of the RubyGems wrapper 338# This is a simplified version of the RubyGems wrapper
264# 339#
265# Generated by ruby-fakegem.eclass $Revision: 1.27 $ 340# Generated by ruby-fakegem.eclass $Revision: 1.40 $
266 341
267require 'rubygems' 342require 'rubygems'
268 343
269load Gem::default_path[-1] + "/gems/${relativegembinary}" 344load Gem::default_path[-1] + "/gems/${relativegembinary}"
270 345
278# @FUNCTION: all_fakegem_compile 353# @FUNCTION: all_fakegem_compile
279# @DESCRIPTION: 354# @DESCRIPTION:
280# Build documentation for the package if indicated by the doc USE flag 355# Build documentation for the package if indicated by the doc USE flag
281# and if there is a documetation task defined. 356# and if there is a documetation task defined.
282all_fakegem_compile() { 357all_fakegem_compile() {
283 if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]] && use doc; then 358 if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && use doc; then
359 case ${RUBY_FAKEGEM_RECIPE_DOC} in
360 rake)
284 rake ${RUBY_FAKEGEM_TASK_DOC} || die "failed to (re)build documentation" 361 rake ${RUBY_FAKEGEM_TASK_DOC} || die "failed to (re)build documentation"
362 ;;
363 rdoc)
364 rdoc ${RUBY_FAKEGEM_DOC_SOURCES} || die "failed to (re)build documentation"
365 ;;
366 yard)
367 yard doc ${RUBY_FAKEGEM_DOC_SOURCES} || die "failed to (re)build documentation"
368 ;;
369 esac
285 fi 370 fi
286} 371}
287 372
288# @FUNCTION: all_ruby_unpack 373# @FUNCTION: all_ruby_unpack
289# @DESCRIPTION: 374# @DESCRIPTION:
293 # extracted twice and the mtime from the archive _has_ to be 378 # extracted twice and the mtime from the archive _has_ to be
294 # ignored (it's always set to epoch 0). 379 # ignored (it's always set to epoch 0).
295 for archive in ${A}; do 380 for archive in ${A}; do
296 case "${archive}" in 381 case "${archive}" in
297 *.gem) 382 *.gem)
298 # Make sure that we're not running unoack for more than 383 # Make sure that we're not running unpack for more than
299 # one .gem file, since we won't support that at all. 384 # one .gem file, since we won't support that at all.
300 [[ -d "${S}" ]] && die "Unable to unpack ${archive}, ${S} exists" 385 [[ -d "${S}" ]] && die "Unable to unpack ${archive}, ${S} exists"
301 386
302 ebegin "Unpacking .gem file..." 387 ebegin "Unpacking .gem file..."
303 tar -mxf ${DISTDIR}/${archive} || die 388 tar -mxf "${DISTDIR}"/${archive} || die
304 eend $? 389 eend $?
305 390
306 ebegin "Uncompressing metadata" 391 ebegin "Uncompressing metadata"
307 gunzip metadata.gz || die 392 gunzip metadata.gz || die
308 eend $? 393 eend $?
340 425
341# @FUNCTION: each_fakegem_test 426# @FUNCTION: each_fakegem_test
342# @DESCRIPTION: 427# @DESCRIPTION:
343# Run tests for the package for each ruby target if the test task is defined. 428# Run tests for the package for each ruby target if the test task is defined.
344each_fakegem_test() { 429each_fakegem_test() {
345 local rubyflags= 430 case ${RUBY_FAKEGEM_RECIPE_TEST} in
431 rake)
346 ${RUBY} ${rubyflags} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed" 432 ${RUBY} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed"
433 ;;
434 rspec)
435 ruby-ng_rspec
436 ;;
437 cucumber)
438 ruby-ng_cucumber
439 ;;
440 none)
441 ewarn "each_fakegem_test called, but \${RUBY_FAKEGEM_RECIPE_TEST} is 'none'"
442 ;;
443 esac
347} 444}
348 445
349if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then 446if [[ ${RUBY_FAKEGEM_RECIPE_TEST} != none ]]; then
350 # @FUNCTION: each_ruby_test 447 # @FUNCTION: each_ruby_test
351 # @DESCRIPTION: 448 # @DESCRIPTION:
352 # Run the tests for this package. 449 # Run the tests for this package.
353 each_ruby_test() { 450 each_ruby_test() {
354 each_fakegem_test 451 each_fakegem_test
355 } 452 }
356fi 453fi
357 454
358# @FUNCTION: each_fakegem_install 455# @FUNCTION: each_fakegem_install
359# @DESCRIPTION: 456# @DESCRIPTION:
360# Install the package for each ruby target. 457# Install the package for each ruby target.

Legend:
Removed from v.1.27  
changed lines
  Added in v.1.40

  ViewVC Help
Powered by ViewVC 1.1.20