roda 3.87.0 → 3.88.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bee7ae126ad0e6e8081bba94be0ad60e2a5f7523c483b2441571549b1bd29274
-  data.tar.gz: f5441e96617877d1347f4a5b6e54e5d48713ffc91a8ad3b9282781c0c26ca108
+  metadata.gz: bfe23e68b3616d0513c55ca0d6006639eaa5595c36e48445e3a4b961f17dc483
+  data.tar.gz: 110d2f273b1b2eee5d0717d7238c3c131d7dd9fd2f7eb5a7ff0b575ce0256af0
 SHA512:
-  metadata.gz: 141408b4d85e7467c0b753c05180201b1a63a3096f713241b94d379bad8d65224d96f1d60978ac336a7d8b9fb3093f35c1d2887d422276cf255cd1c64c557719
-  data.tar.gz: a64207e6d0a46d22c59bc0acc9d56ed43f4dbc75a9d22737908097564a2e4e801f3c19fd3bf95a28722dbf4a828d9930146dd088e421847709948d3a8f2cf24b
+  metadata.gz: 2c60bdca82724f3f1f468ca408e6d58a7fb61bb49e5819835afdb59743b82a8f1ad77e98775f8ce720bcc4aff4d72ae2e3526419cba509d60588eefd585aedba
+  data.tar.gz: 223ed6296acb9829902050161f88356e4bd6d2e5da5dc06e43175b4a59cd38c312a63c79cd93b5f2c648d7bf25e84f66a1ab02c72b603b42866ad434851350d1

data/lib/roda/plugins/head.rb

@@ -45,7 +45,7 @@ class Roda
         end
 
         # yield nothing
-        def each
+        def each(&_)
         end
 
         # this should be called by the Rack server

data/lib/roda/plugins/json_parser.rb

@@ -53,27 +53,28 @@ class Roda
         # parse the request body as JSON.  Ignore an empty request body.
         def POST
           env = @env
-          if post_params = (env["roda.json_params"] || env["rack.request.form_hash"])
-            post_params
-          elsif (input = env["rack.input"]) && content_type =~ /json/
-            str = _read_json_input(input)
-            return super if str.empty?
-            begin
-              json_params = parse_json(str)
-            rescue
-              roda_class.opts[:json_parser_error_handler].call(self)
-            end
+          if post_params = env["roda.json_params"]
+            return post_params
+          end
+
+          unless (input = env["rack.input"]) && (content_type = self.content_type) && content_type.include?('json')
+            return super
+          end
+
+          str = _read_json_input(input)
+          return super if str.empty?
+          begin
+            json_params = parse_json(str)
+          rescue
+            roda_class.opts[:json_parser_error_handler].call(self)
+          end
 
-            wrap = roda_class.opts[:json_parser_wrap]
-            if wrap == :always || (wrap == :unless_hash && !json_params.is_a?(Hash))
-              json_params = {"_json"=>json_params}
-            end
-            env["roda.json_params"] = json_params
-            env["rack.request.form_input"] = input
-            json_params
-          else
-            super
+          wrap = roda_class.opts[:json_parser_wrap]
+          if wrap == :always || (wrap == :unless_hash && !json_params.is_a?(Hash))
+            json_params = {"_json"=>json_params}
           end
+          env["roda.json_params"] = json_params
+          json_params
         end
 
         private

data/lib/roda/plugins/render.rb

@@ -118,6 +118,45 @@ class Roda
     # have either +:template+, +:inline+, +:path+, or +:content+ (for +view+) as
     # one of the keys.
     #
