add shorthands to builder

lib/builder.js

@@ -3,9 +3,10 @@
  * Module dependencies.
  */
 
-var lookup = require('./lookup');
-var Build = require('./build');
 var Batch = require('batch');
+var Build = require('./build');
+var lookup = require('./lookup');
+var shorthands = require('./shorthands');
 
 /**
  * Expose `Builder`
@@ -97,3 +98,9 @@ Builder.prototype.build = function(fn){
     });
   });
 };
+
+/**
+ * Mixin shorthands.
+ */
+
+for (var key in shorthands) Builder.prototype[key] = shorthands[key];

lib/shorthands.js

@@ -0,0 +1,126 @@
+
+var commonjs = require('./plugins/commonjs');
+var concat = require('./plugins/concat');
+var copy = require('./plugins/copy');
+var rewriteUrls = require('./plugins/rewrite-urls');
+var symlink = require('./plugins/symlink');
+
+/**
+ * Build all the native types with an `out` directory and optional `options`
+ * then invoke `fn(err, build)`.
+ *
+ * @param {String} out
+ * @param {Object} options (optional)
+ *   @property {Boolean} symlink
+ *   @property {String} rewriteUrls
+ * @param {Function} fn
+ */
+
+exports.all = function (out, options, fn) {
+  if ('function' == typeof options) fn = options, options = null;
+  options = options || {};
+
+  this
+    .use(commonjs('json'))
+    .use(commonjs('scripts'))
+    .use(commonjs('templates'))
+    .use(rewrite(options.rewriteUrls || ''))
+    .use(concat('json'))
+    .use(concat('scripts'))
+    .use(concat('styles'))
+    .use(concat('templates'))
+    .use(copy('fonts', out, options))
+    .use(copy('images', out, options))
+    .build(fn);
+};
+
+/**
+ * Build scripts and invoke `fn(err, build)`.
+ *
+ * @param {Function} fn
+ */
+
+exports.scripts = function (fn) {
+  this
+    .use(commonjs('scripts'))
+    .use(concat('scripts'))
+    .build(fn);
+};
+
+/**
+ * Build styles with `options` and invoke `fn(err, build)`.
+ *
+ * @param {Object} options (optional)
+ *   @property {String} rewriteUrls
+ * @param {Function} fn
+ */
+
+exports.styles = function (options, fn) {
+  if ('function' == typeof options) fn = options, options = null;
+  options = options || {};
+
+  this
+    .use(rewriteUrls(options.rewriteUrls || ''))
+    .use(concat('styles'))
+    .build(fn);
+};
+
+/**
+ * Build templates and invoke `fn(err, build)`.
+ *
+ * @param {Function} fn
+ */
+
+exports.templates = function (fn) {
+  this
+    .use(commonjs('templates'))
+    .use(concat('templates'))
+    .build(fn);
+};
+
+/**
+ * Build json and invoke `fn(err, build)`.
+ *
+ * @param {Function} fn
+ */
+
+exports.json = function (fn) {
+  this
+    .use(commonjs('json'))
+    .use(concat('json'))
+    .build(fn);
+};
+
+/**
+ * Build images with `out` directory and `options` and invoke `fn(err, build)`.
+ *
+ * @param {String} out
+ * @param {Object} options (optional)
+ * @param {Function} fn
+ */
+
+exports.images = function (out, options, fn) {
+  if ('function' == typeof options) fn = options, options = null;
+  options = options || {};
+
+  this
+    .use(copy('images', out, options))
+    .build(fn);
+};
+
+/**
+ * Build fonts with `out` directory and `options` and invoke `fn(err, build)`.
+ *
+ * @param {String} out
+ * @param {Object} options (optional)
+ * @param {Function} fn
+ */
+
+exports.fonts = function (out, options, fn) {
+  if ('function' == typeof options) fn = options, options = null;
+  options = options || {};
+
+  this
+    .use(copy('fonts', out, options))
+    .build(fn);
+};

test/fixtures/fonts/component.json

@@ -0,0 +1,10 @@
+{
+  "name": "fonts",
+  "description": "a bunch of fonts",
+  "styles": [
+    "style.css"
+  ],
+  "fonts": [
+    "montserrat-regular.ttf"
+  ]
+}

test/fixtures/fonts/style.css

@@ -0,0 +1,6 @@
+@font-face {
+  font-family: 'Montserrat';
+  src: url('fonts/montserrat-regular.ttf') format('truetype');
+  font-weight: normal;
+  font-style: normal;
+}

test/shorthands.js

