roda 3.105.0 → 3.106.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f6f16557b167cdca71f0005ed7b4e40c4465b6400874e05a8ece95e7dad7b68
-  data.tar.gz: decd44332e836e46bc4bb2a6f93e7d40730fbf9f016c83b8a6ae99169c74efd3
+  metadata.gz: 90404574f8af3e952feb444cabe5bb01430e2d7c3658daee9f22f0c22e25d5f6
+  data.tar.gz: 347ba47cf4c3b9e280848ba717a1a4a9f57f8ac0712d2aaa8e5942020c22cb29
 SHA512:
-  metadata.gz: 768134a23ee25d9f9d41641b1bf3dd5d499624b05adf9261f90300407a5dcd55d1535f080547d573b11e19d161c4563eb8538d998ee627d11329e6b59223db88
-  data.tar.gz: 00aa1dfbbc81b5754a824fa668324886338f4a4827d27a2de6cfff5b6318c8e4aba1c8c93afb8e96f80b214b4ba6b96917b3df77108f1eaa60153fa5fc5add5e
+  metadata.gz: 00e03ccebd8d48c4c1576ae0da2929d85a30430114b9a292bd8b9029fba31b4a7fa10767d7fb59a643c4280fb659e9afa90dacde27c7a5bdbc98fc5ee1df40a6
+  data.tar.gz: 7867f8da5bad9db4102f09fc692158feee7605c8021b5d01bb07ebfe57d3a82ca0b18d7fc1341d6e5cdf9ff534736a6c9c3ce2420b2078abe96209ad423bce92

data/lib/roda/plugins/branch_locals.rb

@@ -21,6 +21,8 @@ class Roda
     # have higher precedence than the render_locals plugin options, but lower precedence
     # than options you directly pass to the view/render methods.
     module BranchLocals
+      SCOPE_INSTANCE_VARIABLES = [:@_layout_locals, :@_view_locals].freeze
+
       # Load the render_locals plugin before this plugin, since this plugin
       # works by overriding methods in the render_locals plugin.
       def self.load_dependencies(app)

data/lib/roda/plugins/chunked.rb

@@ -148,6 +148,8 @@ class Roda
     # method is not called until template rendering, the flash may not be
     # rotated.
     module Chunked
+      SCOPE_INSTANCE_VARIABLES = [:@_chunked, :@_each_chunk_args, :@_delays, :@_flusher].freeze
+
       # Depend on the render plugin
       def self.load_dependencies(app, opts=OPTS)
         app.plugin :render
@@ -215,7 +217,7 @@ class Roda
         # If chunking by default, call chunked if it hasn't yet been
         # called and chunking is not specifically disabled.
         def view(*a)
-          if opts[:chunk_by_default] && !defined?(@_chunked) && !defined?(yield)
+          if opts[:chunk_by_default] && @_chunked != false && !defined?(yield)
             chunked(*a)
           else
             super
@@ -225,7 +227,7 @@ class Roda
         # Render a response to the user in chunks.  See Chunked for
         # an overview.  If a block is given, it is passed to #delay.
         def chunked(template, opts=OPTS, &block)
-          unless defined?(@_chunked)
+          if @_chunked.nil?
             @_chunked = !self.opts[:force_chunked_encoding] || @_request.http_version == "HTTP/1.1" 
           end
 

data/lib/roda/plugins/common_logger.rb

@@ -20,6 +20,8 @@ class Roda
     #   plugin :common_logger, Logger.new('filename')
     #   plugin :common_logger, Logger.new('filename'), method: :debug
     module CommonLogger
+      SCOPE_INSTANCE_VARIABLES = [:@_request_timer].freeze
+
       MUTATE_LINE = RUBY_VERSION < '2.3' || RUBY_VERSION >= '3'
       private_constant :MUTATE_LINE
 

data/lib/roda/plugins/content_for.rb

@@ -55,6 +55,8 @@ class Roda
     #
     #   plugin :content_for, append: false
     module ContentFor
+      SCOPE_INSTANCE_VARIABLES = [:@_content_for].freeze
+
       # Depend on the capture_erb plugin, since it uses capture_erb
       # to capture the content.
       def self.load_dependencies(app, _opts = OPTS)

data/lib/roda/plugins/content_security_policy.rb

@@ -111,6 +111,8 @@ class Roda
     # is given.  Also, there is a +report_only?+ method for returning whether report only
     # mode is enabled.
     module ContentSecurityPolicy
+      RESPONSE_INSTANCE_VARIABLES = [:@content_security_policy, :@skip_content_security_policy].freeze
+
       # Represents a content security policy.
       class Policy
         '
