Merge pull request #151 from jamesramsay/relative-override

Fix: override path is relative to source (fixes #150)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hercule",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Markdown, API Blueprint and string transclusion",
   "main": "./lib/hercule",
   "scripts": {

src/resolve-stream.js

@@ -30,16 +30,16 @@ export default function ResolveStream(grammar, opt, log = DEFAULT_LOG) {
   const options = _.merge({}, DEFAULT_OPTIONS, opt);
 
 
-  function resolve(unresolvedLink, references = [], relativePath = '') {
+  function resolve(unresolvedLink, references, relativePath) {
     let link = unresolvedLink.primary;
     const fallback = unresolvedLink.fallback;
-    const override = _.find(references, { 'placeholder': link.href }) || fallback;
+    const override = _.find(references, { 'placeholder': link.href });
 
-    if (override) {
-      link = _.pick(override, ['href', 'hrefType']);
+    if (override || fallback) {
+      link = _.pick(override || fallback, ['href', 'hrefType']);
     }
 
-    if (link.hrefType === 'file') {
+    if (!override && link.hrefType === 'file') {
       link.href = path.join(relativePath, link.href);
     }
 
@@ -49,8 +49,8 @@ export default function ResolveStream(grammar, opt, log = DEFAULT_LOG) {
 
   function transform(chunk, encoding, cb) {
     const rawLink = _.get(chunk, options.input);
-    const relativePath = _.get(chunk, `relativePath`);
-    const parentRefs = _.get(chunk, `references`);
+    const relativePath = _.get(chunk, `relativePath`) || '';
+    const parentRefs = _.get(chunk, `references`) || [];
     let link;
     let references;
 
@@ -68,7 +68,12 @@ export default function ResolveStream(grammar, opt, log = DEFAULT_LOG) {
       return cb();
     }
 
-    references = _.unique([...link.references, ...parentRefs], true);
+    references = _.map(link.references, (ref) => {
+      if (ref.hrefType === 'file') ref.href = path.join(relativePath, ref.href);
+      return ref;
+    });
+
+    references = _.unique([...references, ...parentRefs], true);
     link = resolve(link, parentRefs, relativePath);
 
     this.push(_.assign(chunk, { [options.output]: link }, { references }));

test/fixtures/local-folder-nesting/common/jackdaws.md

@@ -1 +1 @@
-Jackdaws love my :[size link](size.md) sphinx of quartz.
+Jackdaws love my :[size link](size.md) sphinx of :[material](material || "gold").

test/fixtures/local-folder-nesting/common/quartz.md

@@ -0,0 +1 @@
+quartz

test/fixtures/local-folder-nesting/index.md

@@ -1 +1 @@
-:[Jackdaws](common/jackdaws.md)
+:[Jackdaws](common/jackdaws.md material:common/quartz.md)

test/units/resolve-stream.js

@@ -22,7 +22,6 @@ test.cb('should handle no input', (t) => {
 test.cb('should skip input without link', (t) => {
   const input = {
     content: 'The quick brown fox jumps over the lazy dog./n',
-    references: [],
   };
   const testStream = new ResolveStream(grammar);
 
@@ -46,7 +45,6 @@ test.cb('should skip input without link', (t) => {
 test.cb('should parse input simple link', (t) => {
   const input = {
     content: 'The quick brown :[](animal.md) jumps over the lazy dog./n',
-    references: [],
     link: {
       href: 'animal.md',
     },
@@ -118,21 +116,35 @@ test.cb('should parse input with overriding link', (t) => {
 test.cb('should parse input with fallback link', (t) => {
   const input = {
     content: 'The quick brown :[](animal) jumps over the lazy dog./n',
-    references: [],
     link: {
       href: 'animal || "fox" feline:cat.md food:cheese.md',
     },
   };
   const expected = {
-    href: 'fox',
-    hrefType: 'string',
+    content: 'The quick brown :[](animal) jumps over the lazy dog./n',
+    references: [
+      {
+        placeholder: 'feline',
+        href: 'cat.md',
+        hrefType: 'file',
+      },
+      {
+        placeholder: 'food',
+        href: 'cheese.md',
+        hrefType: 'file',
+      },
+    ],
+    link: {
+      href: 'fox',
+      hrefType: 'string',
+    },
   };
   const testStream = new ResolveStream(grammar);
 
   testStream.on('readable', function read() {
     let chunk = null;
     while ((chunk = this.read()) !== null) {
-      t.same(chunk.link, expected);
+      t.same(chunk, expected);
     }
   });
 
@@ -173,18 +185,26 @@ test.cb('should handle parse error', (t) => {
 test.cb('should resolve link relative to file', (t) => {
   const input = {
     content: ':[](animal.md)',
+    link: {
+      href: 'animal.md',
+    },
     relativePath: 'foo',
   };
   const expected = {
-    href: 'foo/animal.md',
-    hrefType: 'file',
+    content: ':[](animal.md)',
+    references: [],
+    link: {
+      href: 'foo/animal.md',
+      hrefType: 'file',
+    },
+    relativePath: 'foo',
   };
   const testStream = new ResolveStream(grammar);
 
   testStream.on('readable', function read() {
     let chunk = null;
     while ((chunk = this.read()) !== null) {
-      t.same(chunk.link, input.link);
+      t.same(chunk, expected);
     }
   });