roda 3.20.0 → 3.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bce3cf55fdec3d303d3d78b6e190046b38619e9ab296b63575962864535339e5
-  data.tar.gz: 874904308a03694809bd777c406ed94e1cefcc11bb9d7e748dd860a22c853d18
+  metadata.gz: 34a644ccaa69bc1913eb1f54315437ce4b215bd5925e82f720d0fda007895224
+  data.tar.gz: 9a85847e46720f4fa2f7a050febd5b0f6ef7db528c8fbd09836113148944f87c
 SHA512:
-  metadata.gz: 0c08ac192ce7a3609b968404e4a3bf232ad7d12d1e70ed3e0c3306fea13ddf91bbf746bff47ec746acfc3481c5bfbaed3d7916dbf44c88c9b7f4d8855be64358
-  data.tar.gz: c3e6e9d50efc13dcd202379a76fef8ad6305c29f38954c8ed340ce7bd274b0ffe792cecb69a8ec0ea37aebc0d9fe1aeda16ea87d50f0f8892c1d805121f635ee
+  metadata.gz: 739c2a26ea80aeca2bbb4b3b51c4cabf93100309956fe594b61cc66a72f6d3e2f23ab0356c81f12e4a461bf82eb1d7f9cc2d0dc5fecbef88348bd17aca17c33a
+  data.tar.gz: 65ef8401849ee398968ccfce12ccbf203914f7a76721c8cb0ef31b5ab9051fd7f8460361dd96abb495dfa25c5acb50141611448b7065a5be3340b8ca51cc70ff

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 3.21.0 (2019-06-14)
+
+* Cache compiled templates in development mode, until the template files are modified (jeremyevans)
+
 = 3.20.0 (2019-05-16)
 
 * Set Content-Length header to 0 for empty 205 responses (jeremyevans)

data/Rakefile

@@ -7,7 +7,7 @@ VERS = lambda do
   require_relative 'lib/roda/version'
   Roda::RodaVersion
 end
-CLEAN.include ["#{NAME}-*.gem", "rdoc", "coverage", "www/public/*.html", "www/public/rdoc", "spec/assets/app.*.css", "spec/assets/app.*.js", "spec/assets/app.*.css.gz", "spec/assets/app.*.js.gz"]
+CLEAN.include ["#{NAME}-*.gem", "rdoc", "coverage", "www/public/*.html", "www/public/rdoc", "spec/assets/app.*.css", "spec/assets/app.*.js", "spec/assets/app.*.css.gz", "spec/assets/app.*.js.gz", "spec/iv.erb"]
 
 # Gem Packaging and Release
 

data/doc/release_notes/3.21.0.txt

@@ -0,0 +1,5 @@
+= Improvements
+
+* View rendering speed is significantly improved in development mode
+  by caching file-based templates until there has been a modification
+  to the template file.

data/lib/roda/plugins/render.rb

@@ -48,8 +48,11 @@ class Roda
     #
     # :allowed_paths :: Set the template paths to allow.  Attempts to render paths outside
     #                   of this directory will raise an error.  Defaults to the +:views+ directory.
-    # :cache :: nil/false to disable template caching by default.  By default, caching
-    #           is disabled by default if RACK_ENV is development.
+    # :cache :: nil/false to explicitly disable premanent template caching.  By default, permanent
+    #           template caching is disabled by default if RACK_ENV is development.  When permanent
+    #           template caching is disabled, for templates with paths in the file system, the
+    #           modification time of the file will be checked on every render, and if it has changed,
+    #           a new template will be created for the current content of the file.
     # :cache_class :: A class to use as the template cache instead of the default.
     # :check_paths :: Can be set to false to turn off template path checking.
     # :engine :: The tilt engine to use for rendering, also the default file extension for
@@ -83,7 +86,7 @@ class Roda
     #
     # :cache :: Set to false to not cache this template, even when
     #           caching is on by default.  Set to true to force caching for
-    #           this template, even when the default is to not cache (e.g.
+    #           this template, even when the default is to not permantently cache (e.g.
     #           when using the :template_block option).
     # :cache_key :: Explicitly set the hash key to use when caching.
     # :content :: Only respected by +view+, provides the content to render
@@ -152,11 +155,11 @@ class Roda
         opts[:allowed_paths] = opts[:allowed_paths].map{|f| app.expand_path(f, nil)}.uniq.freeze
         opts[:check_paths] = true unless opts.has_key?(:check_paths)
 
-        unless opts.has_key?(:explicit_cache)
-          opts[:explicit_cache] = if opts.fetch(:cache, true)
-            ENV['RACK_ENV'] == 'development'
-          else
+        unless opts.has_key?(:check_template_mtime)
+          opts[:check_template_mtime] = if opts[:cache] == false || opts[:explicit_cache]
             true
+          else
+            ENV['RACK_ENV'] == 'development'
           end
         end
 
@@ -211,6 +214,34 @@ class Roda
         opts.freeze
       end
 
