@mtbdata711/twig-loader 1.1.0

package/.editorconfig

@@ -0,0 +1,2 @@
+[*]
+indent_size = 4

package/.prettierrc.yml

@@ -0,0 +1,7 @@
+bracketSpacing: true
+jsxBracketSameLine: false
+printWidth: 80
+semi: true
+singleQuote: true
+tabWidth: 4
+trailingComma: all

package/.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+  - "6"
+  - "8"
+  - "9"
+

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Zimmo.be
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,64 @@
+# twig-loader
+Webpack loader for compiling Twig.js templates. This loader will allow you to require Twig.js views to your code.
+
+This is a fork of [@jfrk/twig-loader](https://github.com/jfrk/twig-loader) to support using Drupal's [Single Directory Components](https://www.drupal.org/docs/develop/theming-drupal/using-single-directory-components) in [Twig.js](https://github.com/twigjs/twig.js). 
+
+## Installation
+
+- Clone this repo
+
+## Usage
+
+[Documentation: Using loaders](http://webpack.github.io/docs/using-loaders.html?branch=master)
+
+``` javascript
+
+module.exports = {
+    //...
+
+    module: {
+        rules: [
+            {
+                test: /\.twig$/,
+                loader: "twig-loader",
+                options: {
+                    // See options section below
+                },
+            }
+        ]
+    },
+
+    node: {
+        fs: "empty" // avoids error messages
+    }
+};
+```
+
+### Options
+
+- `extender`: optional; the full path to a module which exports a `function(Twig)`
+  which extends Twig (such as adding filters and functions). Must use `export default` instead of `module.exports`.
+  Example: `__dirname + "/src/extendTwig.js"`
+- `paths`: optional; an array of absolute paths that contain Twig templates. When this option is included, paths that doesn’t begin with a `.` or `/` inside tags like `{% include %}` and `{% extends %}` will be considered relative to one of these paths instead of the file. This mimics the PHP implementation of Twig.
+- `twigOptions`: optional; a map of options to be passed through to Twig.
+  Example: `{autoescape: true}`
+ - `sdc` - optional; object of namespaces and paths to SDC namespaces. Example: `{design_system: path.resolve(__dirname, './components')}`
+
+## Loading templates
+
+```twig
+{# File: dialog.html.twig #}
+<p>{{title}}</p>
+```
+
+```javascript
+// File: app.js
+var template = require("./dialog.html.twig");
+// => returns pre-compiled template as a function and automatically includes Twig.js to your project
+
+var html = template({title: 'dialog title'});
+// => Render the view with the given context
+
+```
+
+When you extend another view, it will also be added as a dependency. All twig functions that refer to additional templates are supported: import, include, extends & embed.

package/index.js

@@ -0,0 +1 @@
+module.exports = require("./lib/loader");

package/lib/compiler.js

@@ -0,0 +1,122 @@
+var path = require('path');
+var hashGenerator = require('hasha');
+var _ = require('underscore');
+var mapcache = require('./mapcache');
+var fs = require('fs');
+
+module.exports = function(options) {
+    return function(id, tokens, pathToTwig) {
+        var includes = [];
+        var resourcePath = mapcache.get(id);
+        var processDependency = function(token) {
+            let relativePath;
+            if (token.value.includes(':')) {
+                const [namespace, component] = token.value.split(":");
+                if (options.sdc[namespace]) {
+                    resolvedPath = path.resolve(
+                        options.sdc[namespace],
+                        `${component}/${component}.twig`,
+                    );
+                    if (fs.existsSync(resolvedPath)) {
+                        relativePath = `./${path.dirname(
+                            resourcePath,
+                            resolvedPath,
+                        )}`;
+                        includes.push(relativePath);
+                        token.value = hashGenerator(resolvedPath);
+                    }
+                }
+            } else if (!/^[.\/]/.test(token.value)) {
+                let resolvedPath;
+                (options.paths || []).some(templatePath => {
+                    resolvedPath = path.resolve(templatePath, token.value);
+                    if (fs.existsSync(resolvedPath)) {
+                        relativePath =
+                            './' +
+                            path.relative(
+                                path.dirname(resourcePath),
+                                resolvedPath,
+                            );
+                        includes.push(relativePath);
+                        token.value = hashGenerator(resolvedPath);
+                        return true;
+                    }
+                });
+            } else {
+                relativePath = token.value;
+                resolvedPath = path.resolve(
+                    path.dirname(resourcePath),
+                    token.value,
+                );
+                includes.push(relativePath);
+                token.value = hashGenerator(resolvedPath);
+            }
+        };
+
+        var processToken = function(token) {
+            if (token.type == 'logic' && token.token.type) {
+                switch (token.token.type) {
+                    case 'Twig.logic.type.block':
+                    case 'Twig.logic.type.if':
+                    case 'Twig.logic.type.elseif':
+                    case 'Twig.logic.type.else':
+                    case 'Twig.logic.type.for':
+                    case 'Twig.logic.type.spaceless':
+                    case 'Twig.logic.type.macro':
+                        _.each(token.token.output, processToken);
+                        break;
+                    case 'Twig.logic.type.extends':
+                    case 'Twig.logic.type.include':
+                        _.each(token.token.stack, processDependency);
+                        break;
+                    case 'Twig.logic.type.embed':
+                        _.each(token.token.output, processToken);
+                        _.each(token.token.stack, processDependency);
+                        break;
+                    case 'Twig.logic.type.import':
+                    case 'Twig.logic.type.from':
+                        if (token.token.expression != '_self') {
+                            _.each(token.token.stack, processDependency);
+                        }
+                        break;
+                }
+            }
+        };
+
+        var parsedTokens = JSON.parse(tokens);
+
+        _.each(parsedTokens, processToken);
+
+        var opts = Object.assign({}, options.twigOptions, {
+            id: id,
+            data: parsedTokens,
+            allowInlineIncludes: true,
+            rethrow: true,
+        });
+        var output = [
+            'var Twig = require("' + pathToTwig + '"),',
+            '    template = Twig.twig(' + JSON.stringify(opts) + ');\n',
+        ];
+
+        output.push(`
+            if(module && module.hot) {
+                Twig.cache(false);
+            }
+        `);
+
+        if (options.extender) {
+            output.push('require("' + options.extender + '").default(Twig);\n');
+        }
+        output.push(
+            'module.exports = function(context) { return template.render(context); }',
+        );
+
+        if (includes.length > 0) {
+            _.each(_.uniq(includes), function(file) {
+                output.unshift('require(' + JSON.stringify(file) + ');\n');
+            });
+        }
+
+        return output.join('\n');
+    };
+};

package/lib/loader.js

@@ -0,0 +1,57 @@
+var Twig = require("twig");
+var path = require("path");
+var hashGenerator = require("hasha");
+var mapcache = require("./mapcache");
+var getOptions = require("loader-utils").getOptions;
+var validateOptions = require("schema-utils");
+var compilerFactory = require("./compiler");
+
+var schema = {
+    type: "object",
+    properties: {
+        extender: {
+            type: "string",
+        },
+        twigOptions: {
+            type: "object",
+        },
+    },
+};
+
+Twig.cache(false);
+
+module.exports = function(source) {
+    var path = require.resolve(this.resource),
+        id = hashGenerator(path),
+        options = getOptions(this),
+        tpl;
+
+    if (options) {
+        validateOptions(schema, options, "twig-loader");
+    } else {
+        options = {};
+    }
+
+    Twig.extend(function(Twig) {
+        var compiler = Twig.compiler;
+        compiler.module['webpack'] = compilerFactory(options);
+    });
+
+    mapcache.set(id, path)
+
+    this.cacheable && this.cacheable();
+
+    tpl = Twig.twig({
+        id: id,
+        path: path,
+        data: source,
+        allowInlineIncludes: true
+    });
+
+    tpl = tpl.compile({
+        module: 'webpack',
+        twig: 'twig'
+    });
+
+    this.callback(null, tpl);
+};

package/lib/mapcache.js

@@ -0,0 +1,2 @@
+var MapCache = require('map-cache');
+module.exports = new MapCache();

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@mtbdata711/twig-loader",
+  "version": "1.1.0",
+  "description": "Webpack loader for compiling twig.js templates",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha -R spec"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mtbdata711/twig-loader.git"
+  },
+  "author": "Mathieu Maes @ Zimmo.be",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/mtbdata711/twig-loader/issues"
+  },
+  "homepage": "https://github.com/mtbdata711/twig-loader#readme",
+  "dependencies": {
+    "hasha": "^3.0.0",
+    "loader-utils": "^1.1.0",
+    "map-cache": "^0.2.2",
+    "schema-utils": "^0.4.5",
+    "twig": "^1.17.1",
+    "underscore": "^1.11.0"
+  },
+  "devDependencies": {
+    "mocha": "*",
+    "prettier": "^1.19.1",
+    "should": "*"
+  }
+}

