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

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.32

  ViewVC Help
Powered by ViewVC 1.1.20