Merge pull request #83 from nzzdev/release-3.0.0

Release 3.0.0
nzzdev · Nov 27, 2017 · 593ca59 · 593ca59
2 parents 4334aa0 + d87eaec
commit 593ca59
Show file tree

Hide file tree

Showing 76 changed files with 10,714 additions and 3,355 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,40 @@
+defaults: &defaults
+  working_directory: ~/q-server
+  docker:
+    - image: circleci/node:9
+
+version: 2
+jobs:
+  build:
+    <<: *defaults
+
+    steps:
+      - run:
+          name: "Installing headless chrome dependencies"
+          command: sudo apt-get update && sudo apt-get install -yq gconf-service libasound2 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 ca-certificates fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils wget
+
+      - run:
+          name: "Checking Versions"
+          command: |
+            node --version
+            npm --version
+
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "package-lock.json" }}
+
+      - run: 
+          name: "install dependencies"
+          command: npm install
+
+      - run: 
+          name: test
+          command: npm run test
+
+      - save_cache:
+          key: v1-dependencies-{{ checksum "package-lock.json" }}
+          paths:
+            - node_modules
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 node_modules
 .vscode
-.DS_Store
+.DS_Store
+
+test/logs/pouchdb.log
diff --git a/.nvmrc b/.nvmrc
@@ -0,0 +1 @@
+9
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,13 +1,16 @@
 # Q Server
 
-__Q__ is a system that lets journalists create visual elements for stories. It is developed by [NZZ Storytelling](https://www.nzz.ch/storytelling) and used in the [NZZ](https://www.nzz.ch) newsroom.
+__Q__ is a system that lets journalists create visual elements for stories. It is developed by [NZZ Storytelling](https://www.nzz.ch/storytelling) and used in the [NZZ](https://www.nzz.ch) newsroom. There is a Demo over here: https://q-demo.st.nzz.ch
 
 This is the server for the Q Toolbox. To make use of Q server you will also need a [Q editor](https://github.com/nzzdev/Q-editor/).
 
-Demo: https://q-demo.st.nzz.ch
-
 Documentation: https://nzzdev.github.io/Q-server
 
+## Development
+### Tests
+There is a 100% coverage aim with the tests. Please do not lower the coverage.
+The tests use `pouchdb-server` to mock the database and implement a simple mock tool endpoint. This makes e2e testing completely self contained without the need for any external services running. Just do a `npm install` and then `npm run test` and you are good to go. There are e2e tests in `test/e2e-tests.js` and some unit tests in `test/unit-tests.js`.
+
 ## License
 Copyright (c) 2017 Neue Zürcher Zeitung. All rights reserved.
 

diff --git a/auth/couchdb-cookie/plugins.js b/auth/couchdb-cookie/plugins.js
diff --git a/auth/couchdb-cookie/routes.js b/auth/couchdb-cookie/routes.js
diff --git a/auth/couchdb-cookie/state.js b/auth/couchdb-cookie/state.js
diff --git a/auth/couchdb-cookie/strategy.js b/auth/couchdb-cookie/strategy.js
diff --git a/db.js b/db.js
diff --git a/defaults/misc.js b/defaults/misc.js
diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml
@@ -9,7 +9,5 @@ main:
     url: rendering-info.html
   - title: "toolRuntimeConfig"
     url: tool-runtime-config.html
-  - title: "Plugins"
-    url: "plugins.html"
   - title: "Migrations"
     url: "migrations.html"
diff --git a/docs/about-targets.md b/docs/about-targets.md
@@ -8,9 +8,8 @@ So, in a nutshell we have to deal with two groups of target specifics.
 -  __Technology related specifics__: your targets are different applications which can interpret markup or not
 
 ## Styling related specifics
-For each tool - target - environment combination styles can be configured in _config/tools.js_ of your Q server implementation. That can be done either:
-- by specifying a `url` or
-- by specifying a string with the styles in `content`
+For each tool - target - environment combination additional [rendering info](rendering-info.html) can be configured in the config passed as `app.tools` to `Hapi.server()`. We use _config/tools.js_ for this. See our [demo implementation](https://github.com/nzzdev/Q-server-demo) for details.
+This `additionalRenderingInfo` object will be merged with the object returned from the defined endpoint of the tool before getting sent back to the client. We use this to apply the stylesheets of our styleguide system to theme the rendered output for different publications.
 
 ```javascript
 const tools = {