roda 3.59.0 → 3.60.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 963e2d9ac538dbe97835ef65e2e2ba4184838664696bb084ce423a85ef23c205
-  data.tar.gz: d47a7f9c86357e99b0c9f470b6c33a32962df55189303020982af55d70907c7b
+  metadata.gz: 970d646c144f53a89f4f79e9d54b6929b7c10b55b1bbe9b2d5e72aea6a8eb3ae
+  data.tar.gz: ec2489d3d668b3abd2787a7f19c13de43c94685dce010d800296eb1194e36e11
 SHA512:
-  metadata.gz: c84cb0ae8c66b537c0a7d32d83d9c5a639439b15fbc650d3569efab5e134e0883ba06183c7f17bfb379f4018060c7d276a5016431ae3e21d05c2db3801a85762
-  data.tar.gz: 0c9495ec5fe24b774512f6495f97f5bb4cf8189b964f21a04c5e880d4a536ade2e045c7131f0a54a7c1cd203fe142d53c6d7cde4cf223a8e8be4cb5c5475fede
+  metadata.gz: ccc8d09c535a2c6a92ee314ff295ca5b8756b6c942f3224acbabdc6a92de5bf242a928b296c2e410ecf0bf59470a2143ac2c80d118030db5a2f45fb0cf262a8c
+  data.tar.gz: 79114184b64598e3d12d3773c5e7f8d717a05268c63c479758fe3ea1c3c78ccd933531c4e7ef6fd58a6d6af03a150d6e1dde8bf0f27dcc4c0c253482336879f0

data/CHANGELOG

@@ -1,3 +1,7 @@
+= 3.60.0 (2022-09-13)
+
+* Add link_to plugin with link_to method for creating HTML links (jeremyevans)
+
 = 3.59.0 (2022-08-12)
 
 * Add additional_render_engines plugin, for considering multiple render engines for templates (jeremyevans)

data/doc/release_notes/3.60.0.txt

@@ -0,0 +1,56 @@
+= New Features
+
+* A link_to plugin has been added with a link_to method for
+  creating HTML links.
+
+  The simplest usage of link_to is passing the body and the location
+  to link to as strings:
+ 
+    # Instance level
+    link_to("body", "/path")
+    # => "<a href=\"/path\">body</a>"
+ 
+  The link_to plugin depends on the path plugin, and allows you to
+  pass symbols for named paths:
+ 
+    # Class level
+    path :foo, "/path/to/too"
+ 
+    # Instance level
+    link_to("body", :foo)
+    # => "<a href=\"/path/to/foo\">body</a>"
+ 
+  It also allows you to pass instances of classes that you have
+  registered with the path plugin:
+ 
+    # Class level
+    A = Struct.new(:id)
+    path A do
+      "/path/to/a/#{id}"
+    end
+ 
+    # Instance level
+    link_to("body", A.new(1))
+    # => "<a href=\"/path/to/a/1\">body</a>"
+ 
+  To set additional HTML attributes on the tag, you can pass them as
+  an options hash:
+ 
+    link_to("body", "/path", foo: "bar")
+    # => "<a href=\"/path\" foo=\"bar\">body</a>"
+ 
+  If the body is nil, it will be set to the same as the path:
+ 
+    link_to(nil, "/path")
+    # => "<a href=\"/path\">/path</a>"
+ 
+  The plugin will automatically HTML escape the path and any HTML
+  attribute values, using the h plugin:
+ 
+    link_to("body", "/path?a=1&b=2", foo: '"bar"')
+    # => "<a href=\"/path?a=1&amp;b=2\" foo=\"&quot;bar&quot;\">body</a>"
+
+= Other Improvements
+
+* Coverage testing has been expanded to multiple rack versions, instead
+  of just the current rack release.

data/lib/roda/plugins/all_verbs.rb

@@ -34,9 +34,7 @@ class Roda
     module AllVerbs
       module RequestMethods
         %w'delete head options link patch put trace unlink'.each do |verb|
-          # :nocov:
           if ::Rack::Request.method_defined?("#{verb}?")
