roda 3.81.0 → 3.82.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9d94f31e568bd2774c3e582152f0bcdbffdf3fcd7e5a95241e73b3fd5b7ac3c
-  data.tar.gz: b9ad44642acdbaa0035cbd6ece521ca3432d2e7c23d75a331172ecd6c6288c60
+  metadata.gz: bdf5797c96af1d28dc4d13f0c95ac0468d60eb30b6a128b2cee2c26a08eb0a7f
+  data.tar.gz: d687b3cd03657bdcfda6f87a7a7a2a3b55e9a0c4f856cabd3d080865cc7d9ad2
 SHA512:
-  metadata.gz: 1cd64e84b47a1a7a01d9165d16e14d95d2c43287b58f2557d9492a201832c1388157152eab1fd12052c7691e3969e5ce1cb9c0ad706e73ad6de822dcc29e1590
-  data.tar.gz: 86320c603d0c9b90e2c82f16cc5229b76afe66dde5bdbccce9b28ce076e80808a35410098fe0eae5cb3f5b3180b79f4265b3d525e7861a9dd65890315d274fad
+  metadata.gz: e518b9638e98713ed54fd4c609069edf81a81987adf53ce2b7a09fa7110244f67b109cbe91c9c03d713f824900649d1c4b2ad435823852dcdfd01094f506afae
+  data.tar.gz: '00877a1338b70a5b96dab7fb946e21c7c916c776666286f80251b362e29ca6e040ffeb9b7a7258cf3af4c9246de5a6c35c5332385bd3cb926505776102c9112c'

data/CHANGELOG

@@ -1,3 +1,11 @@
+= 3.82.0 (2024-07-12)
+
+* Add :encodings option to public plugin to support configurable encoding order (jeremyevans)
+
+* Add :zstd option to public plugin to supplement it to serve zstd-compressed files with .zst extension (jeremyevans)
+
+* Make capture_erb plugin call integrate better with erubi/capture_block (jeremyevans)
+
 = 3.81.0 (2024-06-12)
 
 * Make assets plugin :early_hints option follow Rack 3 SPEC if using Rack 3 (jeremyevans)

data/doc/release_notes/3.82.0.txt

@@ -0,0 +1,43 @@
+= New Features
+
+* A :zstd option has been added to the public and multi_public
+  plugins to support serving zstd-compressed files with a .zst
+  extension. This option is similar to the existing :gzip and
+  :brotli plugin options.  Chrome started supporting zstd encoding
+  in March.
+
+* An :encodings option has been added to the public and multi_public
+  plugins, for more control over how encodings are handled.  This
+  allows for changing the order in which encodings are attempted, the
+  use of custom encodings, and the use of different file extensions
+  for encodings.  Example:
+
+    plugin :public, encodings: {'zstd'=>'.zst', 'deflate'=>'.deflate'}
+
+  If the :encodings option is not provided, the :zstd, :brotli, and
+  :gzip options are used to build an equivalent :encodings option.
+
+= Other Improvements
+
+* The capture_erb plugin now integrates better when using
+  erubi/capture_block for <%= method do %> support in ERB templates,
+  using the native capture method provided by the buffer object.
+
+* Encoding handling has been more optimized in the public plugin.
+  Regexps for the encodings are precomputed, avoiding a regexp
+  allocation per request per encoding attempted. On Ruby 2.4+
+  Regexp#match? is used for better performance.  If the
+  Accept-Encoding header is not present, no encoding matching
+  is attemped.
+
+= Backwards Compatibility
+
+* The private public_serve_compressed request method in the public
+  plugin now assumes it is called after the encoding is already
+  valid. If you are calling this method in your own code, you now
+  need to perform checks to make sure the client can accept the
+  encoding before calling this method.
+
+* The :public_gzip and :public_brotli application options are no
+  longer set by the public plugin.  The :public_encodings option
+  is now set.

data/lib/roda/plugins/capture_erb.rb

@@ -15,6 +15,11 @@ class Roda
     # inside templates.  It can be combined with the inject_erb plugin
     # to wrap template blocks with arbitrary output and then inject the
     # wrapped output into the template.