+      # Wrapper object for the Tilt template, that checks the modified
+      # time of the template file, and rebuilds the template if the
+      # template file has been modified.
+      class TemplateMtimeWrapper
+        def initialize(template_class, path, *template_args)
+          @template_class = template_class
+          @path = path
+          @template_args = template_args
+
+          @mtime = (File.mtime(path) if File.file?(path))
+          @template = template_class.new(path, *template_args)
+        end
+
+        # If the template file exists and the modification time has
+        # changed, rebuild the template file, then call render on it.
+        def render(*args, &block)
+          if File.file?(path = @path)
+            mtime = File.mtime(path)
+            if mtime != @mtime
+              @mtime = mtime
+              @template = @template_class.new(path, *@template_args)
+            end
+          end
+
+          @template.render(*args, &block)
+        end
+      end
+
       module ClassMethods
         # Copy the rendering options into the subclass, duping
         # them as necessary to prevent changes in the subclass
@@ -268,7 +299,7 @@ class Roda
         # If caching templates, attempt to retrieve the template from the cache.  Otherwise, just yield
         # to get the template.
         def cached_template(opts, &block)
-          if (!render_opts[:explicit_cache] || opts[:cache]) && (key = opts[:cache_key])
+          if key = opts[:cache_key]
             cache = render_opts[:cache]
             unless template = cache[key]
               template = cache[key] = yield
@@ -335,7 +366,8 @@ class Roda
 
         # Retrieve the Tilt::Template object for the given template and opts.
         def retrieve_template(opts)
-          unless opts[:cache_key] && opts[:cache] != false
+          cache = opts[:cache]
+          if !opts[:cache_key] || cache == false
             found_template_opts = opts = find_template(opts)
           end
           cached_template(opts) do
@@ -347,7 +379,12 @@ class Roda
             if current_template_opts = opts[:template_opts]
               template_opts = template_opts.merge(current_template_opts)
             end
-            opts[:template_class].new(opts[:path], 1, template_opts, &opts[:template_block])
+
+            if render_opts[:check_template_mtime] && !opts[:template_block] && !cache
+              TemplateMtimeWrapper.new(opts[:template_class], opts[:path], 1, template_opts)
+            else
+              opts[:template_class].new(opts[:path], 1, template_opts, &opts[:template_block])
+            end
           end
         end
 

data/lib/roda/version.rb

@@ -4,7 +4,7 @@ class Roda
   RodaMajorVersion = 3
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 20
+  RodaMinorVersion = 21
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/plugin/render_spec.rb

@@ -61,6 +61,66 @@ describe "render plugin" do
   end
 end
 
+describe "render plugin" do
+  file = 'spec/iv.erb'
+  before do
+    File.binwrite(file, File.binread('spec/views/iv.erb'))
+  end
+  after do
+    File.delete(file) if File.file?(file)
+  end
+
+  [{:cache=>false}, {:explicit_cache=>true}, {:check_template_mtime=>true}].each do |cache_plugin_opts|
+    it "checks mtime if #{cache_plugin_opts} plugin option is used" do
+      app(:bare) do
+        plugin :render, {:views=>"./spec"}.merge!(cache_plugin_opts)
+
+        route do |r|
+          @a = 'a'
+          render('iv')
+        end
+      end
+
+      t = Time.now
+      body.strip.must_equal "a"
+
+      File.binwrite(file, File.binread(file) + "b")
+      File.utime(t, t+1, file)
+      body.gsub("\n", '').must_equal "ab"
+
+      File.binwrite(file, File.binread(file) + "c")
+      File.utime(t, t+2, file)
+      body.gsub("\n", '').must_equal "abc"
+
+      mtime = File.mtime(file)
+      File.binwrite(file, File.binread(file) + "d")
+      File.utime(t, mtime, file)
+      body.gsub("\n", '').must_equal "abc"
+
+      File.delete(file)
+      body.gsub("\n", '').must_equal "abc"
+    end
+  end
+
+  it "does not check mtime if :cache render option is used" do
+    app(:bare) do
+      plugin :render, :views=>"./spec", :cache=>false
+
+      route do |r|
+        @a = 'a'
+        render('iv', :cache=>true)
+      end
+    end
+
+    t = Time.now+1
+    body.strip.must_equal "a"
+
+    File.binwrite(file, File.binread(file) + "b")
+    File.utime(t, t+1, file)
+    body.gsub("\n", '').must_equal "a"
+  end
+end
+
 describe "render plugin" do
   it "simple layout support" do
     app(:bare) do
@@ -322,13 +382,13 @@ describe "render plugin" do
     body('/c').must_equal "3"
   end
 
-  it "Default to :explicit_cache=>true in development mode" do
+  it "Default to :check_template_mtime=>true in development mode" do
     with_rack_env('development') do
       app(:render){}
     end
-    app.render_opts[:explicit_cache].must_equal true
+    app.render_opts[:check_template_mtime].must_equal true
     app(:render){}
-    app.render_opts[:explicit_cache].must_equal false
+    app.render_opts[:check_template_mtime].must_equal false
   end
 
   it "Support :cache=>false plugin option to disable template caching by default, except :cache=>true method option is given" do
