deas-nm 0.0.1 → 0.1.0

data/README.md

@@ -1,10 +1,66 @@
-# DeasNm
+# Deas::Nm
 
 [Deas](https://github.com/redding/deas) template engine for rendering [Nm](https://github.com/redding/nm) templates
 
 ## Usage
 
-TODO: Write code samples and usage instructions here
+Register the engine:
+
+```ruby
+require 'deas'
+require 'deas-nm'
+
+Deas.configure do |c|
+
+  c.template_source "/path/to/templates" do |s|
+    s.engine 'nm', Deas::Nm::TemplateEngine
+  end
+
+end
+```
+
+Add `.nm` to any template files in your template source path.  Deas will render their content using Nm when they are rendered.
+
+### Serialization
+
+Nm doesn't serialize the objects it renders - it just returns them.  However, Deas expects serialized body content.  By default, the rendered objects are not serialized.
+
+To serialize the rendered objects, specify a serializer when registering:
+
+```ruby
+# this uses Oj to serialize to JSON (for example)
+c.template_source "/path/to/templates" do |s|
+  s.engine('nm', Deas::Nm::TemplateEngine, {
+    'serializer' => proc{ |obj, template_name| Oj.dump(obj, :mode => :strict) }
+  })
+end
+```
+
+The template name is passed to any serializer proc.  This can be helpful if choosing how to serialize is conditonal upon the template name.  For example:
+
+```ruby
+c.template_source "/path/to/templates" do |s|
+  s.engine('nm', Deas::Nm::TemplateEngine, {
+    'serializer' => proc do |obj, template_name|
+      if File.extname(template_name) == '.json'
+        Oj.dump(obj, :mode => :strict)
+      else
+        # serialize some other way?
+      end
+    end
+  })
+end
+```
+
+### Notes
+
+Nm doesn't allow overriding the template scope but instead allows you to pass in data that binds to the template scope as local methods.  By default, the view 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', Deas::Nm::TemplateEngine, 'handler_local' => 'view_handler'
+end
+```
 
 ## Installation
 

data/lib/deas-nm.rb

@@ -1,5 +1,50 @@
+require 'deas/template_engine'
+require 'nm'
 require "deas-nm/version"
 
 module Deas::Nm
-  # TODO: your code goes here...
+
+  class TemplateEngine < Deas::TemplateEngine
+
+    DEFAULT_HANDLER_LOCAL = 'view'.freeze
+    DEFAULT_SERIALIZER = proc{ |obj, template_name| obj }.freeze # no-op
+
+    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 nm_serializer
+      @nm_serializer ||= (self.opts['serializer'] || DEFAULT_SERIALIZER)
+    end
+
+    def render(template_name, view_handler, locals)
+      self.nm_serializer.call(
+        self.nm_source.render(template_name, render_locals(view_handler, locals)),
+        template_name
+      )
+    end
+
+    def partial(template_name, locals)
+      self.nm_serializer.call(
+        self.nm_source.render(template_name, locals),
+        template_name
+      )
+    end
+
+    def capture_partial(template_name, locals, &content)
+      raise NotImplementedError
+    end
+
+    private
+
+    def render_locals(view_handler, locals)
+      { self.nm_handler_local => view_handler }.merge(locals)
+    end
+
+  end
+
 end

data/lib/deas-nm/version.rb

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

data/test/helper.rb

@@ -9,4 +9,5 @@ require 'pry'
 
 require 'test/support/factory'
 
-# TODO: put test helpers here...
+require 'pathname'
+TEST_SUPPORT_PATH = Pathname.new(File.expand_path('../support', __FILE__))

data/test/support/_partial.json.nm

@@ -0,0 +1,3 @@
+node('thing') {
+  node('local1', local1)
+}

data/test/support/factory.rb

@@ -3,4 +3,20 @@ require 'assert/factory'
 module Factory
   extend Assert::Factory
 
+  def self.template_json_rendered(view_handler, locals)
+    { 'thing' => {
+        'id'     => view_handler.identifier,
+        'name'   => view_handler.name,
+        'local1' => locals['local1']
+      }
+    }
+  end
+
+  def self.partial_json_rendered(locals)
+    { 'thing' => {
+        '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,80 @@
+require 'assert'
+require 'deas-nm'
+
+require 'nm/source'
+require 'deas/template_engine'
+
+class Deas::Nm::TemplateEngine
+
+  class UnitTests < Assert::Context
+    desc "Deas::Nm::TemplateEngine"
+    setup do
+      @engine = Deas::Nm::TemplateEngine.new({
+        'source_path' => TEST_SUPPORT_PATH
+      })
+    end
+    subject{ @engine }
+
+    should have_imeths :nm_source, :nm_handler_local, :nm_serializer
+    should have_imeths :render, :partial, :capture_partial
+
+    should "be a Deas template engine" do
+      assert_kind_of Deas::TemplateEngine, 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 = Deas::Nm::TemplateEngine.new('handler_local' => handler_local)
+      assert_equal handler_local, engine.nm_handler_local
+    end
+
+    should "use a no-op serializer by default" do
+      obj = Factory.integer
+      assert_equal obj, subject.nm_serializer.call(obj, Factory.string)
+    end
+
+    should "render nm template files and serialize them" do
+      engine = Deas::Nm::TemplateEngine.new({
+        'source_path' => TEST_SUPPORT_PATH,
+        'serializer' => proc{ |obj, template_name| obj.to_s }
+      })
+      view_handler = OpenStruct.new({
+        :identifier => Factory.integer,
+        :name => Factory.string
+      })
+      locals = { 'local1' => Factory.string }
+      exp = Factory.template_json_rendered(view_handler, locals).to_s
+
+      assert_equal exp, engine.render('template.json', view_handler, locals)
+    end
+
+    should "render nm partials and serialize them" do
+      engine = Deas::Nm::TemplateEngine.new({
+        'source_path' => TEST_SUPPORT_PATH,
+        'serializer' => proc{ |obj, template_name| obj.to_s }
+      })
+      locals = { 'local1' => Factory.string }
+      exp = Factory.partial_json_rendered(locals).to_s
+
+      assert_equal exp, engine.partial('_partial.json', locals)
+    end
+
+    should "not implement the engine capture partial method" do
+      assert_raises NotImplementedError do
+        subject.capture_partial('_partial.json', {})
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deas-nm
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-11-14 00:00:00 Z
+date: 2014-11-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement 
@@ -83,7 +83,10 @@ files:
 - lib/deas-nm/version.rb
 - log/.gitkeep
 - test/helper.rb
+- test/support/_partial.json.nm
 - test/support/factory.rb
+- test/support/template.json.nm
+- test/unit/template_engine_tests.rb
 - tmp/.gitkeep
 homepage: http://github.com/redding/deas-nm
 licenses: 
@@ -120,4 +123,7 @@ specification_version: 3
 summary: Deas template engine for Nm templates
 test_files: 
 - test/helper.rb
+- test/support/_partial.json.nm
 - test/support/factory.rb
+- test/support/template.json.nm
+- test/unit/template_engine_tests.rb