/[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.23 Revision 1.33
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.23 2010/08/30 22:08:24 flameeyes Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/ruby-fakegem.eclass,v 1.33 2012/07/05 21:23:01 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# - none
39# RUBY_FAKEGEM_RECIPE_TEST="rake"
40
36# @ECLASS-VARIABLE: RUBY_FAKEGEM_TASK_TEST 41# @ECLASS-VARIABLE: RUBY_FAKEGEM_TASK_TEST
37# @DESCRIPTION: 42# @DESCRIPTION:
38# Specify the rake(1) task used for executing tests. 43# Specify the rake(1) task used for executing tests. Only valid
44# if RUBY_FAKEGEM_RECIPE_TEST is set to "rake" (the default).
39# RUBY_FAKEGEM_TASK_TEST="test" 45# RUBY_FAKEGEM_TASK_TEST="test"
40 46
41# @ECLASS-VARIABLE: RUBY_FAKEGEM_DOCDIR 47# @ECLASS-VARIABLE: RUBY_FAKEGEM_DOCDIR
42# @DESCRIPTION: 48# @DESCRIPTION:
43# Specify the directory under which the documentation is built; 49# Specify the directory under which the documentation is built;
57# @ECLASS-VARIABLE: RUBY_FAKEGEM_REQUIRE_PATHS 63# @ECLASS-VARIABLE: RUBY_FAKEGEM_REQUIRE_PATHS
58# @DESCRIPTION: 64# @DESCRIPTION:
59# Extra require paths (beside lib) to add to the specification 65# Extra require paths (beside lib) to add to the specification
60# RUBY_FAKEGEM_REQUIRE_PATHS="" 66# RUBY_FAKEGEM_REQUIRE_PATHS=""
61 67
68# @ECLASS-VARIABLE: RUBY_FAKEGEM_GEMSPEC
69# @DESCRIPTION:
70# Filename of .gemspec file to install instead of generating a generic one.
71# RUBY_FAKEGEM_GEMSPEC=""
72
73# @ECLASS-VARIABLE: RUBY_FAKEGEM_EXTRAINSTALL
74# @DESCRIPTION:
75# List of files and directories relative to the top directory that also
76# get installed. Some gems provide extra files such as version information,
77# Rails generators, or data that needs to be installed as well.
78# RUBY_FAKEGEM_EXTRAINSTALL=""
79
62RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}" 80RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}"
63RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV/_pre/.pre}}" 81RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV/_pre/.pre}}"
64RUBY_FAKEGEM_SUFFIX="${RUBY_FAKEGEM_SUFFIX:-}" 82RUBY_FAKEGEM_SUFFIX="${RUBY_FAKEGEM_SUFFIX:-}"
65 83
66RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}" 84RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}"
85RUBY_FAKEGEM_RECIPE_TEST="${RUBY_FAKEGEM_RECIPE_TEST-rake}"
67RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}" 86RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}"
68 87
69RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}" 88RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}"
70 89
71if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then 90if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then
75 94
76if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]]; then 95if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]]; then
77 IUSE="$IUSE doc" 96 IUSE="$IUSE doc"
78fi 97fi
79 98
80if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then 99[[ ${RUBY_FAKEGEM_TASK_TEST} == "" ]] && RUBY_FAKEGEM_RECIPE_TEST="none"
100
101case ${RUBY_FAKEGEM_RECIPE_TEST} in
102 rake)
81 IUSE="$IUSE test" 103 IUSE+=" test"
82 ruby_add_bdepend "test? ( dev-ruby/rake )" 104 ruby_add_bdepend "test? ( dev-ruby/rake )"
83fi 105 ;;
106 rspec)
107 IUSE+=" test"
108 ruby_add_bdepend "test? ( dev-ruby/rspec:2 )"
109 ;;
110 *)
111 RUBY_FAKEGEM_RECIPE_TEST="none"
112 ;;
113esac
84 114
85SRC_URI="mirror://rubygems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${RUBY_FAKEGEM_SUFFIX:+-${RUBY_FAKEGEM_SUFFIX}}.gem" 115SRC_URI="mirror://rubygems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${RUBY_FAKEGEM_SUFFIX:+-${RUBY_FAKEGEM_SUFFIX}}.gem"
86 116
117ruby_add_bdepend virtual/rubygems
87ruby_add_rdepend virtual/rubygems 118ruby_add_rdepend virtual/rubygems
88 119
89# @FUNCTION: ruby_fakegem_gemsdir 120# @FUNCTION: ruby_fakegem_gemsdir
90# @RETURN: Returns the gem data directory 121# @RETURN: Returns the gem data directory
91# @DESCRIPTION: 122# @DESCRIPTION:
92# This function returns the gems data directory for the ruby 123# This function returns the gems data directory for the ruby
93# implementation in question. 124# implementation in question.
94ruby_fakegem_gemsdir() { 125ruby_fakegem_gemsdir() {
95 local _gemsitedir=$(${RUBY} -r rbconfig -e 'print Config::CONFIG["sitelibdir"]' | sed -e 's:site_ruby:gems:') 126 has "${EAPI}" 2 && ! use prefix && EPREFIX=
127
128 local _gemsitedir=$(ruby_rbconfig_value 'sitelibdir')
129 _gemsitedir=${_gemsitedir//site_ruby/gems}
130 _gemsitedir=${_gemsitedir#${EPREFIX}}
96 131
97 [[ -z ${_gemsitedir} ]] && { 132 [[ -z ${_gemsitedir} ]] && {
98 eerror "Unable to find the gems dir" 133 eerror "Unable to find the gems dir"
99 die "Unable to find the gems dir" 134 die "Unable to find the gems dir"
100 } 135 }
129 insinto $(ruby_fakegem_gemsdir)/gems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${newdirname} 164 insinto $(ruby_fakegem_gemsdir)/gems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${newdirname}
130 newins "$1" ${newbasename} 165 newins "$1" ${newbasename}
131 ) || die "failed $0 $@" 166 ) || die "failed $0 $@"
132} 167}
133 168
169# @FUNCTION: ruby_fakegem_install_gemspec
170# @DESCRIPTION:
171# Install a .gemspec file for this package. Either use the file indicated
172# by the RUBY_FAKEGEM_GEMSPEC variable, or generate one using
173# ruby_fakegem_genspec.
174ruby_fakegem_install_gemspec() {
175 local gemspec="${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation}
176
177 (
178 if [[ ${RUBY_FAKEGEM_GEMSPEC} != "" ]]; then
179 ruby_fakegem_gemspec_gemspec ${RUBY_FAKEGEM_GEMSPEC} ${gemspec}
180 else
181 local metadata="${WORKDIR}"/${_ruby_implementation}/metadata
182
183 if [[ -e ${metadata} ]]; then
184 ruby_fakegem_metadata_gemspec ${metadata} ${gemspec}
185 else
186 ruby_fakegem_genspec ${gemspec}
187 fi
188 fi
189 ) || die "Unable to generate gemspec file."
190
191 insinto $(ruby_fakegem_gemsdir)/specifications
192 newins ${gemspec} ${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}.gemspec || die "Unable to install gemspec file."
193}
194
195# @FUNCTION: ruby_fakegem_gemspec_gemspec
196# @USAGE: gemspec-input gemspec-output
197# @DESCRIPTION:
198# Generates an installable version of the specification indicated by
199# RUBY_FAKEGEM_GEMSPEC. This file is eval'ed to produce a final specification
200# in a way similar to packaging the gemspec file.
201ruby_fakegem_gemspec_gemspec() {
202 ${RUBY} -e "puts eval(File::open('$1').read).to_ruby" > $2
203}
204
205# @FUNCTION: ruby_fakegem_metadata_gemspec
206# @USAGE: gemspec-metadata gemspec-output
207# @DESCRIPTION:
208# Generates an installable version of the specification indicated by
209# the metadata distributed by the gem itself. This is similar to how
210# rubygems creates an installation from a .gem file.
211ruby_fakegem_metadata_gemspec() {
212 ${RUBY} -r yaml -e "puts Gem::Specification.from_yaml(File::open('$1').read).to_ruby" > $2
213}
214
134# @FUNCTION: ruby_fakegem_genspec 215# @FUNCTION: ruby_fakegem_genspec
216# @USAGE: output-gemspec
135# @DESCRIPTION: 217# @DESCRIPTION:
136# Generates a gemspec for the package and places it into the "specifications" 218# Generates a gemspec for the package and places it into the "specifications"
137# directory of RubyGems. 219# directory of RubyGems.
220# If the metadata normally distributed with a gem is present then that is
221# used to generate the gemspec file.
222#
223# As a fallback we can generate our own version.
138# In the gemspec, the following values are set: name, version, summary, 224# In the gemspec, the following values are set: name, version, summary,
139# homepage, and require_paths=["lib"]. 225# homepage, and require_paths=["lib"].
140# See RUBY_FAKEGEM_NAME and RUBY_FAKEGEM_VERSION for setting name and version. 226# See RUBY_FAKEGEM_NAME and RUBY_FAKEGEM_VERSION for setting name and version.
141# See RUBY_FAKEGEM_REQUIRE_PATHS for setting extra require paths. 227# See RUBY_FAKEGEM_REQUIRE_PATHS for setting extra require paths.
142ruby_fakegem_genspec() { 228ruby_fakegem_genspec() {
143 (
144 local required_paths="'lib'" 229 local required_paths="'lib'"
145 for path in ${RUBY_FAKEGEM_REQUIRE_PATHS}; do 230 for path in ${RUBY_FAKEGEM_REQUIRE_PATHS}; do
146 required_paths="${required_paths}, '${path}'" 231 required_paths="${required_paths}, '${path}'"
147 done 232 done
148 233
149 # We use the _ruby_implementation variable to avoid having stray 234 # We use the _ruby_implementation variable to avoid having stray
150 # copies with different implementations; while for now we're using 235 # copies with different implementations; while for now we're using
151 # the same exact content, we might have differences in the future, 236 # the same exact content, we might have differences in the future,
152 # so better taking this into consideration. 237 # so better taking this into consideration.
153 local quoted_description=${DESCRIPTION//\"/\\\"} 238 local quoted_description=${DESCRIPTION//\"/\\\"}
154 cat - > "${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation} <<EOF 239 cat - > $1 <<EOF
155# generated by ruby-fakegem.eclass $Revision: 1.23 $ 240# generated by ruby-fakegem.eclass $Revision: 1.33 $
156Gem::Specification.new do |s| 241Gem::Specification.new do |s|
157 s.name = "${RUBY_FAKEGEM_NAME}" 242 s.name = "${RUBY_FAKEGEM_NAME}"
158 s.version = "${RUBY_FAKEGEM_VERSION}" 243 s.version = "${RUBY_FAKEGEM_VERSION}"
159 s.summary = "${quoted_description}" 244 s.summary = "${quoted_description}"
160 s.homepage = "${HOMEPAGE}" 245 s.homepage = "${HOMEPAGE}"
161 s.require_paths = [${required_paths}] 246 s.require_paths = [${required_paths}]
162end 247end
163EOF 248EOF
164
165 insinto $(ruby_fakegem_gemsdir)/specifications
166 newins "${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation} ${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}.gemspec
167 ) || die "Unable to install fake gemspec"
168} 249}
169 250
170# @FUNCTION: ruby_fakegem_binwrapper 251# @FUNCTION: ruby_fakegem_binwrapper
171# @USAGE: command [path] 252# @USAGE: command [path]
172# @DESCRIPTION: 253# @DESCRIPTION:
204 285
205 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF 286 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF
206#!${rubycmd} 287#!${rubycmd}
207# This is a simplified version of the RubyGems wrapper 288# This is a simplified version of the RubyGems wrapper
208# 289#
209# Generated by ruby-fakegem.eclass $Revision: 1.23 $ 290# Generated by ruby-fakegem.eclass $Revision: 1.33 $
210 291
211require 'rubygems' 292require 'rubygems'
212 293
213load Gem::default_path[-1] + "/gems/${relativegembinary}" 294load Gem::default_path[-1] + "/gems/${relativegembinary}"
214 295
237 # extracted twice and the mtime from the archive _has_ to be 318 # extracted twice and the mtime from the archive _has_ to be
238 # ignored (it's always set to epoch 0). 319 # ignored (it's always set to epoch 0).
239 for archive in ${A}; do 320 for archive in ${A}; do
240 case "${archive}" in 321 case "${archive}" in
241 *.gem) 322 *.gem)
242 # Make sure that we're not running unoack for more than 323 # Make sure that we're not running unpack for more than
243 # one .gem file, since we won't support that at all. 324 # one .gem file, since we won't support that at all.
244 [[ -d "${S}" ]] && die "Unable to unpack ${archive}, ${S} exists" 325 [[ -d "${S}" ]] && die "Unable to unpack ${archive}, ${S} exists"
245 326
246 ebegin "Unpacking .gem file..." 327 ebegin "Unpacking .gem file..."
247 tar -mxf ${DISTDIR}/${archive} || die 328 tar -mxf ${DISTDIR}/${archive} || die
248 eend $? 329 eend $?
249 330
331 ebegin "Uncompressing metadata"
332 gunzip metadata.gz || die
333 eend $?
334
250 mkdir "${S}" 335 mkdir "${S}"
251 pushd "${S}" &>/dev/null 336 pushd "${S}" &>/dev/null
252 337
253 ebegin "Unpacking data.tar.gz" 338 ebegin "Unpacking data.tar.gz"
254 tar -mxf "${my_WORKDIR}"/data.tar.gz || die 339 tar -mxf "${my_WORKDIR}"/data.tar.gz || die
255 eend $? 340 eend $?
341
256 popd &>/dev/null 342 popd &>/dev/null
257 ;; 343 ;;
258 *.patch.bz2) 344 *.patch.bz2)
259 # We apply the patches with RUBY_PATCHES directly from DISTDIR, 345 # We apply the patches with RUBY_PATCHES directly from DISTDIR,
260 # as the WORKDIR variable changes value between the global-scope 346 # as the WORKDIR variable changes value between the global-scope
279 365
280# @FUNCTION: each_fakegem_test 366# @FUNCTION: each_fakegem_test
281# @DESCRIPTION: 367# @DESCRIPTION:
282# Run tests for the package for each ruby target if the test task is defined. 368# Run tests for the package for each ruby target if the test task is defined.
283each_fakegem_test() { 369each_fakegem_test() {
284 local rubyflags= 370 case ${RUBY_FAKEGEM_RECIPE_TEST} in
371 rake)
285 ${RUBY} ${rubyflags} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed" 372 ${RUBY} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed"
373 ;;
374 rspec)
375 ruby-ng_rspec
376 ;;
377 none)
378 ewarn "each_fakegem_test called, but \${RUBY_FAKEGEM_RECIPE_TEST} is 'none'"
379 ;;
380 esac
286} 381}
287 382
288if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then 383if [[ ${RUBY_FAKEGEM_RECIPE_TEST} != none ]]; then
289 # @FUNCTION: each_ruby_test 384 # @FUNCTION: each_ruby_test
290 # @DESCRIPTION: 385 # @DESCRIPTION:
291 # Run the tests for this package. 386 # Run the tests for this package.
292 each_ruby_test() { 387 each_ruby_test() {
293 each_fakegem_test 388 each_fakegem_test
294 } 389 }
295fi 390fi
296 391
297# @FUNCTION: each_fakegem_install 392# @FUNCTION: each_fakegem_install
298# @DESCRIPTION: 393# @DESCRIPTION:
299# Install the package for each ruby target. 394# Install the package for each ruby target.
300each_fakegem_install() { 395each_fakegem_install() {
301 ruby_fakegem_genspec 396 ruby_fakegem_install_gemspec
302 397
303 local _gemlibdirs="${RUBY_FAKEGEM_EXTRAINSTALL}" 398 local _gemlibdirs="${RUBY_FAKEGEM_EXTRAINSTALL}"
304 for directory in bin lib; do 399 for directory in bin lib; do
305 [[ -d ${directory} ]] && _gemlibdirs="${_gemlibdirs} ${directory}" 400 [[ -d ${directory} ]] && _gemlibdirs="${_gemlibdirs} ${directory}"
306 done 401 done

Legend:
Removed from v.1.23  
changed lines
  Added in v.1.33

  ViewVC Help
Powered by ViewVC 1.1.20