diff --git a/doc/specification/database.md b/doc/specification/database.md new file mode 100644 index 0000000..6239008 --- /dev/null +++ b/doc/specification/database.md @@ -0,0 +1,235 @@ +# Database Specification + +Note that this is a work in progress. Read it in concert with the Entity-Relationship Diagram. + +Tables are listed in alphabetical order. + +## Address + +The postal address of a building which contains at least one dwelling at which electors are registered. + + CREATE TABLE IF NOT EXISTS addresses ( + id integer NOT NULL, + address character varying(256) NOT NULL, + postcode character varying(16), + phone character varying(16), + district_id integer, + latitude real, + longitude real + ); + + +## Authority + +An *oauth* authority which authenticates canvassers. *Note that* there will need to be substantially more in this table but I don't yet know what. + + CREATE TABLE IF NOT EXISTS authorities ( + id character varying(32) NOT NULL + ); + + +## Canvasser + +A user of the system. + + CREATE TABLE IF NOT EXISTS canvassers ( + id serial, + username character varying(32) NOT NULL, + fullname character varying(64) NOT NULL, + elector_id integer, + address_id integer NOT NULL, + phone character varying(16), + email character varying(128), + authority_id character varying(32) NOT NULL, + authorised boolean + ); + + +## District + +An electoral district. + + CREATE TABLE IF NOT EXISTS districts ( + id integer NOT NULL, + name character varying(64) NOT NULL + ); + + +## Dwelling + +A dwelling at which electors are registered. Most addresses obviously have only one dwelling, but in flatted buildings there will be multiple dwellings. The **sub\_address** field contains +information to distinguish the dwelling, e.g. 'flat 2.1'. + + CREATE TABLE IF NOT EXISTS dwellings ( + id serial NOT NULL primary key, + address_id integer NOT NULL references addresses(id), + sub_address varchar(16) + ); + + +## Elector + +Someone entitled to cast a vote in the referendum. + + CREATE TABLE IF NOT EXISTS electors ( + id integer NOT NULL, + name character varying(64) NOT NULL, + dwelling_id integer NOT NULL, + phone character varying(16), + email character varying(128) + ); + + +## Followup Action + +An action performed by an issue expert in response to a followup request. + + CREATE TABLE IF NOT EXISTS followupactions ( + id integer NOT NULL, + request_id integer NOT NULL, + actor integer NOT NULL, + date timestamp with time zone DEFAULT now() NOT NULL, + notes text, + closed boolean + ); + + +## Followup Method + +A method for responding to a followup request; reference data. + + CREATE TABLE IF NOT EXISTS followupmethods ( + id character varying(32) NOT NULL + ); + + insert into followupmethods values ('Telephone'); + insert into followupmethods values ('eMail'); + insert into followupmethods values ('Post'); + + +## Followup Request + +A request recorded by a canvasser for an issue expert to contact an elector with regard to a particular issue. + + CREATE TABLE IF NOT EXISTS followuprequests ( + id integer NOT NULL, + elector_id integer NOT NULL, + visit_id integer NOT NULL, + issue_id character varying(32) NOT NULL, + method_id character varying(32) NOT NULL + ); + + +## Intention + +An intention, by an elector, to vote for an option; captured by a canvasser during a visit. + + CREATE TABLE IF NOT EXISTS intentions ( + id serial not null, + elector integer not null references elector(id), + option varchar(32) not null references option(id), + visit integer not null references visit(id), + date timestamp with time zone DEFAULT now() NOT NULL + ); + + +## Issue + +An issue which might affect electors' decisions regarding their intention. + + CREATE TABLE IF NOT EXISTS issues ( + id character varying(32) NOT NULL, + url character varying(256), + content varchar(1024), + current default false + ); + + +## Issue expertise + +Expertise of a canvasser able to use a method, in an issue. + + CREATE TABLE IF NOT EXISTS issueexpertise ( + canvasser_id integer NOT NULL, + issue_id character varying(32) NOT NULL, + method_id character varying(32) NOT NULL + ); + + +## Option + +An option for which an elector may have an intention to vote. + + CREATE TABLE IF NOT EXISTS options ( + id character varying(32) NOT NULL + ); + + +## Role + +A role (other than basic *Canvasser*) that a user may have in the system. Reference data. + + create table if not exists roles ( + id serial primary key, + name varchar(64) not null + ); + + +## Role Member + +Membership of a user (*Canvasser*) of an additional role; link table. + + create table if not exists rolememberships ( + role_id integer not null references roles(id), + canvasser_id integer not null references canvassers(id) + ); + + +## Team + +A team of canvassers in a locality who are known to one another and frequently +canvas together. + + create table if not exists teams ( + id serial primary key, + name varchar(64) not null, + district_id integer not null references districts(id), + latitude real, + longitude real + ); + + +## Team Member + +Membership of a user (*Canvasser*) of a particular team. Canvassers may join multiple teams. Link table. + + create table if not exists teammemberships ( + team_id integer not null references teams(id), + canvasser_id integer not null references canvassers(id) + ); + + +## Team Organiser + +A relationship which defines a user (*Canvasser*) as an organiser of a team. A team may +have more than one organiser. An organiser (if they also have the role 'Recruiter', which +they often will have) may recruit additional Canvassers as members of their team, or +accept applications by canvassers to join their team. An organiser may promote a member of +the team to organiser of the team, and may also exclude a member from the team. + + create table if not exists teamorganiserships ( + team_id integer not null references teams(id), + canvasser_id integer not null references canvassers(id) + ); + + +## Visit + +A visit by a canvasser to an address on a date to solicit intentions from electors. + + CREATE TABLE IF NOT EXISTS visits ( + id integer NOT NULL, + address_id integer NOT NULL, + canvasser_id integer NOT NULL, + date timestamp with time zone DEFAULT now() NOT NULL + ); diff --git a/doc/specification/entity-relationship-diagram.svg b/doc/specification/entity-relationship-diagram.svg index 0de6cf0..e68f1bf 100644 --- a/doc/specification/entity-relationship-diagram.svg +++ b/doc/specification/entity-relationship-diagram.svg @@ -25,16 +25,16 @@ borderopacity="1.0" inkscape:pageopacity="0.0" inkscape:pageshadow="2" - inkscape:zoom="1.979899" - inkscape:cx="833.70674" - inkscape:cy="324.89697" + inkscape:zoom="0.98994949" + inkscape:cx="455.50968" + inkscape:cy="346.1212" inkscape:document-units="px" inkscape:current-layer="layer1" showgrid="true" inkscape:window-width="1920" - inkscape:window-height="1058" - inkscape:window-x="1920" - inkscape:window-y="0" + inkscape:window-height="1031" + inkscape:window-x="0" + inkscape:window-y="27" inkscape:window-maximized="1"> + x="8.484766" + y="312.36221" + sodipodi:insensitive="true" /> + y="354.3468" /> YouYesYet: Entity Relationship Diagram + + + District + - District - Addresss + sodipodi:role="line">Dwelling + y="672.276" /> Elector Canvasser + y="553.07794" /> Authority + y="553.07794" /> Visit Intention @@ -236,26 +241,26 @@ width="100" height="60" x="732.33264" - y="775.31158" /> + y="794.50446" /> IssueExpertise Issue FollowupRequest @@ -303,27 +308,27 @@ width="100" height="60" x="220.18532" - y="896.52985" /> + y="915.72272" /> FollowupAction + transform="translate(170.18532,48.487322)"> + transform="translate(682.33266,290.92393)"> + id="g4369" + transform="translate(0,19.192898)"> @@ -402,7 +408,7 @@ + transform="translate(170.18532,48.487322)"> + id="g4402" + transform="translate(-168.69547,-222.23356)"> @@ -442,7 +449,7 @@ + transform="translate(169.17517,171.72593)"> + transform="translate(-170.71578,139.40105)"> @@ -604,146 +611,146 @@ xml:space="preserve" style="font-style:italic;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:20px;line-height:125%;font-family:'URW Chancery L';-inkscape-font-specification:'URW Chancery L Bold Italic';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" x="472.0152" - y="394.48404" + y="413.67694" id="text4361" sodipodi:linespacing="125%">Version: 0.2Version: 0.4Date: 20170315Date: 20170401Author: Simon BrookeCopyright: (c) 2016 Simon Brooke for Radical Independence Campaign Introduced Visited Recorded + y="651.55505" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start">Recorded Raised + x="49.187798" + y="391.35205" + style="font-style:italic;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:10px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Bold Italic';text-align:start;writing-mode:lr-tb;text-anchor:start">Raised Authenticates + y="641.55505" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start">Authenticates Has + y="761.55505" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start">Has About + y="881.55505" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start">About About @@ -751,89 +758,94 @@ xml:space="preserve" style="font-style:italic;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:20px;line-height:125%;font-family:'URW Chancery L';-inkscape-font-specification:'URW Chancery L Bold Italic';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" x="280" - y="872.36218" + y="891.55505" id="text4417" sodipodi:linespacing="125%">Responded to + y="891.55505" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start">Responded to Expressed + x="161.30452" + y="480.12863" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start">Contains Contains + y="531.55505" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start">Contains Resides at + y="651.55505" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start">Resides at Requested + y="761.55505" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start">Requested Performed + y="1021.5551" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start">Performed To + y="571.55505" + style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start">To + y="672.276" /> Team + y="792.48413" /> + y="581.55505" /> Organiser-ship TeamTeamMembership Has @@ -978,41 +990,41 @@ xml:space="preserve" style="font-style:italic;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:20px;line-height:125%;font-family:'URW Chancery L';-inkscape-font-specification:'URW Chancery L Bold Italic';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" x="879.90356" - y="621.14386" + y="640.33673" id="text4344" sodipodi:linespacing="125%">Has of of + transform="matrix(1,0,0,-1,171.72593,1625.9208)"> @@ -1037,13 +1049,13 @@ xml:space="preserve" style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:15px;line-height:125%;font-family:Arial;-inkscape-font-specification:'Arial, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" x="450" - y="742.36218" + y="761.55505" id="text4386" sodipodi:linespacing="125%">For + y="672.276" /> RoleRoleMembership + transform="translate(0,-222.73864)"> Role + id="g4338" + transform="translate(0,19.192898)"> Is Includes + transform="translate(341.43156,-222.73861)"> @@ -1159,5 +1172,73 @@ inkscape:connector-curvature="0" /> + + + FollowupMethod + + + + + + + Address diff --git a/doc/specification/scaling.md b/doc/specification/scaling.md index bfc16de..922c473 100644 --- a/doc/specification/scaling.md +++ b/doc/specification/scaling.md @@ -22,7 +22,7 @@ Database reads are probably more infrequent. Each client will obviously need to Mobile phones typically can have intermittent network access. The client must be able to buffer a queue of records to be stored, and must not prevent the user from moving on to the next doorstep just because the data from the last visit has not yet been stored. There should probably be some on-screen indication of when there is unsent buffered data. -### Pattern of canvassing +### Pattern of canvassing Canvassing takes place typically between 6:30pm and 9:00pm on a weekday evening. There will be some canvassing outside this period, but not enough to create significant load. Canvassing will be higher on dry nights than on wet ones, and will probably ramp up through the campaign. @@ -40,7 +40,7 @@ This means that the maximum number of transactions per second across Scotland is 700 transactions per second is not a very large number. We should be able to support this level of load on a single server. But what if we can't? -## Spreading the load +## Spreading the load ### Caching and memoizing diff --git a/doc/specification/userspec.md b/doc/specification/userspec.md index 3f494b1..efa9f59 100644 --- a/doc/specification/userspec.md +++ b/doc/specification/userspec.md @@ -1,4 +1,4 @@ -### YouYesYet: User-oriented specification +# YouYesYet: User-oriented specification ## Overview diff --git a/env/dev/cljs/youyesyet/dev.cljs b/env/dev/cljs/youyesyet/dev.cljs index a246523..6394c48 100644 --- a/env/dev/cljs/youyesyet/dev.cljs +++ b/env/dev/cljs/youyesyet/dev.cljs @@ -1,5 +1,5 @@ -(ns ^:figwheel-no-load youyesyet.app - (:require [youyesyet.core :as core] +(ns ^:figwheel-no-load youyesyet.canvasser-app.app + (:require [youyesyet.canvasser-app.core :as core] [devtools.core :as devtools] [figwheel.client :as figwheel :include-macros true])) diff --git a/env/prod/cljs/youyesyet/prod.cljs b/env/prod/cljs/youyesyet/prod.cljs index ca12fd2..8cc0292 100644 --- a/env/prod/cljs/youyesyet/prod.cljs +++ b/env/prod/cljs/youyesyet/prod.cljs @@ -1,5 +1,5 @@ (ns youyesyet.app - (:require [youyesyet.core :as core])) + (:require [youyesyet.canvasser-app.core :as core])) ;;ignore println statements in prod (set! *print-fn* (fn [& _])) diff --git a/project.clj b/project.clj index 6108563..e248722 100644 --- a/project.clj +++ b/project.clj @@ -55,12 +55,17 @@ [lein-cljsbuild "1.1.4"] [lein-uberwar "0.2.0"] [lein-bower "0.5.1"] - [lein-less "1.7.5"]] + [lein-less "1.7.5"] + [lein-codox "0.10.3"]] :bower-dependencies [[leaflet "0.7.3"]] :cucumber-feature-paths ["test/clj/features"] + :codox {:metadata {:doc "FIXME: write docs"} + :languages [:clojure :clojurescript] + :source-paths ["src/clj" "src/cljc" "src/cljs"]} + :uberwar {:handler youyesyet.handler/app :init youyesyet.handler/init @@ -121,7 +126,7 @@ {:app {:source-paths ["src/cljs" "src/cljc" "env/dev/cljs"] :compiler - {:main "youyesyet.app" + {:main "youyesyet.canvasser-app.app" :asset-path "/js/out" :output-to "target/cljsbuild/public/js/app.js" :output-dir "target/cljsbuild/public/js/out" diff --git a/resources/migrations/20161014170335-basic-setup.up.sql b/resources/migrations/20161014170335-basic-setup.up.sql index 0719e57..b7b3277 100644 --- a/resources/migrations/20161014170335-basic-setup.up.sql +++ b/resources/migrations/20161014170335-basic-setup.up.sql @@ -118,15 +118,16 @@ ALTER TABLE public.authorities OWNER TO youyesyet; -- CREATE TABLE IF NOT EXISTS canvassers ( - id serial, - username character varying(32) NOT NULL, - fullname character varying(64) NOT NULL, - elector_id integer, - address_id integer NOT NULL, - phone character varying(16), - email character varying(128), - authority_id character varying(32) NOT NULL, - authorised boolean + id serial, + username character varying(32) NOT NULL, + fullname character varying(64) NOT NULL, + elector_id integer, + address_id integer NOT NULL, + phone character varying(16), + email character varying(128), + authority_id character varying(32) NOT NULL, + introduced_by int references canvassers(id), + authorised boolean ); --;; @@ -534,6 +535,8 @@ ALTER TABLE ONLY canvassers ADD CONSTRAINT canvassers_elector_id_fkey FOREIGN KEY (elector_id) REFERENCES electors(id); --;; +create unique index canvassers_username_ix on canvassers (username); +create unique index canvassers_email_ix on canvassers(email); -- -- Name: electors_address_id_fkey; Type: FK CONSTRAINT; Schema: public; Owner: youyesyet diff --git a/resources/migrations/20170401115900-basic-reference-data.down.sql b/resources/migrations/20170401115900-basic-reference-data.down.sql new file mode 100644 index 0000000..a0b3aa1 --- /dev/null +++ b/resources/migrations/20170401115900-basic-reference-data.down.sql @@ -0,0 +1,17 @@ +-- this is just a teardown of everything set up in the corresponding .up.sql file + +delete from roles where name = 'Expert'; +delete from roles where name = 'Administrator'; +delete from roles where name = 'Recruiter'; +delete from roles where name = 'Organiser'; +delete from roles where name = 'Editor'; + +alter table issues drop column content; +alter table issues drop column current; + +delete from issues where id = 'Currency'; +delete from issues where id = 'Monarchy'; +delete from issues where id = 'Defence'; + +delete from options where id = 'Yes'; +delete from options where id = 'No'; diff --git a/resources/migrations/20170401115900-basic-reference-data.up.sql b/resources/migrations/20170401115900-basic-reference-data.up.sql new file mode 100644 index 0000000..26d3bf1 --- /dev/null +++ b/resources/migrations/20170401115900-basic-reference-data.up.sql @@ -0,0 +1,58 @@ + +-- We don't explicitly instantiate the 'Canvasser' role since every user is +-- deemed to be a canvasser. + + +-- an 'Expert' is someone with expertise in one or more issues, who is +-- trusted to discuss those issues in detail with electors. +insert into roles (name) values ('Expert'); + + +-- an 'Administrator' is someone entitled to broadly alter reference data +-- throughout the system. +insert into roles (name) values ('Administrator'); + + +-- a 'Recruiter' is someone entitled to invite other people to become users +-- ('Canvassers'). A Recruiter is entitled to lock the account of anyone they +-- have recruited, recursively. +insert into roles (name) values ('Recruiter'); + + +-- an 'Organiser' is someone who organises one or more local teams. An Organiser +-- is entitled to exclude any Canvasser from any team they organise. +insert into roles (name) values ('Organiser'); + + +-- an 'Editor' is someone entitled to add and edit issues. +insert into roles (name) values ('Editor'); + +-- issue text is local; there may still in addition be a further link to more +-- information, but the basic issue text should be part of the issue record. +-- The text should fit on a phone screen without scrolling, so is reasonably +-- short. +alter table issues add column content varchar(1024); + +-- an issue may be current or not current; when not current it is not deleted +-- from the system but kept because it may become current again later. Only +-- current issues are shown in the app. Typically not fewer than three and not +-- more than about seven issues should be current at any time. +alter table issues add column current boolean default false; + +insert into issues (id, content, current) values ('Currency', + 'Scotland could keep the Pound, or use the Euro. But we could also set up a new currency of our own.', + true); + +insert into issues (id, content, current) values ('Monarchy', + 'Scotland could keep the Queen. This is an issue to be decided after independence.', + true); + +insert into issues (id, content, current) values ('Defence', + 'Scotland will not have nuclear weapons, and will probably not choose to engage in far-off wars. But we could remain members of NATO.', + true); + + +insert into options (id) values ('Yes'); + +insert into options (id) values ('No'); + diff --git a/resources/migrations/20170415102900-core-views.down.sql b/resources/migrations/20170415102900-core-views.down.sql new file mode 100644 index 0000000..c576947 --- /dev/null +++ b/resources/migrations/20170415102900-core-views.down.sql @@ -0,0 +1,11 @@ +drop view if exists roles_by_canvasser; + +drop view if exists teams_by_canvasser; + +drop view if exists canvassers_by_team; + +drop view if exists canvassers_by_introducer; + +drop view if exists teams_by_organiser; + +drop view if exists organisers_by_team; diff --git a/resources/migrations/20170415102900-core-views.up.sql b/resources/migrations/20170415102900-core-views.up.sql new file mode 100644 index 0000000..53346a6 --- /dev/null +++ b/resources/migrations/20170415102900-core-views.up.sql @@ -0,0 +1,59 @@ + +create view roles_by_canvasser as + select canvassers.id as canvasser, roles.name + from roles, rolememberships, canvassers + where roles.id = rolememberships.role_id + and canvassers.id = rolememberships.canvasser_id + and canvassers.authorised = true; + +create view teams_by_canvasser as + select canvassers.id as canvasser, teams.id, teams.name, teams.latitude, teams.longitude + from teams, teammemberships, canvassers + where teams.id = teammemberships.team_id + and canvassers.id = teammemberships.canvasser_id; + +create view canvassers_by_team as + select teams.id as team, + canvassers.id, + canvassers.username, + canvassers.fullname, + canvassers.email, + canvassers.phone + from teams, teammemberships, canvassers + where teams.id = teammemberships.team_id + and canvassers.id = teammemberships.canvasser_id + and canvassers.authorised = true; + +create view canvassers_by_introducer as + select introducers.id as introducer, + canvassers.id as canvasser, + canvassers.username, + canvassers.fullname, + canvassers.email, + canvassers.phone, + canvassers.authorised + from canvassers, canvassers as introducers + where introducers.id = canvassers.introduced_by; + +create view teams_by_organiser as + select canvassers.id as organiser, + teams.id, + teams.name, + teams.latitude, + teams.longitude + from teams, teamorganiserships, canvassers + where teams.id = teamorganiserships.team_id + and canvassers.id = teamorganiserships.canvasser_id + and canvassers.authorised = true; + +create view organisers_by_team as + select teams.id as team, + canvassers.id, + canvassers.username, + canvassers.fullname, + canvassers.email, + canvassers.phone + from teams, teamorganiserships, canvassers + where teams.id = teamorganiserships.team_id + and canvassers.id = teamorganiserships.canvasser_id + and canvassers.authorised = true; diff --git a/resources/migrations/20170721084900-dwellings.down.sql b/resources/migrations/20170721084900-dwellings.down.sql new file mode 100644 index 0000000..674fb1b --- /dev/null +++ b/resources/migrations/20170721084900-dwellings.down.sql @@ -0,0 +1,69 @@ +-------------------------------------------------------------------------------- +---- +---- 20170721084900.up.sql: add dwellings table, to deal with flatted addresses. +---- +---- 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 2 +---- 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, write to the Free Software +---- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +---- USA. +---- +---- Copyright (C) 2017 Simon Brooke for Radical Independence Campaign +---- +-------------------------------------------------------------------------------- +---- +---- NOTE +---- This file is essentially a Postgres schema dump of a database schema which was +---- created with the function initdb! in the file src/clj/youyesyet/db/schema.clj. +---- This file has then been mildly massaged to work with Migratus. +---- Either this file or src/clj/youyesyet/db/schema.clj is redundant; schema.clj +---- represents the older, Korma, way of doing things but does not readily allow +---- for migrations; this file represents the newer Migratus/HugSQL way. I'm not +---- certain which of these paths I'm going to go down. +---- +-------------------------------------------------------------------------------- + +alter table canvassers add column address_id integer references addresses(id); +--;; +alter table electors add column address_id integer references addresses(id); +--;; +alter table visits add column address_id integer references addresses(id); +--;; + +update canvassers set address_id = + (select address_id from dwellings where id = canvassers.dwelling_id); +--;; + +update electors set address_id = + (select address_id from dwellings where id = electors.dwelling_id); +--;; + +update visits set address_id = + (select address_id from dwellings where id = visits.dwelling_id); +--;; + +alter table canvassers alter column address_id set not null; +--;; +alter table electors alter column address_id set not null; +--;; +alter table visits alter column address_id set not null; +--;; + +alter table canvassers drop column dwelling_id; +--;; +alter table electors drop column dwelling_id; +--;; +alter table visits drop column dwelling_id; +--;; + +drop table if exists dwellings; +--;; diff --git a/resources/migrations/20170721084900-dwellings.up.sql b/resources/migrations/20170721084900-dwellings.up.sql new file mode 100644 index 0000000..74e6a27 --- /dev/null +++ b/resources/migrations/20170721084900-dwellings.up.sql @@ -0,0 +1,87 @@ +-------------------------------------------------------------------------------- +---- +---- 20170721084900.up.sql: add dwellings table, to deal with flatted addresses. +---- +---- 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 2 +---- 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, write to the Free Software +---- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +---- USA. +---- +---- Copyright (C) 2017 Simon Brooke for Radical Independence Campaign +---- +-------------------------------------------------------------------------------- +---- +---- NOTE +---- This file is essentially a Postgres schema dump of a database schema which was +---- created with the function initdb! in the file src/clj/youyesyet/db/schema.clj. +---- This file has then been mildly massaged to work with Migratus. +---- Either this file or src/clj/youyesyet/db/schema.clj is redundant; schema.clj +---- represents the older, Korma, way of doing things but does not readily allow +---- for migrations; this file represents the newer Migratus/HugSQL way. I'm not +---- certain which of these paths I'm going to go down. +---- +-------------------------------------------------------------------------------- + +CREATE TABLE IF NOT EXISTS dwellings ( + id serial NOT NULL primary key, + address_id integer NOT NULL references addresses(id), + sub_address varchar(16) +); +--;; + +ALTER TABLE public.dwellings OWNER TO youyesyet; +--;; + +INSERT INTO dwellings (address_id, sub_address) + SELECT DISTINCT id, '' FROM addresses; +--;; + +alter table canvassers add column dwelling_id integer references dwellings(id); +--;; +alter table electors add column dwelling_id integer references dwellings(id); +--;; +alter table visits add column dwelling_id integer references dwellings(id); +--;; + +update canvassers set dwelling_id = + (select id from dwellings where address_id = canvassers.address_id); +--;; + +update electors set dwelling_id = + (select id from dwellings where address_id = electors.address_id); +--;; + +update visits set dwelling_id = + (select id from dwellings where address_id = visits.address_id); +--;; + +alter table canvassers alter column dwelling_id set not null; +--;; +alter table electors alter column dwelling_id set not null; +--;; +alter table visits alter column dwelling_id set not null; +--;; + +alter table canvassers drop constraint canvassers_address_id_fkey; +--;; +alter table electors drop constraint electors_address_id_fkey; +--;; +alter table visits drop constraint visits_address_id_fkey; +--;; + +alter table canvassers drop column address_id; +--;; +alter table electors drop column address_id; +--;; +alter table visits drop column address_id; +--;; diff --git a/resources/public/css/yyy-site.css b/resources/public/css/yyy-site.css index 5387c7a..6f9b521 100644 --- a/resources/public/css/yyy-site.css +++ b/resources/public/css/yyy-site.css @@ -46,6 +46,7 @@ #nav-menu { margin: 0; padding: 0; + width: 100%; } #nav menu li { diff --git a/resources/sql/queries.sql b/resources/sql/queries.sql index 4191f67..e2170b8 100644 --- a/resources/sql/queries.sql +++ b/resources/sql/queries.sql @@ -1,21 +1,344 @@ --- :name create-user! :! :n --- :doc creates a new user record -INSERT INTO users -(id, first_name, last_name, email, pass) -VALUES (:id, :first_name, :last_name, :email, :pass) +------------------------------------------------------------------------------; +---- +---- youyesyet.routes.authenticated: routes and pages for authenticated users. +---- +---- 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 2 +---- 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, write to the Free Software +---- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +---- USA. +---- +---- Copyright (C) 2016 Simon Brooke for Radical Independence Campaign +---- +------------------------------------------------------------------------------; --- :name update-user! :! :n --- :doc update an existing user record -UPDATE users -SET first_name = :first_name, last_name = :last_name, email = :email +-- This file gets slurped in and converted into simple functions by the line +-- in youyesyet.db.core.clj: +-- (conman/bind-connection *db* "sql/queries.sql") +-- the functions then appeare in the youyesyet.db.core namespace. + +-- :name create-address! :! :n +-- :doc creates a new address record +INSERT INTO addresses +(address, postcode, district_id, latitude, longitude) +VALUES (:address, :postcode, :district, :latitude, :longitude) +RETURNING id + +-- :name update-address! :! :n +-- :doc update an existing address record +UPDATE addresses +SET address = :address, postcode = :postcode, latitude = :latitude, longitude = :longitude WHERE id = :id --- :name get-user :? :1 --- :doc retrieve a user given the id. -SELECT * FROM users +-- :name get-address :? :1 +-- :doc retrieve a address given the id. +SELECT * FROM addresses WHERE id = :id --- :name delete-user! :! :n --- :doc delete a user given the id -DELETE FROM users +-- :name get-addresses-by-postcode + +-- :name delete-address! :! :n +-- :doc delete a address given the id +DELETE FROM addresses WHERE id = :id + + +-- :name create-authority! :! :n +-- :doc creates a new authority record +INSERT INTO authorities +(id) +VALUES (:id) +RETURNING id + +-- :name update-authority! :! :n +-- :doc update an existing authority record +UPDATE authorities +SET id = :id +WHERE id = :id + +-- :name get-authority :? :1 +-- :doc retrieve a authority given the id. +SELECT * FROM authorities +WHERE id = :id + +-- :name get-authorities :? :0 +-- :doc retrieve all authorities +SELECT id FROM authorities + +-- :name delete-authority! :! :n +-- :doc delete a authority given the id +DELETE FROM authorities +WHERE id = :id + + +-- :name create-canvasser! :! :n +-- :doc creates a new canvasser record +INSERT INTO canvassers +(username, fullname, elector_id, dwelling_id, phone, email, authority_id, authorised) +VALUES (:username, :fullname, :elector_id, :dwelling_id, :phone, :email, :authority_id, :authorised) +RETURNING id + +-- :name update-canvasser! :! :n +-- :doc update an existing canvasser record +UPDATE canvassers +SET username = :username, fullname = :fullname, elector_id = :elector_id, dwelling_id = :dwelling_id, phone = :phone, email = :email, authority_id = :authority_id, authorised = :authorised +WHERE id = :id + +-- :name get-canvasser :? :1 +-- :doc retrieve a canvasser given the id. +SELECT * FROM canvassers +WHERE id = :id + +-- :name get-canvasser-by-username :? :1 +-- :doc rerieve a canvasser given the username. +SELECT * FROM canvassers +WHERE username = :username + +-- :name get-canvasser-by-email :? :1 +-- :doc rerieve a canvasser given the email address. +SELECT * FROM canvassers +WHERE email = :email + +-- :name delete-canvasser! :! :n +-- :doc delete a canvasser given the id +DELETE FROM canvassers +WHERE id = :id + + +-- :name create-district! :! :n +-- :doc creates a new district record +INSERT INTO districts +(id, name) +VALUES (:id, :name) +RETURNING id + +-- :name update-district! :! :n +-- :doc update an existing district record +UPDATE districts +SET name = :name +WHERE id = :id + +-- :name get-district :? :1 +-- :doc retrieve a district given the id. +SELECT * FROM districts +WHERE id = :id + +-- :name delete-district! :! :n +-- :doc delete a district given the id +DELETE FROM districts +WHERE id = :id + + +-- :name get-dwelling :? :1 +-- :doc retrieve a dwelling given the id. +SELECT * FROM dwellings +WHERE id = :id + +-- :name delete-dwelling! :! :n +-- :doc delete a dwelling given the id +DELETE FROM dwellings +WHERE id = :id + +-- :name create-dwelling! :! :n +-- :doc creates a new dwelling record +INSERT INTO dwellings +(id, address_id, sub_address) +VALUES (:id, :address_id, :sub_address) +RETURNING id + +-- :name update-dwelling! :! :n +-- :doc update an existing dwelling record +UPDATE dwellings +SET address_id = :address_id, + sub_address = :sub_address +WHERE id = :id + +-- :name get-dwelling :? :1 +-- :doc retrieve a dwelling given the id. +SELECT * FROM dwellings +WHERE id = :id + +-- :name delete-dwelling! :! :n +-- :doc delete a dwelling given the id +DELETE FROM dwellings +WHERE id = :id + + +-- :name create-elector! :! :n +-- :doc creates a new elector record +INSERT INTO electors +(name, dwelling_id, phone, email) +VALUES (:name, :dwelling_id, :phone, :email) +RETURNING id + +-- :name update-elector! :! :n +-- :doc update an existing elector record +UPDATE electors +SET name = :name, dwelling_id = :dwelling_id, phone = :phone, email = :email +WHERE id = :id + +-- :name get-elector :? :1 +-- :doc retrieve a elector given the id. +SELECT * FROM electors +WHERE id = :id + +-- :name delete-elector! :! :n +-- :doc delete a elector given the id +DELETE FROM electors +WHERE id = :id + + +-- :name create-followupaction! :! :n +-- :doc creates a new followupaction record +INSERT INTO followupactions +(request_id, actor, date, notes, closed) +VALUES (:request_id, :actor, :date, :notes, :closed) +RETURNING id + +-- We don't update followup actions. They're permanent record. + +-- :name get-followupaction :? :1 +-- :doc retrieve a followupaction given the id. +SELECT * FROM followupactions +WHERE id = :id + +-- We don't delete followup actions. They're permanent record. + + +-- followup methods are reference data, do not need to be programmatically maintained. + + +-- :name create-followuprequest! :! :n +-- :doc creates a new followupaction record +INSERT INTO followuprequests +(elector_id, visit_id, issue_id, method_id) +VALUES (:elector_id, :visit_id, :issue_id, :method_id) +RETURNING id + +-- We don't update followup requests. They're permanent record. + +-- :name get-followuprequest :? :1 +-- :doc retrieve a followupaction given the id. +SELECT * FROM followuprequests +WHERE id = :id + +-- We don't delete followup requests. They're permanent record. + + +-- :name create-issueexpertise! :! :n +-- :doc creates a new issueexpertise record +INSERT INTO issueexpertise +(canvasser_id, issue_id, method_id) +VALUES (:canvasser_id, :issue_id, :method_id) +-- issueexertise is a link table, doesn't have an id field. + +-- :name update-issueexpertise! :! :n +-- :doc update an existing issueexpertise record +UPDATE issueexpertise +SET canvasser_id = :canvasser_id, issue_id = :issue_id, method_id = :method_id +WHERE id = :id + +-- :name get-issueexpertise :? :1 +-- :doc retrieve a issueexpertise given the canvasser_id - +-- getting it by its own id is unlikely to be interesting or useful. +SELECT * FROM issueexpertise +WHERE canvasser_id = :canvasser_id + +-- :name delete-issueexpertise! :! :n +-- :doc delete a issueexpertise given the id +DELETE FROM issueexpertise +WHERE id = :id + + +-- :name create-issue! :! :n +-- :doc creates a new issue record +INSERT INTO issues +(id, url, content, current) +VALUES (:id, :url, :content, :current) +RETURNING id + + +-- :name update-issue! :! :n +-- :doc update an existing issue record +UPDATE issues +SET url = :url, content = :content, current = :current +WHERE id = :id + +-- :name get-issue :? :1 +-- :doc retrieve a issue given the id - +SELECT * FROM issues +WHERE id = :id + +-- :name delete-issue! :! :n +-- :doc delete a issue given the id +DELETE FROM issues +WHERE id = :id + + +-- options is virtually reference data; it's not urgent to create a programmatic means of editing + +-- :name create-visit! :! :n +-- :doc creates a new visit record +INSERT INTO visits +(dwelling_id, canvasser_id) +VALUES (:dwelling_id, :canvasser_id) +RETURNING id + +-- visits is audit data; we don't update it. + +-- :name get-visit :? :1 +-- :doc retrieve a visit given the id. +SELECT * FROM visits +WHERE id = :id + +-- visits is audit data; we don't delete it. + + +-- views are select only + +-- :name get-roles-by-canvasser :? :* +-- :doc Get the role names for the canvasser with the specified id +select name from roles_by_canvasser + where canvasser = :canvasser + +-- :name get-teams-by-canvasser :? :* +-- :doc Get details of the teams which the canvasser with the specified id is member of. +select * from teams_by_canvasser + where canvasser = :canvasser_id + +-- :name get-canvassers-by-team :? :* +-- :doc Get details of all canvassers who are members of the team with the specified id +select * from canvassers_by_team + where team = :team_id + +-- :name get-canvassers-by-team :? :* +-- :doc Get details of all authorised canvassers who are members of this team. +select * from canvassers_by_introducer + where introducer = :introducer_id + +-- :name get-canvassers-by-search :? :* +-- :doc Get details of all authorised canvassers whose details match this search string. +select * from canvassers + where name like '%' || :search || '%' + or username like '%' || :search || '%' + or email like '%' || :search || '%' + +-- :name get-teams_by_organiser :? :* +-- :doc Get details of all the teams organised by the canvasser with the specified id +select * from teams_by_organiser + where organiser = :organiser_id + +-- :name get-organisers-by-team :? :* +-- :doc Get details of all organisers of the team with the specified id +select * from organisers_by_team + where team = :team_id + diff --git a/resources/templates/app.html b/resources/templates/app.html index 5214806..024aa39 100644 --- a/resources/templates/app.html +++ b/resources/templates/app.html @@ -1,16 +1,5 @@ - - - - - - - - - - You Yes Yet? - - - +{% extends "base-authenticated.html" %} +{% block whole-page %}
@@ -33,21 +22,16 @@ You must enable JavaScript to use the You Yes Yet app.

