Merge pull request #97 from jonschlinkert/master

new "relative" helper for resolving paths
assemble · Mar 18, 2013 · d02af19 · d02af19
2 parents 351c32e + 7f610e8
commit d02af19
Show file tree

Hide file tree

Showing 13 changed files with 77 additions and 58 deletions.
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -11,6 +11,7 @@ module.exports = function(grunt) {
 
   // Project configuration.
   grunt.initConfig({
+
     // package.json
     pkg: grunt.file.readJSON('package.json'),
     meta: {
@@ -20,19 +21,19 @@ module.exports = function(grunt) {
         '* Copyright (c) <%= grunt.template.today("yyyy") %> <%= pkg.author.name %>;' +
         ' Licensed <%= _.pluck(pkg.licenses, "type").join(", ") %> */'
     },
-
     jshint: {
+      options: {
+        jshintrc: '.jshintrc'
+      },
       files: [
         'Gruntfile.js',
         'lib/**/*.js',
         'tasks/**/*.js',
         'test/**/*.js'
-      ],
+      ]
-      options: {
-        jshintrc: '.jshintrc'
-      }
     },
-    // Run tests.
+
+    // Run mocha tests.
     mochaTest: {
       files: ['test/**/*.js']
     },
@@ -42,26 +43,8 @@ module.exports = function(grunt) {
       }
     },
 
-    // Run simple tests.
     assemble: {
-      // Internal task to build README, docs.
+      // Run basic tests on templates and data.
-      readme: {
-        options: {
-          today: '<%= grunt.template.today() %>',
-          partials: ['docs/*.md','docs/templates/sections/*.{md,hbs}'],
-          changelog: grunt.file.readYAML('CHANGELOG'),
-          roadmap: grunt.file.readYAML('ROADMAP'),
-          data: [
-            'docs/templates/data/docs.json',
-            '../assemble-internal/docs/templates/data/url.json', 
-            '../assemble-internal/docs/templates/data/repos.json'
-          ],
-          ext: '.md'
-        },
-        files: {
-          '.': ['../assemble-internal/docs/templates/README.hbs']
-        }
-      },
       tests: {
         options: {
           layout: 'test/files/layout-includes.hbs'
@@ -77,6 +60,24 @@ module.exports = function(grunt) {
         files: {
           'test/actual/yaml': ['test/yaml/*.hbs']
         }
+      },
+      // Internal task to build README, docs.
+      readme: {
+        options: {
+          today: '<%= grunt.template.today() %>',
+          partials: ['docs/*.md','docs/templates/sections/*.{md,hbs}'],
+          changelog: grunt.file.readYAML('CHANGELOG'),
+          roadmap: grunt.file.readYAML('ROADMAP'),
+          ext: '.md',
+          data: [
+            'docs/templates/data/docs.json',
+            '../assemble-internal/docs/templates/data/url.json', 
+            '../assemble-internal/docs/templates/data/repos.json'
+          ]
+        },
+        files: {
+          '.': ['../assemble-internal/docs/templates/README.hbs']
+        }
       }
     }
   });

diff --git a/README.md b/README.md
@@ -37,8 +37,6 @@ _This project just launched **so expect frequent changes** for the near future,
 
 
 
-
-
 ## Quick start
 This plugin requires Grunt `~0.4.0`
 
@@ -638,7 +636,7 @@ Copyright 2013 Assemble
 
 ---
 
-_This file was generated with Grunt and [assemble](http://github.com/assemble/assemble) on Sat Mar 16 2013 16:47:56._
+_This file was generated with Grunt and [assemble](http://github.com/assemble/assemble) on Mon Mar 18 2013 00:51:12._
 
 
 

diff --git a/component.json b/component.json
@@ -1,6 +1,6 @@
 {
   "name": "assemble",
-  "version": "0.3.12",
+  "version": "0.3.14",
   "main": [
     "./lib/assemble.js"
   ],

diff --git a/docs/toc.md b/docs/toc.md
@@ -1,3 +1,5 @@
+
+
 **Table of Contents**
 
 - [The "assemble" task](#the-assemble-task)
@@ -25,5 +27,4 @@
 - [Bug tracker](#bug-tracker)
 - [Contributing](#contributing)
 - [Authors](#authors)
-- [License](#copyright-and-license)
+- [License](#copyright-and-license)
-
diff --git a/lib/assemble.js b/lib/assemble.js
@@ -4,7 +4,7 @@
  * Assemble
  * http://assemble.io
  *
- * Copyright (c) 2012 Upside
+ * Copyright (c) 2012 Upstage
  * Licensed under the MIT license.
  * https://github.com/assemble/assemble/blob/master/LICENSE-MIT
  * ========================================================== */

diff --git a/lib/engines/handlebars/helpers/defaultHelpers.js b/lib/engines/handlebars/helpers/defaultHelpers.js
@@ -9,8 +9,7 @@ if(!define || typeof define !== 'function') {
  * be used inside your handlebars templates
  */
 
-define([],
+define([], function() {
-function() {
 
   // figure out if this is node or browser
   var isServer = (typeof process !== 'undefined');
@@ -22,10 +21,14 @@ function() {
         Utils     = {},
         __indexOf = [].indexOf || function(item) { for (var i = 0, l = this.length; i < l; i++) { if (i in this && this[i] === item) { return i; } } return -1; };
 
-//    if(isServer) {
+    // if(isServer) {
-      var assemble  = require('../../../assemble.js'),
+      var assemble = require('../../../assemble.js');
-          markdown  = assemble.Markdown({gfm: true, highlight: 'auto'});
+      var fs       = require('fs');
-//    }
+      var util     = require('util');
+      var path     = require('path');
+      var dest     = './';
+      var markdown = assemble.Markdown({gfm: true, highlight: 'auto'});
+    // }
 
 
     /*************************************************************
@@ -47,6 +50,12 @@ function() {
       return str.toString().replace(trim, '');
     };
 
+    // Normalize slashes in URLs
+    Utils.urlNormalize = function(urlString) {
+      return urlString.replace(/\\/g, '/');
+    };
+
+
 
     /*************************************************************
     * HTML
@@ -362,7 +371,7 @@ function() {
 
     /**
      * Dashify
-     * Replace dots in string with hyphens.
+     * Replace periods in string with hyphens.
      */
     Handlebars.registerHelper('dashify', function(tag) {
       return tag.split('.').join('-');
@@ -481,14 +490,6 @@ function() {
       return "" + space + str + space;
     });
 
-    /**
-     * newLineToBr
-     * Converts new line characters `\n` to line breaks `<br>`.
-     */
-    Handlebars.registerHelper('newLineToBr', function(str) {
-      return str.replace(/\n/g, '<br>');
-    });
-
 
     // ==========================================================
     //
@@ -734,6 +735,24 @@ function() {
       return ret;
     });
 
+    /**
+     * Relative path
+     * Returns the derived relative path from one to the other.
+     */
+    Handlebars.registerHelper('relative', function(from, to) {
+
+      var relativePath = path.relative(from, to);
+
+      if(relativePath === "." || relativePath.length === 0) {
+        relativePath = dest;
+      }
+      relativePath = Utils.urlNormalize(path.relative( 
+        path.resolve(path.join(dest, relative)), 
+        path.resolve(relativePath) 
+      ));
+      return relativePath;
+    });
+
     /**
      * Add
      * Returns the sum of two numbers.

diff --git a/lib/engines/handlebars/preprocessors/handlebarsPreprocessors.js b/lib/engines/handlebars/preprocessors/handlebarsPreprocessors.js
@@ -4,7 +4,7 @@
  * Assemble
  * http://assemble.io
  *
- * Copyright (c) 2012 Upside
+ * Copyright (c) 2012 Upstage
  * Licensed under the MIT license.
  * https://github.com/assemble/assemble/blob/master/LICENSE-MIT
  * ========================================================== */

diff --git a/lib/utils/common-preprocessors.js b/lib/utils/common-preprocessors.js
@@ -2,7 +2,7 @@
  * Assemble
  * http://assemble.io
  *
- * Copyright (c) 2012 Upside
+ * Copyright (c) 2012 Upstage
  * Licensed under the MIT license.
  * https://github.com/assemble/assemble/blob/master/LICENSE-MIT
  * ========================================================== */

diff --git a/lib/utils/engineLoader.js b/lib/utils/engineLoader.js
@@ -4,17 +4,17 @@
  * Assemble
  * http://assemble.io
  *
- * Copyright (c) 2012 Upside
+ * Copyright (c) 2012 Upstage
  * Licensed under the MIT license.
  * https://github.com/assemble/assemble/blob/master/LICENSE-MIT
  * ========================================================== */
 
 (function(exports) {
 
-  var fs     = require('fs'),
+  var fs                 = require('fs'),
-      path   = require('path'),
+      path               = require('path'),
-      _      = require('lodash'),
+      _                  = require('lodash'),
-      extensions = require('../config/extensionMap'),
+      extensions         = require('../config/extensionMap'),
       commonPreprocessor = require('./common-preprocessors');
 
   var EngineLoader = function(options) {

diff --git a/lib/utils/frontMatter.js b/lib/utils/frontMatter.js
@@ -4,7 +4,7 @@
  * Assemble
  * http://assemble.io
  *
- * Copyright (c) 2012 Upside
+ * Copyright (c) 2012 Upstage
  * Licensed under the MIT license.
  * https://github.com/assemble/assemble/blob/master/LICENSE-MIT
  * ========================================================== */

diff --git a/lib/utils/index.js b/lib/utils/index.js
@@ -4,7 +4,7 @@
  * Assemble
  * http://assemble.io
  *
- * Copyright (c) 2012 Upside
+ * Copyright (c) 2012 Upstage
  * Licensed under the MIT license.
  * https://github.com/assemble/assemble/blob/master/LICENSE-MIT
  * ========================================================== */

diff --git a/lib/utils/markdown.js b/lib/utils/markdown.js
@@ -4,7 +4,7 @@
  * Assemble
  * http://assemble.io
  *
- * Copyright (c) 2012 Upside
+ * Copyright (c) 2012 Upstage
  * Licensed under the MIT license.
  * https://github.com/assemble/assemble/blob/master/LICENSE-MIT
  * ========================================================== */

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "assemble",
   "description": "Get the rocks out of your socks. Assemble helps you **quickly launch static web projects** by emphasizing a strong separation of concerns between structure, style, content and configuration.",
-  "version": "0.3.13",
+  "version": "0.3.14",
   "homepage": "https://github.com/assemble/assemble",
   "author": {
     "name": "assemble",