mails 0.0.2 → 0.2.0

package/.npmignore

@@ -1,8 +1,6 @@
 .DS_*
 node_modules
 *.sublime*
-psd
 thumb
 *.log
-theme
-demo
+tests

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 turing
+Copyright (c) 2013 turing <o.u.turing@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.en.md

@@ -1,75 +1,72 @@
 ## ![logo](http://ww2.sinaimg.cn/large/61ff0de3gw1eajmy0wdikj2014014wea.jpg) mails ![npm](https://badge.fury.io/js/mails.png)
 
-send beautiful emails made easy, with responsive templates built in.
+Send beautiful emails made easy, with responsive templates built in.
 
-mails supports [ink](http://zurb.com/ink) responsive email template now!
+Mails supports [ink](http://zurb.com/ink) responsive email template now!
 
 ### Installation
-````
+```bash
 $ npm install mails
-````
+```
 
 ### Example
-````javascript
+```js
 var mails = require('mails');
 
-// use built in templates
+// Use built in templates
 mail.render('basic', {
-    name: 'mySite',
-    banner: 'http://mysite.com/banner.jpg'
+  name: 'mySite',
+  banner: 'http://mysite.com/banner.jpg'
 }, function(err,html){
-    if (!err) {
-        console.log(html);
-    } else {
-        console.log(err);
-    }
+  if (!err) {
+    console.log(html);
+  } else {
+    console.log(err);
+  }
 });
-````
+```
 ### Built-in themes
-mails supports several kinds of themes, they are:
+Mails supports several kinds of themes, they are:
 
 - ink themes:
-    - basic
-    - hero
-    - newsletter
-    - sidebar
-    - sidebar-hero
+  - basic
+  - hero
+  - newsletter
+  - sidebar
+  - sidebar-hero
 - mails theme:
-    - one
+  - one
 
 #### built-in theme useage:
-````javascript
+```js
 var mails = require('mails');
 
 mails.render('basic', {
-    name: 'mySite',
-    banner: 'http://mysite.com/banner.jpg'
+  name: 'mySite',
+  banner: 'http://mysite.com/banner.jpg'
 }, function(err, html){
-    // do sth.
+  // do sth.
 });
-````
+```
 #### built-in theme variables:
-take a look:
+Take a look:
 (screenshots coming soon...)
 
 ### Templates as NPM modules
-you can also push templates as NPM modules, like this:
-````javascript
+You can also push templates as NPM modules, like this:
+```js
 var mails = require('mails');
 
-// using templates named `single` under module `mails-mailmao`
+// Using templates named `single` under module `mails-mailmao`
 mails.render('mails-mailmao/single', {
     name: 'mySite',
     banner: 'http://mysite.com/banner.jpg'
 }, function(err, html){
     // do sth.
 });
-````
+```
 please feel free to publish your templates to NPM.
 
-### API
-check this file: `index.js`
-
 ### Contributing
 - Fork this repo
 - Clone your repo
@@ -80,7 +77,7 @@ check this file: `index.js`
 - Open a pull request, and enjoy <3
 
 ### MIT license
-Copyright (c) 2013 turing
+Copyright (c) 2013 turing &lt;o.u.turing@gmail.com&gt;
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -100,7 +97,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
-
 ---
 ![docor](https://cdn1.iconfinder.com/data/icons/windows8_icons_iconpharm/26/doctor.png)
 generated using [docor](https://github.com/turingou/docor.git) @ 0.1.0. brought to you by [turingou](https://github.com/turingou)

package/README.md

@@ -1,68 +1,62 @@
-## ![logo](http://ww2.sinaimg.cn/large/61ff0de3gw1eajmy0wdikj2014014wea.jpg) mails ![npm](https://badge.fury.io/js/mails.png)
+## ![Mails](http://ww2.sinaimg.cn/large/61ff0de3gw1eajmy0wdikj2014014wea.jpg) mails ![npm](https://badge.fury.io/js/mails.png)
 
-使用 mails，让发送邮件变得更简单与优雅，mails 志在解决设计邮件模板时代码复用率低，终端兼容情况不佳等问题。
+Mails 使发送邮件变得更简单与优雅，提高模板复用率。
 
-你既可以使用 mails 内建的标准模板来发送邮件，也可以快速发布自己的邮件主题。mails 内建的标准邮件模板由 [ink](http://zurb.com/ink) 改造而来，二次开发友好，并且对各个终端的兼容表现优秀，稍作修改，亦可以适配智能手机等小屏幕终端。
+使用 Mails 内建的标准模板 `mails-default` 来发送邮件，或者快速发布自己的邮件主题，Mails 推荐您把邮件主题发布到 NPM
+
+Mails 内建的标准邮件模板由 [Ink](http://zurb.com/ink) 改造而来，对二次开发表现友好，也对各个终端的兼容表现优秀。稍作修改，亦可以适配智能手机等小屏幕终端。
 
 ### 如何安装
-````
-$ npm install mails
-````
+```bash
+$ npm install mails --save
+```
 
 ### 快速指引
 
-mails 包括三个部分：
+Mails 包括三个部分：
 
-- 一个邮件模板加载器  
+- 一个邮件模板加载器
 - 一个支持实时编辑（live reload）的邮件模板设计工具（CLI）  
 - 一个快速生成邮件主题项目文件的脚手架工具（CLI）  
 
-如果你是邮件主题开发者，希望分享自己的主题，或者将他们发布到 NPM，你可能会想要使用到第二个与第三个工具；如果你只是使用 mails 发送邮件的程序员，并不需要了解后两者如何运作，只需了解API的使用方法即可：
+如果你是邮件主题开发者，希望分享自己的主题，或者将他们发布到 NPM，你可能会想要使用到第二个与第三个工具；
+如果你只是使用 mails 发送邮件的程序员，并不需要了解后两者如何运作，只需了解API的使用方法即可：
 
 ### 范例代码
 最快上手使用 mails，我们来看一段渲染邮件的代码：
-````javascript
-var mails = require('mails'); // 引用 mails
-
-// 使用 basic 别名加载邮件模板，并填入对应的变量:
-mail.render('basic', {
-    name: 'mySite',
-    banner: 'http://mysite.com/banner.jpg'
-}, function(err,html){
-    // 得到最终的邮件 html 代码
-    if (!err) {
-        console.log(html);
-    } else {
-        console.log(err);
-    }
-});
-````
-### 内建邮件主题
-mails 内建邮件主题包括以下几种，各个邮件的变量列表请查阅 `templates/*.html` 各个模板文件：
-
-- basic
-- hero
-- newsletter
-- sidebar
-- sidebar-hero
+```js
+import mails from 'mails'
+
+// 使用 mails-default/basic 别名渲染邮件模板，并填入对应的变量:
+mails.render('basic', {
+  name: 'The First Email To You',
+  banner: 'http://mysite.com/banner.jpg'
+}).then(function(html){
+  console.log(html) // 得到最终的邮件 html 代码
+}).catch(err => {
+  console.log(err)
+})
+```
 
 ### 加载 NPM 模块作为主题
-你可以将 mails 提供的标准邮件主题进行简单的二次开发，然后发布到 npm 作为您的邮件主题，使他人获益。
+你可以将 mails 提供的标准邮件主题进行简单的二次开发，然后发布到 NPM 作为您的邮件主题，使他人获益。
 
 在这个例子中，我们使用 `mails-flat` 模块中的 `message` 主题进行邮件渲染：
-````javascript
-var mails = require('mails');
+```js
+import mails from 'mails'
+
+mails.render('mails-flat/message', {})
+  .then(function(html) {
+    console.log(html)
+  })
+```
 
-mails.render('mails-flat/message', { ...... }, function(err, html){
-    console.log(html);
-});
-````
 #### 如何进行主题的二次开发
 
-1. 首先，将 mails 作为全局模块安装：
+1. 首先，将 mails-cli 作为全局模块安装：
 
 ````
-$ [sudo] npm install mails -g
+$ npm install mails-cli -g
 ````
 
 2. 建立新项目文件夹，初始化邮件主题：
@@ -76,23 +70,26 @@ $ mails init
 
 ````
 $ vi ./package.json
-$ { "view engine": "swig" }
+$ { "view engine": "swig" } // 比如使用swig作为模板引擎
 ````
 
 4. 使用 live reload 设计工具进行开发
 
 ````
-$ mails watch ./package.json 
+// ./package.json 也是存放模板变量的文件
+$ mails watch ./package.json [-p] [port] 
+````
+使用 mails 提供的 live reload 工具进行开发，程序会监听当前文件夹下文件的变动，包括样式表文件，模板文件和提供模板变量的 json 文件。打开相应的端口服务，指定相应文件的url即可访问，比如：
+````
+$ GET http://localhost:3001/message.html
 ````
-
 
 #### 如何发布主题到 NPM
 在使用 `npm publish` 发布到社区之前，确认以下几项：
 - 确保你的项目中 `package.json` 符合 NPM 社区规范
 - 确保 `package.json` 文件中有 `view engine` 字段并且符合邮件模板引擎
-
-### API
-查看这个文件: `index.js`
+- 确保填写了相应的依赖模块名
+- 建议在 readme.md 中附上一张模板最终渲染效果的截图
 
 ### 贡献我的代码
 - Fork this repo
@@ -104,7 +101,7 @@ $ mails watch ./package.json
 - Open a pull request, and enjoy <3
 
 ### MIT license
-Copyright (c) 2013 turing
+Copyright (c) 2013 turing &lt;o.u.turing@gmail.com&gt;
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/render.js

@@ -0,0 +1,42 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+});
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { 'default': obj }; }
+
+var _juice = require('juice');
+
+var _juice2 = _interopRequireDefault(_juice);
+
+var _bluebird = require('bluebird');
+
+var _bluebird2 = _interopRequireDefault(_bluebird);
+
+var _pkghubRender = require('pkghub-render');
+
+/**
+ * 根据给定的主题名称或者文件名称渲染邮件
+ * @example
+ *   render('mails-flat/message', {...}).then(inlineHTML).catch(err)
+ */
+
+var _pkghubRender2 = _interopRequireDefault(_pkghubRender);
+
+exports['default'] = function (template) {
+  var data = arguments.length <= 1 || arguments[1] === undefined ? {} : arguments[1];
+
+  if (template.indexOf('/') === -1) template = 'mails-default/' + template;
+
+  return (0, _pkghubRender2['default'])(template, data).then(function (html) {
+    try {
+      return _bluebird2['default'].resolve((0, _juice2['default'])(html));
+    } catch (err) {
+      return _bluebird2['default'].reject(err);
+    }
+  });
+};
+
+module.exports = exports['default'];
+//# sourceMappingURL=render.js.map

package/dist/render.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../libs/render.js"],"names":[],"mappings":";;;;;;;;qBAAkB,OAAO;;;;wBACL,UAAU;;;;4BACX,eAAe;;;;;;;;;;qBAOnB,UAAS,QAAQ,EAAa;MAAX,IAAI,yDAAG,EAAE;;AACzC,MAAI,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAC9B,QAAQ,sBAAoB,QAAQ,AAAE,CAAA;;AAExC,SAAO,+BAAO,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,UAAA,IAAI,EAAI;AACzC,QAAI;AACF,aAAO,sBAAQ,OAAO,CAAC,wBAAM,IAAI,CAAC,CAAC,CAAA;KACpC,CAAC,OAAO,GAAG,EAAE;AACZ,aAAO,sBAAQ,MAAM,CAAC,GAAG,CAAC,CAAA;KAC3B;GACF,CAAC,CAAA;CACH","file":"render.js","sourcesContent":["import juice from 'juice'\nimport Promise from 'bluebird'\nimport render from 'pkghub-render'\n\n/**\n * 根据给定的主题名称或者文件名称渲染邮件\n * @example\n *   render('mails-flat/message', {...}).then(inlineHTML).catch(err)\n */\nexport default function(template, data = {}) {\n  if (template.indexOf('/') === -1)\n    template = `mails-default/${template}`\n\n  return render(template, data).then(html => {\n    try {\n      return Promise.resolve(juice(html))\n    } catch (err) {\n      return Promise.reject(err)\n    }\n  })\n}"]}

package/libs/render.js

@@ -0,0 +1,21 @@
+import juice from 'juice'
+import Promise from 'bluebird'
+import render from 'pkghub-render'
+
+/**
+ * 根据给定的主题名称或者文件名称渲染邮件
+ * @example
+ *   render('mails-flat/message', {...}).then(inlineHTML).catch(err)
+ */
+export default function(template, data = {}) {
+  if (template.indexOf('/') === -1)
+    template = `mails-default/${template}`
+
+  return render(template, data).then(html => {
+    try {
+      return Promise.resolve(juice(html))
+    } catch (err) {
+      return Promise.reject(err)
+    }
+  })
+}

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "mails",
-  "version": "0.0.2",
-  "description": "send beautiful emails made easy, with sexy templates built in.",
-  "main": "index.js",
-  "author": "turing",
+  "version": "0.2.0",
+  "description": "Send beautiful emails made easy with sexy built-in templates",
+  "main": "dist/mails.js",
+  "author": "turing <o.u.turing@Gmail.com>",
   "license": "MIT",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "node_modules/mocha/bin/mocha tests/*.js --require tests/babelhook",
+    "build": "node_modules/.bin/babel libs --out-dir dist --source-maps --watch"
   },
-  "bin": "./bin/cli",
   "repository": {
     "type": "git",
     "url": "https://github.com/turingou/mails.git"
@@ -22,11 +22,15 @@
     "url": "https://github.com/turingou/mails/issues"
   },
   "dependencies": {
-    "juice": "*",
-    "swig": "*",
-    "optimist": "*",
-    "consoler": "*",
-    "tao": "*",
-    "exeq": "*"
+    "bluebird": "^2.9.34",
+    "juice": "1.3.3",
+    "mails-default": "0.0.1",
+    "pkghub-render": "0.1.0"
+  },
+  "devDependencies": {
+    "babel": "^5.8.3",
+    "mails-flat": "0.0.1",
+    "mocha": "^2.2.5",
+    "should": "^7.0.2"
   }
-}
+}