-          # :nocov:
             class_eval(<<-END, __FILE__, __LINE__+1)
               def #{verb}(*args, &block)
                 _verb(args, &block) if #{verb}?

data/lib/roda/plugins/disallow_file_uploads.rb

@@ -1,8 +1,6 @@
 # frozen-string-literal: true
 
-# :nocov:
 raise LoadError, "disallow_file_uploads plugin not supported on Rack <1.6" if Rack.release < '1.6'
-# :nocov:
 
 #
 class Roda

data/lib/roda/plugins/indifferent_params.rb

@@ -52,14 +52,12 @@ class Roda
           end
           
           class Params < Rack::QueryParser::Params
-            # :nocov:
-            if Rack.release >= '2.3'
+            if Rack.release >= '3'
               def initialize
                 @size   = 0
                 @params = Hash.new(&INDIFFERENT_PROC)
               end
             else
-            # :nocov:
               def initialize(limit = Rack::Utils.key_space_limit)
                 @limit  = limit
                 @size   = 0
@@ -71,9 +69,7 @@ class Roda
         end
 
         module RequestMethods
-          # :nocov:
-          query_parser = Rack.release >= '2.3' ? QueryParser.new(QueryParser::Params, 32) : QueryParser.new(QueryParser::Params, 65536, 32)
-          # :nocov:
+          query_parser = Rack.release >= '3' ? QueryParser.new(QueryParser::Params, 32) : QueryParser.new(QueryParser::Params, 65536, 32)
           QUERY_PARSER = Rack::Utils.default_query_parser = query_parser
 
           private
@@ -89,7 +85,6 @@ class Roda
           end
         end
       else
-        # :nocov:
         module InstanceMethods
           # A copy of the request params that will automatically
           # convert symbols to strings.
@@ -115,7 +110,6 @@ class Roda
             end
           end
         end
-        # :nocov:
       end  
     end
 

data/lib/roda/plugins/json_parser.rb

@@ -86,12 +86,10 @@ class Roda
 
         
         # Rack 3 dropped requirement that input be rewindable
-        if Rack.release >= '2.3'
-          # :nocov:
+        if Rack.release >= '3'
           def _read_json_input(input)
             input.read
           end
-          # :nocov:
         else
           def _read_json_input(input)
             input.rewind

data/lib/roda/plugins/link_to.rb

@@ -0,0 +1,83 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The link_to plugin adds the +link_to+ instance method, which can be used for constructing
+    # HTML links (+a+ tag with +href+ attribute).
+    #
+    # The simplest usage of +link_to+ is passing the body and the location to link to as strings:
+    #
+    #   link_to("body", "/path")
+    #   # => "<a href=\"/path\">body</a>"
+    #
+    # The link_to plugin depends on the path plugin, and allows you to pass symbols for named paths:
+    #
+    #   # Class level
+    #   path :foo, "/path/to/too"
+    #
+    #   # Instance level
+    #   link_to("body", :foo)
+    #   # => "<a href=\"/path/to/foo\">body</a>"
+    #
+    # It also allows you to pass instances of classes that you have registered with the path plugin:
+    #
+    #   # Class level
+    #   A = Struct.new(:id)
+    #   path A do
+    #     "/path/to/a/#{id}"
+    #   end
+    #
+    #   # Instance level
+    #   link_to("body", A.new(1))
+    #   # => "<a href=\"/path/to/a/1\">body</a>"
+    #
+    # To set additional HTML attributes on the +a+ tag, you can pass them as an options hash:
+    #
+    #   link_to("body", "/path", foo: "bar")
+    #   # => "<a href=\"/path\" foo=\"bar\">body</a>"
+    #
+    # If the body is nil, it will be set to the same as the path:
+    #
+    #   link_to(nil, "/path")
+    #   # => "<a href=\"/path\">/path</a>"
+    #
+    # The plugin will automatically HTML escape the path and any HTML attribute values, using the h plugin:
+    #
+    #   link_to("body", "/path?a=1&b=2", foo: '"bar"')
+    #   # => "<a href=\"/path?a=1&amp;b=2\" foo=\"&quot;bar&quot;\">body</a>"
+    module LinkTo
+      def self.load_dependencies(app)
+        app.plugin :h
+        app.plugin :path
+      end
+
+      module InstanceMethods
+        # Return a string with an HTML +a+ tag with an +href+ attribute. See LinkTo
+        # module documentation for details.
+        def link_to(body, href, attributes=OPTS)
+          case href
+          when Symbol
+            href = public_send(:"#{href}_path")
+          when String
+            # nothing
+          else
+            href = path(href)
+          end
+
+          href = h(href)
+
+          body = href if body.nil?
+
+          buf = String.new << "<a href=\"#{href}\""
+          attributes.each do |k, v|
+            buf << " " << k.to_s << "=\"" << h(v) << "\""
+          end
+          buf << ">" << body << "</a>"
+        end
+      end
+    end
+
+    register_plugin(:link_to, LinkTo)
+  end
+end

