/[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.3 Revision 1.31
1# Copyright 1999-2009 Gentoo Foundation 1# Copyright 1999-2011 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.3 2009/12/15 16:27:46 flameeyes Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/ruby-fakegem.eclass,v 1.31 2011/10/21 06:32:29 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:
29# RUBY_FAKEGEM_VERSION="${PV}" 26# RUBY_FAKEGEM_VERSION="${PV}"
30 27
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_VERSION="rdoc" 31# RUBY_FAKEGEM_TASK_DOC="rdoc"
35 32
36# @ECLASS-VARIABLE: RUBY_FAKEGEM_TASK_TEST 33# @ECLASS-VARIABLE: RUBY_FAKEGEM_TASK_TEST
37# @DESCRIPTION: 34# @DESCRIPTION:
38# Specify the rake(1) task used for executing tests. 35# Specify the rake(1) task used for executing tests.
39# RUBY_FAKEGEM_VERSION="test" 36# RUBY_FAKEGEM_TASK_TEST="test"
37
38# @ECLASS-VARIABLE: RUBY_FAKEGEM_DOCDIR
39# @DESCRIPTION:
40# Specify the directory under which the documentation is built;
41# if empty no documentation will be installed automatically.
42# RUBY_FAKEGEM_DOCDIR=""
43
44# @ECLASS-VARIABLE: RUBY_FAKEGEM_EXTRADOC
45# @DESCRIPTION:
46# Extra documentation to install (readme, changelogs, …).
47# RUBY_FAKEGEM_EXTRADOC=""
48
49# @ECLASS-VARIABLE: RUBY_FAKEGEM_BINWRAP
50# @DESCRIPTION:
51# Binaries to wrap around (relative to the bin/ directory)
52# RUBY_FAKEGEM_BINWRAP="*"
53
54# @ECLASS-VARIABLE: RUBY_FAKEGEM_REQUIRE_PATHS
55# @DESCRIPTION:
56# Extra require paths (beside lib) to add to the specification
57# RUBY_FAKEGEM_REQUIRE_PATHS=""
58
59# @ECLASS-VARIABLE: RUBY_FAKEGEM_GEMSPEC
60# @DESCRIPTION:
61# Filename of .gemspec file to install instead of generating a generic one.
62# RUBY_FAKEGEM_GEMSPEC=""
40 63
41RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}" 64RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}"
42RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV}}" 65RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV/_pre/.pre}}"
66RUBY_FAKEGEM_SUFFIX="${RUBY_FAKEGEM_SUFFIX:-}"
43 67
44RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}" 68RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}"
45RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}" 69RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}"
46 70
71RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}"
72
47if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then 73if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then
48 IUSE="$IUSE doc" 74 IUSE="$IUSE doc"
49 ruby_add_bdepend doc "dev-ruby/rake" 75 ruby_add_bdepend "doc? ( dev-ruby/rake )"
76fi
77
78if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]]; then
79 IUSE="$IUSE doc"
50fi 80fi
51 81
52if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then 82if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then
53 IUSE="$IUSE test" 83 IUSE="$IUSE test"
54 ruby_add_bdepend test "dev-ruby/rake" 84 ruby_add_bdepend "test? ( dev-ruby/rake )"
55fi 85fi
56 86
57SRC_URI="mirror://rubygems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}.gem" 87SRC_URI="mirror://rubygems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${RUBY_FAKEGEM_SUFFIX:+-${RUBY_FAKEGEM_SUFFIX}}.gem"
58 88
89ruby_add_bdepend virtual/rubygems
59ruby_add_rdepend virtual/rubygems 90ruby_add_rdepend virtual/rubygems
60 91
61# @FUNCTION: ruby_fakegem_gemsdir 92# @FUNCTION: ruby_fakegem_gemsdir
62# @RETURN: Returns the gem data directory 93# @RETURN: Returns the gem data directory
63# @DESCRIPTION: 94# @DESCRIPTION:
64# This function returns the gems data directory for the ruby 95# This function returns the gems data directory for the ruby
65# implementation in question. 96# implementation in question.
66ruby_fakegem_gemsdir() { 97ruby_fakegem_gemsdir() {
67 local _gemsitedir=$(${RUBY} -r rbconfig -e 'print Config::CONFIG["sitelibdir"]' | sed -e 's:site_ruby:gems:') 98 has "${EAPI}" 2 && ! use prefix && EPREFIX=
99
100 local _gemsitedir=$(ruby_rbconfig_value 'sitelibdir')
101 _gemsitedir=${_gemsitedir//site_ruby/gems}
102 _gemsitedir=${_gemsitedir#${EPREFIX}}
68 103
69 [[ -z ${_gemsitedir} ]] && { 104 [[ -z ${_gemsitedir} ]] && {
70 eerror "Unable to find the gems dir" 105 eerror "Unable to find the gems dir"
71 die "Unable to find the gems dir" 106 die "Unable to find the gems dir"
72 } 107 }
101 insinto $(ruby_fakegem_gemsdir)/gems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${newdirname} 136 insinto $(ruby_fakegem_gemsdir)/gems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${newdirname}
102 newins "$1" ${newbasename} 137 newins "$1" ${newbasename}
103 ) || die "failed $0 $@" 138 ) || die "failed $0 $@"
104} 139}
105 140
141# @FUNCTION: ruby_fakegem_install_gemspec
142# @DESCRIPTION:
143# Install a .gemspec file for this package. Either use the file indicated
144# by the RUBY_FAKEGEM_GEMSPEC variable, or generate one using
145# ruby_fakegem_genspec.
146ruby_fakegem_install_gemspec() {
147 local gemspec="${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation}
148
149 (
150 if [[ ${RUBY_FAKEGEM_GEMSPEC} != "" ]]; then
151 ruby_fakegem_gemspec_gemspec ${RUBY_FAKEGEM_GEMSPEC} ${gemspec}
152 else
153 local metadata="${WORKDIR}"/${_ruby_implementation}/metadata
154
155 if [[ -e ${metadata} ]]; then
156 ruby_fakegem_metadata_gemspec ${metadata} ${gemspec}
157 else
158 ruby_fakegem_genspec ${gemspec}
159 fi
160 fi
161 ) || die "Unable to generate gemspec file."
162
163 insinto $(ruby_fakegem_gemsdir)/specifications
164 newins ${gemspec} ${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}.gemspec || die "Unable to install gemspec file."
165}
166
167# @FUNCTION: ruby_fakegem_gemspec_gemspec
168# @USAGE: gemspec-input gemspec-output
169# @DESCRIPTION:
170# Generates an installable version of the specification indicated by
171# RUBY_FAKEGEM_GEMSPEC. This file is eval'ed to produce a final specification
172# in a way similar to packaging the gemspec file.
173ruby_fakegem_gemspec_gemspec() {
174 ${RUBY} -e "puts eval(File::open('$1').read).to_ruby" > $2
175}
176
177# @FUNCTION: ruby_fakegem_metadata_gemspec
178# @USAGE: gemspec-metadata gemspec-output
179# @DESCRIPTION:
180# Generates an installable version of the specification indicated by
181# the metadata distributed by the gem itself. This is similar to how
182# rubygems creates an installation from a .gem file.
183ruby_fakegem_metadata_gemspec() {
184 ${RUBY} -r yaml -e "puts Gem::Specification.from_yaml(File::open('$1').read).to_ruby" > $2
185}
186
106# @FUNCTION: ruby_fakegem_genspec 187# @FUNCTION: ruby_fakegem_genspec
188# @USAGE: output-gemspec
107# @DESCRIPTION: 189# @DESCRIPTION:
108# Generates a gemspec for the package and places it into the "specifications" 190# Generates a gemspec for the package and places it into the "specifications"
109# directory of RubyGems. 191# directory of RubyGems.
192# If the metadata normally distributed with a gem is present then that is
193# used to generate the gemspec file.
194#
195# As a fallback we can generate our own version.
110# In the gemspec, the following values are set: name, version, summary, 196# In the gemspec, the following values are set: name, version, summary,
111# homepage, and require_paths=["lib"]. 197# homepage, and require_paths=["lib"].
112# See RUBY_FAKEGEM_NAME and RUBY_FAKEGEM_VERSION for setting name and version. 198# See RUBY_FAKEGEM_NAME and RUBY_FAKEGEM_VERSION for setting name and version.
199# See RUBY_FAKEGEM_REQUIRE_PATHS for setting extra require paths.
113ruby_fakegem_genspec() { 200ruby_fakegem_genspec() {
114 ( 201 local required_paths="'lib'"
202 for path in ${RUBY_FAKEGEM_REQUIRE_PATHS}; do
203 required_paths="${required_paths}, '${path}'"
204 done
205
115 # We use the _ruby_implementation variable to avoid having stray 206 # We use the _ruby_implementation variable to avoid having stray
116 # copies with different implementations; while for now we're using 207 # copies with different implementations; while for now we're using
117 # the same exact content, we might have differences in the future, 208 # the same exact content, we might have differences in the future,
118 # so better taking this into consideration. 209 # so better taking this into consideration.
119 cat - > "${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation} <<EOF 210 local quoted_description=${DESCRIPTION//\"/\\\"}
211 cat - > $1 <<EOF
212# generated by ruby-fakegem.eclass $Revision: 1.31 $
120Gem::Specification.new do |s| 213Gem::Specification.new do |s|
121 s.name = "${RUBY_FAKEGEM_NAME}" 214 s.name = "${RUBY_FAKEGEM_NAME}"
122 s.version = "${RUBY_FAKEGEM_VERSION}" 215 s.version = "${RUBY_FAKEGEM_VERSION}"
123 s.summary = "${DESCRIPTION}" 216 s.summary = "${quoted_description}"
124 s.homepage = "${HOMEPAGE}" 217 s.homepage = "${HOMEPAGE}"
125 s.require_paths = ["lib"] 218 s.require_paths = [${required_paths}]
126end 219end
127EOF 220EOF
128
129 insinto $(ruby_fakegem_gemsdir)/specifications
130 newins "${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation} ${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}.gemspec
131 ) || die "Unable to install fake gemspec"
132} 221}
133 222
134# @FUNCTION: ruby_fakegem_binwrapper 223# @FUNCTION: ruby_fakegem_binwrapper
135# @USAGE: command [path] 224# @USAGE: command [path]
136# @DESCRIPTION: 225# @DESCRIPTION:
138# path defaults to /usr/bin/$command 227# path defaults to /usr/bin/$command
139ruby_fakegem_binwrapper() { 228ruby_fakegem_binwrapper() {
140 ( 229 (
141 local gembinary=$1 230 local gembinary=$1
142 local newbinary=${2:-/usr/bin/$gembinary} 231 local newbinary=${2:-/usr/bin/$gembinary}
232 local relativegembinary=${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}/bin/${gembinary}
233 local binpath=$(dirname $newbinary)
234 [[ ${binpath} = . ]] && binpath=/usr/bin
235
236 # Try to find out whether the package is going to install for
237 # one or multiple implementations; if we're installing for a
238 # *single* implementation, no need to use “/usr/bin/env ruby”
239 # in the shebang, and we can actually avoid errors when
240 # calling the script by default (see for instance the
241 # JRuby-specific commands).
242 local rubycmd=
243 for implementation in ${USE_RUBY}; do
244 # ignore non-enabled implementations
245 use ruby_targets_${implementation} || continue
246 if [ -z $rubycmd ]; then
247 # if no other implementation was set before, set it.
248 rubycmd="$(ruby_implementation_command ${implementation})"
249 else
250 # if another implementation already arrived, then make
251 # it generic and break out of the loop. This ensures
252 # that we do at most two iterations.
253 rubycmd="/usr/bin/env ruby"
254 break
255 fi
256 done
143 257
144 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF 258 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF
145#!/usr/bin/env ruby 259#!${rubycmd}
146# This is a simplified version of the RubyGems wrapper 260# This is a simplified version of the RubyGems wrapper
147# 261#
148# Generated by ruby-fakegem.eclass 262# Generated by ruby-fakegem.eclass $Revision: 1.31 $
149 263
150require 'rubygems' 264require 'rubygems'
151 265
152load Gem::GemPathSearcher.new.find('$(tr [A-Z] [a-z] <<< ${RUBY_FAKEGEM_NAME})').full_gem_path + "/bin/${gembinary}" 266load Gem::default_path[-1] + "/gems/${relativegembinary}"
153 267
154EOF 268EOF
155 269
156 exeinto $(dirname $newbinary) 270 exeinto ${binpath:-/usr/bin}
157 newexe "${T}"/gembin-wrapper-${gembinary} $(basename $newbinary) 271 newexe "${T}"/gembin-wrapper-${gembinary} $(basename $newbinary)
158 ) || die "Unable to create fakegem wrapper" 272 ) || die "Unable to create fakegem wrapper"
159} 273}
160 274
161# @FUNCTION: all_fakegem_compile 275# @FUNCTION: all_fakegem_compile
173# Unpack the source archive, including support for unpacking gems. 287# Unpack the source archive, including support for unpacking gems.
174all_ruby_unpack() { 288all_ruby_unpack() {
175 # Special support for extracting .gem files; the file need to be 289 # Special support for extracting .gem files; the file need to be
176 # extracted twice and the mtime from the archive _has_ to be 290 # extracted twice and the mtime from the archive _has_ to be
177 # ignored (it's always set to epoch 0). 291 # ignored (it's always set to epoch 0).
178 # 292 for archive in ${A}; do
179 # This only works if there is exactly one archive and that archive 293 case "${archive}" in
180 # is a .gem file! 294 *.gem)
181 if [[ $(wc -w <<< ${A}) == 1 ]] && 295 # Make sure that we're not running unpack for more than
182 [[ ${A} == *.gem ]]; then 296 # one .gem file, since we won't support that at all.
297 [[ -d "${S}" ]] && die "Unable to unpack ${archive}, ${S} exists"
298
183 ebegin "Unpacking .gem file..." 299 ebegin "Unpacking .gem file..."
184 tar -mxf ${DISTDIR}/${A} || die 300 tar -mxf ${DISTDIR}/${archive} || die
185 eend $? 301 eend $?
186 302
303 ebegin "Uncompressing metadata"
304 gunzip metadata.gz || die
305 eend $?
306
187 mkdir "${S}" 307 mkdir "${S}"
188 pushd "${S}" 308 pushd "${S}" &>/dev/null
189 309
190 ebegin "Unpacking data.tar.gz" 310 ebegin "Unpacking data.tar.gz"
191 tar -mxf "${my_WORKDIR}"/data.tar.gz || die 311 tar -mxf "${my_WORKDIR}"/data.tar.gz || die
192 eend $? 312 eend $?
193 else 313
194 [[ -n ${A} ]] && unpack ${A} 314 popd &>/dev/null
195 fi 315 ;;
316 *.patch.bz2)
317 # We apply the patches with RUBY_PATCHES directly from DISTDIR,
318 # as the WORKDIR variable changes value between the global-scope
319 # and the time all_ruby_unpack/_prepare are called. Since we can
320 # simply decompress them when applying, this is much easier to
321 # deal with for us.
322 einfo "Keeping ${archive} as-is"
323 ;;
324 *)
325 unpack ${archive}
326 ;;
327 esac
328 done
196} 329}
197 330
198# @FUNCTION: all_ruby_compile 331# @FUNCTION: all_ruby_compile
199# @DESCRIPTION: 332# @DESCRIPTION:
200# Compile the package. 333# Compile the package.
205# @FUNCTION: each_fakegem_test 338# @FUNCTION: each_fakegem_test
206# @DESCRIPTION: 339# @DESCRIPTION:
207# Run tests for the package for each ruby target if the test task is defined. 340# Run tests for the package for each ruby target if the test task is defined.
208each_fakegem_test() { 341each_fakegem_test() {
209 local rubyflags= 342 local rubyflags=
210
211 if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then
212 ${RUBY} ${rubyflags} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed" 343 ${RUBY} ${rubyflags} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed"
213 else
214 echo "No test task defined, skipping tests."
215 fi
216} 344}
217 345
346if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then
218# @FUNCTION: each_ruby_test 347 # @FUNCTION: each_ruby_test
219# @DESCRIPTION: 348 # @DESCRIPTION:
220# Run the tests for this package. 349 # Run the tests for this package.
221each_ruby_test() { 350 each_ruby_test() {
222 each_fakegem_test 351 each_fakegem_test
223} 352 }
353fi
224 354
225# @FUNCTION: each_fakegem_install 355# @FUNCTION: each_fakegem_install
226# @DESCRIPTION: 356# @DESCRIPTION:
227# Install the package for each ruby target. 357# Install the package for each ruby target.
228each_fakegem_install() { 358each_fakegem_install() {
229 ruby_fakegem_genspec 359 ruby_fakegem_install_gemspec
230 360
231 local _gemlibdirs= 361 local _gemlibdirs="${RUBY_FAKEGEM_EXTRAINSTALL}"
232 for directory in bin lib ${RUBY_FAKEGEM_EXTRAINSTALL}; do 362 for directory in bin lib; do
233 [[ -d ${directory} ]] && _gemlibdirs="${_gemlibdirs} ${directory}" 363 [[ -d ${directory} ]] && _gemlibdirs="${_gemlibdirs} ${directory}"
234 done 364 done
235 365
366 [[ -n ${_gemlibdirs} ]] && \
236 ruby_fakegem_doins -r ${_gemlibdirs} 367 ruby_fakegem_doins -r ${_gemlibdirs}
237} 368}
238 369
239# @FUNCTION: each_ruby_install 370# @FUNCTION: each_ruby_install
240# @DESCRIPTION: 371# @DESCRIPTION:
241# Install the package for each target. 372# Install the package for each target.
246# @FUNCTION: all_fakegem_install 377# @FUNCTION: all_fakegem_install
247# @DESCRIPTION: 378# @DESCRIPTION:
248# Install files common to all ruby targets. 379# Install files common to all ruby targets.
249all_fakegem_install() { 380all_fakegem_install() {
250 if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && use doc; then 381 if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && use doc; then
251 pushd ${RUBY_FAKEGEM_DOCDIR} 382 for dir in ${RUBY_FAKEGEM_DOCDIR}; do
383 [[ -d ${dir} ]] || continue
384
385 pushd ${dir} &>/dev/null
252 dohtml -r * || die "failed to install documentation" 386 dohtml -r * || die "failed to install documentation"
253 popd 387 popd &>/dev/null
388 done
254 fi 389 fi
255 390
256 if [[ -n ${RUBY_FAKEGEM_EXTRADOC} ]]; then 391 if [[ -n ${RUBY_FAKEGEM_EXTRADOC} ]]; then
257 dodoc ${RUBY_FAKEGEM_EXTRADOC} || die "failed to install further documentation" 392 dodoc ${RUBY_FAKEGEM_EXTRADOC} || die "failed to install further documentation"
258 fi 393 fi
394
395 # binary wrappers; we assume that all the implementations get the
396 # same binaries, or something is wrong anyway, so...
397 if [[ -n ${RUBY_FAKEGEM_BINWRAP} ]]; then
398 local bindir=$(find "${D}" -type d -path "*/gems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}/bin" -print -quit)
399
400 if [[ -d "${bindir}" ]]; then
401 pushd "${bindir}" &>/dev/null
402 local binaries=$(eval ls ${RUBY_FAKEGEM_BINWRAP})
403 for binary in $binaries; do
404 ruby_fakegem_binwrapper $binary
405 done
406 popd &>/dev/null
407 fi
408 fi
259} 409}
260 410
261# @FUNCTION: all_ruby_install 411# @FUNCTION: all_ruby_install
262# @DESCRIPTION: 412# @DESCRIPTION:
263# Install files common to all ruby targets. 413# Install files common to all ruby targets.

Legend:
Removed from v.1.3  
changed lines
  Added in v.1.31

  ViewVC Help
Powered by ViewVC 1.1.20