/[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.12 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.12 2010/01/21 10:18:59 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:
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
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
62RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}" 71RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}"
63RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV}}" 72RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV/_pre/.pre}}"
73RUBY_FAKEGEM_SUFFIX="${RUBY_FAKEGEM_SUFFIX:-}"
64 74
65RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}" 75RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}"
66RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}" 76RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}"
67 77
68RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}" 78RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}"
69 79
70if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then 80if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then
71 IUSE="$IUSE doc" 81 IUSE="$IUSE doc"
72 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"
73fi 87fi
74 88
75if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then 89if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then
76 IUSE="$IUSE test" 90 IUSE="$IUSE test"
77 ruby_add_bdepend test "dev-ruby/rake" 91 ruby_add_bdepend "test? ( dev-ruby/rake )"
78fi 92fi
79 93
80SRC_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"
81 95
96ruby_add_bdepend virtual/rubygems
82ruby_add_rdepend virtual/rubygems 97ruby_add_rdepend virtual/rubygems
83 98
84# @FUNCTION: ruby_fakegem_gemsdir 99# @FUNCTION: ruby_fakegem_gemsdir
85# @RETURN: Returns the gem data directory 100# @RETURN: Returns the gem data directory
86# @DESCRIPTION: 101# @DESCRIPTION:
87# This function returns the gems data directory for the ruby 102# This function returns the gems data directory for the ruby
88# implementation in question. 103# implementation in question.
89ruby_fakegem_gemsdir() { 104ruby_fakegem_gemsdir() {
90 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}}
91 110
92 [[ -z ${_gemsitedir} ]] && { 111 [[ -z ${_gemsitedir} ]] && {
93 eerror "Unable to find the gems dir" 112 eerror "Unable to find the gems dir"
94 die "Unable to find the gems dir" 113 die "Unable to find the gems dir"
95 } 114 }
124 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}
125 newins "$1" ${newbasename} 144 newins "$1" ${newbasename}
126 ) || die "failed $0 $@" 145 ) || die "failed $0 $@"
127} 146}
128 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
129# @FUNCTION: ruby_fakegem_genspec 194# @FUNCTION: ruby_fakegem_genspec
195# @USAGE: output-gemspec
130# @DESCRIPTION: 196# @DESCRIPTION:
131# 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"
132# 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.
133# In the gemspec, the following values are set: name, version, summary, 203# In the gemspec, the following values are set: name, version, summary,
134# homepage, and require_paths=["lib"]. 204# homepage, and require_paths=["lib"].
135# 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.
136# See RUBY_FAKEGEM_REQUIRE_PATHS for setting extra require paths. 206# See RUBY_FAKEGEM_REQUIRE_PATHS for setting extra require paths.
137ruby_fakegem_genspec() { 207ruby_fakegem_genspec() {
138 (
139 local required_paths="'lib'" 208 local required_paths="'lib'"
140 for path in ${RUBY_FAKEGEM_REQUIRE_PATHS}; do 209 for path in ${RUBY_FAKEGEM_REQUIRE_PATHS}; do
141 required_paths="${required_paths}, '${path}'" 210 required_paths="${required_paths}, '${path}'"
142 done 211 done
143 212
144 # We use the _ruby_implementation variable to avoid having stray 213 # We use the _ruby_implementation variable to avoid having stray
145 # copies with different implementations; while for now we're using 214 # copies with different implementations; while for now we're using
146 # the same exact content, we might have differences in the future, 215 # the same exact content, we might have differences in the future,
147 # so better taking this into consideration. 216 # so better taking this into consideration.
148 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 $
149Gem::Specification.new do |s| 220Gem::Specification.new do |s|
150 s.name = "${RUBY_FAKEGEM_NAME}" 221 s.name = "${RUBY_FAKEGEM_NAME}"
151 s.version = "${RUBY_FAKEGEM_VERSION}" 222 s.version = "${RUBY_FAKEGEM_VERSION}"
152 s.summary = "${DESCRIPTION}" 223 s.summary = "${quoted_description}"
153 s.homepage = "${HOMEPAGE}" 224 s.homepage = "${HOMEPAGE}"
154 s.require_paths = [${required_paths}] 225 s.require_paths = [${required_paths}]
155end 226end
156EOF 227EOF
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} 228}
162 229
163# @FUNCTION: ruby_fakegem_binwrapper 230# @FUNCTION: ruby_fakegem_binwrapper
164# @USAGE: command [path] 231# @USAGE: command [path]
165# @DESCRIPTION: 232# @DESCRIPTION:
171 local newbinary=${2:-/usr/bin/$gembinary} 238 local newbinary=${2:-/usr/bin/$gembinary}
172 local relativegembinary=${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}/bin/${gembinary} 239 local relativegembinary=${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}/bin/${gembinary}
173 local binpath=$(dirname $newbinary) 240 local binpath=$(dirname $newbinary)
174 [[ ${binpath} = . ]] && binpath=/usr/bin 241 [[ ${binpath} = . ]] && binpath=/usr/bin
175 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
264
176 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF 265 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF
177#!/usr/bin/env ruby 266#!${rubycmd}
178# This is a simplified version of the RubyGems wrapper 267# This is a simplified version of the RubyGems wrapper
179# 268#
180# Generated by ruby-fakegem.eclass 269# Generated by ruby-fakegem.eclass $Revision: 1.32 $
181 270
182require 'rubygems' 271require 'rubygems'
183 272
184load Gem::default_path[-1] + "/gems/${relativegembinary}" 273load Gem::default_path[-1] + "/gems/${relativegembinary}"
185 274
205# Unpack the source archive, including support for unpacking gems. 294# Unpack the source archive, including support for unpacking gems.
206all_ruby_unpack() { 295all_ruby_unpack() {
207 # Special support for extracting .gem files; the file need to be 296 # Special support for extracting .gem files; the file need to be
208 # extracted twice and the mtime from the archive _has_ to be 297 # extracted twice and the mtime from the archive _has_ to be
209 # ignored (it's always set to epoch 0). 298 # ignored (it's always set to epoch 0).
210 # 299 for archive in ${A}; do
211 # This only works if there is exactly one archive and that archive 300 case "${archive}" in
212 # is a .gem file! 301 *.gem)
213 if [[ $(wc -w <<< ${A}) == 1 ]] && 302 # Make sure that we're not running unpack for more than
214 [[ ${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
215 ebegin "Unpacking .gem file..." 306 ebegin "Unpacking .gem file..."
216 tar -mxf ${DISTDIR}/${A} || die 307 tar -mxf ${DISTDIR}/${archive} || die
217 eend $? 308 eend $?
218 309
310 ebegin "Uncompressing metadata"
311 gunzip metadata.gz || die
312 eend $?
313
219 mkdir "${S}" 314 mkdir "${S}"
220 pushd "${S}" &>/dev/null 315 pushd "${S}" &>/dev/null
221 316
222 ebegin "Unpacking data.tar.gz" 317 ebegin "Unpacking data.tar.gz"
223 tar -mxf "${my_WORKDIR}"/data.tar.gz || die 318 tar -mxf "${my_WORKDIR}"/data.tar.gz || die
224 eend $? 319 eend $?
320
225 popd &>/dev/null 321 popd &>/dev/null
226 else 322 ;;
227 [[ -n ${A} ]] && unpack ${A} 323 *.patch.bz2)
228 fi 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
229} 336}
230 337
231# @FUNCTION: all_ruby_compile 338# @FUNCTION: all_ruby_compile
232# @DESCRIPTION: 339# @DESCRIPTION:
233# Compile the package. 340# Compile the package.
238# @FUNCTION: each_fakegem_test 345# @FUNCTION: each_fakegem_test
239# @DESCRIPTION: 346# @DESCRIPTION:
240# 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.
241each_fakegem_test() { 348each_fakegem_test() {
242 local rubyflags= 349 local rubyflags=
243
244 if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then
245 ${RUBY} ${rubyflags} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed" 350 ${RUBY} ${rubyflags} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed"
246 else
247 echo "No test task defined, skipping tests."
248 fi
249} 351}
250 352
353if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then
251# @FUNCTION: each_ruby_test 354 # @FUNCTION: each_ruby_test
252# @DESCRIPTION: 355 # @DESCRIPTION:
253# Run the tests for this package. 356 # Run the tests for this package.
254each_ruby_test() { 357 each_ruby_test() {
255 each_fakegem_test 358 each_fakegem_test
256} 359 }
360fi
257 361
258# @FUNCTION: each_fakegem_install 362# @FUNCTION: each_fakegem_install
259# @DESCRIPTION: 363# @DESCRIPTION:
260# Install the package for each ruby target. 364# Install the package for each ruby target.
261each_fakegem_install() { 365each_fakegem_install() {
262 ruby_fakegem_genspec 366 ruby_fakegem_install_gemspec
263 367
264 local _gemlibdirs="${RUBY_FAKEGEM_EXTRAINSTALL}" 368 local _gemlibdirs="${RUBY_FAKEGEM_EXTRAINSTALL}"
265 for directory in bin lib; do 369 for directory in bin lib; do
266 [[ -d ${directory} ]] && _gemlibdirs="${_gemlibdirs} ${directory}" 370 [[ -d ${directory} ]] && _gemlibdirs="${_gemlibdirs} ${directory}"
267 done 371 done
279 383
280# @FUNCTION: all_fakegem_install 384# @FUNCTION: all_fakegem_install
281# @DESCRIPTION: 385# @DESCRIPTION:
282# Install files common to all ruby targets. 386# Install files common to all ruby targets.
283all_fakegem_install() { 387all_fakegem_install() {
284 if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]] && use doc; then 388 if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && use doc; then
285 for dir in ${RUBY_FAKEGEM_DOCDIR}; do 389 for dir in ${RUBY_FAKEGEM_DOCDIR}; do
390 [[ -d ${dir} ]] || continue
391
286 pushd ${dir} &>/dev/null 392 pushd ${dir} &>/dev/null
287 dohtml -r * || die "failed to install documentation" 393 dohtml -r * || die "failed to install documentation"
288 popd &>/dev/null 394 popd &>/dev/null
289 done 395 done
290 fi 396 fi

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

  ViewVC Help
Powered by ViewVC 1.1.20