nm 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
---- 
-SHA512: 
-  metadata.gz: 31eb095487432e3c6b60cbb023624cce4b902371692cea5312d52d0bcd6a57d98ad2ca4171110f66e2bd4028fdf449c6eee00442d769fc260abd7ab76f8f15cb
-  data.tar.gz: 43ec476c3b63ec379f30edc5b75989f56843eab905e90a0a2b4422022102f2cbd5931cc3b09bbe7f3aeeacf26280a130dc6a8875af9cfd83b4ed903dcfeda5c8
-SHA1: 
-  metadata.gz: 79b11e40bec9d04eed9c4590c06ee9acc2a74ba9
-  data.tar.gz: 2a6984f912b917b14c9ab9ba5a524c310f8f7648
+---
+SHA256:
+  metadata.gz: dc0aecffbcfc3c14162b53a334c10172f41946f3e3d9a524e98b223dcb5a64bb
+  data.tar.gz: 25559fce124e9cfb71d46e9eda6d79ab39585f94fff0bdfee7b591df540616f9
+SHA512:
+  metadata.gz: 862701c2457f04f1479c124a0ba2d1d5c464b819baf035ba0779eb21f8253e2b0c133b5700268a20416b26a7e3629fc08b2187887f23f55c2b8cca78188b1c5d
+  data.tar.gz: acadad3b3ee918cf36e02975718cb0d7770d5b9f7b190451172c009ca90ad0b276efe970a697ecc3190d6f89bc1c91bc62a08049a09f6c40aaa59b3e36e248ae

data/.gitignore

@@ -4,6 +4,7 @@
 .rbx/
 .bundle
 .config
+.rubocop-*-yml
 .yardoc
 Gemfile.lock
 InstalledFiles

data/.l.yml

@@ -0,0 +1,9 @@
+# https://github.com/redding/l.rb
+
+linters:
+  - name: "Rubocop"
+    cmd: "bundle exec rubocop"
+    autocorrect_cmd: "bundle exec rubocop -A"
+    extensions:
+      - ".rb"
+    cli_abbrev: "u"

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_gem:
+  much-style-guide:
+    - "lib/much-style-guide/rubocop.yml"

data/.ruby-version

@@ -0,0 +1 @@
+2.7.3

data/.t.yml

@@ -0,0 +1,6 @@
+# https://github.com/redding/t.rb
+
+default_cmd: "bundle exec assert"
+test_dir: "test"
+test_file_suffixes:
+  - "_tests.rb"

data/Gemfile

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
+ruby "~> 2.5"
+
 gemspec
 
-gem 'pry', "~> 0.9.0"
+gem "pry"
 gem "whysoslow"
-gem 'rabl'
+gem "rabl"

data/README.md

@@ -1,6 +1,6 @@
 # Nm
 
-Data templating system.  Named for its two main markup methods: "node" and "map".  Designed to template data objects for JSON/BSON/whatever/etc serialization.
+Node-Map: a data templating DSL. Named for its two main markup methods: "node" and "map". Designed to template data objects for JSON/BSON/whatever/etc serialization.
 
 ## Usage
 
@@ -9,15 +9,15 @@ Template:
 ```ruby
 # in /path/to/views/slideshow.json.nm
 
-node 'slideshow' do
-  node 'start_slide', start_slide
-  node 'slides' do
+node "slideshow" do
+  node "start_slide", start_slide
+  node "slides" do
     map slides do |slide|
-      node 'id',    slide.id
-      node 'title', slide.title
-      node 'image', slide.image_url
-      node 'thumb', slide.thumb_url
-      node 'url',   slide.url
+      node "id",    slide.id
+      node "title", slide.title
+      node "image", slide.image_url
+      node "thumb", slide.thumb_url
+      node "url",   slide.url
     end
   end
 end
@@ -26,12 +26,15 @@ end
 Render:
 
 ```ruby