- - - - - - - - - - {% script "/js/app.js" %} - - +{% endblock %} +{% block extra-script %} + + + + + + +{% script "/js/app.js" %} +{% endblock %} diff --git a/resources/templates/base-authenticated.html b/resources/templates/base-authenticated.html index 7b2d418..7da389b 100644 --- a/resources/templates/base-authenticated.html +++ b/resources/templates/base-authenticated.html @@ -3,12 +3,14 @@ - + + {{title}} + {% block whole-page %}
@@ -28,12 +34,40 @@
+ {% block big-links %} + {% endblock %} +
- {{content}} + {% block content %} + {% endblock %} +
+
+ + {% endblock %} + + {% block extra-script %} + {% endblock %} diff --git a/resources/templates/base-unauthenticated.html b/resources/templates/base-unauthenticated.html index 7eb5ef5..4e41c8f 100644 --- a/resources/templates/base-unauthenticated.html +++ b/resources/templates/base-unauthenticated.html @@ -6,7 +6,7 @@ - {{title}} + {% block title %}{% endblock %}{{title}}
diff --git a/resources/templates/canvasser.html b/resources/templates/canvasser.html new file mode 100644 index 0000000..b223313 --- /dev/null +++ b/resources/templates/canvasser.html @@ -0,0 +1,60 @@ +{% extends "base-authenticated.html" %} +{% block title %} +{% endblock %} +{% block content %} +
+ {% if canvasser %} + + {% endif %} +

