nm 0.5.4 → 0.6.0

data/lib/nm/template_behaviors.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+require "much-mixin"
+require "nm/ext"
+require "nm/render"
+require "nm/source"
+
+module Nm; end
+
+module Nm::TemplateBehaviors
+  include MuchMixin
+
+  after_mixin_included do
+    attr_accessor :__nm_context__
+
+    alias_method :node,  :__node__
+    alias_method :_node, :__node__
+    alias_method :n,     :__node__
+
+    alias_method :map,  :__map__
+    alias_method :_map, :__map__
+    alias_method :m,    :__map__
+
+    alias_method :partial,  :__partial__
+    alias_method :_partial, :__partial__
+    alias_method :p,        :__partial__
+  end
+
+  mixin_instance_methods do
+    def __nm_render_stack__
+      @__nm_render_stack__ ||= []
+    end
+
+    def __nm_push_render__(locals)
+      __nm_render_stack__.push(
+        Nm::Render.new(dstack: @__nm_dstack__, locals: @__nm_locals__),
+      )
+      @__nm_dstack__ = [nil]
+      @__nm_locals__ = locals
+    end
+
+    def __nm_pop_render__
+      __nm_render_stack__.pop.tap do |render|
+        @__nm_dstack__ = render.dstack
+        @__nm_locals__ = render.locals
+      end
+    end
+
+    def __nm_data__
+      @__nm_dstack__.last || {}
+    end
+
+    def __node__(key, value = nil, &block)
+      unless @__nm_dstack__[-1].nil? || @__nm_dstack__[-1].is_a?(::Hash)
+        raise Nm::InvalidError, "invalid `node` call"
+      end
+      @__nm_dstack__[-1] ||= {}
+
+      @__nm_dstack__.push(nil)
+      instance_exec(&(block || Proc.new{}))
+      @__nm_dstack__.pop.tap{ |v| @__nm_dstack__[-1][key] = (v || value) }
+
+      self
+    end
+
+    def __map__(list, &block)
+      unless list.respond_to?(:map)
+        raise(
+          ArgumentError,
+          "given list (`#{list.class}`) doesn't respond to `.map`",
+        )
+      end
+      unless @__nm_dstack__[-1].nil? || @__nm_dstack__[-1].is_a?(::Array)
+        raise Nm::InvalidError, "invalid `map` call"
+      end
+      @__nm_dstack__[-1] ||= []
+
+      list.map do |item|
+        @__nm_dstack__.push(nil)
+        instance_exec(item, &(block || Proc.new{}))
+        @__nm_dstack__.pop.tap{ |v| @__nm_dstack__[-1].push(v || item) }
+      end
+
+      self
+    end
+
+    def __partial__(*args)
+      @__nm_dstack__[-1] =
+        @__nm_dstack__[-1].__nm_add_partial_data__(
+          __nm_context__.partial(*args),
+        )
+
+      self
+    end
+  end
+end

data/lib/nm/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nm
-  VERSION = "0.5.4"
+  VERSION = "0.6.0"
 end

data/nm.gemspec

@@ -1,5 +1,7 @@
 # -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "nm/version"
 
@@ -8,12 +10,12 @@ Gem::Specification.new do |gem|
   gem.version     = Nm::VERSION
   gem.authors     = ["Kelly Redding", "Collin Redding"]
   gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
-  gem.summary     = %q{Data templating system.}
-  gem.description = %q{Data templating system.}
+  gem.summary     = "Node-Map: a data templating DSL."
+  gem.description = "Node-Map: a data templating DSL."
   gem.homepage    = "http://github.com/redding/nm"
-  gem.license     = 'MIT'
+  gem.license     = "MIT"
 
-  gem_files = `git ls-files`.split($/)
+  gem_files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem_files -= gem_files.grep(%r{^(bench)/})
   gem_files -= gem_files.grep(%r{^(script)/})
   gem.files         = gem_files
@@ -21,6 +23,10 @@ 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.required_ruby_version = "~> 2.5"
+
+  gem.add_development_dependency("much-style-guide", ["~> 0.6.6"])
+  gem.add_development_dependency("assert",           ["~> 2.19.6"])
 
+  gem.add_dependency("much-mixin", ["~> 0.2.4"])
 end

data/test/helper.rb

@@ -1,24 +1,17 @@
+# frozen_string_literal: true
+
 # this file is automatically required when you run `assert`
 # put any test helpers here
 