-require 'nm'
-source = Nm::Source.new('/path/to/views')
-source.render('slideshow.json', {
-  :start_slide => 1,
-  :slides => [ ... ] #=> list of slide objects 1, 2 and 3
-})
+require "nm"
+source = Nm::Source.new("/path/to/views")
+source.render(
+  "slideshow.json",
+  locals: {
+    start_slide: 1,
+    slides: [ ... ] #=> list of slide objects 1, 2 and 3
+  }
+)
 ```
 
 Output:
@@ -67,10 +70,10 @@ Output:
 
 ### Cache Templates
 
-By default the source doesn't cache template files.  You can configure it to cache templates using the `:cache` option:
+By default the source doesn't cache template files. You can configure it to cache templates using the `:cache` option:
 
 ```ruby
-source = Nm::Source.new('/path/to/views', :cache => true)
+source = Nm::Source.new("/path/to/views", cache: true)
 ```
 
 ### Default locals
@@ -78,14 +81,13 @@ source = Nm::Source.new('/path/to/views', :cache => true)
 You can specify a set of default locals to use on all renders for a source using the `:locals` option:
 
 ```ruby
-source = Nm::Source.new('/path/to/views', :locals => {
-  'something' => 'value'
-})
+source =
+  Nm::Source.new("/path/to/views", locals: { "something" => "value" })
 ```
 
 ### Render Format
 
-Rendering templates returns a data object (`::Hash` or `::Array`).  To serialize, bring in your favorite JSON/BSON/whatever serializer and pass the rendered object to it.
+Rendering templates returns a data object (`::Hash` or `::Array`). To serialize, bring in your favorite JSON/BSON/whatever serializer and pass the rendered object to it.
 
 ### Markup Methods
 
@@ -96,18 +98,18 @@ There are two main markup methods:
 
 ### Default render value
 
-Nm templates render an empty object (ie `::Hash.new`) if no source is given or no markup methods are called in the template source.  The idea is that the templates should always return *something* and avoid `nil` values as much as possible.
+Nm templates render an empty object (ie `::Hash.new`) if no source is given or no markup methods are called in the template source. The idea is that the templates should always return *something* and avoid `nil` values as much as possible.
 
 This is also more consistent with rendering mapped lists vs reduced objects.  Say your are mapping a list of objects in your template (using the `map` markup method):
 
 ```ruby
 map incoming_list do |item|
-  node 'name',  item.name
-  node 'value', item.value
+  node "name",  item.name
+  node "value", item.value
 end
 ```
 
-If there are no items in the incoming list, the template render produces an empty list.  Now say you are reducing an incoming list to a single object:
+If there are no items in the incoming list, the template render produces an empty list. Now say you are reducing an incoming list to a single object:
 
 ```ruby
 incoming_list.each do |item|
@@ -126,47 +128,47 @@ If there are no items in the incoming list, no markup methods are called, but th
 ```ruby
 # in /path/to/views/slideshow.json.nm
 
-node 'slideshow' do
-  node 'start_slide', start_slide
-  node 'slides' do
+node "slideshow" do
+  node "start_slide", start_slide
+  node "slides" do
     map slides do |slide|
-      partial '_slide.json', :slide => slide
+      partial "_slide.json", slide: slide
     end
   end
 end
 
 # in /path/to/views/_slide.json.nm
 
-node 'id',    slide.id
-node 'title', slide.title
-node 'image', slide.image_url
-node 'thumb', slide.thumb_url
-node 'url',   slide.url
+node "id",    slide.id
+node "title", slide.title
+node "image", slide.image_url
+node "thumb", slide.thumb_url
+node "url",   slide.url
 ```
 
 This will render the same output as above.
 
 ### Markup Aliases
 
