sanford 0.19.0 → 0.19.1

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
-SHA1: 
-  data.tar.gz: be152ddfab1bc45693e6d3f7770fb2dcac53e7ac
-  metadata.gz: 550b49e83a11d06488fbdddcec205ef4adb7df58
 SHA512: 
-  data.tar.gz: 5ffb0877eaf187acc36e3a681478d90f867ab5e5156074ab56427c03df8f35eea17be19071d5bffbef79f1ed1784bfa6f6fbcfc5c12c8c6b91f5e02580cbcdd5
-  metadata.gz: 688a1b30785ba2d731e93f7b4ca513a6b8797654177b3414999f28330d9b78efd7a555b4f3e2314bb6ae7f0112d6146f346170aea3cb2d7ad79a7340337d74b2
+  data.tar.gz: 37d9c67d1935a3a4de78f3fae6fd4f01127d5cea1e516c3e312f0dd4a61a33e4d4bf7296b3e73d67823113938d6aecb2177bb1044180667f92f9d44b6e7a73f6
+  metadata.gz: b5b32bfaf14577c18ce4da0506753aae3ebff7f4fee0e858a1c43e5b090d59117a6f713854cd7f7ed51a543b59a18b6d1456a510da191bdc24d85d3a085399f6
+SHA1: 
+  data.tar.gz: f630d9098164756eec0de60f38a03567c357be3b
+  metadata.gz: ed54304eab935901a6f8882e713dd58a2878659b

data/Gemfile

@@ -2,5 +2,5 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'pry', "~> 0.9.0"
-gem 'bson_ext', '~>1.7'
+gem 'pry',      "~> 0.9.0"
+gem 'bson_ext', "~> 1.7"

data/lib/sanford/runner.rb

@@ -68,6 +68,10 @@ module Sanford
       self.data(self.template_source.render(path, self.handler, locals || {}))
     end
 
+    def partial(path, locals = nil)
+      self.data(self.template_source.partial(path, locals || {}))
+    end
+
   end
 
 end

data/lib/sanford/service_handler.rb

@@ -62,10 +62,11 @@ module Sanford
       def params;  @sanford_runner.params;  end
 
       # response
-      def status(*args); @sanford_runner.status(*args); end
-      def data(*args);   @sanford_runner.data(*args);   end
-      def halt(*args);   @sanford_runner.halt(*args);   end
-      def render(*args); @sanford_runner.render(*args); end
+      def status(*args);  @sanford_runner.status(*args);  end
+      def data(*args);    @sanford_runner.data(*args);    end
+      def halt(*args);    @sanford_runner.halt(*args);    end
+      def render(*args);  @sanford_runner.render(*args);  end
+      def partial(*args); @sanford_runner.partial(*args); end
 
     end
 

data/lib/sanford/template_engine.rb

@@ -17,6 +17,10 @@ module Sanford
       raise NotImplementedError
     end
 
+    def partial(name, locals)
+      raise NotImplementedError
+    end
+
     def ==(other_engine)
       if other_engine.kind_of?(TemplateEngine)
         self.source_path == other_engine.source_path &&
@@ -31,6 +35,10 @@ module Sanford
   class NullTemplateEngine < TemplateEngine
 
     def render(template_name, service_handler, locals)
+      self.partial(template_name, locals)
+    end
+
+    def partial(template_name, locals)
       paths = Dir.glob(self.source_path.join("#{template_name}*"))
       if paths.size > 1
         raise ArgumentError, "#{template_name.inspect} matches more than one " \

data/lib/sanford/template_source.rb

@@ -41,6 +41,11 @@ module Sanford
       engine.render(template_name, service_handler, locals)
     end
 
+    def partial(template_name, locals)
+      engine = @engines[get_template_ext(template_name)]
+      engine.partial(template_name, locals)
+    end
+
     def ==(other_template_source)
       if other_template_source.kind_of?(TemplateSource)
         self.path    == other_template_source.path &&

data/lib/sanford/version.rb

@@ -1,3 +1,3 @@
 module Sanford
-  VERSION = "0.19.0"
+  VERSION = "0.19.1"
 end

