roda 3.62.0 → 3.64.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 912f354ffcb4440bf7955d4db8546f9eccbee3f3a3f91b77604a91228a2433c4
-  data.tar.gz: 8df8254014b7e8e9b6db623fa2b8269ac5485b5087ee53978080a81ba344a60c
+  metadata.gz: 715e94da6acab0fa1c5e8409051f3faf0800ca56874d8640fa8f00c2ac432322
+  data.tar.gz: 79d9f75da1af54c8288918f722dff874433c7935a996180311344a24acc751ec
 SHA512:
-  metadata.gz: bb43bcbad6e5421935d62a11abc3da27c40559ef1f55b9791d71ab22bd8cc4a73933f85bb68d77feb26efd6bf84f840bd5a202c80938ede330ca67cf9b51ca8b
-  data.tar.gz: 6f3234b37c506e3037864e7a7b79280f5b190758e8dada8f213b141cd1e4826a03a98017ddccb806082fa551580af9683088c94080157811867c0a3a1ec92b04
+  metadata.gz: 507d5395d337ae4e6c13a3ace905a605ecad5690bf8ceabd8d40bf3c9e2b162649a2a6cb79d1422c8c560396f4abdf891d8f3543b9866cd4f20e944acb4b6347
+  data.tar.gz: 37cdd77e3b2894ca55370d638e411e3bf10005101d83939a970b242a4750aa2df929994343c20546cdd6046553897e4d7cde19788f10c2406eb5b446d31e97d5

data/CHANGELOG

@@ -1,3 +1,19 @@
+= 3.64.0 (2023-01-12)
+
+* Automatically expand paths for autoload_hash_branches files, so that relative paths work (jeremyevans)
+
+* Make autoload_hash_branches plugin eagerly load the branches when freezing the application (jeremyevans)
+
+* Add erb_h plugin for faster (if slightly less safe) html escaping using erb/escape (jeremyevans)
+
+= 3.63.0 (2022-12-16)
+
+* Make mailer plugin set configured content type for body part for emails with attachments when using mail 2.8+ (jeremyevans)
+
+* Add autoload_hash_branches plugin for autoloading file for a hash branch when there is a request for that branch (jeremyevans)
+
+* Add mailer plugin :terminal option to make r.mail use a terminal match when provided arguments (jeremyevans)
+
 = 3.62.0 (2022-11-14)
 
 * Add typecast_params_sized_integers plugin for converting parameters to sized integers (jeremyevans)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2014-2022 Jeremy Evans
+Copyright (c) 2014-2023 Jeremy Evans
 Copyright (c) 2010-2014 Michel Martens, Damian Janowski and Cyril David
 Copyright (c) 2008-2009 Christian Neukirchen
 

data/doc/release_notes/3.63.0.txt

@@ -0,0 +1,36 @@
+= New Features
+
+* An autoload_hash_branches plugin has been added for autoloading
+  route files for each hash branch, instead of requiring the route
+  files be loaded up front.  For example, to automatically load a
+  route file for a hash branch on the first request to that branch:
+
+    plugin :autoload_hash_branches
+    autoload_hash_branch('branch_name', '/path/to/file')
+    autoload_hash_branch('namespace', 'branch_name', '/path/to/file')
+
+  The route file loaded should define the expected hash branch.
+
+  It is common to have route files stored in a directory, with the
+  file name matching the branch name.  In that case, you can set
+  autoloading for all route files in a given directory:
+
+    plugin :autoload_hash_branches
+    autoload_hash_branch_dir('/path/to/dir')
+    autoload_hash_branch_dir('namespace', '/path/to/dir')
+
+  Note that autoloading hash branches does not work if the application
+  is frozen.  This plugin should only be used in development mode for
+  faster startup, or when running tests on a subset of the application
+  in order to avoid loading parts of the application unrelated to what
+  is being tested.
+
+* The mailer plugin now supports a :terminal plugin option to make
+  the r.mail method force a terminal match, similar to how r.get
+  and other HTTP verb methods work in standard Roda.  This behavior
+  will become the default in Roda 4.
+
+= Other Improvements
+
+* The mailer plugin now correctly sets the content_type of the body
+  for emails with attachments when using mail 2.8.0+.

data/doc/release_notes/3.64.0.txt

