Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lib.strings.concatMapAttrsStringSep: init #330010

Merged
merged 3 commits into from
Dec 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/default.nix
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ let
length head tail elem elemAt isList;
inherit (self.strings) concatStrings concatMapStrings concatImapStrings
stringLength substring isString replaceStrings
intersperse concatStringsSep concatMapStringsSep
intersperse concatStringsSep concatMapStringsSep concatMapAttrsStringSep
concatImapStringsSep concatLines makeSearchPath makeSearchPathOutput
makeLibraryPath makeIncludePath makeBinPath optionalString
hasInfix hasPrefix hasSuffix stringToCharacters stringAsChars escape
Expand Down
37 changes: 37 additions & 0 deletions lib/strings.nix
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,43 @@ rec {
f:
list: concatStringsSep sep (lib.imap1 f list);

/**
Like [`concatMapStringsSep`](#function-library-lib.strings.concatMapStringsSep)
but takes an attribute set instead of a list.

# Inputs

`sep`
: Separator to add between item strings

`f`
: Function that takes each key and value and return a string

`attrs`
: Attribute set to map from

# Type

```
concatMapAttrsStringSep :: String -> (String -> Any -> String) -> AttrSet -> String
```

# Examples

:::{.example}
## `lib.strings.concatMapAttrsStringSep` usage example

```nix
concatMapAttrsStringSep "\n" (name: value: "${name}: foo-${value}") { a = "0.1.0"; b = "0.2.0"; }
=> "a: foo-0.1.0\nb: foo-0.2.0"
```

:::
*/
concatMapAttrsStringSep =
sep: f: attrs:
concatStringsSep sep (lib.attrValues (lib.mapAttrs f attrs));

/**
Concatenate a list of strings, adding a newline at the end of each one.
Defined as `concatMapStrings (s: s + "\n")`.
Expand Down
6 changes: 6 additions & 0 deletions lib/tests/misc.nix
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ let
composeManyExtensions
concatLines
concatMapAttrs
concatMapAttrsStringSep
concatMapStrings
concatStrings
concatStringsSep
Expand Down Expand Up @@ -328,6 +329,11 @@ runTests {
expected = "a,b,c";
};

testConcatMapAttrsStringSepExamples = {
expr = concatMapAttrsStringSep "\n" (name: value: "${name}: foo-${value}") { a = "0.1.0"; b = "0.2.0"; };
expected = "a: foo-0.1.0\nb: foo-0.2.0";
};

testConcatLines = {
expr = concatLines ["a" "b" "c"];
expected = "a\nb\nc\n";
Expand Down
6 changes: 1 addition & 5 deletions pkgs/applications/virtualization/singularity/generic.nix
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,6 @@ in
}@args:

let
concatMapStringAttrsSep =
sep: f: attrs:
lib.concatMapStringsSep sep (name: f name attrs.${name}) (lib.attrNames attrs);

addShellDoubleQuotes = s: lib.escapeShellArg ''"'' + s + lib.escapeShellArg ''"'';
in
(buildGoModule {
Expand Down Expand Up @@ -210,7 +206,7 @@ in
patchShebangs --build "$configureScript" makeit e2e scripts mlocal/scripts

# Patching the hard-coded defaultPath by prefixing the packages in defaultPathInputs
${concatMapStringAttrsSep "\n" (fileName: originalDefaultPaths: ''
${lib.concatMapAttrsStringSep "\n" (fileName: originalDefaultPaths: ''
substituteInPlace ${lib.escapeShellArg fileName} \
${
lib.concatMapStringsSep " \\\n " (
Expand Down
2 changes: 1 addition & 1 deletion pkgs/test/overriding.nix
Original file line number Diff line number Diff line change
Expand Up @@ -158,5 +158,5 @@ stdenvNoCC.mkDerivation {
passthru = { inherit tests; };
buildCommand = ''
touch $out
'' + lib.concatStringsSep "\n" (lib.attrValues (lib.mapAttrs (name: t: "([[ ${lib.boolToString t.expr} == ${lib.boolToString t.expected} ]] && echo '${name} success') || (echo '${name} fail' && exit 1)") tests));
'' + lib.concatMapAttrsStringSep "\n" (name: t: "([[ ${lib.boolToString t.expr} == ${lib.boolToString t.expected} ]] && echo '${name} success') || (echo '${name} fail' && exit 1)") tests;
}
Loading