Merge pull request #41 from zyoung51/feature/template-scope

GRIP-17: Add scoping to templates
RackHD · Dec 8, 2015 · cce3e65 · cce3e65
2 parents dd0bdf1 + 6d2f92f
commit cce3e65
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 12 deletions.
diff --git a/lib/common/template.js b/lib/common/template.js
@@ -57,9 +57,10 @@ function templateServiceFactory(FileLoader, Constants, Promise, _, waterline, Lo
         });
     };
 
-    TemplateService.prototype.put = function (file, contents) {
+    TemplateService.prototype.put = function (file, contents, scope) {
+        scope = scope || 'global';
         return Promise.resolve(
-            waterline.templates.findOne({ name: file })
+            waterline.templates.findOne({ name: file, scope: scope })
             .then(function(doc) {
                 if (!_.isEmpty(doc)) {
                     return waterline.templates.update(
@@ -70,24 +71,39 @@ function templateServiceFactory(FileLoader, Constants, Promise, _, waterline, Lo
                     return waterline.templates.create(
                         {
                             name: file,
-                            contents: contents
+                            contents: contents,
+                            scope: scope
                         }
                     );
                 }
             })
         );
     };
 
-    TemplateService.prototype.get = function (name) {
-        return waterline.templates.findOne({ name: name });
+    TemplateService.prototype.get = function (name, scope) {
+        scope = scope || ['global'];
+
+        // The position of the tag defines the scope priority
+        var scopeWeight = {}, i = 1;
+        _.forEach(scope, function(item) {
+            scopeWeight[item] = i;
+            i += 1;
+        });
+
+        return waterline.templates.find({name: name, scope: scope}).then(function(templates) {
+            templates.sort(function(a,b) {
+                return scopeWeight[a.scope] - scopeWeight[b.scope];
+            });
+            return templates[0];
+        });
     };
 
     TemplateService.prototype.getAll = function () {
         return waterline.templates.find();
     };
 
-    TemplateService.prototype.render = function render (name, options) {
-        return this.get(name).then(function (template) {
+    TemplateService.prototype.render = function render (name, options, scope) {
+        return this.get(name, scope).then(function (template) {
             return ejs.render(template.contents, options);
         });
     };

diff --git a/lib/models/template.js b/lib/models/template.js
@@ -21,6 +21,10 @@ function TemplateModelFactory (Model) {
             contents: {
                 type: 'string',
                 required: true
+            },
+            scope: {
+                type: 'string',
+                defaultsTo: 'global'
             }
         }
     });

diff --git a/spec/lib/common/template-spec.js b/spec/lib/common/template-spec.js
@@ -77,23 +77,80 @@ describe('Templates', function () {
         });
 
         it('should get a template', function() {
-            waterline.templates.findOne.resolves('test contents');
+            waterline.templates.find.resolves(['test contents']);
             return this.subject.get('test template')
             .then(function(out) {
                 expect(out).to.equal('test contents');
-                expect(waterline.templates.findOne)
-                    .to.have.been.calledWith({ name: 'test template' });
+                expect(waterline.templates.find)
+                    .to.have.been.calledWith({ name: 'test template', scope: ['global'] });
             });
         });
 
-        it('should create a new template', function() {
+        it('should get the template in the right scope', function() {
+            var templates = [
+                { name: 'template', contents: 'global scope', scope: 'global'},
+                { name: 'template', contents: 'a scope', scope: 'a'},
+                { name: 'template', contents: 'b scope', scope: 'b'}
+            ];
+            var scope = ['b', 'a', 'global'];
+            waterline.templates.find.resolves(templates);
+            return this.subject.get('template', scope)
+            .then(function(out) {
+                expect(out.contents).to.equal('b scope');
+                expect(waterline.templates.find)
+                    .to.have.been.calledWith({ name: 'template', scope: scope });
+            });
+        });
+
+        it('should be empty when the scope does not exist', function() {
+            var templates = [];
+            var scope = ['b'];
+            waterline.templates.find.resolves(templates);
+            return this.subject.get('template', scope)
+            .then(function(out) {
+                expect(out).to.equal(undefined);
+                expect(waterline.templates.find)
+                    .to.have.been.calledWith({ name: 'template', scope: scope });
+            });
+        });
+
+        it('should get the next template when the scope does not exist', function() {
+            var templates = [
+                { name: 'template', contents: 'global scope', scope: 'global'},
+                { name: 'template', contents: 'a scope', scope: 'a'}
+            ];
+            var scope = ['b', 'a', 'global'];
+            waterline.templates.find.resolves(templates);
+            return this.subject.get('template', scope)
+            .then(function(out) {
+                expect(out.contents).to.equal('a scope');
+                expect(waterline.templates.find)
+                    .to.have.been.calledWith({ name: 'template', scope: scope });
+            });
+        });
+
+        it('should create a new template in global scope', function() {
             var self = this;
             waterline.templates.findOne.resolves(null);
             return self.subject.put('test template', 'test contents')
             .then(function() {
                 expect(waterline.templates.create).to.have.been.calledWith({
                     name: 'test template',
-                    contents: 'test contents'
+                    contents: 'test contents',
+                    scope: 'global'
+                });
+            });
+        });
+
+        it('should create a new template in the specified scope', function() {
+            var self = this;
+            waterline.templates.findOne.resolves(null);
+            return self.subject.put('test template', 'test contents', 'sku')
+            .then(function() {
+                expect(waterline.templates.create).to.have.been.calledWith({
+                    name: 'test template',
+                    contents: 'test contents',
+                    scope: 'sku'
                 });
             });
         });