Rewrote codebase in ES2015, divided into smaller files, use latest Meteor templating API

Author: aldeed

.jshintrc

@@ -0,0 +1,18 @@
+{
+  "curly": false,
+  "esnext": true,
+  "globals": {
+    "Hooks": true
+  },
+  "predef": [
+    "Blaze",
+    "EJSON",
+    "Meteor",
+    "Package",
+    "Template",
+    "Tinytest",
+    "Tracker",
+    "_",
+    "$"
+  ]
+}

.versions

@@ -1,35 +1,51 @@
-aldeed:[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-local-test:aldeed:[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
-[email protected]
+aldeed:[email protected]
+[email protected]_1
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+local-test:aldeed:[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]_1
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]
+[email protected]

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Eric Dobbertin
+Copyright (c) 2014-2015 Eric Dobbertin
 
 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

README.md

@@ -16,20 +16,46 @@ A smart package for Meteor that allows you to:
 * use `template.get(fieldName)` to access the first field named `fieldName` in the current or ancestor template instances.
 * pass a function to `Template.parentData(fun)` to get the first data context which passes the test.
 
-## Prerequisites
-
-Requires Meteor 1.0+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Installation](#installation)
+- [Compatibility](#compatibility)
+- [Template.forEach(callback)](#templateforeachcallback)
+- [Template.forEachCurrentlyRenderedInstance(callback)](#templateforeachcurrentlyrenderedinstancecallback)
+- [Template.onCreated / Template.onRendered / Template.onDestroyed](#templateoncreated--templateonrendered--templateondestroyed)
+- [hooks(options)](#hooksoptions)
+- [replaces(templateName)](#replacestemplatename)
+- [inheritsHelpersFrom(templateName), inheritsEventsFrom(templateName), and inheritsHooksFrom(templateName)](#inheritshelpersfromtemplatename-inheritseventsfromtemplatename-and-inheritshooksfromtemplatename)
+- [clearEventMaps()](#cleareventmaps)
+- [copyAs(newTemplateName)](#copyasnewtemplatename)
+- [template.parent(numLevels, includeBlockHelpers)](#templateparentnumlevels-includeblockhelpers)
+- [template.get(fieldName)](#templategetfieldname)
+- [Template.parentData(fun)](#templateparentdatafun)
+- [Contributors](#contributors)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 ## Installation
 
 ```bash
 $ meteor add aldeed:template-extension
 ```
 
+## Compatibility
+
+- Use a 3.x.x release with Meteor 1.0.x or Meteor 1.1.x
+- Use a 4.x.x release with Meteor 1.2+
+
 ## Template.forEach(callback)
 
 Call `callback` once for each defined template. Generally, you'll want to call this in a `Meteor.startup` function or sometime after all templates have been loaded.
 
+## Template.forEachCurrentlyRenderedInstance(callback)
+
+Call `callback` once for each template instance that is currently rendered.
+
 ## Template.onCreated / Template.onRendered / Template.onDestroyed
 
 Run a function whenever *any* template is created/rendered/destroyed.
@@ -43,7 +69,7 @@ Template.onRendered(function () {
 
 ## hooks(options)
 
-Use this instead of setting created/rendered/destroyed property directly. You can call it multiple times to attach multiple hooks to the same template.
+An alternative syntax to `onCreated`, `onRendered`, and `onDestroyed`.
 
 ```js
 Template.foo.hooks({
@@ -82,9 +108,11 @@ Template.foo.hooks({
 *client.js*
 
 ```js
-Template.foo.bar = function () {
-  return "TEST";
-};
+Template.foo.helpers({
+  bar: function () {
+    return "TEST";
+  }
+});
 
 Template.foo.events({
   'click button': function (event, template) {
@@ -99,6 +127,8 @@ Whenever `{{> foo}}` is used, the contents of the `foo2` template will be shown
 
 This is useful when a package you are using defines a template for something and you'd like to adjust some things in that template for your app.
 
+NOTE: This simply swaps the render function. Helpers, callbacks, and events assigned to `foo2` will not fire when `{{> foo}}` is used. Only the `foo` helpers, callbacks, and events are used.
+
 ## inheritsHelpersFrom(templateName), inheritsEventsFrom(templateName), and inheritsHooksFrom(templateName)
 
 *html*
@@ -147,6 +177,10 @@ In this example, both templates are rendered. Both use the `bar` helper defined
 
 Additionally, these methods can be called with an array of template names: `Template.foo2.inheritsHooksFrom(['foo', 'bar', 'baz']);`
 
+## clearEventMaps()
+
+After `Template.foo.events({...})` has been called one or more times, you can remove all the added event handlers by calling `Template.foo.clearEventMaps()`
+
 ## copyAs(newTemplateName)
 
 *html*
@@ -204,7 +238,7 @@ they are not.
 ## template.get(fieldName)
 
 To not have to hard-code the number of levels when accessing parent template instances you can use
-`get(fieldName)` method which returns the value of the first field named `fieldName` in the current
+`get(fieldName)` method which returns the value of the first property named `fieldName` on the current
 or ancestor template instances, traversed in the hierarchical order. It traverses block helper template
 instances as well. This pattern makes it easier to refactor templates without having to worry about
 changes to number of levels.
@@ -223,7 +257,7 @@ var data = Template.parentData(function (data) {return data instanceof MyDocumen
 
 ## Contributors
 
-* @aldeed ([Support via Gratipay](https://gratipay.com/aldeed/))
+* @aldeed
 * @grabbou
 * @mitar
 * @jgladch

lib/hooks.js

@@ -0,0 +1,39 @@
+Hooks = {
+  global: {
+    created: [],
+    rendered: [],
+    destroyed: []
+  },
+  master: {
+    created: function () {
+      Hooks.runGlobal('created', this, arguments);
+    },
+    rendered: function () {
+      Hooks.runGlobal('rendered', this, arguments);
+    },
+    destroyed: function () {
+      Hooks.runGlobal('destroyed', this, arguments);
+    }
+  }
+};
+
+Hooks.addGlobal = (template) => {
+  // For each hookType, define the hooks for this template.
+  // Since we might call this multiple times from startup code
+  // and other functions, make sure we do it only once.
+  // Doing it twice would create an infinite loop of self-calling
+  // hooks.
+  if (!template._hasTemplateExtensionMasterHooks) {
+    template.onCreated(Hooks.master.created);
+    template.onRendered(Hooks.master.rendered);
+    template.onDestroyed(Hooks.master.destroyed);
+
+    template._hasTemplateExtensionMasterHooks = true;
+  }
+};
+
+Hooks.runGlobal = (type, template, args) => {
+  for (let hook of Hooks.global[type]) {
+    hook.apply(template, args);
+  }
+};

lib/template-clear-event-maps.js

@@ -0,0 +1,3 @@
+Template.prototype.clearEventMaps = function clearEventMaps() {
+  this.__eventMaps = [];
+};

lib/template-copy-as.js

@@ -0,0 +1,25 @@
+Template.prototype.copyAs = function copyAs(newTemplateName) {
+  var self = this;
+
+  function createNewTemplate(templateName) {
+    var newTemplate =
+    Template[templateName] = new Template(`Template.${templateName}`, self.renderFunction);
+
+    newTemplate.inheritsHelpersFrom(self);
+    newTemplate.inheritsEventsFrom(self);
+    newTemplate.inheritsHooksFrom(self);
+
+    return newTemplate;
+  }
+
+  // Check if newTemplateName is an array
+  if (_.isArray(newTemplateName)) {
+    let result = [];
+    for (let name of newTemplateName) {
+      result.push(createNewTemplate(name));
+    }
+    return result;
+  } else { //newTemplateName is a string
+    return createNewTemplate(newTemplateName);
+  }
+};

lib/template-for-each-instance.js

@@ -0,0 +1,14 @@
+Template._renderedInstances = [];
+
+Template.onRendered(function () {
+  Template._renderedInstances.push(this);
+});
+
+Template.onDestroyed(function () {
+  var i = Template._renderedInstances.indexOf(this);
+  if (i > -1) Template._renderedInstances.splice(i, 1);
+});
+
+Template.forEachCurrentlyRenderedInstance = (func) => {
+  Template._renderedInstances.forEach(func);
+};

lib/template-for-each.js

@@ -0,0 +1,21 @@
+Template.forEach = (callback) => {
+  // for some reason we get the "body" template twice when looping, so
+  // we track that and only call the callback once.
+  var alreadyDidBody = false;
+  for (var t in Template) {
+    if (Template.hasOwnProperty(t)) {
+      var tmpl = Template[t];
+      if (Blaze.isTemplate(tmpl)) {
+        let name = tmpl.viewName;
+        if (name === "body") {
+          if (!alreadyDidBody) {
+            alreadyDidBody = true;
+            callback(tmpl);
+          }
+        } else if (name !== 'Template.__dynamic' && name !== 'Template.__dynamicWithDataContext') {
+          callback(tmpl);
+        }
+      }
+    }
+  }
+};

lib/template-global-hooks.js

@@ -0,0 +1,20 @@
+// Setup for multiple hooks support
+// We assume that no other code will be directly defining
+// a hook once the client has started.
+Meteor.startup(() => {
+  Template.forEach((template) => {
+    Hooks.addGlobal(template);
+  });
+});
+
+Template.onCreated = (hook) => {
+  Hooks.global.created.push(hook);
+};
+
+Template.onRendered = (hook) => {
+  Hooks.global.rendered.push(hook);
+};
+
+Template.onDestroyed = (hook) => {
+  Hooks.global.destroyed.push(hook);
+};

lib/template-hooks.js

@@ -0,0 +1,9 @@
+Template.prototype.hooks = function (hooks) {
+  if (!hooks || typeof hooks !== "object") {
+    throw new Error("hooks argument must be an object with created, rendered, and/or destroyed properties, each set to a function");
+  }
+
+  if (typeof hooks.created === 'function') this.onCreated(hooks.created);
+  if (typeof hooks.rendered === 'function') this.onRendered(hooks.rendered);
+  if (typeof hooks.destroyed === 'function') this.onDestroyed(hooks.destroyed);
+};

lib/template-inherits-events-from.js

@@ -0,0 +1,20 @@
+Template.prototype.inheritsEventsFrom = function inheritsEventsFrom(otherTemplate) {
+  var self = this;
+
+  self.__eventMaps = self.__eventMaps || [];
+
+  function inheritEvents(template) {
+    // String template names can be provided and template object is looked up
+    if (typeof template === 'string') template = Template[template];
+    if (!template) return;
+
+    self.__eventMaps = self.__eventMaps.concat(template.__eventMaps);
+  }
+
+  // Accept an array as otherTemplate argument
+  if (_.isArray(otherTemplate)) {
+    _.each(otherTemplate, inheritEvents);
+  } else { //otherTemplate is a string
+    inheritEvents(otherTemplate);
+  }
+};