@@ -0,0 +1,26 @@
+= New Features
+
+* An erb_h plugin has been added for faster HTML escaping using
+  erb/escape.  erb 4 added erb/escape and it is included in Ruby 3.2.
+
+  The erb_h plugin is added as a separate plugin because it changes
+  the behavior of the h method. The h method added by the h plugin
+  will always return a new string, but the h method added by the
+  erb_h plugin will return the argument if the argument is a
+  string that does not need escaping.  By avoiding unnecessary
+  string allocations, use of the erb_h plugin can speed up HTML
+  escaping.
+
+= Other Improvements
+
+* The autoload_hash_branches plugin added in Roda 3.63.0 will now
+  eagerly load the hash branches when freezing the application,
+  allowing the application to continue to work after being frozen.
+  Additionally, file paths for the hash branches will now be
+  automatically expanded, allowing the use of relative file paths.
+
+= Backwards Compatibility
+
+* The expanding of file paths in the autoload_hash_branches plugin
+  can break applications that were providing relative paths and
+  expecting them to be looked up using the Ruby load path.

data/lib/roda/plugins/autoload_hash_branches.rb

@@ -0,0 +1,79 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The autoload_hash_branches plugin builds on the hash_branches plugin and allows for
+    # delaying loading of a file containing a hash branch for an application until there
+    # is a request that uses the hash branch. This can be useful in development
+    # to improvement startup time by not loading all branches up front.  It can also be
+    # useful in testing subsets of an application by only loading the hash branches being
+    # tested.
+    #
+    # You can specify a single hash branch for autoloading:
+    #
+    #   plugin :autoload_hash_branches
+    #   autoload_hash_branch('branch_name', '/absolute/path/to/file')
+    #   autoload_hash_branch('namespace', 'branch_name', 'relative/path/to/file')
+    #
+    # You can also set the plugin to autoload load all hash branch files in a given directory.
+    # This will look at each .rb file in the directory, and add an autoload for it, using the
+    # filename without the .rb as the branch name:
+    #
+    #   autoload_hash_branch_dir('/path/to/dir')
+    #   autoload_hash_branch_dir('namespace', '/path/to/dir')
+    #
+    # In both cases, when the autoloaded file is required, it should redefine the same
+    # hash branch.  If it does not, requests to the hash branch will result in a 404 error.
+    #
+    # When freezing an application, all hash branches are automatically loaded, because
+    # autoloading hash branches does not work for frozen applications.
+    module AutoloadHashBranches
+      def self.load_dependencies(app)
+        app.plugin :hash_branches
+      end
+
+      def self.configure(app)
+        app.opts[:autoload_hash_branch_files] ||= []
+      end
+
+      module ClassMethods
+        # Autoload the given file when there is request for the hash branch.
+        # The given file should configure the hash branch specified.
+        def autoload_hash_branch(namespace='', segment, file)
+          segment = "/#{segment}"
+          file = File.expand_path(file)
+          opts[:autoload_hash_branch_files] << file
+          routes = opts[:hash_branches][namespace] ||= {}
+          meth = routes[segment] = define_roda_method(routes[segment] || "hash_branch_#{namespace}_#{segment}", 1) do |r|
+            loc = method(routes[segment]).source_location
+            require file
+            # Avoid infinite loop in case method is not overridden
+            if method(meth).source_location != loc
+              send(meth, r)
+            end
+          end
+          nil
+        end
+
+        # For each .rb file in the given directory, add an autoloaded hash branch
+        # based on the file name.
+        def autoload_hash_branch_dir(namespace='', dir)
+          Dir.new(dir).entries.each do |file|
+            if file =~ /\.rb\z/i
+              autoload_hash_branch(namespace, file.sub(/\.rb\z/i, ''), File.join(dir, file))
+            end
+          end
+        end
+
+        # Eagerly load all hash branches when freezing the application.
+        def freeze
+          opts.delete(:autoload_hash_branch_files).each{|file| require file}
+          super
+        end
+      end
+    end
+
+    register_plugin(:autoload_hash_branches, AutoloadHashBranches)
+  end
+end

data/lib/roda/plugins/erb_h.rb

