deas 0.39.2 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  metadata.gz: a00b252a65f50835be12b3dfaa0250f7604daaa4
-  data.tar.gz: 8e0056e396f5f24f9d65f5422d8f418eb01e567c
+  metadata.gz: cc1b0541f8352e417fcaea600dfc199984f4ee5f
+  data.tar.gz: 55e89c13f41a75441fb281025d62deb3fa114080
 SHA512: 
-  metadata.gz: 01bff2c3747cf37a17ab7840bc2e332889a0acf0c436b3a9c62531cbfb83f123e1ce80ca6654bec9217b35b44106469ce76040332cbde6cd34a633563847b858
-  data.tar.gz: 2465addcff960eab76c8d9a0fa71b3105574d00b84b703461fcf7b22fda388452b8f86dafc35e0406d7f6e2382c6be1988796e7964122ed9e10e993252ea51e2
+  metadata.gz: 066f4eac74ffd2e34af998f5622291a9d3db400381e3e3b1bbb68fd819ca00880d208460462f2b340980659b1518da9a575d4b58d67a8750b099688c6b5d7187
+  data.tar.gz: c4bf700bfe1196493333e38cf2bf437841d4f86258bd6e713159c5c9838db19c5d3526ab04f18619d5fd30c6e513b8369589c91e0a368ca081ba747c41d1de57

data/lib/deas/template_engine.rb

@@ -30,10 +30,16 @@ module Deas
   class NullTemplateEngine < TemplateEngine
 
     def render(template_name, view_handler, locals, &content)
-      if (path = Dir.glob(self.source_path.join("#{template_name}*")).first).nil?
-        raise ArgumentError, "template file `#{path}` does not exist"
+      paths = Dir.glob(self.source_path.join("#{template_name}*"))
+      if paths.size > 1
+        raise ArgumentError, "#{template_name.inspect} matches more than one " \
+                             "file, consider using a more specific template name"
       end
-      File.read(path)
+      if paths.size < 1
+        raise ArgumentError, "a template file named #{template_name.inspect} " \
+                             "does not exist"
+      end
+      File.read(paths.first)
     end
 
     def partial(template_name, locals, &content)
@@ -41,7 +47,7 @@ module Deas
     end
 
     def compile(template_name, compiled_content)
-      compiled_content  # no-op, pass-thru - just return the given content
+      compiled_content # no-op, pass-thru - just return the given content
     end
 
   end

data/lib/deas/template_source.rb

@@ -5,10 +5,6 @@ module Deas
 
   class TemplateSource
 
-    DISALLOWED_ENGINE_EXTS = [ 'rb' ]
-
-    DisallowedEngineExtError = Class.new(ArgumentError)
-
     attr_reader :path, :engines
 
     def initialize(path, logger = nil)
@@ -18,7 +14,12 @@ module Deas
         'logger'                  => logger || Deas::NullLogger.new,
         'default_template_source' => self
       }
-      @engines = Hash.new{ |h, k| Deas::NullTemplateEngine.new(@default_engine_opts) }
+      @engines = Hash.new do |hash, ext|
+        # cache null template exts so we don't repeatedly call this block for
+        # known null template exts
+        hash[ext.to_s] = Deas::NullTemplateEngine.new(@default_engine_opts)
+      end
+      @engine_exts = []
       @ext_lists = Hash.new do |hash, template_name|
         # An ext list is an array of non-template-name extensions that have engines
         # configured.  The first ext in the list is the most precedent. Its engine
@@ -29,16 +30,15 @@ module Deas
     end
 
     def engine(input_ext, engine_class, registered_opts = nil)
-      if DISALLOWED_ENGINE_EXTS.include?(input_ext)
-        raise DisallowedEngineExtError, "`#{input_ext}` is disallowed as an"\
-                                        " engine extension."
-      end
+      @engine_exts << input_ext.to_s
+
       engine_opts = @default_engine_opts.merge(registered_opts || {})
+      engine_opts['ext'] = input_ext.to_s
       @engines[input_ext.to_s] = engine_class.new(engine_opts)
     end
 
     def engine_for?(ext)
-      @engines.keys.include?(ext)
+      @engine_exts.include?(ext.to_s)
     end
 
     def render(template_name, view_handler, locals, &content)
@@ -62,17 +62,29 @@ module Deas
     private
 
     def compile(name)
-      ext_list = @ext_lists[name].dup
-      ext_list.inject(yield @engines[ext_list.shift]) do |content, ext|
-        @engines[ext].compile(name, content)
+      @ext_lists[name].drop(1).inject(yield @engines[@ext_lists[name].first]) do |c, e|
+        @engines[e].compile(name, c)
       end
     end
 
     def parse_ext_list(template_name)