+    # = Fixed Locals in Templates
+    #
+    # By default, you can pass any local variables to any templates.  A separate
+    # template method is compiled for each combination of locals.  This causes
+    # multiple issues:
+    # 
+    # * It is inefficient, especially for large templates that are called with
+    #   many combinations of locals.
+    # * It hides issues if unused local variable names are passed to the template
+    # * It does not support default values for local variables
+    # * It does not support required local variables
+    # * It does not support cases where you want to pass values via a keyword splat
+    # * It does not support named blocks
+    #
+    # If you are using Tilt 2.6+, you can used fixed locals in templates, by
+    # passing the appropriate options in :template_opts.  For example, if you
+    # are using ERB templates, the recommended way to use the render plugin is to
+    # use the +:extract_fixed_locals+ and +:default_fixed_locals+ template options:
+    #
+    #   plugin :render, template_opts: {extract_fixed_locals: true, default_fixed_locals: '()'}
+    #
+    # This will default templates to not allowing any local variables to be passed.
+    # If the template requires local variables, you can specify them using a magic
+    # comment in the template, such as:
+    # 
+    #   <%# locals(required_local:, optional_local: nil) %>
+    #
+    # The magic comment is used as method parameters when defining the compiled template
+    # method.
+    #
+    # For better debugging of issues with invalid keywords being passed to templates that
+    # have not been updated to support fixed locals, it can be helpful to set
+    # +:default_fixed_locals+ to use a single optional keyword argument
+    # <tt>'(_no_kw: nil)'</tt>.  This makes the error message show which keywords
+    # were passed, instead of showing that the takes no arguments (if you use <tt>'()'</tt>),
+    # or that no keywords are accepted (if you pass <tt>(**nil)</tt>).
+    #
+    # See Tilt's documentation for more information regarding fixed locals.
+    #
     # = Speeding Up Template Rendering
     #
     # The render/view method calls are optimized for usage with a single symbol/string
@@ -131,6 +170,21 @@ class Roda
     # the hash, making sure the +:cache_key+ is unique to the template you are
     # rendering.
     #
+    # = Recommended +template_opts+
+    #
+    # Here are the recommended values of :template_opts for new applications (a couple
+    # are Erubi-specific and can be ignored if you are using other templates engines):
+    #
+    #   plugin :render, template_opts: {
+    #       scope_class: self,          # Always uses current class as scope class for compiled templates
+    #       freeze: true,               # Freeze string literals in templates
+    #       extract_fixed_locals: true, # Support fixed locals in templates
+    #       default_fixed_locals: '()', # Default to templates not supporting local variables
+    #       escape: true,               # For Erubi templates, escapes <%= by default (use <%== for unescaped
+    #       chain_appends: true,        # For Erubi templates, improves performance
+    #       skip_compiled_encoding_detection: true, # Unless you need encodings explicitly specified
+    #     }
+    #
     # = Accepting Template Blocks in Methods
     #
     # If you are used to Rails, you may be surprised that this type of template code
@@ -228,6 +282,19 @@ class Roda
         ([1, -2].include?(((compiled_method_arity = Tilt::Template.instance_method(:compiled_method).arity) rescue false)))
       NO_CACHE = {:cache=>false}.freeze
       COMPILED_METHOD_SUPPORT = RUBY_VERSION >= '2.3' && tilt_compiled_method_support && ENV['RODA_RENDER_COMPILED_METHOD_SUPPORT'] != 'no'
+      FIXED_LOCALS_COMPILED_METHOD_SUPPORT = COMPILED_METHOD_SUPPORT && Tilt::Template.method_defined?(:fixed_locals?)
+
+      if FIXED_LOCALS_COMPILED_METHOD_SUPPORT
+        def self.tilt_template_fixed_locals?(template)
+          template.fixed_locals?
+        end
+      # :nocov:
+      else
+        def self.tilt_template_fixed_locals?(template)
+          false
+        end
+      end
+      # :nocov:
 
       if compiled_method_arity == -2
         def self.tilt_template_compiled_method(template, locals_keys, scope_class)
@@ -385,6 +452,11 @@ class Roda
         end
 
         if COMPILED_METHOD_SUPPORT
+          # Whether the underlying template uses fixed locals.
+          def fixed_locals?
+            Render.tilt_template_fixed_locals?(@template)
+          end
+
           # Compile a method in the given module with the given name that will
           # call the compiled template method, updating the compiled template method
           def define_compiled_method(roda_class, method_name, locals_keys=EMPTY_ARRAY)
@@ -403,6 +475,15 @@ class Roda
             method_name
           end
 