-require 'pathname'
+require "pathname"
 
 # add the root dir to the load path
 ROOT = Pathname.new(File.expand_path("../..", __FILE__))
 $LOAD_PATH.unshift(ROOT.to_s)
 
-TEMPLATE_ROOT = ROOT.join('test/support/templates')
+TEMPLATE_ROOT = ROOT.join("test/support/templates")
 
 # require pry for debugging (`binding.pry`)
-require 'pry'
-
-require 'test/support/factory'
-
-# 1.8.7 backfills
+require "pry"
 
-# Array#sample
-if !(a = Array.new).respond_to?(:sample) && a.respond_to?(:choice)
-  class Array
-    alias_method :sample, :choice
-  end
-end
+require "test/support/factory"

data/test/support/factory.rb

@@ -1,4 +1,6 @@
-require 'assert/factory'
+# frozen_string_literal: true
+
+require "assert/factory"
 
 module Factory
   extend Assert::Factory
@@ -10,5 +12,4 @@ module Factory
   def self.template_file(name)
     TEMPLATE_ROOT.join(name).to_s
   end
-
 end

data/test/support/templates/_list.nm

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 map [1, 2, 3] do |num|
   node num.to_s, num
 end

data/test/support/templates/_locals.nm

@@ -1,3 +1,5 @@
-node 'locals' do
-  node 'key', key
+# frozen_string_literal: true
+
+node "locals" do
+  node "key", key
 end

data/test/support/templates/_obj.nm

@@ -1,3 +1,5 @@
-node 'a', 'Aye'
-node 'b', 'Bee'
-node 'c', "See"
+# frozen_string_literal: true
+
+node "a", "Aye"
+node "b", "Bee"
+node "c", "See"

data/test/support/templates/aliases.nm

@@ -1,4 +1,9 @@
-_map (1..1) do
-  n     'node local value', node
-  _node 'map local value',  map
+# frozen_string_literal: true
+
+_map(1..1) do
+  n        "node local value",     node
+  _node    "map local value",      map
+  __node__ "context method value", helper_method1
+  __node__ "context local value",  key1
+  __node__ "render local value",   key2
 end

data/test/support/templates/list.nm

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 map [1, 2, 3] do |num|
   node num.to_s, num
 end

data/test/support/templates/locals.nm

@@ -1,3 +1,5 @@
-node 'locals' do
-  node 'key', key
+# frozen_string_literal: true
+
+node "locals" do
+  node "key", key
 end

data/test/support/templates/locals_alt.data.inem

@@ -1,3 +1,3 @@
-node 'locals' do
-  node 'key', key
+node "locals" do
+  node "key", key
 end

data/test/support/templates/obj.nm

@@ -1,5 +1,7 @@
-node 'obj' do
-  node 'a', 'Aye'
-  node 'b', 'Bee'
-  node 'c', "See"
+# frozen_string_literal: true
+
+node "obj" do
+  node "a", "Aye"
+  node "b", "Bee"
+  node "c", "See"
 end

data/test/unit/context_tests.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "assert"
+require "nm/context"
+
+require "nm/source"
+require "nm/template_behaviors"
+
+class Nm::Context
+  class UnitTests < Assert::Context
+    desc "Nm::Context"
+    subject{ unit_class }
+
+    let(:unit_class){ Nm::Context }
+  end
+
+  class InitTests < UnitTests
+    desc "when init"
+    subject{ unit_class.new(context, source: source, locals: locals) }
+
+    let(:context){ Class.new.new }
+    let(:template_root){ Factory.template_root }
+    let(:source){ Nm::Source.new(template_root) }
+    let(:locals){ { "key" => "a-value" } }
+
+    should have_imeths :render, :partial, :render_content
+
+    should "setup the context to render Nm templates" do
+      local_name, local_val = [Factory.string, Factory.string]
+      nm_context =
+        unit_class.new(
+          context,
+          source: source,
+          locals: { local_name => local_val },
+        )
+
+      assert_that(context.class).does_not_include(Nm::TemplateBehaviors)
+
+      metaclass = class << context; self; end
+      assert_that(metaclass).includes(Nm::TemplateBehaviors)
+
+      assert_that(context).responds_to(local_name)
+      assert_that(context.send(local_name)).equals(local_val)
+
+      assert_that(context.__nm_context__).equals(nm_context)
+    end
+
+    # See test/unit/template_behaviors_tests.rb for testing the mixed in
+    # template behaviors and rendering.
+  end
+end

data/test/unit/ext_tests.rb

