Merge pull request #5 from RobLoach/dynamic-filters

Allow dynamic registration of filters
thiagodemellobueno · Jun 12, 2015 · 609094c · 609094c
2 parents 9da26eb + 6c46200
commit 609094c
Show file tree

Hide file tree

Showing 12 changed files with 174 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -35,6 +35,31 @@ metalsmith
 .use(templates('swig'));
 ```
 
+### Filters
+
+Add your own filters dynamically with either a function, or a require() string.
+
+```js
+var swigHelpers = require('metalsmith-swig-helpers');
+var templates = require('metalsmith-templates');
+metalsmith
+.use(swig-helpers({
+  filters: {
+    // Append a ! at the end of the given content.
+    // {{ title|exclamation }}
+    "exclamation": function(content) {
+      return content + "!"
+    },
+
+    // Encryption filter
+    // {{ title|xorcrypt }}
+    "xorcrypt": "xor-crypt" // Does a require() on "xor-crypt"
+  }
+}))
+.use(templates('swig'));
+```
+
+
 ## License
 
   MIT
diff --git a/lib/index.js b/lib/index.js
@@ -65,6 +65,23 @@ module.exports = function plugin( data ) {
            return input + "?" + Date.now();
          });
 
+        // Dynamic Filters
+        // Take an array of functions or strings.
+        for (var name in data.filters || {}) {
+          var filter = null;
+          switch (typeof data.filters[name]) {
+            case "string":
+              filter = require(data.filters[name]);
+              break;
+            case "function":
+            default:
+              filter = data.filters[name];
+              break;
+          }
+          swig.setFilter(name, filter);
+        }
+
+
         done();
 
     };

diff --git a/package.json b/package.json
@@ -24,6 +24,14 @@
   "homepage": "https://github.com/madeofpeople/metalsmith-swigh-helpers",
   "_from": "metalsmith-swig-helpers@",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "mocha --reporter spec"
+  },
+  "devDependencies": {
+    "assert-dir-equal": "^1.0.1",
+    "metalsmith": "^1.7.0",
+    "metalsmith-templates": "^0.7.0",
+    "mocha": "^2.2.5",
+    "rimraf": "^2.4.0",
+    "xor-crypt": "0.0.2"
   }
 }
diff --git a/test/fixtures/dynamic/build/example.html b/test/fixtures/dynamic/build/example.html
@@ -0,0 +1,11 @@
+<html>
+<body>
+
+Encrypted: Ncjji&amp;Qitjb&#39;
+
+
+This is an example.
+
+
+</body>
+</html>
diff --git a/test/fixtures/dynamic/expected/example.html b/test/fixtures/dynamic/expected/example.html
@@ -0,0 +1,11 @@
+<html>
+<body>
+
+Encrypted: Ncjji&amp;Qitjb&#39;
+
+
+This is an example.
+
+
+</body>
+</html>
diff --git a/test/fixtures/dynamic/src/example.html b/test/fixtures/dynamic/src/example.html
@@ -0,0 +1,7 @@
+---
+template: layout.html
+title: Hello World!
+---
+
+This is an example.
+
diff --git a/test/fixtures/dynamic/templates/layout.html b/test/fixtures/dynamic/templates/layout.html
@@ -0,0 +1,8 @@
+<html>
+<body>
+
+Encrypted: {{ title|xorcrypt }}
+
+{{contents}}
+</body>
+</html>
diff --git a/test/fixtures/simple/build/example.html b/test/fixtures/simple/build/example.html
@@ -0,0 +1,12 @@
+<html>
+<body>
+
+Title: Hello World!
+Slug: hello-world
+
+
+This is an example.
+
+
+</body>
+</html>
diff --git a/test/fixtures/simple/expected/example.html b/test/fixtures/simple/expected/example.html
@@ -0,0 +1,12 @@
+<html>
+<body>
+
+Title: Hello World!
+Slug: hello-world
+
+
+This is an example.
+
+
+</body>
+</html>
diff --git a/test/fixtures/simple/src/example.html b/test/fixtures/simple/src/example.html
@@ -0,0 +1,7 @@
+---
+template: layout.html
+title: Hello World!
+---
+
+This is an example.
+
diff --git a/test/fixtures/simple/templates/layout.html b/test/fixtures/simple/templates/layout.html
@@ -0,0 +1,9 @@
+<html>
+<body>
+
+Title: {{ title }}
+Slug: {{ title|slug }}
+
+{{contents}}
+</body>
+</html>
diff --git a/test/index.js b/test/index.js
@@ -0,0 +1,46 @@
+
+var equal = require('assert-dir-equal');
+var swigHelpers = require('..');
+var templates = require('metalsmith-templates');
+var Metalsmith = require('metalsmith');
+var rm = require('rimraf').sync;
+
+describe('metalsmith-ignore', function(){
+
+  it('should register swig helpers', function(done){
+    rm('test/fixtures/simple/build');
+    var m = Metalsmith('test/fixtures/simple')
+      .use(swigHelpers({}))
+      .use(templates({
+        engine: 'swig',
+        directory: 'templates'
+      }));
+
+    m.build(function(err){
+      if (err) return done(err);
+      equal('test/fixtures/simple/build', 'test/fixtures/simple/expected');
+      done();
+    });
+  });
+
+  it('should register dynamic swig helpers', function(done){
+    rm('test/fixtures/dynamic/build');
+    var m = Metalsmith('test/fixtures/dynamic')
+      .use(swigHelpers({
+        filters: {
+          "xorcrypt": "xor-crypt"
+        }
+      }))
+      .use(templates({
+        engine: 'swig',
+        directory: 'templates'
+      }));
+
+    m.build(function(err){
+      if (err) return done(err);
+      equal('test/fixtures/dynamic/build', 'test/fixtures/dynamic/expected');
+      done();
+    });
+  });
+
+});