sanford 0.16.1 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA512: 
-  data.tar.gz: 81515e6dbc607826d511c14f4423afc408d58787cc5ba1b791d29b4d44f464ec05560c5165cdf16aa45e02233eef2e80d6d9a11458ffd63adb9daa77440e3a20
-  metadata.gz: 20da29417dddee1768e3b64d29b945bc92826e548cdd7b38c8a85214522393d65477d02398f905e5f8a9640b3f0fc7f15f2619fa7233885ba6948c6f88752202
+  metadata.gz: 179edb42ed70349903ee1c61dac5d041ce8ccf2224121e952871965635ea4f26541f58468c3f7bfc6842dfae80551993dae461845024e26a89bfbbfb315f144a
+  data.tar.gz: dc50fc52dcabe5aaea8969654bdd1af13fc40cb1bd62ffaafc38a845b3fe1127a17b1f1adfcd2880a828a18241b869c5f4ad3782c71bcd40c5635d285e633a3a
 SHA1: 
-  data.tar.gz: d2a9c2b2c446cf36c7a09b80b1f182ac444058cf
-  metadata.gz: a68ed5854a158d2c9d0c19cda28cb61fc51149ea
+  metadata.gz: da5833891f1c7570eb1cb642bbd506487eb2f3c8
+  data.tar.gz: 3b093248ea8ac8cd931f1cb05db52d676a34494c

data/lib/sanford/template_engine.rb

@@ -13,7 +13,7 @@ module Sanford
       @logger = @opts['logger'] || Sanford::NullLogger.new
     end
 
-    def render(path, service_handler, locals)
+    def render(name, service_handler, locals)
       raise NotImplementedError
     end
 
@@ -30,12 +30,17 @@ module Sanford
 
   class NullTemplateEngine < TemplateEngine
 
-    def render(path, service_handler, locals)
-      template_file = self.source_path.join(path).to_s
-      unless File.exists?(template_file)
-        raise ArgumentError, "template file `#{template_file}` does not exist"
+    def render(template_name, service_handler, locals)
+      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(template_file)
+      if paths.size < 1
+        raise ArgumentError, "a template file named #{template_name.inspect} " \
+                             "does not exist"
+      end
+      File.read(paths.first.to_s)
     end
 
   end

data/lib/sanford/template_source.rb

@@ -5,10 +5,6 @@ module Sanford
 
   class TemplateSource
 
-    DISALLOWED_ENGINE_EXTS = [ 'rb' ]
-
-    DisallowedEngineExtError = Class.new(ArgumentError)
-
     attr_reader :path, :engines
 
     def initialize(path, logger = nil)
@@ -17,29 +13,32 @@ module Sanford
         'source_path' => @path,
         'logger'      => logger || Sanford::NullLogger.new
       }
-      @engines = Hash.new{ |h,k| Sanford::NullTemplateEngine.new(@default_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] = Sanford::NullTemplateEngine.new(@default_opts)
+      end
+      @engine_exts = []
     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_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 engine_for_template?(template_name)
       self.engine_for?(get_template_ext(template_name))
     end
 
-    def render(template_path, service_handler, locals)
-      engine = @engines[get_template_ext(template_path)]
-      engine.render(template_path, service_handler, locals)
+    def render(template_name, service_handler, locals)
+      engine = @engines[get_template_ext(template_name)]
+      engine.render(template_name, service_handler, locals)
     end
 
     def ==(other_template_source)
@@ -53,14 +52,17 @@ module Sanford
 
     private
 
-    def get_template_ext(template_path)
-      files = Dir.glob("#{File.join(@path, template_path.to_s)}.*")
-      files = files.reject{ |p| !@engines.keys.include?(parse_ext(p)) }
-      parse_ext(files.first.to_s || '')
+    def get_template_ext(template_name)
+      files = Dir.glob("#{File.join(@path, template_name.to_s)}*")
+      if files.size > 1
+        raise ArgumentError, "#{template_name.inspect} matches more than one " \
+                             "file, consider using a more specific template name"
+      end
+      parse_ext(files.first.to_s)
     end
 
-    def parse_ext(template_path)
-      File.extname(template_path)[1..-1]
+    def parse_ext(template_name)
+      File.extname(template_name)[1..-1]
     end
 
   end

data/lib/sanford/version.rb

@@ -1,3 +1,3 @@
 module Sanford
-  VERSION = "0.16.1"
+  VERSION = "0.17.0"
 end

data/test/support/conflict_template.erb

@@ -0,0 +1 @@
+This is an erb template for use in template engine tests.

data/test/unit/template_engine_tests.rb

@@ -70,11 +70,18 @@ class Sanford::TemplateEngine
     end
 
     should "read and return the given path in its source path on `render" do
-      exists_file = 'test/support/template.json'
-      exp = File.read(subject.source_path.join(exists_file).to_s)
+      exists_file = ['test/support/template', 'test/support/template.erb'].choice
+      exp = File.read(Dir.glob("#{subject.source_path.join(exists_file)}*").first)
       assert_equal exp, subject.render(exists_file, @service_handler, @locals)
     end
 
+    should "complain if given a path that matches multiple files" do
+      conflict_file = 'test/support/conflict_template'
+      assert_raises ArgumentError do
+        subject.render(conflict_file, @service_handler, @locals)
+      end
+    end
+
     should "complain if given a path that does not exist in its source path" do
       no_exists_file = '/does/not/exists'
       assert_raises ArgumentError do

data/test/unit/template_source_tests.rb

@@ -10,11 +10,6 @@ class Sanford::TemplateSource
     desc "Sanford::TemplateSource"
     subject{ Sanford::TemplateSource }
 
-    should "disallow certain engine extensions" do
-      exp = [ 'rb' ]
-      assert_equal exp, subject::DISALLOWED_ENGINE_EXTS
-    end
-
   end
 
   class InitTests < Assert::Context
@@ -45,45 +40,45 @@ class Sanford::TemplateSource
       assert_kind_of Sanford::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
+        'logger'      => @logger,
+        '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)
 
       source = Sanford::TemplateSource.new(@source_path)
-      source.engine 'test', @test_engine
-      assert_kind_of Sanford::NullLogger, source.engines['test'].opts['logger']
+      source.engine engine_ext, @test_engine
+      assert_kind_of Sanford::NullLogger, source.engines[engine_ext].opts['logger']
 
-      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,
-        'an'          => 'opt'
-      }
-      assert_equal exp_opts, subject.engines['test'].opts
-
-      subject.engine('test', @test_engine, {
-        'source_path' => 'something',
-        'logger'      => 'another'
-      })
-      exp_opts = {
-        'source_path' => 'something',
-        'logger'      => 'another'
+        'ext'         => engine_ext
+      }.merge(custom_opts)
+      assert_equal exp_opts, subject.engines[engine_ext].opts
+      assert_true subject.engine_for?(engine_ext)
+
+      custom_opts = {
+        'source_path' => Factory.string,
+        'logger'      => Factory.string,
+        'ext'         => Factory.string
       }