+    #
+    # If the output buffer object responds to +capture+ (e.g. when
+    # +erubi/capture_block+ is being used as the template engine),
+    # this will call +capture+ on the output buffer object, instead
+    # of setting the output buffer object temporarily to a new object.
     module CaptureERB
       def self.load_dependencies(app)
         app.plugin :render
@@ -25,13 +30,20 @@ class Roda
         # with an empty string, and then yield to the block.
         # Return the value of the block, converted to a string.
         # Restore the previous ERB output buffer before returning.
-        def capture_erb
+        def capture_erb(&block)
           outvar = render_opts[:template_opts][:outvar]
           buf_was = instance_variable_get(outvar)
-          instance_variable_set(outvar, String.new)
-          yield.to_s
-        ensure
-          instance_variable_set(outvar, buf_was) if outvar && buf_was
+
+          if buf_was.respond_to?(:capture)
+            buf_was.capture(&block)
+          else
+            begin
+              instance_variable_set(outvar, String.new)
+              yield.to_s
+            ensure
+              instance_variable_set(outvar, buf_was) if outvar && buf_was
+            end
+          end
         end
       end
     end

data/lib/roda/plugins/plain_hash_response_headers.rb

@@ -3,7 +3,7 @@
 #
 class Roda
   module RodaPlugins
-    # The response_headers_plain_hash plugin will change Roda to
+    # The plain_hash_response_headers plugin will change Roda to
     # use a plain hash for response headers.  This is Roda's
     # default behavior on Rack 2, but on Rack 3+, Roda defaults
     # to using Rack::Headers for response headers for backwards

data/lib/roda/plugins/public.rb

@@ -44,15 +44,30 @@ class Roda
       SPLIT = Regexp.union(*[File::SEPARATOR, File::ALT_SEPARATOR].compact)
       PARSER = URI::DEFAULT_PARSER
       RACK_FILES = defined?(Rack::Files) ? Rack::Files : Rack::File
+      ENCODING_MAP = {:zstd=>'zstd', :brotli=>'br', :gzip=>'gzip'}.freeze
+      ENCODING_EXTENSIONS = {'br'=>'.br', 'gzip'=>'.gz', 'zstd'=>'.zst'}.freeze
+
+      # :nocov:
+      MATCH_METHOD = RUBY_VERSION >= '2.4' ? :match? : :match
+      # :nocov:
 
       # Use options given to setup a Rack::File instance for serving files. Options:
+      # :brotli :: Whether to serve already brotli-compressed files with a .br extension
+      #            for clients supporting "br" transfer encoding.
       # :default_mime :: The default mime type to use if the mime type is not recognized.
+      # :encodings :: An enumerable of pairs to handle accepted encodings.  The first
+      #               element of the pair is the accepted encoding name (e.g. 'gzip'),
+      #               and the second element of the pair is the file extension (e.g.
+      #               '.gz'). This allows configuration of the order in which encodings 
+      #               are tried, to prefer brotli to zstd for example, or to support
+      #               encodings other than zstd, brotli, and gzip. This takes
+      #               precedence over the :brotli, :gzip, and :zstd options if given.
       # :gzip :: Whether to serve already gzipped files with a .gz extension for clients
-      #          supporting gzipped transfer encoding.
-      # :brotli :: Whether to serve already brotli-compressed files with a .br extension
-      #            for clients supporting brotli transfer encoding.
+      #          supporting "gzip" transfer encoding.
       # :headers :: A hash of headers to use for statically served files
       # :root :: Use this option for the root of the public directory (default: "public")
+      # :zstd :: Whether to serve already zstd-compressed files with a .zst extension
+      #          for clients supporting "zstd" transfer encoding.
       def self.configure(app, opts={})
         if opts[:root]
           app.opts[:public_root] = app.expand_path(opts[:root])
@@ -60,8 +75,18 @@ class Roda
           app.opts[:public_root] = app.expand_path("public")
         end
         app.opts[:public_server] = RACK_FILES.new(app.opts[:public_root], opts[:headers]||{}, opts[:default_mime] || 'text/plain')
-        app.opts[:public_gzip] = opts[:gzip]
-        app.opts[:public_brotli] = opts[:brotli]
+
+        unless encodings = opts[:encodings]
+          if ENCODING_MAP.any?{|k,| opts.has_key?(k)}
+            encodings = ENCODING_MAP.map{|k, v| [v, ENCODING_EXTENSIONS[v]] if opts[k]}.compact
+          end
+        end
+        encodings = (encodings || app.opts[:public_encodings] || EMPTY_ARRAY).map(&:dup).freeze
+        encodings.each do |a|
+          a << /\b#{a[0]}\b/
+        end
+        encodings.each(&:freeze)
+        app.opts[:public_encodings] = encodings
       end
 
       module RequestMethods