@@ -192,6 +194,8 @@ class Roda
         # Clear all settings, useful to remove any inherited settings.
         def clear
           @opts = {}
+          @report_only = nil
+          @header_value = nil
         end
 
         # Do not allow future modifications to any settings.

data/lib/roda/plugins/flash.rb

@@ -36,6 +36,8 @@ class Roda
     #     flash['a'] # = >'b'
     #   end
     module Flash
+      SCOPE_INSTANCE_VARIABLES = [:@_flash].freeze
+
       # Simple flash hash, where assiging to the hash updates the flash
       # used in the following request.
       class FlashHash < DelegateClass(Hash)

data/lib/roda/plugins/host_routing.rb

@@ -71,6 +71,8 @@ class Roda
     # This plugin uses the host method on the request to get the hostname (this method
     # is defined by Rack).
     module HostRouting
+      REQUEST_INSTANCE_VARIABLES = [:@_host_routing_host].freeze
+
       # Setup the host routing support.  The block yields an object used to
       # configure the plugin.  Options:
       #
@@ -110,6 +112,8 @@ class Roda
         def initialize
           @hosts = []
           @host_hash = {}
+          @default_host = nil
+          @default_block = nil
         end
 
         # Run the DSL for the given block.

data/lib/roda/plugins/indifferent_params.rb

@@ -39,6 +39,8 @@ class Roda
     # it affects all rack applications instead of just the Roda app that
     # you load the plugin into.
     module IndifferentParams
+      SCOPE_INSTANCE_VARIABLES = [:@_params].freeze
+
       INDIFFERENT_PROC = lambda{|h,k| h[k.to_s] if k.is_a?(Symbol)}
 
       if Rack.release > '2'

data/lib/roda/plugins/mailer.rb

@@ -127,6 +127,8 @@ class Roda
     # Roda application if you want your helper methods to automatically be
     # available in your email views.
     module Mailer
+      RESPONSE_INSTANCE_VARIABLES = [:@mail, :@mail_attachments].freeze
+
       # Error raised when the using the mail class method, but the routing
       # tree doesn't return the mail object. 
       class Error < ::Roda::RodaError; end

data/lib/roda/plugins/not_allowed.rb

@@ -68,6 +68,8 @@ class Roda
     #
     # This plugin depends on the all_verbs plugin.
     module NotAllowed
+      REQUEST_INSTANCE_VARIABLES = [:@_is_verbs].freeze
+
       # Depend on the all_verbs plugin, as this plugin overrides methods
       # defined by it and calls super.
       def self.load_dependencies(app)

data/lib/roda/plugins/params_capturing.rb

@@ -55,6 +55,8 @@ class Roda
     # the symbol_matchers plugin with custom symbol matching and are using
     # symbols that capture multiple values or no values.
     module ParamsCapturing
+      REQUEST_INSTANCE_VARIABLES = [:@_params_captures].freeze
+
       module RequestMethods
         # Lazily initialize captures entry when params is called.
         def params

data/lib/roda/plugins/permissions_policy.rb

@@ -104,6 +104,8 @@ class Roda
     # setting a policy.  This is faster than calling +permissions_policy.clear+, since
     # it does not duplicate the default policy.
     module PermissionsPolicy
+      RESPONSE_INSTANCE_VARIABLES = [:@permissions_policy, :@skip_permissions_policy].freeze
+
       SUPPORTED_SETTINGS = %w'
       accelerometer
       ambient-light-sensor
@@ -180,6 +182,8 @@ class Roda
         # Clear all settings, useful to remove any inherited settings.
         def clear
           @opts = {}
+          @report_only = nil
+          @header_value = nil
         end
 
         # Do not allow future modifications to any settings.

data/lib/roda/plugins/relative_path.rb

@@ -31,6 +31,8 @@ class Roda
     # This plugin is mostly designed for applications using Roda as a static
     # site generator, where the generated site can be hosted at any subpath.
     module RelativePath
+      SCOPE_INSTANCE_VARIABLES = [:@_relative_prefix].freeze
+
       module InstanceMethods
         # Return a relative path for the absolute path based on the current path
         # of the request by adding the appropriate prefix.

data/lib/roda/plugins/request_headers.rb

@@ -25,6 +25,8 @@ class Roda
     #
     #   plugin :request_headers
     module RequestHeaders
+      REQUEST_INSTANCE_VARIABLES = [:@request_headers].freeze
+
       module RequestMethods
         # Provide access to the request headers while normalizing indexes.
         def headers