+          # Returns an appropriate value for the template method cache.
+          def define_compiled_method_cache_value(roda_class, method_name, locals_keys=EMPTY_ARRAY)
+            if compiled_method = define_compiled_method(roda_class, method_name, locals_keys)
+              [compiled_method, false].freeze
+            else
+              compiled_method
+            end
+          end
+
           private
 
           # Return the compiled method for the current template object.
@@ -422,7 +503,7 @@ class Roda
                 mod.send(:private, method_name)
               end
 
-              send(method_name, locals, &block)
+              _call_optimized_template_method([method_name, Render.tilt_template_fixed_locals?(template)], locals, &block)
             end
           end
         end
@@ -489,17 +570,17 @@ class Roda
         def _freeze_layout_method
           if render_opts[:layout]
             instance = allocate
+            # This needs to be called even if COMPILED_METHOD_SUPPORT is not set,
+            # in order for the precompile_templates plugin to work correctly.
             instance.send(:retrieve_template, instance.send(:view_layout_opts, OPTS))
 
-            if COMPILED_METHOD_SUPPORT
-              if (layout_template = render_opts[:optimize_layout]) && !opts[:render][:optimized_layout_method_created]
+            if COMPILED_METHOD_SUPPORT && (layout_template = render_opts[:optimize_layout]) && !opts[:render][:optimized_layout_method_created]
                 instance.send(:retrieve_template, :template=>layout_template, :cache_key=>nil, :template_method_cache_key => :_roda_layout)
                 layout_method = opts[:render][:template_method_cache][:_roda_layout]
                 define_method(:_layout_method){layout_method}
                 private :_layout_method
                 alias_method(:_layout_method, :_layout_method)
                 opts[:render] = opts[:render].merge(:optimized_layout_method_created=>true)
-              end
             end
           end
         end
@@ -509,9 +590,9 @@ class Roda
         # Render the given template. See Render for details.
         def render(template, opts = (no_opts = true; optimized_template = _cached_template_method(template); OPTS), &block)
           if optimized_template
-            send(optimized_template, OPTS, &block)
+            _call_optimized_template_method(optimized_template, OPTS, &block)
           elsif !no_opts && opts.length == 1 && (locals = opts[:locals]) && (optimized_template = _optimized_render_method_for_locals(template, locals))
-            send(optimized_template, locals, &block)
+            _call_optimized_template_method(optimized_template, locals, &block)
           else
             opts = render_template_opts(template, opts)
             retrieve_template(opts).render((opts[:scope]||self), (opts[:locals]||OPTS), &block)
@@ -534,7 +615,7 @@ class Roda
             # and use it if so.  This way avoids the extra conditional and local variable
             # assignments in the next section.
             if layout_method = _layout_method
-              return send(layout_method, OPTS){content}
+              return _call_optimized_template_method(layout_method, OPTS){content}
             end
 
             # If we have an optimized template method but no optimized layout method, create the
@@ -543,7 +624,7 @@ class Roda
             if layout_template = self.class.opts[:render][:optimize_layout]
               retrieve_template(:template=>layout_template, :cache_key=>nil, :template_method_cache_key => :_roda_layout)
               if layout_method = _layout_method
-                return send(layout_method, OPTS){content}
+                return _call_optimized_template_method(layout_method, OPTS){content}
               end
             end
           else
@@ -594,37 +675,43 @@ class Roda
           def _optimized_render_method_for_locals(template, locals)
             return unless method_cache = render_opts[:template_method_cache]
 
-            locals_keys = locals.keys.sort
-            key = [:_render_locals, template, locals_keys]
-
-            optimized_template = case template
+            case template
             when String, Symbol
-              _cached_template_method_lookup(method_cache, key)
+              key = [:_render_locals, template]
+              if optimized_template = _cached_template_method_lookup(method_cache, key)
+                # Fixed locals case
+                return optimized_template
+              end
+
+              locals_keys = locals.keys.sort
+              key << locals_keys
+              if optimized_template = _cached_template_method_lookup(method_cache, key)
+                # Regular locals case
+                return optimized_template
+              end
             else
               return
             end
 
