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`.
This commit is contained in:
Alyssa Ross 2018-10-29 21:39:51 +00:00 committed by zimbatm
parent 3947b88389
commit 69dcb1a2c0
2 changed files with 16 additions and 11 deletions

View File

@ -19,6 +19,7 @@
, meta ? {}
, groups ? ["default"]
, ignoreCollisions ? false
, buildInputs ? []
, ...
}@args:
@ -96,7 +97,7 @@ let
envPaths = lib.attrValues gems ++ lib.optional (!hasBundler) bundler;
basicEnv = buildEnv {
inherit ignoreCollisions;
inherit buildInputs ignoreCollisions;
name = name';

View File

@ -1,4 +1,4 @@
{ lib, stdenv, callPackage, runCommand, ruby }@defs:
{ lib, stdenv, callPackage, runCommand, makeWrapper, ruby }@defs:
# Use for simple installation of Ruby tools shipped in a Gem.
# Start with a Gemfile that includes `gem <toolgem>`
@ -26,6 +26,7 @@
, allowSubstitutes ? false
, installManpages ? true
, meta ? {}
, buildInputs ? []
, postBuild ? ""
, gemConfig ? null
}@args:
@ -33,19 +34,22 @@
let
basicEnv = (callPackage ../bundled-common {}) args;
cmdArgs = removeAttrs args [ "pname" "postBuild" "gemConfig" ]
// { inherit preferLocalBuild allowSubstitutes; }; # pass the defaults
cmdArgs = removeAttrs args [ "pname" "postBuild" "gemConfig" ] // {
inherit preferLocalBuild allowSubstitutes; # pass the defaults
buildInputs = buildInputs ++ lib.optional (scripts != []) makeWrapper;
};
in
runCommand basicEnv.name cmdArgs ''
runCommand basicEnv.name cmdArgs ''
mkdir -p $out/bin
${(lib.concatMapStrings (x: "ln -s '${basicEnv}/bin/${x}' $out/bin/${x};\n") exes)}
${(lib.concatMapStrings (s: "makeWrapper $out/bin/$(basename ${s}) $srcdir/${s} " +
"--set BUNDLE_GEMFILE ${basicEnv.confFiles}/Gemfile "+
"--set BUNDLE_PATH ${basicEnv}/${ruby.gemPath} "+
"--set BUNDLE_FROZEN 1 "+
"--set GEM_HOME ${basicEnv}/${ruby.gemPath} "+
"--set GEM_PATH ${basicEnv}/${ruby.gemPath} "+
"--run \"cd $srcdir\";\n") scripts)}
"--set BUNDLE_GEMFILE ${basicEnv.confFiles}/Gemfile "+
"--set BUNDLE_PATH ${basicEnv}/${ruby.gemPath} "+
"--set BUNDLE_FROZEN 1 "+
"--set GEM_HOME ${basicEnv}/${ruby.gemPath} "+
"--set GEM_PATH ${basicEnv}/${ruby.gemPath} "+
"--run \"cd $srcdir\";\n") scripts)}
${lib.optionalString installManpages ''
for section in {1..9}; do