Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding master template option and tests #21

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 18 additions & 19 deletions lib/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

var consolidate = require('consolidate');
var debug = require('debug')('metalsmith-templates');
var each = require('async').each;
var async = require('async');
var extend = require('extend');
var join = require('path').join;
var match = require('multimatch');
Expand Down Expand Up @@ -41,50 +41,49 @@ function plugin(opts){
var pattern = opts.pattern;
var inPlace = opts.inPlace;
var def = opts.default;
var master = opts.master;
var params = omit(opts, settings);

return function(files, metalsmith, done){
var metadata = metalsmith.metadata();

function check(file){
var data = files[file];
var tmpl = data.template || def;
if (pattern && !match(file, pattern)[0]) return false;
if (!inPlace && !tmpl) return false;
if (!inPlace && !data.template && !def && !master) return false;
return true;
}

Object.keys(files).forEach(function(file){
if (!check(file)) return;
debug('stringifying file: %s', file);
var data = files[file];
data.contents = data.contents.toString();
});

each(Object.keys(files), convert, done);
async.each(Object.keys(files), convert, done);

function convert(file, done){
if (!check(file)) return done();
debug('converting file: %s', file);
var data = files[file];
data.contents = data.contents.toString();
var clone = extend({}, params, metadata, data);
var str;
var render;
var templates = [];

if (inPlace) {
str = clone.contents;
templates.push(clone.contents);
render = consolidate[engine].render;
} else {
str = metalsmith.join(dir, data.template || def);
if (data.template || def) templates.push(metalsmith.join(dir, data.template || def));
if (master) templates.push(metalsmith.join(dir, master));
render = consolidate[engine];
}

render(str, clone, function(err, str){
if (err) return done(err);
data.contents = new Buffer(str);
debug('converted file: %s', file);
done();
});
async.eachSeries(templates,function(tmplname,done){
render(tmplname, clone, function(err, tmplname){
if (err) return done(err);
data.contents = clone.contents = (new Buffer(tmplname)).toString();
debug('converted file %s using template %s', file, tmplname);
done();
});
},done);

}
};
}
8 changes: 8 additions & 0 deletions test/fixtures/master/build/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### MASTER ###
I use a default template
##############
---DEFAULT---
I use a default template
BODY
-------------
##############
1 change: 1 addition & 0 deletions test/fixtures/master/build/excluded.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
I shouldn't be templated
8 changes: 8 additions & 0 deletions test/fixtures/master/build/templ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### MASTER ###
I use a specific template
##############
--TEMPLATE---
I use a specific template
BODY
-------------
##############
8 changes: 8 additions & 0 deletions test/fixtures/master/expected/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### MASTER ###
I use a default template
##############
---DEFAULT---
I use a default template
BODY
-------------
##############
1 change: 1 addition & 0 deletions test/fixtures/master/expected/excluded.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
I shouldn't be templated
8 changes: 8 additions & 0 deletions test/fixtures/master/expected/templ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### MASTER ###
I use a specific template
##############
--TEMPLATE---
I use a specific template
BODY
-------------
##############
4 changes: 4 additions & 0 deletions test/fixtures/master/src/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: I use a default template
---
BODY
1 change: 1 addition & 0 deletions test/fixtures/master/src/excluded.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
I shouldn't be templated
5 changes: 5 additions & 0 deletions test/fixtures/master/src/templ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: I use a specific template
template: template.html
---
BODY
4 changes: 4 additions & 0 deletions test/fixtures/master/templates/default.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---DEFAULT---
{{title}}
{{contents}}
-------------
5 changes: 5 additions & 0 deletions test/fixtures/master/templates/master.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
### MASTER ###
{{title}}
##############
{{contents}}
##############
4 changes: 4 additions & 0 deletions test/fixtures/master/templates/template.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
--TEMPLATE---
{{title}}
{{contents}}
-------------
10 changes: 10 additions & 0 deletions test/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,14 @@ describe('metalsmith-templates', function(){
done();
});
});

it('should apply master template', function(done){
Metalsmith('test/fixtures/master')
.use(templates({ engine: 'swig', master: 'master.html', default: 'default.html', pattern: '*.md' }))
.build(function(err){
if (err) return done(err);
equal('test/fixtures/master/expected', 'test/fixtures/master/build');
done();
});
});
});