roda 3.31.0 → 3.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d6d28c0f8b5197ab3d2a74726150921a435ccdcd8f18c6eb2c9bbe4d1cb2a14
-  data.tar.gz: f1464284c0cb20638bc7575769271c6ea39642ff3b1842fad33b92759db915cd
+  metadata.gz: 2a342192f0ab697bea9c4e5b55669644f06fe16e161539b1efc3d10f3c6b9947
+  data.tar.gz: cf01944fe14494efd606cd892cbbbae5b5128f5a1d83c5e411bd4c64cc6e4321
 SHA512:
-  metadata.gz: 4fca0abe3d0072e0a3e7201a089fd708610933ce4d461496bb0c13cbf7d84d2d10010c4007c460953972070d782742dba4d88799fd608f3df1ef7cca58cecef1
-  data.tar.gz: 189a647f809aa732baebc225ea313c59e543d0d0935c8008a85084694161753e0939a7cac4c1f9d010e03785ec792d49b6c3e5643925066e1cda12d0b7701237
+  metadata.gz: e5de72f1385942855bd2c8e1c0f6be5187430d7d83112d7400bc573f045456a445166edfdbb6a7f70779c7b008745e8063bd44274b0111dec95643f87cfe12fe
+  data.tar.gz: b69e2fb41045d19c1f9e79dd2d1a87ca691fcd8de975bd34e37456cd6c5183cd2a6ad6bb59a07594527588d2903ef1bceea5f356a809aef03c01e5f64415246b

data/CHANGELOG

