bashcov 3.1.3 → 3.2.0

data/flake.lock

@@ -0,0 +1,139 @@
+{
+  "nodes": {
+    "devshell": {
+      "inputs": {
+        "nixpkgs": [
+          "nixpkgs"
+        ],
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1688380630,
+        "narHash": "sha256-8ilApWVb1mAi4439zS3iFeIT0ODlbrifm/fegWwgHjA=",
+        "owner": "numtide",
+        "repo": "devshell",
+        "rev": "f9238ec3d75cefbb2b42a44948c4e8fb1ae9a205",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "devshell",
+        "type": "github"
+      }
+    },
+    "flake-compat": {
+      "flake": false,
+      "locked": {
+        "lastModified": 1673956053,
+        "narHash": "sha256-4gtG9iQuiKITOjNQQeQIpoIB6b16fm+504Ch3sNKLd8=",
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "rev": "35bb57c0c8d8b62bbfd284272c928ceb64ddbde9",
+        "type": "github"
+      },
+      "original": {
+        "owner": "edolstra",
+        "repo": "flake-compat",
+        "type": "github"
+      }
+    },
+    "flake-parts": {
+      "inputs": {
+        "nixpkgs-lib": "nixpkgs-lib"
+      },
+      "locked": {
+        "lastModified": 1688466019,
+        "narHash": "sha256-VeM2akYrBYMsb4W/MmBo1zmaMfgbL4cH3Pu8PGyIwJ0=",
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "rev": "8e8d955c22df93dbe24f19ea04f47a74adbdc5ec",
+        "type": "github"
+      },
+      "original": {
+        "owner": "hercules-ci",
+        "repo": "flake-parts",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1689137672,
+        "narHash": "sha256-QZoHxr0a73x6rQcAo5CiwYpysHbSnk7lAR8/16um7mM=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "98da3dd0de6660d4abed7bb74e748694bd803413",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-23.05",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "nixpkgs-lib": {
+      "locked": {
+        "dir": "lib",
+        "lastModified": 1688049487,
+        "narHash": "sha256-100g4iaKC9MalDjUW9iN6Jl/OocTDtXdeAj7pEGIRh4=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "4bc72cae107788bf3f24f30db2e2f685c9298dc9",
+        "type": "github"
+      },
+      "original": {
+        "dir": "lib",
+        "owner": "NixOS",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "devshell": "devshell",
+        "flake-compat": "flake-compat",
+        "flake-parts": "flake-parts",
+        "nixpkgs": "nixpkgs",
+        "treefmt-nix": "treefmt-nix"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    },
+    "treefmt-nix": {
+      "inputs": {
+        "nixpkgs": [
+          "nixpkgs"
+        ]
+      },
+      "locked": {
+        "lastModified": 1689070229,
+        "narHash": "sha256-99VU2FTkEdO3/1Qr78fHWWlN5GaOGLaXDi26PNiUf+I=",
+        "owner": "numtide",
+        "repo": "treefmt-nix",
+        "rev": "3c54278bf7b8642eba174a22ca02d5552c21dc0b",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "treefmt-nix",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

data/flake.nix

@@ -0,0 +1,225 @@
+{
+  description = "Code coverage tool for Bash";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-23.05";
+
+    devshell.url = "github:numtide/devshell";
+    devshell.inputs.nixpkgs.follows = "nixpkgs";
+
+    flake-compat.url = "github:edolstra/flake-compat";
+    flake-compat.flake = false;
+
+    flake-parts.url = "github:hercules-ci/flake-parts";
+
+    treefmt-nix.url = "github:numtide/treefmt-nix";
+    treefmt-nix.inputs.nixpkgs.follows = "nixpkgs";
+  };
+
+  outputs = inputs @ {
+    self,
+    devshell,
+    flake-parts,
+    treefmt-nix,
+    ...
+  }:
+    flake-parts.lib.mkFlake {inherit inputs;} ({lib, ...}: {
+      systems = [
+        "aarch64-darwin"
+        "aarch64-linux"
+        "x86_64-darwin"
+        "x86_64-linux"
+      ];
+
+      imports = [
+        devshell.flakeModule
+        flake-parts.flakeModules.easyOverlay
+        treefmt-nix.flakeModule
+      ];
+
+      perSystem = {
+        config,
+        pkgs,
+        self',
+        system,
+        ...
+      }: let
+        newestRuby = let
+          rubies = lib.filterAttrs (name: value: let
+            hasRubyEngine = builtins.tryEval (value ? rubyEngine);
+          in
+            lib.hasPrefix "ruby" name && hasRubyEngine.success && hasRubyEngine.value)
+          pkgs;
+
+          recentRubies =
+            lib.foldlAttrs (
+              acc: name: value: let
+                v = toString value.version;
+              in
+                acc ++ (lib.optional (lib.versionAtLeast v "3" && lib.versionOlder v "4") {inherit name value;})
+            ) []
+            rubies;
+
+          sortedRubies = lib.sort (x: y: lib.versionAtLeast (toString x.value.version) (toString y.value.version)) recentRubies;
+        in
+          if (lib.length sortedRubies) > 0
+          then lib.head sortedRubies
+          else {
+            name = "ruby";
+            value = pkgs.ruby;
+          };
+
+        ruby = newestRuby.value;
+        rubyName = newestRuby.name;
+      in {
+        # `nix run '.#devshell' -- update-deps`, etc.
+        apps.devshell = self'.devShells.default.flakeApp;
+
+        checks = {
+          inherit (config.packages) bashcov;
+        };
+
+        devshells.default = {
+          imports = [
+            # Ruby support, including prerequisites for compiling native
+            # extensions.
+            "${inputs.devshell}/extra/language/ruby.nix"
+          ];
+
+          commands = [
+            {
+              name = "fmt";
+              category = "linting";
+              help = "Format the Nix code in this project";
+              command = ''
+                exec ${config.treefmt.build.wrapper}/bin/treefmt "$@"
+              '';
+            }
+
+            {
+              package = ruby;
+              category = "development";
+            }
+
+            {
+              package = pkgs.bundix;
+              category = "maintenance";
+            }
+
+            {
+              name = "update-deps";
+              category = "maintenance";
+              help = "Update dependencies with Bundler and Bundix";
+              command = ''
+                export NIX_PATH="nixpkgs=${toString pkgs.path}''${NIX_PATH:+:''${NIX_PATH}}"
+                lockfile="''${PRJ_ROOT:-.}/Gemfile.nix.lock"
+                bundle lock --lockfile "$lockfile"
+                exec bundix --ruby ${lib.escapeShellArg rubyName} --lockfile="$lockfile" "$@"
+              '';
+            }
+
+            {
+              name = "update-deps-conservative";
+              category = "maintenance";
+              help = "Update dependencies with Bundler and Bundix (if necessary)";
+
+              # If `nix build` succeeds, then presume that the lockfiles do not
+              # need to be updated.  If `nix build` fails after updating the
+              # lockfile, out-of-date dependencies weren't to blame for the
+              # build failure.
+              command = ''
+                export NIX_PATH="nixpkgs=${toString pkgs.path}''${NIX_PATH:+:''${NIX_PATH}}"
+                nix build && exit
+                if update-deps; then
+                  nix build || {
+                    rc="$?"
+                    git restore "''${PRJ_ROOT}/Gemfile.nix.lock" "''${PRJ_ROOT}/gemset.nix" || rc="$?"
+                    exit "$rc"
+                  }
+                fi
+              '';
+            }
+          ];
+        };
+
+        overlayAttrs = {
+          inherit (config.packages) bashcov;
+        };
+
+        packages = {
+          bashcov = pkgs.callPackage ({
+            lib,
+            bash,
+            buildRubyGem,
+            makeWrapper,
+            ruby,
+            gems,
+            doCheck ? true, # Whether to run RSpec and Cucumber Rake tasks.
+          }: let
+            inherit (gems'.gems.bashcov) version;
+            gems' = gems.override {inherit ruby;};
+            gemName = gems'.gems.bashcov.name;
+          in
+            assert lib.assertMsg (gems'.gems ? bashcov) "bashcov: gem set must contain `bashcov`";
+              buildRubyGem {
+                inherit doCheck gemName version ruby;
+
+                name = "${gemName}-${version}";
+
+                src = self;
+
+                nativeBuildInputs = [bash makeWrapper];
+                propagatedBuildInputs = [gems'];
+
+                checkPhase = ''
+                  ${config.packages.gems.wrappedRuby}/bin/rake cucumber spec
+                '';
+
+                # Replace shebangs like "#!/usr/bin/env bash" with Nix store
+                # paths.  Note that we need to do this for `./bin/bashcov`
+                # itself, as otherwise running `bashcov` from Cucumber features
+                # during the check phase will fail because `/usr/bin/env` does
+                # not exist in the build sandbox.
+                doPatch = true;
+                postPatch = ''
+                  patchShebangs ./bin ./features ./spec
+                '';
+
+                # Ensure that Bashcov can find Bash, but make this Bash
+                # low-precedence by placing its /bin/ at the end of PATH.
+                postInstall = ''
+                  wrapProgram $out/bin/bashcov --suffix PATH : ${bash}/bin
+                '';
+              }) {
+            inherit ruby;
+            inherit (config.packages) gems;
+          };
+
+          default = config.packages.bashcov;
+
+          gems = pkgs.callPackage ({
+            bundlerEnv,
+            ruby,
+          }:
+            bundlerEnv {
+              inherit ruby;
+              pname = "bashcov";
+              gemdir = self;
+              lockfile = ./Gemfile.nix.lock;
+              version = "3.0.2";
+              postBuild = ''
+                for gem in $out/${ruby.gemPath}/bundler/gems/*; do
+                  ln -sfrT "$gem" $out/${ruby.gemPath}/gems/"''${gem##*/}"
+                done
+              '';
+            }) {inherit ruby;};
+        };
+
+        treefmt = {
+          programs.alejandra.enable = true;
+          flakeFormatter = true;
+          projectRootFile = "flake.nix";
+        };
+      };
+    });
+}