nm 0.1.0 → 0.2.0

data/test/unit/source_tests.rb

@@ -0,0 +1,94 @@
+require 'assert'
+require 'nm/source'
+
+class Nm::Source
+
+  class UnitTests < Assert::Context
+    desc "Nm::Source"
+    subject{ Nm::Source }
+
+    should "know its extension" do
+      assert_equal ".nm", subject::EXT
+    end
+
+  end
+
+  class InitTests < UnitTests
+    desc "when init"
+    setup do
+      @root = Factory.template_root
+      @source = Nm::Source.new(@root)
+    end
+    subject{ @source }
+
+    should have_readers :root
+    should have_imeths :data, :render, :partial
+
+    should "know its root" do
+      assert_equal @root, subject.root.to_s
+    end
+
+  end
+
+  class DataTests < InitTests
+    desc "`data` method"
+    setup do
+      @file_path = Factory.template_file('obj.nm')
+    end
+
+    should "read the contents of a given file path" do
+      exp = File.read(@file_path)
+      assert_equal exp, subject.data(@file_path)
+    end
+
+  end
+
+  class RenderTests < InitTests
+    desc "`render` method"
+    setup do
+      @file_name = "locals"
+      @file_locals = { 'key' => 'a-value' }
+      @file_path = Factory.template_file("#{@file_name}#{Nm::Source::EXT}")
+    end
+
+    should "render a template for the given file name and return its data" do
+      exp = Nm::Template.new(subject, @file_path, @file_locals).__data__
+      assert_equal exp, subject.render(@file_name, @file_locals)
+    end
+
+  end
+
+  class PartialTests < InitTests
+    desc "`partial` method"
+
+    setup do
+      @file_name = "locals"
+      @file_locals = { 'key' => 'a-value' }
+      @file_path = Factory.template_file("_#{@file_name}#{Nm::Source::EXT}")
+    end
+
+    should "render a template for the given file name and return its data" do
+      exp = Nm::Template.new(subject, @file_path, @file_locals).__data__
+      assert_equal exp, subject.partial(@file_name, @file_locals)
+    end
+
+  end
+
+  class DefaultSource < UnitTests
+    desc "DefaultSource"
+    setup do
+      @source = Nm::DefaultSource.new
+    end
+    subject{ @source }
+
+    should "be a Source" do
+      assert_kind_of Nm::Source, subject
+    end
+
+    should "use `/` as its root" do
+      assert_equal '/', subject.root.to_s
+    end
+
+  end
+
+end

data/test/unit/template_tests.rb

