Merge pull request #79 from lookback/feature/tests

- [x] Adds package tests for `Mailer`. Just to check for existence of `Mailer` object for now.
- [x] Sets up `example` app for testing in app testing mode. Checks if an email renders with data.
- [x] Use ES6 modules.
- [x] Runs tests on CircleCI.
- [x] Updates example (and now also test app) to Meteor 1.4.2.

Author: johanbrook

.eslintrc

@@ -3,14 +3,10 @@
 
   "globals": {
     "Mailer": true,
-    "Utils": true,
     "juice": false,
     "FlowRouter": false,
     "Router": false,
-    "TemplateHelpers": true,
     "SSR": false,
-    "Picker": false,
-    "Routing": true,
-    "Templates": true
+    "Picker": false
   }
 }

Makefile

@@ -0,0 +1,19 @@
+PORT=3100
+TEST_DRIVER=dispatch:mocha
+
+lint:
+	@./node_modules/.bin/eslint .
+
+test-package:
+	@meteor test-packages ./ --driver-package $(TEST_DRIVER) --once --port $(PORT)
+
+test-app:
+	@cd example && npm test -- --port $(PORT) && cd -
+
+test-app-watch:
+	@cd example && npm run test:watch -- --port $(PORT)
+
+test-watch:
+	@TEST_WATCH=1 meteor test-packages ./ --driver-package $(TEST_DRIVER) --port $(PORT)
+
+.PHONY: test, test-watch

README.md

@@ -1,5 +1,7 @@
 # Meteor Emails
 
