rbac/rbac-docs.lisp at master · macnod/rbac · GitHub

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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
;; rbac-docs.lisp

(in-package :rbac)

(defmacro defsection-wrapper (name (&rest options) doc-string &body body)
  `(defsection ,name ,options ,(eval doc-string) ,@body))

(defsection-wrapper @rbac-manual
  (:title "RBAC System Reference Manual")
  (u:slurp (u:join-paths
             (asdf:system-relative-pathname :rbac #P"")
             "intro-src.md"))
  (@rbac-examples section)
  (@rbac-overview section)
  (@rbac-limitations section)
  (@rbac-installation section)
  (@rbac-pg-class section)
  (@rbac-functions section)
  (@rbac-variables section)
  (@rbac-macros section)
  (@rbac-development section)
  (@rbac-contact section))

(defsection-wrapper @rbac-overview
  (:title "Introduction")
  (u:slurp (u:join-paths
             (asdf:system-relative-pathname :rbac #P"")
             "overview-src.md")))

(defsection-wrapper @rbac-limitations
  (:title "Current Limitations (Planned Fixes)")
  (u:slurp (u:join-paths
             (asdf:system-relative-pathname :rbac #P"")
             "limitations-src.md")))

(defsection-wrapper @rbac-installation
  (:title "Installation")
  (u:slurp (u:join-paths
             (asdf:system-relative-pathname :rbac #P"")
             "installation-src.md")))

(defsection @rbac-pg-class
  (:title "RBAC-PG Class")
  "RBAC-PG Class and Accessors."
  (rbac-pg class)
  (db-host (accessor rbac-pg))
  (db-name (accessor rbac-pg))
  (db-password (accessor rbac-pg))
  (db-port (accessor rbac-pg))
  (db-user (accessor rbac-pg))
  (email-length-max (accessor rbac))
  (email-regex (accessor rbac))
  (password-length-max (accessor rbac))
  (password-length-min (accessor rbac))
  (password-regexes (accessor rbac))
  (permission-length-max (accessor rbac))
  (permission-regex (accessor rbac))
  (resource-length-max (accessor rbac))
  (resource-regex (accessor rbac))
  (role-length-max (accessor rbac))
  (role-regex (accessor rbac))
  (user-name-length-max (accessor rbac))
  (user-name-regex (accessor rbac)))

(defsection @rbac-functions
  (:title "Functions")
  "Accessors and methods for manipulating RBAC objects."
  (add-permission function)
  (add-resource function)
  (add-resource-role function)
  (add-role function)
  (add-role-permission function)
  (add-role-user function)
  (add-user function)
  (add-user-role function)
  (exclusive-role-for function)
  (get-id function)
  (get-value function)
  (id-exists-p function)
  (initialize-database function)
  (list-permission-names function)
  (list-permissions function)
  (list-resource-names function)
  (list-resource-role-names function)
  (list-resource-roles function)
  (list-resource-user-names function)
  (list-resource-users function)
  (list-resources function)
  (list-role-names function)
  (list-role-permission-names function)
  (list-role-permissions function)
  (list-role-resource-names function)
  (list-role-resources function)
  (list-role-user-names function)
  (list-role-users function)
  (list-roles function)
  (list-user-names function)
  (list-user-resource-names function)
  (list-user-resource-names-of-type function)
  (list-user-resource-permission-names function)
  (list-user-resources function)
  (list-user-role-names function)
  (list-user-roles function)
  (list-users function)
  (login function)
  (password-hash function)
  (password-hash function)
  (permission-count function)
  (rbac-query function)
  (rbac-query-single function)
  (remove-permission function)
  (remove-resource function)
  (remove-resource-role function)
  (remove-role function)
  (remove-role-permission function)
  (remove-role-user function)
  (remove-user function)
  (remove-user-role function)
  (resource-count function)
  (resource-role-count function)
  (resource-user-count function)
  (role-count function)
  (role-permission-count function)
  (role-resource-count function)
  (role-user-count function)
  (user-allowed function)
  (user-count function)
  (user-has-role function)
  (user-resource-count function)
  (user-role-count function)
  (valid-description-p function)
  (valid-email-p function)
  (valid-password-p function)
  (valid-permission-p function)
  (valid-resource-p function)
  (valid-role-p function)
  (valid-user-name-p function))

(defsection @rbac-macros
  (:title "Macros")
  "Exported macros."
  (with-rbac macro))

(defsection @rbac-variables
  (:title "Special Variables")
  "Exported special variables."
  (*admin* variable)
  (*guest* variable)
  (*default-page-size* variable)
  (*default-permissions* variable)
  (*default-resource-roles* variable)
  (*default-user-roles* variable))

(defsection-wrapper @rbac-examples
  (:title "Examples")
  (u:slurp (u:join-paths
             (asdf:system-relative-pathname :rbac #P"")
             "examples-src.md")))

(defsection-wrapper @rbac-development
  (:title "RBAC Development")
  (u:slurp (u:join-paths
             (asdf:system-relative-pathname :rbac #P"")
             "development-src.md")))

(defsection-wrapper @rbac-contact
  (:title "Contact")
  (u:slurp (u:join-paths
             (asdf:system-relative-pathname :rbac #P"")
             "contact-src.md")))

(defun generate-readme ()
  (let* ((file-name (u:join-paths
                      (asdf:system-relative-pathname :rbac #P"")
                      "README.md"))
          (raw-doc (with-output-to-string (s)
                     (document @rbac-manual :format :markdown :stream s)))
          (final-doc (re:regex-replace-all ":public: " raw-doc "")))
    (u:spew final-doc file-name)
    t))