#
# bsd.ruby.mk - Utility definitions for Ruby related ports.
#
# Created by: Akinori MUSHA <knu@FreeBSD.org>
#
# $FreeBSD$
#
.if !defined(Ruby_Include)
Ruby_Include= bsd.ruby.mk
Ruby_Include_MAINTAINER= stas@FreeBSD.org
#
# [variables that a user may define]
#
# RUBY_VER - (See below)
# RUBY_DEFAULT_VER - Set to (e.g.) "1.8" if you want to refer to "ruby18"
# just as "ruby".
# RUBY_ARCH - (See below)
# RUBY_RD_HTML - Define if you want HTML files generated from RD files.
#
#
# [variables that each port can define]
#
# RUBY - Set to full path of ruby. If you set this, the values
# of the following variables are automatically obtained
# from the ruby executable: RUBY_VER, RUBY_VERSION,
# RUBY_NAME, RUBY_ARCH, RUBY_LIBDIR, RUBY_ARCHLIBDIR,
# RUBY_SITELIBDIR, and RUBY_SITEARCHLIBDIR.
# RUBY_VER - Set to the alternative short version of ruby in the
# form of `x.y' (see below for current value).
# USE_RUBY - Says that the port uses ruby for building and running.
# RUBY_NO_BUILD_DEPENDS - Says that the port should not build-depend on ruby.
# RUBY_NO_RUN_DEPENDS - Says that the port should not run-depend on ruby.
# USE_LIBRUBY - Says that the port uses libruby.
# USE_RUBY_EXTCONF - Says that the port uses extconf.rb to configure.
# Implies USE_RUBY.
# RUBY_EXTCONF - Set to the alternative name of extconf.rb
# (default: extconf.rb).
# RUBY_EXTCONF_SUBDIRS - Set to list of subdirectories, if multiple modules
# are included.
# USE_RUBY_SETUP - Says that the port uses setup.rb to configure and
# build.
# RUBY_SETUP - Set to the alternative name of setup.rb
# (default: setup.rb).
# USE_RUBY_AMSTD - Says that the port uses amstd for building and
# running.
# USE_RUBY_RDTOOL - Says that the port uses rdtool to generate documents.
# USE_RUBY_RDOC - Says that the port uses rdoc to generate documents.
# USE_RUBY_FEATURES - Says that the port requires some of the following
# features for building and/or running (default: none):
# iconv
# RUBY_REQUIRE - Set to a Ruby expression to evaluate before building
# the port. The constant "Ruby" is set to the integer
# version number of ruby, and the result of the
# expression will be set to RUBY_PROVIDED, which is
# left undefined if the result is nil, false or a
# zero-length string. Implies USE_RUBY.
# RUBY_SHEBANG_FILES - Specify the files which shebang lines you want to fix.
# RUBY_RD_FILES - Specify the RD files which you want to generate HTML
# documents from. If this is defined and not empty,
# USE_RUBY_RDTOOL is implied and RUBY_RD_HTML_FILES is
# defined.
#
#
# [variables that each port should not (re)define]
#
# RUBY_PKGNAMEPREFIX - Common PKGNAMEPREFIX for ruby ports
# (default: ruby${RUBY_SUFFIX}-)
# RUBY_VERSION - Full version of ruby without preview/beta suffix in
# the form of `x.y.z' (see below for current value).
# RUBY_VERSION_CODE - Full integer version of ruby without preview/beta
# suffix in the form of `xyz'.
# RUBY_PORTVERSION - PORTVERSION for the standard ruby ports (ruby,
# ruby-gdbm, etc.).
# RUBY_PORTREVISION - PORTREVISION for the standard ruby ports.
# RUBY_PORTEPOCH - PORTEPOCH for the standard ruby ports.
# RUBY_DISTNAME - DISTNAME for the standard ruby ports, i.e. the
# basename of the ruby distribution tarball.
# RUBY_DISTVERSION - The version number part of RUBY_DISTNAME.
# RUBY_PATCHFILES - PATCHFILES for the standard ruby ports, i.e. the
# basename of the ruby distribution tarball.
# RUBY_WRKSRC - WRKSRC for the ruby port.
# MASTER_SITE_SUBDIR_RUBY - MASTER_SITE_SUBDIR for the ruby distfiles.
#
# RUBY_SHLIBVER - Major version of libruby (see below for current
# value).
# RUBY_ARCH - Set to target architecture name.
# (e.g. i386-freebsd7)
# RUBY_SUFFIX - Suffix for ruby binaries and directories
# (${RUBY_VER:S/.//}).
# RUBY_WITHOUT_SUFFIX - Always ${LOCALBASE}/bin/ruby.
# RUBY_WITH_SUFFIX - Always ${RUBY_WITHOUT_SUFFIX}${RUBY_SUFFIX}.
# RUBY_NAME - Ruby's name with trailing suffix.
#
# RUBY_MODNAME - Set to the module name (default: ${PORTNAME}).
#
# RUBY_RD2 - Full path of rd2 executable.
# RUBY_RDOC - Full path of rdoc executable.
#
# RUBY_BASE_PORT - Port path of base ruby without PORTSDIR, without
# suffix except version.
# RUBY_PORT - Port path of ruby without PORTSDIR.
# RUBY_AMSTD_PORT - Port path of ruby-amstd without PORTSDIR.
# RUBY_RDTOOL_PORT - Port path of rdtool without PORTSDIR.
# RUBY_RDOC_PORT - Port path of rdoc without PORTSDIR.
# RUBY_ICONV_PORT - Port path of ruby-iconv without PORTSDIR.
#
# DEPEND_LIBRUBY - LIB_DEPENDS entry for libruby.
# DEPEND_RUBY - BUILD_DEPENDS/RUN_DEPENDS entry for ruby.
# DEPEND_RUBY_AMSTD - BUILD_DEPENDS/RUN_DEPENDS entry for ruby-amstd.
# DEPEND_RUBY_RDTOOL - BUILD_DEPENDS entry for rdtool.
# DEPEND_RUBY_RDOC - BUILD_DEPENDS entry for rdoc.
# DEPEND_RUBY_ICONV - BUILD_DEPENDS/RUN_DEPENDS entry for ruby-iconv.
#
# RUBY_LIBDIR - Installation path for architecture independent
# libraries.
# RUBY_ARCHLIBDIR - Installation path for architecture dependent
# libraries.
# RUBY_SITELIBDIR - Installation path for site architecture independent
# libraries.
# RUBY_SITEARCHLIBDIR - Installation path for site architecture dependent
# libraries.
# RUBY_DOCDIR - Installation path for documents.
# RUBY_EXAMPLESDIR - Installation path for examples.
# RUBY_RIDIR - Installation path for site architecture independent ri
# documents.
# RUBY_SITERIDIR - Installation path for site architecture dependent ri
# documents.
# RUBY_MODDOCDIR - Installation path for the module's documents.
# RUBY_MODEXAMPLESDIR - Installation path for the module's examples.
# RUBY_ELISPDIR - Installation path for emacs lisp files.
#
RUBY_DEFAULT_VER?= 1.8
RUBY_VER?= ${RUBY_DEFAULT_VER}
.if defined(RUBY)
.if !exists(${RUBY})
IGNORE= cannot install: you set the variable RUBY to "${RUBY}", but it does not seem to exist. Please specify an already installed ruby executable.
.endif
_RUBY_TEST!= ${RUBY} -e 'begin; require "rbconfig"; rescue LoadError; puts "error"; end'
.if !empty(_RUBY_TEST)
IGNORE= cannot install: you set the variable RUBY to "${RUBY}", but it failed to include rbconfig. Please specify a properly installed ruby executable.
.endif
_RUBY_CONFIG= ${RUBY} -r rbconfig -e 'C = Config::CONFIG' -e
RUBY_VERSION!= ${_RUBY_CONFIG} 'puts VERSION'
RUBY_SUFFIX?= # empty
RUBY_ARCH!= ${_RUBY_CONFIG} 'puts C["target"]'
RUBY_NAME!= ${_RUBY_CONFIG} 'puts C["ruby_install_name"]'
_RUBY_SYSLIBDIR!= ${_RUBY_CONFIG} 'puts C["libdir"]'
_RUBY_SITEDIR!= ${_RUBY_CONFIG} 'puts C["sitedir"]'
.else
RUBY?= ${LOCALBASE}/bin/${RUBY_NAME}
.if defined(RUBY_VER) && ${RUBY_VER} == 1.8
RUBY_RELVERSION= 1.8.6
RUBY_PORTREVISION= 1
RUBY_PORTEPOCH= 1
RUBY_PATCHLEVEL= 111
.if ${RUBY_PATCHLEVEL} == 0
RUBY_VERSION?= ${RUBY_RELVERSION}
RUBY_DISTVERSION?= ${RUBY_RELVERSION}
.else
RUBY_VERSION?= ${RUBY_RELVERSION}.${RUBY_PATCHLEVEL}
RUBY_DISTVERSION?= ${RUBY_RELVERSION}-p${RUBY_PATCHLEVEL}
.endif
# Security patch
RUBY_PATCHFILES?= ${RUBY_VERSION}-patch1.gz
#RUBY_PORTVERSION?= ${RUBY_VERSION}
RUBY_WRKSRC= ${WRKDIR}/ruby-${RUBY_DISTVERSION}
#MASTER_SITE_SUBDIR_RUBY= snapshots
.else
IGNORE= Only ruby 1.8 supported
.endif
# defined(RUBY_VER) && ${RUBY_VER} == 1.8
CONFIGURE_TARGET?= ${ARCH}-portbld-freebsd${OSREL:C/\..*//}
RUBY_ARCH?= ${ARCH}-freebsd${OSREL:C/\..*//}
RUBY_NAME?= ruby${RUBY_SUFFIX}
_RUBY_SYSLIBDIR?= ${PREFIX}/lib
_RUBY_SITEDIR?= ${_RUBY_SYSLIBDIR}/ruby/site_ruby
.endif
# defined(RUBY)
RUBY_DEFAULT_SUFFIX?= ${RUBY_DEFAULT_VER:S/.//}
RUBY_DISTVERSION?= ${RUBY_VERSION}
RUBY_PORTVERSION?= ${RUBY_VERSION}
MASTER_SITE_SUBDIR_RUBY?= ${RUBY_VER}
RUBY_DISTNAME?= ruby-${RUBY_DISTVERSION}
RUBY_WRKSRC?= ${WRKDIR}/${RUBY_DISTNAME}
RUBY_VERSION_CODE?= ${RUBY_VERSION:S/.//g}
RUBY_VER= ${RUBY_VERSION:C/([[:digit:]]+\.[[:digit:]]+).*/\1/}
RUBY_SUFFIX= ${RUBY_VER:S/.//}
RUBY_WITHOUT_SUFFIX?= ${LOCALBASE}/bin/ruby
RUBY_WITH_SUFFIX?= ${RUBY_WITHOUT_SUFFIX}${RUBY_SUFFIX}
RUBY_PKGNAMEPREFIX?= ruby${RUBY_SUFFIX}-
RUBY_SHLIBVER?= ${RUBY_VER:S/.//}
RUBY_CONFIGURE_ARGS+= --program-prefix=""
DEPENDS_ARGS+= RUBY_VER="${RUBY_VER}"
RUBY_CONFIGURE_ARGS+= --program-suffix="${RUBY_SUFFIX}"
RUBY_MODNAME?= ${PORTNAME}
# Commands
RUBY_RD2?= ${LOCALBASE}/bin/rd2
RUBY_RDOC?= ${LOCALBASE}/bin/rdoc
# Ports
RUBY_BASE_PORT?= lang/ruby${RUBY_VER:S/.//}
RUBY_PORT?= ${RUBY_BASE_PORT}
RUBY_AMSTD_PORT?= devel/ruby-amstd
RUBY_RDTOOL_PORT?= textproc/ruby-rdtool
RUBY_RDOC_PORT?= textproc/ruby-rdoc
RUBY_ICONV_PORT?= converters/ruby-iconv
# Depends
DEPEND_LIBRUBY?= ${RUBY_NAME}.${RUBY_SHLIBVER}:${PORTSDIR}/${RUBY_PORT}
DEPEND_RUBY?= ${RUBY}:${PORTSDIR}/${RUBY_PORT}
DEPEND_RUBY_AMSTD?= ${RUBY_SITELIBDIR}/amstd/version.rb:${PORTSDIR}/${RUBY_AMSTD_PORT}
DEPEND_RUBY_RDTOOL?= ${RUBY_RD2}:${PORTSDIR}/${RUBY_RDTOOL_PORT}
DEPEND_RUBY_ICONV= ${RUBY_ARCHLIBDIR}/iconv.so:${PORTSDIR}/${RUBY_ICONV_PORT}
# Directories
RUBY_LIBDIR?= ${_RUBY_SYSLIBDIR}/ruby/${RUBY_VER}
RUBY_ARCHLIBDIR?= ${RUBY_LIBDIR}/${RUBY_ARCH}
RUBY_SITELIBDIR?= ${_RUBY_SITEDIR}/${RUBY_VER}
RUBY_SITEARCHLIBDIR?= ${RUBY_SITELIBDIR}/${RUBY_ARCH}
RUBY_DOCDIR?= ${PREFIX}/share/doc/${RUBY_NAME}
RUBY_EXAMPLESDIR?= ${PREFIX}/share/examples/${RUBY_NAME}
RUBY_RIDIR?= ${PREFIX}/share/ri/${RUBY_VER}/system
RUBY_SITERIDIR?= ${PREFIX}/share/ri/${RUBY_VER}/site
RUBY_MODDOCDIR?= ${RUBY_DOCDIR}/${RUBY_MODNAME}
RUBY_MODEXAMPLESDIR?= ${RUBY_EXAMPLESDIR}/${RUBY_MODNAME}
RUBY_ELISPDIR?= ${PREFIX}/lib/ruby/elisp
# PLIST
PLIST_RUBY_DIRS= RUBY_LIBDIR="${RUBY_LIBDIR}" \
RUBY_ARCHLIBDIR="${RUBY_ARCHLIBDIR}" \
RUBY_SITELIBDIR="${RUBY_SITELIBDIR}" \
RUBY_SITEARCHLIBDIR="${RUBY_SITEARCHLIBDIR}" \
RUBY_MODDOCDIR="${RUBY_MODDOCDIR}" \
RUBY_MODEXAMPLESDIR="${RUBY_MODEXAMPLESDIR}" \
RUBY_DOCDIR="${RUBY_DOCDIR}" \
RUBY_EXAMPLESDIR="${RUBY_EXAMPLESDIR}" \
RUBY_RIDIR="${RUBY_RIDIR}" \
RUBY_SITERIDIR="${RUBY_SITERIDIR}" \
RUBY_ELISPDIR="${RUBY_ELISPDIR}"
PLIST_SUB+= ${PLIST_RUBY_DIRS:C,DIR="(${LOCALBASE}|${PREFIX})/,DIR=",} \
RUBY_VERSION="${RUBY_VERSION}" \
RUBY_VER="${RUBY_VER}" \
RUBY_SHLIBVER="${RUBY_SHLIBVER}" \
RUBY_ARCH="${RUBY_ARCH}" \
RUBY_SUFFIX="${RUBY_SUFFIX}" \
RUBY_NAME="${RUBY_NAME}" \
RUBY_DEFAULT_SUFFIX="${RUBY_DEFAULT_SUFFIX}"
RUBY18_ONLY= ""
RUBY16_ONLY= "@comment "
PLIST_SUB+= RUBY16_ONLY=${RUBY16_ONLY} \
RUBY18_ONLY=${RUBY18_ONLY}
# require check
.if defined(RUBY_REQUIRE)
USE_RUBY= yes
.if exists(${RUBY})
RUBY_PROVIDED!= ${RUBY} -e '\
Ruby = ${RUBY_VERSION_CODE}; \
value = begin; ${RUBY_REQUIRE}; end and puts value'
.else
RUBY_PROVIDED= "should be" # the latest version is going to be installed
.endif
.if empty(RUBY_PROVIDED)
.undef RUBY_PROVIDED
.endif
.endif
# fix shebang lines
.if defined(RUBY_SHEBANG_FILES) && !empty(RUBY_SHEBANG_FILES)
USE_RUBY= yes
post-patch: ruby-shebang-patch
ruby-shebang-patch:
@cd ${WRKSRC}; for f in ${RUBY_SHEBANG_FILES}; do \
${ECHO_MSG} "===> Fixing the #! line of $$f"; \
${RUBY} ${RUBY_FLAGS} -i -p \
-e 'if $$. == 1; ' \
-e ' if /^#!/; ' \
-e ' sub /^#!\s*\S*(\benv\s+)?\bruby/, "#!${RUBY}";' \
-e ' else;' \
-e ' $$_ = "#!${RUBY}\n" + $$_;' \
-e ' end;' \
-e 'end' \
$$f; \
done
.endif
.if defined(DEBUG)
RUBY_FLAGS+= -d
.endif
# extconf.rb
.if defined(USE_RUBY_EXTCONF)
USE_RUBY= yes
RUBY_EXTCONF?= extconf.rb
CONFIGURE_ARGS+= --with-opt-dir="${LOCALBASE}"
do-configure: ruby-extconf-configure
ruby-extconf-configure:
.if defined(RUBY_EXTCONF_SUBDIRS)
.for d in ${RUBY_EXTCONF_SUBDIRS}
@${ECHO_MSG} "===> Running ${RUBY_EXTCONF} in ${d} to configure"
@cd ${CONFIGURE_WRKSRC}/${d}; \
${SETENV} ${CONFIGURE_ENV} ${RUBY} ${RUBY_FLAGS} ${RUBY_EXTCONF} ${CONFIGURE_ARGS}
.endfor
.else
@${ECHO_MSG} "===> Running ${RUBY_EXTCONF} to configure"
@cd ${CONFIGURE_WRKSRC}; \
${SETENV} ${CONFIGURE_ENV} ${RUBY} ${RUBY_FLAGS} ${RUBY_EXTCONF} ${CONFIGURE_ARGS}
.endif
.endif
# setup.rb
.if defined(USE_RUBY_SETUP)
RUBY_SETUP?= setup.rb
do-configure: ruby-setup-configure
ruby-setup-configure:
@${ECHO_MSG} "===> Running ${RUBY_SETUP} to configure"
@cd ${BUILD_WRKSRC}; \
${SETENV} ${CONFIGURE_ENV} ${RUBY} ${RUBY_FLAGS} ${RUBY_SETUP} config ${CONFIGURE_ARGS}
do-build: ruby-setup-build
ruby-setup-build:
@${ECHO_MSG} "===> Running ${RUBY_SETUP} to build"
@cd ${BUILD_WRKSRC}; \
${SETENV} ${MAKE_ENV} ${RUBY} ${RUBY_FLAGS} ${RUBY_SETUP} setup
do-install: ruby-setup-install
ruby-setup-install:
@${ECHO_MSG} "===> Running ${RUBY_SETUP} to install"
@cd ${INSTALL_WRKSRC}; \
${SETENV} ${MAKE_ENV} ${RUBY} ${RUBY_FLAGS} ${RUBY_SETUP} install
.endif
.if defined(USE_LIBRUBY)
LIB_DEPENDS+= ${DEPEND_LIBRUBY}
.endif
.if defined(USE_RUBY)
.if !defined(RUBY_NO_BUILD_DEPENDS)
EXTRACT_DEPENDS+= ${DEPEND_RUBY}
PATCH_DEPENDS+= ${DEPEND_RUBY}
BUILD_DEPENDS+= ${DEPEND_RUBY}
.endif
.if !defined(RUBY_NO_RUN_DEPENDS)
RUN_DEPENDS+= ${DEPEND_RUBY}
.endif
.endif
.if defined(USE_RUBY_FEATURES)
_use= ${USE_RUBY_FEATURES:Miconv}
.if !empty(_use)
BUILD_DEPENDS+= ${DEPEND_RUBY_ICONV}
RUN_DEPENDS+= ${DEPEND_RUBY_ICONV}
.endif
.undef _use
.endif
.if defined(USE_RUBY_AMSTD)
BUILD_DEPENDS+= ${DEPEND_RUBY_AMSTD}
RUN_DEPENDS+= ${DEPEND_RUBY_AMSTD}
.endif
# documents
RUBY_NO_RD_HTML= yes
.if defined(RUBY_RD_HTML)
.undef RUBY_NO_RD_HTML
.endif
.if defined(NOPORTDOCS)
RUBY_NO_RD_HTML= yes
.endif
.if defined(RUBY_RD_FILES) && !defined(RUBY_NO_RD_HTML)
USE_RUBY_RDTOOL= yes
RUBY_RD_HTML_FILES= ${RUBY_RD_FILES:S/.rb$//:S/.rd././:S/.rd$//:S/$/.html/}
PLIST_SUB+= RUBY_RD_HTML_FILES=""
pre-install: ruby-rd-build
ruby-rd-build:
.if !empty(RUBY_RD_FILES)
@${ECHO_MSG} "===> Generating HTML documents from RD documents"
@cd ${WRKSRC}; for rd in ${RUBY_RD_FILES}; do \
html=$$(echo $$rd | ${SED} 's/\.rb$$//;s/\.rd\././;s/\.rd$$//').html; \
${ECHO_MSG} "${RUBY_RD2} $$rd > $$html"; \
${RUBY_RD2} $$rd > $$html; \
done
.else
@${DO_NADA}
.endif
.else
RUBY_RD_HTML_FILES= # empty
PLIST_SUB+= RUBY_RD_HTML_FILES="@comment "
.endif
.if !defined(NOPORTDOCS) && defined(USE_RUBY_RDTOOL)
BUILD_DEPENDS+= ${DEPEND_RUBY_RDTOOL}
.endif
.endif
