Skip to content
This repository was archived by the owner on May 5, 2021. It is now read-only.

Do Not Merge: Proposed idea around code partial #26

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
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
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
# TODO
- color.html (handlebars) parsing doesn't work yet

# Fabricator Assemble

[![Build Status](https://travis-ci.org/fbrctr/fabricator-assemble.svg?branch=master)](https://travis-ci.org/fbrctr/fabricator-assemble) [![npm version](https://badge.fury.io/js/fabricator-assemble.svg)](http://badge.fury.io/js/fabricator-assemble)
@@ -95,7 +98,7 @@ Default options:
Type: `String`
Default: `default`

Name of the default layout template.
Name of the default layout template.

### options.layouts

@@ -154,7 +157,7 @@ assemble({
materials: 'patterns'
}
});
```
```

```
<!-- formerly `{{#each materials}}` -->
@@ -283,7 +286,7 @@ Fabricator pages are typically stored at the root level of the `views` directory

#### Materials

Materials are partial templates; think of them as the materials used to build pages.
Materials are partial templates; think of them as the materials used to build pages.

They are accessed as a "partial" using the `>` syntax in Handlebars:

73 changes: 54 additions & 19 deletions index.js
Original file line number Diff line number Diff line change
@@ -12,7 +12,7 @@ var mkdirp = require('mkdirp');
var path = require('path');
var sortObj = require('sort-object');
var yaml = require('js-yaml');

var jsdom = require("node-jsdom");

/**
* Default options
@@ -230,7 +230,6 @@ var buildContext = function (data, hash) {

var docs = {};
docs[options.keys.docs] = assembly.docs;

return _.assign({}, data, assembly.data, assembly.materialData, materials, views, docs, hash);

};
@@ -262,7 +261,7 @@ var wrapPage = function (page, layout) {
/**
* Parse each material - collect data, create partial
*/
var parseMaterials = function () {
var parseMaterials = function (callback) {

// reset object
assembly.materials = {};
@@ -310,7 +309,7 @@ var parseMaterials = function () {


// iterate over each file (material)
files.forEach(function (file) {
files.forEach(function (file, index) {

// get info
var fileMatter = getMatter(file);
@@ -363,16 +362,46 @@ var parseMaterials = function () {
// register the partial
Handlebars.registerPartial(id, content);

});

// parse out code from material for use in example syntax-highlighted implementation
// strips out all classes with a prefix of `-f`, so that they may be used for display
// purposes indepedant of styles
function generateCodePartial(content, after) {
// config
var prefix = "f-";

// jsdom
var libPath = path.join.bind(null, __dirname, 'lib');
var jquery = fs.readFileSync(libPath("jquery.js"), "utf-8");
jsdom.env({
html: content,
src: [jquery],
done: function domLoaded(errors, window) {
var $ = window.$;
$(content).each(function eachEl() {
$('[class^="'+prefix+'"],[class*=" '+prefix+'"]').each(function hideEach() {
var children = $(this).contents();
$(this).replaceWith(children);
});
});
Handlebars.registerPartial(id + ":code", $("body").html());
if (index === files.length - 1) {
after();
}
}
});
}

// sort materials object alphabetically
assembly.materials = sortObj(assembly.materials, 'order');
generateCodePartial(content, function afterForEach() {
// sort materials object alphabetically
assembly.materials = sortObj(assembly.materials, 'order');

for (var collection in assembly.materials) {
assembly.materials[collection].items = sortObj(assembly.materials[collection].items, 'order');
}
for (var collection in assembly.materials) {
assembly.materials[collection].items = sortObj(assembly.materials[collection].items, 'order');
}

callback();
});
});
};


@@ -519,6 +548,7 @@ var registerHelpers = function () {

// register local helpers
localHelpers.map(function (helper) {
console.log("helper", helper);
var key = helper.match(/(^\w+?-)(.+)(\.\w+)/)[2];
var path = resolveHelper(helper);
Handlebars.registerHelper(key, require(path));
@@ -545,12 +575,16 @@ var registerHelpers = function () {
* @example
* {{material name context}}
*/
Handlebars.registerHelper(inflect.singularize(options.keys.materials), function (name, context, opts) {
Handlebars.registerHelper(inflect.singularize(options.keys.materials), function (name, presentation, context, opts) {

// remove leading numbers from name keyword
// partials are always registered with the leading numbers removed
var key = name.replace(/^([a-z][a-z0-9\-]*\.)?([0-9\.-]+)(.*)$/i, '$1$3');

if (presentation === "code") {
key += ":code";
}

// attempt to find pre-compiled partial
var template = Handlebars.partials[key],
fn;
@@ -564,7 +598,6 @@ var registerHelpers = function () {

// return beautified html with trailing whitespace removed
return beautifyHtml(fn(buildContext(context, opts.hash)).replace(/^\s+/, ''), options.beautifier);

});

};
@@ -574,7 +607,7 @@ var registerHelpers = function () {
* Setup the assembly
* @param {Objet} options User options
*/
var setup = function (userOptions) {
var setup = function (userOptions, callback) {

// merge user options with defaults
options = _.merge({}, defaults, userOptions);
@@ -584,7 +617,9 @@ var setup = function (userOptions) {
parseLayouts();
parseLayoutIncludes();
parseData();
parseMaterials();
parseMaterials(function() {
callback();
});
parseViews();
parseDocs();

@@ -657,10 +692,10 @@ module.exports = function (options) {
try {

// setup assembly
setup(options);

// assemble
assemble();
setup(options, function() {
// assemble
assemble();
});

} catch(e) {
handleError(e);
Loading