data/lib/roda/plugins/multi_public.rb

@@ -3,9 +3,7 @@
 begin
   require 'rack/files'
 rescue LoadError
-  # :nocov:
   require 'rack/file'
-  # :nocov:
 end
 
 #
@@ -66,9 +64,7 @@ class Roda
     #     end
     #   end
     module MultiPublic
-      # :nocov:
       RACK_FILES = defined?(Rack::Files) ? Rack::Files : Rack::File
-      # :nocov:
 
       def self.load_dependencies(app, _, opts=OPTS)
         app.plugin(:public, opts)

data/lib/roda/plugins/not_allowed.rb

@@ -116,9 +116,7 @@ class Roda
         # arguments, record the verb used.  If given an argument, add an is
         # check with the arguments.
         %w'get post delete head options link patch put trace unlink'.each do |verb|
-          # :nocov:
           if ::Rack::Request.method_defined?("#{verb}?")
-          # :nocov:
             class_eval(<<-END, __FILE__, __LINE__+1)
               def #{verb}(*args, &block)
                 if (empty = args.empty?) && @_is_verbs

data/lib/roda/plugins/public.rb

@@ -5,9 +5,7 @@ require 'uri'
 begin
   require 'rack/files'
 rescue LoadError
-  # :nocov:
   require 'rack/file'
-  # :nocov:
 end
 
 #
@@ -45,9 +43,7 @@ class Roda
     module Public
       SPLIT = Regexp.union(*[File::SEPARATOR, File::ALT_SEPARATOR].compact)
       PARSER = URI::DEFAULT_PARSER
-      # :nocov:
       RACK_FILES = defined?(Rack::Files) ? Rack::Files : Rack::File
-      # :nocov:
 
       # Use options given to setup a Rack::File instance for serving files. Options:
       # :default_mime :: The default mime type to use if the mime type is not recognized.
@@ -142,13 +138,11 @@ class Roda
             server.serving(self, path)
           end
         else
-          # :nocov:
           def public_serve(server, path)
             server = server.dup
             server.path = path
             server.serving(env)
           end
-          # :nocov:
         end
       end
     end

data/lib/roda/plugins/render.rb

@@ -214,18 +214,18 @@ class Roda
       tilt_compiled_method_support = defined?(Tilt::VERSION) && Tilt::VERSION >= '1.2' &&
         ([1, -2].include?(((compiled_method_arity = Tilt::Template.instance_method(:compiled_method).arity) rescue false)))
       NO_CACHE = {:cache=>false}.freeze
-      COMPILED_METHOD_SUPPORT = RUBY_VERSION >= '2.3' && tilt_compiled_method_support
+      COMPILED_METHOD_SUPPORT = RUBY_VERSION >= '2.3' && tilt_compiled_method_support && ENV['RODA_RENDER_COMPILED_METHOD_SUPPORT'] != 'no'
 
       if compiled_method_arity == -2
         def self.tilt_template_compiled_method(template, locals_keys, scope_class)
           template.send(:compiled_method, locals_keys, scope_class)
         end
