/[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.23
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.23 2010/08/30 22:08:24 flameeyes 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=""
42 61
43RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}" 62RUBY_FAKEGEM_NAME="${RUBY_FAKEGEM_NAME:-${PN}}"
44RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV}}" 63RUBY_FAKEGEM_VERSION="${RUBY_FAKEGEM_VERSION:-${PV/_pre/.pre}}"
64RUBY_FAKEGEM_SUFFIX="${RUBY_FAKEGEM_SUFFIX:-}"
45 65
46RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}" 66RUBY_FAKEGEM_TASK_DOC="${RUBY_FAKEGEM_TASK_DOC-rdoc}"
47RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}" 67RUBY_FAKEGEM_TASK_TEST="${RUBY_FAKEGEM_TASK_TEST-test}"
48 68
69RUBY_FAKEGEM_BINWRAP="${RUBY_FAKEGEM_BINWRAP-*}"
70
49if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then 71if [[ ${RUBY_FAKEGEM_TASK_DOC} != "" ]]; then
50 IUSE="$IUSE doc" 72 IUSE="$IUSE doc"
51 ruby_add_bdepend doc "dev-ruby/rake" 73 ruby_add_bdepend "doc? ( dev-ruby/rake )"
74fi
75
76if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]]; then
77 IUSE="$IUSE doc"
52fi 78fi
53 79
54if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then 80if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then
55 IUSE="$IUSE test" 81 IUSE="$IUSE test"
56 ruby_add_bdepend test "dev-ruby/rake" 82 ruby_add_bdepend "test? ( dev-ruby/rake )"
57fi 83fi
84
85SRC_URI="mirror://rubygems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}${RUBY_FAKEGEM_SUFFIX:+-${RUBY_FAKEGEM_SUFFIX}}.gem"
58 86
59ruby_add_rdepend virtual/rubygems 87ruby_add_rdepend virtual/rubygems
60 88
61# @FUNCTION: ruby_fakegem_gemsdir 89# @FUNCTION: ruby_fakegem_gemsdir
62# @RETURN: Returns the gem data directory 90# @RETURN: Returns the gem data directory
108# Generates a gemspec for the package and places it into the "specifications" 136# Generates a gemspec for the package and places it into the "specifications"
109# directory of RubyGems. 137# directory of RubyGems.
110# In the gemspec, the following values are set: name, version, summary, 138# In the gemspec, the following values are set: name, version, summary,
111# homepage, and require_paths=["lib"]. 139# homepage, and require_paths=["lib"].
112# See RUBY_FAKEGEM_NAME and RUBY_FAKEGEM_VERSION for setting name and version. 140# See RUBY_FAKEGEM_NAME and RUBY_FAKEGEM_VERSION for setting name and version.
141# See RUBY_FAKEGEM_REQUIRE_PATHS for setting extra require paths.
113ruby_fakegem_genspec() { 142ruby_fakegem_genspec() {
114 ( 143 (
144 local required_paths="'lib'"
145 for path in ${RUBY_FAKEGEM_REQUIRE_PATHS}; do
146 required_paths="${required_paths}, '${path}'"
147 done
148
115 # We use the _ruby_implementation variable to avoid having stray 149 # We use the _ruby_implementation variable to avoid having stray
116 # copies with different implementations; while for now we're using 150 # copies with different implementations; while for now we're using
117 # the same exact content, we might have differences in the future, 151 # the same exact content, we might have differences in the future,
118 # so better taking this into consideration. 152 # so better taking this into consideration.
153 local quoted_description=${DESCRIPTION//\"/\\\"}
119 cat - > "${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation} <<EOF 154 cat - > "${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation} <<EOF
155# generated by ruby-fakegem.eclass $Revision: 1.23 $
120Gem::Specification.new do |s| 156Gem::Specification.new do |s|
121 s.name = "${RUBY_FAKEGEM_NAME}" 157 s.name = "${RUBY_FAKEGEM_NAME}"
122 s.version = "${RUBY_FAKEGEM_VERSION}" 158 s.version = "${RUBY_FAKEGEM_VERSION}"
123 s.summary = "${DESCRIPTION}" 159 s.summary = "${quoted_description}"
124 s.homepage = "${HOMEPAGE}" 160 s.homepage = "${HOMEPAGE}"
125 s.require_paths = ["lib"] 161 s.require_paths = [${required_paths}]
126end 162end
127EOF 163EOF
128 164
129 insinto $(ruby_fakegem_gemsdir)/specifications 165 insinto $(ruby_fakegem_gemsdir)/specifications
130 newins "${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation} ${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}.gemspec 166 newins "${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation} ${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}.gemspec
138# path defaults to /usr/bin/$command 174# path defaults to /usr/bin/$command
139ruby_fakegem_binwrapper() { 175ruby_fakegem_binwrapper() {
140 ( 176 (
141 local gembinary=$1 177 local gembinary=$1
142 local newbinary=${2:-/usr/bin/$gembinary} 178 local newbinary=${2:-/usr/bin/$gembinary}
179 local relativegembinary=${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}/bin/${gembinary}
180 local binpath=$(dirname $newbinary)
181 [[ ${binpath} = . ]] && binpath=/usr/bin
182
183 # Try to find out whether the package is going to install for
184 # one or multiple implementations; if we're installing for a
185 # *single* implementation, no need to use “/usr/bin/env ruby”
186 # in the shebang, and we can actually avoid errors when
187 # calling the script by default (see for instance the
188 # JRuby-specific commands).
189 local rubycmd=
190 for implementation in ${USE_RUBY}; do
191 # ignore non-enabled implementations
192 use ruby_targets_${implementation} || continue
193 if [ -z $rubycmd ]; then
194 # if no other implementation was set before, set it.
195 rubycmd="$(ruby_implementation_command ${implementation})"
196 else
197 # if another implementation already arrived, then make
198 # it generic and break out of the loop. This ensures
199 # that we do at most two iterations.
200 rubycmd="/usr/bin/env ruby"
201 break
202 fi
203 done
143 204
144 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF 205 cat - > "${T}"/gembin-wrapper-${gembinary} <<EOF
145#!/usr/bin/env ruby 206#!${rubycmd}
146# This is a simplified version of the RubyGems wrapper 207# This is a simplified version of the RubyGems wrapper
147# 208#
148# Generated by ruby-fakegem.eclass 209# Generated by ruby-fakegem.eclass $Revision: 1.23 $
149 210
150require 'rubygems' 211require 'rubygems'
151 212
152load Gem::GemPathSearcher.new.find('$(tr [A-Z] [a-z] <<< ${RUBY_FAKEGEM_NAME})').full_gem_path + "/bin/${gembinary}" 213load Gem::default_path[-1] + "/gems/${relativegembinary}"
153 214
154EOF 215EOF
155 216
156 exeinto $(dirname $newbinary) 217 exeinto ${binpath:-/usr/bin}
157 newexe "${T}"/gembin-wrapper-${gembinary} $(basename $newbinary) 218 newexe "${T}"/gembin-wrapper-${gembinary} $(basename $newbinary)
158 ) || die "Unable to create fakegem wrapper" 219 ) || die "Unable to create fakegem wrapper"
159} 220}
160 221
161# @FUNCTION: all_fakegem_compile 222# @FUNCTION: all_fakegem_compile
173# Unpack the source archive, including support for unpacking gems. 234# Unpack the source archive, including support for unpacking gems.
174all_ruby_unpack() { 235all_ruby_unpack() {
175 # Special support for extracting .gem files; the file need to be 236 # Special support for extracting .gem files; the file need to be
176 # extracted twice and the mtime from the archive _has_ to be 237 # extracted twice and the mtime from the archive _has_ to be
177 # ignored (it's always set to epoch 0). 238 # ignored (it's always set to epoch 0).
178 # 239 for archive in ${A}; do
179 # This only works if there is exactly one archive and that archive 240 case "${archive}" in
180 # is a .gem file! 241 *.gem)
181 if [[ $(wc -w <<< ${A}) == 1 ]] && 242 # Make sure that we're not running unoack for more than
182 [[ ${A} == *.gem ]]; then 243 # one .gem file, since we won't support that at all.
244 [[ -d "${S}" ]] && die "Unable to unpack ${archive}, ${S} exists"
245
183 ebegin "Unpacking .gem file..." 246 ebegin "Unpacking .gem file..."
184 tar -mxf ${DISTDIR}/${A} || die 247 tar -mxf ${DISTDIR}/${archive} || die
185 eend $? 248 eend $?
186 249
187 mkdir "${S}" 250 mkdir "${S}"
188 pushd "${S}" 251 pushd "${S}" &>/dev/null
189 252
190 ebegin "Unpacking data.tar.gz" 253 ebegin "Unpacking data.tar.gz"
191 tar -mxf "${my_WORKDIR}"/data.tar.gz || die 254 tar -mxf "${my_WORKDIR}"/data.tar.gz || die
192 eend $? 255 eend $?
193 else 256 popd &>/dev/null
194 [[ -n ${A} ]] && unpack ${A} 257 ;;
195 fi 258 *.patch.bz2)
259 # We apply the patches with RUBY_PATCHES directly from DISTDIR,
260 # as the WORKDIR variable changes value between the global-scope
261 # and the time all_ruby_unpack/_prepare are called. Since we can
262 # simply decompress them when applying, this is much easier to
263 # deal with for us.
264 einfo "Keeping ${archive} as-is"
265 ;;
266 *)
267 unpack ${archive}
268 ;;
269 esac
270 done
196} 271}
197 272
198# @FUNCTION: all_ruby_compile 273# @FUNCTION: all_ruby_compile
199# @DESCRIPTION: 274# @DESCRIPTION:
200# Compile the package. 275# Compile the package.
205# @FUNCTION: each_fakegem_test 280# @FUNCTION: each_fakegem_test
206# @DESCRIPTION: 281# @DESCRIPTION:
207# Run tests for the package for each ruby target if the test task is defined. 282# Run tests for the package for each ruby target if the test task is defined.
208each_fakegem_test() { 283each_fakegem_test() {
209 local rubyflags= 284 local rubyflags=
210
211 if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then
212 ${RUBY} ${rubyflags} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed" 285 ${RUBY} ${rubyflags} -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed"
213 else
214 echo "No test task defined, skipping tests."
215 fi
216} 286}
217 287
288if [[ ${RUBY_FAKEGEM_TASK_TEST} != "" ]]; then
218# @FUNCTION: each_ruby_test 289 # @FUNCTION: each_ruby_test
219# @DESCRIPTION: 290 # @DESCRIPTION:
220# Run the tests for this package. 291 # Run the tests for this package.
221each_ruby_test() { 292 each_ruby_test() {
222 each_fakegem_test 293 each_fakegem_test
223} 294 }
295fi
224 296
225# @FUNCTION: each_fakegem_install 297# @FUNCTION: each_fakegem_install
226# @DESCRIPTION: 298# @DESCRIPTION:
227# Install the package for each ruby target. 299# Install the package for each ruby target.
228each_fakegem_install() { 300each_fakegem_install() {
229 ruby_fakegem_genspec 301 ruby_fakegem_genspec
230 302
231 local _gemlibdirs= 303 local _gemlibdirs="${RUBY_FAKEGEM_EXTRAINSTALL}"
232 for directory in bin lib ${RUBY_FAKEGEM_EXTRAINSTALL}; do 304 for directory in bin lib; do
233 [[ -d ${directory} ]] && _gemlibdirs="${_gemlibdirs} ${directory}" 305 [[ -d ${directory} ]] && _gemlibdirs="${_gemlibdirs} ${directory}"
234 done 306 done
235 307
308 [[ -n ${_gemlibdirs} ]] && \
236 ruby_fakegem_doins -r ${_gemlibdirs} 309 ruby_fakegem_doins -r ${_gemlibdirs}
237} 310}
238 311
239# @FUNCTION: each_ruby_install 312# @FUNCTION: each_ruby_install
240# @DESCRIPTION: 313# @DESCRIPTION:
241# Install the package for each target. 314# Install the package for each target.
246# @FUNCTION: all_fakegem_install 319# @FUNCTION: all_fakegem_install
247# @DESCRIPTION: 320# @DESCRIPTION:
248# Install files common to all ruby targets. 321# Install files common to all ruby targets.
249all_fakegem_install() { 322all_fakegem_install() {
250 if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && use doc; then 323 if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && use doc; then
251 pushd ${RUBY_FAKEGEM_DOCDIR} 324 for dir in ${RUBY_FAKEGEM_DOCDIR}; do
325 [[ -d ${dir} ]] || continue
326
327 pushd ${dir} &>/dev/null
252 dohtml -r * || die "failed to install documentation" 328 dohtml -r * || die "failed to install documentation"
253 popd 329 popd &>/dev/null
330 done
254 fi 331 fi
255 332
256 if [[ -n ${RUBY_FAKEGEM_EXTRADOC} ]]; then 333 if [[ -n ${RUBY_FAKEGEM_EXTRADOC} ]]; then
257 dodoc ${RUBY_FAKEGEM_EXTRADOC} || die "failed to install further documentation" 334 dodoc ${RUBY_FAKEGEM_EXTRADOC} || die "failed to install further documentation"
258 fi 335 fi
336
337 # binary wrappers; we assume that all the implementations get the
338 # same binaries, or something is wrong anyway, so...
339 if [[ -n ${RUBY_FAKEGEM_BINWRAP} ]]; then
340 local bindir=$(find "${D}" -type d -path "*/gems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}/bin" -print -quit)
341
342 if [[ -d "${bindir}" ]]; then
343 pushd "${bindir}" &>/dev/null
344 local binaries=$(eval ls ${RUBY_FAKEGEM_BINWRAP})
345 for binary in $binaries; do
346 ruby_fakegem_binwrapper $binary
347 done
348 popd &>/dev/null
349 fi
350 fi
259} 351}
260 352
261# @FUNCTION: all_ruby_install 353# @FUNCTION: all_ruby_install
262# @DESCRIPTION: 354# @DESCRIPTION:
263# Install files common to all ruby targets. 355# Install files common to all ruby targets.

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

  ViewVC Help
Powered by ViewVC 1.1.20