/
skeleton.lisp
319 lines (294 loc) · 16.2 KB
/
skeleton.lisp
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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
;; Copyright (c) 2012 Phil Hargett
;; Permission is hereby granted, free of charge, to any person obtaining a copy
;; of this software and associated documentation files (the "Software"), to deal
;; in the Software without restriction, including without limitation the rights
;; to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
;; copies of the Software, and to permit persons to whom the Software is
;; furnished to do so, subject to the following conditions:
;; The above copyright notice and this permission notice shall be included in
;; all copies or substantial portions of the Software.
;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
;; IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
;; FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
;; AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
;; LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
;; OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
;; THE SOFTWARE.
(in-package :hh-web)
(defclass skeleton ()
((location :type (satisfies directory-pathname-p)
:initarg :location
:accessor in-location)
(package :type (or symbol string)
:initarg :package
:accessor for-package))
(:documentation "A skeleton represents the starting point for a project based on hh-web"))
(defgeneric skeleton-components (skeleton)
(:documentation "Return the list of components of the skeleton, as a list of keywords")
(:method ((skeleton skeleton))
`(:directory
:system
:package
:taglibraries
:templates
:logs
:urls
:locales
:server
:quickrun)))
(defgeneric location-pathname (location)
(:documentation "Convert the argument to a pathname")
(:method ((location pathname))
location)
(:method ((location symbol))
(location-pathname (string location)))
(:method ((location string))
(make-pathname :directory location)))
(defgeneric skeleton-location (skeleton)
(:method ((skeleton skeleton))
(merge-pathnames (make-pathname :directory `(:relative ,(string-downcase (string (for-package skeleton)))))
(location-pathname (in-location skeleton)))))
(defmacro with-skeleton-file ((stream skeleton path) &rest body)
"Write a string representation of content to the
location specified path relative to the skeleton's base director"
`(with-open-file (,stream (merge-pathnames ,path (skeleton-location ,skeleton))
:direction :output
:if-does-not-exist :create)
,@body))
(defun generate-skeleton-file (skeleton path content)
(declare (type skeleton skeleton)
(type pathname path)
(type content list))
(with-open-file (os (merge-pathnames path (skeleton-location skeleton))
:direction :output
:if-does-not-exist :create)
(let ((*print-case* :downcase)
(*package* (find-package :asdf)))
(loop for item in content
do (print item os)
do (pprint-newline :mandatory)
do (pprint-newline :mandatory)))))
(defgeneric generate-skeleton (skeleton)
(:documentation "Generate all the files necessary for a project using hh-web")
(:method ((skeleton skeleton))
;; Generate each component--creating directory should be first one
(loop for component in (skeleton-components skeleton)
do (generate-skeleton-component skeleton component))
(skeleton-location skeleton)))
(defgeneric generate-skeleton-component (skeleton component)
(:documentation "Generate the files necessary for the indicated component and skeleton"))
(defmethod generate-skeleton-component ((skeleton skeleton) (component symbol))
"If no such component exists for the skeleton, do nothing"
component)
(defmethod generate-skeleton-component ((skeleton skeleton) (component (eql :directory)))
(ensure-directories-exist (skeleton-location skeleton)))
(defmethod generate-skeleton-component ((skeleton skeleton) (component (eql :system)))
(let* ((package-name (string-downcase (symbol-name (for-package skeleton))))
(system-file-pathname (pathname (format nil "~a.asd" package-name))))
(with-skeleton-file (os skeleton system-file-pathname)
(format os "(defpackage #:~a-asd~%" package-name)
(format os " (:use :cl :asdf))~%~%")
(format os "(in-package :~a-asd)~%~%" package-name)
(format os "(defsystem ~a~%" package-name)
(format os " :name \"~a\"~%" package-name)
(format os " :version \"0.01\"~%")
(format os " :serial t~%")
(format os " :components ((:file \"package\")~%")
(format os " (:file \"logs\")~%")
(format os " (:file \"templates\")~%")
(format os " (:file \"urls\")~%")
(format os " (:file \"server\"))~%")
(format os " :depends-on (#:log5~%")
(format os " (:version #:hh-web \"0.02\")))~%"))))
(defmethod generate-skeleton-component ((skeleton skeleton) (component (eql :package)))
(let* ((package-name (string-downcase (symbol-name (for-package skeleton)))))
(with-skeleton-file (os skeleton #p"package.lisp")
(format os "(defpackage #:~a-asd~%" package-name)
(format os " (:use :cl :asdf))~%~%")
(format os "(defpackage #:~a~%" package-name)
(format os " (:use :cl~%")
(format os " :hh-web)~%")
(format os " (:export~%")
(format os " ;; Exports go here~%")
(format os " #:start-httpd-server~%")
(format os " #:stop-httpd-server~%")
(format os " ))~%")
)))
(defmethod generate-skeleton-component ((skeleton skeleton) (component (eql :taglibraries)))
(ensure-directories-exist (merge-pathnames #p"taglibraries/" (skeleton-location skeleton)))
(ensure-directories-exist (merge-pathnames #p"js/" (skeleton-location skeleton)))
(ensure-directories-exist (merge-pathnames #p"css/" (skeleton-location skeleton)))
(ensure-directories-exist (merge-pathnames #p"images/" (skeleton-location skeleton)))
(let* ((package-name (string-downcase (symbol-name (for-package skeleton)))))
(with-skeleton-file (os skeleton #p"taglibraries/ui-theme.lisp")
(format os "(in-tag-library :ui-theme)~%~%")
(format os "(+tag-library :html)~%")
(format os "(+tag-library :script)~%")
(format os "(defhtmltag ui-header~%")
(format os " :style \".header {~%")
(format os " position:relative;~%")
(format os " font-family: Arial;~%")
(format os " font-weight: bold;~%")
(format os " font-size: 48px;~%")
(format os " height: 84px;~%")
(format os " margin-left: 84px;~%")
(format os " margin-top:5px;~%")
(format os " margin-bottom:5px;~%")
(format os " }~%")
(format os " ~%")
(format os " .header-content {~%")
(format os " position: absolute;~%")
(format os " bottom: 0;~%")
(format os " }\"~%")
(format os " ~%")
(format os " :content (div {:class \"jumbotron\"}~%")
(format os " (h1 \":: All about ~a :\"))~%~%" package-name)
(format os " )~%~%")
(format os "(defhtmltag ui-body ~%~%")
(format os " :style \".text {~%")
(format os " background-color: silver;~%")
(format os " padding: 25px;~%")
(format os " }\"~%")
(format os " ~%")
(format os " :content _body)~%~%")
(format os "(defhtmltag ui-jquery~%")
(format os " :script-libraries `(\"http://code.jquery.com/jquery-2.1.0.min.js\"))~%~%")
(format os "(defhtmltag ui-bootstrap~%")
(format os " :style-sheets `(\"//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css\")~%")
(format os " :script-libraries `(\"//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js\"))~%~%")
(format os "(defhtmltag ui-bootstrap-theme~%")
(format os " :style-sheets `(\"//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap-theme.min.css\"))~%~%")
(format os "(defhtmltag ui-page~%")
(format os " :content (div {:class \"container\"}~%")
(format os " (ui-jquery)~%")
(format os " (ui-bootstrap)~%")
(format os " (ui-bootstrap-theme)~%")
(format os " (ui-header)~%")
(format os " (ui-body _body)))~%"))))
;; Documentation
;; (package-doc-page \"docs.lisp\" :args ( package ) )
(defmethod generate-skeleton-component ((skeleton skeleton) (component (eql :templates)))
(let* ((package-name (string-downcase (symbol-name (for-package skeleton)))))
(with-skeleton-file (os skeleton #p"templates.lisp")
(format os "(in-package :~a)~%~%" package-name)
(format os "(deftemplates :tag-library-packages (\"~a\")~%" package-name)
(format os " :template-packages (:~a)~%" package-name)
(format os " :templates (~%")
(format os " ;; General site templates~%")
(format os " (home-page \"home_page.lisp\")~%")
(format os " ;; Favorite icon~%")
(format os " (favicon-image \"favicon.lisp\")~%")
(format os " ;; Documentation viewer~%")
(format os " (package-doc-page \"docs.lisp\" :args ( package ) )))~%"))
(ensure-directories-exist (merge-pathnames #p"templates/" (skeleton-location skeleton)))
(with-skeleton-file (os skeleton #p"templates/home_page.lisp")
(format os "(+tag-library :html)~%")
(format os "(+tag-library :ui-theme)~%~%")
(format os "(page~%")
(format os " (+title \"Hornbook home page\")~%")
(format os " (ui-page~%")
(format os " (div {:class \"page-header\"}~%")
(format os " (h1 \"Hello world!\")~%")
(format os " (p {:class \"text\" } \"This text styled by the $(tag-name *this-tag*) tag\")~%")
(format os " (p {:style \"padding:25px\" } \"This is text styled in a $(tag-name *current-tag*) tag\")~%")
(format os " (p {:class \"well\"} \"This text styled by \" (a {:href \"http://getbootstrap.com\" } \"Bootstrap\")))))~%"))
(with-skeleton-file (os skeleton #p"templates/docs.lisp")
(format os "(+tag-library :html)~%")
(format os "(+tag-library :ui-theme)~%~%")
(format os "(+tag-library :doc)~%~%")
(format os "(page~%")
(format os " (doc-page {:package package}))~%"))
(with-skeleton-file (os skeleton #p"templates/favicon.lisp")
(format os "(+tag-library :html)~%")
(format os "~%")
(format os "(use-package :vecto)~%")
(format os "~%")
(format os "(image (:width 100 :height 100)~%")
(format os " (set-line-width 4)~%")
(format os "~%")
(format os " (move-to 0 100)~%")
(format os " (set-rgb-stroke 1.0 1.0 0.0)~%")
(format os " (line-to 100 0)~%")
(format os " (fill-and-stroke)~%")
(format os "~%")
(format os " (move-to 0 0)~%")
(format os " (set-rgb-stroke 1.0 0.0 0.0)~%")
(format os " (line-to 100 100)~%")
(format os " (fill-and-stroke)~%")
(format os "~%")
(format os " (move-to 0 50)~%")
(format os " (set-rgb-stroke 0.0 1.0 0.0)~%")
(format os " (line-to 100 50)~%")
(format os " (fill-and-stroke)~%")
(format os "~%")
(format os " (move-to 50 100)~%")
(format os " (set-rgb-stroke 0.0 0.0 1.0)~%")
(format os " (line-to 50 0)~%")
(format os " (fill-and-stroke)~%")
(format os "~%")
(format os " (set-line-width 0)~%")
(format os " (set-rgb-fill 0.8 0.0 1.0)~%")
(format os " (centered-circle-path 50 50 15)~%")
(format os " (fill-and-stroke))~%"))))
(defmethod generate-skeleton-component ((skeleton skeleton) (component (eql :logs)))
(let* ((package-name (string-downcase (symbol-name (for-package skeleton)))))
(with-skeleton-file (os skeleton #p"logs.lisp")
(format os "(in-package :~a)~%~%" package-name)
(format os "(defvar *log-root* #p\"logs\")~%~%")
(format os "(defun init-logging()~%")
(format os " (log5:start-sender 'http-access-log (rotating-log-sender ~%")
(format os " :interval (* 30 60) ;; new log every 30 minutes~%")
(format os " :max 5~%")
(format os " :location (merge-pathnames \"~a-access.log\" *log-root*))~%" package-name)
(format os " :category-spec `(http-access)~%")
(format os " :output-spec `(log5:message))~%")
(format os " (log5:start-sender 'http-messages-log (rotating-log-sender ~%")
(format os " :interval (* 30 60) ;; new log every 30 minutes~%")
(format os " :max 5~%")
(format os " :location (merge-pathnames \"~a-messages.log\" *log-root*))~%" package-name)
(format os " :category-spec `(http-message)~%")
(format os " :output-spec `(log5:message)))~%")
)))
(defmethod generate-skeleton-component ((skeleton skeleton) (component (eql :urls)))
(let* ((package-name (string-downcase (symbol-name (for-package skeleton)))))
(with-skeleton-file (os skeleton #p"urls.lisp")
(format os ";; Dispatch to home page template~%")
(format os "(defurl \"^/$\" :handler (home-page))~%~%")
(format os ";; Dispatch to favicon renderer~%")
(format os "(defurl \"^/favicon.ico$\" :handler (favicon-image))~%")
(format os ";; Dispatch to package documentation viewer~%")
(format os "(defurl \"^/docs/(?<package>.*)\" :handler (package-doc-page package) :categories (docs) )~%"))))
(defmethod generate-skeleton-component ((skeleton skeleton) (component (eql :locales)))
)
(defmethod generate-skeleton-component ((skeleton skeleton) (component (eql :server)))
(let* ((package-name (string-downcase (symbol-name (for-package skeleton)))))
(with-skeleton-file (os skeleton #p"server.lisp")
(format os "(in-package :~a)~%~%" package-name)
(format os "(defvar *httpd-port* 8000)~%~%")
(format os "(let ((httpd (create-web-server (:port *httpd-port*~%")
(format os " :read-timeout 0.5~%")
(format os " :write-timeout 0.5~%")
(format os " :access-log-destination *error-output*~%")
(format os " :message-log-destination *error-output*)~%")
(format os " :packages (( \"/\" \"~a\"))~%" package-name)
(format os " :folders ((\"/js/\" \"~a/js/\")~%" (skeleton-location skeleton))
(format os " (\"/css/\" \"~a/css/\")~%" (skeleton-location skeleton))
(format os " (\"/images/\" \"~a/images/\"))))~%" (skeleton-location skeleton))
(format os " (*locale-package :~a))~%" package-name)
(format os " (init-localization :~a \"en_US\")~%~%" package-name)
(format os " (defun start-httpd-server (&key (wait nil))~%")
(format os " (run-web-server httpd :wait wait))~%~%")
(format os " (defun stop-httpd-server ()~%")
(format os " (hunchentoot:stop httpd)))~%~%"))))
(defmethod generate-skeleton-component ((skeleton skeleton) (component (eql :quickrun)))
(let* ((package-name (string-downcase (symbol-name (for-package skeleton)))))
(with-skeleton-file (os skeleton #p"quickrun.lisp")
(format os "(ql:quickload :~a)~%~%" package-name)
(format os "(~a:start-httpd-server)~%" package-name))))
(defun make-skeleton (&key for in)
"Generate a skeleton for a package in the indicated location; "
(declare (type (or symbol string) for)
(type (satisfies cl-fad:directory-pathname-p) in))
(let ((skeleton (make-instance 'skeleton :package for :location in)))
(generate-skeleton skeleton)
skeleton))