sanford-nm 0.0.1 → 0.1.0

data/Gemfile

@@ -4,6 +4,7 @@ gemspec
 
 gem 'rake'
 gem 'pry'
+gem 'bson_ext'
 
 platform :rbx do
   gem 'rubysl'

data/README.md

@@ -13,7 +13,7 @@ require 'sanford-nm'
 
 Sanford.configure do |c|
 
-  c.template_source "/path/to/templates") do |s|
+  c.template_source "/path/to/templates" do |s|
     s.engine 'nm', Sanford::Nm::TemplateEngine
   end
 
@@ -22,6 +22,15 @@ end
 
 Add `.nm` to any template files in your template source path.  Sanford will render their content using Nm when they are rendered.
 
+### Notes
+
+Nm doesn't allow overriding the template scope but instead allows you to pass in data that binds to the template scope as methods.  By default, the service handler will be bound to Nm's scope via the `view` method in templates.  If you want to change this, provide a `'handler_local'` option when registering:
+
+```ruby
+  c.template_source "/path/to/templates" do |s|
+    s.engine 'nm', Sanford::Nm::TemplateEngine, 'handler_local' => 'service_handler'
+  end
+```
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/sanford-nm/version.rb

@@ -1,4 +1,4 @@
 module Sanford; end
 module Sanford::Nm
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/sanford-nm.rb

@@ -1,4 +1,31 @@
+require 'nm'
+require 'sanford/template_engine'
 require "sanford-nm/version"
 
 module Sanford::Nm
+
+  class TemplateEngine < Sanford::TemplateEngine
+
+    DEFAULT_HANDLER_LOCAL = 'view'
+
+    def nm_source
+      @nm_source ||= Nm::Source.new(self.source_path)
+    end
+
+    def nm_handler_local
+      @nm_handler_local ||= (self.opts['handler_local'] || DEFAULT_HANDLER_LOCAL)
+    end
+
+    def render(path, service_handler, locals)
+      self.nm_source.render(path, render_locals(service_handler, locals))
+    end
+
+    private
+
+    def render_locals(service_handler, locals)
+      { self.nm_handler_local => service_handler }.merge(locals)
+    end
+
+  end
+
 end

data/sanford-nm.gemspec

@@ -20,4 +20,7 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency("assert", ["~> 2.10"])
 
+  gem.add_dependency("sanford", ["~> 0.10"])
+  gem.add_dependency("nm")
+
 end

data/test/helper.rb

@@ -7,4 +7,7 @@ $LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
 # require pry for debugging (`binding.pry`)
 require 'pry'
 
+require 'pathname'
+TEST_SUPPORT_PATH = Pathname.new(File.expand_path('../support', __FILE__))
+
 require 'test/support/factory'

data/test/support/factory.rb

@@ -3,4 +3,13 @@ require 'assert/factory'
 module Factory
   extend Assert::Factory
 
+  def self.template_json_rendered(service_handler, locals)
+    { 'thing' => {
+        'id' => service_handler.identifier,
+        'name' => service_handler.name,
+        'local1' => locals['local1']
+      }
+    }
+  end
+
 end

data/test/support/template.json.nm

@@ -0,0 +1,5 @@
+node('thing') {
+  node('id', view.identifier)
+  node('name', view.name)
+  node('local1', local1)
+}

data/test/unit/template_engine_tests.rb

@@ -0,0 +1,54 @@
+require 'assert'
+require 'sanford-nm'
+
+require 'nm/source'
+require 'sanford/template_engine'
+
+class Sanford::Nm::TemplateEngine
+
+  class UnitTests < Assert::Context
+    desc "Sanford::Nm::TemplateEngine"
+    setup do
+      @engine = Sanford::Nm::TemplateEngine.new({
+        'source_path' => TEST_SUPPORT_PATH
+      })
+    end
+    subject{ @engine }
+
+    should have_imeths :nm_source, :nm_handler_local
+
+    should "be a Sanford template engine" do
+      assert_kind_of Sanford::TemplateEngine, subject
+      assert_respond_to 'render', subject
+    end
+
+    should "memoize its Nm source" do
+      assert_kind_of Nm::Source, subject.nm_source
+      assert_equal subject.source_path, subject.nm_source.root
+      assert_same subject.nm_source, subject.nm_source
+    end
+
+    should "use 'view' as the handler local name by default" do
+      assert_equal 'view', subject.nm_handler_local
+    end
+
+    should "allow custom handler local names" do
+      handler_local = Factory.string
+      engine = Sanford::Nm::TemplateEngine.new('handler_local' => handler_local)
+      assert_equal handler_local, engine.nm_handler_local
+    end
+
+    should "render nm template files" do
+      service_handler = OpenStruct.new({
+        :identifier => Factory.integer,
+        :name => Factory.string
+      })
+      locals = { 'local1' => Factory.string }
+      exp = Factory.template_json_rendered(service_handler, locals)
+
+      assert_equal exp, subject.render('template.json', service_handler, locals)
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sanford-nm
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -10,17 +16,51 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-06-08 00:00:00 Z
+date: 2014-06-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 10
         version: "2.10"
   type: :development
-  version_requirements: *id001
   name: assert
+  version_requirements: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 10
+        version: "0.10"
+  type: :runtime
+  name: sanford
+  version_requirements: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  name: nm
+  version_requirements: *id003
   prerelease: false
 description: Sanford template engine for Nm templates
 email: 
@@ -44,33 +84,44 @@ files:
 - sanford-nm.gemspec
 - test/helper.rb
 - test/support/factory.rb
+- test/support/template.json.nm
+- test/unit/template_engine_tests.rb
 - tmp/.gitkeep
 homepage: http://github.com/redding/sanford-nm
 licenses: 
 - MIT
-metadata: {}
-
 post_install_message: 
 rdoc_options: []
 
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - &id002 
-    - ">="
+  - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
-  - *id002
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.25
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Sanford template engine for Nm templates
 test_files: 
 - test/helper.rb
 - test/support/factory.rb
+- test/support/template.json.nm
+- test/unit/template_engine_tests.rb

checksums.yaml

@@ -1,7 +0,0 @@
---- 
-SHA512: 
-  data.tar.gz: 2e9084121898d5efbe1e36f6330c1ec6651649e87f4f18ab2ac2dfca77841a5728db25962e9df4c445e64cf5d584e256c747a0942bb563f2e1fe2e30c9893d4b
-  metadata.gz: 65fa1dfa5fc5bb25295c0b8c33ab7aa1eb1d0c235ad87e5dffa6bf8340509773f7fe900b071dc4297daf2dcf1ee6a7ae2b111d56dc8ef0352216438ec3e843da
-SHA1: 
-  data.tar.gz: 72373d9605321bbc7ac5adc9a95a3f5d616d444c
-  metadata.gz: 9afa971ee87506a6136662e416a9e726d8f72044