package/test/embed.test.js

@@ -0,0 +1,39 @@
+var should = require("should");
+
+var fs = require("fs");
+var path = require("path");
+
+var runLoader = require("./fakeModuleSystem");
+var twigLoader = require("../");
+
+var fixtures = path.join(__dirname, "fixtures");
+
+describe("embed", function() {
+  it("should generate proper require embed tag", function(done) {
+    var template = path.join(fixtures, "embed", "template.html.twig");
+    runLoader(twigLoader, path.join(fixtures, "extend"), template, fs.readFileSync(template, "utf-8"), function(err, result) {
+      if(err) throw err;
+
+      result.should.have.type("string");
+
+      // verify the generated module imports the `embed`d templates
+      result.should.match(/require\(\"embed\.html\.twig\"\);/);
+
+      done();
+    });
+  });
+
+  it("should generate proper require include tag in block tag", function(done) {
+    var template = path.join(fixtures, "embed", "template.html.twig");
+    runLoader(twigLoader, path.join(fixtures, "extend"), template, fs.readFileSync(template, "utf-8"), function(err, result) {
+      if(err) throw err;
+
+      result.should.have.type("string");
+
+      // verify the generated module imports the `include`d templates
+      result.should.match(/require\(\"include\.html\.twig\"\);/);
+
+      done();
+    });
+  });
+});

package/test/extends.test.js

@@ -0,0 +1,25 @@
+var should = require("should");
+
+var fs = require("fs");
+var path = require("path");
+
+var runLoader = require("./fakeModuleSystem");
+var twigLoader = require("../");
+
+var fixtures = path.join(__dirname, "fixtures");
+
+describe("extend", function() {
+  it("should generate proper require statements", function(done) {
+    var template = path.join(fixtures, "extend", "template.html.twig");
+    runLoader(twigLoader, path.join(fixtures, "extend"), template, fs.readFileSync(template, "utf-8"), function(err, result) {
+      if(err) throw err;
+
+      result.should.have.type("string");
+
+      // verify the generated module imports the `include`d templates
+      result.should.match(/require\(\"a\.html\.twig\"\);/);
+
+      done();
+    });
+  });
+});

package/test/fakeModuleSystem.js

@@ -0,0 +1,33 @@
+var fs = require("fs");
+var path = require("path");
+
+module.exports = function runLoader(loader, directory, filename, arg, callback) {
+  var async = true;
+  var loaderContext = {
+    async: function() {
+      async = true;
+      return callback;
+    },
+    loaders: ["itself"],
+    loaderIndex: 0,
+    query: "",
+    resource: filename,
+    callback: function() {
+      async = true;
+      return callback.apply(this, arguments);
+    },
+    resolve: function(context, request, callback) {
+      callback(null, path.resolve(context, request));
+    },
+    loadModule: function(request, callback) {
+      request = request.replace(/^-?!+/, "");
+      request = request.split("!");
+      var content = fs.readFileSync(request.pop(), "utf-8");
+      if(request[0] && /stringify/.test(request[0]))
+        content = JSON.stringify(content);
+      return callback(null, content);
+    }
+  };
+  var res = loader.call(loaderContext, arg);
+  if(!async) callback(null, res);
+}

package/test/fixtures/embed/template.html.twig

@@ -0,0 +1,5 @@
+{% embed 'embed.html.twig' %}
+    {% block body %}
+        {% include 'include.html.twig' %}
+    {% endblock %}
+{% endembed %}

package/test/fixtures/extend/template.html.twig

@@ -0,0 +1,2 @@
+{% extends 'a.html.twig' %}
+{% block body %}{% endblock %}

package/test/fixtures/from/template.html.twig

@@ -0,0 +1,25 @@
+{% from './a.html.twig' import macroName %}
+
+{% if true %}
+  {% from './b.html.twig' import macroName %}
+{% elseif false %}
+  {% from './c.html.twig' import macroName %}
+{% else %}
+  {% from './d.html.twig' import macroName %}
+{% endif %}
+
+{% for i in 0..10 %}
+  {% from './e.html.twig' import macroName %}
+{% endfor %}
+
+{% block myblock %}
+  {% from './f.html.twig' import macroName %}
+{% endblock %}
+
+{% spaceless %}
+  {% from './g.html.twig' import macroName %}
+{% endspaceless %}
+
+{% macro mymacro() %}
+  {% from './h.html.twig' import macroName %}
+{% endmacro %}

package/test/fixtures/include/template.html.twig

@@ -0,0 +1,21 @@
+{% include './a.html.twig' %}
+
+{% if true %}
+  {% include './b.html.twig' %}
+{% elseif false %}
+  {% include './c.html.twig' %}
+{% else %}
+  {% include './d.html.twig' %}
+{% endif %}
+
+{% for i in 0..10 %}
+  {% include './e.html.twig' %}
+{% endfor %}
+
+{% block myblock %}
+  {% include './f.html.twig' %}
+{% endblock %}
+
+{% spaceless %}
+  {% include './g.html.twig' %}
+{% endspaceless %}

package/test/fixtures/loader/template.html.twig

@@ -0,0 +1 @@
+Lorem ipsum {% if variable is true %}dolor{% endif %} sit amet.

package/test/fixtures/sdc/component-a/component-a.twig

@@ -0,0 +1 @@
+{% include 'design_system:component-b' %}

package/test/fixtures/sdc/component-b/component-b.twig

@@ -0,0 +1 @@
+<p>Hello World</p>

package/test/from.test.js

@@ -0,0 +1,32 @@
+var should = require("should");
+
+var fs = require("fs");
+var path = require("path");
+
+var runLoader = require("./fakeModuleSystem");
+var twigLoader = require("../");
+
+var fixtures = path.join(__dirname, "fixtures");
+
+describe("from", function() {
+  it("should generate correct code", function(done) {
+    var template = path.join(fixtures, "from", "template.html.twig");
+    runLoader(twigLoader, path.join(fixtures, "from"), template, fs.readFileSync(template, "utf-8"), function(err, result) {
+      if(err) throw err;
+
+      result.should.have.type("string");
+
+      // verify the generated module imports the `from`d templates
+      result.should.match(/require\(\"\.\/a\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/b\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/c\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/d\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/e\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/f\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/g\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/h\.html\.twig\"\);/);
+
+      done();
+    });
+  });
+});

package/test/include.test.js

@@ -0,0 +1,31 @@
+var should = require("should");
+
+var fs = require("fs");
+var path = require("path");
+
+var runLoader = require("./fakeModuleSystem");
+var twigLoader = require("../");
+
+var fixtures = path.join(__dirname, "fixtures");
+
+describe("include", function() {
+  it("should generate correct code", function(done) {
+    var template = path.join(fixtures, "include", "template.html.twig");
+    runLoader(twigLoader, path.join(fixtures, "include"), template, fs.readFileSync(template, "utf-8"), function(err, result) {
+      if(err) throw err;
+
+      result.should.have.type("string");
+
+      // verify the generated module imports the `include`d templates
+      result.should.match(/require\(\"\.\/a\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/b\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/c\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/d\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/e\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/f\.html\.twig\"\);/);
+      result.should.match(/require\(\"\.\/g\.html\.twig\"\);/);
+
+      done();
+    });
+  });
+});

package/test/loader.test.js

@@ -0,0 +1,24 @@
+var should = require("should");
+
+var fs = require("fs");
+var path = require("path");
+
+var runLoader = require("./fakeModuleSystem");
+var twigLoader = require("../");
+
+var fixtures = path.join(__dirname, "fixtures");
+
+describe("loader", function() {
+  it("should add require statement to the twig library", function(done) {
+    var template = path.join(fixtures, "loader", "template.html.twig");
+    runLoader(twigLoader, path.join(fixtures, "loader"), template, fs.readFileSync(template, "utf-8"), function(err, result) {
+      if(err) throw err;
+
+      result.should.have.type("string");
+
+      result.should.match(/require\(\"twig\"\)/);
+
+      done();
+    });
+  });
+});

package/test/sdc.test.js

@@ -0,0 +1,33 @@
+var should = require('should');
+
+var fs = require('fs');
+var path = require('path');
+
+var runLoader = require('./fakeModuleSystem');
+var twigLoader = require('../');
+
+var fixtures = path.join(__dirname, 'fixtures');
+
+describe('sdc', function() {
+    it('sdc', function(done) {
+        var template = path.join(fixtures, 'sdc', 'component-a', 'component-a.twig');
+        runLoader(
+            twigLoader,
+            null,
+            template,
+            fs.readFileSync(template, 'utf-8'),
+            function(err, result) {
+                if (err) throw err;
+
+                result.should.have.type('string');
+                
+                done();
+            },
+            {
+            sdc: {
+                    design_system: path.resolve(__dirname, './fixtures')
+                }
+            }
+        );
+    });
+});