@@ -1,94 +1,79 @@
-require 'assert'
-require 'nm/ext'
+# frozen_string_literal: true
 
-module Nm::Ext
+require "assert"
+require "nm/ext"
 
+module Nm::Ext
   class UnitTests < Assert::Context
     desc "Nm ruby extension"
     subject{ Nm }
 
-    should "define and invalid runtime error" do
-      assert_kind_of ::RuntimeError, subject::InvalidError.new
+    should "define an invalid runtime error" do
+      assert_that(subject::InvalidError.new).is_a(RuntimeError)
     end
-
   end
 
   class AddCallDataTests < UnitTests
-    desc "__nm_add_call_data__"
-    setup do
-      @call_name = Factory.string
-    end
+    desc "__nm_add_partial_data__"
 
     should "be added to ::Hash" do
-      assert_responds_to :__nm_add_call_data__, ::Hash.new
+      assert_that({}).responds_to(:__nm_add_partial_data__)
     end
 
     should "be added to ::Array" do
-      assert_responds_to :__nm_add_call_data__, ::Array.new
+      assert_that([]).responds_to(:__nm_add_partial_data__)
     end
 
     should "be added to nil" do
-      assert_responds_to :__nm_add_call_data__, nil
+      assert_that(nil).responds_to(:__nm_add_partial_data__)
     end
-
   end
 
   class HashAddCallDataTests < AddCallDataTests
     desc "on ::Hash"
-    setup do
-      @h = { 1 => '1' }
-    end
+
+    let(:h){ { 1 => "1" } }
 
     should "merge and return hash and nil data" do
-      add = { 2 => '2' }
-      assert_equal @h.merge(add), @h.__nm_add_call_data__(@call_name, add)
-      assert_equal @h, @h.__nm_add_call_data__(@call_name, nil)
+      add = { 2 => "2" }
+      assert_that(h.__nm_add_partial_data__(add)).equals(h.merge(add))
+      assert_that(h.__nm_add_partial_data__(nil)).equals(h)
     end
 
     should "complain if adding Array data" do
       add = []
-      assert_raises Nm::InvalidError do
-        @h.__nm_add_call_data__(@call_name, add)
-      end
+      assert_that{ h.__nm_add_partial_data__(add) }.raises(Nm::InvalidError)
     end
-
   end
 
   class ArrayAddCallDataTests < AddCallDataTests
     desc "on ::Array"
-    setup do
-      @a = [1, 2]
-    end
+
+    let(:a){ [1, 2] }
 
     should "concat and return array and nil data" do
       add = [3, 4]
-      assert_equal @a.concat(add), @a.__nm_add_call_data__(@call_name, add)
-      assert_equal @a, @a.__nm_add_call_data__(@call_name, nil)
+      assert_that(a.__nm_add_partial_data__(add)).equals(a.concat(add))
+      assert_that(a.__nm_add_partial_data__(nil)).equals(a)
     end
 
     should "complain if adding Hash data" do
       add = {}
-      assert_raises Nm::InvalidError do
-        @a.__nm_add_call_data__(@call_name, add)
-      end
+      assert_that{ a.__nm_add_partial_data__(add) }.raises(Nm::InvalidError)
     end
-
   end
 
   class NilAddCallDataTests < AddCallDataTests
     desc "on nil"
-    setup do
-      @n = nil
-    end
+
+    let(:n){ nil }
 
     should "return any given data" do
-      add_hash = { 1 => '1' }
+      add_hash = { 1 => "1" }
       add_array = [3, 4]
-      assert_equal add_hash,  @n.__nm_add_call_data__(@call_name, add_hash)
-      assert_equal add_array, @n.__nm_add_call_data__(@call_name, add_array)
-      assert_equal @n, @n.__nm_add_call_data__(@call_name, nil)
+      assert_that(n.__nm_add_partial_data__(add_hash)).equals(add_hash)
+      assert_that(n.__nm_add_partial_data__(add_array)).equals(add_array)
+      assert_that(n.__nm_add_partial_data__(nil)).equals(n)
     end
-
   end
-
 end

data/test/unit/nm_tests.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "assert"
+require "nm"
+
+module Nm
+  class UnitTests < Assert::Context
+    desc "Nm"
+    subject{ unit_class }
+
+    let(:unit_class){ Nm }
+
+    should have_imeths :default_context_class, :default_context
+
+    should "know its attributes" do
+      assert_that(subject.default_context_class).is_a(Class)
+      assert_that(subject.default_context).is_a(subject.default_context_class)
+    end
+  end
+end