-If you find you need to use a local named `node` or `map`, the markup methods are aliased as `n`, `_node`, `m`, and `_map` respectively.  Any combination of aliases is valid:
+If you find you need to use a local named `node` or `map`, the markup methods are aliased as `n`, `_node`, `m`, and `_map` respectively. Any combination of aliases is valid:
 
 ```ruby
-node 'slideshow' do
-  n 'start_slide', start_slide
-  _node 'slides' do
+node "slideshow" do
+  n "start_slide", start_slide
+  _node "slides" do
     _map slides do |slide|
-      _node 'id',    slide.id
-      node  'title', slide.title
-      _node 'image', slide.image_url
-      node  'thumb', slide.thumb_url
-      _node 'url',   slide.url
+      _node "id",    slide.id
+      node  "title", slide.title
+      _node "image", slide.image_url
+      node  "thumb", slide.thumb_url
+      _node "url",   slide.url
     end
     m other_slides do |slide|
-      node  'id',    slide.id
-      _node 'title', slide.title
-      node  'image', slide.image_url
-      _node 'thumb', slide.thumb_url
-      node  'url',   slide.url
+      node  "id",    slide.id
+      _node "title", slide.title
+      node  "image", slide.image_url
+      _node "thumb", slide.thumb_url
+      node  "url",   slide.url
     end
   end
 end
@@ -174,9 +176,9 @@ end
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application"s Gemfile:
 
-    gem 'nm'
+    gem "nm"
 
 And then execute:
 
@@ -190,6 +192,6 @@ Or install it yourself as:
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
+3. Commit your changes (`git commit -am "Added some feature"`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request

data/lib/nm.rb

@@ -1,4 +1,14 @@
+# frozen_string_literal: true
+
 require "nm/version"
-require 'nm/source'
+require "nm/source"
+
+module Nm
+  def self.default_context_class
+    @default_context_class ||= Class.new
+  end
 
-module Nm; end
+  def self.default_context
+    default_context_class.new
+  end
+end

data/lib/nm/context.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "nm/template_behaviors"
+
+module Nm; end
+
+class Nm::Context
+  def initialize(context, source:, locals:)
+    @context = context
+    @source = source
+
+    # apply template behaviors to the meta-context
+    metacontext = class << context; self; end
+    metacontext.class_eval do
+      include Nm::TemplateBehaviors
+
+      locals.each do |key, value|
+        define_method(key){ value }
+      end
+    end
+    @context.__nm_context__ = self
+  end
+
+  def render(template_name, locals = {})
+    source_file_path = @source.file_path!(template_name)
+    render_content(
+      @source.data(source_file_path),
+      locals: locals,
+      file_path: source_file_path,
+    )
+  end
+
+  alias_method :partial, :render
+
+  def render_content(content, locals: {}, file_path: nil)
+    @context.__nm_push_render__(locals.to_h)
+    @context.instance_eval(
+      "#{locals_code_for(locals)};#{content}",
+      file_path,
+      1,
+    )
+    @context.__nm_data__.tap{ |_data| @context.__nm_pop_render__ }
+  end
+
+  private
+
+  def locals_code_for(locals)
+    # Assign for the same variable is to suppress unused variable warning.
+    locals.reduce(+"") do |code, (key, _value)|
+      code <<
+        "#{key} = @__nm_locals__[:#{key}] || @__nm_locals__[\"#{key}\"]; "\
+        "#{key} = #{key};"
+    end
+  end
+end

data/lib/nm/ext.rb

@@ -1,31 +1,24 @@
-module Nm
-
-  class InvalidError < RuntimeError; end
+# frozen_string_literal: true
 
+module Nm
+  class InvalidError < RuntimeError
+  end
 end
 
 class ::Hash
-
-  def __nm_add_call_data__(call_name, data)
-    if data.is_a?(::Array)
-      raise Nm::InvalidError, "invalid `#{call_name}` call"
-    end
-    self.merge(data || {})
+  def __nm_add_partial_data__(data)
+    raise Nm::InvalidError, "invalid partial call" if data.is_a?(::Array)
+    merge(data || {})
   end
-
 end
 
 class ::Array
-
-  def __nm_add_call_data__(call_name, data)
-    if data.is_a?(::Hash)
-      raise Nm::InvalidError, "invalid `#{call_name}` call"
-    end
-    self.concat(data || [])
+  def __nm_add_partial_data__(data)
+    raise Nm::InvalidError, "invalid partial call" if data.is_a?(::Hash)
+    concat(data || [])
   end
-
 end
 