@@ -1,3 +1,13 @@
+= 3.32.0 (2020-05-15)
+
+* Make :dependencies option in assets plugin work correctly with render plugin template caching (jeremyevans) (#191)
+
+* Support render method :dependencies option for specifying which files to check for modification (jgarth, jeremyevans) (#192)
+
+* Add each_partial to the partials plugin for rendering a partial for each element in an enumerable (jeremyevans)
+
+* Make render_each in render_each plugin handle template names with directories and extensions (jeremyevans)
+
 = 3.31.0 (2020-04-15)
 
 * Add :relative option to path method in path plugin, for generating a method returning relative paths (jeremyevans)

data/README.rdoc

@@ -418,6 +418,10 @@ You can provide an array to specify multiple request methods and match on any of
   {method: :post}             # matches POST
   {method: ['post', 'patch']} # matches POST and PATCH
 
+=== true
+
+If +true+ is given directly as a matcher, it always matches.
+
 === false, nil
 
 If +false+ or +nil+ is given directly as a matcher, it doesn't match anything.

data/doc/release_notes/3.31.0.txt

@@ -1,6 +1,6 @@
 = New Features
 
-* A relative_paths plugin has been added, adding a relative_path
+* A relative_path plugin has been added, adding a relative_path
   method that will take an absolute path and make it relative to the
   current request by prepending an appropriate prefix.  This is
   helpful when using Roda as a static site generator to generate a

data/doc/release_notes/3.32.0.txt

@@ -0,0 +1,42 @@
+= New Features
+
+* render_each in the render_each plugin now automatically handles
+  template names with subdirectories and extensions.  Previously, these
+  caused issues unless the :local option was provided.  So now you
+  can use:
+
+    render_each(foos, "items/foo")
+
+  instead of:
+
+    render_each(foos, "items/foo", :local=>:foo)
+
+* each_partial has been added to the partials plugin.  It operates
+  similarly to render_each, but uses the convention for partial
+  template naming.  So this:
+
+    each_partial(foos, "items/foo")
+
+  is the same as:
+
+    render_each(foos, "items/_foo", :local=>:foo)
+
+= Other Improvements
+
+* The :dependencies option in the assets plugin now works correctly
+  with compiled templates in the render plugin in uncached mode
+  (the default in development).  Previously, modifying a dependency
+  file would not result in recompiling the asset template when
+  requesting the main file.
+
+* Method visibility issues in the following plugins have been fixed:
+
+  * content_security_policy
+  * default_headers
+  * indifferent_params
+  * placeholder_string_matchers
+  * symbol_matchers
+
+  Previously, these plugins made private methods public by mistake
+  when overriding them.  Additionally, Roda.freeze no longer changes
+  the visibility of the set_default_headers private method.

data/lib/roda.rb

@@ -197,6 +197,8 @@ class Roda
               if instance_method(:set_default_headers).owner == ResponseMethods &&
                  instance_method(:default_headers).owner == ResponseMethods
 
+                private
+
                 def set_default_headers
                   @headers['Content-Type'] ||= 'text/html'
                 end

data/lib/roda/plugins/_symbol_regexp_matchers.rb

@@ -8,6 +8,8 @@ class Roda
     # using a regexp.
     module SymbolRegexpMatchers
       module RequestMethods
+        private
+
         # The regular expression to use for matching symbols.  By default, any non-empty
         # segment matches.
         def _match_symbol_regexp(s)

data/lib/roda/plugins/assets.rb

@@ -405,6 +405,11 @@ class Roda
           opts[s] ||= {} 
         end
 
+        expanded_deps = opts[:expanded_dependencies] = {}
+        opts[:dependencies].each do |file, deps|
+          expanded_deps[File.expand_path(file)] = Array(deps)
+        end
+
         if headers = opts[:headers]
           opts[:css_headers] = headers.merge(opts[:css_headers])
           opts[:js_headers]  = headers.merge(opts[:js_headers])
@@ -412,7 +417,7 @@ class Roda
         opts[:css_headers]['Content-Type'] ||= "text/css; charset=UTF-8".freeze
         opts[:js_headers]['Content-Type']  ||= "application/javascript; charset=UTF-8".freeze
 
-        [:css_headers, :js_headers, :css_opts, :js_opts, :dependencies].each do |s|
+        [:css_headers, :js_headers, :css_opts, :js_opts, :dependencies, :expanded_dependencies].each do |s|
           opts[s].freeze
         end
         [:headers, :css, :js].each do |s|
@@ -732,7 +737,7 @@ class Roda
           content = if file.end_with?(".#{type}")
             ::File.read(file)
           else
-            render_asset_file(file, :template_opts=>o[:"#{type}_opts"])
+            render_asset_file(file, :template_opts=>o[:"#{type}_opts"], :dependencies=>o[:expanded_dependencies][file])
           end
 
           o[:postprocessor] ? o[:postprocessor].call(file, type, content) : content
@@ -762,7 +767,7 @@ class Roda
         # other files, check the modification times of all dependencies and
         # return the maximum.
         def asset_last_modified(file)
-          if deps = self.class.assets_opts[:dependencies][file]
+          if deps = self.class.assets_opts[:expanded_dependencies][file]
             ([file] + Array(deps)).map{|f| ::File.stat(f).mtime}.max
           else
             ::File.stat(file).mtime

data/lib/roda/plugins/content_security_policy.rb

@@ -304,6 +304,8 @@ class Roda
           @content_security_policy ||= roda_class.opts[:content_security_policy].dup
         end
 
+        private
+
         # Set the appropriate content security policy header.
         def set_default_headers
           super

data/lib/roda/plugins/default_headers.rb

@@ -31,6 +31,8 @@ class Roda
           if owner == Base::ResponseMethods || (owner == response_class && app.opts[:set_default_headers_overridder] == response_class)
             app.opts[:set_default_headers_overridder] = response_class
             response_class.class_eval(<<-END, __FILE__, __LINE__+1)
+              private
+
               def set_default_headers
                 h = @headers
                 #{headers.map{|k,v| "h[#{k.inspect}] ||= #{v.inspect}"}.join('; ')}

data/lib/roda/plugins/hash_matcher.rb

@@ -8,7 +8,7 @@ class Roda
     #
     #   class App < Roda
     #     hash_matcher(:foo) do |v|
-    #       self['foo'] == v
+    #       params['foo'] == v
     #     end
     #
     #     route do

data/lib/roda/plugins/indifferent_params.rb

@@ -64,6 +64,8 @@ class Roda
         module RequestMethods
           QUERY_PARSER = Rack::Utils.default_query_parser = QueryParser.new(QueryParser::Params, 65536, 100)
 
+          private
+
           def query_parser
             QUERY_PARSER
           end

data/lib/roda/plugins/partials.rb

@@ -18,27 +18,54 @@ class Roda
     #   render('_test')
     #   render('dir/_test')
     #
-    # Note that this plugin automatically loads the :render plugin.
+    # To render the same template once for each object in an enumerable,
+    # you can use the +render_partials+ method:
+    #
+    #   each_partial([1,2,3], :foo) # uses _foo.erb
+    #
+    # This is basically equivalent to:
+    #
+    #   render_each([1,2,3], "_foo", local: :foo)
+    #
+    # This plugin depends on the render and render_each plugins.
     module Partials
-      # Depend on the render plugin, since this overrides
-      # some of its methods.
+      # Depend on the render plugin, passing received options to it.
+      # Also depend on the render_each plugin.
       def self.load_dependencies(app, opts=OPTS)
         app.plugin :render, opts
+        app.plugin :render_each
       end
 
       module InstanceMethods
+        # For each object in the given enumerable, render the given
+        # template (prefixing the template filename with an underscore).
+        def each_partial(enum, template, opts=OPTS)
+          unless opts.has_key?(:local)
+            opts = Hash[opts]
+            opts[:local] = render_each_default_local(template)
+          end
+          render_each(enum, partial_template_name(template.to_s), opts)
+        end
+
         # Renders the given template without a layout, but
         # prefixes the template filename to use with an 
         # underscore.
         def partial(template, opts=OPTS)
           opts = parse_template_opts(template, opts)
           if opts[:template]
-            template = opts[:template].split('/')
-            template[-1] = "_#{template[-1]}"
-            opts[:template] = template.join('/')
+            opts[:template] = partial_template_name(opts[:template])
           end
           render_template(opts)
         end
+
+        private
+
+        # Prefix the template base filename with an underscore.
+        def partial_template_name(template)
+          segments = template.split('/')
+          segments[-1] = "_#{segments[-1]}"
+          segments.join('/')
+        end
       end
     end
 

data/lib/roda/plugins/placeholder_string_matchers.rb

@@ -27,6 +27,8 @@ class Roda
       end
 
       module RequestMethods
+        private
+
         def _match_string(str)
           if str.index(":")
             consume(self.class.cached_matcher(str){Regexp.escape(str).gsub(/:(\w+)/){|m| _match_symbol_regexp($1)}})

data/lib/roda/plugins/render.rb

@@ -241,12 +241,13 @@ class Roda
       # template file has been modified.  This is an internal class and
       # the API is subject to change at any time.
       class TemplateMtimeWrapper
-        def initialize(template_class, path, *template_args)
+        def initialize(template_class, path, dependencies, *template_args)
           @template_class = template_class
           @path = path
           @template_args = template_args
+          @dependencies = ([path] + Array(dependencies)) if dependencies
 
-          @mtime = (File.mtime(path) if File.file?(path))
+          @mtime = template_last_modified if File.file?(path)
           @template = template_class.new(path, *template_args)
         end
 
@@ -257,17 +258,28 @@ class Roda
           @template.render(*args, &block)
         end
 
+        # Return when the template was last modified.  If the template depends on any
+        # other files, check the modification times of all dependencies and
+        # return the maximum.
+        def template_last_modified
+          if deps = @dependencies
+            deps.map{|f| File.mtime(f)}.max
+          else
+            File.mtime(@path)
+          end
+        end
+
         # If the template file has been updated, return true and update
         # the template object and the modification time. Other return false.
         def modified?
           begin
-            mtime = File.mtime(path = @path)
+            mtime = template_last_modified
           rescue
             # ignore errors
           else
             if mtime != @mtime
               @mtime = mtime
-              @template = @template_class.new(path, *@template_args)
+              @template = @template_class.new(@path, *@template_args)
               return true
             end
           end
@@ -576,7 +588,7 @@ class Roda
                !opts[:inline]
 
             if render_opts[:check_template_mtime] && !opts[:template_block] && !cache
-              template = TemplateMtimeWrapper.new(opts[:template_class], opts[:path], 1, template_opts)
+              template = TemplateMtimeWrapper.new(opts[:template_class], opts[:path], opts[:dependencies], 1, template_opts)
 
               if define_compiled_method
                 method_name = :"_roda_template_#{self.class.object_id}_#{method_cache_key}"

data/lib/roda/plugins/render_each.rb

@@ -26,7 +26,9 @@ class Roda
     #
     # Will render the +foo+ template, but the local variable used inside
     # the template will be +bar+.  You can use <tt>local: nil</tt> to
-    # not set a local variable inside the template.
+    # not set a local variable inside the template. By default, the
+    # local variable name is based on the template name, with any
+    # directories and file extensions removed.
     module RenderEach
       # Load the render plugin before this plugin, since this plugin
       # calls the render method.
@@ -45,11 +47,11 @@ class Roda
         #           set a local variable.  If not set, uses the template name.
         def render_each(enum, template, opts=(no_opts = true; optimized_template = _cached_render_each_template_method(template); OPTS))
           if optimized_template
-            return _optimized_render_each(enum, optimized_template, template.to_s.to_sym, {})
+            return _optimized_render_each(enum, optimized_template, render_each_default_local(template), {})
           elsif opts.has_key?(:local)
             as = opts[:local]
           else
-            as = template.to_s.to_sym
+            as = render_each_default_local(template)
             if no_opts && optimized_template.nil? && (optimized_template = _optimized_render_method_for_locals(template, (locals = {as=>nil})))
               return _optimized_render_each(enum, optimized_template, as, locals)
             end
@@ -77,6 +79,12 @@ class Roda
         
         private
 
+        # The default local variable name to use for the template, if the :local option
+        # is not used when calling render_each.
+        def render_each_default_local(template)
+          File.basename(template.to_s).sub(/\..+\z/, '').to_sym
+        end
+
         if Render::COMPILED_METHOD_SUPPORT
           # If compiled method support is enabled in the render plugin, return the
           # method name to call to render the template.  Return false if not given

data/lib/roda/plugins/symbol_matchers.rb

@@ -6,7 +6,7 @@ class Roda
     # The symbol_matchers plugin allows you do define custom regexps to use
     # for specific symbols.  For example, if you have a route such as:
     #
-    #   r.on :username do
+    #   r.on :username do |username|
     #     # ...
     #   end
     #
@@ -28,7 +28,7 @@ class Roda
     # If the placeholder_string_matchers plugin is loaded, this feature also applies to
     # placeholders in strings, so the following:
     #
-    #   r.on "users/:username" do
+    #   r.on "users/:username" do |username|
     #     # ...
     #   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 = 31
+  RodaMinorVersion = 32
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.31.0
+  version: 3.32.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-15 00:00:00.000000000 Z
+date: 2020-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -207,6 +207,7 @@ extra_rdoc_files:
 - doc/release_notes/3.29.0.txt
 - doc/release_notes/3.30.0.txt
 - doc/release_notes/3.31.0.txt
+- doc/release_notes/3.32.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -239,6 +240,7 @@ files:
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.30.0.txt
 - doc/release_notes/3.31.0.txt
+- doc/release_notes/3.32.0.txt
 - doc/release_notes/3.4.0.txt
 - doc/release_notes/3.5.0.txt
 - doc/release_notes/3.6.0.txt