nm 0.4.0 → 0.5.0

data/README.md

@@ -65,6 +65,24 @@ Output:
 
 ## Notes
 
+### Cache Templates
+
+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)
+```
+
+### Default locals
+
+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'
+})
+```
+
 ### 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.

data/lib/nm/source.rb

@@ -7,12 +7,15 @@ module Nm
 
     EXT = ".nm"
 
-    attr_reader :root, :template_class
+    attr_reader :root, :cache, :template_class
+
+    def initialize(root, opts = nil)
+      opts ||= {}
+      @root  = Pathname.new(root.to_s)
+      @cache = opts[:cache] ? Hash.new : NullCache.new
 
-    def initialize(root, locals = nil)
-      @root = Pathname.new(root.to_s)
       @template_class = Class.new(Template) do
-        (locals || {}).each{ |key, value| define_method(key){ value } }
+        (opts[:locals] || {}).each{ |key, value| define_method(key){ value } }
       end
     end
 
@@ -21,7 +24,9 @@ module Nm
     end
 
     def data(file_path)
-      File.send(File.respond_to?(:binread) ? :binread : :read, file_path)
+      @cache[file_path] ||= begin
+        File.send(File.respond_to?(:binread) ? :binread : :read, file_path)
+      end
     end
 
     def render(file_name, locals = nil)
@@ -36,6 +41,12 @@ module Nm
       self.root.join("#{file_name}#{EXT}").to_s
     end
 
+    class NullCache
+      def [](file_name);         end
+      def []=(file_name, value); end
+      def keys; [];              end
+    end
+
   end
 
   class DefaultSource < Source

data/lib/nm/version.rb

@@ -1,3 +1,3 @@
 module Nm
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/test/unit/source_tests.rb

@@ -7,7 +7,10 @@ class Nm::Source
 
   class UnitTests < Assert::Context
     desc "Nm::Source"
-    subject{ Nm::Source }
+    setup do
+      @source_class = Nm::Source
+    end
+    subject{ @source_class }
 
     should "know its extension" do
       assert_equal ".nm", subject::EXT
@@ -19,24 +22,35 @@ class Nm::Source
     desc "when init"
     setup do
       @root = Factory.template_root
-      @source = Nm::Source.new(@root)
+      @source = @source_class.new(@root)
     end
     subject{ @source }
 
-    should have_readers :root, :template_class
+    should have_readers :root, :cache, :template_class
     should have_imeths :data, :render, :partial
 
     should "know its root" do
       assert_equal @root, subject.root.to_s
     end
 
+    should "not cache templates by default" do
+      assert_kind_of NullCache, subject.cache
+    end
+
+    should "cache templates if the :cache opt is `true`" do
+      source = @source_class.new(@root, :cache => true)
+      assert_kind_of Hash, source.cache
+    end
+
     should "know its template class" do
       assert_true subject.template_class < Nm::Template
     end
 
     should "optionally take and apply default locals to its template class" do
       local_name, local_val = [Factory.string, Factory.string]
-      source = Nm::Source.new(@root, local_name => local_val)
+      source = @source_class.new(@root, :locals => {
+        local_name => local_val
+      })
       template = source.template_class.new
 
       assert_responds_to local_name, template
@@ -56,6 +70,19 @@ class Nm::Source
       assert_equal exp, subject.data(@file_path)
     end
 
+    should "not cache template source by default" do
+      assert_equal [], subject.cache.keys
+    end
+
+    should "cache template source by file path if enabled" do
+      source = @source_class.new(@root, :cache => true)
+
+      exp = File.read(@file_path)
+      assert_equal exp, source.data(@file_path)
+      assert_equal [@file_path], source.cache.keys
+      assert_equal exp, source.cache[@file_path]
+    end
+
   end
 
   class RenderTests < InitTests
@@ -63,7 +90,7 @@ class Nm::Source
     setup do
       @file_name = "locals"
       @file_locals = { 'key' => 'a-value' }
-      @file_path = Factory.template_file("#{@file_name}#{Nm::Source::EXT}")
+      @file_path = Factory.template_file("#{@file_name}#{@source_class::EXT}")
     end
 
     should "render a template for the given file name and return its data" do
@@ -86,7 +113,7 @@ class Nm::Source
     subject{ @source }
 
     should "be a Source" do
-      assert_kind_of Nm::Source, subject
+      assert_kind_of @source_class, subject
     end
 
     should "use `/` as its root" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: nm
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 11
   prerelease: 
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-11-25 00:00:00 Z
+date: 2015-01-19 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement