[gentoo-dev] Add debug-print-function calls to Ruby eclasses

[gentoo-dev] Add debug-print-function calls to Ruby eclasses

[Anna Vyalkova]

These functions write to ${T}/eclass-debug.log, which is useful for
testing ebuilds.

[gentoo-dev] [PATCH 1/3] ruby-ng.eclass: add debug-print-function calls

[Anna Vyalkova]

Signed-off-by: Anna Vyalkova <cyber+gentoo@sysrq.in>
---
 eclass/ruby-ng.eclass | 52 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 51 insertions(+), 1 deletion(-)

diff --git a/eclass/ruby-ng.eclass b/eclass/ruby-ng.eclass
index 90da695a04c2..8e7c7f76290b 100644
--- a/eclass/ruby-ng.eclass
+++ b/eclass/ruby-ng.eclass
@@ -1,4 +1,4 @@
-# Copyright 1999-2021 Gentoo Authors
+# Copyright 1999-2022 Gentoo Authors
 # Distributed under the terms of the GNU General Public License v2
 
 # @ECLASS: ruby-ng.eclass
@@ -102,6 +102,8 @@ esac
 # Set `comparator' and `version' to include a comparator (=, >=, etc.) and a
 # version string to the returned string
 ruby_implementation_depend() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	_ruby_implementation_depend $1
 }
 
@@ -132,6 +134,8 @@ _ruby_get_all_impls() {
 # ruby_add_bdepend(), but may also be useful in an ebuild to specify
 # more complex dependencies.
 ruby_samelib() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	local res=
 	for _ruby_implementation in $(_ruby_get_all_impls); do
 		has -${_ruby_implementation} $@ || \
@@ -164,6 +168,8 @@ _ruby_atoms_samelib_generic() {
 # Not all implementations have the same command basename as the
 # target; This function translate between the two
 ruby_implementation_command() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	local _ruby_name=$1
 
 	# Add all USE_RUBY values where the flag name diverts from the binary here
@@ -203,6 +209,8 @@ _ruby_wrap_conditions() {
 # Note: runtime dependencies are also added as build-time test
 # dependencies.
 ruby_add_rdepend() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	case $# in
 		1) ;;
 		2)
@@ -248,6 +256,8 @@ ruby_add_rdepend() {
 # dependencies instead of setting DEPEND or BDEPEND yourself. The list
 # of atoms uses the same syntax as normal dependencies.
 ruby_add_bdepend() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	case $# in
 		1) ;;
 		2)
@@ -282,6 +292,8 @@ ruby_add_bdepend() {
 # Adds the specified dependencies to DEPEND in EAPI7, similar to
 # ruby_add_bdepend.
 ruby_add_depend() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	case ${EAPI} in
 		5|6) die "only available in EAPI 7 and newer" ;;
 		*) ;;