@@ -0,0 +1,355 @@
+require 'assert'
+require 'nm/template'
+
+require 'nm/ext'
+require 'nm/source'
+
+class Nm::Template
+
+  class UnitTests < Assert::Context
+    desc "Nm::Template"
+    subject{ Nm::Template }
+
+  end
+
+  class InitTests < UnitTests
+    desc "when init"
+    setup do
+      @template = Nm::Template.new
+    end
+    subject{ @template }
+
+    should have_imeths :__data__, :__node__, :__map__, :__render__, :__partial__
+    should have_imeths :node, :_node, :n
+    should have_imeths :map,  :_map,  :m
+    should have_imeths :render,  :_render,  :r
+    should have_imeths :partial, :_partial, :p
+
+    should "have no data if no source file is given" do
+      assert_nil subject.__data__
+    end
+
+    should "return itself when its markup methods are called" do
+      t = Nm::Template.new
+      assert_equal t, t.__node__('key', 'value')
+
+      t = Nm::Template.new
+      assert_equal t, t.__map__([], &Proc.new{})
+
+      t = Nm::Template.new
+      assert_equal t, t.__render__(Factory.template_file('obj'))
+
+      t = Nm::Template.new
+      assert_equal t, t.__partial__(Factory.template_file('obj'))
+    end
+
+  end
+
+  class NodeMethodTests < UnitTests
+    desc "`__node__` method"
+
+    should "add key-value pairs at any level" do
+      exp = {'a' => 'Aye'}
+      assert_equal exp, Nm::Template.new.__node__('a', 'Aye').__data__
+
+      exp = {
+        'nested' => {'a' => 'Aye'}
+      }
+      t = Nm::Template.new.__node__('nested'){ __node__('a', 'Aye') }
+      assert_equal exp, t.__data__
+    end
+
+    should "be aliased as `node`, `_node` and `n`" do
+      exp = {'a' => 'Aye'}
+      assert_equal exp, Nm::Template.new.__node__('a', 'Aye').__data__
+      assert_equal exp, Nm::Template.new.node('a', 'Aye').__data__
+      assert_equal exp, Nm::Template.new._node('a', 'Aye').__data__
+      assert_equal exp, Nm::Template.new.n('a', 'Aye').__data__
+    end
+
+    should "complain if called after a `__map__` call" do
+      t = Nm::Template.new.__map__([1,2,3])
+      assert_raises Nm::InvalidError do
+        t.__node__('a', 'Aye')
+      end
+    end
+
+  end
+
+  class MapMethodTests < UnitTests
+    desc "`map` method"
+    setup do
+      @list = [1,2,3]
+    end
+
+    should "map a given list to the data" do
+      exp = @list
+      assert_equal exp, Nm::Template.new.__map__(@list).__data__
+
+      exp = [
+        {'1' => 1},
+        {'2' => 2},
+        {'3' => 3},
+      ]
+      t = Nm::Template.new.__map__(@list){ |item| __node__(item.to_s, item) }
+      assert_equal exp, t.__data__
+
+      exp = {
+        'list' => [
+          {'1' => 1},
+          {'2' => 2},
+          {'3' => 3},
+        ]
+      }
+      list = @list
+      t = Nm::Template.new.__node__('list') do
+        __map__(list){ |item| __node__(item.to_s, item) }
+      end
+      assert_equal exp, t.__data__
+    end
+
+    should "be aliased as `map`, `_map` and `m`" do
+      exp = @list
+      assert_equal exp, Nm::Template.new.__map__(@list).__data__
+      assert_equal exp, Nm::Template.new.map(@list).__data__
+      assert_equal exp, Nm::Template.new._map(@list).__data__
+      assert_equal exp, Nm::Template.new.m(@list).__data__
+    end
+
+    should "complain if given a list that doesn't respond to `.map`" do
+      val = 123
+      assert_not_responds_to 'map', val
+      assert_raises ArgumentError do
+        Nm::Template.new.__map__(val)
+      end
+    end
+
+    should "complain if called after a `__node__` call" do
+      t = Nm::Template.new.__node__('a', 'Aye')
+      assert_raises Nm::InvalidError do
+        t.__map__([1,2,3])
+      end
+    end
+
+  end
+
+  class RenderTests < InitTests
+    setup do
+      @source = Nm::Source.new(Factory.template_root)
+
+      @obj_file_name = "obj"
+      @obj = {
+        'obj' => {
+          'a' => 'Aye',
+          'b' => 'Bee',
+          'c' => 'See'
+        }
+      }
+
+      @list_file_name = "list"
+      @list = [
+        { '1' => 1 },
+        { '2' => 2 },
+        { '3' => 3 }
+      ]
+    end
+
+  end
+
+  class RenderMethodTests < RenderTests
+    desc "`render` method"
+
+    should "render a template for the given file name and add its data" do
+      t = Nm::Template.new(@source)
+      assert_equal @obj, t.__render__(@obj_file_name).__data__
+    end
+
+    should "be aliased as `render`, `_render` and `r`" do
+      t = Nm::Template.new(@source)
+      assert_equal @obj, t.__render__(@obj_file_name).__data__
+
+      t = Nm::Template.new(@source)
+      assert_equal @obj, t.render(@obj_file_name).__data__
+
+      t = Nm::Template.new(@source)
+      assert_equal @obj, t._render(@obj_file_name).__data__
+
+      t = Nm::Template.new(@source)
+      assert_equal @obj, t.r(@obj_file_name).__data__
+    end
+
+    should "merge if call returns an obj and called after a `__node__` call" do
+      t = Nm::Template.new(@source)
+      t.__node__('1', 'One')
+
+      exp = {'1' => 'One'}.merge(@obj)
+      assert_equal exp, t.__render__(@obj_file_name).__data__
+    end
+
+    should "complain if call returns an obj and called after a `__map__` call" do
+      t = Nm::Template.new(@source)
+      t.__map__([1,2,3])
+      assert_raises Nm::InvalidError do
+        t.__render__(@obj_file_name).__data__
+      end
+    end
+
+    should "concat if call returns a list and called after a `__map__` call" do
+      t = Nm::Template.new(@source)
+      t.__map__([1,2,3])
+
+      exp = [1,2,3].concat(@list)
+      assert_equal exp, t.__render__(@list_file_name).__data__
+    end
+
+    should "complain if call returns a list and called after a `__node__` call" do
+      t = Nm::Template.new(@source)
+      t.__node__('1', 'One')
+
+      assert_raises Nm::InvalidError do
+        t.__render__(@list_file_name).__data__
+      end
+    end
+
+  end
+
+  class PartialMethodTests < RenderTests
+    desc "`partial` method"
+    setup do
+      @partial_obj = {
+        'a' => 'Aye',
+        'b' => 'Bee',
+        'c' => 'See'
+      }
+      @partial_list = @list
+    end
+
+    should "render a template for the given partial name and add its data" do
+      t = Nm::Template.new(@source)
+      assert_equal @partial_obj, t.__partial__(@obj_file_name).__data__
+    end
+
+    should "be aliased as `render`, `_render` and `r`" do
+      t = Nm::Template.new(@source)
+      assert_equal @partial_obj, t.__partial__(@obj_file_name).__data__
+
+      t = Nm::Template.new(@source)
+      assert_equal @partial_obj, t.partial(@obj_file_name).__data__
+
+      t = Nm::Template.new(@source)
+      assert_equal @partial_obj, t._partial(@obj_file_name).__data__
+
+      t = Nm::Template.new(@source)
+      assert_equal @partial_obj, t.p(@obj_file_name).__data__
+    end
+
+    should "merge if call returns an obj and called after a `__node__` call" do
+      t = Nm::Template.new(@source)
+      t.__node__('1', 'One')
+
+      exp = {'1' => 'One'}.merge(@partial_obj)
+      assert_equal exp, t.__partial__(@obj_file_name).__data__
+    end
+
+    should "complain if call returns an obj and called after a `__map__` call" do
+      t = Nm::Template.new(@source)
+      t.__map__([1,2,3])
+      assert_raises Nm::InvalidError do
+        t.__partial__(@obj_file_name).__data__
+      end
+    end
+
+    should "merge if call returns a list and called after a `__map__` call" do
+      t = Nm::Template.new(@source)
+      t.__map__([1,2,3])
+
+      exp = [1,2,3].concat(@partial_list)
+      assert_equal exp, t.__partial__(@list_file_name).__data__
+    end
+
+    should "complain if call returns a list and called after a `__node__` call" do
+      t = Nm::Template.new(@source)
+      t.__node__('1', 'One')
+
+      assert_raises Nm::InvalidError do
+        t.__partial__(@list_file_name).__data__
+      end
+    end
+
+  end
+
+  class SourceFileTests < UnitTests
+    desc "when init given a source file"
+    setup do
+      @obj_source_file = Factory.template_file('obj.nm')
+      @exp_obj = {
+        'obj' => {
+          'a' => 'Aye',
+          'b' => 'Bee',
+          'c' => 'See'
+        }
+      }
+
+      @list_source_file = Factory.template_file('list.nm')
+      @exp_list = [
+        { '1' => 1 },
+        { '2' => 2 },
+        { '3' => 3 }
+      ]
+    end
+
+    should "evaluate the source file" do
+      assert_equal @exp_obj,  Nm::Template.new(@obj_source_file).__data__
+      assert_equal @exp_list, Nm::Template.new(@list_source_file).__data__
+    end
+
+    should "evaluate the source file with locals" do
+      assert_equal @exp_obj,  Nm::Template.new(@obj_source_file,  {}).__data__
+      assert_equal @exp_list, Nm::Template.new(@list_source_file, {}).__data__
+    end
+
+  end
+
+  class NoExistSourceFileTests < UnitTests
+    desc "when init given a source file that does not exist"
+    setup do
+      @no_exist_source_file = Factory.template_file('does-not-exist.nm')
+    end
+
+    should "complain that the source does not exist" do
+      assert_raises ArgumentError do
+        Nm::Template.new(@no_exist_source_file)
+      end
+    end
+
+  end
+
+  class LocalsTests < UnitTests
+    desc "when init with locals"
+    setup do
+      @locals = {
+        'key' => 'value',
+        'node' => 'A Node',
+        'map' => 'A Map'
+      }
+    end
+
+    should "expose the local as a reader method on the template" do
+      t = Nm::Template.new
+      assert_not_responds_to 'key', t
+
+      t = Nm::Template.new(@locals)
+      assert_equal 'value', t.key
+    end
+
+    should "not interfere with method aliases" do
+      d = Nm::Template.new(Factory.template_file('aliases.nm'), @locals).__data__
+      assert_kind_of ::Array, d
+      assert_equal 1, d.size
+      assert_equal 'A Node', d.first['node local value']
+      assert_equal 'A Map',  d.first['map local value']
+    end
+
+  end
+
+end