package/README.sample.md

@@ -1,58 +0,0 @@
-## ![logo](http://ww2.sinaimg.cn/large/61ff0de3gw1eajmy0wdikj2014014wea.jpg) mails-themename ![npm](https://badge.fury.io/js/mails-flat.png)
-
-another email templates for mails 
-
-![screenshot](http://ww2.sinaimg.cn/large/61ff0de3gw1eapg3os39oj20kt0f9q4j.jpg)
-
-### Installation
-````
-$ npm install mails-themename
-````
-
-### Example
-````javascript
-var mails = require('mails');
-
-mails.render('mails-themename/message', function(err, html){
-    console.log(html);
-});
-````
-
-### Theme variables
-
-mails-flat using `swig` to create htmls, checkout variables in `message.html` and `package.json`
-
-### Contributing
-- Fork this repo
-- Clone your repo
-- Install dependencies
-- Checkout a feature branch
-- Feel free to add your features
-- Make sure your features are fully tested
-- Open a pull request, and enjoy <3
-
-### MIT license
-Copyright (c) 2013 turing
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-
----
-![docor](https://cdn1.iconfinder.com/data/icons/windows8_icons_iconpharm/26/doctor.png)
-generated using [docor](https://github.com/turingou/docor.git) @ 0.1.0. brought to you by [turingou](https://github.com/turingou)

package/bin/cli

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-
-require('../cli').cli();

package/cli.js

@@ -1,141 +0,0 @@
-var fs = require('fs'),
-    path = require('path'),
-    mails = require('./index'),
-    Tao = require('tao'),
-    optimist = require('optimist'),
-    argv = optimist.argv,
-    consoler = require('consoler'),
-    exeq = require('exeq'),
-    sys = require('./package.json');
-
-exports.socket = function(port, html) {
-    var socket = "<script src=\"http://localhost:" + (port + 1) + "/socket.io/socket.io.js\"></script><script>var socket = io.connect('http://localhost:" + (port + 1) + "');socket.on('updated', function (result) { window.location.reload(); });</script>";
-    return html + socket;
-}
-
-exports.serve = function(dir, params, callback) {
-
-    // 初始化服务
-    var server = new Tao({
-        dir: dir,
-        port: params.port,
-        socket: true
-    });
-    // 直接访问时渲染页面
-    server.use(function(req, res, next) {
-        if (req.url === '/') {
-            res.end('ok');
-        } else {
-            next();
-        }
-    });
-    server.use(function(req, res, next) {
-        var file = req._parsedUrl.pathname,
-            afterfix = file.substr(file.lastIndexOf('.') + 1);
-        fs.exists(path.join(dir, file), function(exist) {
-            if (exist) {
-                if (afterfix !== 'json') {
-                    mails._render({
-                        template: path.join(dir, file),
-                        data: JSON.parse(fs.readFileSync(params.pkg)),
-                        engine: {
-                            name: params.data['view engine'],
-                            _engine: params.engine
-                        }
-                    }, function(err, html) {
-                        if (!err) {
-                            res.end(exports.socket(server.configs.port, html));
-                        } else {
-                            res.end('render error: ' + err.toString());
-                        }
-                    })
-                } else {
-                    res.end(fs.readFileSync(path.join(dir, file)));
-                }
-            } else {
-                res.end('404');
-            }
-        })
-    });
-    // 检测到模板变动时刷新页面
-    server.watch(function(event, file, stat) {
-        if (params.engine && event !== 'removed') {
-            server.emit('updated', {
-                stat: 'ok',
-                file: file
-            });
-        }
-    });
-    server.run();
-    return server;
-}
-
-// mails(1)
-exports.cli = function() {
-
-    var arguments = argv._,
-        command = arguments[0],
-        pkg = arguments[1],
-        dir = process.cwd(),
-        self = this;
-
-    if (command == 'watch') {
-        if (pkg) {
-            pkg = pkg.toString();
-            fs.readFile(path.resolve(dir, pkg), function(err, file) {
-                if (!err) {
-                    try {
-                        var data = JSON.parse(file);
-                        if (data['view engine']) {
-                            try {
-                                var engine = require(data['view engine']),
-                                    port = argv.p && !isNaN(parseInt(argv.p, 10)) ? parseInt(argv.p, 10) : 3001;
-                                self.server = exports.serve(dir, {
-                                    port: port,
-                                    engine: engine,
-                                    data: data,
-                                    pkg: path.resolve(dir, pkg)
-                                });
-                                consoler.success('Mails is watching: http://localhost:' + port);
-                            } catch (err) {
-                                consoler.error('view engine required');
-                                consoler.error(err);
-                                return false;
-                            }
-                        } else {
-                            consoler.error('view engine required');
-                            return false;
-                        }
-                    } catch (err) {
-                        consoler.error('configs format must be json');
-                        return false;
-                    }
-                } else {
-                    consoler.log('404', 'configs not found');
-                    return false;
-                }
-            })
-        } else {
-            consoler.error('configs required');
-            return false;
-        }
-    } else if (command == 'init') {
-        var init = exeq([
-            'git clone ' + sys.repository.url + ' .',
-            'rm -rf .git',
-            'rm -rf bin',
-            'rm index.js cli.js package.json README.md README.en.md LICENSE',
-            'cp ./package.sample.json ./package.json',
-            'rm package.sample.json',
-            'cp ./README.sample.md ./README.md',
-            'rm README.sample.md',
-            'npm install'
-        ]);
-        init.on('done', function(count) {
-            consoler.success('another mails theme created, enjoy!');
-        });
-        init.run();
-    } else {
-        return false;
-    }
-}