2017-04-25 02:45:00 +01:00
|
|
|
{ stdenv, runCommand, ruby, lib
|
|
|
|
, defaultGemConfig, buildRubyGem, buildEnv
|
|
|
|
, makeWrapper
|
|
|
|
, bundler
|
|
|
|
}@defs:
|
|
|
|
|
|
|
|
{
|
2017-06-28 06:33:18 +01:00
|
|
|
name ? null
|
|
|
|
, pname ? null
|
2017-06-26 01:40:22 +01:00
|
|
|
, mainGemName ? null
|
2017-06-09 17:04:33 +01:00
|
|
|
, gemdir ? null
|
|
|
|
, gemfile ? null
|
|
|
|
, lockfile ? null
|
|
|
|
, gemset ? null
|
2017-04-25 02:45:00 +01:00
|
|
|
, ruby ? defs.ruby
|
|
|
|
, gemConfig ? defaultGemConfig
|
|
|
|
, postBuild ? null
|
|
|
|
, document ? []
|
|
|
|
, meta ? {}
|
2018-12-11 21:19:32 +00:00
|
|
|
, groups ? null
|
2017-04-25 02:45:00 +01:00
|
|
|
, ignoreCollisions ? false
|
bundlerApp: take buildInputs (#45435)
It would be reasonable to have a Ruby program that depends on some other
program being in the PATH. In this case, the obvious thing to do would
be something like this:
bundlerApp {
# ...
buildInputs = [ makeWrapper ];
postBuild = ''
wrapProgram "$out/bin/foo" \
--prefix PATH : ${lib.makeBinPath [ dep ]}
'';
}
However, this doesn't work, because even though it just forwards most of
its arguments to `runCommand`, `bundlerApp` won't take a `buildInputs`
parameter. It doesn't even specify its own `buildInputs`, which means
that the `scripts` parameter to `bundlerApp` (which depends on
`makeWrapper`) is completely broken, and, as far as I can tell, has been
since its inception. I've added a `makeWrapper` build input if the
scripts parameter is present to fix this.
I've added a `buildInputs` option to `bundlerApp`. It's also passed
through to bundled-common because `postBuild` scripts are run there as
well. This actually means that in this example we'd end up going through
two layers of wrappers (one from `bundlerApp` and one from
bundled-common), but that has always been the case and isn't likely to
break anything. That oddity does suggest that it might be prudent to
not forward `postBuild` to bundled-common (or to at least use a
different option) though...
FWIW, as far as I can tell no package in nixpkgs uses either the
`scripts` or `postBuild` options to `bundlerApp`.
2018-10-29 21:39:51 +00:00
|
|
|
, buildInputs ? []
|
2017-04-25 02:45:00 +01:00
|
|
|
, ...
|
|
|
|
}@args:
|
|
|
|
|
2017-06-28 06:33:18 +01:00
|
|
|
assert name == null -> pname != null;
|
|
|
|
|
2017-05-10 18:00:21 +01:00
|
|
|
with import ./functions.nix { inherit lib gemConfig; };
|
2017-04-25 02:45:00 +01:00
|
|
|
|
|
|
|
let
|
2017-06-09 17:04:33 +01:00
|
|
|
gemFiles = bundlerFiles args;
|
2017-04-25 02:45:00 +01:00
|
|
|
|
2018-04-15 11:53:15 +01:00
|
|
|
importedGemset = if builtins.typeOf gemFiles.gemset != "set"
|
2017-10-05 09:28:45 +01:00
|
|
|
then import gemFiles.gemset
|
|
|
|
else gemFiles.gemset;
|
2017-04-25 02:45:00 +01:00
|
|
|
|
2017-05-10 18:00:21 +01:00
|
|
|
filteredGemset = filterGemset { inherit ruby groups; } importedGemset;
|
2017-04-25 02:45:00 +01:00
|
|
|
|
|
|
|
configuredGemset = lib.flip lib.mapAttrs filteredGemset (name: attrs:
|
|
|
|
applyGemConfigs (attrs // { inherit ruby; gemName = name; })
|
|
|
|
);
|
|
|
|
|
|
|
|
hasBundler = builtins.hasAttr "bundler" filteredGemset;
|
|
|
|
|
|
|
|
bundler =
|
|
|
|
if hasBundler then gems.bundler
|
|
|
|
else defs.bundler.override (attrs: { inherit ruby; });
|
|
|
|
|
|
|
|
gems = lib.flip lib.mapAttrs configuredGemset (name: attrs: buildGem name attrs);
|
|
|
|
|
2017-06-28 06:33:18 +01:00
|
|
|
name' = if name != null then
|
|
|
|
name
|
|
|
|
else
|
|
|
|
let
|
2019-08-13 22:52:01 +01:00
|
|
|
gem = gems.${pname};
|
2017-06-28 06:33:18 +01:00
|
|
|
version = gem.version;
|
|
|
|
in
|
|
|
|
"${pname}-${version}";
|
|
|
|
|
|
|
|
pname' = if pname != null then
|
|
|
|
pname
|
|
|
|
else
|
|
|
|
name;
|
|
|
|
|
2018-07-20 20:54:05 +01:00
|
|
|
copyIfBundledByPath = { bundledByPath ? false, ...}:
|
2017-06-09 17:04:33 +01:00
|
|
|
(if bundledByPath then
|
2017-07-29 23:03:24 +01:00
|
|
|
assert gemFiles.gemdir != null; "cp -a ${gemFiles.gemdir}/* $out/" #*/
|
2017-06-09 17:04:33 +01:00
|
|
|
else ""
|
2017-04-25 02:45:00 +01:00
|
|
|
);
|
|
|
|
|
2017-06-26 01:40:22 +01:00
|
|
|
maybeCopyAll = pkgname: if pkgname == null then "" else
|
2017-05-01 17:07:42 +01:00
|
|
|
let
|
2019-08-13 22:52:01 +01:00
|
|
|
mainGem = gems.${pkgname} or (throw "bundlerEnv: gem ${pkgname} not found");
|
2017-05-01 17:07:42 +01:00
|
|
|
in
|
|
|
|
copyIfBundledByPath mainGem;
|
2017-04-25 02:45:00 +01:00
|
|
|
|
|
|
|
# We have to normalize the Gemfile.lock, otherwise bundler tries to be
|
|
|
|
# helpful by doing so at run time, causing executables to immediately bail
|
|
|
|
# out. Yes, I'm serious.
|
|
|
|
confFiles = runCommand "gemfile-and-lockfile" {} ''
|
|
|
|
mkdir -p $out
|
2017-06-26 01:40:22 +01:00
|
|
|
${maybeCopyAll mainGemName}
|
2017-06-09 17:04:33 +01:00
|
|
|
cp ${gemFiles.gemfile} $out/Gemfile || ls -l $out/Gemfile
|
|
|
|
cp ${gemFiles.lockfile} $out/Gemfile.lock || ls -l $out/Gemfile.lock
|
2017-04-25 02:45:00 +01:00
|
|
|
'';
|
|
|
|
|
|
|
|
buildGem = name: attrs: (
|
|
|
|
let
|
2017-05-10 18:00:21 +01:00
|
|
|
gemAttrs = composeGemAttrs ruby gems name attrs;
|
2017-04-25 02:45:00 +01:00
|
|
|
in
|
|
|
|
if gemAttrs.type == "path" then
|
2018-11-25 12:38:39 +00:00
|
|
|
pathDerivation (gemAttrs.source // gemAttrs)
|
2017-04-25 02:45:00 +01:00
|
|
|
else
|
2017-05-10 18:00:21 +01:00
|
|
|
buildRubyGem gemAttrs
|
2017-04-25 02:45:00 +01:00
|
|
|
);
|
|
|
|
|
|
|
|
envPaths = lib.attrValues gems ++ lib.optional (!hasBundler) bundler;
|
|
|
|
|
2017-05-01 17:07:42 +01:00
|
|
|
basicEnv = buildEnv {
|
bundlerApp: take buildInputs (#45435)
It would be reasonable to have a Ruby program that depends on some other
program being in the PATH. In this case, the obvious thing to do would
be something like this:
bundlerApp {
# ...
buildInputs = [ makeWrapper ];
postBuild = ''
wrapProgram "$out/bin/foo" \
--prefix PATH : ${lib.makeBinPath [ dep ]}
'';
}
However, this doesn't work, because even though it just forwards most of
its arguments to `runCommand`, `bundlerApp` won't take a `buildInputs`
parameter. It doesn't even specify its own `buildInputs`, which means
that the `scripts` parameter to `bundlerApp` (which depends on
`makeWrapper`) is completely broken, and, as far as I can tell, has been
since its inception. I've added a `makeWrapper` build input if the
scripts parameter is present to fix this.
I've added a `buildInputs` option to `bundlerApp`. It's also passed
through to bundled-common because `postBuild` scripts are run there as
well. This actually means that in this example we'd end up going through
two layers of wrappers (one from `bundlerApp` and one from
bundled-common), but that has always been the case and isn't likely to
break anything. That oddity does suggest that it might be prudent to
not forward `postBuild` to bundled-common (or to at least use a
different option) though...
FWIW, as far as I can tell no package in nixpkgs uses either the
`scripts` or `postBuild` options to `bundlerApp`.
2018-10-29 21:39:51 +00:00
|
|
|
inherit buildInputs ignoreCollisions;
|
2017-04-25 02:45:00 +01:00
|
|
|
|
2017-06-28 06:33:18 +01:00
|
|
|
name = name';
|
2017-05-15 17:36:30 +01:00
|
|
|
|
2017-04-25 02:45:00 +01:00
|
|
|
paths = envPaths;
|
|
|
|
pathsToLink = [ "/lib" ];
|
|
|
|
|
2017-05-04 04:27:42 +01:00
|
|
|
postBuild = genStubsScript (defs // args // {
|
|
|
|
inherit confFiles bundler groups;
|
2017-04-25 02:45:00 +01:00
|
|
|
binPaths = envPaths;
|
2017-05-04 04:27:42 +01:00
|
|
|
}) + lib.optionalString (postBuild != null) postBuild;
|
2017-04-25 02:45:00 +01:00
|
|
|
|
|
|
|
meta = { platforms = ruby.meta.platforms; } // meta;
|
|
|
|
|
|
|
|
passthru = rec {
|
2017-07-29 23:03:24 +01:00
|
|
|
inherit ruby bundler gems confFiles envPaths;
|
2017-04-25 02:45:00 +01:00
|
|
|
|
2017-07-29 23:03:24 +01:00
|
|
|
wrappedRuby = stdenv.mkDerivation {
|
|
|
|
name = "wrapped-ruby-${pname'}";
|
2017-04-25 02:45:00 +01:00
|
|
|
nativeBuildInputs = [ makeWrapper ];
|
|
|
|
buildCommand = ''
|
|
|
|
mkdir -p $out/bin
|
|
|
|
for i in ${ruby}/bin/*; do
|
|
|
|
makeWrapper "$i" $out/bin/$(basename "$i") \
|
|
|
|
--set BUNDLE_GEMFILE ${confFiles}/Gemfile \
|
2017-05-01 17:07:42 +01:00
|
|
|
--set BUNDLE_PATH ${basicEnv}/${ruby.gemPath} \
|
2017-04-25 02:45:00 +01:00
|
|
|
--set BUNDLE_FROZEN 1 \
|
2017-05-01 17:07:42 +01:00
|
|
|
--set GEM_HOME ${basicEnv}/${ruby.gemPath} \
|
|
|
|
--set GEM_PATH ${basicEnv}/${ruby.gemPath}
|
2017-04-25 02:45:00 +01:00
|
|
|
done
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
env = let
|
|
|
|
irbrc = builtins.toFile "irbrc" ''
|
|
|
|
if !(ENV["OLD_IRBRC"].nil? || ENV["OLD_IRBRC"].empty?)
|
|
|
|
require ENV["OLD_IRBRC"]
|
|
|
|
end
|
|
|
|
require 'rubygems'
|
|
|
|
require 'bundler/setup'
|
|
|
|
'';
|
|
|
|
in stdenv.mkDerivation {
|
2017-07-29 23:03:24 +01:00
|
|
|
name = "${pname'}-interactive-environment";
|
2017-05-01 17:07:42 +01:00
|
|
|
nativeBuildInputs = [ wrappedRuby basicEnv ];
|
2017-04-25 02:45:00 +01:00
|
|
|
shellHook = ''
|
2017-07-03 01:18:58 +01:00
|
|
|
export OLD_IRBRC=$IRBRC
|
2017-04-25 02:45:00 +01:00
|
|
|
export IRBRC=${irbrc}
|
|
|
|
'';
|
|
|
|
buildCommand = ''
|
|
|
|
echo >&2 ""
|
|
|
|
echo >&2 "*** Ruby 'env' attributes are intended for interactive nix-shell sessions, not for building! ***"
|
|
|
|
echo >&2 ""
|
|
|
|
exit 1
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
};
|
2017-05-01 17:07:42 +01:00
|
|
|
};
|
|
|
|
in
|
|
|
|
basicEnv
|