@@ -0,0 +1,147 @@
+
+var Builder = require('..');
+var exec = require('child_process').exec;
+var exists = require('fs').existsSync;
+var fs = require('fs');
+var read = require('fs').readFileSync;
+var vm = require('vm');
+
+describe('shorthands', function(){
+  afterEach(function(done){
+    exec('rm -rf /tmp/build', done);
+  });
+
+  describe('scripts', function(){
+    it('should build scripts', function(done){
+      var builder = new Builder('test/fixtures/hello');
+      builder.path('..');
+      builder.scripts(function(err, build){
+        if (err) return done(err);
+        var js = build.scripts.trim();
+        var out = read('test/fixtures/hello-js.js', 'utf8').trim();
+        js.should.eql(out);
+        done();
+      });
+    });
+  });
+
+  describe('json', function(){
+    it('should build json', function(done){
+      var builder = new Builder('test/fixtures/json');
+      builder.path('..');
+      builder.json(function(err, build){
+        if (err) return done(err);
+        var js = build.json.trim();
+        var out = read('test/fixtures/json.js', 'utf8').trim();
+        js.should.eql(out);
+        done();
+      });
+    });
+  });
+
+  describe('templates', function(){
+    it('should build templates', function(done){
+      var builder = new Builder('test/fixtures/template-strings');
+      builder.path('..');
+      builder.templates(function(err, build){
+        if (err) return done(err);
+        var js = build.templates.trim();
+        var out = read('test/fixtures/template.js', 'utf8').trim();
+        js.should.eql(out);
+        done();
+      });
+    });
+  });
+
+  describe('styles', function(){
+    it('should build styles', function(done){
+      var builder = new Builder('test/fixtures/assets-parent');
+      builder.path('..');
+      builder.styles(function(err, build){
+        if (err) return done(err);
+        build.styles.should.include('url("assets/images/logo.png")');
+        build.styles.should.include('url("assets/images/maru.jpeg")');
+        build.styles.should.include('url("assets/images/npm.png")');
+        build.styles.should.include('url(http://example.com/images/manny.png)');
+        build.styles.should.include('url(/public/images/foo.png)')
+        build.styles.should.include('url(data:image/png;base64,PNG DATA HERE)');
+        done();
+      });
+    });
+
+    it('should rewrite urls', function(done){
+      var builder = new Builder('test/fixtures/assets-parent');
+      builder.path('..');
+      builder.styles({ rewriteUrls: 'build' }, function(err, build){
+        if (err) return done(err);
+        build.styles.should.include('url("build/assets/images/logo.png")');
+        build.styles.should.include('url("build/assets/images/maru.jpeg")');
+        build.styles.should.include('url("build/assets/images/npm.png")');
+        build.styles.should.include('url(http://example.com/images/manny.png)');
+        build.styles.should.include('url(/public/images/foo.png)')
+        build.styles.should.include('url(data:image/png;base64,PNG DATA HERE)');
+        done();
+      });
+
+    });
+  });
+
+  describe('images', function(){
+    it('should build images', function(done){
+      var builder = new Builder('test/fixtures/assets');
+      builder.path('..');
+      builder.images('/tmp/build', function(err){
+        if (err) return done(err);
+        exists('/tmp/build/assets/images/maru.jpeg').should.be.true;
+        exists('/tmp/build/assets/images/logo.png').should.be.true;
+        exists('/tmp/build/assets/images/npm.png').should.be.true;
+        fs.lstat('/tmp/build/assets/images/npm.png', function(err, stats) {
+          if (err) return done(err);
+          stats.isSymbolicLink().should.be.false;
+          done();
+        });
+      });
+    });
+
+    it('should symlink when option is true', function(done){
+      var builder = new Builder('test/fixtures/assets');
+      builder.path('..');
+      builder.images('/tmp/build', { symlink: true }, function(err){
+        if (err) return done(err);
+        fs.lstat('/tmp/build/assets/images/npm.png', function(err, stats) {
+          if (err) return done(err);
+          stats.isSymbolicLink().should.be.true;
+          done();
+        });
+      });
+    });
+  });
+
+  describe('fonts', function(){
+    it('should build fonts', function(done){
+      var builder = new Builder('test/fixtures/fonts');
+      builder.path('..');
+      builder.fonts('/tmp/build', function(err){
+        if (err) return done(err);
+        fs.lstat('/tmp/build/fonts/montserrat-regular.ttf', function(err, stats) {
+          if (err) return done(err);
+          stats.isSymbolicLink().should.be.false;
+          done();
+        });
+      });
+    });
+
+    it('should symlink when option is true', function(done){
+      var builder = new Builder('test/fixtures/fonts');
+      builder.path('..');
+      builder.fonts('/tmp/build', { symlink: true }, function(err){
+        if (err) return done(err);
+        fs.lstat('/tmp/build/fonts/montserrat-regular.ttf', function(err, stats) {
+          if (err) return done(err);
+          stats.isSymbolicLink().should.be.true;
+          done();
+        });
+      });
+    });
+  });
+});