+      # :nocov:
       else
-        # :nocov:
         def self.tilt_template_compiled_method(template, locals_keys, scope_class)
           template.send(:compiled_method, locals_keys)
         end
-        # :nocov:
+      # :nocov:
       end
 
       # Setup default rendering options.  See Render for details.
@@ -366,9 +366,7 @@ class Roda
           false
         end
 
-        # :nocov:
         if COMPILED_METHOD_SUPPORT
-        # :nocov:
           # Compile a method in the given module with the given name that will
           # call the compiled template method, updating the compiled template method
           def define_compiled_method(roda_class, method_name, locals_keys=EMPTY_ARRAY)
@@ -412,9 +410,7 @@ class Roda
       end
 
       module ClassMethods
-        # :nocov:
         if COMPILED_METHOD_SUPPORT
-        # :nocov:
           # If using compiled methods and there is an optimized layout, speed up
           # access to the layout method to improve the performance of view.
           def freeze
@@ -437,9 +433,7 @@ class Roda
         def inherited(subclass)
           super
           opts = subclass.opts[:render] = subclass.opts[:render].dup
-          # :nocov:
           if COMPILED_METHOD_SUPPORT
-          # :nocov:
             opts[:template_method_cache] = (opts[:cache_class] || RodaCache).new
           end
           opts[:cache] = opts[:cache].dup
@@ -459,9 +453,7 @@ class Roda
             instance = allocate
             instance.send(:retrieve_template, instance.send(:view_layout_opts, OPTS))
 
-            # :nocov:
             if COMPILED_METHOD_SUPPORT
-            # :nocov:
               if (layout_template = render_opts[:optimize_layout]) && !opts[:render][:optimized_layout_method_created]
                 instance.send(:retrieve_template, :template=>layout_template, :cache_key=>nil, :template_method_cache_key => :_roda_layout)
                 layout_method = opts[:render][:template_method_cache][:_roda_layout]
@@ -610,7 +602,6 @@ class Roda
             end
           end
         else
-          # :nocov:
           def _cached_template_method(_)
             nil
           end
@@ -630,7 +621,6 @@ class Roda
           def _optimized_view_content(template)
             nil
           end
-          # :nocov:
         end
 
 

data/lib/roda/plugins/render_each.rb

@@ -109,11 +109,9 @@ class Roda
             end.join
           end
         else
-          # :nocov:
           def _cached_render_each_template_method(template)
             nil
           end
-          # :nocov:
         end
       end
     end

data/lib/roda/plugins/render_locals.rb

@@ -43,9 +43,7 @@ class Roda
       module InstanceMethods
         private
 
-        # :nocov:
         if Render::COMPILED_METHOD_SUPPORT
-        # :nocov:
           # Disable use of cached templates, since it assumes a render/view call with no
           # options will have no locals.
           def _cached_template_method(template)

data/lib/roda/plugins/sinatra_helpers.rb

@@ -4,9 +4,7 @@ require 'rack/mime'
 begin
   require 'rack/files'
 rescue LoadError
-  # :nocov:
   require 'rack/file'
-  # :nocov:
 end
 
 
@@ -225,9 +223,7 @@ class Roda
       ISO88591_ENCODING = Encoding.find('ISO-8859-1')
       BINARY_ENCODING = Encoding.find('BINARY')
 
-      # :nocov:
       RACK_FILES = defined?(Rack::Files) ? Rack::Files : Rack::File
-      # :nocov:
 
       # Depend on the status_303 plugin.
       def self.load_dependencies(app, _opts = nil)
@@ -351,10 +347,8 @@ class Roda
           s, h, b = if Rack.release > '2'
             file.serving(self, path)
           else
-            # :nocov:
             file.path = path
             file.serving(@env)
-            # :nocov:
           end
 
           res.status = opts[:status] || s

data/lib/roda/plugins/status_handler.rb

@@ -45,11 +45,9 @@ class Roda
           when nil, false
             CLEAR_HEADERS
           when Array
