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

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.25

  ViewVC Help
Powered by ViewVC 1.1.20