deas-erubis 0.1.0 → 0.2.0

data/lib/deas-erubis/source.rb

@@ -8,73 +8,33 @@ module Deas::Erubis
   class Source
 
     EXT           = '.erb'.freeze
-    CACHE_EXT     = '.cache'.freeze
     BUFVAR_NAME   = '@_erb_buf'.freeze
     DEFAULT_ERUBY = ::Erubis::Eruby
 
-    attr_reader :root, :cache_root, :eruby_class, :context_class
+    attr_reader :root, :eruby_class, :cache, :context_class
 
     def initialize(root, opts)
-      @root        = Pathname.new(root.to_s)
-      @eruby_class = opts[:eruby] || DEFAULT_ERUBY
-
-      should_cache = !!opts[:cache]
-      @cache_root  = opts[:cache] == true ? @root : Pathname.new(opts[:cache].to_s)
-      @cache_root.mkpath if should_cache && !@cache_root.exist?
-
-      if should_cache
-        # use `load_file` to lookup and cache templates (faster renders)
-        if @cache_root == @root
-          # use the `load_file` default and don't bother with looking up, setting,
-          # and making sure the cache file path exists - by default `load_file`
-          # caches alongside the source with the `CACHE_EXT` appended.
-          add_meta_eruby_method do |file_name|
-            @eruby_class.load_file(source_file_path(file_name), {
-              :bufvar => BUFVAR_NAME
-            })
-          end
-        else
-          # lookup and ensure the custom cache location exists (more expensive)
-          add_meta_eruby_method do |file_name|
-            @eruby_class.load_file(source_file_path(file_name), {
-              :bufvar    => BUFVAR_NAME,
-              :cachename => cache_file_path(file_name)
-            })
-          end
-        end
-      else
-        # don't cache template files (slower renders, but no cache files created)
-        add_meta_eruby_method do |file_name|
-          filename = source_file_path(file_name).to_s
-          template = File.send(File.respond_to?(:binread) ? :binread : :read, filename)
-          @eruby_class.new(template, {
-            :bufvar   => BUFVAR_NAME,
-            :filename => filename
-          })
-        end
-      end
-
-      @deas_source   = opts[:deas_source]
+      @root          = Pathname.new(root.to_s)
+      @eruby_class   = opts[:eruby] || DEFAULT_ERUBY
+      @cache         = opts[:cache] ? Hash.new : NullCache.new
       @context_class = build_context_class(opts)
-    end
 
-    def eruby(file_name)
-      # should be overridden by a metaclass equivalent on init
-      # the implementation changes whether you are caching templates or not
-      # and the goal here is to not add a bunch of conditional overhead as this
-      # will be called on every render
-      raise NotImplementedError
+      @deas_source = opts[:deas_source]
     end
 
     def render(file_name, locals, &content)
-      eruby(file_name).evaluate(@context_class.new(@deas_source, locals), &content)
+      load(file_name).evaluate(@context_class.new(@deas_source, locals), &content)
     end
 
-    def compile(file_name, content)
+    def compile(filename, content)
+      eruby(filename, content).evaluate(@context_class.new(@deas_source, {}))
+    end
+
+    def eruby(filename, content)
       @eruby_class.new(content, {
         :bufvar   => BUFVAR_NAME,
-        :filename => file_name
-      }).evaluate(@context_class.new(@deas_source, {}))
+        :filename => filename
+      })
     end
 
     def inspect
@@ -85,21 +45,16 @@ module Deas::Erubis
 
     private
 
-    def source_file_path(file_name)
-      self.root.join("#{file_name}#{EXT}").to_s
-    end
-
-    def cache_file_path(file_name)
-      self.cache_root.join("#{file_name}#{EXT}#{CACHE_EXT}").tap do |path|
-        path.dirname.mkpath if !path.dirname.exist?
-      end.to_s
+    def load(file_name)
+      @cache[file_name] ||= begin
+        filename = source_file_path(file_name).to_s
+        content = File.send(File.respond_to?(:binread) ? :binread : :read, filename)
+        eruby(filename, content)
+      end
     end
 
-    def add_meta_eruby_method(&method)
-      metaclass = class << self; self; end
-      metaclass.class_eval do
-        define_method(:eruby, &method)
-      end
+    def source_file_path(file_name)
+      self.root.join("#{file_name}#{EXT}").to_s
     end
 
     def build_context_class(opts)