-def nil.__nm_add_call_data__(call_name, data)
+def nil.__nm_add_partial_data__(data)
   data
 end

data/lib/nm/render.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Nm; end
+
+class Nm::Render
+  attr_reader :dstack, :locals
+
+  def initialize(dstack:, locals:)
+    @dstack = dstack
+    @locals = locals
+  end
+end

data/lib/nm/source.rb

@@ -1,70 +1,83 @@
-require 'pathname'
-require 'nm/template'
+# frozen_string_literal: true
 
-module Nm
+require "pathname"
+require "nm/context"
 
-  class Source
+module Nm; end
 
-    attr_reader :root, :ext, :cache, :template_class
+class Nm::Source
+  attr_reader :root, :extension, :cache, :locals
 
-    def initialize(root, opts = nil)
-      opts ||= {}
-      @root  = Pathname.new(root.to_s)
-      @ext   = opts[:ext] ? ".#{opts[:ext]}" : nil
-      @cache = opts[:cache] ? Hash.new : NullCache.new
-
-      @template_class = Class.new(Template) do
-        (opts[:locals] || {}).each{ |key, value| define_method(key){ value } }
-      end
-    end
+  def initialize(root, extension: nil, cache: false, locals: {})
+    @root = Pathname.new(root.to_s)
+    @extension = extension ? ".#{extension}" : nil
+    @cache = cache ? {} : NullCache.new
+    @locals = locals
+  end
 
-    def inspect
-      "#<#{self.class}:#{'0x0%x' % (object_id << 1)} @root=#{@root.inspect}>"
-    end
+  def inspect
+    "#<#{self.class}:#{"0x0%x" % (object_id << 1)} @root=#{@root.inspect}>"
+  end
 
-    def data(file_path)
-      @cache[file_path] ||= begin
+  def data(file_path)
+    @cache[file_path] ||=
+      begin
         File.send(File.respond_to?(:binread) ? :binread : :read, file_path)
       end
-    end
+  end
 
-    def render(template_name, locals = nil)
-      if (filename = source_file_path(template_name)).nil?
-        template_desc = "a template file named #{template_name.inspect}"
-        if !@ext.nil?
-          template_desc += " that ends in #{@ext.inspect}"
-        end
-        raise ArgumentError, "#{template_desc} does not exist"
-      end
-      @template_class.new(self, filename, locals || {}).__data__
+  def render(template_name, context: Nm.default_context, locals: {})
+    Nm::Context
+      .new(context, source: self, locals: @locals)
+      .render(template_name, locals)
+  end
+
+  def file_path!(template_name)
+    if (path = file_path(template_name)).nil?
+      message  = "a template file named #{template_name.inspect}"
+      message += " that ends in #{@extension.inspect}" unless @extension.nil?
+      message += " does not exist"
+      raise ArgumentError, message
     end
+    path
+  end
 
-    alias_method :partial, :render
+  def ==(other)
+    return super unless other.is_a?(self.class)
 
-    private
+    root == other.root &&
+    extension == other.extension &&
+    cache == other.cache &&
+    locals == other.locals
+  end
 
-    def source_file_path(name)
-      Dir.glob(self.root.join(source_file_glob_string(name))).first
-    end
+  private
 
-    def source_file_glob_string(name)
-      !@ext.nil? && name.end_with?(@ext) ? name : "#{name}*#{@ext}"
-    end
+  def file_path(template_name)
+    Dir.glob(root.join(file_glob_string(template_name))).first
+  end
 
-    class NullCache
-      def [](template_name);         end
-      def []=(template_name, value); end
-      def keys; [];                  end
+  def file_glob_string(template_name)
+    if !@extension.nil? && template_name.end_with?(@extension)
+      template_name
+    else
+      "#{template_name}*#{@extension}"
     end
-
   end
 
-  class DefaultSource < Source
+  class NullCache
+    def [](template_name)
+    end
 
-    def initialize
-      super('/')
+    def []=(template_name, value)
     end
 
-  end
+    def keys
+      []
+    end
 
+    def ==(other)
+      other.is_a?(self.class)
+    end
+  end
 end