-      no_ext_path = "#{File.join(@path, template_name.to_s)}."
-      path = Dir.glob("#{no_ext_path}*").first || ''
-      path.sub(no_ext_path, '').split('.').reverse.reject do |ext|
-        !self.engine_for?(ext)
+      paths = Dir.glob(File.join(@path, "#{template_name}*"))
+      if paths.size > 1
+        raise ArgumentError, "#{template_name.inspect} matches more than one " \
+                             "file, consider using a more specific template name"
+      end
+      get_ext_list(paths.first.to_s)
+    end
+
+    def get_ext_list(path)
+      # get the base name of the path (file name plus extensions).  Split on the
+      # periods and drop the first value (the file name).  reverse the list b/c
+      # we process exts right-to-left.  reject any unnecessary exts.
+      File.basename(path).split('.').drop(1).reverse.reject.each_with_index do |e, i|
+        # keep the first ext (for initial render from source) and any registered
+        # exts.  remove any non-first non-registered exts so you don't have the
+        # overhead of running through the null engine for each.
+        i != 0 && !self.engine_for?(e)
       end
     end
 

data/lib/deas/version.rb

@@ -1,3 +1,3 @@
 module Deas
-  VERSION = "0.39.2"
+  VERSION = "0.40.0"
 end

data/test/support/template-compiled4.json.foo

@@ -0,0 +1 @@
+This is a json template for use in template source/engine tests.

data/test/support/template.a.json

@@ -0,0 +1 @@
+This is a json template for use in template source/engine tests.

data/test/unit/template_engine_tests.rb

@@ -86,17 +86,23 @@ class Deas::TemplateEngine
     end
 
     should "read and return the given path in its source path on `render`" do
-      template = 'test/support/template'
+      template = ['test/support/template.a', 'test/support/template.a.json'].choice
       exp = File.read(Dir.glob(subject.source_path.join("#{template}*")).first)
       assert_equal exp, subject.render(template, @v, @l)
     end
 
     should "call `render` to implement its `partial` method" do
-      template = 'test/support/template'
+      template = ['test/support/template.a', 'test/support/template.a.json'].choice
       exp = subject.render(template, nil, @l)
       assert_equal exp, subject.partial(template, @l)
     end
 
+    should "complain if given a path that matches multiple files" do
+      template = 'test/support/template'
+      assert_raises(ArgumentError){ subject.render(template, @v, @l) }
+      assert_raises(ArgumentError){ subject.partial(template, @l) }
+    end
+
     should "complain if given a path that does not exist in its source path" do
       template = '/does/not/exists'
       assert_raises(ArgumentError){ subject.render(template, @v, @l) }

data/test/unit/template_source_tests.rb

@@ -10,11 +10,6 @@ class Deas::TemplateSource
     desc "Deas::TemplateSource"
     subject{ Deas::TemplateSource }
 
-    should "disallow certain engine extensions" do
-      exp = [ 'rb' ]
-      assert_equal exp, subject::DISALLOWED_ENGINE_EXTS
-    end
-
   end
 
   class InitTests < Assert::Context
@@ -45,49 +40,48 @@ class Deas::TemplateSource
       assert_kind_of Deas::NullTemplateEngine, subject.engines['test']
       subject.engine 'test', @test_engine
       assert_kind_of @test_engine, subject.engines['test']
+
+      assert_true  subject.engine_for?('test')
+      assert_false subject.engine_for?(Factory.string)
     end
 
     should "register with default options" do
-      subject.engine 'test', @test_engine
+      engine_ext = Factory.string
+      subject.engine engine_ext, @test_engine
       exp_opts = {
         'source_path'             => subject.path,
         'logger'                  => @logger,
-        'default_template_source' => subject
+        'default_template_source' => subject,
+        'ext'                     => engine_ext
       }
-      assert_equal exp_opts, subject.engines['test'].opts
+      assert_equal exp_opts, subject.engines[engine_ext].opts
+      assert_true subject.engine_for?(engine_ext)
 
-      subject.engine 'test', @test_engine, 'an' => 'opt'
+      custom_opts = { Factory.string => Factory.string }
+      subject.engine engine_ext, @test_engine, custom_opts
       exp_opts = {
         'source_path'             => subject.path,
         'logger'                  => @logger,
         'default_template_source' => subject,
-        'an'                      => 'opt'
-      }
-      assert_equal exp_opts, subject.engines['test'].opts
+        'ext'                     => engine_ext
+      }.merge(custom_opts)
+      assert_equal exp_opts, subject.engines[engine_ext].opts
+      assert_true subject.engine_for?(engine_ext)
 
