roda 3.57.0 → 3.58.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 578868ccd08ba1fa91302273c92176def99072db735ec119d13cbf49e78a7249
-  data.tar.gz: b95b2a33a18a3b135f494ba7f0ffa1639a5fd876b0b199f414826cab7fa75a9d
+  metadata.gz: 01acdb87d6bf21ec4137dd2b6c7e3210c5923c43f188a510135c30a66945160a
+  data.tar.gz: e84ddddfbfe23a4be3951c2611f38916cb6dfb60b15c1a6bfd18155869ad4985
 SHA512:
-  metadata.gz: 2b7b769a1653315b1fd9bca1a993ff0e699f2a09fb4db135304d8c7473f2c834c61b91e188005ac029fd85feaca6cc6a106efdd83f0e53771cddd8f3a73204aa
-  data.tar.gz: 7bdc602a54f8f5b34a7edc0355b3e6a426b29dd4671c30ef9d7712c757e116c9e6679cd08884f28c7636a80560878284ff4de479f0c479d905948ebfce9b12b3
+  metadata.gz: 1681a1b8b8eb950be113d1a533c545ed0a71c24dc6d027a41d2cddb1ae99e4a2c2d23fc0e4c84d1f2960fd141021684d37d75e8509b247d732203100eae6ab2f
+  data.tar.gz: a21456321d0ab6f3c32d4ba97dabd31635751caee7889a2b556dd17cc74fb019d974cc06500081a859402cbf8002a26144d4885dbd8c47589852395d1e398ed2

data/CHANGELOG

@@ -1,3 +1,11 @@
+= 3.58.0 (2022-07-13)
+
+* Add filter_common_logger plugin for skipping the logging of certain requests when using the common_logger plugin (jeremyevans)
+
+* Make exception_page plugin use Exception#detailed_message on Ruby 3.2+ (jeremyevans)
+
+* Make heartbeat plugin compatible with recent changes in the rack master branch (jeremyevans)
+
 = 3.57.0 (2022-06-14)
 
 * Make static_routing plugin depend on the hash_paths instead of the hash_routes plugin (jeremyevans)

data/doc/release_notes/3.58.0.txt

@@ -0,0 +1,16 @@
+= New Features
+
+* A filter_common_logger plugin has been added, allowing you to skip
+  logging of certain requests in the common_logger plugin. This
+  allows you to only log requests for certain paths, or only log
+  requests for certain types of responses.
+
+= Other Improvements
+
+* The heartbeat plugin is now compatible with recent changes in the
+  rack master branch (what will be rack 3).
+
+* The exception_page plugin will now use Exception#detailed_message
+  on Ruby 3.2+, preserving the did_you_mean and error_highlight
+  information.  Additionally, the display of exception messages
+  has been improved.

data/lib/roda/plugins/exception_page.rb

@@ -127,7 +127,7 @@ div.context ol.context-line li span { float: right; }
 div.commands { margin-left: 40px; }
 div.commands a { color:black; text-decoration:none; }
 #summary { background: #ffc; }
-#summary h2 { font-weight: normal; color: #666; }
+#summary h2 { font-weight: normal; color: #666; font-family: monospace; white-space: pre-wrap;}
 #summary ul#quicklinks { list-style-type: none; margin-bottom: 2em; }
 #summary ul#quicklinks li { float: left; padding: 0 1em; }
 #summary ul#quicklinks>li+li { border-left: 1px #666 solid; }
@@ -196,12 +196,13 @@ END
         #          Designed to be used with the +json+ exception, which will
         #          automatically convert the hash to JSON format.
         def exception_page(exception, opts=OPTS)
+          message = exception_page_exception_message(exception)
           if opts[:json]
             @_response['Content-Type'] = "application/json"
             {
               "exception"=>{
                 "class"=>exception.class.to_s,
-                "message"=>exception.message.to_s,
+                "message"=>message,
                 "backtrace"=>exception.backtrace.map(&:to_s)
               }
             }
@@ -319,7 +320,7 @@ END
 
 <div id="summary">
   <h1>#{h exception.class} at #{h r.path}</h1>
-  <h2>#{h exception.message}</h2>
+  <h2>#{h message}</h2>
   <table><tr>
     <th>Ruby</th>
     <td>
@@ -394,7 +395,22 @@ END1
 END
           else
             @_response['Content-Type'] = "text/plain"
