aboutsummaryrefslogtreecommitdiff
path: root/lib/oneliner.lisp
blob: 8386fa9fd73a23042a205998f879a2af01eb4b60 (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
106
107
108
109
110
111
112
;;;; oneliner.lisp -- defines a oneliner structure and functions for using it

;; Copyright (C) 2022  Colin Okay

;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU Affero General Public License as
;; published by the Free Software Foundation, either version 3 of the
;; License, or (at your option) any later version.

;; This program 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 Affero General Public License for more details.

;; You should have received a copy of the GNU Affero General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.


(in-package :oneliners.cli)

(defplist oneliner
  id
  name
  oneliner
  tags
  brief
  explanation
  runstyle
  createdat
  editedat
  createdby
  isflagged
  islocked)

;;; SUPPLEMENTARY GETTERS

(defun get-positional-arguments (ol)
  "Collects the names of all positional arguments in the oneliner, prefix included."
  (remove-duplicates 
   (sort 
    (ppcre:all-matches-as-strings "#[1-9][0-9]*" (oneliner-oneliner ol))
    #'string<)
   :test #'equal))

(defun get-named-arguments (ol)
  "Collects the names of all named arguments in the oneliner, prefix included"
  (remove-duplicates 
   (ppcre:all-matches-as-strings "#[A-Za-z][A-Za-z0-9_]*" (oneliner-oneliner ol))
   :test #'equal))



;;; VALIDATION OF ONELINER SLOT VALUES

(defun valid-oneliner-string-p (string)
  (and (not (find #\newline string))
       (parse-oneliner-tags string)))

(defun valid-brief-description-p (string)
  (<= (length string) 72))

(defun valid-runstyle-p (string)
  (member string '("auto" "manual") :test 'equalp))

(defun valid-oneliner-name-p (string)
  (or (equal string "")
      (and (< 2 (length string)) 
           (ppcre:scan "^[a-zA-Z][a-zA-Z0-9_\-]+$" string))))

;;; PRINTING 

(defun print-oneliner-result-for-user (ol)
  "Prints information about the oneliner to the terminal."
  (unless *term-width* (set-term-width)) ; setting here as a fallback, can set it elswere if desired.
  (let* ((title-line-format-str
           (concatenate 'string "~" (prin1-to-string *term-width*) "<[~a]~;~a~;~a~>~%"))
         (tags-line-format-string
           (concatenate 'string "~" (prin1-to-string *term-width*) "<~a~;by ~a ~a~>~%"))) 
    (loop repeat *term-width* do (princ #\_))
    (terpri)
    (format t title-line-format-str
            (oneliner-id ol)
            (or (oneliner-name ol) " ")
            (format nil "~:[ ~;⚠~]~:[ ~;🔒~]~:[ ~;📋~]"
                    (oneliner-isflagged ol)
                    (oneliner-islocked ol)
                    (equalp "manual" (oneliner-runstyle ol))))
    (format t tags-line-format-string
            (format nil "tags: ~{~a~^ ~}" (oneliner-tags ol))
            (oneliner-createdby ol)
            (datestring-of-universal-time (oneliner-createdat ol)))
    (loop
      for x from 0 to (length (oneliner-brief ol)) by *term-width*
      do (format t "~a~%"
                 (string-trim '(#\space)
                              (alexandria-2:subseq* (oneliner-brief ol) x (+ x *term-width*)))))
    (format t "~%~a~%~%" (oneliner-oneliner ol))))

;;;; json serialization

(defun oneliner-to-json-body (ol)
  "Takes a oneliner structure and produces some json suitable for
sending to the server.  ID and some other fields are omitted."
  (jonathan:to-json
   (list :oneliner (oneliner-oneliner ol)
         :tags (oneliner-tags ol)
         :brief (oneliner-brief ol)
         :name (if (plusp (length (oneliner-name ol)))
                   (oneliner-name ol)
                   :null)
         :explanation (oneliner-explanation ol)
         :runstyle (oneliner-runstyle ol))))