@@ -301,6 +313,8 @@ ruby_add_depend() {
 # @DESCRIPTION:
 # Gets an array of ruby use targets enabled by the user
 ruby_get_use_implementations() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	local i implementation
 	for implementation in $(_ruby_get_all_impls); do
 		use ruby_targets_${implementation} && i+=" ${implementation}"
@@ -312,6 +326,8 @@ ruby_get_use_implementations() {
 # @DESCRIPTION:
 # Gets an array of ruby use targets that the ebuild sets
 ruby_get_use_targets() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	local t implementation
 	for implementation in $(_ruby_get_all_impls); do
 		t+=" ruby_targets_${implementation}"
@@ -336,6 +352,8 @@ ruby_get_use_targets() {
 # DEPEND="ruby? ( $(ruby_implementations_depend) )"
 # RDEPEND="${DEPEND}"
 ruby_implementations_depend() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	local depend
 	for _ruby_implementation in $(_ruby_get_all_impls); do
 		depend="${depend}${depend+ }ruby_targets_${_ruby_implementation}? ( $(ruby_implementation_depend $_ruby_implementation) )"
@@ -430,6 +448,8 @@ _ruby_each_implementation() {
 # @DESCRIPTION:
 # Check whether at least one ruby target implementation is present.
 ruby-ng_pkg_setup() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	# This only checks that at least one implementation is present
 	# before doing anything; by leaving the parameters empty we know
 	# it's a special case.
@@ -440,6 +460,8 @@ ruby-ng_pkg_setup() {
 # @DESCRIPTION:
 # Unpack the source archive.
 ruby-ng_src_unpack() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	mkdir "${WORKDIR}"/all
 	pushd "${WORKDIR}"/all &>/dev/null || die
 
@@ -496,6 +518,8 @@ _ruby_source_copy() {
 # Apply patches and prepare versions for each ruby target
 # implementation. Also carry out common clean up tasks.
 ruby-ng_src_prepare() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	# Way too many Ruby packages are prepared on OSX without removing
 	# the extra data forks, we do it here to avoid repeating it for
 	# almost every other ebuild.
@@ -524,6 +548,8 @@ ruby-ng_src_prepare() {
 # @DESCRIPTION:
 # Configure the package.
 ruby-ng_src_configure() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	if type each_ruby_configure &>/dev/null; then
 		_ruby_each_implementation each_ruby_configure
 	fi
@@ -536,6 +562,8 @@ ruby-ng_src_configure() {
 # @DESCRIPTION:
 # Compile the package.
 ruby-ng_src_compile() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	if type each_ruby_compile &>/dev/null; then
 		_ruby_each_implementation each_ruby_compile
 	fi
@@ -548,6 +576,8 @@ ruby-ng_src_compile() {
 # @DESCRIPTION:
 # Run tests for the package.
 ruby-ng_src_test() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	if type each_ruby_test &>/dev/null; then
 		_ruby_each_implementation each_ruby_test
 	fi
@@ -589,6 +619,8 @@ _each_ruby_check_install() {
 # @DESCRIPTION:
 # Install the package for each ruby target implementation.
 ruby-ng_src_install() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	if type each_ruby_install &>/dev/null; then
 		_ruby_each_implementation each_ruby_install
 	fi
@@ -604,6 +636,8 @@ ruby-ng_src_install() {
 # @USAGE: rbconfig item
 # @RETURN: Returns the value of the given rbconfig item of the Ruby interpreter in ${RUBY}.
 ruby_rbconfig_value() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	echo $(${RUBY} --disable=did_you_mean -rrbconfig -e "puts RbConfig::CONFIG['$1']" || die "Could not read ruby configuration for '${1}'")
 }
 
@@ -612,6 +646,8 @@ ruby_rbconfig_value() {
 # @DESCRIPTION:
 # Installs the specified file(s) into the sitelibdir of the Ruby interpreter in ${RUBY}.
 doruby() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	[[ -z ${RUBY} ]] && die "\$RUBY is not set"
 	( # don't want to pollute calling env
 		sitelibdir=$(ruby_rbconfig_value 'sitelibdir')
@@ -624,12 +660,16 @@ doruby() {
 # @FUNCTION: ruby_get_libruby
 # @RETURN: The location of libruby*.so belonging to the Ruby interpreter in ${RUBY}.
 ruby_get_libruby() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	${RUBY} -rrbconfig -e 'puts File.join(RbConfig::CONFIG["libdir"], RbConfig::CONFIG["LIBRUBY"])'
 }
 
 # @FUNCTION: ruby_get_hdrdir
 # @RETURN: The location of the header files belonging to the Ruby interpreter in ${RUBY}.
 ruby_get_hdrdir() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	local rubyhdrdir=$(ruby_rbconfig_value 'rubyhdrdir')
 
 	if [[ "${rubyhdrdir}" = "nil" ]] ; then
@@ -642,6 +682,8 @@ ruby_get_hdrdir() {
 # @FUNCTION: ruby_get_version
 # @RETURN: The version of the Ruby interpreter in ${RUBY}, or what 'ruby' points to.
 ruby_get_version() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	local ruby=${RUBY:-$(type -p ruby 2>/dev/null)}
 
 	echo $(${ruby} -e 'puts RUBY_VERSION')
@@ -650,6 +692,8 @@ ruby_get_version() {
 # @FUNCTION: ruby_get_implementation
 # @RETURN: The implementation of the Ruby interpreter in ${RUBY}, or what 'ruby' points to.
 ruby_get_implementation() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	local ruby=${RUBY:-$(type -p ruby 2>/dev/null)}
 
 	case $(${ruby} --version) in
@@ -671,6 +715,8 @@ ruby_get_implementation() {
 # rspec version that must be executed. It defaults to 2 for historical
 # compatibility.
 ruby-ng_rspec() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	local version=${RSPEC_VERSION-2}
 	local files="$@"
 
@@ -711,6 +757,8 @@ ruby-ng_rspec() {
 # This is simply a wrapper around the cucumber command (executed by $RUBY})
 # which also respects TEST_VERBOSE and NOCOLOR environment variables.
 ruby-ng_cucumber() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	if [[ "${DEPEND}${BDEPEND}" != *"dev-util/cucumber"* ]]; then
 		ewarn "Missing test dependency dev-util/cucumber"
 	fi
@@ -745,6 +793,8 @@ ruby-ng_cucumber() {
 # their script and we installed a broken wrapper for a while.
 # This also respects TEST_VERBOSE and NOCOLOR environment variables.
 ruby-ng_testrb-2() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	if [[ "${DEPEND}${BDEPEND}" != *"dev-ruby/test-unit"* ]]; then
 		ewarn "Missing test dependency dev-ruby/test-unit"
 	fi
-- 
2.35.1

[gentoo-dev] [PATCH 2/3] ruby-ng-gnome2.eclass: add debug-print-function calls

[Anna Vyalkova]

Signed-off-by: Anna Vyalkova <cyber+gentoo@sysrq.in>
---
 eclass/ruby-ng-gnome2.eclass | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/eclass/ruby-ng-gnome2.eclass b/eclass/ruby-ng-gnome2.eclass
index cc475b36b731..732cf9c96b3a 100644
--- a/eclass/ruby-ng-gnome2.eclass
+++ b/eclass/ruby-ng-gnome2.eclass
@@ -1,4 +1,4 @@
-# Copyright 1999-2020 Gentoo Authors
+# Copyright 1999-2022 Gentoo Authors
 # Distributed under the terms of the GNU General Public License v2
 
 # @ECLASS: ruby-ng-gnome2.eclass
@@ -82,6 +82,8 @@ all_ruby_prepare() {
 # @DESCRIPTION:
 # Run the configure script in the subbinding for each specific ruby target.
 each_ruby_configure() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	[[ -e extconf.rb ]] || return
 
 	${RUBY} extconf.rb || die "extconf.rb failed"
@@ -91,6 +93,8 @@ each_ruby_configure() {
 # @DESCRIPTION:
 # Compile the C bindings in the subbinding for each specific ruby target.
 each_ruby_compile() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	[[ -e Makefile ]] || return
 
 	# We have injected --no-undefined in Ruby as a safety precaution
@@ -109,6 +113,8 @@ each_ruby_compile() {
 # @DESCRIPTION:
 # Install the files in the subbinding for each specific ruby target.
 each_ruby_install() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	if [[ -e Makefile ]]; then
 		# Create the directories, or the package will create them as files.
 		local archdir=$(ruby_rbconfig_value "sitearchdir")
@@ -124,6 +130,8 @@ each_ruby_install() {
 # @DESCRIPTION:
 # Install the files common to all ruby targets.
 all_ruby_install() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	for doc in ../AUTHORS ../NEWS ChangeLog README; do
 		[[ -s ${doc} ]] && dodoc $doc
 	done
@@ -139,6 +147,8 @@ all_ruby_install() {
 # @DESCRIPTION:
 # Run the tests for this package.
 each_ruby_test() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	[[ -e test/run-test.rb ]] || return
 
 	if [[ ${RUBY_GNOME2_NEED_VIRTX} == yes ]]; then
-- 
2.35.1

[gentoo-dev] [PATCH 3/3] ruby-fakegem.eclass: add debug-print-function calls

[Anna Vyalkova]

Signed-off-by: Anna Vyalkova <cyber+gentoo@sysrq.in>
---
 eclass/ruby-fakegem.eclass | 46 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 45 insertions(+), 1 deletion(-)

diff --git a/eclass/ruby-fakegem.eclass b/eclass/ruby-fakegem.eclass
index cafb5dc04788..8ec772f0261e 100644
--- a/eclass/ruby-fakegem.eclass
+++ b/eclass/ruby-fakegem.eclass
@@ -1,4 +1,4 @@
-# Copyright 1999-2021 Gentoo Authors
+# Copyright 1999-2022 Gentoo Authors
 # Distributed under the terms of the GNU General Public License v2
 
 # @ECLASS: ruby-fakegem.eclass
@@ -218,6 +218,8 @@ esac
 # This function returns the gems data directory for the ruby
 # implementation in question.
 ruby_fakegem_gemsdir() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	local _gemsitedir=$(ruby_rbconfig_value 'sitelibdir')
 	_gemsitedir=${_gemsitedir//site_ruby/gems}
 	_gemsitedir=${_gemsitedir#${EPREFIX}}
@@ -235,6 +237,8 @@ ruby_fakegem_gemsdir() {
 # @DESCRIPTION:
 # Installs the specified file(s) into the gems directory.
 ruby_fakegem_doins() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	(
 		insinto $(ruby_fakegem_gemsdir)/gems/${RUBY_FAKEGEM_NAME}-${RUBY_FAKEGEM_VERSION}
 		doins "$@"
@@ -246,6 +250,8 @@ ruby_fakegem_doins() {
 # @DESCRIPTION:
 # Installs the specified file into the gems directory using the provided filename.
 ruby_fakegem_newins() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	(
 		# Since newins does not accept full paths but just basenames
 		# for the target file, we want to extend it here.
@@ -265,6 +271,8 @@ ruby_fakegem_newins() {
 # by the RUBY_FAKEGEM_GEMSPEC variable, or generate one using
 # ruby_fakegem_genspec.
 ruby_fakegem_install_gemspec() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	local gemspec="${T}"/${RUBY_FAKEGEM_NAME}-${_ruby_implementation}
 
 	(
@@ -292,6 +300,8 @@ ruby_fakegem_install_gemspec() {
 # RUBY_FAKEGEM_GEMSPEC. This file is eval'ed to produce a final specification
 # in a way similar to packaging the gemspec file.
 ruby_fakegem_gemspec_gemspec() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	${RUBY} --disable=did_you_mean -e "puts eval(File::open('$1').read).to_ruby" > $2
 }
 
@@ -302,6 +312,8 @@ ruby_fakegem_gemspec_gemspec() {
 # the metadata distributed by the gem itself. This is similar to how
 # rubygems creates an installation from a .gem file.
 ruby_fakegem_metadata_gemspec() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	${RUBY} --disable=did_you_mean -r yaml -e "puts Gem::Specification.from_yaml(File::open('$1', :encoding => 'UTF-8').read).to_ruby" > $2
 }
 
@@ -319,6 +331,8 @@ ruby_fakegem_metadata_gemspec() {
 # See RUBY_FAKEGEM_NAME and RUBY_FAKEGEM_VERSION for setting name and version.
 # See RUBY_FAKEGEM_REQUIRE_PATHS for setting extra require paths.
 ruby_fakegem_genspec() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	case ${EAPI} in
 		5|6) ;;
 		*)
@@ -358,6 +372,8 @@ EOF
 # to inject additional ruby code into the wrapper. This may be useful to
 # e.g. force a specific version using the gem command.
 ruby_fakegem_binwrapper() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	(
 		local gembinary=$1
 		local newbinary=${2:-/usr/bin/$gembinary}
@@ -409,6 +425,8 @@ EOF
 # @DESCRIPTION:
 # Configure extensions defined in RUBY_FAKEGEM_EXTENSIONS, if any.
 each_fakegem_configure() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	tc-export PKG_CONFIG
 	for extension in "${RUBY_FAKEGEM_EXTENSIONS[@]}" ; do
 		CC=$(tc-getCC) ${RUBY} --disable=did_you_mean -C ${extension%/*} ${extension##*/} --with-cflags="${CFLAGS}" --with-ldflags="${LDFLAGS}" ${RUBY_FAKEGM_EXTENSION_OPTIONS} || die
@@ -419,6 +437,8 @@ each_fakegem_configure() {
 # @DESCRIPTION:
 # Run each_fakegem_configure for each ruby target
 each_ruby_configure() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	each_fakegem_configure
 }
 
@@ -427,6 +447,8 @@ each_ruby_configure() {
 # Build documentation for the package if indicated by the doc USE flag
 # and if there is a documetation task defined.
 all_fakegem_compile() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && use doc; then
 		case ${RUBY_FAKEGEM_RECIPE_DOC} in
 			rake)
@@ -447,6 +469,8 @@ all_fakegem_compile() {
 # @DESCRIPTION:
 # Compile extensions defined in RUBY_FAKEGEM_EXTENSIONS, if any.
 each_fakegem_compile() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	for extension in "${RUBY_FAKEGEM_EXTENSIONS[@]}" ; do
 		emake V=1 -C ${extension%/*}
 		mkdir -p "${RUBY_FAKEGEM_EXTENSION_LIBDIR%/}"
@@ -458,6 +482,8 @@ each_fakegem_compile() {
 # @DESCRIPTION:
 # Run each_fakegem_compile for each ruby target
 each_ruby_compile() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	each_fakegem_compile
 }
 
@@ -465,6 +491,8 @@ each_ruby_compile() {
 # @DESCRIPTION:
 # Unpack the source archive, including support for unpacking gems.
 all_ruby_unpack() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	# Special support for extracting .gem files; the file need to be
 	# extracted twice and the mtime from the archive _has_ to be
 	# ignored (it's always set to epoch 0).
@@ -511,6 +539,8 @@ all_ruby_unpack() {
 # @DESCRIPTION:
 # Compile the package.
 all_ruby_compile() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	all_fakegem_compile
 }
 
@@ -518,6 +548,8 @@ all_ruby_compile() {
 # @DESCRIPTION:
 # Run tests for the package for each ruby target if the test task is defined.
 each_fakegem_test() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	case ${RUBY_FAKEGEM_RECIPE_TEST} in
 		rake)
 			${RUBY} --disable=did_you_mean -S rake ${RUBY_FAKEGEM_TASK_TEST} || die "tests failed"
@@ -552,6 +584,8 @@ fi
 # installed. This is normally done as part of the extension
 # installation, but may be useful when we handle extensions manually.
 ruby_fakegem_extensions_installed() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	mkdir -p "${ED}$(ruby_fakegem_extensionsdir)" || die
 	touch "${ED}$(ruby_fakegem_extensionsdir)/gem.build_complete" || die
 }
@@ -561,6 +595,8 @@ ruby_fakegem_extensions_installed() {
 # The directory where rubygems expects extensions for this package
 # version.
 ruby_fakegem_extensionsdir() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	# Using formula from ruby src/lib/rubygems/basic_specification.
 	extensions_dir=$(${RUBY} --disable=did_you_mean -e "puts File.join('extensions', Gem::Platform.local.to_s, Gem.extension_api_version)")
 
@@ -571,6 +607,8 @@ ruby_fakegem_extensionsdir() {
 # @DESCRIPTION:
 # Install the package for each ruby target.
 each_fakegem_install() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	ruby_fakegem_install_gemspec
 
 	local _gemlibdirs="${RUBY_FAKEGEM_EXTRAINSTALL}"
@@ -596,6 +634,8 @@ each_fakegem_install() {
 # @DESCRIPTION:
 # Install the package for each target.
 each_ruby_install() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	each_fakegem_install
 }
 
@@ -603,6 +643,8 @@ each_ruby_install() {
 # @DESCRIPTION:
 # Install files common to all ruby targets.
 all_fakegem_install() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	if [[ -n ${RUBY_FAKEGEM_DOCDIR} ]] && use doc; then
 		for dir in ${RUBY_FAKEGEM_DOCDIR}; do
 			[[ -d ${dir} ]] || continue
@@ -636,5 +678,7 @@ all_fakegem_install() {
 # @DESCRIPTION:
 # Install files common to all ruby targets.
 all_ruby_install() {
+	debug-print-function ${FUNCNAME} "${@}"
+
 	all_fakegem_install
 }
-- 
2.35.1

Re: [gentoo-dev] Add debug-print-function calls to Ruby eclasses

[Joonas Niilola]

[-- Attachment #1.1: Type: text/plain, Size: 430 bytes --]

On 14.2.2022 19.37, Anna Vyalkova wrote:
> These functions write to ${T}/eclass-debug.log, which is useful for
> testing ebuilds.
> 
> 
> 

Acked by graaff and merged yesterday after some testing. Thanks!

As a sidenote, these ruby eclasses received 5 commits yesterday so if
something breaks now it's not hard to figure what's related. But I
emerged around ~200-300 ruby packages and everything passed.

-- juippis

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 618 bytes --]