/[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.10 Revision 1.30
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.10 2010/01/09 21:16:37 flameeyes Exp $ 3# $Header: /var/cvsroot/gentoo-x86/eclass/ruby-fakegem.eclass,v 1.30 2011/08/22 04:46:32 vapier 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:
57# @ECLASS-VARIABLE: RUBY_FAKEGEM_REQUIRE_PATHS 54# @ECLASS-VARIABLE: RUBY_FAKEGEM_REQUIRE_PATHS
58# @DESCRIPTION: 55# @DESCRIPTION:
59# Extra require paths (beside lib) to add to the specification 56# Extra require paths (beside lib) to add to the specification
60# RUBY_FAKEGEM_REQUIRE_PATHS="" 57# RUBY_FAKEGEM_REQUIRE_PATHS=""
61 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
62RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}" 64RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}"
63RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV}}" 65RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV/_pre/.pre}}"
66RUBY_FAKEGEM_SUFFIX="${RUBY_FAKEGEM_SUFFIX:-}"
64 67
65RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}" 68RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}"
66RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}" 69RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}"
67 70
68RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}" 71RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}"
69 72
70if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then 73if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then
71 IUSE="$IUSE doc" 74 IUSE="$IUSE doc"
72 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"
73fi 80fi
74 81
75if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then 82if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then
76 IUSE="$IUSE test" 83 IUSE="$IUSE test"
77 ruby_add_bdepend test "dev-ruby/rake" 84 ruby_add_bdepend "test? ( dev-ruby/rake )"
78fi 85fi
79 86
80SRC_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"
81 88
89ruby_add_bdepend dev-ruby/rubygems
82ruby_add_rdepend virtual/rubygems 90ruby_add_rdepend dev-ruby/rubygems
83 91
84# @FUNCTION: ruby_fakegem_gemsdir 92# @FUNCTION: ruby_fakegem_gemsdir
85# @RETURN: Returns the gem data directory 93# @RETURN: Returns the gem data directory
86# @DESCRIPTION: 94# @DESCRIPTION:
87# This function returns the gems data directory for the ruby 95# This function returns the gems data directory for the ruby
88# implementation in question. 96# implementation in question.
89ruby_fakegem_gemsdir() { 97ruby_fakegem_gemsdir() {
90 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}}
91 103
92 [[ -z ${_gemsitedir} ]] && { 104 [[ -z ${_gemsitedir} ]] && {
93 eerror "Unable to find the gems dir" 105 eerror "Unable to find the gems dir"
94 die "Unable to find the gems dir" 106 die "Unable to find the gems dir"
95 } 107 }
124 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}
125 newins "$1" ${newbasename} 137 newins "$1" ${newbasename}
126 ) || die "failed $0 $@" 138 ) || die "failed $0 $@"
127} 139}
128 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
129# @FUNCTION: ruby_fakegem_genspec 187# @FUNCTION: ruby_fakegem_genspec
188# @USAGE: output-gemspec
130# @DESCRIPTION: 189# @DESCRIPTION:
131# 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"
132# 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.
133# In the gemspec, the following values are set: name, version, summary, 196# In the gemspec, the following values are set: name, version, summary,
134# homepage, and require_paths=["lib"]. 197# homepage, and require_paths=["lib"].
135# 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.
136# See RUBY_FAKEGEM_REQUIRE_PATHS for setting extra require paths. 199# See RUBY_FAKEGEM_REQUIRE_PATHS for setting extra require paths.
137ruby_fakegem_genspec() { 200ruby_fakegem_genspec() {
138 (
139 local required_paths="'lib'" 201 local required_paths="'lib'"
140 for path in ${RUBY_FAKEGEM_REQUIRE_PATHS}; do 202 for path in ${RUBY_FAKEGEM_REQUIRE_PATHS}; do
141 required_paths="${required_paths}, '${path}'" 203 required_paths="${required_paths}, '${path}'"
142 done 204 done
143 205
144 # We use the _ruby_implementation variable to avoid having stray 206 # We use the _ruby_implementation variable to avoid having stray
145 # copies with different implementations; while for now we're using 207 # copies with different implementations; while for now we're using
146 # the same exact content, we might have differences in the future, 208 # the same exact content, we might have differences in the future,
147 # so better taking this into consideration. 209 # so better taking this into consideration.
148 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.30 $
149Gem::Specification.new do |s| 213Gem::Specification.new do |s|
150 s.name = "${RUBY_FAKEGEM_NAME}" 214 s.name = "${RUBY_FAKEGEM_NAME}"
151 s.version = "${RUBY_FAKEGEM_VERSION}" 215 s.version = "${RUBY_FAKEGEM_VERSION}"
152 s.summary = "${DESCRIPTION}" 216 s.summary = "${quoted_description}"
153 s.homepage = "${HOMEPAGE}" 217 s.homepage = "${HOMEPAGE}"
154 s.require_paths = [${required_paths}] 218 s.require_paths = [${required_paths}]
155end 219end
156EOF 220EOF
157
158 insinto $(ruby_fakegem_gemsdir)/specifications
159 newins "${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation} ${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}.gemspec
160 ) || die "Unable to install fake gemspec"
161} 221}
162 222
163# @FUNCTION: ruby_fakegem_binwrapper 223# @FUNCTION: ruby_fakegem_binwrapper
164# @USAGE: command [path] 224# @USAGE: command [path]
165# @DESCRIPTION: 225# @DESCRIPTION:
168ruby_fakegem_binwrapper() { 228ruby_fakegem_binwrapper() {
169 ( 229 (
170 local gembinary=$1 230 local gembinary=$1
171 local newbinary=${2:-/usr/bin/$gembinary} 231 local newbinary=${2:-/usr/bin/$gembinary}
172 local relativegembinary=${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}/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
173 257
174 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF 258 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF
175#!/usr/bin/env ruby 259#!${rubycmd}
176# This is a simplified version of the RubyGems wrapper 260# This is a simplified version of the RubyGems wrapper
177# 261#
178# Generated by ruby-fakegem.eclass 262# Generated by ruby-fakegem.eclass $Revision: 1.30 $
179 263
180require 'rubygems' 264require 'rubygems'
181 265
182load Gem::default_path[-1] + "/gems/${relativegembinary}" 266load Gem::default_path[-1] + "/gems/${relativegembinary}"
183 267
184EOF 268EOF
185 269
186 exeinto $(dirname $newbinary) 270 exeinto ${binpath:-/usr/bin}
187 newexe "${T}"/gembin-wrapper-${gembinary} $(basename $newbinary) 271 newexe "${T}"/gembin-wrapper-${gembinary} $(basename $newbinary)
188 ) || die "Unable to create fakegem wrapper" 272 ) || die "Unable to create fakegem wrapper"
189} 273}
190 274
191# @FUNCTION: all_fakegem_compile 275# @FUNCTION: all_fakegem_compile
203# Unpack the source archive, including support for unpacking gems. 287# Unpack the source archive, including support for unpacking gems.
204all_ruby_unpack() { 288all_ruby_unpack() {
205 # Special support for extracting .gem files; the file need to be 289 # Special support for extracting .gem files; the file need to be
206 # extracted twice and the mtime from the archive _has_ to be 290 # extracted twice and the mtime from the archive _has_ to be
207 # ignored (it's always set to epoch 0). 291 # ignored (it's always set to epoch 0).
208 # 292 for archive in ${A}; do
209 # This only works if there is exactly one archive and that archive 293 case "${archive}" in
210 # is a .gem file! 294 *.gem)
211 if [[ $(wc -w <<< ${A}) == 1 ]] && 295 # Make sure that we're not running unpack for more than
212 [[ ${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
213 ebegin "Unpacking .gem file..." 299 ebegin "Unpacking .gem file..."
214 tar -mxf ${DISTDIR}/${A} || die 300 tar -mxf ${DISTDIR}/${archive} || die
215 eend $? 301 eend $?
216 302
303 ebegin "Uncompressing metadata"
304 gunzip metadata.gz || die
305 eend $?
306
217 mkdir "${S}" 307 mkdir "${S}"
218 pushd "${S}" 308 pushd "${S}" &>/dev/null
219 309
220 ebegin "Unpacking data.tar.gz" 310 ebegin "Unpacking data.tar.gz"
221 tar -mxf "${my_WORKDIR}"/data.tar.gz || die 311 tar -mxf "${my_WORKDIR}"/data.tar.gz || die
222 eend $? 312 eend $?
223 else 313
224 [[ -n ${A} ]] && unpack ${A} 314 popd &>/dev/null
225 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
226} 329}
227 330
228# @FUNCTION: all_ruby_compile 331# @FUNCTION: all_ruby_compile
229# @DESCRIPTION: 332# @DESCRIPTION:
230# Compile the package. 333# Compile the package.
235# @FUNCTION: each_fakegem_test 338# @FUNCTION: each_fakegem_test
236# @DESCRIPTION: 339# @DESCRIPTION:
237# 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.
238each_fakegem_test() { 341each_fakegem_test() {
239 local rubyflags= 342 local rubyflags=
240
241 if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then
242 ${RUBY} ${rubyflags} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed" 343 ${RUBY} ${rubyflags} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed"
243 else
244 echo "No test task defined, skipping tests."
245 fi
246} 344}
247 345
346if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then
248# @FUNCTION: each_ruby_test 347 # @FUNCTION: each_ruby_test
249# @DESCRIPTION: 348 # @DESCRIPTION:
250# Run the tests for this package. 349 # Run the tests for this package.
251each_ruby_test() { 350 each_ruby_test() {
252 each_fakegem_test 351 each_fakegem_test
253} 352 }
353fi
254 354
255# @FUNCTION: each_fakegem_install 355# @FUNCTION: each_fakegem_install
256# @DESCRIPTION: 356# @DESCRIPTION:
257# Install the package for each ruby target. 357# Install the package for each ruby target.
258each_fakegem_install() { 358each_fakegem_install() {
259 ruby_fakegem_genspec 359 ruby_fakegem_install_gemspec
260 360
261 local _gemlibdirs= 361 local _gemlibdirs="${RUBY_FAKEGEM_EXTRAINSTALL}"
262 for directory in bin lib ${RUBY_FAKEGEM_EXTRAINSTALL}; do 362 for directory in bin lib; do
263 [[ -d ${directory} ]] && _gemlibdirs="${_gemlibdirs} ${directory}" 363 [[ -d ${directory} ]] && _gemlibdirs="${_gemlibdirs} ${directory}"
264 done 364 done
265 365
266 [[ -n ${_gemlibdirs} ]] && \ 366 [[ -n ${_gemlibdirs} ]] && \
267 ruby_fakegem_doins -r ${_gemlibdirs} 367 ruby_fakegem_doins -r ${_gemlibdirs}
276 376
277# @FUNCTION: all_fakegem_install 377# @FUNCTION: all_fakegem_install
278# @DESCRIPTION: 378# @DESCRIPTION:
279# Install files common to all ruby targets. 379# Install files common to all ruby targets.
280all_fakegem_install() { 380all_fakegem_install() {
281 if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]] && use doc; then 381 if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && use doc; then
282 for dir in ${RUBY_FAKEGEM_DOCDIR}; do 382 for dir in ${RUBY_FAKEGEM_DOCDIR}; do
283 pushd ${dir} 383 [[ -d ${dir} ]] || continue
384
385 pushd ${dir} &>/dev/null
284 dohtml -r * || die "failed to install documentation" 386 dohtml -r * || die "failed to install documentation"
285 popd 387 popd &>/dev/null
286 done 388 done
287 fi 389 fi
288 390
289 if [[ -n ${RUBY_FAKEGEM_EXTRADOC} ]]; then 391 if [[ -n ${RUBY_FAKEGEM_EXTRADOC} ]]; then
290 dodoc ${RUBY_FAKEGEM_EXTRADOC} || die "failed to install further documentation" 392 dodoc ${RUBY_FAKEGEM_EXTRADOC} || die "failed to install further documentation"
294 # same binaries, or something is wrong anyway, so... 396 # same binaries, or something is wrong anyway, so...
295 if [[ -n ${RUBY_FAKEGEM_BINWRAP} ]]; then 397 if [[ -n ${RUBY_FAKEGEM_BINWRAP} ]]; then
296 local bindir=$(find "${D}" -type d -path "*/gems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}/bin" -print -quit) 398 local bindir=$(find "${D}" -type d -path "*/gems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}/bin" -print -quit)
297 399
298 if [[ -d "${bindir}" ]]; then 400 if [[ -d "${bindir}" ]]; then
299 pushd "${bindir}" 401 pushd "${bindir}" &>/dev/null
300 local binaries=$(eval ls ${RUBY_FAKEGEM_BINWRAP}) 402 local binaries=$(eval ls ${RUBY_FAKEGEM_BINWRAP})
301 for binary in $binaries; do 403 for binary in $binaries; do
302 ruby_fakegem_binwrapper $binary 404 ruby_fakegem_binwrapper $binary
303 done 405 done
304 popd 406 popd &>/dev/null
305 fi 407 fi
306 fi 408 fi
307} 409}
308 410
309# @FUNCTION: all_ruby_install 411# @FUNCTION: all_ruby_install

Legend:
Removed from v.1.10  
changed lines
  Added in v.1.30

  ViewVC Help
Powered by ViewVC 1.1.20