-      assert_equal exp_opts, subject.engines['test'].opts
-    end
-
-    should "complain if registering a disallowed temp" do
-      assert_kind_of Sanford::NullTemplateEngine, subject.engines['rb']
-      assert_raises DisallowedEngineExtError do
-        subject.engine 'rb', @test_engine
-      end
-      assert_kind_of Sanford::NullTemplateEngine, subject.engines['rb']
+      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)
     end
 
     should "know if it has an engine registered for a given template name" do
@@ -110,13 +105,9 @@ class Sanford::TemplateSource
       locals = { :something => Factory.string }
       result = subject.render('test_template', TestServiceHandler, locals)
       assert_equal 'test-engine', result
-    end
 
-    should "only try rendering template files its has engines for" do
-      # there should be 2 files called "template" in `test/support` with diff
-      # extensions
-      result = subject.render('template', TestServiceHandler, {})
-      assert_equal 'json-engine', result
+      result = subject.render('test_template.test', TestServiceHandler, locals)
+      assert_equal 'test-engine', result
     end
 
     should "use the null template engine when an engine can't be found" do
@@ -125,6 +116,14 @@ class Sanford::TemplateSource
       end
     end
 
+    should "complain if the given template name matches multiple templates" do
+      # there should be 2 files called "conflict_template" in `test/support`
+      # with diff extensions
+      assert_raises(ArgumentError) do
+        subject.render('conflict_template', TestServiceHandler, {})
+      end
+    end
+
   end
 
   class NullTemplateSourceTests < Assert::Context

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sanford
 version: !ruby/object:Gem::Version 
-  version: 0.16.1
+  version: 0.17.0
 platform: ruby
 authors: 
 - Collin Redding
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2016-03-14 00:00:00 Z
+date: 2016-04-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assert
@@ -110,11 +110,12 @@ files:
 - test/support/config.sanford
 - test/support/config_invalid_run.sanford
 - test/support/config_no_run.sanford
+- test/support/conflict_template.erb
+- test/support/conflict_template.json
 - test/support/factory.rb
 - test/support/fake_server_connection.rb
 - test/support/pid_file_spy.rb
 - test/support/template.erb
-- test/support/template.json
 - test/support/test_disallowed_template.rb
 - test/support/test_template.test
 - test/system/server_tests.rb
@@ -171,11 +172,12 @@ test_files:
 - test/support/config.sanford
 - test/support/config_invalid_run.sanford
 - test/support/config_no_run.sanford
+- test/support/conflict_template.erb
+- test/support/conflict_template.json
 - test/support/factory.rb
 - test/support/fake_server_connection.rb
 - test/support/pid_file_spy.rb
 - test/support/template.erb
-- test/support/template.json
 - test/support/test_disallowed_template.rb
 - test/support/test_template.test
 - test/system/server_tests.rb