-      subject.engine('test', @test_engine, {
+      custom_opts = {
         'source_path'             => 'something',
         'logger'                  => 'another',
-        'default_template_source' => 'tempsource'
-      })
-      exp_opts = {
-        'source_path'             => 'something',
-        'logger'                  => 'another',
-        'default_template_source' => 'tempsource'
+        'default_template_source' => 'tempsource',
+        'ext'                     => Factory.string
       }
-      assert_equal exp_opts, subject.engines['test'].opts
+      subject.engine(engine_ext, @test_engine, custom_opts)
+      exp_opts = custom_opts.merge('ext' => engine_ext)
+      assert_equal exp_opts, subject.engines[engine_ext].opts
+      assert_true subject.engine_for?(engine_ext)
 
       source = Deas::TemplateSource.new(@source_path)
-      source.engine('test', @test_engine)
-      assert_instance_of Deas::NullLogger, source.engines['test'].opts['logger']
-    end
-
-    should "complain if registering a disallowed temp" do
-      assert_kind_of Deas::NullTemplateEngine, subject.engines['rb']
-      assert_raises DisallowedEngineExtError do
-        subject.engine 'rb', @test_engine
-      end
-      assert_kind_of Deas::NullTemplateEngine, subject.engines['rb']
+      source.engine(engine_ext, @test_engine)
+      assert_instance_of Deas::NullLogger, source.engines[engine_ext].opts['logger']
     end
 
   end
@@ -112,25 +106,29 @@ class Deas::TemplateSource
       assert_equal exp, subject.render('test_template', @v, @l)
     end
 
-    should "only render the first template file matching the template name" do
-      # there should be 2 files called "template" in `test/support` with diff
-      # extensions
-      exp = "render-json-engine on template\n"
-      assert_equal exp, subject.render('template', @v, @l)
-    end
-
     should "compile multiple engine outputs if template has multi-engine exts" do
       exp = "render-json-engine on template-compiled1\ncompile-test-engine"
       assert_equal exp, subject.render('template-compiled1', @v, @l)
 
       exp = "render-test-engine on template-compiled2\ncompile-json-engine"
       assert_equal exp, subject.render('template-compiled2', @v, @l)
+
+      exp = "render-json-engine on template-compiled3\n"
+      assert_equal exp, subject.render('template-compiled3', @v, @l)
+
+      exp = "This is a json template for use in template source/engine tests.\n"\
+            "compile-json-engine"
+      assert_equal exp, subject.render('template-compiled4', @v, @l)
+    end
+
+    should "complain if the given template name matches multiple templates" do
+      # there should be more than 1 file called "template" in `test/support`
+      # with various extensions
+      assert_raises(ArgumentError){ subject.render('template', @v, @l) }
     end
 
     should "use the null template engine when an engine can't be found" do
-      assert_raises(ArgumentError) do
-        subject.render(Factory.string, @v, @l)
-      end
+      assert_raises(ArgumentError){ subject.render(Factory.string, @v, @l) }
     end
 
   end
@@ -158,13 +156,6 @@ class Deas::TemplateSource
       assert_equal exp, subject.partial('test_template', @l)
     end
 
-    should "only render the first template file matching the template name" do
-      # there should be 2 files called "template" in `test/support` with diff
-      # extensions
-      exp = "partial-json-engine on template\n"
-      assert_equal exp, subject.partial('template', @l)
-    end
-
     should "compile multiple engine outputs if template has multi-engine exts" do
       exp = "partial-json-engine on template-compiled1\ncompile-test-engine"
       assert_equal exp, subject.partial('template-compiled1', @l)
@@ -173,10 +164,14 @@ class Deas::TemplateSource
       assert_equal exp, subject.partial('template-compiled2', @l)
     end
 
+    should "complain if the given template name matches multiple templates" do
+      # there should be more than 1 file called "template" in `test/support`
+      # with various extensions
+      assert_raises(ArgumentError){ subject.partial('template', @l) }
+    end
+
     should "use the null template engine when an engine can't be found" do
-      assert_raises(ArgumentError) do
-        subject.partial(Factory.string, @l)
-      end
+      assert_raises(ArgumentError){ subject.partial(Factory.string, @l) }
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: deas
 version: !ruby/object:Gem::Version 
-  version: 0.39.2
+  version: 0.40.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2016-04-05 00:00:00 Z
+date: 2016-04-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assert
@@ -126,7 +126,9 @@ files:
 - test/support/show.json
 - test/support/template-compiled1.test.json
 - test/support/template-compiled2.json.test
-- test/support/template.json
+- test/support/template-compiled3.foo.json
+- test/support/template-compiled4.json.foo
+- test/support/template.a.json
 - test/support/template.z.erb
 - test/support/test_layout1.test
 - test/support/test_layout2.test
@@ -193,7 +195,9 @@ test_files:
 - test/support/show.json
 - test/support/template-compiled1.test.json
 - test/support/template-compiled2.json.test
-- test/support/template.json
+- test/support/template-compiled3.foo.json
+- test/support/template-compiled4.json.foo
+- test/support/template.a.json
 - test/support/template.z.erb
 - test/support/test_layout1.test
 - test/support/test_layout2.test