# bsd.ruby.mk - Utility definitions for Ruby related ports.
#
# Created by: Akinori MUSHA <knu@FreeBSD.org>
.if !defined(Ruby_Include)
Ruby_Include= bsd.ruby.mk
Ruby_Include_MAINTAINER= ruby@FreeBSD.org
#
# [variables that a user may define]
#
# RUBY_VER - (See below)
# RUBY_DEFAULT_VER - Set to (e.g.) "2.7" if you want to refer to "ruby27"
# just as "ruby".
# RUBY_ARCH - (See below)
#
# [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_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_RDOC - Says that the port uses rdoc to generate documents.
# 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.
# USE_RUBYGEMS - Do not use this -- instead USES=gem
#
# [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 - Integer version of RUBY_VERSION 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_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_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_RDOC_PORT - Port path of rdoc without PORTSDIR.
#
# DEPEND_RUBY - BUILD_DEPENDS/RUN_DEPENDS entry for ruby.
# DEPEND_RUBY_RDOC - BUILD_DEPENDS entry for rdoc.
#
# 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.
#
.if defined(RUBY_DEFAULT_VER)
WARNING+= "RUBY_DEFAULT_VER is defined, consider using DEFAULT_VERSIONS=ruby=${RUBY_DEFAULT_VER} instead"
.endif
RUBY_DEFAULT_VER?= ${RUBY_DEFAULT}
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"; puts "ok" ; rescue LoadError; puts "error"; end'
.if !empty(_RUBY_TEST) && ${_RUBY_TEST} != "ok"
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 = RbConfig::CONFIG' -e
RUBY_VERSION!= ${_RUBY_CONFIG} 'puts C["ruby_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"]'
_RUBY_VENDORDIR!= ${_RUBY_CONFIG} 'puts C["vendordir"]'
.else
RUBY?= ${LOCALBASE}/bin/${RUBY_NAME}
.if defined(RUBY_VER)
# When adding a version, please keep the comment in
# Mk/bsd.default-versions.mk in sync.
. if ${RUBY_VER} == 2.6
#
# Ruby 2.6
#
RUBY_VERSION= 2.6.7
RUBY_PORTREVISION= 0
RUBY_PORTEPOCH= 1
RUBY26= "" # PLIST_SUB helpers
. elif ${RUBY_VER} == 2.7
#
# Ruby 2.7
#
RUBY_VERSION= 2.7.3
RUBY_PORTREVISION= 0
RUBY_PORTEPOCH= 1
RUBY27= "" # PLIST_SUB helpers
. elif ${RUBY_VER} == 3.0
#
# Ruby 3.0
#
RUBY_DISTVERSION= 3.0.0-preview1
RUBY_PORTREVISION= 1
RUBY_PORTEPOCH= 1
RUBY30= "" # PLIST_SUB helpers
# When adding a version, please keep the comment in
# Mk/bsd.default-versions.mk in sync.
. else
#
# Other versions
#
IGNORE= Only ruby 2.6, 2.7 and 3.0 are supported
_INVALID_RUBY_VER= 1
. endif
.endif # defined(RUBY_VER)
.if defined(RUBY_DISTVERSION)
.if !defined(RUBY_VERSION)
RUBY_VERSION= ${RUBY_DISTVERSION:tl:C/([a-z])[a-z]+/\1/g:C/([0-9])([a-z])/\1.\2/g:C/:(.)/\1/g:C/[^a-z0-9+]+/./g}
.else
DEV_ERROR+= "Defining both RUBY_VERSION and RUBY_DISTVERSION is wrong, only set one"
.endif
.else
RUBY_DISTVERSION= ${RUBY_VERSION}
.endif
.if !defined(_INVALID_RUBY_VER)
RUBY26?= "@comment "
RUBY27?= "@comment "
RUBY30?= "@comment "
.if defined(BROKEN_RUBY${RUBY_VER:R}${RUBY_VER:E})
.if ${BROKEN_RUBY${RUBY_VER:R}${RUBY_VER:E}} == "yes"
BROKEN= does not build with Ruby ${RUBY_VER}
.else
BROKEN= ${BROKEN_RUBY${RUBY_VER:R}${RUBY_VER:E}}
.endif
.endif
RUBY_WRKSRC= ${WRKDIR}/ruby-${RUBY_DISTVERSION}
RUBY_CONFIGURE_ARGS+= --with-rubyhdrdir="${PREFIX}/include/ruby-${RUBY_VER}/" \
--with-rubylibprefix="${PREFIX}/lib/ruby" \
--docdir="${RUBY_DOCDIR}" \
--with-soname=ruby${RUBY_SUFFIX}
CONFIGURE_TARGET?= ${ARCH}-portbld-${OPSYS:tl}${OSREL:C/\..*//}
RUBY_ARCH?= ${ARCH}-${OPSYS:tl}${OSREL:C/\..*//}
RUBY_NAME?= ruby${RUBY_SUFFIX}
_RUBY_SYSLIBDIR?= ${PREFIX}/lib
_RUBY_SITEDIR?= ${_RUBY_SYSLIBDIR}/ruby/site_ruby
_RUBY_VENDORDIR?= ${_RUBY_SYSLIBDIR}/ruby/vendor_ruby
.endif
.endif
# defined(RUBY)
.if !defined(_INVALID_RUBY_VER)
RUBY_DEFAULT_SUFFIX?= ${RUBY_DEFAULT_VER:S/.//}
RUBY_PORTVERSION?= ${RUBY_VERSION}
MASTER_SITE_SUBDIR_RUBY?= ${RUBY_VER}
RUBY_DISTNAME?= ruby-${RUBY_DISTVERSION}
RUBY_WRKSRC?= ${WRKDIR}/${RUBY_DISTNAME}
RUBY_RELVERSION_CODE?= ${RUBY_RELVERSION:S/.//g}
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=""
.if ${RUBY_VER} != ${RUBY_DEFAULT_VER}
DEPENDS_ARGS+= RUBY_VER=${RUBY_VER}
.endif
RUBY_CONFIGURE_ARGS+= --program-suffix="${RUBY_SUFFIX}"
RUBY_MODNAME?= ${PORTNAME}
# Commands
.if ${RUBY_VER} < 2.7
RUBY_RDOC?= ${LOCALBASE}/bin/rdoc${RUBY_VER:S/.//}
.else
RUBY_RDOC?= ${LOCALBASE}/bin/rdoc
.endif
# Ports
RUBY_BASE_PORT?= lang/ruby${RUBY_VER:S/.//}
RUBY_PORT?= ${RUBY_BASE_PORT}
# Depends
DEPEND_RUBY?= ${RUBY}:${RUBY_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_VENDORLIBDIR?= ${_RUBY_VENDORDIR}/${RUBY_VER}
RUBY_VENDORARCHLIBDIR?= ${RUBY_VENDORLIBDIR}/${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}
# PLIST
PLIST_RUBY_DIRS= RUBY_LIBDIR="${RUBY_LIBDIR}" \
RUBY_ARCHLIBDIR="${RUBY_ARCHLIBDIR}" \
RUBY_SITELIBDIR="${RUBY_SITELIBDIR}" \
RUBY_SITEARCHLIBDIR="${RUBY_SITEARCHLIBDIR}" \
RUBY_VENDORLIBDIR="${RUBY_VENDORLIBDIR}" \
RUBY_VENDORARCHLIBDIR="${RUBY_VENDORARCHLIBDIR}" \
RUBY_MODDOCDIR="${RUBY_MODDOCDIR}" \
RUBY_MODEXAMPLESDIR="${RUBY_MODEXAMPLESDIR}" \
RUBY_DOCDIR="${RUBY_DOCDIR}" \
RUBY_EXAMPLESDIR="${RUBY_EXAMPLESDIR}" \
RUBY_RIDIR="${RUBY_RIDIR}" \
RUBY_SITERIDIR="${RUBY_SITERIDIR}"
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}" \
RUBY26=${RUBY26} \
RUBY27=${RUBY27} \
RUBY30=${RUBY30}
.if defined(USE_RUBY_RDOC)
MAKE_ENV+= RUBY_RDOC=${RUBY_RDOC}
.endif
# require check
.if defined(RUBY_REQUIRE)
USE_RUBY= yes
.if exists(${RUBY})
RUBY_PROVIDED!= ${RUBY} -e '\
Ruby = ${RUBY_RELVERSION_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
.if ${PORT_OPTIONS:MDEBUG}
RUBY_FLAGS+= -d
.endif
#
# extconf.rb support
#
.if defined(USE_RUBY_EXTCONF)
USE_RUBY= yes
RUBY_EXTCONF?= extconf.rb
CONFIGURE_ARGS+= --with-opt-dir="${LOCALBASE}"
CONFIGURE_ENV+= RB_USER_INSTALL=yes
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 support
#
.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 --prefix=${STAGEDIR}
.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
.endif # _INVALID_RUBY_VER
.endif