@@ -0,0 +1,43 @@
+# frozen-string-literal: true
+
+require 'erb/escape'
+
+#
+class Roda
+  module RodaPlugins
+    # The erb_h plugin adds an +h+ instance method that will HTML
+    # escape the input and return it. This is similar to the h
+    # plugin, but it uses erb/escape to implement the HTML escaping,
+    # which offers faster performance.
+    #
+    # To make sure that this speeds up applications using the h
+    # plugin, this depends on the h plugin, and overrides the
+    # h method.
+    #
+    # The following example will return "<foo>" as the body.
+    #
+    #   plugin :erb_h
+    #
+    #   route do |r|
+    #     h('<foo>')
+    #   end
+    #
+    # The faster performance offered by the erb_h plugin is due
+    # to erb/escape avoiding allocations if not needed (returning the
+    # input object if no escaping is needed).  That behavior change
+    # can cause problems if you mutate the result of the h method
+    # (which can mutate the input), or mutate the input of the h
+    # method after calling it (which can mutate the result).
+    module ErbH
+      def self.load_dependencies(app)
+        app.plugin :h
+      end
+
+      module InstanceMethods
+        define_method(:h, ERB::Escape.instance_method(:html_escape))
+      end
+    end
+
+    register_plugin(:erb_h, ErbH)
+  end
+end

data/lib/roda/plugins/exception_page.rb

@@ -401,7 +401,6 @@ END
 
         private
 
-        # :nocov:
         if RUBY_VERSION >= '3.2'
           def exception_page_exception_message(exception)
             exception.detailed_message(highlight: false).to_s
@@ -413,6 +412,7 @@ END
             exception.message.to_s
           end
         end
+        # :nocov:
       end
 
       module RequestMethods

data/lib/roda/plugins/mailer.rb

@@ -115,6 +115,11 @@ class Roda
     #
     #   plugin :mailer, content_type: 'text/html'
     #
+    # For backwards compatibility reasons, the +r.mail+ method does not do
+    # a terminal match by default if provided arguments (unlike +r.get+ and
+    # +r.post+).  You can pass the :terminal option to make +r.mail+ enforce
+    # a terminal match if provided arguments.
+    #
     # The mailer plugin does support being used inside a Roda application
     # that is handling web requests, where the routing block for mails and
     # web requests is shared.  However, it's recommended that you create a
@@ -163,7 +168,8 @@ class Roda
         # any arguments passed to the +mail+ or +sendmail+ Roda class methods.
         def mail(*args)
           if @env["REQUEST_METHOD"] == "MAIL"
-            if_match(args) do |*vs|
+            # RODA4: Make terminal match the default
+            send(roda_class.opts[:mailer][:terminal] ? :_verb : :if_match, args) do |*vs|
               yield(*(vs + @env['roda.mail_args']))
             end
           end
@@ -190,9 +196,9 @@ class Roda
 
             if content_type = header_content_type || roda_class.opts[:mailer][:content_type]
               if mail.multipart?
-                if mail.content_type =~ /multipart\/mixed/ &&
+                if /multipart\/mixed/ =~ mail.content_type &&
                    mail.parts.length >= 2 &&
-                   (part = mail.parts.find{|p| !p.attachment && p.content_type == "text/plain"})
+                   (part = mail.parts.find{|p| !p.attachment && (p.encoded; /text\/plain/ =~ p.content_type)})
                   part.content_type = content_type
                 end
               else

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 = 62
+  RodaMinorVersion = 64
 
   # 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.62.0
+  version: 3.64.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-14 00:00:00.000000000 Z
+date: 2023-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -235,6 +235,8 @@ extra_rdoc_files:
 - doc/release_notes/3.60.0.txt
 - doc/release_notes/3.61.0.txt
 - doc/release_notes/3.62.0.txt
+- doc/release_notes/3.63.0.txt
+- doc/release_notes/3.64.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
 - doc/release_notes/3.9.0.txt
@@ -304,6 +306,8 @@ files:
 - doc/release_notes/3.60.0.txt
 - doc/release_notes/3.61.0.txt
 - doc/release_notes/3.62.0.txt
+- doc/release_notes/3.63.0.txt
+- doc/release_notes/3.64.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
 - doc/release_notes/3.9.0.txt
@@ -320,6 +324,7 @@ files:
 - lib/roda/plugins/all_verbs.rb
 - lib/roda/plugins/assets.rb
 - lib/roda/plugins/assets_preloading.rb
+- lib/roda/plugins/autoload_hash_branches.rb
 - lib/roda/plugins/backtracking_array.rb
 - lib/roda/plugins/branch_locals.rb
 - lib/roda/plugins/caching.rb
@@ -344,6 +349,7 @@ files:
 - lib/roda/plugins/early_hints.rb
 - lib/roda/plugins/empty_root.rb
 - lib/roda/plugins/environments.rb
+- lib/roda/plugins/erb_h.rb
 - lib/roda/plugins/error_email.rb
 - lib/roda/plugins/error_handler.rb
 - lib/roda/plugins/error_mail.rb
@@ -457,7 +463,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Routing tree web toolkit