/[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.17 Revision 1.34
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.17 2010/02/19 11:59:38 flameeyes Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/ruby-fakegem.eclass,v 1.34 2012/08/13 22:21:26 flameeyes 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"
40 48
41# @ECLASS-VARIABLE: RUBY_FAKEGEM_DOCDIR 49# @ECLASS-VARIABLE: RUBY_FAKEGEM_DOCDIR
42# @DESCRIPTION: 50# @DESCRIPTION:
43# Specify the directory under which the documentation is built; 51# Specify the directory under which the documentation is built;
57# @ECLASS-VARIABLE: RUBY_FAKEGEM_REQUIRE_PATHS 65# @ECLASS-VARIABLE: RUBY_FAKEGEM_REQUIRE_PATHS
58# @DESCRIPTION: 66# @DESCRIPTION:
59# Extra require paths (beside lib) to add to the specification 67# Extra require paths (beside lib) to add to the specification
60# RUBY_FAKEGEM_REQUIRE_PATHS="" 68# RUBY_FAKEGEM_REQUIRE_PATHS=""
61 69
70# @ECLASS-VARIABLE: RUBY_FAKEGEM_GEMSPEC
71# @DESCRIPTION:
72# Filename of .gemspec file to install instead of generating a generic one.
73# RUBY_FAKEGEM_GEMSPEC=""
74
75# @ECLASS-VARIABLE: RUBY_FAKEGEM_EXTRAINSTALL
76# @DESCRIPTION:
77# List of files and directories relative to the top directory that also
78# get installed. Some gems provide extra files such as version information,
79# Rails generators, or data that needs to be installed as well.
80# RUBY_FAKEGEM_EXTRAINSTALL=""
81
62RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}" 82RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}"
63RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV/_pre/.pre}}" 83RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV/_pre/.pre}}"
64RUBY_FAKEGEM_SUFFIX="${RUBY_FAKEGEM_SUFFIX:-}" 84RUBY_FAKEGEM_SUFFIX="${RUBY_FAKEGEM_SUFFIX:-}"
65 85
66RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}" 86RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}"
87RUBY_FAKEGEM_RECIPE_TEST="${RUBY_FAKEGEM_RECIPE_TEST-rake}"
67RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}" 88RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}"
68 89
69RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}" 90RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}"
70 91
71if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then 92if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then
72 IUSE="$IUSE doc" 93 IUSE="$IUSE doc"
73 ruby_add_bdepend doc "dev-ruby/rake" 94 ruby_add_bdepend "doc? ( dev-ruby/rake )"
74fi 95fi
75 96
76if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then 97if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]]; then
77 IUSE="$IUSE test" 98 IUSE="$IUSE doc"
78 ruby_add_bdepend test "dev-ruby/rake"
79fi 99fi
80 100
101[[ ${RUBY_FAKEGEM_TASK_TEST} == "" ]] && RUBY_FAKEGEM_RECIPE_TEST="none"
102
103case ${RUBY_FAKEGEM_RECIPE_TEST} in
104 rake)
105 IUSE+=" test"
106 ruby_add_bdepend "test? ( dev-ruby/rake )"
107 ;;
108 rspec)
109 IUSE+=" test"
110 ruby_add_bdepend "test? ( dev-ruby/rspec:2 )"
111 ;;
112 cucumber)
113 IUSE+=" test"
114 # Unfortunately as of August 2012, cucumber is not supported on
115 # JRuby. We work it around here to avoid repeating the same
116 # code over and over again.
117 USE_RUBY="${USE_RUBY/jruby/}" ruby_add_bdepend "test? ( dev-util/cucumber )"
118 ;;
119 *)
120 RUBY_FAKEGEM_RECIPE_TEST="none"
121 ;;
122esac
123
81SRC_URI="mirror://rubygems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${RUBY_FAKEGEM_SUFFIX:+-${RUBY_FAKEGEM_SUFFIX}}.gem" 124SRC_URI="mirror://rubygems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${RUBY_FAKEGEM_SUFFIX:+-${RUBY_FAKEGEM_SUFFIX}}.gem"
82 125
126ruby_add_bdepend virtual/rubygems
83ruby_add_rdepend virtual/rubygems 127ruby_add_rdepend virtual/rubygems
84 128
85# @FUNCTION: ruby_fakegem_gemsdir 129# @FUNCTION: ruby_fakegem_gemsdir
86# @RETURN: Returns the gem data directory 130# @RETURN: Returns the gem data directory
87# @DESCRIPTION: 131# @DESCRIPTION:
88# This function returns the gems data directory for the ruby 132# This function returns the gems data directory for the ruby
89# implementation in question. 133# implementation in question.
90ruby_fakegem_gemsdir() { 134ruby_fakegem_gemsdir() {
91 local _gemsitedir=$(${RUBY} -r rbconfig -e 'print Config::CONFIG["sitelibdir"]' | sed -e 's:site_ruby:gems:') 135 has "${EAPI}" 2 && ! use prefix && EPREFIX=
136
137 local _gemsitedir=$(ruby_rbconfig_value 'sitelibdir')
138 _gemsitedir=${_gemsitedir//site_ruby/gems}
139 _gemsitedir=${_gemsitedir#${EPREFIX}}
92 140
93 [[ -z ${_gemsitedir} ]] && { 141 [[ -z ${_gemsitedir} ]] && {
94 eerror "Unable to find the gems dir" 142 eerror "Unable to find the gems dir"
95 die "Unable to find the gems dir" 143 die "Unable to find the gems dir"
96 } 144 }
125 insinto $(ruby_fakegem_gemsdir)/gems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${newdirname} 173 insinto $(ruby_fakegem_gemsdir)/gems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${newdirname}
126 newins "$1" ${newbasename} 174 newins "$1" ${newbasename}
127 ) || die "failed $0 $@" 175 ) || die "failed $0 $@"
128} 176}
129 177
178# @FUNCTION: ruby_fakegem_install_gemspec
179# @DESCRIPTION:
180# Install a .gemspec file for this package. Either use the file indicated
181# by the RUBY_FAKEGEM_GEMSPEC variable, or generate one using
182# ruby_fakegem_genspec.
183ruby_fakegem_install_gemspec() {
184 local gemspec="${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation}
185
186 (
187 if [[ ${RUBY_FAKEGEM_GEMSPEC} != "" ]]; then
188 ruby_fakegem_gemspec_gemspec ${RUBY_FAKEGEM_GEMSPEC} ${gemspec}
189 else
190 local metadata="${WORKDIR}"/${_ruby_implementation}/metadata
191
192 if [[ -e ${metadata} ]]; then
193 ruby_fakegem_metadata_gemspec ${metadata} ${gemspec}
194 else
195 ruby_fakegem_genspec ${gemspec}
196 fi
197 fi
198 ) || die "Unable to generate gemspec file."
199
200 insinto $(ruby_fakegem_gemsdir)/specifications
201 newins ${gemspec} ${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}.gemspec || die "Unable to install gemspec file."
202}
203
204# @FUNCTION: ruby_fakegem_gemspec_gemspec
205# @USAGE: gemspec-input gemspec-output
206# @DESCRIPTION:
207# Generates an installable version of the specification indicated by
208# RUBY_FAKEGEM_GEMSPEC. This file is eval'ed to produce a final specification
209# in a way similar to packaging the gemspec file.
210ruby_fakegem_gemspec_gemspec() {
211 ${RUBY} -e "puts eval(File::open('$1').read).to_ruby" > $2
212}
213
214# @FUNCTION: ruby_fakegem_metadata_gemspec
215# @USAGE: gemspec-metadata gemspec-output
216# @DESCRIPTION:
217# Generates an installable version of the specification indicated by
218# the metadata distributed by the gem itself. This is similar to how
219# rubygems creates an installation from a .gem file.
220ruby_fakegem_metadata_gemspec() {
221 ${RUBY} -r yaml -e "puts Gem::Specification.from_yaml(File::open('$1').read).to_ruby" > $2
222}
223
130# @FUNCTION: ruby_fakegem_genspec 224# @FUNCTION: ruby_fakegem_genspec
225# @USAGE: output-gemspec
131# @DESCRIPTION: 226# @DESCRIPTION:
132# Generates a gemspec for the package and places it into the "specifications" 227# Generates a gemspec for the package and places it into the "specifications"
133# directory of RubyGems. 228# directory of RubyGems.
229# If the metadata normally distributed with a gem is present then that is
230# used to generate the gemspec file.
231#
232# As a fallback we can generate our own version.
134# In the gemspec, the following values are set: name, version, summary, 233# In the gemspec, the following values are set: name, version, summary,
135# homepage, and require_paths=["lib"]. 234# homepage, and require_paths=["lib"].
136# See RUBY_FAKEGEM_NAME and RUBY_FAKEGEM_VERSION for setting name and version. 235# See RUBY_FAKEGEM_NAME and RUBY_FAKEGEM_VERSION for setting name and version.
137# See RUBY_FAKEGEM_REQUIRE_PATHS for setting extra require paths. 236# See RUBY_FAKEGEM_REQUIRE_PATHS for setting extra require paths.
138ruby_fakegem_genspec() { 237ruby_fakegem_genspec() {
139 (
140 local required_paths="'lib'" 238 local required_paths="'lib'"
141 for path in ${RUBY_FAKEGEM_REQUIRE_PATHS}; do 239 for path in ${RUBY_FAKEGEM_REQUIRE_PATHS}; do
142 required_paths="${required_paths}, '${path}'" 240 required_paths="${required_paths}, '${path}'"
143 done 241 done
144 242
145 # We use the _ruby_implementation variable to avoid having stray 243 # We use the _ruby_implementation variable to avoid having stray
146 # copies with different implementations; while for now we're using 244 # copies with different implementations; while for now we're using
147 # the same exact content, we might have differences in the future, 245 # the same exact content, we might have differences in the future,
148 # so better taking this into consideration. 246 # so better taking this into consideration.
149 local quoted_description=${DESCRIPTION//\"/\\\"} 247 local quoted_description=${DESCRIPTION//\"/\\\"}
150 cat - > "${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation} <<EOF 248 cat - > $1 <<EOF
151# generated by ruby-fakegem.eclass $Revision: 1.17 $ 249# generated by ruby-fakegem.eclass $Revision: 1.34 $
152Gem::Specification.new do |s| 250Gem::Specification.new do |s|
153 s.name = "${RUBY_FAKEGEM_NAME}" 251 s.name = "${RUBY_FAKEGEM_NAME}"
154 s.version = "${RUBY_FAKEGEM_VERSION}" 252 s.version = "${RUBY_FAKEGEM_VERSION}"
155 s.summary = "${quoted_description}" 253 s.summary = "${quoted_description}"
156 s.homepage = "${HOMEPAGE}" 254 s.homepage = "${HOMEPAGE}"
157 s.require_paths = [${required_paths}] 255 s.require_paths = [${required_paths}]
158end 256end
159EOF 257EOF
160
161 insinto $(ruby_fakegem_gemsdir)/specifications
162 newins "${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation} ${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}.gemspec
163 ) || die "Unable to install fake gemspec"
164} 258}
165 259
166# @FUNCTION: ruby_fakegem_binwrapper 260# @FUNCTION: ruby_fakegem_binwrapper
167# @USAGE: command [path] 261# @USAGE: command [path]
168# @DESCRIPTION: 262# @DESCRIPTION:
186 for implementation in ${USE_RUBY}; do 280 for implementation in ${USE_RUBY}; do
187 # ignore non-enabled implementations 281 # ignore non-enabled implementations
188 use ruby_targets_${implementation} || continue 282 use ruby_targets_${implementation} || continue
189 if [ -z $rubycmd ]; then 283 if [ -z $rubycmd ]; then
190 # if no other implementation was set before, set it. 284 # if no other implementation was set before, set it.
191 rubycmd="/usr/bin/${implementation}" 285 rubycmd="$(ruby_implementation_command ${implementation})"
192 else 286 else
193 # if another implementation already arrived, then make 287 # if another implementation already arrived, then make
194 # it generic and break out of the loop. This ensures 288 # it generic and break out of the loop. This ensures
195 # that we do at most two iterations. 289 # that we do at most two iterations.
196 rubycmd="/usr/bin/env ruby" 290 rubycmd="/usr/bin/env ruby"
200 294
201 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF 295 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF
202#!${rubycmd} 296#!${rubycmd}
203# This is a simplified version of the RubyGems wrapper 297# This is a simplified version of the RubyGems wrapper
204# 298#
205# Generated by ruby-fakegem.eclass $Revision: 1.17 $ 299# Generated by ruby-fakegem.eclass $Revision: 1.34 $
206 300
207require 'rubygems' 301require 'rubygems'
208 302
209load Gem::default_path[-1] + "/gems/${relativegembinary}" 303load Gem::default_path[-1] + "/gems/${relativegembinary}"
210 304
230# Unpack the source archive, including support for unpacking gems. 324# Unpack the source archive, including support for unpacking gems.
231all_ruby_unpack() { 325all_ruby_unpack() {
232 # Special support for extracting .gem files; the file need to be 326 # Special support for extracting .gem files; the file need to be
233 # extracted twice and the mtime from the archive _has_ to be 327 # extracted twice and the mtime from the archive _has_ to be
234 # ignored (it's always set to epoch 0). 328 # ignored (it's always set to epoch 0).
235 # 329 for archive in ${A}; do
236 # This only works if there is exactly one archive and that archive 330 case "${archive}" in
237 # is a .gem file! 331 *.gem)
238 if [[ $(wc -w <<< ${A}) == 1 ]] && 332 # Make sure that we're not running unpack for more than
239 [[ ${A} == *.gem ]]; then 333 # one .gem file, since we won't support that at all.
334 [[ -d "${S}" ]] && die "Unable to unpack ${archive}, ${S} exists"
335
240 ebegin "Unpacking .gem file..." 336 ebegin "Unpacking .gem file..."
241 tar -mxf ${DISTDIR}/${A} || die 337 tar -mxf ${DISTDIR}/${archive} || die
242 eend $? 338 eend $?
243 339
340 ebegin "Uncompressing metadata"
341 gunzip metadata.gz || die
342 eend $?
343
244 mkdir "${S}" 344 mkdir "${S}"
245 pushd "${S}" &>/dev/null 345 pushd "${S}" &>/dev/null
246 346
247 ebegin "Unpacking data.tar.gz" 347 ebegin "Unpacking data.tar.gz"
248 tar -mxf "${my_WORKDIR}"/data.tar.gz || die 348 tar -mxf "${my_WORKDIR}"/data.tar.gz || die
249 eend $? 349 eend $?
350
250 popd &>/dev/null 351 popd &>/dev/null
251 else 352 ;;
252 [[ -n ${A} ]] && unpack ${A} 353 *.patch.bz2)
253 fi 354 # We apply the patches with RUBY_PATCHES directly from DISTDIR,
355 # as the WORKDIR variable changes value between the global-scope
356 # and the time all_ruby_unpack/_prepare are called. Since we can
357 # simply decompress them when applying, this is much easier to
358 # deal with for us.
359 einfo "Keeping ${archive} as-is"
360 ;;
361 *)
362 unpack ${archive}
363 ;;
364 esac
365 done
254} 366}
255 367
256# @FUNCTION: all_ruby_compile 368# @FUNCTION: all_ruby_compile
257# @DESCRIPTION: 369# @DESCRIPTION:
258# Compile the package. 370# Compile the package.
262 374
263# @FUNCTION: each_fakegem_test 375# @FUNCTION: each_fakegem_test
264# @DESCRIPTION: 376# @DESCRIPTION:
265# Run tests for the package for each ruby target if the test task is defined. 377# Run tests for the package for each ruby target if the test task is defined.
266each_fakegem_test() { 378each_fakegem_test() {
267 local rubyflags= 379 case ${RUBY_FAKEGEM_RECIPE_TEST} in
380 rake)
268 ${RUBY} ${rubyflags} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed" 381 ${RUBY} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed"
382 ;;
383 rspec)
384 ruby-ng_rspec
385 ;;
386 cucumber)
387 ruby-ng_cucumber
388 ;;
389 none)
390 ewarn "each_fakegem_test called, but \${RUBY_FAKEGEM_RECIPE_TEST} is 'none'"
391 ;;
392 esac
269} 393}
270 394
271if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then 395if [[ ${RUBY_FAKEGEM_RECIPE_TEST} != none ]]; then
272 # @FUNCTION: each_ruby_test 396 # @FUNCTION: each_ruby_test
273 # @DESCRIPTION: 397 # @DESCRIPTION:
274 # Run the tests for this package. 398 # Run the tests for this package.
275 each_ruby_test() { 399 each_ruby_test() {
276 each_fakegem_test 400 each_fakegem_test
277 } 401 }
278fi 402fi
279 403
280# @FUNCTION: each_fakegem_install 404# @FUNCTION: each_fakegem_install
281# @DESCRIPTION: 405# @DESCRIPTION:
282# Install the package for each ruby target. 406# Install the package for each ruby target.
283each_fakegem_install() { 407each_fakegem_install() {
284 ruby_fakegem_genspec 408 ruby_fakegem_install_gemspec
285 409
286 local _gemlibdirs="${RUBY_FAKEGEM_EXTRAINSTALL}" 410 local _gemlibdirs="${RUBY_FAKEGEM_EXTRAINSTALL}"
287 for directory in bin lib; do 411 for directory in bin lib; do
288 [[ -d ${directory} ]] && _gemlibdirs="${_gemlibdirs} ${directory}" 412 [[ -d ${directory} ]] && _gemlibdirs="${_gemlibdirs} ${directory}"
289 done 413 done
301 425
302# @FUNCTION: all_fakegem_install 426# @FUNCTION: all_fakegem_install
303# @DESCRIPTION: 427# @DESCRIPTION:
304# Install files common to all ruby targets. 428# Install files common to all ruby targets.
305all_fakegem_install() { 429all_fakegem_install() {
306 if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]] && use doc; then 430 if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && use doc; then
307 for dir in ${RUBY_FAKEGEM_DOCDIR}; do 431 for dir in ${RUBY_FAKEGEM_DOCDIR}; do
432 [[ -d ${dir} ]] || continue
433
308 pushd ${dir} &>/dev/null 434 pushd ${dir} &>/dev/null
309 dohtml -r * || die "failed to install documentation" 435 dohtml -r * || die "failed to install documentation"
310 popd &>/dev/null 436 popd &>/dev/null
311 done 437 done
312 fi 438 fi

Legend:
Removed from v.1.17  
changed lines
  Added in v.1.34

  ViewVC Help
Powered by ViewVC 1.1.20