data/lib/roda/plugins/response_request.rb

@@ -10,6 +10,13 @@ class Roda
     #
     #   plugin :response_request
     module ResponseRequest
+      # This isn't set because it breaks usage with the error_handler/class_level_routing
+      # plugins and the shape_friendly plugin, due to those calling RodaResponse#initialize,
+      # which would reset @request to nil. It isn't strictly necessary to set this for
+      # shape friendliness, as the Roda#initialize sets it directly after creating the
+      # RodaRequest, so in normal use, the instance variable will already be set.
+      # RESPONSE_INSTANCE_VARIABLES = [:@request].freeze
+
       module InstanceMethods
         # Set the response's request to the current request.
         def initialize(env)

data/lib/roda/plugins/shape_friendly.rb

@@ -0,0 +1,232 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The shape_friendly plugin makes the scope, request, and response objects
+    # used by Roda friendly to object shapes, which can result in better
+    # performance on modern versions of Ruby, especially when the JIT compiler
+    # is enabled. All plugins shipped with Roda integrate with this plugin.
+    #
+    # In order for this behavior to be beneficial for your application, you
+    # need to either avoid setting instance variables inside your routing
+    # tree, or you need to register each instance variable used, to ensure
+    # that all instances have the same shape.
+    #
+    # If you want to avoid using instance variables in your routing tree, you
+    # can switch to using local variables. If using the render plugin, you can
+    # pass data from your routing tree to your views using the +:locals+ option.
+    # When passing data from your routing tree to other routing trees, such as
+    # when using the hash_branches plugin, you can use the shared_vars plugin,
+    # which stores the data in the Rack environment.
+    #
+    # To register instance variables set in your applications routing tree,
+    # use a +:scope_instance_variables+ option when loading the plugin,
+    # listing the instance variable symbols you are setting in the route
+    # block scope:
+    #
+    #   class MyApp < Roda
+    #     plugin :shape_friendly, scope_instance_variables: [:@var1, @:var2]
+    #
+    #     route do |r|
+    #       r.root do
+    #         @var1 = "a"
+    #         @var1.inspect
+    #       end
+    #
+    #       @var2 = "b"
+    #       @var2.inspect
+    #     end
+    #   end
+    #
+    # When developing external plugins, you can set one of three constants in
+    # the plugin module to integrate with this plugin to support shape friendly
+    # behavior:
+    #
+    # * +SCOPE_INSTANCE_VARIABLES+: For instance variables set in +InstanceMethods+.
+    # * +REQUEST_INSTANCE_VARIABLES+: For instance variables set in +RequestMethods+.
+    # * +RESPONSE_INSTANCE_VARIABLES+: For instance variables set in +ResponseMethods+.
+    #
+    # These constants are set in the plugin module, not in the plugin's
+    # +InstanceMethods+, +RequestMethods+, or +ResponseMethods+ modules, to
+    # avoid pollution of the related namespaces in the class loading the plugin.
+    module ShapeFriendly
+      # This is used by the base support and not by this plugin.
+      RESPONSE_INSTANCE_VARIABLES = [:@status].freeze
+
+      # Set the Roda application to create the private
+      # _initialize_nil_instance_variables for the plugin to use.
+      def self.configure(app, opts=OPTS)
+        if scope_ivs = opts[:scope_instance_variables]
+          app.opts[:shape_friendly_scope_instance_variables] = Array(scope_ivs).dup.freeze
+        end
+
+        app.instance_exec do
+          def_initialize_nil_instance_variables(app, :SCOPE_INSTANCE_VARIABLES)
+          def_initialize_nil_instance_variables(app::RodaRequest, :REQUEST_INSTANCE_VARIABLES)
+          def_initialize_nil_instance_variables(app::RodaResponse, :RESPONSE_INSTANCE_VARIABLES)
+
+          # Avoid overhead of super call if possible
+          include(instance_method(:initialize).owner == Roda::RodaPlugins::Base::InstanceMethods ? OptimizedInstanceMethods : UnoptimizedInstanceMethods)
+          app::RodaRequest.send(:include, app::RodaRequest.instance_method(:initialize).owner == Roda::RodaPlugins::Base::RequestMethods ? OptimizedRequestMethods : UnoptimizedRequestMethods)
+          app::RodaResponse.send(:include, app::RodaResponse.instance_method(:initialize).owner == Roda::RodaPlugins::Base::ResponseMethods ? OptimizedResponseMethods : UnoptimizedResponseMethods)
+        end
+      end
+
+      module ClassMethods
+        # Automatically refresh the instance variables used if the plugin
+        # sets instance variables.
+        def plugin(plugin, *args, &block)
+          super
+          plugin = RodaPlugins.load_plugin(plugin) if plugin.is_a?(Symbol)
+          [
+            [self, :SCOPE_INSTANCE_VARIABLES],
+            [self::RodaRequest, :REQUEST_INSTANCE_VARIABLES],
+            [self::RodaResponse, :RESPONSE_INSTANCE_VARIABLES],
+          ].each do |klass, ivs_const|
+            if plugin.const_defined?(ivs_const)
+              def_initialize_nil_instance_variables(klass, ivs_const)
+            end
+          end
+          nil
+        end
+        # :nocov:
+        ruby2_keywords(:plugin) if respond_to?(:ruby2_keywords, true)
+        # :nocov:
+
+        private
+
+        # If there are any intance variables configured in one of the plugins
+        # (looking for the +const+ constant in the plugin), override the
+        # private _initialize_nil_instance_variables method for the class,
+        # and have it initialize each instance variable to nil. 
+        def def_initialize_nil_instance_variables(klass, const)
+          ivs = []
+
+          plugins.each do |mod|
+            ivs.concat(mod.const_get(const)) if mod.const_defined?(const)
+          end
+
+          if const == :SCOPE_INSTANCE_VARIABLES && (scope_ivs = opts[:shape_friendly_scope_instance_variables])
+            ivs.concat(scope_ivs)
+          end
+
+          ivs.each do |iv|
+            unless /\A@[a-z_][a-z0-9_]*\z/.match(iv)
+              raise RodaError, "invalid scope instance variable used"
+            end
+          end
+
+          unless ivs.empty?
+            ivs.uniq!
+
+            klass.class_eval(<<-RUBY, __FILE__, __LINE__+1)
+              def _initialize_nil_instance_variables
+                #{ivs.reverse.join(" = ")} = nil
+              end
+              private :_initialize_nil_instance_variables
+              alias _initialize_nil_instance_variables _initialize_nil_instance_variables
+            RUBY
+            nil
+          end
+        end
+      end
+
+      # :nocov:
+      if RUBY_VERSION >= '4.0'
+      # :nocov:
+        module InstanceMethods
+          private
+
+          def instance_variables_to_inspect
+            instance_variables.reject{|v| instance_variable_get(v).nil?}
+          end
+        end
+      end
+
+      module OptimizedInstanceMethods
+        # Initialize configured instance variables to nil.
+        def initialize(env)
+          _initialize_nil_instance_variables
+          klass = self.class
+          @_request = klass::RodaRequest.new(self, env)
+          @_response = klass::RodaResponse.new
+        end
+
+        private
+
+        def _initialize_nil_instance_variables
+          nil
+        end
+      end
+
+      module UnoptimizedInstanceMethods
+        # Initialize configured instance variables to nil.
+        def initialize(env)
+          _initialize_nil_instance_variables
+          super
+        end
+
+        private
+
+        def _initialize_nil_instance_variables
+          nil
+        end
+      end
+
+      module OptimizedRequestMethods
+        # Initialize configured instance variables to nil.
+        def initialize(scope, env)
+          _initialize_nil_instance_variables
+          @scope = scope
+          @captures = []
+          @remaining_path = _remaining_path(env)
+          @env = env
+        end
+
+        private
+
+        def _initialize_nil_instance_variables
+          nil
+        end
+      end
+
+      module UnoptimizedRequestMethods
+        # Initialize configured instance variables to nil.
+        def initialize(scope, env)
+          _initialize_nil_instance_variables
+          super
+        end
+
+        private
+
+        def _initialize_nil_instance_variables
+          nil
+        end
+      end
+
+      module OptimizedResponseMethods
+        def initialize
+          _initialize_nil_instance_variables
+          @headers = _initialize_headers
+          @body    = []
+          @length  = 0
+        end
+      end
+
+      module UnoptimizedResponseMethods
+        # Initialize configured instance variables to nil.
+        def initialize
+          _initialize_nil_instance_variables
+          super
+        end
+      end
+
+      # For response methods, there is no default definition for
+      # _initialize_nil_instance_variables, as the plugin will always
+      # define a method in the class it is loaded into.
+    end
+
+    register_plugin(:shape_friendly, ShapeFriendly)
+  end
+end