-            case optimized_template
-            when Symbol
-              optimized_template
-            else
-              if method_cache_key = _cached_template_method_key(key)
-                template_obj = retrieve_template(render_template_opts(template, NO_CACHE))
-                method_name = :"_roda_template_locals_#{self.class.object_id}_#{method_cache_key}"
+            if method_cache_key = _cached_template_method_key(key)
+              template_obj = retrieve_template(render_template_opts(template, NO_CACHE))
+              key.pop if fixed_locals = Render.tilt_template_fixed_locals?(template_obj)
+              key.freeze
+              method_cache_key.freeze
+              method_name = :"_roda_template_locals_#{self.class.object_id}_#{method_cache_key}"
 
-                method_cache[method_cache_key] = case template_obj
-                when Render::TemplateMtimeWrapper
-                  template_obj.define_compiled_method(self.class, method_name, locals_keys)
+              method_cache[method_cache_key] = case template_obj
+              when Render::TemplateMtimeWrapper
+                template_obj.define_compiled_method_cache_value(self.class, method_name, locals_keys)
+              else
+                begin
+                  unbound_method = Render.tilt_template_compiled_method(template_obj, locals_keys, self.class)
+                rescue ::NotImplementedError
+                  false
                 else
-                  begin
-                    unbound_method = Render.tilt_template_compiled_method(template_obj, locals_keys, self.class)
-                  rescue ::NotImplementedError
-                    false
-                  else
-                    self.class::RodaCompiledTemplates.send(:define_method, method_name, unbound_method)
-                    self.class::RodaCompiledTemplates.send(:private, method_name)
-                    method_name
-                  end
+                  self.class::RodaCompiledTemplates.send(:define_method, method_name, unbound_method)
+                  self.class::RodaCompiledTemplates.send(:private, method_name)
+                  [method_name, fixed_locals].freeze
                 end
               end
             end
@@ -634,11 +721,47 @@ class Roda
           # a single argument is passed to view.
           def _optimized_view_content(template)
             if optimized_template = _cached_template_method(template)
-              send(optimized_template, OPTS)
+              _call_optimized_template_method(optimized_template, OPTS)
             elsif template.is_a?(Hash) && template.length == 1
               template[:content]
             end
           end
+
+          if RUBY_VERSION >= '3'
+            class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+              def _call_optimized_template_method((meth, fixed_locals), locals, &block)
+                if fixed_locals
+                  send(meth, **locals, &block)
+                else
+                  send(meth, locals, &block)
+                end
+              end
+            RUBY
+          # :nocov:
+          elsif RUBY_VERSION >= '2'
+            class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+              def _call_optimized_template_method((meth, fixed_locals), locals, &block)
+                if fixed_locals
+                  if locals.empty?
+                    send(meth, &block)
+                  else
+                    send(meth, **locals, &block)
+                  end
+                else
+                  send(meth, locals, &block)
+                end
+              end
+            RUBY
+          else
+            # Call the optimized template method.  This is designed to be used with the
+            # method cache, which caches the method name and whether the method uses
+            # fixed locals.  Methods with fixed locals need to be called with a keyword
+            # splat.
+            def _call_optimized_template_method((meth, fixed_locals), locals, &block)
+              send(meth, locals, &block)
+            end
+          end
+          # :nocov:
         else
           def _cached_template_method(_)
             nil
@@ -648,10 +771,6 @@ class Roda
             nil
           end
 
-          def _layout_method
-            nil
-          end
-
           def _optimized_render_method_for_locals(_, _)
             nil
           end
@@ -661,7 +780,6 @@ class Roda
           end
         end
 
-
         # Convert template options to single hash when rendering templates using render.
         def render_template_opts(template, opts)
           parse_template_opts(template, opts)
@@ -772,7 +890,7 @@ class Roda
 
               if define_compiled_method
                 method_name = :"_roda_template_#{self.class.object_id}_#{method_cache_key}"
-                method_cache[method_cache_key] = template.define_compiled_method(self.class, method_name)
+                method_cache[method_cache_key] = template.define_compiled_method_cache_value(self.class, method_name)
               end
             else
               template = self.class.create_template(opts, template_opts)
