[bug#50208] [PATCH 0/4] Fixes and improvements for home-services

[Andrew Tropin]

There are a few follow up patches for the current wip-guix-home branch:
- Add utils ns with helpers for converting cases, which was missing.
- Fix issue with creating first home-environment generation.
- Add support to activation script for multiline values for environment
variables.
- Add a doc comment.

The patches are attached to this messages.

Andrew Tropin (4):
  home-services: Add utils module.
  home-services: symlink-manager: Properly handle 1st generation case
  home-services: activation: Add support for multiline env vars
  gnu: home: Add doc comment about the module

 gnu/home-services.scm                 |  4 +-
 gnu/home-services/shells.scm          |  1 +
 gnu/home-services/symlink-manager.scm |  2 +-
 gnu/home-services/utils.scm           | 77 +++++++++++++++++++++++++++
 gnu/home.scm                          |  8 +++
 5 files changed, 89 insertions(+), 3 deletions(-)
 create mode 100644 gnu/home-services/utils.scm

-- 
2.33.0

From 93ae498296b37e5b21b6a824d090b0898b870a39 Mon Sep 17 00:00:00 2001
From: Andrew Tropin <andrew@trop.in>
Date: Mon, 30 Aug 2021 12:17:11 +0300
Subject: [PATCH 1/4] home-services: Add utils module.

* gnu/home-services/utils.scm (maybe-object->string object->snake-case-string)
(object->snake-case-string): New variables.
---
 gnu/home-services/shells.scm |  1 +
 gnu/home-services/utils.scm  | 77 ++++++++++++++++++++++++++++++++++++
 2 files changed, 78 insertions(+)
 create mode 100644 gnu/home-services/utils.scm

diff --git a/gnu/home-services/shells.scm b/gnu/home-services/shells.scm
index b8065d28d2..ecb02098f7 100644
--- a/gnu/home-services/shells.scm
+++ b/gnu/home-services/shells.scm
@@ -20,6 +20,7 @@
 (define-module (gnu home-services shells)
   #:use-module (gnu services configuration)
   #:use-module (gnu home-services configuration)
+  #:use-module (gnu home-services utils)
   #:use-module (gnu home-services)
   #:use-module (gnu packages shells)
   #:use-module (gnu packages bash)
diff --git a/gnu/home-services/utils.scm b/gnu/home-services/utils.scm
new file mode 100644
index 0000000000..3e490a0515
--- /dev/null
+++ b/gnu/home-services/utils.scm
@@ -0,0 +1,77 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2021 Xinglu Chen <public@yoctocell.xyz>
+;;; Copyright © 2021 Andrew Tropin <andrew@trop.in>
+;;;
+;;; This file is part of GNU Guix.
+;;;
+;;; GNU Guix is free software; you can redistribute it and/or modify it
+;;; under the terms of the GNU General Public License as published by
+;;; the Free Software Foundation; either version 3 of the License, or (at
+;;; your option) any later version.
+;;;
+;;; GNU Guix is distributed in the hope that it will be useful, but
+;;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;;; GNU General Public License for more details.
+;;;
+;;; You should have received a copy of the GNU General Public License
+;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
+
+(define-module (gnu home-services utils)
+  #:use-module (ice-9 string-fun)
+  #:use-module (srfi srfi-1)
+  #:use-module (srfi srfi-26)
+
+  #:export (maybe-object->string
+            object->snake-case-string
+            object->camel-case-string))
+
+(define (maybe-object->string object)
+  "Like @code{object->string} but don't do anyting if OBJECT already is
+a string."
+  (if (string? object)
+      object
+      (object->string object)))
+
+;; Snake case: <https://en.wikipedia.org/wiki/Snake_case>
+(define* (object->snake-case-string object #:optional (style 'lower))
+  "Convert the object OBJECT to the equivalent string in ``snake
+case''.  STYLE can be three `@code{lower}', `@code{upper}', or
+`@code{capitalize}', defaults to `@code{lower}'.
+
+@example
+(object->snake-case-string 'variable-name 'upper)
+@result{} \"VARIABLE_NAME\" @end example"
+  (if (not (member style '(lower upper capitalize)))
+      (error 'invalid-style (format #f "~a is not a valid style" style))
+      (let ((stringified (maybe-object->string object)))
+        (string-replace-substring
+         (cond
+          ((equal? style 'lower) stringified)
+          ((equal? style 'upper) (string-upcase stringified))
+          (else (string-capitalize stringified)))
+         "-" "_"))))
+
+(define* (object->camel-case-string object #:optional (style 'lower))
+  "Convert the object OBJECT to the equivalent string in ``camel case''.
+STYLE can be three `@code{lower}', `@code{upper}', defaults to
+`@code{lower}'.
+
+@example
+(object->camel-case-string 'variable-name 'upper)
+@result{} \"VariableName\"
+@end example"
+  (if (not (member style '(lower upper)))
+      (error 'invalid-style (format #f "~a is not a valid style" style))
+      (let ((stringified (maybe-object->string object)))
+        (cond
+         ((eq? style 'upper)
+          (string-concatenate
+           (map string-capitalize
+                (string-split stringified (cut eqv? <> #\-)))))
+         ((eq? style 'lower)
+          (let ((splitted-string (string-split stringified (cut eqv? <> #\-))))
+            (string-concatenate
+             (cons (first splitted-string)
+                   (map string-capitalize
+                        (cdr splitted-string))))))))))
-- 
2.33.0

From eebdfd72d2e20b18154f66fc0f84c723340e3b5f Mon Sep 17 00:00:00 2001
From: Andrew Tropin <andrew@trop.in>
Date: Mon, 30 Aug 2021 12:23:48 +0300
Subject: [PATCH 2/4] home-services: symlink-manager: Properly handle 1st
 generation case

---
 gnu/home-services/symlink-manager.scm | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/gnu/home-services/symlink-manager.scm 
b/gnu/home-services/symlink-manager.scm
index dc409d2ae2..11f5d503d4 100644
--- a/gnu/home-services/symlink-manager.scm
+++ b/gnu/home-services/symlink-manager.scm
@@ -102,7 +102,7 @@ appear only after all nested items already listed."
                                          (number->string (current-time))
                                          "-guix-home-legacy-configs-backup"))
 
-              (old-tree (if (file-exists? old-home)
+              (old-tree (if old-home
                           ((simplify-file-tree "")
                            (file-system-tree
                             (string-append old-home "/files/.")))
-- 
2.33.0

From 25f61084e11fccc50dc1fbec3b28e7dea091e625 Mon Sep 17 00:00:00 2001
From: Andrew Tropin <andrew@trop.in>
Date: Mon, 30 Aug 2021 12:26:19 +0300
Subject: [PATCH 3/4] home-services: activation: Add support for multiline env
 vars

---
 gnu/home-services.scm | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/gnu/home-services.scm b/gnu/home-services.scm
index 16b9736d64..2a773496f0 100644
--- a/gnu/home-services.scm
+++ b/gnu/home-services.scm
@@ -324,7 +324,7 @@ extended with one gexp.")))
                               #f))))
        (if (file-exists? (he-init-file new-home))
            (let* ((port   ((@ (ice-9 popen) open-input-pipe)
-                           (format #f "source ~a && env"
+                           (format #f "source ~a && env -0"
                                    (he-init-file new-home))))
                   (result ((@ (ice-9 rdelim) read-delimited) "" port))
                   (vars (map (lambda (x)
@@ -333,7 +333,7 @@ extended with one gexp.")))
                                        (string-drop x (1+ si)))))
                              ((@ (srfi srfi-1) remove)
                               string-null?
-                              (string-split result #\newline)))))
+                              (string-split result #\nul)))))
              (close-port port)
              (map (lambda (x) (setenv (car x) (cdr x))) vars)
 
-- 
2.33.0

From ec05edf310609dd1424ce7bfdcaaf6758a77fe29 Mon Sep 17 00:00:00 2001
From: Andrew Tropin <andrew@trop.in>
Date: Mon, 30 Aug 2021 12:07:48 +0300
Subject: [PATCH 4/4] gnu: home: Add doc comment about the module

---
 gnu/home.scm | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/gnu/home.scm b/gnu/home.scm
index a53d27163d..f4c9359e25 100644
--- a/gnu/home.scm
+++ b/gnu/home.scm
@@ -38,6 +38,14 @@
 
             home-environment-with-provenance))
 
+;;; Comment:
+;;;
+;;; This module provides a <home-environment> record for managing
+;;; per-user packages and configuration files in the similar way as
+;;; <operating-system> do for system packages and configuration files.
+;;;
+;;; Code:
+
 (define-record-type* <home-environment> home-environment
   make-home-environment
   home-environment?
-- 
2.33.0

signature.asc
Description: PGP signature