@@ -121,6 +76,12 @@ module Deas::Erubis
       end
     end
 
+    class NullCache
+      def [](file_name);         end
+      def []=(file_name, value); end
+      def keys; [];              end
+    end
+
   end
 
   class DefaultSource < Source

data/lib/deas-erubis/version.rb

@@ -1,4 +1,4 @@
 module Deas; end
 module Deas::Erubis
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/test/unit/source_tests.rb

@@ -12,9 +12,8 @@ class Deas::Erubis::Source
     end
     subject{ @source_class }
 
-    should "know its extensions" do
+    should "know its extension" do
       assert_equal '.erb',   subject::EXT
-      assert_equal '.cache', subject::CACHE_EXT
     end
 
     should "know the bufvar name to use" do
@@ -35,8 +34,8 @@ class Deas::Erubis::Source
     end
     subject{ @source }
 
-    should have_readers :root, :cache_root, :eruby_class, :context_class
-    should have_imeths :eruby, :render, :compile
+    should have_readers :root, :eruby_class, :cache, :context_class
+    should have_imeths :render, :compile, :eruby
 
     should "know its root" do
       assert_equal @root, subject.root.to_s
@@ -53,32 +52,23 @@ class Deas::Erubis::Source
     end
 
     should "build eruby instances for a given template file" do
-      assert_kind_of subject.eruby_class, subject.eruby('basic')
+      assert_kind_of subject.eruby_class, subject.eruby('basic', Factory.string)
     end
 
     should "build its eruby instances with the correct bufvar name" do
+      eruby = subject.eruby('basic', Factory.string)
+
       exp = Deas::Erubis::Source::BUFVAR_NAME
-      assert_equal exp, subject.eruby('basic').instance_variable_get('@bufvar')
+      assert_equal exp, eruby.instance_variable_get('@bufvar')
     end
 
-    should "default its cache root" do
-      assert_equal Pathname.new('').to_s, subject.cache_root.to_s
+    should "not cache templates by default" do
+      assert_kind_of NullCache, subject.cache
     end
 
-    should "use the root as its cache root if :cache opt is `true`" do
+    should "cache templates if the :cache opt is `true`" do
       source = @source_class.new(@root, :cache => true)
-      assert_equal @root.to_s, source.cache_root.to_s
-    end
-
-    should "optionally use a custom cache root" do
-      source = @source_class.new(@root, :cache => TEMPLATE_CACHE_ROOT)
-      assert_equal TEMPLATE_CACHE_ROOT.to_s, source.cache_root.to_s
-    end
-
-    should "create the cache root if it doesn't exist already" do
-      FileUtils.rm_rf(TEMPLATE_CACHE_ROOT) if TEMPLATE_CACHE_ROOT.exist?
-      source = @source_class.new(@root, :cache => TEMPLATE_CACHE_ROOT)
-      assert_file_exists TEMPLATE_CACHE_ROOT.to_s
+      assert_kind_of Hash, source.cache
     end
 
     should "know its context class" do
@@ -121,27 +111,15 @@ class Deas::Erubis::Source
 
   end
 
-  class RenderSetupTests < InitTests
+  class RenderTests < InitTests
+    desc "`render` method"
     setup do
+      @file_name   = "basic"
       @file_locals = {
         'name'   => Factory.string,
         'local1' => Factory.integer
       }
     end
-    teardown do
-      root = TEMPLATE_ROOT.join("*#{@source_class::CACHE_EXT}").to_s
-      Dir.glob(root).each{ |f| FileUtils.rm_f(f) }
-      root = TEMPLATE_CACHE_ROOT.join("*#{@source_class::CACHE_EXT}").to_s
-      Dir.glob(root).each{ |f| FileUtils.rm_f(f) }
-    end
-
-  end
-
-  class RenderTests < RenderSetupTests
-    desc "`render` method"
-    setup do
-      @file_name = "basic"
-    end
 
     should "render a template for the given file name and return its data" do
       exp = Factory.basic_erb_rendered(@file_locals)
@@ -162,36 +140,18 @@ class Deas::Erubis::Source
 
   end
 
-  class RenderEnabledCacheTests < RenderTests
+  class RenderCacheTests < RenderTests
     desc "when caching is enabled"
     setup do
       @source = @source_class.new(@root, :cache => true)
     end
 