@@ -786,7 +904,7 @@ class Roda
                   method_name = :"_roda_template_#{self.class.object_id}_#{method_cache_key}"
                   self.class::RodaCompiledTemplates.send(:define_method, method_name, unbound_method)
                   self.class::RodaCompiledTemplates.send(:private, method_name)
-                  method_cache[method_cache_key] = method_name
+                  method_cache[method_cache_key] = [method_name, Render.tilt_template_fixed_locals?(template)].freeze
                 end
               end
             end

data/lib/roda/plugins/render_coverage.rb

@@ -50,17 +50,36 @@ class Roda
         # Set a compiled path on the created template, if the path for
         # the template is in one of the allowed_views.
         def create_template(opts, template_opts)
-          template = super
-          return template if opts[:template_block]
+          return super if opts[:template_block]
 
           path = File.expand_path(opts[:path])
+          compiled_path = nil
           (self.opts[:render_coverage_strip_paths] || render_opts[:allowed_paths]).each do |dir|
             if path.start_with?(dir + '/')
-              template.compiled_path = File.join(self.opts[:render_coverage_dir], path[dir.length+1, 10000000].gsub('/', '-'))
+              compiled_path = File.join(self.opts[:render_coverage_dir], path[dir.length+1, 10000000].gsub('/', '-'))
               break
             end
           end
 
+          # For Tilt 2.6+, when using :scope_class and fixed locals, must provide
+          # compiled path as option, since compilation happens during initalization
+          # in that case. This option should be ignored if the template does not
+          # support it, but some template class may break if the option is not
+          # handled, so for compatibility, only set the method if Tilt::Template
+          # will handle it.
+          if compiled_path && Tilt::Template.method_defined?(:fixed_locals?)
+            template_opts = template_opts.dup
+            template_opts[:compiled_path] = compiled_path
+            compiled_path = nil
+          end
+
+          template = super
+
+          # Set compiled path for template when using older tilt versions.
+          # :nocov:
+          template.compiled_path = compiled_path if compiled_path
+          # :nocov:
+
           template
         end
       end

data/lib/roda/plugins/render_each.rb

@@ -105,7 +105,7 @@ class Roda
           def _optimized_render_each(enum, optimized_template, as, locals)
             enum.map do |v|
               locals[as] = v
-              send(optimized_template, locals)
+              _call_optimized_template_method(optimized_template, locals)
             end.join
           end
         else

data/lib/roda/response.rb

@@ -46,8 +46,6 @@ class Roda
 
       # Instance methods for RodaResponse
       module ResponseMethods
-        DEFAULT_HEADERS = {RodaResponseHeaders::CONTENT_TYPE => "text/html".freeze}.freeze
-
         # The body for the current response.
         attr_reader :body
 
@@ -179,11 +177,15 @@ class Roda
         private
 
         if defined?(Rack::Headers) && Rack::Headers.is_a?(Class)
+          DEFAULT_HEADERS = Rack::Headers[{RodaResponseHeaders::CONTENT_TYPE => "text/html".freeze}].freeze
+
           # Use Rack::Headers for headers by default on Rack 3
           def _initialize_headers
             Rack::Headers.new
           end
         else
+          DEFAULT_HEADERS = {RodaResponseHeaders::CONTENT_TYPE => "text/html".freeze}.freeze
+
           # Use plain hash for headers by default on Rack 1-2
           def _initialize_headers
             {}

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 = 87
+  RodaMinorVersion = 88
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.87.0
+  version: 3.88.0
 platform: ruby
 authors:
 - Jeremy Evans
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2025-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -150,7 +149,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - code@jeremyevans.net
 executables: []
@@ -313,7 +311,6 @@ metadata:
   documentation_uri: https://roda.jeremyevans.net/documentation.html
   mailing_list_uri: https://github.com/jeremyevans/roda/discussions
   source_code_uri: https://github.com/jeremyevans/roda
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -328,8 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Routing tree web toolkit
 test_files: []