+ + +

+

+ (TODO: Not absolutely sure what I'm going to do for an elector id widget yet.) +

+

+ + {% if address.id %} + + + {{address.address}} + + {% else %} + (TODO: Some sort of address lookup widget goes here.) + {% endif %} +

+

+ + +

+

+ + +

+

+ + +

+ +

+ id serial, + username character varying(32) NOT NULL, + fullname character varying(64) NOT NULL, + elector_id integer, + address_id integer NOT NULL, + phone character varying(16), + email character varying(128), + authority_id character varying(32) NOT NULL, + introduced_by int references canvassers(id), + authorised boolean + +
+ +{% endblock %} diff --git a/resources/templates/login.html b/resources/templates/login.html index f3e8731..5ee3706 100644 --- a/resources/templates/login.html +++ b/resources/templates/login.html @@ -1,9 +1,4 @@ {% extends "base-unauthenticated.html" %} -{% block big-links %} - -{% endblock %} {% block content %}

We're not going to do login in the long term; we're going to use oauth. diff --git a/resources/templates/roles.html b/resources/templates/roles.html new file mode 100644 index 0000000..6b49d2e --- /dev/null +++ b/resources/templates/roles.html @@ -0,0 +1,16 @@ +{% extends "base-authenticated.html" %} +{% block title %} + {{ user }} +{% endblock %} +{% block big-links %} +

+ Canvasser +
+ {% for role in roles %} +
+ {{role.name}} +
+ {% endfor %} +{% endblock %} +{% block content %} +{% endblock %} diff --git a/src/clj/youyesyet/config.clj b/src/clj/youyesyet/config.clj index d3f80e0..2de50fa 100644 --- a/src/clj/youyesyet/config.clj +++ b/src/clj/youyesyet/config.clj @@ -1,4 +1,6 @@ -(ns youyesyet.config +(ns ^{:doc "Read configuration." + :author "Simon Brooke"} + youyesyet.config (:require [cprop.core :refer [load-config]] [cprop.source :as source] [mount.core :refer [args defstate]])) diff --git a/src/clj/youyesyet/db/core.clj b/src/clj/youyesyet/db/core.clj index e514d08..a57fa50 100644 --- a/src/clj/youyesyet/db/core.clj +++ b/src/clj/youyesyet/db/core.clj @@ -1,4 +1,6 @@ -(ns youyesyet.db.core +(ns ^{:doc "Database access functions." + :author "Simon Brooke"} + youyesyet.db.core (:require [cheshire.core :refer [generate-string parse-string]] [clojure.java.jdbc :as jdbc] @@ -15,12 +17,10 @@ Timestamp PreparedStatement])) -(def ^:dynamic *db* {:name "java:comp/env/jdbc/EmployeeDB"}) -;; (defstate ^:dynamic *db* -;; :start (conman/connect! {:jdbc-url-env (env :database-url) -;; :jdbc-url "jdbc:postgresql://127.0.0.1/youyesyet_dev?user=youyesyet&password=thisisnotsecure" -;; :driver-class-name "org.postgresql.Driver"}) -;; :stop (conman/disconnect! *db*)) +(defstate ^:dynamic *db* + :start (conman/connect! {:jdbc-url (env :database-url) + :driver-class-name "org.postgresql.Driver"}) + :stop (conman/disconnect! *db*)) (conman/bind-connection *db* "sql/queries.sql") diff --git a/src/clj/youyesyet/db/schema.clj b/src/clj/youyesyet/db/schema.clj index 7a6c45b..7571251 100644 --- a/src/clj/youyesyet/db/schema.clj +++ b/src/clj/youyesyet/db/schema.clj @@ -1,4 +1,5 @@ -(ns youyesyet.db.schema +(ns ^{:doc "Korma-flavour database setup, now obsolete but retained for documentation." + :author "Simon Brooke"} youyesyet.db.schema (:require [clojure.java.jdbc :as sql] [korma.core :as kc] [youyesyet.db.core :as yyydb])) diff --git a/src/clj/youyesyet/handler.clj b/src/clj/youyesyet/handler.clj index f898fe5..173497e 100644 --- a/src/clj/youyesyet/handler.clj +++ b/src/clj/youyesyet/handler.clj @@ -1,6 +1,9 @@ -(ns youyesyet.handler +(ns ^{:doc "Handlers for starting and stopping the webapp." + :author "Simon Brooke"} + youyesyet.handler (:require [compojure.core :refer [routes wrap-routes]] [youyesyet.layout :refer [error-page]] + [youyesyet.routes.authenticated :refer [authenticated-routes]] [youyesyet.routes.home :refer [home-routes]] [youyesyet.routes.oauth :refer [oauth-routes]] [compojure.route :as route] @@ -10,6 +13,29 @@ [clojure.tools.logging :as log] [youyesyet.config :refer [env]])) +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; youyesyet.handler: handlers for starting and stopping the webapp. +;;;; +;;;; 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 2 +;;;; 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, write to the Free Software +;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +;;;; USA. +;;;; +;;;; Copyright (C) 2016 Simon Brooke for Radical Independence Campaign +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + (mount/defstate init-app :start ((or (:init defaults) identity)) :stop ((or (:stop defaults) identity))) @@ -38,6 +64,7 @@ (wrap-routes middleware/wrap-csrf) (wrap-routes middleware/wrap-formats)) #'oauth-routes + #'authenticated-routes (route/not-found (:body (error-page {:status 404 diff --git a/src/clj/youyesyet/layout.clj b/src/clj/youyesyet/layout.clj index aaec434..d131cb7 100644 --- a/src/clj/youyesyet/layout.clj +++ b/src/clj/youyesyet/layout.clj @@ -1,4 +1,6 @@ -(ns youyesyet.layout +(ns^{:doc "Render web pages using Selmer tamplating markup." + :author "Simon Brooke"} + youyesyet.layout (:require [selmer.parser :as parser] [selmer.filters :as filters] [markdown.core :refer [md-to-html-string]] @@ -12,6 +14,7 @@ (parser/add-tag! :csrf-field (fn [_ _] (anti-forgery-field))) (filters/add-filter! :markdown (fn [content] [:safe (md-to-html-string content)])) + (defn render "renders the HTML template located relative to resources/templates" [template & [params]] @@ -26,6 +29,7 @@ :version (System/getProperty "youyesyet.version")))) "text/html; charset=utf-8")) + (defn error-page "error-details should be a map containing the following keys: :status - error status diff --git a/src/clj/youyesyet/middleware.clj b/src/clj/youyesyet/middleware.clj index 1775cb9..2288720 100644 --- a/src/clj/youyesyet/middleware.clj +++ b/src/clj/youyesyet/middleware.clj @@ -1,4 +1,6 @@ -(ns youyesyet.middleware +(ns ^{:doc "Plumbing, mainly boilerplate from Luminus." + :author "Simon Brooke"} + youyesyet.middleware (:require [youyesyet.env :refer [defaults]] [clojure.tools.logging :as log] [youyesyet.layout :refer [*app-context* error-page]] diff --git a/src/clj/youyesyet/routes/administrator.clj b/src/clj/youyesyet/routes/administrator.clj new file mode 100644 index 0000000..7a08b36 --- /dev/null +++ b/src/clj/youyesyet/routes/administrator.clj @@ -0,0 +1,11 @@ +(ns ^{:doc "Routes/pages available to administrators, only." + :author "Simon Brooke"} + youyesyet.routes.administrator + (:require [clojure.java.io :as io] + [clojure.walk :refer [keywordize-keys]] + [compojure.core :refer [defroutes GET POST]] + [noir.response :as nresponse] + [noir.util.route :as route] + [ring.util.http-response :as response] + [youyesyet.layout :as layout] + [youyesyet.db.core :as db])) diff --git a/src/clj/youyesyet/routes/authenticated.clj b/src/clj/youyesyet/routes/authenticated.clj new file mode 100644 index 0000000..b02c512 --- /dev/null +++ b/src/clj/youyesyet/routes/authenticated.clj @@ -0,0 +1,75 @@ +(ns ^{:doc "Routes/pages available to all authenticated users." + :author "Simon Brooke"} + youyesyet.routes.authenticated + (:require [clojure.java.io :as io] + [clojure.walk :refer [keywordize-keys]] + [compojure.core :refer [defroutes GET POST]] + [noir.response :as nresponse] + [noir.util.route :as route] + [ring.util.http-response :as response] + [youyesyet.layout :as layout] + [youyesyet.db.core :as db])) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; youyesyet.routes.authenticated: routes and pages for authenticated users. +;;;; +;;;; 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 2 +;;;; 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, write to the Free Software +;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +;;;; USA. +;;;; +;;;; Copyright (C) 2016 Simon Brooke for Radical Independence Campaign +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +;;; This code adapted from http://www.luminusweb.net/docs#accessing_the_database + +(defn post? + "Return true if the argument is a ring request which is a post request" + [request] + true) + +(defn canvasser-page + "Process this canvasser request, and render the canvasser page" + [request] + (let [canvasser (if + (:params request) + (let [params (:params request)] + (if (:id params) + (if (post? request) + (db/update-canvasser! params) + (db/create-canvasser! params)) + (db/get-canvasser (:id params))) + ))] + (layout/render + "canvasser.html" + {:title (if canvasser + (str + "Edit canvasser " + (:fullname canvasser) + " " + (:email canvasser)) + "Add new canvasser") + :canvasser canvasser + :address (if (:address_id canvasser) (db/get-address (:address_id canvasser)))}))) + +(defn routing-page + "Render the routing page, which offers routes according to the user's roles" + [] + (layout/render "routing.html")) + +(defroutes authenticated-routes + (GET "/edit-canvasser" request (canvasser-page request)) + (POST "/edit-canvasser" request (canvasser-page request)) + (GET "/routing" [] (routing-page))) diff --git a/src/clj/youyesyet/routes/home.clj b/src/clj/youyesyet/routes/home.clj index b44a289..9fbc094 100644 --- a/src/clj/youyesyet/routes/home.clj +++ b/src/clj/youyesyet/routes/home.clj @@ -1,4 +1,5 @@ -(ns youyesyet.routes.home +(ns ^{:doc "Routes/pages available to unauthenticated users." + :author "Simon Brooke"} youyesyet.routes.home (:require [clojure.walk :refer [keywordize-keys]] [noir.response :as nresponse] [noir.util.route :as route] @@ -8,12 +9,37 @@ [ring.util.http-response :as response] [clojure.java.io :as io])) +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; youyesyet.routes.home: routes and pages for unauthenticated users. +;;;; +;;;; 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 2 +;;;; 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, write to the Free Software +;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +;;;; USA. +;;;; +;;;; Copyright (C) 2016 Simon Brooke for Radical Independence Campaign +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + (defn app-page [] (layout/render "app.html")) + (defn about-page [] (layout/render "about.html")) + (defn call-me-page [request] (if request @@ -25,28 +51,53 @@ ;; TODO: Issues need to be fetched from the database :concerns nil}))) + +(defn roles-page [request] + (let + [session (:session request) + username (:user session) + user (if username (db-core/get-canvasser-by-username db-core/*db* {:username username})) + roles (if user (db-core/get-roles-by-canvasser db-core/*db* {:canvasser (:id user)}))] + (cond + roles (layout/render "roles.html" + {:title (str "Welcome " (:fullname user) ", what do you want to do?") + :user user + :roles roles}) + (empty? roles)(response/found "/app") + true (assoc (response/found "/login") :session (dissoc session :user)) + ))) + + (defn home-page [] (layout/render "home.html" {:title "You Yes Yet?"})) + (defn login-page "This is very temporary. We're going to do authentication by oauth." [request] (let [params (keywordize-keys (:form-params request)) session (:session request) username (:username params) + user (if username (db-core/get-canvasser-by-username db-core/*db* {:username username})) password (:password params) - redirect-to (or (:redirect-to params) "app")] - (if - (and (= username "test") (= password "test")) - (do - (assoc (response/found redirect-to) :session (assoc session :user username))) - (layout/render "login.html" {:title "Please log in" :redirect-to redirect-to})))) + redirect-to (or (:redirect-to params) "roles")] + (cond + ;; this is obviously, ABSURDLY, insecure. I don't want to put just-about-good-enough, + ;; it-will-do-for-now security in place; instead, I want this to be test code only + ;; until we have o-auth properly working. + (and user (= username password)) + (assoc (response/found redirect-to) :session (assoc session :user username)) + user + (layout/render "login.html" {:title (str "User " username " is unknown") :redirect-to redirect-to}) + true + (layout/render "login.html" {:title "Please log in" :redirect-to redirect-to})))) (defroutes home-routes (GET "/" [] (home-page)) (GET "/home" [] (home-page)) (GET "/about" [] (about-page)) + (GET "/roles" request (route/restricted (roles-page request))) (GET "/app" [] (route/restricted (app-page))) (GET "/call-me" [] (call-me-page nil)) (POST "/call-me" request (call-me-page request)) diff --git a/src/clj/youyesyet/routes/oauth.clj b/src/clj/youyesyet/routes/oauth.clj index d916e10..a7c7e46 100644 --- a/src/clj/youyesyet/routes/oauth.clj +++ b/src/clj/youyesyet/routes/oauth.clj @@ -1,4 +1,5 @@ -(ns youyesyet.routes.oauth +(ns ^{:doc "OAuth authentication routes - not finished, does not work yet." + :author "Simon Brooke"} youyesyet.routes.oauth (:require [compojure.core :refer [defroutes GET]] [ring.util.http-response :refer [ok found]] [clojure.java.io :as io] diff --git a/src/clj/youyesyet/routes/services.clj b/src/clj/youyesyet/routes/services.clj index c0de2b5..43347c7 100644 --- a/src/clj/youyesyet/routes/services.clj +++ b/src/clj/youyesyet/routes/services.clj @@ -1,4 +1,5 @@ -(ns youyesyet.routes.services +(ns ^{:doc "REST API." + :author "Simon Brooke"} youyesyet.routes.services (:require [clj-http.client :as client] [ring.util.http-response :refer :all] [compojure.api.sweet :refer :all] diff --git a/src/cljc/youyesyet/outqueue.cljc b/src/cljc/youyesyet/outqueue.cljc index f2f0df3..8386d4a 100644 --- a/src/cljc/youyesyet/outqueue.cljc +++ b/src/cljc/youyesyet/outqueue.cljc @@ -1,4 +1,6 @@ -(ns youyesyet.outqueue +(ns ^{:doc "Queue of messages waiting to be sent to the server." + :author "Simon Brooke"} + youyesyet.outqueue (:require #?(:clj [clojure.core] :cljs [reagent.core :refer [atom]]))) @@ -41,6 +43,7 @@ (reverse items) (list items))}))) + (defn add! "Add this item to the queue." [q item] @@ -49,7 +52,9 @@ (assoc a :items (cons item (:items a)))))) -(defn q? + +(defn queue? + "True if x is a queue, else false." [x] (try (let [q (deref x) @@ -61,21 +66,25 @@ #?(:clj (print (.getMessage any)) :cljs (js/console.log (str any)))))) + (defn peek "Look at the next item which could be removed from the queue." [q] (last (:items (deref q)))) + (defn locked? [q] (:locked (deref q))) + (defn unlock! ([q ] (unlock! q true)) ([q value] (swap! q (fn [a] (assoc a :locked (not (true? value))))))) + (defn lock! [q] (unlock! q false)) @@ -86,6 +95,7 @@ [q] (count (deref q))) + (defn take! "Return the first item from the queue, rebind the queue to the remaining items. If the queue is empty return nil." @@ -97,12 +107,13 @@ (assoc (assoc a :items new-queue) :v item)))) (:v (deref q))) + (defn maybe-process-next "Apply this process, assumed to be a function of one argument, to the next item in the queue, if the queue is not currently locked; return the value returned by process." [q process] - (if (and (q? q)(not (locked? q))) + (if (and (queue? q)(not (locked? q))) (try (lock! q) (let [v (apply process (list (peek q)))] diff --git a/src/cljc/youyesyet/validation.cljc b/src/cljc/youyesyet/validation.cljc index fd01d8f..7c293dd 100644 --- a/src/cljc/youyesyet/validation.cljc +++ b/src/cljc/youyesyet/validation.cljc @@ -1,3 +1,26 @@ (ns youyesyet.validation (:require [bouncer.core :as b] [bouncer.validators :as v])) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; youyesyet.validation: +;;;; +;;;; 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 2 +;;;; 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, write to the Free Software +;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +;;;; USA. +;;;; +;;;; Copyright (C) 2016 Simon Brooke for Radical Independence Campaign +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; diff --git a/src/cljs/youyesyet/ajax.cljs b/src/cljs/youyesyet/ajax.cljs deleted file mode 100644 index 07cf00d..0000000 --- a/src/cljs/youyesyet/ajax.cljs +++ /dev/null @@ -1,20 +0,0 @@ -(ns youyesyet.ajax - (:require [ajax.core :as ajax])) - -(defn local-uri? [{:keys [uri]}] - (not (re-find #"^\w+?://" uri))) - -(defn default-headers [request] - (if (local-uri? request) - (-> request - (update :uri #(str js/context %)) - (update :headers #(merge {"x-csrf-token" js/csrfToken} %))) - request)) - -(defn load-interceptors! [] - (swap! ajax/default-interceptors - conj - (ajax/to-interceptor {:name "default headers" - :request default-headers}))) - - diff --git a/src/cljs/youyesyet/canvasser_app/ajax.cljs b/src/cljs/youyesyet/canvasser_app/ajax.cljs new file mode 100644 index 0000000..3db48fc --- /dev/null +++ b/src/cljs/youyesyet/canvasser_app/ajax.cljs @@ -0,0 +1,46 @@ +(ns ^{:doc "Canvasser app transciever for ajax packets." + :author "Simon Brooke"} + youyesyet.canvasser-app.ajax + (:require [ajax.core :as ajax])) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; youyesyet.canvasser-app.ajax: transciever for ajax packets. +;;;; +;;;; 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 2 +;;;; 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, write to the Free Software +;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +;;;; USA. +;;;; +;;;; Copyright (C) 2016 Simon Brooke for Radical Independence Campaign +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + + +(defn local-uri? [{:keys [uri]}] + (not (re-find #"^\w+?://" uri))) + +(defn default-headers [request] + (if (local-uri? request) + (-> request + (update :uri #(str js/context %)) + (update :headers #(merge {"x-csrf-token" js/csrfToken} %))) + request)) + +(defn load-interceptors! [] + (swap! ajax/default-interceptors + conj + (ajax/to-interceptor {:name "default headers" + :request default-headers}))) + + diff --git a/src/cljs/youyesyet/core.cljs b/src/cljs/youyesyet/canvasser_app/core.cljs similarity index 78% rename from src/cljs/youyesyet/core.cljs rename to src/cljs/youyesyet/canvasser_app/core.cljs index 27e831c..e492a35 100644 --- a/src/cljs/youyesyet/core.cljs +++ b/src/cljs/youyesyet/canvasser_app/core.cljs @@ -1,4 +1,6 @@ -(ns youyesyet.core +(ns ^{:doc "Canvasser app navigation and routing." + :author "Simon Brooke"} + youyesyet.canvasser-app.core (:require cljsjs.react-leaflet [ajax.core :refer [GET POST]] [goog.events :as events] @@ -7,21 +9,22 @@ [reagent.core :as r] [re-frame.core :as rf] [secretary.core :as secretary] - [youyesyet.ajax :refer [load-interceptors!]] - [youyesyet.handlers] - [youyesyet.subscriptions] - [youyesyet.ui-utils :as ui] - [youyesyet.views.about :as about] - [youyesyet.views.electors :as electors] - [youyesyet.views.followup :as followup] - [youyesyet.views.issue :as issue] - [youyesyet.views.issues :as issues] - [youyesyet.views.map :as maps]) + [youyesyet.canvasser-app.ajax :refer [load-interceptors!]] + [youyesyet.canvasser-app.handlers] + [youyesyet.canvasser-app.subscriptions] + [youyesyet.canvasser-app.ui-utils :as ui] + [youyesyet.canvasser-app.views.about :as about] + [youyesyet.canvasser-app.views.building :as building] + [youyesyet.canvasser-app.views.electors :as electors] + [youyesyet.canvasser-app.views.followup :as followup] + [youyesyet.canvasser-app.views.issue :as issue] + [youyesyet.canvasser-app.views.issues :as issues] + [youyesyet.canvasser-app.views.map :as maps]) (:import goog.History)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; -;;;; youyesyet.core: core of the app. +;;;; youyesyet.canvasser-app.core: core of the app. ;;;; ;;;; This program is free software; you can redistribute it and/or ;;;; modify it under the terms of the GNU General Public License @@ -48,6 +51,9 @@ (defn about-page [] (about/panel)) +(defn building-page [] + (building/panel)) + (defn electors-page [] (electors/panel)) @@ -65,6 +71,7 @@ (def pages {:about #'about-page + :building #'building-page :electors #'electors-page :followup #'followup-page :issues #'issues-page @@ -103,10 +110,10 @@ (secretary/defroute "/about" [] (rf/dispatch [:set-active-page :about])) -(secretary/defroute "/electors" [] - (rf/dispatch [:set-active-page :electors])) +(secretary/defroute "/electors/:dwelling" {dwelling-id :dwelling} + (rf/dispatch [:set-dwelling dwelling-id])) -(secretary/defroute "/electors/:address" {address-id :address} +(secretary/defroute "/building/:address" {address-id :address} (rf/dispatch [:set-address address-id])) (secretary/defroute "/followup" [] diff --git a/src/cljs/youyesyet/handlers.cljs b/src/cljs/youyesyet/canvasser_app/handlers.cljs similarity index 84% rename from src/cljs/youyesyet/handlers.cljs rename to src/cljs/youyesyet/canvasser_app/handlers.cljs index deb11f4..813ec99 100644 --- a/src/cljs/youyesyet/handlers.cljs +++ b/src/cljs/youyesyet/canvasser_app/handlers.cljs @@ -1,7 +1,9 @@ -(ns youyesyet.handlers +(ns ^{:doc "Canvasser app event handlers." + :author "Simon Brooke"} + youyesyet.canvasser-app.handlers (:require [cljs.reader :refer [read-string]] [re-frame.core :refer [dispatch reg-event-db]] - [youyesyet.db :as db] + [youyesyet.canvasser-app.state :as db] )) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -110,7 +112,29 @@ (fn [db [_ address-id]] (let [id (read-string address-id) address (first (remove nil? (map #(if (= id (:id %)) %) (:addresses db))))] - (assoc (clear-messages db) :address address :page :electors)))) + (if + (= (count (:dwellings address)) 1) + (assoc (clear-messages db) + :address address + :dwelling (first (:dwellings address)) + :page :electors) + (assoc (clear-messages db) + :address address + :dwelling nil + :page :building))))) + + +(reg-event-db + :set-dwelling + (fn [db [_ dwelling-id]] + (let [id (read-string dwelling-id) + dwelling (first + (remove + nil? + (map + #(if (= id (:id %)) %) + (mapcat :dwellings (:addresses db)))))] + (assoc (clear-messages db) :dwelling dwelling :page :electors)))) (reg-event-db diff --git a/src/cljs/youyesyet/canvasser_app/state.cljs b/src/cljs/youyesyet/canvasser_app/state.cljs new file mode 100644 index 0000000..c967f7c --- /dev/null +++ b/src/cljs/youyesyet/canvasser_app/state.cljs @@ -0,0 +1,85 @@ +(ns ^{:doc "Canvasser app client state." + :author "Simon Brooke"} + youyesyet.canvasser-app.state) + +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; +;;;; +;;;; youyesyet.canvasser-app.state: the state of the app. +;;;; +;;;; 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 2 +;;;; 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, write to the Free Software +;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, +;;;; USA. +;;;; +;;;; Copyright (C) 2016 Simon Brooke for Radical Independence Campaign +;;;; +;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; + +;;; This is the constructor for the atom in which the state of the user interface is held. +;;; The atom gets updated by 'events' registered in handler.cljs, q.v. +;;; +;;; not wonderfully happy with 'db' as a name for this namespace; will probably change to +;;; 'client-state'. + +(def default-db + {;;; the currently selected address, if any. + :address {:id 1 :address "13 Imaginary Terrace, IM1 3TE" :latitude 55.8253043 :longitude -4.2569057 + :dwellings [{:id 1 + :electors [{:id 1 :name "Alan Anderson" :gender :male :intention :no} + {:id 2 :name "Ann Anderson" :gender :female} + {:id 3 :name "Alex Anderson" :gender :fluid :intention :yes} + {:id 4 :name "Andy Anderson" :intention :yes}]}]} + ;;; a list of the addresses in the current location at which there + ;;; are electors registered. + :addresses [{:id 1 :address "13 Imaginary Terrace, IM1 3TE" :latitude 55.8253043 :longitude -4.2570944 + :dwellings [{:id 1 + :electors [{:id 1 :name "Alan Anderson" :gender :male :intention :no} + {:id 2 :name "Ann Anderson" :gender :female} + {:id 3 :name "Alex Anderson" :gender :fluid :intention :yes} + {:id 4 :name "Andy Anderson" :intention :yes}]}]} + {:id 2 :address "15 Imaginary Terrace, IM1 3TE" :latitude 55.8252354 :longitude -4.2572778 + :dwellings [{:id 2 + :electors [{:id 1 :name "Beryl Brown" :gender :female} + {:id 2 :name "Betty Black" :gender :female}]}]} + + {:id 3 :address "17 Imaginary Terrace, IM1 3TE" :latitude 55.825166 :longitude -4.257026 + :dwellings [{:id 3 :sub-address "Flat 1" + :electors [{:id 1 :name "Catriona Crathie" :gender :female :intention :yes} + {:id 2 :name "Colin Caruthers" :gender :male :intention :yes} + {:id 3 :name "Calum Crathie" :intention :yes}]} + {:id 4 :sub-address "Flat 2" + :electors [{:id 1 :name "David Dewar" :gender :male :intention :no}]}]}] + ;;; electors at the currently selected dwelling + :electors [{:id 1 :name "Alan Anderson" :gender :male :intention :no} + {:id 2 :name "Ann Anderson" :gender :female} + {:id 3 :name "Alex Anderson" :gender :fluid :intention :yes} + {:id 4 :name "Andy Anderson" :intention :yes}] + ;;; any error to display + :error nil + ;;; the issue from among the issues which is currently selected. + ;;; any confirmation message to display + :feedback nil + ;;; the currently selected issue + :issue "Currency" + ;;; the issues selected for the issues page on this day. + :issues {"Currency" "Scotland could keep the Pound, or use the Euro. But we could also set up a new currency of our own. Yada yada yada" + "Monarchy" "Scotland could keep the Queen. This is an issue to be decided after independence. Yada yada yada" + "Defence" "Scotland will not have nuclear weapons, and will probably not choose to engage in far-off wars. But we could remain members of NATO"} + ;;; message of the day + :motd "This is a test version only. There is no real data." + ;;; the options from among which electors can select. + :options [{:id :yes :description "Yes"} {:id :no :description "No"}] + ;;; the queue of items waiting to be transmitted. + :outqueue () + ;;; the currently displayed page within the app. + :page :home}) diff --git a/src/cljs/youyesyet/subscriptions.cljs b/src/cljs/youyesyet/canvasser_app/subscriptions.cljs similarity index 90% rename from src/cljs/youyesyet/subscriptions.cljs rename to src/cljs/youyesyet/canvasser_app/subscriptions.cljs index b1aa09c..3f87dee 100644 --- a/src/cljs/youyesyet/subscriptions.cljs +++ b/src/cljs/youyesyet/canvasser_app/subscriptions.cljs @@ -1,4 +1,6 @@ -(ns youyesyet.subscriptions +(ns ^{:doc "Canvasser app event subscriptions." + :author "Simon Brooke"} + youyesyet.canvasser-app.subscriptions (:require [re-frame.core :refer [reg-sub]])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @@ -44,6 +46,11 @@ (fn [db _] (:changes db))) +(reg-sub + :dwelling + (fn [db _] + (:dwelling db))) + (reg-sub :elector (fn [db _] diff --git a/src/cljs/youyesyet/ui_utils.cljs b/src/cljs/youyesyet/canvasser_app/ui_utils.cljs similarity index 95% rename from src/cljs/youyesyet/ui_utils.cljs rename to src/cljs/youyesyet/canvasser_app/ui_utils.cljs index 719090b..068bad6 100644 --- a/src/cljs/youyesyet/ui_utils.cljs +++ b/src/cljs/youyesyet/canvasser_app/ui_utils.cljs @@ -1,4 +1,6 @@ -(ns youyesyet.ui-utils +(ns ^{:doc "Canvasser app user interface widgets." + :author "Simon Brooke"} + youyesyet.canvasser-app.ui-utils (:require [reagent.core :as r] [re-frame.core :as rf])) diff --git a/src/cljs/youyesyet/views/about.cljs b/src/cljs/youyesyet/canvasser_app/views/about.cljs similarity index 91% rename from src/cljs/youyesyet/views/about.cljs rename to src/cljs/youyesyet/canvasser_app/views/about.cljs index 4ca4a4a..6b4d9ca 100644 --- a/src/cljs/youyesyet/views/about.cljs +++ b/src/cljs/youyesyet/canvasser_app/views/about.cljs @@ -1,11 +1,13 @@ -(ns youyesyet.views.about +(ns ^{:doc "Canvasser app about panel." + :author "Simon Brooke"} + youyesyet.canvasser-app.views.about (:require [re-frame.core :refer [reg-sub subscribe]] [markdown.core :refer [md->html]] - [youyesyet.ui-utils :as ui])) + [youyesyet.canvasser-app.ui-utils :as ui])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; -;;;; youyesyet.views.about: about/credits view for youyesyet. +;;;; youyesyet.canvasser-app.views.about: about/credits view for youyesyet. ;;;; ;;;; This program is free software; you can redistribute it and/or ;;;; modify it under the terms of the GNU General Public License diff --git a/src/cljs/youyesyet/views/building.cljs b/src/cljs/youyesyet/canvasser_app/views/building.cljs similarity index 61% rename from src/cljs/youyesyet/views/building.cljs rename to src/cljs/youyesyet/canvasser_app/views/building.cljs index 01d3dd6..5e9e935 100644 --- a/src/cljs/youyesyet/views/building.cljs +++ b/src/cljs/youyesyet/canvasser_app/views/building.cljs @@ -1,9 +1,12 @@ -(ns youyesyet.views.building - (:require [re-frame.core :refer [reg-sub]])) +(ns ^{:doc "Canvasser app households in building panel." + :author "Simon Brooke"} + youyesyet.canvasser-app.views.building + (:require [re-frame.core :refer [reg-sub subscribe]] + [youyesyet.canvasser-app.ui-utils :as ui])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; -;;;; youyesyet.views.building: building view for youyesyet. +;;;; youyesyet.canvasser-app.views.building: building view for youyesyet. ;;;; ;;;; This program is free software; you can redistribute it and/or ;;;; modify it under the terms of the GNU General Public License @@ -28,10 +31,22 @@ ;;; The pattern from the re-com demo (https://github.com/Day8/re-com) is to have ;;; one source file/namespace per view. Each namespace contains a function 'panel' ;;; whose output is an enlive-style specification of the view to be redered. -;;; I propose to follow this pattern. This file will (eventually) provide the building view. - +;;; I propose to follow this pattern. This file will provide the building view. (defn panel "Generate the building panel." [] - []) + (let [address @(subscribe [:address]) + dwellings (:dwellings address)] + [:div + [:h1 (str "Flats at " (:address address))] + [:div.container {:id "main-container"} + (ui/back-link) + [:div {:id "dwelling-list"} + (map + (fn + [dwelling] + (ui/big-link + (:sub-address dwelling) + (str "#/electors/" (:id dwelling))) ) + (:dwellings address))]]])) diff --git a/src/cljs/youyesyet/views/electors.cljs b/src/cljs/youyesyet/canvasser_app/views/electors.cljs similarity index 85% rename from src/cljs/youyesyet/views/electors.cljs rename to src/cljs/youyesyet/canvasser_app/views/electors.cljs index 05f7af4..482d21a 100644 --- a/src/cljs/youyesyet/views/electors.cljs +++ b/src/cljs/youyesyet/canvasser_app/views/electors.cljs @@ -1,11 +1,13 @@ -(ns youyesyet.views.electors +(ns ^{:doc "Canvasser app electors in household panel." + :author "Simon Brooke"} + youyesyet.canvasser-app.views.electors (:require [reagent.core :refer [atom]] [re-frame.core :refer [reg-sub subscribe dispatch]] - [youyesyet.ui-utils :as ui])) + [youyesyet.canvasser-app.ui-utils :as ui])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; -;;;; youyesyet.views.electors: electors view for youyesyet. +;;;; youyesyet.canvasser-app.views.electors: electors view for youyesyet. ;;;; ;;;; This program is free software; you can redistribute it and/or ;;;; modify it under the terms of the GNU General Public License @@ -30,7 +32,7 @@ ;;; The pattern from the re-com demo (https://github.com/Day8/re-com) is to have ;;; one source file/namespace per view. Each namespace contains a function 'panel' ;;; whose output is an enlive-style specification of the view to be redered. -;;; I propose to follow this pattern. This file will (eventually) provide the electors view. +;;; I propose to follow this pattern. This file will provide the electors view. ;;; See https://github.com/simon-brooke/youyesyet/blob/master/doc/specification/userspec.md#electors-view @@ -105,14 +107,16 @@ (defn panel "Generate the electors panel." [] - (let [address @(subscribe [:address]) - addresses @(subscribe [:addresses]) - electors (sort-by :id (:electors address)) - options @(subscribe [:options]) - changes @(subscribe [:changes])] + (let [dwelling @(subscribe [:dwelling]) + address @(subscribe [:address]) + sub-address (:sub-address dwelling) + electors (sort-by :id (:electors dwelling)) + options @(subscribe [:options])] (if address [:div - [:h1 (:address address)] + [:h1 (if sub-address + (str sub-address ", " (:address address)) + (:address address))] [:div.container {:id "main-container"} [:table [:tbody diff --git a/src/cljs/youyesyet/views/followup.cljs b/src/cljs/youyesyet/canvasser_app/views/followup.cljs similarity index 92% rename from src/cljs/youyesyet/views/followup.cljs rename to src/cljs/youyesyet/canvasser_app/views/followup.cljs index 78c0c04..b81ff58 100644 --- a/src/cljs/youyesyet/views/followup.cljs +++ b/src/cljs/youyesyet/canvasser_app/views/followup.cljs @@ -1,10 +1,12 @@ -(ns youyesyet.views.followup +(ns ^{:doc "Canvasser followup request form panel." + :author "Simon Brooke"} + youyesyet.canvasser-app.views.followup (:require [re-frame.core :refer [reg-sub subscribe dispatch]] - [youyesyet.ui-utils :as ui])) + [youyesyet.canvasser-app.ui-utils :as ui])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; -;;;; youyesyet.views.followup-request: followup-request view for youyesyet. +;;;; youyesyet.canvasser-app.views.followup-request: followup-request view for youyesyet. ;;;; ;;;; This program is free software; you can redistribute it and/or ;;;; modify it under the terms of the GNU General Public License diff --git a/src/cljs/youyesyet/views/issue.cljs b/src/cljs/youyesyet/canvasser_app/views/issue.cljs similarity index 88% rename from src/cljs/youyesyet/views/issue.cljs rename to src/cljs/youyesyet/canvasser_app/views/issue.cljs index 20620d6..34afe10 100644 --- a/src/cljs/youyesyet/views/issue.cljs +++ b/src/cljs/youyesyet/canvasser_app/views/issue.cljs @@ -1,8 +1,10 @@ -(ns youyesyet.views.issue +(ns ^{:doc "Canvasser app current issue detail panel." + :author "Simon Brooke"} + youyesyet.canvasser-app.views.issue (:require [re-frame.core :refer [reg-sub subscribe]] [markdown.core :refer [md->html]] - [youyesyet.ui-utils :as ui] - [youyesyet.views.issues :as issues])) + [youyesyet.canvasser-app.ui-utils :as ui] + [youyesyet.canvasser-app.views.issues :as issues])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; diff --git a/src/cljs/youyesyet/views/issues.cljs b/src/cljs/youyesyet/canvasser_app/views/issues.cljs similarity index 84% rename from src/cljs/youyesyet/views/issues.cljs rename to src/cljs/youyesyet/canvasser_app/views/issues.cljs index ea8f383..8b2ca47 100644 --- a/src/cljs/youyesyet/views/issues.cljs +++ b/src/cljs/youyesyet/canvasser_app/views/issues.cljs @@ -1,10 +1,12 @@ -(ns youyesyet.views.issues +(ns ^{:doc "Canvasser app current issues list panel." + :author "Simon Brooke"} + youyesyet.canvasser-app.views.issues (:require [re-frame.core :refer [reg-sub subscribe]] - [youyesyet.ui-utils :as ui])) + [youyesyet.canvasser-app.ui-utils :as ui])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; -;;;; youyesyet.views.issues: issues view for youyesyet. +;;;; youyesyet.canvasser-app.views.issues: issues view for youyesyet. ;;;; ;;;; This program is free software; you can redistribute it and/or ;;;; modify it under the terms of the GNU General Public License @@ -29,7 +31,7 @@ ;;; The pattern from the re-com demo (https://github.com/Day8/re-com) is to have ;;; one source file/namespace per view. Each namespace contains a function 'panel' ;;; whose output is an enlive-style specification of the view to be redered. -;;; I propose to follow this pattern. This file will (eventually) provide the issues view. +;;; I propose to follow this pattern. This file will provide the issues view. ;;; See https://github.com/simon-brooke/youyesyet/blob/master/doc/specification/userspec.md#issues-view diff --git a/src/cljs/youyesyet/views/map.cljs b/src/cljs/youyesyet/canvasser_app/views/map.cljs similarity index 92% rename from src/cljs/youyesyet/views/map.cljs rename to src/cljs/youyesyet/canvasser_app/views/map.cljs index c725531..a0a7097 100644 --- a/src/cljs/youyesyet/views/map.cljs +++ b/src/cljs/youyesyet/canvasser_app/views/map.cljs @@ -1,10 +1,12 @@ -(ns youyesyet.views.map +(ns ^{:doc "Canvasser app map view panel." + :author "Simon Brooke"} + youyesyet.canvasser-app.views.map (:require [re-frame.core :refer [reg-sub subscribe dispatch]] [reagent.core :as reagent])) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; ;;;; -;;;; youyesyet.views.map: map view for youyesyet. +;;;; youyesyet.canvasser-app.views.map: map view for youyesyet. ;;;; ;;;; This program is free software; you can redistribute it and/or ;;;; modify it under the terms of the GNU General Public License @@ -55,7 +57,14 @@ (defn pin-image "select the name of a suitable pin image for this address" [address] - (let [intentions (set (remove nil? (map #(:intention %) (:electors address))))] + (let [intentions + (set + (remove + nil? + (map + #(:intention %) + (map :electors + (:dwellings address)))))] (case (count intentions) 0 "unknown-pin" 1 (str (name (first intentions)) "-pin") @@ -68,7 +77,7 @@ so back links work." [id] (js/console.log (str "Click handler for address #" id)) - (set! window.location.href (str "#electors/" id))) + (set! window.location.href (str "#building/" id))) ;; This way is probably more idiomatic React, but history doesn't work: ;; (defn map-pin-click-handler ;; [id] diff --git a/src/cljs/youyesyet/db.cljs b/src/cljs/youyesyet/db.cljs deleted file mode 100644 index 9659c44..0000000 --- a/src/cljs/youyesyet/db.cljs +++ /dev/null @@ -1,79 +0,0 @@ -(ns youyesyet.db) - -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -;;;; -;;;; youyesyet.db: the state of the app. -;;;; -;;;; 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 2 -;;;; 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, write to the Free Software -;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, -;;;; USA. -;;;; -;;;; Copyright (C) 2016 Simon Brooke for Radical Independence Campaign -;;;; -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; - -;;; This is the constructor for the atom in which the state of the user interface is held. -;;; The atom gets updated by 'events' registered in handler.cljs, q.v. -;;; -;;; not wonderfully happy with 'db' as a name for this namespace; will probably change to -;;; 'client-state'. - -(def default-db - {;;; the currently selected address, if any. - :address {:id 1 :address "13 Imaginary Terrace, IM1 3TE" :latitude 55.8253043 :longitude -4.2569057 - :electors [{:id 1 :name "Alan Anderson" :gender :male :intention :no} - {:id 2 :name "Ann Anderson" :gender :female} - {:id 3 :name "Alex Anderson" :gender :fluid :intention :yes} - {:id 4 :name "Andy Anderson" :intention :yes}]} - ;;; a list of the addresses in the current location at which there - ;;; are electors registered. - :addresses [{:id 1 :address "13 Imaginary Terrace, IM1 3TE" :latitude 55.8253043 :longitude -4.2570944 - :electors [{:id 1 :name "Alan Anderson" :gender :male :intention :no} - {:id 2 :name "Ann Anderson" :gender :female} - {:id 3 :name "Alex Anderson" :gender :fluid :intention :yes} - {:id 4 :name "Andy Anderson" :intention :yes}]} - {:id 2 :address "15 Imaginary Terrace, IM1 3TE" :latitude 55.8252354 :longitude -4.2572778 - :electors [{:id 1 :name "Beryl Brown" :gender :female} - {:id 2 :name "Betty Black" :gender :female}]} - {:id 3 :address "17 Imaginary Terrace, IM1 3TE" :latitude 55.825166 :longitude -4.257026 - :electors [{:id 1 :name "Catriona Crathie" :gender :female :intention :yes} - {:id 2 :name "Colin Caruthers" :gender :male :intention :yes} - {:id 3 :name "Calum Crathie" :intention :yes}]} - {:id 4 :address "19 Imaginary Terrace, IM1 3TE" :latitude 55.82506950000001 :longitude -4.2570239 - :electors [{:id 1 :name "David Dewar" :gender :male :intention :no}]}] - ;;; electors at the currently selected address - :electors [{:id 1 :name "Alan Anderson" :gender :male :intention :no} - {:id 2 :name "Ann Anderson" :gender :female} - {:id 3 :name "Alex Anderson" :gender :fluid :intention :yes} - {:id 4 :name "Andy Anderson" :intention :yes}] - ;;; any error to display - :error nil - ;;; the issue from among the issues which is currently selected. - ;;; any confirmation message to display - :feedback nil - ;;; the currently selected issue - :issue "Currency" - ;;; the issues selected for the issues page on this day. - :issues {"Currency" "Scotland could keep the Pound, or use the Euro. But we could also set up a new currency of our own. Yada yada yada" - "Monarchy" "Scotland could keep the Queen. This is an issue to be decided after independence. Yada yada yada" - "Defence" "Scotland will not have nuclear weapons, and will probably not choose to engage in far-off wars. But we could remain members of NATO"} - ;;; message of the day - :motd "This is a test version only. There is no real data." - ;;; the options from among which electors can select. - :options [{:id :yes :description "Yes"} {:id :no :description "No"}] - ;;; the queue of items waiting to be transmitted. - :outqueue () - ;;; the currently displayed page within the app. - :page :home - }) diff --git a/test/cljs/youyesyet/core_test.cljs b/test/cljs/youyesyet/canvasser_app/core_test.cljs similarity index 65% rename from test/cljs/youyesyet/core_test.cljs rename to test/cljs/youyesyet/canvasser_app/core_test.cljs index 7de65c8..d0f5e40 100644 --- a/test/cljs/youyesyet/core_test.cljs +++ b/test/cljs/youyesyet/canvasser_app/core_test.cljs @@ -1,7 +1,7 @@ -(ns youyesyet.core-test +(ns youyesyet.canvasser-app.core-test (:require [cljs.test :refer-macros [is are deftest testing use-fixtures]] [reagent.core :as reagent :refer [atom]] - [youyesyet.core :as rc])) + [youyesyet.canvasser-app.core :as rc])) (deftest test-home (is (= true true))) diff --git a/test/cljs/youyesyet/canvasser_app/doo_runner.cljs b/test/cljs/youyesyet/canvasser_app/doo_runner.cljs new file mode 100644 index 0000000..f6c89dd --- /dev/null +++ b/test/cljs/youyesyet/canvasser_app/doo_runner.cljs @@ -0,0 +1,6 @@ +(ns youyesyet.canvasser-app.doo-runner + (:require [doo.runner :refer-macros [doo-tests]] + [youyesyet.canvasser-app.core-test])) + +(doo-tests 'youyesyet.canvasser-app.canvasser-app.core-test) + diff --git a/test/cljs/youyesyet/doo_runner.cljs b/test/cljs/youyesyet/doo_runner.cljs deleted file mode 100644 index 486a282..0000000 --- a/test/cljs/youyesyet/doo_runner.cljs +++ /dev/null @@ -1,6 +0,0 @@ -(ns youyesyet.doo-runner - (:require [doo.runner :refer-macros [doo-tests]] - [youyesyet.core-test])) - -(doo-tests 'youyesyet.core-test) -