-            "#{exception.class}: #{exception.message}\n#{exception.backtrace.map{|l| "\t#{l}"}.join("\n")}"
+            "#{exception.class}: #{message}\n#{exception.backtrace.map{|l| "\t#{l}"}.join("\n")}"
+          end
+        end
+
+        private
+
+        # :nocov:
+        if RUBY_VERSION >= '3.2'
+          def exception_page_exception_message(exception)
+            exception.detailed_message(highlight: false).to_s
+          end
+        # :nocov:
+        else
+          # Return message to use for exception.
+          def exception_page_exception_message(exception)
+            exception.message.to_s
           end
         end
       end

data/lib/roda/plugins/filter_common_logger.rb

@@ -0,0 +1,46 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The skip_common_logger plugin allows for skipping common_logger logging
+    # of some requests. You pass a block when loading the plugin, and the
+    # block will be called before logging each request.  The block should return
+    # whether the request should be logged.
+    #
+    # Example:
+    #
+    #   # Only log server errors
+    #   plugin :filter_common_logger do |result|
+    #     result[0] >= 500
+    #   end
+    #
+    #   # Don't log requests to certain paths
+    #   plugin :filter_common_logger do |_|
+    #     # Block is called in the same context as the route block
+    #     !request.path.start_with?('/admin/')
+    #   end
+    module FilterCommonLogger
+      def self.load_dependencies(app)
+        app.plugin :common_logger
+      end
+
+      def self.configure(app, &block)
+        app.send(:define_method, :_common_log_request?, &block)
+        app.send(:private, :_common_log_request?)
+        app.send(:alias_method, :_common_log_request?, :_common_log_request?)
+      end
+
+      module InstanceMethods
+        private
+
+        # Log request/response information in common log format to logger.
+        def _roda_after_90__common_logger(result)
+          super if result && _common_log_request?(result)
+        end
+      end
+    end
+
+    register_plugin(:filter_common_logger, FilterCommonLogger)
+  end
+end

data/lib/roda/plugins/heartbeat.rb

@@ -14,13 +14,6 @@ class Roda
     #
     #   plugin :heartbeat, path: '/status'
     module Heartbeat
-      # :nocov:
-      HEADER_CLASS = (defined?(Rack::Headers) && Rack::Headers.is_a?(Class)) ? Rack::Headers : Hash
-      # :nocov:
-      private_constant :HEADER_CLASS
-
-      HEARTBEAT_RESPONSE = [200, {'Content-Type'=>'text/plain'}.freeze, ['OK'.freeze].freeze].freeze
-
       # Set the heartbeat path to the given path.
       def self.configure(app, opts=OPTS)
         app.opts[:heartbeat_path] = (opts[:path] || app.opts[:heartbeat_path] || "/heartbeat").dup.freeze
@@ -32,9 +25,11 @@ class Roda
         # If the request is for a heartbeat path, return the heartbeat response.
         def _roda_before_20__heartbeat
           if env['PATH_INFO'] == opts[:heartbeat_path]
-            response = HEARTBEAT_RESPONSE.dup
-            response[1] = HEADER_CLASS[response[1]]
-            throw :halt, response
+            response = @_response
+            response.status = 200
+            response['Content-Type'] = 'text/plain'
+            response.write 'OK'
+            throw :halt, response.finish
           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 = 57
+  RodaMinorVersion = 58
 
   # 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.57.0
+  version: 3.58.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-14 00:00:00.000000000 Z
+date: 2022-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -229,6 +229,7 @@ extra_rdoc_files:
 - doc/release_notes/3.55.0.txt
 - doc/release_notes/3.56.0.txt
 - doc/release_notes/3.57.0.txt
+- doc/release_notes/3.58.0.txt
 - doc/release_notes/3.6.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
@@ -293,6 +294,7 @@ files:
 - doc/release_notes/3.55.0.txt
 - doc/release_notes/3.56.0.txt
 - doc/release_notes/3.57.0.txt
+- doc/release_notes/3.58.0.txt
 - doc/release_notes/3.6.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
@@ -336,6 +338,7 @@ files:
 - lib/roda/plugins/error_handler.rb
 - lib/roda/plugins/error_mail.rb
 - lib/roda/plugins/exception_page.rb
+- lib/roda/plugins/filter_common_logger.rb
 - lib/roda/plugins/flash.rb
 - lib/roda/plugins/h.rb
 - lib/roda/plugins/halt.rb