-            # :nocov:
-            if Rack.release >= '2.3'
+            if Rack.release >= '3'
               keep_headers = keep_headers.map(&:downcase)
             end
-            # :nocov:
             lambda{|headers| headers.delete_if{|k,_| !keep_headers.include?(k)}}
           else
             raise RodaError, "Invalid :keep_headers option"

data/lib/roda/plugins/view_options.rb

@@ -126,9 +126,7 @@ class Roda
 
         private
 
-        # :nocov:
         if Render::COMPILED_METHOD_SUPPORT
-        # :nocov:
           # Return nil if using custom view or layout options.
           # If using a view subdir, prefix the template key with the subdir.
           def _cached_template_method_key(template)

data/lib/roda/request.rb

@@ -1,18 +1,16 @@
 # frozen-string-literal: true
 
-# :nocov:
 begin
   require "rack/version"
 rescue LoadError
   require "rack"
 else
-  if Rack.release >= '2.3'
+  if Rack.release >= '3'
     require "rack/request"
   else
     require "rack"
   end
 end
-# :nocov:
 
 require_relative "cache"
 
@@ -129,8 +127,7 @@ class Roda
           "#<#{self.class.inspect} #{@env["REQUEST_METHOD"]} #{path}>"
         end
 
-        # :nocov:
-        if Rack.release >= '2.3'
+        if Rack.release >= '3'
           def http_version
             # Prefer SERVER_PROTOCOL as it is required in Rack 3.
             # Still fall back to HTTP_VERSION if SERVER_PROTOCOL
@@ -139,7 +136,6 @@ class Roda
             @env['SERVER_PROTOCOL'] || @env['HTTP_VERSION']
           end
         else
-        # :nocov:
           # What HTTP version the request was submitted with.
           def http_version
             # Prefer HTTP_VERSION as it is backwards compatible

data/lib/roda/response.rb

@@ -42,7 +42,6 @@ class Roda
         # code for non-empty responses and a 404 code for empty responses.
         attr_accessor :status
 
-        # :nocov:
         if defined?(Rack::Headers) && Rack::Headers.is_a?(Class)
           # Set the default headers when creating a response.
           def initialize
@@ -51,7 +50,6 @@ class Roda
             @length  = 0
           end
         else
-        # :nocov:
           # Set the default headers when creating a response.
           def initialize
             @headers = {}
@@ -173,7 +171,6 @@ class Roda
 
         private
 
-        # :nocov:
         if Rack.release < '2.0.2'
           # Don't use a content length for empty 205 responses on
           # rack 1, as it violates Rack::Lint in that version.
@@ -181,7 +178,6 @@ class Roda
             headers.delete("Content-Type")
             headers.delete("Content-Length")
           end
-        # :nocov:
         else
           # Set the content length for empty 205 responses to 0
           def empty_205_headers(headers)

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 = 59
+  RodaMinorVersion = 60
 
   # 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.59.0
+  version: 3.60.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -232,6 +232,7 @@ extra_rdoc_files:
 - doc/release_notes/3.58.0.txt
 - doc/release_notes/3.59.0.txt
 - doc/release_notes/3.6.0.txt
+- doc/release_notes/3.60.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
 - doc/release_notes/3.9.0.txt
@@ -298,6 +299,7 @@ files:
 - doc/release_notes/3.58.0.txt
 - doc/release_notes/3.59.0.txt
 - doc/release_notes/3.6.0.txt
+- doc/release_notes/3.60.0.txt
 - doc/release_notes/3.7.0.txt
 - doc/release_notes/3.8.0.txt
 - doc/release_notes/3.9.0.txt
@@ -359,6 +361,7 @@ files:
 - lib/roda/plugins/inject_erb.rb
 - lib/roda/plugins/json.rb
 - lib/roda/plugins/json_parser.rb
+- lib/roda/plugins/link_to.rb
 - lib/roda/plugins/mail_processor.rb
 - lib/roda/plugins/mailer.rb
 - lib/roda/plugins/match_affix.rb