data/sanford.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency("assert", ["~> 2.16.1"])
+  gem.add_development_dependency("assert", ["~> 2.16.3"])
 
   gem.add_dependency("dat-tcp",          ["~> 0.8.2"])
   gem.add_dependency("much-plugin",      ["~> 0.2.0"])

data/test/support/app_server.rb

@@ -21,6 +21,14 @@ class AppERBEngine < Sanford::TemplateEngine
     b = RenderScope.new(service_handler).get_binding
     ERB.new(File.read(full_path)).result(b)
   end
+
+  def partial(path, locals)
+    require 'erb'
+    full_path = ROOT_PATH.join("test/support/#{path}.erb")
+
+    b = RenderScope.new(nil).get_binding
+    ERB.new(File.read(full_path)).result(b)
+  end
 end
 
 class AppServer
@@ -38,12 +46,13 @@ class AppServer
   router do
     service_handler_ns 'AppHandlers'
 
-    service 'echo',         'Echo'
-    service 'raise',        'Raise'
-    service 'bad_response', 'BadResponse'
-    service 'template',     'Template'
-    service 'halt',         'Halt'
-    service 'custom_error', 'CustomError'
+    service 'echo',             'Echo'
+    service 'raise',            'Raise'
+    service 'bad_response',     'BadResponse'
+    service 'render_template',  'RenderTemplate'
+    service 'partial_template', 'PartialTemplate'
+    service 'halt',             'Halt'
+    service 'custom_error',     'CustomError'
   end
 
   Sanford::TemplateSource.new(ROOT_PATH.join('test/support').to_s).tap do |s|
@@ -96,11 +105,17 @@ module AppHandlers
     def init!
       @message = params['message']
     end
-
+  end
+  class RenderTemplate < Template
     def run!
       render "template"
     end
   end
+  class PartialTemplate < Template
+    def run!
+      partial "template"
+    end
+  end
 
   class Halt
     include Sanford::ServiceHandler

data/test/support/template.erb

@@ -1 +1 @@
-ERB Template Message: <%= view.message %>
+ERB Template Message: <%= view.nil? ? '' : view.message %>

data/test/system/server_tests.rb

@@ -166,11 +166,11 @@ module Sanford::Server
 
   end
 
-  class TemplateTests < RunningAppServerTests
+  class RenderTemplateTests < RunningAppServerTests
     desc "calling a service that renders a template"
     setup do
       @message = Factory.text
-      @client.set_request('template', :message => @message)
+      @client.set_request('render_template', :message => @message)
       @response = @client.call
     end
 
@@ -182,6 +182,22 @@ module Sanford::Server
 
   end
 
+  class PartialTemplateTests < RunningAppServerTests
+    desc "calling a service that renders a partial template"
+    setup do
+      @message = Factory.text
+      @client.set_request('partial_template', :message => @message)
+      @response = @client.call
+    end
+
+    should "return a success response with the rendered data" do
+      assert_equal 200, subject.code
+      assert_nil subject.status.message
+      assert_equal "ERB Template Message: \n", subject.data
+    end
+
+  end
+
   class KeepAliveTests < RunningAppServerTests
     desc "receiving a keep-alive connection"
     setup do

data/test/system/service_handler_tests.rb

@@ -57,11 +57,11 @@ module Sanford::ServiceHandler
 
   end
 
-  class TemplateHandlerTests < SystemTests
-    desc "AppHandlers::Template"
+  class RenderTemplateHandlerTests < SystemTests
+    desc "AppHandlers::RenderTemplate"
     setup do
       @params = { 'message' => Factory.text }
