From bc90de24d898655542589237cc0a6ada7564cb6c Mon Sep 17 00:00:00 2001
From: Andrew Marshall <andrew@johnandrewmarshall.com>
Date: Sat, 12 Nov 2022 09:35:01 -0500
Subject: [PATCH] xdg-user-dirs: allow setting to null to skip setting

Previously, this module was all-or-nothing with its pre-defined user
dirs. This allows e.g. `xdg.userDirs.desktop = null;` to opt-out of
some configuration while still benefiting from the rest.
---
 modules/misc/xdg-user-dirs.nix            | 20 ++++++++---------
 tests/modules/misc/xdg/default.nix        |  1 +
 tests/modules/misc/xdg/user-dirs-null.nix | 26 +++++++++++++++++++++++
 3 files changed, 37 insertions(+), 10 deletions(-)
 create mode 100644 tests/modules/misc/xdg/user-dirs-null.nix

diff --git a/modules/misc/xdg-user-dirs.nix b/modules/misc/xdg-user-dirs.nix
index 36f200eb9..2ea07709a 100644
--- a/modules/misc/xdg-user-dirs.nix
+++ b/modules/misc/xdg-user-dirs.nix
@@ -33,7 +33,7 @@ in {
     # https://gitlab.freedesktop.org/xdg/xdg-user-dirs/blob/master/man/user-dirs.dirs.xml
 
     desktop = mkOption {
-      type = with types; coercedTo path toString str;
+      type = with types; nullOr (coercedTo path toString str);
       default = "${config.home.homeDirectory}/Desktop";
       defaultText =
         literalExpression ''"''${config.home.homeDirectory}/Desktop"'';
@@ -41,7 +41,7 @@ in {
     };
 
     documents = mkOption {
-      type = with types; coercedTo path toString str;
+      type = with types; nullOr (coercedTo path toString str);
       default = "${config.home.homeDirectory}/Documents";
       defaultText =
         literalExpression ''"''${config.home.homeDirectory}/Documents"'';
@@ -49,7 +49,7 @@ in {
     };
 
     download = mkOption {
-      type = with types; coercedTo path toString str;
+      type = with types; nullOr (coercedTo path toString str);
       default = "${config.home.homeDirectory}/Downloads";
       defaultText =
         literalExpression ''"''${config.home.homeDirectory}/Downloads"'';
@@ -57,7 +57,7 @@ in {
     };
 
     music = mkOption {
-      type = with types; coercedTo path toString str;
+      type = with types; nullOr (coercedTo path toString str);
       default = "${config.home.homeDirectory}/Music";
       defaultText =
         literalExpression ''"''${config.home.homeDirectory}/Music"'';
@@ -65,7 +65,7 @@ in {
     };
 
     pictures = mkOption {
-      type = with types; coercedTo path toString str;
+      type = with types; nullOr (coercedTo path toString str);
       default = "${config.home.homeDirectory}/Pictures";
       defaultText =
         literalExpression ''"''${config.home.homeDirectory}/Pictures"'';
@@ -73,7 +73,7 @@ in {
     };
 
     publicShare = mkOption {
-      type = with types; coercedTo path toString str;
+      type = with types; nullOr (coercedTo path toString str);
       default = "${config.home.homeDirectory}/Public";
       defaultText =
         literalExpression ''"''${config.home.homeDirectory}/Public"'';
@@ -81,7 +81,7 @@ in {
     };
 
     templates = mkOption {
-      type = with types; coercedTo path toString str;
+      type = with types; nullOr (coercedTo path toString str);
       default = "${config.home.homeDirectory}/Templates";
       defaultText =
         literalExpression ''"''${config.home.homeDirectory}/Templates"'';
@@ -89,7 +89,7 @@ in {
     };
 
     videos = mkOption {
-      type = with types; coercedTo path toString str;
+      type = with types; nullOr (coercedTo path toString str);
       default = "${config.home.homeDirectory}/Videos";
       defaultText =
         literalExpression ''"''${config.home.homeDirectory}/Videos"'';
@@ -113,7 +113,7 @@ in {
   };
 
   config = let
-    directories = {
+    directories = (filterAttrs (n: v: !isNull v) {
       XDG_DESKTOP_DIR = cfg.desktop;
       XDG_DOCUMENTS_DIR = cfg.documents;
       XDG_DOWNLOAD_DIR = cfg.download;
@@ -122,7 +122,7 @@ in {
       XDG_PUBLICSHARE_DIR = cfg.publicShare;
       XDG_TEMPLATES_DIR = cfg.templates;
       XDG_VIDEOS_DIR = cfg.videos;
-    } // cfg.extraConfig;
+    }) // cfg.extraConfig;
   in mkIf cfg.enable {
     assertions =
       [ (hm.assertions.assertPlatform "xdg.userDirs" pkgs platforms.linux) ];
diff --git a/tests/modules/misc/xdg/default.nix b/tests/modules/misc/xdg/default.nix
index f3fef0929..4cce5bafc 100644
--- a/tests/modules/misc/xdg/default.nix
+++ b/tests/modules/misc/xdg/default.nix
@@ -4,4 +4,5 @@
   xdg-desktop-entries = ./desktop-entries.nix;
   xdg-file-gen = ./file-gen.nix;
   xdg-default-locations = ./default-locations.nix;
+  xdg-user-dirs-null = ./user-dirs-null.nix;
 }
diff --git a/tests/modules/misc/xdg/user-dirs-null.nix b/tests/modules/misc/xdg/user-dirs-null.nix
new file mode 100644
index 000000000..6e8c4f18d
--- /dev/null
+++ b/tests/modules/misc/xdg/user-dirs-null.nix
@@ -0,0 +1,26 @@
+{ config, lib, pkgs, ... }:
+
+{
+  config = {
+    xdg.userDirs = {
+      enable = true;
+      desktop = null;
+    };
+
+    nmt.script = ''
+      configFile=home-files/.config/user-dirs.dirs
+      assertFileExists $configFile
+      assertFileContent $configFile ${
+        pkgs.writeText "expected" ''
+          XDG_DOCUMENTS_DIR="/home/hm-user/Documents"
+          XDG_DOWNLOAD_DIR="/home/hm-user/Downloads"
+          XDG_MUSIC_DIR="/home/hm-user/Music"
+          XDG_PICTURES_DIR="/home/hm-user/Pictures"
+          XDG_PUBLICSHARE_DIR="/home/hm-user/Public"
+          XDG_TEMPLATES_DIR="/home/hm-user/Templates"
+          XDG_VIDEOS_DIR="/home/hm-user/Videos"
+        ''
+      }
+    '';
+  };
+}