From 95e4971908574f14f6a1baa6b463aa1e7bc2b281 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Tue, 19 Dec 2017 18:24:40 +0100 Subject: [PATCH 01/28] feat(lisp): Initial Gemma backend implementation Implements the initial - very simple - backend for Gemma, a task-management app for recurring tasks. --- gemma.asd | 22 +++++++++ src/gemma.lisp | 125 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 147 insertions(+) create mode 100644 gemma.asd create mode 100644 src/gemma.lisp diff --git a/gemma.asd b/gemma.asd new file mode 100644 index 000000000..82237a6f2 --- /dev/null +++ b/gemma.asd @@ -0,0 +1,22 @@ +#| + This file is a part of gemma project. + Copyright (c) 2017 Vincent Ambo +|# + +#| + Author: Vincent Ambo +|# + +(defsystem "gemma" + :version "0.1.0" + :author "Vincent Ambo" + :license "GPLv3" + :depends-on (alexandria local-time hunchentoot yason) + :components ((:module "src" + :components + ((:file "gemma")))) + :description "Gemma is a household task management system" + :long-description + #.(read-file-string + (subpathname *load-pathname* "README.markdown")) + :in-order-to ((test-op (test-op "gemma-test")))) diff --git a/src/gemma.lisp b/src/gemma.lisp new file mode 100644 index 000000000..a96b722a2 --- /dev/null +++ b/src/gemma.lisp @@ -0,0 +1,125 @@ +(defpackage gemma + (:use :cl + :alexandria + :hunchentoot + :local-time + :cl-json)) +(in-package :gemma) + +;; TODO: Store an average of how many days it was between task +;; completions. Some of the current numbers are just guesses +;; anyways. + +;; +;; Define task management system +;; +(defclass task () + (;; (Unique) name of the task + (name :type symbol + :initarg :name + :accessor name-of) + + ;; Maximum completion interval + (days :type integer + :initarg :days + :accessor days-of) + + ;; Optional description + (description :type string + :initarg :description + :accessor description-of) + + ;; Last completion time + (done-at :type local-time:timestamp + :accessor last-done-at))) + +(defvar *tasks* + (make-hash-table) + "List of all tasks registered in this Gemma instance.") + +(defmacro deftask (task-name days &optional description) + `(setf (gethash (quote ,task-name) *tasks*) + (make-instance (quote task) + :name (quote ,task-name) + :days ,days + :description (or ,description "")))) + +(defun get-task (name) + (gethash name *tasks*)) + +(defun list-tasks () + (alexandria:hash-table-values *tasks*)) + +(defun days-remaining (task) + "Returns the number of days remaining before the supplied TASK reaches its +maximum interval." + (let* ((expires-at (local-time:timestamp+ (last-done-at task) + (days-of task) :day)) + (secs-until-expiry (local-time:timestamp-difference expires-at + (local-time:now)))) + (round (/ secs-until-expiry 60 60 24)))) + +(defun sort-tasks (tasks) + "Sorts TASKS in descending order by number of days remaining." + (sort (copy-list tasks) + (lambda (t1 t2) (> (days-remaining t1) + (days-remaining t2))))) + +(defun complete-task (name &optional at) + "Mark the task with NAME as completed, either now or AT specified time." + (setf (last-done-at (get-task name)) + (or at (local-time:now)))) + +;; +;; Define web API +;; + +(defun start-gemma () + ;; Set up web server + (hunchentoot:start (make-instance 'hunchentoot:easy-acceptor :port 4242)) + + ;; ... and register all handlers. + (hunchentoot:define-easy-handler + (get-tasks :uri "/tasks") () + + (setf (hunchentoot:content-type*) "application/json") + (setf (hunchentoot:header-out "Access-Control-Allow-Origin") "*") + (json:encode-json-to-string + ;; Construct a frontend-friendly representation of the tasks. + (mapcar + (lambda (task) `((:name . ,(name-of task)) + (:description . ,(description-of task)) + (:remaining . ,(days-remaining task)))) + (sort-tasks (list-tasks)))))) + +;; (not-so) example tasks + +;; Bathroom tasks +(deftask bathroom/wipe-mirror 7) +(deftask bathroom/wipe-counter 7) + +;; Bedroom tasks +(deftask bedroom/change-sheets 7) +(deftask bedroom/vacuum 10) + +;; Kitchen tasks +(deftask kitchen/normal-trash 3) +(deftask kitchen/green-trash 5) +(deftask kitchen/blue-trash 5) +(deftask kitchen/wipe-counters 3) +(deftask kitchen/vacuum 5 "Kitchen has more crumbs and such!") + +;; Entire place +(deftask clean-windows 60) + +;; Experimentation / testing stuff + +(defun randomise-completion-times () + "Set some random completion timestamps for all tasks" + (mapcar + (lambda (key) (complete-task key (local-time:timestamp- (local-time:now) + (random 14) + :day))) + (alexandria:hash-table-keys *tasks*))) + +;; (randomise-completion-times) From 26f365271e00a87374f4b6cc3877e3896c1b1425 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Tue, 19 Dec 2017 18:26:26 +0100 Subject: [PATCH 02/28] feat(elm): Add initial logic for Gemma's Elm frontend --- frontend/Main.elm | 101 ++++++++++++++++++++++++++++++++++++++ frontend/elm-package.json | 16 ++++++ 2 files changed, 117 insertions(+) create mode 100644 frontend/Main.elm create mode 100644 frontend/elm-package.json diff --git a/frontend/Main.elm b/frontend/Main.elm new file mode 100644 index 000000000..c977e890a --- /dev/null +++ b/frontend/Main.elm @@ -0,0 +1,101 @@ +module Main exposing (..) + +import Html exposing (Html, text, div, span) +import Json.Decode exposing (..) +import Http + + +-- API interface to Gemma + + +type alias Task = + { name : String + , description : Maybe String + , remaining : Int + } + + +emptyStringFilter s = + if s == "" then + Nothing + else + Just s + + +decodeEmptyString : Decoder (Maybe String) +decodeEmptyString = + map emptyStringFilter string + + +decodeTask : Decoder Task +decodeTask = + map3 Task + (field "name" string) + (field "description" decodeEmptyString) + (field "remaining" int) + + +loadTasks : Cmd Msg +loadTasks = + let + request = + Http.get "http://localhost:4242/tasks" (list decodeTask) + in + Http.send NewTasks request + + + +-- Elm architecture implementation + + +type Msg + = None + | LoadTasks + | NewTasks (Result Http.Error (List Task)) + + +type alias Model = + { tasks : List Task + , error : Maybe String + } + + +renderTask : Task -> Html Msg +renderTask task = + div [] [ span [] [ text task.name ] ] + + +view : Model -> Html Msg +view model = + div [] (List.map renderTask model.tasks) + + +update : Msg -> Model -> ( Model, Cmd Msg ) +update msg model = + case msg of + LoadTasks -> + ( model, loadTasks ) + + NewTasks (Ok tasks) -> + ( { tasks = tasks, error = Nothing }, Cmd.none ) + + NewTasks (Err err) -> + ( { model | error = Just (toString err) }, Cmd.none ) + + _ -> + ( model, Cmd.none ) + + +init : ( Model, Cmd Msg ) +init = + ( { tasks = [], error = Nothing }, loadTasks ) + + +main : Program Never Model Msg +main = + Html.program + { init = init + , view = view + , update = update + , subscriptions = always Sub.none + } diff --git a/frontend/elm-package.json b/frontend/elm-package.json new file mode 100644 index 000000000..e0c71aadf --- /dev/null +++ b/frontend/elm-package.json @@ -0,0 +1,16 @@ +{ + "version": "1.0.0", + "summary": "helpful summary of your project, less than 80 characters", + "repository": "https://github.com/user/project.git", + "license": "BSD3", + "source-directories": [ + "." + ], + "exposed-modules": [], + "dependencies": { + "elm-lang/core": "5.1.1 <= v < 6.0.0", + "elm-lang/html": "2.0.0 <= v < 3.0.0", + "elm-lang/http": "1.0.0 <= v < 2.0.0" + }, + "elm-version": "0.18.0 <= v < 0.19.0" +} From ce036d7d15361ad4ad6630d0528473529d3df46a Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 20 Dec 2017 19:36:05 +0100 Subject: [PATCH 03/28] fix(lisp): Sort tasks in DESCENDING order --- src/gemma.lisp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/gemma.lisp b/src/gemma.lisp index a96b722a2..0aa873db4 100644 --- a/src/gemma.lisp +++ b/src/gemma.lisp @@ -62,7 +62,7 @@ maximum interval." (defun sort-tasks (tasks) "Sorts TASKS in descending order by number of days remaining." (sort (copy-list tasks) - (lambda (t1 t2) (> (days-remaining t1) + (lambda (t1 t2) (< (days-remaining t1) (days-remaining t2))))) (defun complete-task (name &optional at) From cf0395e37ca2fd31bc14e1395185f59064ac854e Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 20 Dec 2017 19:36:31 +0100 Subject: [PATCH 04/28] feat(lisp): Add Hunchentoot handler for task completion --- src/gemma.lisp | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/src/gemma.lisp b/src/gemma.lisp index 0aa873db4..39feb5f60 100644 --- a/src/gemma.lisp +++ b/src/gemma.lisp @@ -74,11 +74,19 @@ maximum interval." ;; Define web API ;; +(defun response-for (task) + "Create a response object to be JSON encoded for TASK." + `((:name . ,(name-of task)) + (:description . ,(description-of task)) + (:remaining . ,(days-remaining task)))) + (defun start-gemma () ;; Set up web server (hunchentoot:start (make-instance 'hunchentoot:easy-acceptor :port 4242)) ;; ... and register all handlers. + + ;; Task listing handler (hunchentoot:define-easy-handler (get-tasks :uri "/tasks") () @@ -86,11 +94,16 @@ maximum interval." (setf (hunchentoot:header-out "Access-Control-Allow-Origin") "*") (json:encode-json-to-string ;; Construct a frontend-friendly representation of the tasks. - (mapcar - (lambda (task) `((:name . ,(name-of task)) - (:description . ,(description-of task)) - (:remaining . ,(days-remaining task)))) - (sort-tasks (list-tasks)))))) + (mapcar #'response-for (sort-tasks (list-tasks))))) + + ;; Task completion handler + (hunchentoot:define-easy-handler + (complete-task-handler :uri "/complete") (task) + (setf (hunchentoot:content-type*) "application/json") + (let* ((key (intern (json:camel-case-to-lisp task) "GEMMA"))) + (format t "Marking task ~A as completed" key) + (complete-task key) + (json:encode-json-to-string (response-for (get-task key)))))) ;; (not-so) example tasks From 6cd75ac184ecdcdaba09f684534ce722002e8819 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 20 Dec 2017 19:40:02 +0100 Subject: [PATCH 05/28] feat(elm): Add initial (broken) MDL layout for tasks The idea is that every task should be shown as an MDL "card" and have some sort of associated action (probably more than just a click, but that I'll look at ...). Tasks are coloured based on their current "urgency". --- frontend/Main.elm | 93 ++++++++++++++++++++++++++++++--------- frontend/elm-package.json | 3 +- 2 files changed, 75 insertions(+), 21 deletions(-) diff --git a/frontend/Main.elm b/frontend/Main.elm index c977e890a..3527540d9 100644 --- a/frontend/Main.elm +++ b/frontend/Main.elm @@ -1,10 +1,21 @@ module Main exposing (..) import Html exposing (Html, text, div, span) +import Html.Attributes exposing (style) import Json.Decode exposing (..) import Http +-- Material design imports + +import Material +import Material.Card as Card +import Material.Color as Color +import Material.Grid exposing (grid, cell, size, Device(..)) +import Material.Layout as Layout +import Material.Scheme as Scheme + + -- API interface to Gemma @@ -52,24 +63,16 @@ type Msg = None | LoadTasks | NewTasks (Result Http.Error (List Task)) + | Mdl (Material.Msg Msg) type alias Model = { tasks : List Task , error : Maybe String + , mdl : Material.Model } -renderTask : Task -> Html Msg -renderTask task = - div [] [ span [] [ text task.name ] ] - - -view : Model -> Html Msg -view model = - div [] (List.map renderTask model.tasks) - - update : Msg -> Model -> ( Model, Cmd Msg ) update msg model = case msg of @@ -77,7 +80,7 @@ update msg model = ( model, loadTasks ) NewTasks (Ok tasks) -> - ( { tasks = tasks, error = Nothing }, Cmd.none ) + ( { model | tasks = tasks, error = Nothing }, Cmd.none ) NewTasks (Err err) -> ( { model | error = Just (toString err) }, Cmd.none ) @@ -86,16 +89,66 @@ update msg model = ( model, Cmd.none ) -init : ( Model, Cmd Msg ) -init = - ( { tasks = [], error = Nothing }, loadTasks ) + +-- View implementation + + +white = + Color.text Color.white + + +taskColor : Task -> Color.Hue +taskColor task = + if task.remaining > 2 then + Color.Green + else if task.remaining < 0 then + Color.Red + else + Color.Yellow + + +renderTask : Task -> Html Msg +renderTask task = + Card.view + [ Color.background (Color.color (taskColor task) Color.S800) ] + [ Card.title [] [ Card.head [ white ] [ text task.name ] ] ] + + + +-- div [] [ span [] [ ] ] + + +gemmaView : Model -> Html Msg +gemmaView model = + grid [] + (List.map (\t -> cell [ size All 3 ] [ renderTask t ]) + model.tasks + ) + + +view : Model -> Html Msg +view model = + gemmaView model |> Scheme.top + + + +-- div [ style [ ( "padding", "2rem" ) ] ] +-- +-- |> Scheme.top main : Program Never Model Msg main = - Html.program - { init = init - , view = view - , update = update - , subscriptions = always Sub.none - } + let + model = + { tasks = [] + , error = Nothing + , mdl = Material.model + } + in + Html.program + { init = ( model, Cmd.batch [ loadTasks, Material.init Mdl ] ) + , view = view + , update = update + , subscriptions = Material.subscriptions Mdl + } diff --git a/frontend/elm-package.json b/frontend/elm-package.json index e0c71aadf..2ae541ae0 100644 --- a/frontend/elm-package.json +++ b/frontend/elm-package.json @@ -10,7 +10,8 @@ "dependencies": { "elm-lang/core": "5.1.1 <= v < 6.0.0", "elm-lang/html": "2.0.0 <= v < 3.0.0", - "elm-lang/http": "1.0.0 <= v < 2.0.0" + "elm-lang/http": "1.0.0 <= v < 2.0.0", + "debois/elm-mdl": "8.1.0 <= v < 9.0.0" }, "elm-version": "0.18.0 <= v < 0.19.0" } From 304f3ae3f15f3c72b01d1069b4c665ae690e3ce5 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 20 Dec 2017 20:03:09 +0100 Subject: [PATCH 06/28] feat(elm): Implement task completion handling Adds a clickable area to the cards that will inform the backend of a task being completed. This of course still looks completely terrible because I don't really know how frontend works. --- frontend/Main.elm | 50 ++++++++++++++++++++++++++++++++++++----------- 1 file changed, 39 insertions(+), 11 deletions(-) diff --git a/frontend/Main.elm b/frontend/Main.elm index 3527540d9..905dc2256 100644 --- a/frontend/Main.elm +++ b/frontend/Main.elm @@ -14,6 +14,7 @@ import Material.Color as Color import Material.Grid exposing (grid, cell, size, Device(..)) import Material.Layout as Layout import Material.Scheme as Scheme +import Material.Options as Options -- API interface to Gemma @@ -55,6 +56,20 @@ loadTasks = Http.send NewTasks request +completeTask : Task -> Cmd Msg +completeTask task = + let + request = + Http.getString + (String.concat + [ "http://localhost:4242/complete?task=" + , task.name + ] + ) + in + Http.send (\_ -> LoadTasks) request + + -- Elm architecture implementation @@ -64,6 +79,7 @@ type Msg | LoadTasks | NewTasks (Result Http.Error (List Task)) | Mdl (Material.Msg Msg) + | Complete Task type alias Model = @@ -79,6 +95,9 @@ update msg model = LoadTasks -> ( model, loadTasks ) + Complete task -> + ( model, completeTask task ) + NewTasks (Ok tasks) -> ( { model | tasks = tasks, error = Nothing }, Cmd.none ) @@ -107,15 +126,30 @@ taskColor task = Color.Yellow +within task = + String.concat + [ "This task should be completed within " + , toString task.remaining + , " days." + ] + + renderTask : Task -> Html Msg renderTask task = Card.view [ Color.background (Color.color (taskColor task) Color.S800) ] - [ Card.title [] [ Card.head [ white ] [ text task.name ] ] ] - - - --- div [] [ span [] [ ] ] + [ Card.title [] [ Card.head [ white ] [ text task.name ] ] + , Card.text [ white ] + [ text (Maybe.withDefault "" task.description) + , text (within task) + ] + , Card.actions + [ Card.border + , white + , Options.onClick (Complete task) + ] + [ text "Done!" ] + ] gemmaView : Model -> Html Msg @@ -131,12 +165,6 @@ view model = gemmaView model |> Scheme.top - --- div [ style [ ( "padding", "2rem" ) ] ] --- --- |> Scheme.top - - main : Program Never Model Msg main = let From ac623e4a7d61b91ac1bb2763f020ab909a547bd1 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 20 Dec 2017 20:14:04 +0100 Subject: [PATCH 07/28] feat(elm): Add nice little texts to display time remaining --- frontend/Main.elm | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/frontend/Main.elm b/frontend/Main.elm index 905dc2256..8c5a8e1a5 100644 --- a/frontend/Main.elm +++ b/frontend/Main.elm @@ -126,12 +126,22 @@ taskColor task = Color.Yellow +within : Task -> String within task = - String.concat - [ "This task should be completed within " - , toString task.remaining - , " days." - ] + if task.remaining < 0 then + "This task is overdue!" + else if task.remaining > 2 then + String.concat + [ "Relax, this task has " + , toString task.remaining + , " days left before it is due." + ] + else + String.concat + [ "This task should be completed within " + , toString task.remaining + , " days. Consider doing it now!" + ] renderTask : Task -> Html Msg @@ -141,6 +151,7 @@ renderTask task = [ Card.title [] [ Card.head [ white ] [ text task.name ] ] , Card.text [ white ] [ text (Maybe.withDefault "" task.description) + , Html.br [] [] , text (within task) ] , Card.actions From 7dbeb83f854de51e7997378fe1df840805fb73ee Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 20 Dec 2017 21:04:15 +0100 Subject: [PATCH 08/28] feat(elm): Add real button to task cards --- frontend/Main.elm | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/frontend/Main.elm b/frontend/Main.elm index 8c5a8e1a5..c7dcc9dd8 100644 --- a/frontend/Main.elm +++ b/frontend/Main.elm @@ -15,6 +15,8 @@ import Material.Grid exposing (grid, cell, size, Device(..)) import Material.Layout as Layout import Material.Scheme as Scheme import Material.Options as Options +import Material.Elevation as Elevation +import Material.Button as Button -- API interface to Gemma @@ -144,10 +146,12 @@ within task = ] -renderTask : Task -> Html Msg -renderTask task = +renderTask : Model -> Task -> Html Msg +renderTask model task = Card.view - [ Color.background (Color.color (taskColor task) Color.S800) ] + [ Color.background (Color.color (taskColor task) Color.S800) + , Elevation.e3 + ] [ Card.title [] [ Card.head [ white ] [ text task.name ] ] , Card.text [ white ] [ text (Maybe.withDefault "" task.description) @@ -155,18 +159,20 @@ renderTask task = , text (within task) ] , Card.actions - [ Card.border - , white - , Options.onClick (Complete task) + [ Card.border ] + [ Button.render Mdl + [ 0 ] + model.mdl + [ white, Button.ripple, Button.accent, Options.onClick (Complete task) ] + [ text "Completed" ] ] - [ text "Done!" ] ] gemmaView : Model -> Html Msg gemmaView model = grid [] - (List.map (\t -> cell [ size All 3 ] [ renderTask t ]) + (List.map (\t -> cell [ size All 4 ] [ renderTask model t ]) model.tasks ) From d3ce3c1568fdc2a0d7699c09098159814e02750c Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 20 Dec 2017 21:17:57 +0100 Subject: [PATCH 09/28] feat(elm): Automatically poll every 15 seconds 15 seconds is potentially a bit aggressive considering that Gemma (currently) tracks expiry times in *days*. --- frontend/Main.elm | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/frontend/Main.elm b/frontend/Main.elm index c7dcc9dd8..2ff61fe28 100644 --- a/frontend/Main.elm +++ b/frontend/Main.elm @@ -4,6 +4,7 @@ import Html exposing (Html, text, div, span) import Html.Attributes exposing (style) import Json.Decode exposing (..) import Http +import Time -- Material design imports @@ -182,6 +183,17 @@ view model = gemmaView model |> Scheme.top + +-- subscriptions : Model -> Sub Msg + + +subscriptions model = + Sub.batch + [ Material.subscriptions Mdl model + , Time.every (15 * Time.second) (\_ -> LoadTasks) + ] + + main : Program Never Model Msg main = let @@ -195,5 +207,5 @@ main = { init = ( model, Cmd.batch [ loadTasks, Material.init Mdl ] ) , view = view , update = update - , subscriptions = Material.subscriptions Mdl + , subscriptions = subscriptions } From b0e64916003750ff7629828bf7c048ab46276d67 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 20 Dec 2017 21:42:32 +0100 Subject: [PATCH 10/28] chore: License under GPLv3 --- LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++ frontend/Main.elm | 10 + gemma.asd | 12 +- src/gemma.lisp | 9 + 4 files changed, 700 insertions(+), 5 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..94a9ed024 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program 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. + + 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/frontend/Main.elm b/frontend/Main.elm index 2ff61fe28..9f90476f6 100644 --- a/frontend/Main.elm +++ b/frontend/Main.elm @@ -1,3 +1,13 @@ +-- Copyright (C) 2016-2017 Vincent Ambo +-- +-- This file is part of Gemma. +-- +-- Gemma 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. + + module Main exposing (..) import Html exposing (Html, text, div, span) diff --git a/gemma.asd b/gemma.asd index 82237a6f2..eb2968313 100644 --- a/gemma.asd +++ b/gemma.asd @@ -1,10 +1,12 @@ #| - This file is a part of gemma project. - Copyright (c) 2017 Vincent Ambo -|# + This file is part of Gemma. -#| - Author: Vincent Ambo + Gemma 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. + + Copyright (c) 2017 Vincent Ambo |# (defsystem "gemma" diff --git a/src/gemma.lisp b/src/gemma.lisp index 39feb5f60..975628f3d 100644 --- a/src/gemma.lisp +++ b/src/gemma.lisp @@ -1,3 +1,12 @@ +;; Copyright (C) 2016-2017 Vincent Ambo +;; +;; This file is part of Gemma. +;; +;; Gemma 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. + (defpackage gemma (:use :cl :alexandria From 6679b893aa82062330e197dcd85ab1452285675d Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 20 Dec 2017 21:43:32 +0100 Subject: [PATCH 11/28] chore: Add code of conduct to project --- CODE_OF_CONDUCT.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 000000000..c4013ac13 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,20 @@ +A SERMON ON ETHICS AND LOVE +=========================== + +One day Mal-2 asked the messenger spirit Saint Gulik to approach the Goddess and request Her presence for some desperate advice. Shortly afterwards the radio came on by itself, and an ethereal female Voice said **YES?** + +"O! Eris! Blessed Mother of Man! Queen of Chaos! Daughter of Discord! Concubine of Confusion! O! Exquisite Lady, I beseech You to lift a heavy burden from my heart!" + +**WHAT BOTHERS YOU, MAL? YOU DON'T SOUND WELL.** + +"I am filled with fear and tormented with terrible visions of pain. Everywhere people are hurting one another, the planet is rampant with injustices, whole societies plunder groups of their own people, mothers imprison sons, children perish while brothers war. O, woe." + +**WHAT IS THE MATTER WITH THAT, IF IT IS WHAT YOU WANT TO DO?** + +"But nobody Wants it! Everybody hates it." + +**OH. WELL, THEN *STOP*.** + +At which moment She turned herself into an aspirin commercial and left The Polyfather stranded alone with his species. + +SINISTER DEXTER HAS A BROKEN SPIROMETER. From 51ddb8fb53c6b1ecb9630d6a4cabd16ede07cb22 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 20 Dec 2017 21:43:48 +0100 Subject: [PATCH 12/28] docs: Add README with project explanation and background --- README.markdown | 91 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 README.markdown diff --git a/README.markdown b/README.markdown new file mode 100644 index 000000000..e4e880905 --- /dev/null +++ b/README.markdown @@ -0,0 +1,91 @@ +# Gemma + +Gemma is a simple application to track *recurring* tasks, named after Gemma +Hartley who [wrote an article][] about task distribution issues in households. + +## Background + +(Skip this if you just want the technical bits) + +Gemma's article launched a discussion in my friend circle about what causes an +uneven distribution of household workload. I theorised that this is not so much +a gender issue, but mostly a discoverability issue. + +Usually one person in a household is aware of what needs to be done, but in many +cases the "overhead" of delegating the tasks would actually take more time than +simply doing the task. + +I theorise further that the person (or people) who do a smaller share of the +household work would often do the work if they had a convenient way to become +aware of what needs to be done. Many times the "household manager" has the +function of tracking non-obvious tasks like when bedsheets were last changed - +shouldn't it be possible to actually distribute this information somehow? + +## The Project + +This project is an initial attempt at sketching out a little application that +aids with reminding users of recurring tasks. Some basic ideas: + +* The system should be blame-free. +* There should be as little usage overhead as possible so that people actually + do use it. +* It should work mostly passively without much user interaction. + +I believe that the basic (*very* simple) idea behind Gemma solves these issues. +Unfortunately my previous relationship fell apart before I actually got to test +this out in a real-life situation involving multiple people, but feedback from +other potential test subjects would be welcome! :) + +## Overview + +Gemma is a Common Lisp application in which a list of recurring tasks is +declared, together with the *maximum interval* at which they should be completed +(in days). Example: + +```lisp +;; Bathroom tasks +(deftask bathroom/wipe-mirror 7) +(deftask bathroom/wipe-counter 7) + +;; Bedroom tasks +(deftask bedroom/change-sheets 7) +(deftask bedroom/vacuum 10) + +;; Kitchen tasks +(deftask kitchen/trash 3) +(deftask kitchen/wipe-counters 3) +(deftask kitchen/vacuum 5 "Kitchen has more crumbs and such!") + +;; Entire place +(deftask clean-windows 60) +``` + +These tasks are marked with their last completion time and tracked by Gemma. A +simple Elm-based frontend application displays the tasks sorted by their +"urgency" and features a button to mark a task as completed: + +![Gemma screenshot](http://i.imgur.com/n7FFMJH.png) + +Marking a task as completed resets its counter and moves it to the bottom of the +task list. + +In theory this *should be it*, the frontend is made available to household +members in some easily accessible place (e.g. an old phone glued to the fridge!) +and people should attempt to develop a habit of checking what needs to be done +occasionally. + +The "household manager" still exists as a role of the household because someone +is entering the tasks into the application, but if my theory about people not +actually being actively *unwilling* to do tasks is correct this could help a +lot. + +## Usage + +(*Note*: Gemma is alpha software so the below is clearly not the final goal) + +Right now using this is non-trivial, but I'll eventually make a better +distribution. Basically you need to know Common Lisp (in which case you'll know +how to get the backend running) and have `elm-reactor` installed to run the +development version of the frontend application. + +[wrote an article]: http://www.harpersbazaar.com/culture/features/a12063822/emotional-labor-gender-equality/ From a8d46a358e9bef845fc6d89d3e7551910f0b3d47 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Thu, 21 Dec 2017 01:21:11 +0100 Subject: [PATCH 13/28] feat(lisp): Implement persistent storage via cl-prevalence Uses the cl-prevalence system to store tasks on disk. The storage location is either relative to the working directory in which the system is started or determined (with priority) by the environment variable `GEMMA_DATA_DIR`. --- gemma.asd | 5 ++++- src/gemma.lisp | 59 +++++++++++++++++++++++++++++++++++--------------- 2 files changed, 45 insertions(+), 19 deletions(-) diff --git a/gemma.asd b/gemma.asd index eb2968313..a2472a4f1 100644 --- a/gemma.asd +++ b/gemma.asd @@ -13,7 +13,10 @@ :version "0.1.0" :author "Vincent Ambo" :license "GPLv3" - :depends-on (alexandria local-time hunchentoot yason) + :depends-on (local-time + hunchentoot + cl-json + cl-prevalence) :components ((:module "src" :components ((:file "gemma")))) diff --git a/src/gemma.lisp b/src/gemma.lisp index 975628f3d..e103ed92c 100644 --- a/src/gemma.lisp +++ b/src/gemma.lisp @@ -9,7 +9,6 @@ (defpackage gemma (:use :cl - :alexandria :hunchentoot :local-time :cl-json)) @@ -23,7 +22,10 @@ ;; Define task management system ;; (defclass task () - (;; (Unique) name of the task + ((id :reader id + :initarg :id) + + ;; (Unique) name of the task (name :type symbol :initarg :name :accessor name-of) @@ -40,24 +42,38 @@ ;; Last completion time (done-at :type local-time:timestamp + :initarg :done-at :accessor last-done-at))) -(defvar *tasks* - (make-hash-table) - "List of all tasks registered in this Gemma instance.") +(defvar *gemma-data-dir* + (pathname (or (sb-posix:getenv "GEMMA_DATA_DIR") + (sb-posix:getcwd))) + "Directory in which to store Gemma data.") + +(defvar *p-tasks* + (cl-prevalence:make-prevalence-system *gemma-data-dir*) + "All tasks registered in this Gemma instance.") + +;; Initialise database ID counter +(or (> (length (cl-prevalence:find-all-objects *p-tasks* 'task)) 0) + (cl-prevalence:tx-create-id-counter *p-tasks*)) (defmacro deftask (task-name days &optional description) - `(setf (gethash (quote ,task-name) *tasks*) - (make-instance (quote task) - :name (quote ,task-name) - :days ,days - :description (or ,description "")))) + (unless (get-task task-name) + `(progn (cl-prevalence:tx-create-object + *p-tasks* + 'task + (quote ((name ,task-name) + (days ,days) + (description ,(or description "")) + (done-at ,(local-time:now))))) + (cl-prevalence:snapshot *p-tasks*)))) (defun get-task (name) - (gethash name *tasks*)) + (cl-prevalence:find-object-with-slot *p-tasks* 'task 'name name)) (defun list-tasks () - (alexandria:hash-table-values *tasks*)) + (cl-prevalence:find-all-objects *p-tasks* 'task)) (defun days-remaining (task) "Returns the number of days remaining before the supplied TASK reaches its @@ -76,8 +92,9 @@ maximum interval." (defun complete-task (name &optional at) "Mark the task with NAME as completed, either now or AT specified time." - (setf (last-done-at (get-task name)) - (or at (local-time:now)))) + (cl-prevalence:tx-change-object-slots *p-tasks* 'task + (id (get-task name)) + `((done-at ,(or at (local-time:now)))))) ;; ;; Define web API @@ -139,9 +156,15 @@ maximum interval." (defun randomise-completion-times () "Set some random completion timestamps for all tasks" (mapcar - (lambda (key) (complete-task key (local-time:timestamp- (local-time:now) - (random 14) - :day))) - (alexandria:hash-table-keys *tasks*))) + (lambda (task) + (complete-task (name-of task) + (local-time:timestamp- (local-time:now) + (random 14) + :day))) + (cl-prevalence:find-all-objects *p-tasks* 'task))) + +(defun clear-all-tasks () + (mapcar (lambda (task) (cl-prevalence:tx-delete-object *p-tasks* 'task (id task))) + (cl-prevalence:find-all-objects *p-tasks* 'task))) ;; (randomise-completion-times) From 8d1c9df43458b0e4c137a17615256b8cb53be5f0 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Thu, 21 Dec 2017 01:27:06 +0100 Subject: [PATCH 14/28] fix(lisp): Automatically snapshot after task completions --- src/gemma.lisp | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/gemma.lisp b/src/gemma.lisp index e103ed92c..e0e52854b 100644 --- a/src/gemma.lisp +++ b/src/gemma.lisp @@ -94,7 +94,8 @@ maximum interval." "Mark the task with NAME as completed, either now or AT specified time." (cl-prevalence:tx-change-object-slots *p-tasks* 'task (id (get-task name)) - `((done-at ,(or at (local-time:now)))))) + `((done-at ,(or at (local-time:now))))) + (cl-prevalence:snapshot *p-tasks*)) ;; ;; Define web API From bf9991026a70a7ffe87193a4ca2cbb98e443dd84 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Thu, 21 Dec 2017 13:54:02 +0100 Subject: [PATCH 15/28] refactor(lisp): Use imported symbols with local qualification ... except hunchentoot, I like using that fully-qualified because it's a great word. --- src/gemma.lisp | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/src/gemma.lisp b/src/gemma.lisp index e0e52854b..279cbb3cc 100644 --- a/src/gemma.lisp +++ b/src/gemma.lisp @@ -9,7 +9,6 @@ (defpackage gemma (:use :cl - :hunchentoot :local-time :cl-json)) (in-package :gemma) @@ -41,7 +40,7 @@ :accessor description-of) ;; Last completion time - (done-at :type local-time:timestamp + (done-at :type timestamp :initarg :done-at :accessor last-done-at))) @@ -66,7 +65,7 @@ (quote ((name ,task-name) (days ,days) (description ,(or description "")) - (done-at ,(local-time:now))))) + (done-at ,(now))))) (cl-prevalence:snapshot *p-tasks*)))) (defun get-task (name) @@ -78,10 +77,9 @@ (defun days-remaining (task) "Returns the number of days remaining before the supplied TASK reaches its maximum interval." - (let* ((expires-at (local-time:timestamp+ (last-done-at task) - (days-of task) :day)) - (secs-until-expiry (local-time:timestamp-difference expires-at - (local-time:now)))) + (let* ((expires-at (timestamp+ (last-done-at task) + (days-of task) :day)) + (secs-until-expiry (timestamp-difference expires-at (now)))) (round (/ secs-until-expiry 60 60 24)))) (defun sort-tasks (tasks) @@ -94,7 +92,7 @@ maximum interval." "Mark the task with NAME as completed, either now or AT specified time." (cl-prevalence:tx-change-object-slots *p-tasks* 'task (id (get-task name)) - `((done-at ,(or at (local-time:now))))) + `((done-at ,(or at (now))))) (cl-prevalence:snapshot *p-tasks*)) ;; @@ -119,7 +117,7 @@ maximum interval." (setf (hunchentoot:content-type*) "application/json") (setf (hunchentoot:header-out "Access-Control-Allow-Origin") "*") - (json:encode-json-to-string + (encode-json-to-string ;; Construct a frontend-friendly representation of the tasks. (mapcar #'response-for (sort-tasks (list-tasks))))) @@ -127,10 +125,10 @@ maximum interval." (hunchentoot:define-easy-handler (complete-task-handler :uri "/complete") (task) (setf (hunchentoot:content-type*) "application/json") - (let* ((key (intern (json:camel-case-to-lisp task) "GEMMA"))) + (let* ((key (intern (camel-case-to-lisp task) "GEMMA"))) (format t "Marking task ~A as completed" key) (complete-task key) - (json:encode-json-to-string (response-for (get-task key)))))) + (encode-json-to-string (response-for (get-task key)))))) ;; (not-so) example tasks @@ -159,9 +157,9 @@ maximum interval." (mapcar (lambda (task) (complete-task (name-of task) - (local-time:timestamp- (local-time:now) - (random 14) - :day))) + (timestamp- (now) + (random 14) + :day))) (cl-prevalence:find-all-objects *p-tasks* 'task))) (defun clear-all-tasks () From 02a34a14a007cd3f03203173de8de1ab5507d6fb Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Thu, 21 Dec 2017 14:00:32 +0100 Subject: [PATCH 16/28] feat(lisp): Make server port configurable --- src/gemma.lisp | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/gemma.lisp b/src/gemma.lisp index 279cbb3cc..008e2841b 100644 --- a/src/gemma.lisp +++ b/src/gemma.lisp @@ -44,6 +44,10 @@ :initarg :done-at :accessor last-done-at))) +(defvar *gemma-port* + (parse-integer (or (sb-posix:getenv "GEMMA_PORT") "4242")) + "Port on which the Gemma web server should listen.") + (defvar *gemma-data-dir* (pathname (or (sb-posix:getenv "GEMMA_DATA_DIR") (sb-posix:getcwd))) @@ -107,7 +111,7 @@ maximum interval." (defun start-gemma () ;; Set up web server - (hunchentoot:start (make-instance 'hunchentoot:easy-acceptor :port 4242)) + (hunchentoot:start (make-instance 'hunchentoot:easy-acceptor :port *gemma-port*)) ;; ... and register all handlers. From db0e74fbd05d10675ae2dd64da9a285789595613 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Sun, 24 Dec 2017 18:05:49 +0100 Subject: [PATCH 17/28] fix(lisp): Don't intern symbols for unregistered tasks --- src/gemma.lisp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/gemma.lisp b/src/gemma.lisp index 008e2841b..ad096ec57 100644 --- a/src/gemma.lisp +++ b/src/gemma.lisp @@ -129,7 +129,7 @@ maximum interval." (hunchentoot:define-easy-handler (complete-task-handler :uri "/complete") (task) (setf (hunchentoot:content-type*) "application/json") - (let* ((key (intern (camel-case-to-lisp task) "GEMMA"))) + (let* ((key (find-symbol (camel-case-to-lisp task) "GEMMA"))) (format t "Marking task ~A as completed" key) (complete-task key) (encode-json-to-string (response-for (get-task key)))))) From 4536e65471eb9d844eb811cfe643ea687a62dbae Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Tue, 26 Dec 2017 11:05:16 +0100 Subject: [PATCH 18/28] feat(lisp): Implement configuration loading Adds configuration loading from a file located at either "/etc/gemma/config.lisp" or a path determined via the `GEMMA_CONFIG` environment variable. The configuration file can contain any number of deftask forms and a single config form which determines the location at which Gemma stores its data and also the port on which it should listen. --- src/gemma.lisp | 51 ++++++++++++++++++++++++++++++++------------------ 1 file changed, 33 insertions(+), 18 deletions(-) diff --git a/src/gemma.lisp b/src/gemma.lisp index ad096ec57..2ead8f9ab 100644 --- a/src/gemma.lisp +++ b/src/gemma.lisp @@ -10,16 +10,44 @@ (defpackage gemma (:use :cl :local-time - :cl-json)) + :cl-json) + (:import-from :sb-posix :getenv) + (:shadowing-import-from :sb-posix :getcwd)) (in-package :gemma) ;; TODO: Store an average of how many days it was between task ;; completions. Some of the current numbers are just guesses ;; anyways. +(defmacro in-case-of (x &body body) + "Evaluate BODY if X is non-nil, binding the value of X to IT." + `(let ((it ,x)) + (when it ,@body))) + +;; Set default configuration parameters +(defvar *gemma-port* 4242 + "Port on which the Gemma web server listens.") + +(defun initialise-persistence (data-dir) + (defvar *p-tasks* + (cl-prevalence:make-prevalence-system data-dir) + "All tasks registered in this Gemma instance.") + + ;; Initialise database ID counter + (or (> (length (cl-prevalence:find-all-objects *p-tasks* 'task)) 0) + (cl-prevalence:tx-create-id-counter *p-tasks*))) + +(defun config (&key port data-dir) + "Configuration function for use in the Gemma configuration file." + + (in-package :gemma) + (in-case-of port (defparameter *gemma-port* it)) + (initialise-persistence (or data-dir "data/"))) + ;; ;; Define task management system ;; + (defclass task () ((id :reader id :initarg :id) @@ -44,23 +72,6 @@ :initarg :done-at :accessor last-done-at))) -(defvar *gemma-port* - (parse-integer (or (sb-posix:getenv "GEMMA_PORT") "4242")) - "Port on which the Gemma web server should listen.") - -(defvar *gemma-data-dir* - (pathname (or (sb-posix:getenv "GEMMA_DATA_DIR") - (sb-posix:getcwd))) - "Directory in which to store Gemma data.") - -(defvar *p-tasks* - (cl-prevalence:make-prevalence-system *gemma-data-dir*) - "All tasks registered in this Gemma instance.") - -;; Initialise database ID counter -(or (> (length (cl-prevalence:find-all-objects *p-tasks* 'task)) 0) - (cl-prevalence:tx-create-id-counter *p-tasks*)) - (defmacro deftask (task-name days &optional description) (unless (get-task task-name) `(progn (cl-prevalence:tx-create-object @@ -110,6 +121,10 @@ maximum interval." (:remaining . ,(days-remaining task)))) (defun start-gemma () + ;; Load configuration + (load (pathname (or (getenv "GEMMA_CONFIG") + "/etc/gemma/config.lisp"))) + ;; Set up web server (hunchentoot:start (make-instance 'hunchentoot:easy-acceptor :port *gemma-port*)) From e50e2acde039f8a16373c653aaa1e76b37bd02a2 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Tue, 26 Dec 2017 11:13:52 +0100 Subject: [PATCH 19/28] docs: Add example configuration file --- config.lisp | 21 +++++++++++++++++++++ src/gemma.lisp | 21 +-------------------- 2 files changed, 22 insertions(+), 20 deletions(-) create mode 100644 config.lisp diff --git a/config.lisp b/config.lisp new file mode 100644 index 000000000..54f8e5f34 --- /dev/null +++ b/config.lisp @@ -0,0 +1,21 @@ +;; Example configuration file for Gemma + +(config :port 4242 + :data-dir "/tmp/gemma/") + +(deftask bathroom/wipe-mirror 7) +(deftask bathroom/wipe-counter 7) + +;; Bedroom tasks +(deftask bedroom/change-sheets 7) +(deftask bedroom/vacuum 10) + +;; Kitchen tasks +(deftask kitchen/normal-trash 3) +(deftask kitchen/green-trash 5) +(deftask kitchen/blue-trash 5) +(deftask kitchen/wipe-counters 3) +(deftask kitchen/vacuum 5 "Kitchen has more crumbs and such!") + +;; Entire place +(deftask clean-windows 60) diff --git a/src/gemma.lisp b/src/gemma.lisp index 2ead8f9ab..a925e65a7 100644 --- a/src/gemma.lisp +++ b/src/gemma.lisp @@ -149,26 +149,6 @@ maximum interval." (complete-task key) (encode-json-to-string (response-for (get-task key)))))) -;; (not-so) example tasks - -;; Bathroom tasks -(deftask bathroom/wipe-mirror 7) -(deftask bathroom/wipe-counter 7) - -;; Bedroom tasks -(deftask bedroom/change-sheets 7) -(deftask bedroom/vacuum 10) - -;; Kitchen tasks -(deftask kitchen/normal-trash 3) -(deftask kitchen/green-trash 5) -(deftask kitchen/blue-trash 5) -(deftask kitchen/wipe-counters 3) -(deftask kitchen/vacuum 5 "Kitchen has more crumbs and such!") - -;; Entire place -(deftask clean-windows 60) - ;; Experimentation / testing stuff (defun randomise-completion-times () @@ -186,3 +166,4 @@ maximum interval." (cl-prevalence:find-all-objects *p-tasks* 'task))) ;; (randomise-completion-times) + From abe8419b034600b8cea37a17407ed933766cfbf5 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Tue, 26 Dec 2017 11:15:27 +0100 Subject: [PATCH 20/28] docs(README): Update docs with a note about configuration --- README.markdown | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.markdown b/README.markdown index e4e880905..064742c00 100644 --- a/README.markdown +++ b/README.markdown @@ -32,9 +32,9 @@ aids with reminding users of recurring tasks. Some basic ideas: * It should work mostly passively without much user interaction. I believe that the basic (*very* simple) idea behind Gemma solves these issues. -Unfortunately my previous relationship fell apart before I actually got to test -this out in a real-life situation involving multiple people, but feedback from -other potential test subjects would be welcome! :) +Unfortunately my living situation changed before I actually got to test this out +in a real-life situation involving multiple people, but feedback from other +potential test subjects would be welcome! :) ## Overview @@ -88,4 +88,9 @@ distribution. Basically you need to know Common Lisp (in which case you'll know how to get the backend running) and have `elm-reactor` installed to run the development version of the frontend application. +Gemma is configured via a configuration file that should be located either at +`/etc/gemma/config.lisp` or at a custom location specified via the environment +variable `GEMMA_CONFIG`. Have a look at the `config.lisp` file in the repository +root for an example. + [wrote an article]: http://www.harpersbazaar.com/culture/features/a12063822/emotional-labor-gender-equality/ From 5579ca7d6c620c5dd874ed0654d9a03a73fbf6d6 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Tue, 26 Dec 2017 13:48:43 +0100 Subject: [PATCH 21/28] feat(build): Configure ASDF program-op with entrypoint --- gemma.asd | 2 ++ src/gemma.lisp | 18 ++++++++++++++++-- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/gemma.asd b/gemma.asd index a2472a4f1..1da8aa0b2 100644 --- a/gemma.asd +++ b/gemma.asd @@ -20,6 +20,8 @@ :components ((:module "src" :components ((:file "gemma")))) + :build-operation program-op + :entry-point "gemma::entrypoint" :description "Gemma is a household task management system" :long-description #.(read-file-string diff --git a/src/gemma.lisp b/src/gemma.lisp index a925e65a7..526eb0453 100644 --- a/src/gemma.lisp +++ b/src/gemma.lisp @@ -12,7 +12,8 @@ :local-time :cl-json) (:import-from :sb-posix :getenv) - (:shadowing-import-from :sb-posix :getcwd)) + (:shadowing-import-from :sb-posix :getcwd) + (:export :start-gemma :config :entrypoint)) (in-package :gemma) ;; TODO: Store an average of how many days it was between task @@ -121,6 +122,8 @@ maximum interval." (:remaining . ,(days-remaining task)))) (defun start-gemma () + (in-package :gemma) + ;; Load configuration (load (pathname (or (getenv "GEMMA_CONFIG") "/etc/gemma/config.lisp"))) @@ -149,6 +152,18 @@ maximum interval." (complete-task key) (encode-json-to-string (response-for (get-task key)))))) +(defun entrypoint () + "This function serves as the entrypoint for ASDF-built executables. + It joins the Hunchentoot server thread to keep the process running + for as long as the server is alive." + + (start-gemma) + (sb-thread:join-thread + (find-if (lambda (th) + (string= (sb-thread:thread-name th) + (format nil "hunchentoot-listener-*:~A" *gemma-port*))) + (sb-thread:list-all-threads)))) + ;; Experimentation / testing stuff (defun randomise-completion-times () @@ -166,4 +181,3 @@ maximum interval." (cl-prevalence:find-all-objects *p-tasks* 'task))) ;; (randomise-completion-times) - From 8703b6102c348d5e860af83a980ba5e1585e3964 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Fri, 29 Dec 2017 16:42:10 +0100 Subject: [PATCH 22/28] feat(build): Add initial Nix-based build process Adds a build script using ASDF's program-op to build an executable out of the Gemma source code. In addition a Nix derivation is provided that will both compile the Elm source and place it in a folder, as well as create the executable. Currently static file serving does not function as intended. --- build.lisp | 37 +++++++++++++++++++++++++++++++++++++ default.nix | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ gemma.asd | 1 + 3 files changed, 91 insertions(+) create mode 100644 build.lisp create mode 100644 default.nix diff --git a/build.lisp b/build.lisp new file mode 100644 index 000000000..3c8ce3372 --- /dev/null +++ b/build.lisp @@ -0,0 +1,37 @@ +;; Build script for use within Nix. + +(require :asdf) +(require :sb-posix) +(require :cffi) + +(push (format nil "~A/" (sb-posix:getcwd)) asdf:*central-registry*) + +;; Quicklisp is configured in the Nix build script +(let ((quicklisp-init (merge-pathnames "quicklisp/setup.lisp" + (user-homedir-pathname)))) + (when (probe-file quicklisp-init) + (load quicklisp-init))) + +;; OpenSSL linking requires pkg_config on NixOS. +(ql:quickload "inferior-shell") + +(defun pkg-config-lib-path (lib) + "Look up the location of a library using pkg-config." + (let ((flag (inferior-shell:run `("pkg-config" "--libs-only-L" ,lib) + :output '(:string :stripped t)))) + (concatenate 'string (subseq flag 2) "/"))) + +(pushnew (pathname (pkg-config-lib-path "openssl")) + cffi:*foreign-library-directories* + :test #'equal) + +;; cl-prevalence is not in the current Quicklisp -> Nix snapshot +(ql:quickload "cl-prevalence") + +;; the $out path should be set in the application to let Hunchentoot serve the +;; correct static files. + +(if (sb-posix:getenv "out") + (defvar *gemma-nix-out-dir* (sb-posix:getenv "out"))) + +(asdf:operate 'asdf:program-op :gemma) diff --git a/default.nix b/default.nix new file mode 100644 index 000000000..f4a10b542 --- /dev/null +++ b/default.nix @@ -0,0 +1,53 @@ +with import {}; + +stdenv.mkDerivation rec { + name = "gemma"; + + src = ./.; + + buildInputs = with lispPackages; [ + sbcl + quicklisp + hunchentoot + cl-json + local-time + elmPackages.elm + pkgconfig + ]; + + # The build phase has three distinct things it needs to do: + # + # 1. "Compile" the Elm source into something useful to browsers. + # + # 2. Configure the Lisp part of the application to serve the compiled Elm + # + # 3. Build (and don't strip!) an executable out of the Lisp backend. + buildPhase = '' + mkdir -p $out/share/gemma $out/bin $src/build + mkdir .home && export HOME="$PWD/.home" + + # Build Elm + cd frontend + elm-make --yes Main.elm --output $out/share/gemma/index.html + + # Build Lisp + cd $src + quicklisp init + sbcl --load build.lisp + + # ASDF writes this output into an extremely annoying path, but I also can't + # be bothered to figure out the output-translation definition for it. + mv $HOME/.cache/common-lisp/sbcl-*/$PWD/build/gemma $out/bin/gemma + ''; + + installPhase = "true"; + + # Stripping an SBCL executable removes the application, which is unfortunate. + dontStrip = true; + + meta = with stdenv.lib; { + description = "Tool for tracking recurring tasks"; + homepage = "https://github.com/tazjin/gemma"; + license = licenses.gpl3; + }; +} diff --git a/gemma.asd b/gemma.asd index 1da8aa0b2..54e794a1e 100644 --- a/gemma.asd +++ b/gemma.asd @@ -21,6 +21,7 @@ :components ((:file "gemma")))) :build-operation program-op + :output-files (program-op (c o) '("build/gemma")) :entry-point "gemma::entrypoint" :description "Gemma is a household task management system" :long-description From bd3b2782b938a29d6952d7a06c040e59571d825e Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Sun, 31 Dec 2017 15:03:17 +0100 Subject: [PATCH 23/28] feat(lisp): Correctly set location for static assets in Nix builds In order to let Hunchentoot serve the static assets from the correct location, the *static-file-location* parameter is set before image dumping based on the $out-envvar which is present during the build process. This can easily be set manually in the config file if required by a user. --- build.lisp | 6 ------ src/gemma.lisp | 15 ++++++++++++--- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/build.lisp b/build.lisp index 3c8ce3372..ce67a91f6 100644 --- a/build.lisp +++ b/build.lisp @@ -28,10 +28,4 @@ ;; cl-prevalence is not in the current Quicklisp -> Nix snapshot (ql:quickload "cl-prevalence") -;; the $out path should be set in the application to let Hunchentoot serve the -;; correct static files. - -(if (sb-posix:getenv "out") - (defvar *gemma-nix-out-dir* (sb-posix:getenv "out"))) - (asdf:operate 'asdf:program-op :gemma) diff --git a/src/gemma.lisp b/src/gemma.lisp index 526eb0453..b8a20addd 100644 --- a/src/gemma.lisp +++ b/src/gemma.lisp @@ -29,6 +29,14 @@ (defvar *gemma-port* 4242 "Port on which the Gemma web server listens.") +(defvar *static-file-location* + (or (in-case-of (sb-posix:getenv "out") + (concatenate 'string it "/share/gemma/")) + "frontend/") + "Folder from which to serve static assets. If built inside of Nix, + the folder is concatenated with the output path at which the files + are expected to be.") + (defun initialise-persistence (data-dir) (defvar *p-tasks* (cl-prevalence:make-prevalence-system data-dir) @@ -129,9 +137,10 @@ maximum interval." "/etc/gemma/config.lisp"))) ;; Set up web server - (hunchentoot:start (make-instance 'hunchentoot:easy-acceptor :port *gemma-port*)) - - ;; ... and register all handlers. + (hunchentoot:start + (make-instance 'hunchentoot:easy-acceptor + :port *gemma-port* + :document-root *static-file-location*)) ;; Task listing handler (hunchentoot:define-easy-handler From 48687f77d2e838907f73e503bef709ff1fd0f51a Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Sun, 31 Dec 2017 17:02:13 +0100 Subject: [PATCH 24/28] fix(elm): Use relative URL to access API Now that Hunchentoot is serving the Elm frontend, Elm needs to connect to Gemma at a relative path. Side note: It would be useful if the frontend displayed errors that happened :sun: --- frontend/Main.elm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/frontend/Main.elm b/frontend/Main.elm index 9f90476f6..e449908e4 100644 --- a/frontend/Main.elm +++ b/frontend/Main.elm @@ -64,7 +64,7 @@ loadTasks : Cmd Msg loadTasks = let request = - Http.get "http://localhost:4242/tasks" (list decodeTask) + Http.get "/tasks" (list decodeTask) in Http.send NewTasks request @@ -75,7 +75,7 @@ completeTask task = request = Http.getString (String.concat - [ "http://localhost:4242/complete?task=" + [ "/complete?task=" , task.name ] ) From cc6de0f9c6792413a58031b74190ad358a2b6efd Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Sun, 31 Dec 2017 17:02:56 +0100 Subject: [PATCH 25/28] feat(nix): Add Docker building configuration --- gemma-docker.nix | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 gemma-docker.nix diff --git a/gemma-docker.nix b/gemma-docker.nix new file mode 100644 index 000000000..69cfdd4c1 --- /dev/null +++ b/gemma-docker.nix @@ -0,0 +1,19 @@ +with import {}; +let + gemma = import ./default.nix; + entrypoint = writeScript "entrypoint.sh" '' + #!${stdenv.shell} + set -e + exec ${gemma}/bin/gemma + ''; +in dockerTools.buildImage { + name = "gemma"; + contents = gemma; # [ gemma ]; + config = { + Entrypoint = [ entrypoint ]; + WorkingDir = "/data"; + Volumes = { + "/data" = {}; + }; + }; +} From 0d7f845bf5e54f2af6bda4cdf9476bcd66ff08d4 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 3 Jan 2018 16:54:45 +0100 Subject: [PATCH 26/28] refactor(build): Use ASDF facility for output naming Turns out there is an easy-to-use :build-pathname parameter to set the output binary name. This kills the hack! --- default.nix | 7 +++---- gemma.asd | 2 +- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/default.nix b/default.nix index f4a10b542..43950571c 100644 --- a/default.nix +++ b/default.nix @@ -23,7 +23,7 @@ stdenv.mkDerivation rec { # # 3. Build (and don't strip!) an executable out of the Lisp backend. buildPhase = '' - mkdir -p $out/share/gemma $out/bin $src/build + mkdir -p $out/share/gemma $out/bin mkdir .home && export HOME="$PWD/.home" # Build Elm @@ -35,9 +35,8 @@ stdenv.mkDerivation rec { quicklisp init sbcl --load build.lisp - # ASDF writes this output into an extremely annoying path, but I also can't - # be bothered to figure out the output-translation definition for it. - mv $HOME/.cache/common-lisp/sbcl-*/$PWD/build/gemma $out/bin/gemma + # "Install" result + cp $src/gemma $out/bin/gemma ''; installPhase = "true"; diff --git a/gemma.asd b/gemma.asd index 54e794a1e..e9a1d298e 100644 --- a/gemma.asd +++ b/gemma.asd @@ -21,7 +21,7 @@ :components ((:file "gemma")))) :build-operation program-op - :output-files (program-op (c o) '("build/gemma")) + :build-pathname "gemma" :entry-point "gemma::entrypoint" :description "Gemma is a household task management system" :long-description From 61be253d6baa99f0a2208425b8a03b444bb1b184 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Wed, 3 Jan 2018 17:10:07 +0100 Subject: [PATCH 27/28] feat(build): Configurable output location For easier Nix builds! --- default.nix | 5 +---- gemma.asd | 5 ++++- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/default.nix b/default.nix index 43950571c..02f8c225f 100644 --- a/default.nix +++ b/default.nix @@ -33,10 +33,7 @@ stdenv.mkDerivation rec { # Build Lisp cd $src quicklisp init - sbcl --load build.lisp - - # "Install" result - cp $src/gemma $out/bin/gemma + env GEMMA_BIN_TARGET=$out/bin/gemma sbcl --load build.lisp ''; installPhase = "true"; diff --git a/gemma.asd b/gemma.asd index e9a1d298e..0aea9c95f 100644 --- a/gemma.asd +++ b/gemma.asd @@ -9,6 +9,8 @@ Copyright (c) 2017 Vincent Ambo |# +(require 'sb-posix) + (defsystem "gemma" :version "0.1.0" :author "Vincent Ambo" @@ -21,7 +23,8 @@ :components ((:file "gemma")))) :build-operation program-op - :build-pathname "gemma" + :build-pathname #.(or (pathname (sb-posix:getenv "GEMMA_BIN_TARGET")) + "gemma") :entry-point "gemma::entrypoint" :description "Gemma is a household task management system" :long-description From 60532a541b4a1e2c19bb9de95f1ffd72d1579067 Mon Sep 17 00:00:00 2001 From: Vincent Ambo Date: Sat, 29 Jun 2019 14:13:58 +0100 Subject: [PATCH 28/28] refactor(gemma): Move Gemma source into monorepo stucture --- CODE_OF_CONDUCT.md => services/gemma/CODE_OF_CONDUCT.md | 0 LICENSE => services/gemma/LICENSE | 0 README.markdown => services/gemma/README.markdown | 0 build.lisp => services/gemma/build.lisp | 0 config.lisp => services/gemma/config.lisp | 0 default.nix => services/gemma/default.nix | 0 {frontend => services/gemma/frontend}/Main.elm | 0 {frontend => services/gemma/frontend}/elm-package.json | 0 gemma-docker.nix => services/gemma/gemma-docker.nix | 0 gemma.asd => services/gemma/gemma.asd | 0 {src => services/gemma/src}/gemma.lisp | 0 11 files changed, 0 insertions(+), 0 deletions(-) rename CODE_OF_CONDUCT.md => services/gemma/CODE_OF_CONDUCT.md (100%) rename LICENSE => services/gemma/LICENSE (100%) rename README.markdown => services/gemma/README.markdown (100%) rename build.lisp => services/gemma/build.lisp (100%) rename config.lisp => services/gemma/config.lisp (100%) rename default.nix => services/gemma/default.nix (100%) rename {frontend => services/gemma/frontend}/Main.elm (100%) rename {frontend => services/gemma/frontend}/elm-package.json (100%) rename gemma-docker.nix => services/gemma/gemma-docker.nix (100%) rename gemma.asd => services/gemma/gemma.asd (100%) rename {src => services/gemma/src}/gemma.lisp (100%) diff --git a/CODE_OF_CONDUCT.md b/services/gemma/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.md rename to services/gemma/CODE_OF_CONDUCT.md diff --git a/LICENSE b/services/gemma/LICENSE similarity index 100% rename from LICENSE rename to services/gemma/LICENSE diff --git a/README.markdown b/services/gemma/README.markdown similarity index 100% rename from README.markdown rename to services/gemma/README.markdown diff --git a/build.lisp b/services/gemma/build.lisp similarity index 100% rename from build.lisp rename to services/gemma/build.lisp diff --git a/config.lisp b/services/gemma/config.lisp similarity index 100% rename from config.lisp rename to services/gemma/config.lisp diff --git a/default.nix b/services/gemma/default.nix similarity index 100% rename from default.nix rename to services/gemma/default.nix diff --git a/frontend/Main.elm b/services/gemma/frontend/Main.elm similarity index 100% rename from frontend/Main.elm rename to services/gemma/frontend/Main.elm diff --git a/frontend/elm-package.json b/services/gemma/frontend/elm-package.json similarity index 100% rename from frontend/elm-package.json rename to services/gemma/frontend/elm-package.json diff --git a/gemma-docker.nix b/services/gemma/gemma-docker.nix similarity index 100% rename from gemma-docker.nix rename to services/gemma/gemma-docker.nix diff --git a/gemma.asd b/services/gemma/gemma.asd similarity index 100% rename from gemma.asd rename to services/gemma/gemma.asd diff --git a/src/gemma.lisp b/services/gemma/src/gemma.lisp similarity index 100% rename from src/gemma.lisp rename to services/gemma/src/gemma.lisp