metadata

@@ -1,13 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: nm
 version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,24 +10,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-04-12 00:00:00 Z
+date: 2014-06-04 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :development
-  name: assert
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 2
-        - 10
         version: "2.10"
+  type: :development
+  version_requirements: *id001
+  name: assert
   prerelease: false
-  requirement: *id001
-description: "JSON/BSON data structure template system "
+description: Data templating system.
 email: 
 - kelly@kellyredding.com
 - collin.redding@me.com
@@ -49,44 +38,80 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bench/_slide.nm
+- bench/logger.rb
+- bench/results/nm.txt
+- bench/results/nm_partials.txt
+- bench/results/nm_re_source.txt
+- bench/results/rabl.txt
+- bench/runner.rb
+- bench/slideshow.nm
+- bench/slideshow.rabl
+- bench/slideshow.rb
+- bench/slideshow_partials.nm
+- bench/slideshow_partials.rb
+- bench/template.rb
 - lib/nm.rb
+- lib/nm/ext.rb
+- lib/nm/source.rb
+- lib/nm/template.rb
 - lib/nm/version.rb
 - log/.gitkeep
 - nm.gemspec
+- script/bench_all.rb
+- script/bench_nm.rb
+- script/bench_nm_partials.rb
+- script/bench_nm_re_source.rb
+- script/bench_rabl.rb
 - test/helper.rb
+- test/support/factory.rb
+- test/support/templates/_list.nm
+- test/support/templates/_locals.nm
+- test/support/templates/_obj.nm
+- test/support/templates/aliases.nm
+- test/support/templates/list.nm
+- test/support/templates/locals.nm
+- test/support/templates/obj.nm
+- test/unit/ext_tests.rb
+- test/unit/source_tests.rb
+- test/unit/template_tests.rb
 - tmp/.gitkeep
 homepage: http://github.com/redding/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: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  - *id002
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: JSON/BSON data structure template system
+specification_version: 4
+summary: Data templating system.
 test_files: 
 - test/helper.rb
+- test/support/factory.rb
+- test/support/templates/_list.nm
+- test/support/templates/_locals.nm
+- test/support/templates/_obj.nm
+- test/support/templates/aliases.nm
+- test/support/templates/list.nm
+- test/support/templates/locals.nm
+- test/support/templates/obj.nm
+- test/unit/ext_tests.rb
+- test/unit/source_tests.rb
+- test/unit/template_tests.rb