@@ -365,7 +425,7 @@ describe "render plugin" do
     body('/a').strip.must_equal "a"
     app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].must_be_nil
     body('/b').strip.must_equal "a"
-    app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].wont_equal nil
+    app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].wont_be_nil
   end
 
   it "Support :cache=>false option to disable template caching even when :cache_key is given" do
@@ -382,41 +442,28 @@ describe "render plugin" do
     body('/a').strip.must_equal "a"
     app.render_opts[:cache][:foo].must_be_nil
     body('/b').strip.must_equal "a"
-    app.render_opts[:cache][:foo].wont_equal nil
+    app.render_opts[:cache][:foo].wont_be_nil
   end
 
-  it "Support :explicit_cache option to disable caching by default, but still allow caching on a per-call basis" do
-    app(:bare) do
-      plugin :render, :views=>"./spec/views", :explicit_cache=>true
-
-      route do |r|
-        @a = 'a'
-        r.is('a'){render('iv')}
-        render('iv', :cache=>true)
-      end
-    end
-
-    body('/a').strip.must_equal "a"
-    app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].must_be_nil
-    body('/b').strip.must_equal "a"
-    app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].wont_equal nil
-  end
+  [{}, {:cache=>true}].each do |cache_val_opts|
+    [{}, {:cache_key=>:foo}].each do |cache_key_opts|
+      cache_opts = cache_key_opts.merge(cache_val_opts)
+      it "Support :explicit_cache plugin option with #{cache_opts} render option" do
+        app(:bare) do
+          plugin :render, :views=>"./spec/views", :explicit_cache=>true
 
-  it "Support :explicit_cache plugin option with :cache_key render option" do
-    app(:bare) do
-      plugin :render, :views=>"./spec/views", :explicit_cache=>true
+          route do |r|
+            @a = 'a'
+            render('iv', cache_opts)
+          end
+        end
 
-      route do |r|
-        @a = 'a'
-        r.is('a'){render('iv', :cache_key=>:foo)}
-        render('iv', :cache=>true, :cache_key=>:foo)
+        body('/a').strip.must_equal "a"
+        template = app.render_opts[:cache][cache_opts[:cache_key] || File.expand_path("spec/views/iv.erb")]
+        template.must_be_kind_of(cache_val_opts.empty? ? Roda::RodaPlugins::Render::TemplateMtimeWrapper : Tilt::Template)
+        body('/a').strip.must_equal "a"
       end
     end
-
-    body('/a').strip.must_equal "a"
-    app.render_opts[:cache][:foo].must_be_nil
-    body('/b').strip.must_equal "a"
-    app.render_opts[:cache][:foo].wont_equal nil
   end
 
   it "Support :cache=>true option to enable template caching when :template_block is used" do
@@ -445,7 +492,7 @@ describe "render plugin" do
     body('/a').strip.must_equal "iv-a"
     app.render_opts[:cache][['iv', c, nil, nil, proca]].must_be_nil
     body('/b').strip.must_equal "iv-a"
-    app.render_opts[:cache][['iv', c, nil, nil, proca]].wont_equal nil
+    app.render_opts[:cache][['iv', c, nil, nil, proca]].wont_be_nil
   end
 
   it "Support :cache_key option to force the key used when caching, unless :cache=>false option is used" do
@@ -500,17 +547,17 @@ describe "render plugin" do
     c = Class.new(Roda)
     c.plugin :render
     cache = c.render_opts[:cache]
-    c.render_opts[:explicit_cache].must_equal false
+    c.render_opts[:check_template_mtime].must_equal false
     c.plugin :render
     c.render_opts[:cache].must_be_same_as cache
-    c.render_opts[:explicit_cache].must_equal false
+    c.render_opts[:check_template_mtime].must_equal false
 
     c.plugin :render, :cache=>false
     c.render_opts[:cache].must_be_same_as cache
-    c.render_opts[:explicit_cache].must_equal true
+    c.render_opts[:check_template_mtime].must_equal true
     c.plugin :render
     c.render_opts[:cache].must_be_same_as cache
-    c.render_opts[:explicit_cache].must_equal true
+    c.render_opts[:check_template_mtime].must_equal true
   end
 
   it "render plugin call should not override existing options" do
@@ -530,7 +577,7 @@ describe "render plugin" do
     end
 
     body("/inline").strip.must_equal "Hello Agent Smith"
-    Class.new(app).render_opts[:cache][:a].must_be_nil
+    Class.new(app).render_opts[:check_template_mtime].must_equal true
   end
 
   it "with :check_paths=>true plugin option used" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.20.0
+  version: 3.21.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -217,6 +217,7 @@ extra_rdoc_files:
 - doc/release_notes/3.18.0.txt
 - doc/release_notes/3.19.0.txt
 - doc/release_notes/3.20.0.txt
+- doc/release_notes/3.21.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -273,6 +274,7 @@ files:
 - doc/release_notes/3.19.0.txt
 - doc/release_notes/3.2.0.txt
 - doc/release_notes/3.20.0.txt
+- doc/release_notes/3.21.0.txt
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.4.0.txt
 - doc/release_notes/3.5.0.txt