data/lib/roda/plugins/sinatra_helpers.rb

@@ -213,6 +213,7 @@ class Roda
         # called until the body is needed.
         def initialize(&block)
           @block = block
+          @value = nil
         end
 
         # If the body is a String, yield it, otherwise yield each string

data/lib/roda/plugins/type_routing.rb

@@ -89,6 +89,8 @@ class Roda
     # :use_header :: Whether to take the +Accept+ header into account.
     #                Default is +true+.
     module TypeRouting
+      REQUEST_INSTANCE_VARIABLES = [:@requested_type, :@type_routing_extension].freeze
+
       CONFIGURATION = {
         :mimes => {
           'text/json' => :json,
@@ -158,7 +160,7 @@ class Roda
 
         # Returns the data type the client requests.
         def requested_type
-          return @requested_type if defined?(@requested_type)
+          return @requested_type if @requested_type
 
           opts = @scope.opts[:type_routing]
           @requested_type = accept_response_type if opts[:use_header]
@@ -168,7 +170,7 @@ class Roda
         # Append the type routing extension back to the path if it was
         # removed before routing.
         def real_remaining_path
-          if defined?(@type_routing_extension)
+          if @type_routing_extension
             "#{super}.#{@type_routing_extension}"
           else
             super

data/lib/roda/plugins/typecast_params.rb

@@ -307,6 +307,8 @@ class Roda
     # By design, typecast_params only deals with string keys, it is not possible to use
     # symbol keys as arguments to the conversion methods and have them converted.
     module TypecastParams
+      SCOPE_INSTANCE_VARIABLES = [:@_typecast_params, :@_typecast_query_params, :@_typecast_body_params].freeze
+
       # Sentinal value for whether to raise exception during #process
       CHECK_NIL = Object.new.freeze
 

data/lib/roda/plugins/view_options.rb

@@ -80,6 +80,8 @@ class Roda
     #     end
     #   end
     module ViewOptions
+      SCOPE_INSTANCE_VARIABLES = [:@_view_subdir, :@_view_options, :@_layout_options].freeze
+
       # Load the render plugin before this plugin, since this plugin
       # works by overriding methods in the render plugin.
       def self.load_dependencies(app)

data/lib/roda/session_middleware.rb

@@ -29,6 +29,7 @@ class RodaSessionMiddleware
 
     def initialize(req)
       @req = req
+      @data = nil
     end
 
     # The Roda sessions plugin options used by the middleware for this
@@ -124,7 +125,7 @@ class RodaSessionMiddleware
 
     # Whether the session has already been loaded from the cookie yet.
     def loaded?
-      !!defined?(@data)
+      !!@data
     end
 
     def empty?

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

data/lib/roda.rb

@@ -17,6 +17,7 @@ class Roda
   @app = nil
   @inherit_middleware = true
   @middleware = []
+  @plugins = []
   @opts = {}
   @raw_route_block = nil
   @route_block = nil
@@ -42,6 +43,9 @@ class Roda
         # The settings/options hash for the current class.
         attr_reader :opts
 
+        # The plugins loaded into the current class.
+        attr_reader :plugins
+
         # The route block that this class uses.
         attr_reader :route_block
 
@@ -224,6 +228,7 @@ class Roda
 
           build_rack_app
           @opts.freeze
+          @plugins.freeze
           @middleware.freeze
 
           super
@@ -250,6 +255,7 @@ class Roda
           super
           subclass.instance_variable_set(:@inherit_middleware, @inherit_middleware)
           subclass.instance_variable_set(:@middleware, @inherit_middleware ? @middleware.dup : [])
+          subclass.instance_variable_set(:@plugins, @plugins.dup)
           subclass.instance_variable_set(:@opts, opts.dup)
           subclass.opts.delete(:subclassed)
           subclass.opts.to_a.each do |k,v|
@@ -291,6 +297,7 @@ class Roda
           end
 
           plugin.load_dependencies(self, *args, &block) if plugin.respond_to?(:load_dependencies)
+          @plugins << plugin unless @plugins.include?(plugin)
           include(plugin::InstanceMethods) if defined?(plugin::InstanceMethods)
           extend(plugin::ClassMethods) if defined?(plugin::ClassMethods)
           self::RodaRequest.send(:include, plugin::RequestMethods) if defined?(plugin::RequestMethods)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.105.0
+  version: 3.106.0
 platform: ruby
 authors:
 - Jeremy Evans
@@ -292,6 +292,7 @@ files:
 - lib/roda/plugins/sec_fetch_site_csrf.rb
 - lib/roda/plugins/send_file.rb
 - lib/roda/plugins/sessions.rb
+- lib/roda/plugins/shape_friendly.rb
 - lib/roda/plugins/shared_vars.rb
 - lib/roda/plugins/sinatra_helpers.rb
 - lib/roda/plugins/slash_path_empty.rb