@@ -102,8 +127,13 @@ class Roda
           roda_opts = roda_class.opts
           path = ::File.join(server.root, *public_path_segments(path))
 
-          public_serve_compressed(server, path, '.br', 'br') if roda_opts[:public_brotli]
-          public_serve_compressed(server, path, '.gz', 'gzip') if roda_opts[:public_gzip]
+          if accept_encoding = env['HTTP_ACCEPT_ENCODING']
+            roda_opts[:public_encodings].each do |enc, ext, regexp|
+              if regexp.send(MATCH_METHOD, accept_encoding)
+                public_serve_compressed(server, path, ext, enc)
+              end
+            end
+          end
 
           if public_file_readable?(path)
             s, h, b = public_serve(server, path)
@@ -113,22 +143,22 @@ class Roda
           end
         end
 
+        # Serve the compressed file if it exists.  This should only
+        # be called if the client will accept the related encoding.
         def public_serve_compressed(server, path, suffix, encoding)
-          if env['HTTP_ACCEPT_ENCODING'] =~ /\b#{encoding}\b/
-            compressed_path = path + suffix
+          compressed_path = path + suffix
 
-            if public_file_readable?(compressed_path)
-              s, h, b = public_serve(server, compressed_path)
-              headers = response.headers
-              headers.replace(h)
-
-              unless s == 304
-                headers[RodaResponseHeaders::CONTENT_TYPE] = ::Rack::Mime.mime_type(::File.extname(path), 'text/plain')
-                headers[RodaResponseHeaders::CONTENT_ENCODING] = encoding
-              end
+          if public_file_readable?(compressed_path)
+            s, h, b = public_serve(server, compressed_path)
+            headers = response.headers
+            headers.replace(h)
 
-              halt [s, headers, b]
+            unless s == 304
+              headers[RodaResponseHeaders::CONTENT_TYPE] = ::Rack::Mime.mime_type(::File.extname(path), 'text/plain')
+              headers[RodaResponseHeaders::CONTENT_ENCODING] = encoding
             end
+
+            halt [s, headers, b]
           end
         end
 

data/lib/roda/plugins/render.rb

@@ -148,6 +148,19 @@ class Roda
     # inject the content into the output. To get similar behavior with Roda, you have
     # a few different options you can use.
     #
+    # == Use Erubi::CaptureBlockEngine
+    #
+    # Roda defaults to using Erubi for erb template rendering.  Erubi 1.13.0+ includes
+    # support for an erb variant that supports blocks in <tt><%=</tt> and <tt><%==</tt>
+    # tags.  To use it:
+    #
+    #   require 'erubi/capture_block'
+    #   plugin :render, template_opts: {engine_class: Erubi::CaptureBlockEngine}
+    #
+    # See the Erubi documentation for how to capture data inside the block.  Make sure
+    # the method call (+some_method+ in the example) returns the output you want added
+    # to the rendered body.
+    #
     # == Directly Inject Template Output
     #
     # You can switch from a <tt><%=</tt> tag to using a <tt><%</tt> tag:

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 = 81
+  RodaMinorVersion = 82
 
   # 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.81.0
+  version: 3.82.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -122,20 +122,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sassc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -256,6 +242,7 @@ extra_rdoc_files:
 - doc/release_notes/3.8.0.txt
 - doc/release_notes/3.80.0.txt
 - doc/release_notes/3.81.0.txt
+- doc/release_notes/3.82.0.txt
 - doc/release_notes/3.9.0.txt
 files:
 - CHANGELOG
@@ -344,6 +331,7 @@ files:
 - doc/release_notes/3.8.0.txt
 - doc/release_notes/3.80.0.txt
 - doc/release_notes/3.81.0.txt
+- doc/release_notes/3.82.0.txt
 - doc/release_notes/3.9.0.txt
 - lib/roda.rb
 - lib/roda/cache.rb
@@ -509,7 +497,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Routing tree web toolkit