-      @runner = test_runner(AppHandlers::Template, {
+      @runner = test_runner(AppHandlers::RenderTemplate, {
         :params          => @params,
         :template_source => AppServer.config.template_source
       })
@@ -78,12 +78,41 @@ module Sanford::ServiceHandler
     should "return a 200 response and render the template when run" do
       response = @runner.run
       assert_equal 200, response.code
+
       exp = "ERB Template Message: #{@params['message']}\n"
       assert_equal exp, response.data
     end
 
   end
 
+  class PartialTemplateHandlerTests < SystemTests
+    desc "AppHandlers::PartialTemplate"
+    setup do
+      @params = { 'message' => Factory.text }
+      @runner = test_runner(AppHandlers::PartialTemplate, {
+        :params          => @params,
+        :template_source => AppServer.config.template_source
+      })
+      @handler = @runner.handler
+    end
+    subject{ @handler }
+
+    should have_readers :message
+
+    should "know its message" do
+      assert_equal @params['message'], subject.message
+    end
+
+    should "return a 200 response and render the template when run" do
+      response = @runner.run
+      assert_equal 200, response.code
+
+      exp = "ERB Template Message: \n"
+      assert_equal exp, response.data
+    end
+
+  end
+
   class HaltHandlerTests < SystemTests
     desc "AppHandlers::Halt"
     setup do

data/test/unit/runner_tests.rb

@@ -41,8 +41,8 @@ class Sanford::Runner
     should have_readers :handler_class, :handler
     should have_readers :logger, :router, :template_source
     should have_readers :request, :params
-    should have_imeths :run, :to_response
-    should have_imeths :halt
+    should have_imeths :run, :to_response, :status, :data
+    should have_imeths :halt, :render, :partial
 
     should "know its handler class and handler" do
       assert_equal @handler_class, subject.handler_class
@@ -180,19 +180,28 @@ class Sanford::Runner
 
   end
 
-  class RenderTests < InitTests
-    desc "the `render` method"
+  class RenderPartialTests < InitTests
     setup do
       @template_name = Factory.path
-      @locals = { Factory.string => Factory.string }
-      data = @data = Factory.text
-      @render_called_with = nil
+      @locals        = { Factory.string => Factory.string }
+      @data          = Factory.text
+
       @source = @runner.template_source
+    end
+
+  end
+
+  class RenderTests < RenderPartialTests
+    desc "the `render` method"
+    setup do
+      data                = @data
+      @render_called_with = nil
       Assert.stub(@source, :render){ |*args| @render_called_with = args; data }
     end
 
     should "call to the template source's render method and set the return value as data" do
       subject.render(@template_name, @locals)
+
       exp = [@template_name, subject.handler, @locals]
       assert_equal exp,   @render_called_with
       assert_equal @data, subject.data
@@ -200,12 +209,37 @@ class Sanford::Runner
 
     should "default the locals if none given" do
       subject.render(@template_name)
+
       exp = [@template_name, subject.handler, {}]
       assert_equal exp, @render_called_with
     end
 
   end
 
+  class PartialTests < RenderPartialTests
+    desc "the `partial` method"
+    setup do
+      data                 = @data
+      @partial_called_with = nil
+      Assert.stub(@source, :partial){ |*args| @partial_called_with = args; data }
+    end
+
+    should "call to the template source's partial method and set the return value as data" do
+      subject.partial(@template_name, @locals)
+
+      exp = [@template_name, @locals]
+      assert_equal exp,   @partial_called_with
+      assert_equal @data, subject.data
+    end
+
+    should "default the locals if none given" do
+      subject.partial(@template_name)
+      exp = [@template_name, {}]
+      assert_equal exp, @partial_called_with
+    end
+
+  end
+
   class TestServiceHandler
     include Sanford::ServiceHandler
 

data/test/unit/service_handler_tests.rb

@@ -255,6 +255,14 @@ module Sanford::ServiceHandler
       assert_equal exp_args, @meth_args
     end
 
+    should "call to the runner for its partial helper" do
+      capture_runner_meth_args_for(:partial)
+      exp_args = @args
+      subject.instance_eval{ partial(*exp_args) }
+
+      assert_equal exp_args, @meth_args
+    end
+
     private
 
     def stub_runner_with_something_for(meth)

data/test/unit/template_engine_tests.rb

@@ -19,7 +19,7 @@ class Sanford::TemplateEngine
     subject{ @engine }
 
     should have_readers :source_path, :logger, :opts
-    should have_imeths :render
+    should have_imeths :render, :partial
 
     should "default its source path" do
       assert_equal Pathname.new(nil.to_s), subject.source_path
@@ -56,6 +56,12 @@ class Sanford::TemplateEngine
       end
     end
 
+    should "raise NotImplementedError on `partial`" do
+      assert_raises NotImplementedError do
+        subject.partial(@path, @locals)
+      end
+    end
+
   end
 
   class NullTemplateEngineTests < Assert::Context
@@ -69,10 +75,11 @@ class Sanford::TemplateEngine
       assert_kind_of Sanford::TemplateEngine, subject
     end
 
-    should "read and return the given path in its source path on `render" do
+    should "read and return the given path in its source path" do
       exists_file = ['test/support/template', 'test/support/template.erb'].sample
       exp = File.read(Dir.glob("#{subject.source_path.join(exists_file)}*").first)
       assert_equal exp, subject.render(exists_file, @service_handler, @locals)
+      assert_equal exp, subject.partial(exists_file, @locals)
     end
 
     should "complain if given a path that matches multiple files" do
@@ -80,6 +87,9 @@ class Sanford::TemplateEngine
       assert_raises ArgumentError do
         subject.render(conflict_file, @service_handler, @locals)
       end
+      assert_raises ArgumentError do
+        subject.partial(conflict_file, @locals)
+      end
     end
 
     should "complain if given a path that does not exist in its source path" do
@@ -87,6 +97,9 @@ class Sanford::TemplateEngine
       assert_raises ArgumentError do
         subject.render(no_exists_file, @service_handler, @locals)
       end
+      assert_raises ArgumentError do
+        subject.partial(no_exists_file, @locals)
+      end
     end
 
   end

data/test/unit/template_source_tests.rb

@@ -22,7 +22,7 @@ class Sanford::TemplateSource
 
     should have_readers :path, :engines
     should have_imeths :engine, :engine_for?, :engine_for_template?
-    should have_imeths :render
+    should have_imeths :render, :partial
 
     should "know its path" do
       assert_equal @source_path.to_s, subject.path
@@ -94,20 +94,24 @@ class Sanford::TemplateSource
 
   end
 
-  class RenderTests < InitTests
-    desc "when rendering a template"
+  class TemplateTests < InitTests
     setup do
       @source.engine('test', TestEngine)
       @source.engine('json', JsonEngine)
     end
 
+  end
+
+  class RenderTemplateTests < TemplateTests
+    desc "when rendering a template"
+
     should "render a matching template using the configured engine" do
       locals = { :something => Factory.string }
       result = subject.render('test_template', TestServiceHandler, locals)
-      assert_equal 'test-engine', result
+      assert_equal 'test-engine-render', result
 
       result = subject.render('test_template.test', TestServiceHandler, locals)
-      assert_equal 'test-engine', result
+      assert_equal 'test-engine-render', result
     end
 
     should "use the null template engine when an engine can't be found" do
@@ -126,6 +130,34 @@ class Sanford::TemplateSource
 
   end
 
+  class PartialTemplateTests < TemplateTests
+    desc "when rendering a partial template"
+
+    should "render a matching partial template using the configured engine" do
+      locals = { :something => Factory.string }
+      result = subject.partial('test_template', locals)
+      assert_equal 'test-engine-partial', result
+
+      result = subject.partial('test_template.test', locals)
+      assert_equal 'test-engine-partial', result
+    end
+
+    should "use the null template engine when an engine can't be found" do
+      assert_raises(ArgumentError) do
+        subject.partial(Factory.string, {})
+      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.partial('conflict_template', {})
+      end
+    end
+
+  end
+
   class NullTemplateSourceTests < Assert::Context
     desc "Sanford::NullTemplateSource"
     setup do
@@ -151,13 +183,19 @@ class Sanford::TemplateSource
 
   class TestEngine < Sanford::TemplateEngine
     def render(path, service_handler, locals)
-      'test-engine'
+      'test-engine-render'
+    end
+    def partial(path, locals)
+      'test-engine-partial'
     end
   end
 
   class JsonEngine < Sanford::TemplateEngine
     def render(path, service_handler, locals)
-      'json-engine'
+      'json-engine-render'
+    end
+    def partial(path, locals)
+      'json-engine-partial'
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sanford
 version: !ruby/object:Gem::Version 
-  version: 0.19.0
+  version: 0.19.1
 platform: ruby
 authors: 
 - Collin Redding
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2016-09-15 00:00:00 Z
+date: 2017-08-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assert
@@ -19,7 +19,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.16.1
+        version: 2.16.3
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -154,7 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Sanford TCP protocol server for hosting services