roda 3.66.0 → 3.67.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52a6bb08790a0a3414771a5d772a27d98089a96a306812ddb781ce31724289f0
-  data.tar.gz: 8679931319b2abf3b8aba64151664cf2d154517fbfd5020ded910e5ba32452a0
+  metadata.gz: 0ea9212a800294ebf286d593e230ac925aced0d5e7c118fa7541b3fd6a5cc983
+  data.tar.gz: 9a591fdf0b2b481f71cbf871a70b3f83a8cac4bca4c3fe399348dfeee2447a13
 SHA512:
-  metadata.gz: 4ace69f14606887e7243a5ec00598d8a3ded4230e8fbdf849c801579f38c9242ca87c5ab48887aeba65911cbcf49e675e768c077d20680e9693c5989180218b7
-  data.tar.gz: 7986400736b3631524c3427f135a8d3cb9da04da0d1413f59d764fd8c5b7c4ee6f81be9a3b92d848c5546229b7bd7f236278cfe41cb12410c34def542762d1f9
+  metadata.gz: 7f5887a701034ac935d6bb1f14a454f6dfe03751ec7842e383f401555f46d021d8bb502658959a5edae9d4199d8e8bfc785721d3386b76f0b6b280c7731fad3d
+  data.tar.gz: eb7de74ded26221a86664644ceddda6428e877bdf158acd988319c56bdc335955b506623cc9d8fb3c71376c877d4e00254c018c4341debd221a6439d9557e6ed

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 3.67.0 (2023-04-12)
+
+* Add custom_block_results plugin for registering custom block result handlers (jeremyevans)
+
 = 3.66.0 (2023-03-13)
 
 * Support overriding exception page assets via exception_page_{css,js} instance methods (jeremyevans) (#306)

data/doc/release_notes/3.67.0.txt

@@ -0,0 +1,25 @@
+= New Feature
+
+* A custom_block_results plugin has been added for custom handling
+  of block results.  This allows routing blocks to return
+  arbitrary objects instead of just String, nil, and false, and
+  to have custom handling for them. For example, if you want to
+  be able to have your routing blocks return the status code to use,
+  you could do:
+
+    plugin :custom_block_results
+
+    handle_block_result Integer do |result|
+      response.status_code = result
+    end
+
+    route do |r|
+      200
+    end
+
+  While the expected use of the handle_block_result method is with
+  class arguments, you can use any argument that implements an
+  appropriate === method.
+
+  The symbol_views and json plugins, which support additional block
+  results, now use the custom_block_results plugin internally.

data/lib/roda/plugins/custom_block_results.rb

@@ -0,0 +1,68 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The custom_block_results plugin allows you to specify handling
+    # for different block results.  By default, Roda only supports
+    # nil, false, and string block results, but using this plugin,
+    # you can support other block results.
+    #
+    # For example, if you wanted to support returning Integer
+    # block results, and have them set the response status code,
+    # you could do:
+    #
+    #   plugin :custom_block_results
+    #
+    #   handle_block_result Integer do |result|
+    #     response.status_code = result
+    #   end
+    #
+    #   route do |r|
+    #     200
+    #   end
+    #
+    # The expected use case for this is to customize behavior by
+    # class, but matching uses ===, so it is possible to use non-class
+    # objects that respond to === appropriately.
+    #
+    # Note that custom block result handling only occurs if the types
+    # are not handled by Roda itself.  You cannot use this to modify
+    # the handling of nil, false, or string results.
+    module CustomBlockResults
+      def self.configure(app)
+        app.opts[:custom_block_results] ||= {}
+      end
+
+      module ClassMethods
+        # Freeze the configured custom block results when freezing the app.
+        def freeze
+          opts[:custom_block_results].freeze
+          super
+        end
+
+        # Specify a block that will be called when an instance of klass
+        # is returned as a block result.  The block defines a method.
+        def handle_block_result(klass, &block)
+          opts[:custom_block_results][klass] = define_roda_method(opts[:custom_block_results][klass] || "custom_block_result_#{klass}", 1, &block)
+        end
+      end
+
+      module RequestMethods
+        private
+
+        # Try each configured custom block result, and call the related method
+        # to get the block result.
+        def unsupported_block_result(result)
+          roda_class.opts[:custom_block_results].each do |klass, meth|
+            return scope.send(meth, result) if klass === result
+          end
+
+          super
+        end
+      end
+    end
+
+    register_plugin(:custom_block_results, CustomBlockResults)
+  end
+end

data/lib/roda/plugins/json.rb

@@ -55,11 +55,17 @@ class Roda
     module Json
       # Set the classes to automatically convert to JSON, and the serializer to use.
       def self.configure(app, opts=OPTS)
+        app.plugin :custom_block_results
+
         classes = opts[:classes] || [Array, Hash]
         app.opts[:json_result_classes] ||= []
         app.opts[:json_result_classes] += classes
-        app.opts[:json_result_classes].uniq!
-        app.opts[:json_result_classes].freeze
+        classes = app.opts[:json_result_classes]
+        classes.uniq!
+        classes.freeze
+        classes.each do |klass|
+          app.opts[:custom_block_results][klass] = :handle_json_block_result
+        end
 
         app.opts[:json_result_serializer] = opts[:serializer] || app.opts[:json_result_serializer] || app.opts[:json_serializer] || :to_json.to_proc
 
@@ -71,32 +77,34 @@ class Roda
       module ClassMethods
         # The classes that should be automatically converted to json
         def json_result_classes
+          # RODA4: remove, only used by previous implementation.
           opts[:json_result_classes]
         end
       end
 
+      module InstanceMethods
+        # Handle a result for one of the registered JSON result classes
+        # by converting the result to JSON.
+        def handle_json_block_result(result)
+          @_response['Content-Type'] ||= opts[:json_result_content_type]
+          @_request.send(:convert_to_json, result)
+        end
+      end
+
       module RequestMethods
         private
 
-        # If the result is an instance of one of the json_result_classes,
-        # convert the result to json and return it as the body, using the
-        # application/json content-type.
-        def block_result_body(result)
-          case result
-          when *roda_class.json_result_classes
-            response['Content-Type'] ||= roda_class.opts[:json_result_content_type]
-            convert_to_json(result)
-          else
-            super
-          end
-        end
-
         # Convert the given object to JSON.  Uses to_json by default,
         # but can use a custom serializer passed to the plugin.
-        def convert_to_json(obj)
-          args = [obj]
-          args << self if roda_class.opts[:json_result_include_request]
-          roda_class.opts[:json_result_serializer].call(*args)
+        def convert_to_json(result)
+          opts = roda_class.opts
+          serializer = opts[:json_result_serializer]
+
+          if opts[:json_result_include_request]
+            serializer.call(result, self)
+          else
+            serializer.call(result)
+          end
         end
       end
     end

data/lib/roda/plugins/symbol_views.rb

@@ -23,18 +23,9 @@ class Roda
     #     :foo
     #   end
     module SymbolViews
-      module RequestMethods
-        private
-
-        # If the block result is a symbol, consider the symbol a
-        # template name and use the template view as the body.
-        def block_result_body(result)
-          if result.is_a?(Symbol)
-            scope.view(result)
-          else
-            super
-          end
-        end
+      def self.configure(app)
+        app.plugin :custom_block_results
+        app.opts[:custom_block_results][Symbol] = :view
       end
     end
 

data/lib/roda/request.rb

@@ -547,7 +547,7 @@ class Roda
           when nil, false
             # nothing
           else
-            raise RodaError, "unsupported block result: #{result.inspect}"
+            unsupported_block_result(result)
           end
         end
 
@@ -652,6 +652,12 @@ class Roda
           end
         end
 
+        # How to handle block results that are not nil, false, or a String.
+        # By default raises an exception.
+        def unsupported_block_result(result)
+          raise RodaError, "unsupported block result: #{result.inspect}"
+        end
+
         # Handle an unsupported matcher.
         def unsupported_matcher(matcher)
           raise RodaError, "unsupported matcher: #{matcher.inspect}"

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 = 66
+  RodaMinorVersion = 67
 
   # 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.66.0
+  version: 3.67.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-13 00:00:00.000000000 Z
+date: 2023-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -239,6 +239,7 @@ extra_rdoc_files:
 - doc/release_notes/3.64.0.txt
 - doc/release_notes/3.65.0.txt
 - doc/release_notes/3.66.0.txt
+- doc/release_notes/3.67.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
 - doc/release_notes/3.9.0.txt
@@ -312,6 +313,7 @@ files:
 - doc/release_notes/3.64.0.txt
 - doc/release_notes/3.65.0.txt
 - doc/release_notes/3.66.0.txt
+- doc/release_notes/3.67.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
 - doc/release_notes/3.9.0.txt
@@ -342,6 +344,7 @@ files:
 - lib/roda/plugins/content_security_policy.rb
 - lib/roda/plugins/cookies.rb
 - lib/roda/plugins/csrf.rb
+- lib/roda/plugins/custom_block_results.rb
 - lib/roda/plugins/custom_matchers.rb
 - lib/roda/plugins/default_headers.rb
 - lib/roda/plugins/default_status.rb
@@ -469,7 +472,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Routing tree web toolkit