aboutsummaryrefslogtreecommitdiff
path: root/gnu/home/services/utils.scm
blob: 3ce32f80c0841908b936d07cedc83a9ff9342a5f (about) (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
;;; 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
            list->human-readable-list))

(define (maybe-object->string object)
  "Like @code{object->string} but don't do anything 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))))))))))

(define* (list->human-readable-list lst
                                    #:key
                                    (cumulative? #f)
                                    (proc identity))
  "Turn a list LST into a sequence of terms readable by humans.
If CUMULATIVE? is @code{#t}, use ``and'', otherwise use ``or'' before
the last term.

PROC is a procedure to apply to each of the elements of a list before
turning them into a single human readable string.

@example
(list->human-readable-list '(1 4 9) #:cumulative? #t #:proc sqrt)
@result{} \"1, 2, and 3\"
@end example

yields:"
  (let* ((word (if cumulative? "and " "or "))
         (init (append (drop-right lst 1))))
    (format #f "~a" (string-append
                     (string-join
                      (map (compose maybe-object->string proc) init)
                      ", " 'suffix)
                     word
                     (maybe-object->string (proc (last lst)))))))

a130'>about -rw-r--r--apl.scm3278logplainabout -rw-r--r--apparmor.scm8152logplainabout -rw-r--r--apr.scm4258logplainabout -rw-r--r--arcan.scm11141logplainabout -rw-r--r--aspell.scm21407logplainabout -rw-r--r--assembly.scm21936logplainabout -rw-r--r--astronomy.scm100303logplainabout -rw-r--r--attr.scm3492logplainabout -rw-r--r--audio.scm229736logplainabout -rw-r--r--augeas.scm2617logplainabout -rw-r--r--authentication.scm6865logplainabout -rw-r--r--autogen.scm4534logplainabout -rw-r--r--autotools.scm27444logplainabout d---------aux-files336logplain -rw-r--r--avahi.scm5706logplainabout -rw-r--r--avr-xyz.scm3853logplainabout -rw-r--r--avr.scm7855logplainabout -rw-r--r--axoloti.scm29131logplainabout -rw-r--r--backup.scm59183logplainabout -rw-r--r--barrier.scm2761logplainabout -rw-r--r--base.scm68671logplainabout -rw-r--r--bash.scm21356logplainabout -rw-r--r--batik.scm8758logplainabout -rw-r--r--bdw-gc.scm5976logplainabout -rw-r--r--benchmark.scm30424logplainabout -rw-r--r--bioconductor.scm660558logplainabout -rw-r--r--bioinformatics.scm726429logplainabout -rw-r--r--bison.scm3264logplainabout -rw-r--r--bittorrent.scm23086logplainabout -rw-r--r--boost.scm20381logplainabout -rw-r--r--bootloaders.scm73128logplainabout -rw-r--r--bootstrap.scm45152logplainabout -rw-r--r--bqn.scm9192logplainabout -rw-r--r--browser-extensions.scm4613logplainabout -rw-r--r--build-tools.scm32927logplainabout -rw-r--r--busybox.scm7726logplainabout -rw-r--r--c.scm56820logplainabout -rw-r--r--calcurse.scm3469logplainabout -rw-r--r--calendar.scm19795logplainabout -rw-r--r--ccache.scm3183logplainabout -rw-r--r--cdrom.scm42776logplainabout -rw-r--r--cedille.scm5388logplainabout -rw-r--r--certs.scm12932logplainabout -rw-r--r--check.scm134773logplainabout -rw-r--r--chemistry.scm51815logplainabout -rw-r--r--chez.scm58540logplainabout -rw-r--r--chicken.scm12183logplainabout -rw-r--r--chromium.scm46052logplainabout -rw-r--r--ci.scm13458logplainabout -rw-r--r--cinnamon.scm2923logplainabout -rw-r--r--clojure.scm28052logplainabout -rw-r--r--cluster.scm11841logplainabout -rw-r--r--cmake.scm18776logplainabout -rw-r--r--cobol.scm3223logplainabout -rw-r--r--code.scm45624logplainabout -rw-r--r--commencement.scm161897logplainabout -rw-r--r--compression.scm118247logplainabout -rw-r--r--compton.scm5628logplainabout -rw-r--r--configuration-management.scm4341logplainabout -rw-r--r--conky.scm3453logplainabout -rw-r--r--connman.scm8187logplainabout -rw-r--r--containers.scm13570logplainabout -rw-r--r--convmv.scm2300logplainabout -rw-r--r--cook.scm4105logplainabout -rw-r--r--coq.scm31441logplainabout -rw-r--r--cpio.scm2300logplainabout -rw-r--r--cpp.scm91242logplainabout -rw-r--r--cppi.scm1775logplainabout -rw-r--r--cran.scm1280330logplainabout -rw-r--r--crates-graphics.scm110439logplainabout -rw-r--r--crates-gtk.scm71594logplainabout -rw-r--r--crates-io.scm2386504logplainabout -rw-r--r--cross-base.scm25838logplainabout -rw-r--r--crypto.scm72423logplainabout -rw-r--r--cryptsetup.scm6632logplainabout -rw-r--r--cups.scm46987logplainabout -rw-r--r--curl.scm17350logplainabout -rw-r--r--cvassistant.scm3600logplainabout -rw-r--r--cybersecurity.scm6306logplainabout -rw-r--r--cyrus-sasl.scm3439logplainabout -rw-r--r--darwin.scm4460logplainabout -rw-r--r--databases.scm201666logplainabout -rw-r--r--datamash.scm6611logplainabout -rw-r--r--datastructures.scm16947logplainabout -rw-r--r--dav.scm6445logplainabout -rw-r--r--dbm.scm8358logplainabout -rw-r--r--dc.scm2177logplainabout -rw-r--r--debian.scm27204logplainabout -rw-r--r--debug.scm38249logplainabout -rw-r--r--dejagnu.scm3502logplainabout -rw-r--r--dezyne.scm5022logplainabout -rw-r--r--dhall.scm5386logplainabout