+[![CircleCI](https://circleci.com/gh/lookback/meteor-emails.svg?style=shield)](https://circleci.com/gh/lookback/meteor-emails)
+
 `lookback:emails` is a Meteor package that makes it easier to build, test and debug rich HTML emails.
 
 Usually, building HTML emails yourself is tedious. On top of that, add the need for data integration and thus a template language (for sending out daily digest emails, for instance). We wanted a way to preview the email in the browser *with real data* in order to quickly iterate on the design, instead of alternating between code editor and email client.
@@ -562,22 +564,40 @@ route: {
 
 PRs and help is welcomed.
 
-## Develop
+### Develop
 
 Clone repo, and run:
 
 ```
 npm install
 ```
 
-to install dev dev dependencies. We're using ESLint for linting.
+to install dev dev dependencies. We're using ESLint for linting. Lint with:
+
+```
+npm run lint
+```
+
+Run tests with:
+
+```
+npm test
+```
+
+or have test watching with:
+
+```
+npm run test:watch
+```
+
+You'll find tests in the `lib` directory along with the source files.
 
-## Things to do
+### Things to do
 
 - [ ] Tests.
 
 Also see [open issues](https://github.com/lookback/meteor-emails/issues).
 
 ***
 
-Made by [Lookback](http://github.com/lookback)
+Made by [Johan](http://johanbrook.com) in [Lookback](http://github.com/lookback)

circle.yml

@@ -0,0 +1,17 @@
+machine:
+  node:
+    version: 5.8.0
+
+dependencies:
+  cache_directories:
+    - "~/.meteor"
+    - "~/.npm"
+  override:
+    # -- CACHE METEOR --
+    # Restore the meteor symlink
+    - if [ -d ~/.meteor ]; then sudo ln -s ~/.meteor/meteor /usr/local/bin/meteor; fi
+    # Install Meteor (if not restored from cache)
+    - if [ ! -e ~/.meteor/meteor ]; then curl https://install.meteor.com | /bin/sh; fi
+    - npm install --no-progress
+    - meteor npm install --no-progress:
+        pwd: example

example/.meteor/.finished-upgraders

@@ -11,3 +11,5 @@ notices-for-facebook-graph-api-2
 1.2.0-cordova-changes
 1.2.0-breaking-changes
 1.3.0-split-minifiers-package
+1.4.0-remove-old-dev-bundle-link
+1.4.1-add-shell-server-package

example/.meteor/packages

@@ -4,14 +4,18 @@
 # 'meteor add' and 'meteor remove' will edit this file for you,
 # but you can also edit it by hand.
 
-ecmascript
+ecmascript@0.5.9
 lookback:emails
 #chrisbutler:[email protected]
-meteor-base
+meteor-base@1.0.4
 blaze-html-templates
-reload
+reload@1.1.11
 spacebars
 kadira:flow-router
 #iron:router
-standard-minifier-css
-standard-minifier-js
+[email protected]
+[email protected]
+
+practicalmeteor:chai
+dispatch:mocha
+shell-server

example/.meteor/release

@@ -1 +1 @@
-[email protected].1.1
+[email protected].2

example/.meteor/versions

@@ -1,69 +1,76 @@
 [email protected]
-[email protected]
-[email protected]
-[email protected]_1
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]_1
-[email protected]
-[email protected]
-[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
 [email protected]
-[email protected].8_1
-[email protected].6
-[email protected].8_1
+[email protected].9
+[email protected].7
+[email protected].10
 [email protected]
-[email protected]
-[email protected]_1
-[email protected]_1
-[email protected]
-[email protected]_1
-[email protected]
+[email protected]
+dispatch:[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
 [email protected]
-[email protected].10
-[email protected].10
-[email protected].7
-[email protected].8
-[email protected].9
+[email protected].11
+[email protected].11
+[email protected].8
+[email protected].9
+[email protected].10
 kadira:[email protected]
 [email protected]
-[email protected].13_1
+[email protected].14
 lookback:[email protected]
-meteor@1.1.15_1
+meteor@1.6.0
 [email protected]
 meteorhacks:[email protected]
 meteorhacks:[email protected]
-minifier-css@1.1.12_1
-minifier-js@1.1.12_1
-[email protected].17
-modules@0.6.4
-modules-runtime@0.6.4_1
+minifier-css@1.2.15
+minifier-js@1.2.15
+[email protected].18
+modules@0.7.7
+modules-runtime@0.7.7
 [email protected]_1
-[email protected]
-[email protected]_1
-[email protected]
-[email protected]
-[email protected]_1
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+practicalmeteor:[email protected]_1
+practicalmeteor:[email protected]
+[email protected]
 [email protected]
 [email protected]
-[email protected].10
-[email protected].10
-[email protected].8
+[email protected].11
+[email protected].11
+[email protected].9
 [email protected]
 sacha:[email protected]
-[email protected]
-[email protected]
-[email protected]_1
-[email protected]_1
-[email protected]_1
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]_1
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
 [email protected]

example/package.json

@@ -2,7 +2,8 @@
   "name": "example",
   "version": "1.0.0",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "meteor test --driver-package dispatch:mocha --once --full-app",
+    "test:watch": "TEST_WATCH=1 meteor test --port 5012 --driver-package dispatch:mocha --full-app"
   },
   "author": "Johan Brook",
   "license": "MIT",

example/packages/lookback:emails example/packages/emails

@@ -1,4 +1,4 @@
-TemplateHelpers = {
+export default {
 
   enumerate(arr, limit, oxfordComma) {
     if (arr) {
@@ -24,7 +24,7 @@ TemplateHelpers = {
       let suffix = ' and ';
 
       if (oxfordComma === true
-        || (typeof oxfordComma === 'number' && length >= oxfordComma)) {
+        || typeof oxfordComma === 'number' && length >= oxfordComma) {
         suffix = `, ${suffix}`;
       }
 

example/server/lib/template-helpers.js

@@ -1,22 +1,20 @@
-Templates = {};
+export default {
+  sample: {
+    path: 'sample-email/template.html',    // Relative to the 'private' dir.
+    scss: 'sample-email/style.scss',       // Mail specific SCSS.
 
-Templates.sample = {
-  path: 'sample-email/template.html',    // Relative to the 'private' dir.
-  scss: 'sample-email/style.scss',       // Mail specific SCSS.
+    helpers: {
+      capitalizedName() {
+        return this.name.charAt(0).toUpperCase() + this.name.slice(1);
+      }
+    },
 
-  helpers: {
-    capitalizedName() {
-      return this.name.charAt(0).toUpperCase() + this.name.slice(1);
-    }
-  },
-
-  route: {
-    path: '/sample/:name',
-    data: function(params) {
-      return {
+    route: {
+      path: '/sample/:name',
+      data: (params) => ({
         name: params.name,
         names: ['Johan', 'John', 'Paul', 'Ringo']
-      };
+      })
     }
   }
 };

example/server/lib/templates.js

@@ -0,0 +1,29 @@
+/* eslint-env mocha */
+import { Mailer } from 'meteor/lookback:emails';
+import { assert } from 'meteor/practicalmeteor:chai';
+
+describe('Render email', () => {
+
+  it('should render an email', () => {
+    const string = Mailer.render('sample', {
+      name: 'johan',
+      names: ['Johan', 'John', 'Paul', 'Ringo']
+    });
+
+    assert.isString(string);
+    assert.match(string, new RegExp('<h2>Hi Johan', 'gm'), 'includes heading with capitalized name');
+  });
+
+  it('should render with a layout', () => {
+    const searchFor = 'Paul is dead';
+
+    const string = Mailer.render('sample', {
+      name: 'johan',
+      names: ['Johan', 'John', 'Paul', 'Ringo'],
+      preview: searchFor
+    });
+
+    assert.isString(string);
+    assert.match(string, new RegExp(`<title>${searchFor}</title>`, 'gm'), 'includes a <title> element from layout.html');
+  });
+});

example/server/server.app-test.js

@@ -1,3 +1,6 @@
+import TemplateHelpers from './lib/template-helpers';
+import Templates from './lib/templates';
+
 if (!process.env.MAIL_URL) {
   process.env.MAIL_URL = Meteor.settings.MAIL_URL;
 }

example/server/server.js

@@ -0,0 +1,3 @@
+import { Mailer as theModule } from './lib/mailer';
+
+Mailer = theModule;

export.js

@@ -5,6 +5,9 @@
 // See the [GitHub repo](https://github.com/lookback/meteor-emails) for README.
 // Made by Johan Brook for [Lookback](https://github.com/lookback).
 
+import RoutingMiddleware from './routing';
+import TemplateHelpers from './template-helpers';
+import Utils from './utils';
 
 const TAG = 'mailer';
 
@@ -19,7 +22,7 @@ const TAG = 'mailer';
 // - `disabled`, optionally disable the actual email sending. Useful for E2E testing.
 //    Defaults to `false`.
 // - `addRoutes`, should we add preview and send routes? Defaults to `true` in development.
-Mailer = {
+export const Mailer = {
   settings: {
     silent: false,
     routePrefix: 'emails',
@@ -300,7 +303,7 @@ Mailer.init = function(opts) {
   const obj = _.extend(this, factory(opts));
 
   if (obj.settings.addRoutes) {
-    obj.use(Routing);
+    obj.use(RoutingMiddleware);
   }
 
   obj.init();