-    should "cache templates in the root (cache root) alongside the source" do
-      f = "#{@file_name}#{@source_class::EXT}#{@source_class::CACHE_EXT}"
-      cache_file = subject.root.join(f)
-
-      assert_not_file_exists cache_file
-      subject.render(@file_name, @file_locals)
-      assert_file_exists cache_file
-    end
-
-  end
-
-  class RenderCustomCacheTests < RenderTests
-    desc "when caching is enabled on a custom cache root"
-    setup do
-      @source = @source_class.new(@root, :cache => TEMPLATE_CACHE_ROOT)
-    end
-
-    should "cache templates in the cache root" do
-      f = "#{@file_name}#{@source_class::EXT}#{@source_class::CACHE_EXT}"
-      cache_file = TEMPLATE_CACHE_ROOT.join(f)
+    should "cache template eruby instances by their file name" do
+      exp = Factory.basic_erb_rendered(@file_locals)
+      assert_equal exp, @source.render(@file_name, @file_locals)
 
-      assert_not_file_exists cache_file
-      subject.render(@file_name, @file_locals)
-      assert_file_exists cache_file
+      assert_equal [@file_name], @source.cache.keys
+      assert_kind_of @source.eruby_class, @source.cache[@file_name]
     end
 
   end
@@ -202,13 +162,11 @@ class Deas::Erubis::Source
       @source = @source_class.new(@root, :cache => false)
     end
 
-    should "not cache templates" do
-      f = "#{@file_name}#{@source_class::EXT}#{@source_class::CACHE_EXT}"
-      cache_file = subject.root.join(f)
+    should "not cache template eruby instances" do
+      exp = Factory.basic_erb_rendered(@file_locals)
+      assert_equal exp, @source.render(@file_name, @file_locals)
 
-      assert_not_file_exists cache_file
-      subject.render(@file_name, @file_locals)
-      assert_not_file_exists cache_file
+      assert_equal [], @source.cache.keys
     end
 
   end
@@ -227,7 +185,7 @@ class Deas::Erubis::Source
 
   end
 
-  class CompileTests < RenderSetupTests
+  class CompileTests < InitTests
     desc "`compile` method"
 
     should "compile raw content file name and return its data" do
@@ -238,15 +196,40 @@ class Deas::Erubis::Source
 
   end
 
-  class DefaultSource < UnitTests
-    desc "DefaultSource"
+  class NullCacheTests < UnitTests
+    desc "NullCache"
+    setup do
+      @cache = NullCache.new
+    end
+    subject{ @cache }
+
+    should have_imeths :[], :[]=, :keys
+
+    should "take a file name and return nothing on index" do
+      assert_nil subject[Factory.path]
+    end
+
+    should "take a file name and value and do nothing on index write" do
+      assert_nothing_raised do
+        subject[Factory.path] = Factory.string
+      end
+    end
+
+    should "always have empty keys" do
+      assert_equal [], subject.keys
+    end
+
+  end
+
+  class DefaultSourceTests < Assert::Context
+    desc "Deas::Erubis::DefaultSource"
     setup do
       @source = Deas::Erubis::DefaultSource.new
     end
     subject{ @source }
 
     should "be a Source" do
-      assert_kind_of @source_class, subject
+      assert_kind_of Deas::Erubis::Source, subject
     end
 
     should "use `/` as its root" do

data/test/unit/template_engine_tests.rb

@@ -34,9 +34,9 @@ class Deas::Erubis::TemplateEngine
       assert_equal custom_eruby, engine.erb_source.eruby_class
     end
 
-    should "allow custom cache roots on its source" do
-      engine = Deas::Erubis::TemplateEngine.new('cache' => TEMPLATE_CACHE_ROOT)
-      assert_equal TEMPLATE_CACHE_ROOT.to_s, engine.erb_source.cache_root.to_s
+    should "pass any given cache option to its source" do
+      engine = Deas::Erubis::TemplateEngine.new('cache' => true)
+      assert_kind_of Hash, engine.erb_source.cache
     end
 
     should "pass any given deas template source to its source" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deas-erubis
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kelly Redding
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2015-01-08 00:00:00 Z
+date: 2015-01-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   requirement: &id001 !ruby/object:Gem::Requirement