roda 3.28.0 → 3.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2de9e0d72db9d2f1d1143c71738067798dbcc3f2786611f8f0a5f85c32f26167
-  data.tar.gz: 92645c4e9792b1217cfae3d8b430741f64212a30003cf81b393c37636dc531c0
+  metadata.gz: 0f9ede53406b16bff69c2115f7d35e808835e300ca866a5caadde9b9fad9d206
+  data.tar.gz: f78eb239a3d15e83879b8a7272f07959a00b6d94e93595f6871841144d3d718b
 SHA512:
-  metadata.gz: 35a615a610ca645130cbd15482f6864a50a3a8727e6e4cf7bad8d63a00e40118f7a0443f88931ec24a5f416ae822a9bd8ebc101f930efff178831660d5125849
-  data.tar.gz: a6b9f48cfe249297ce8abfd3a856c65634364ea0490910b956f25fe4cd54c4b77096bd980a59276e6ed0fb4db537e99fa8b4e1e0e35441afaaf942ca7e92bb02
+  metadata.gz: 45e3020a3509bacc5f39107659fca5e64ba25c322c18af6a62b976308f5bac2ac44a18d54bc82d9b1d4260e260883208ce8210ac2fb660e09b63b65401abfed6
+  data.tar.gz: 5a00af14f4d6e01c472a23b59f5a51eec66fc55c2d8d34069de869d7ff487913ff6ab1d21023b8207f5fdf18ad6354f30520b3cf89d2491de4b330c1ae30f10a

data/CHANGELOG

@@ -1,3 +1,43 @@
+= 3.33.0 (2020-06-16)
+
+* Add :brotli option to public plugin to supplement it to serve brotli-compressed files like :gzip does for gzipped files (hmdne) (#194)
+
+* Add url method to path plugin, similar to path but returning the entire URL (jeremyevans)
+
+= 3.32.0 (2020-05-15)
+
+* Make :dependencies option in assets plugin work correctly with render plugin template caching (jeremyevans) (#191)
+
+* Support render method :dependencies option for specifying which files to check for modification (jgarth, jeremyevans) (#192)
+
+* Add each_partial to the partials plugin for rendering a partial for each element in an enumerable (jeremyevans)
+
+* Make render_each in render_each plugin handle template names with directories and extensions (jeremyevans)
+
+= 3.31.0 (2020-04-15)
+
+* Add :relative option to path method in path plugin, for generating a method returning relative paths (jeremyevans)
+
+* Add relative_path plugin, for turning absolute paths to paths relative to the current request (jeremyevans)
+
+= 3.30.0 (2020-03-13)
+
+* Support :relative_paths assets plugin option to use relative paths for the assets (jeremyevans)
+
+* Make run_append_slash and run_handler plugins work when used together (janko) (#185)
+
+* Make :header matcher in header_matchers plugin work for Content-Type and Content-Length (jeremyevans) (#184)
+
+= 3.29.0 (2020-02-14)
+
+* Remove specs and old release notes from the gem to reduce gem size by over 35% (jeremyevans)
+
+* Raise RodaError if trying to load a plugin that is not a module (jeremyevans)
+
+* Include SCRIPT_NAME when logging in common logger plugin (jeremyevans)
+
+* Handle invalid POST data when using the exception_page plugin (jeremyevans)
+
 = 3.28.0 (2020-01-15)
 
 * Add session_created_at and session_updated_at methods to the sessions plugin (jeremyevans)

data/README.rdoc

@@ -137,6 +137,16 @@ in your application.  It is recommended to freeze the app in production and
 during testing.  The +.app+ is an optimization, which saves a few method calls
 for every request.
 
+== Running the Application
+
+Running a Roda application is similar to running any other rack-based application
+that uses a +config.ru+ file.  You can start a basic server using +rackup+:
+
+  $ rackup
+
+Ruby web servers such as Unicorn and Puma also ship with their own programs
+that you can use to run a Roda application.
+
 == The Routing Tree
 
 Roda is called a routing tree web toolkit because the way most sites are structured,
@@ -408,6 +418,10 @@ You can provide an array to specify multiple request methods and match on any of
   {method: :post}             # matches POST
   {method: ['post', 'patch']} # matches POST and PATCH
 
+=== true
+
+If +true+ is given directly as a matcher, it always matches.
+
 === false, nil
 
 If +false+ or +nil+ is given directly as a matcher, it doesn't match anything.
@@ -1097,7 +1111,7 @@ Roda's plugin system is based on the plugin system used by
 
 Roda fully supports the currently supported versions of Ruby (MRI) and JRuby.  It may
 support unsupported versions of Ruby or JRuby, but such support may be dropped in any
-minor version of keeping it becomes a support issue.  The minimum Ruby version
+minor version if keeping it becomes a support issue.  The minimum Ruby version
 required to run the current version of Roda is 1.9.2.
 
 == License

data/doc/conventions.rdoc

@@ -15,6 +15,8 @@ For a small application, the following directory layout is recommended:
   Rakefile
   app_name.rb
   assets/
+  config.ru
+  db.rb
   migrate/
   models.rb
   models/
@@ -25,6 +27,8 @@ For a small application, the following directory layout is recommended:
 +app_name.rb+ should contain the Roda application, and should reflect the name of your application.
 So, if your application is named +FooBar+, you should use +foo_bar.rb+.
 
++config.ru+ should contain the code the webserver uses to determine which application to run.
+
 +views/+ should contain your template files.  This assumes you are using the +render+ plugin
 and server-side rendering.  If you are creating a single page application and just serving
 JSON, then you won't need a +views+ directory.  For small applications, all view files should be
@@ -36,7 +40,11 @@ Again, for pure JSON applications, you won't need a +public+ directory.
 +assets/+ should contain the source files for your CSS and javascript assets.  If you are
 not using the +assets+ plugin, you won't need an +assets+ directory.
 
-+models.rb+ should contain all code related to your database/ORM.  This file should be required
++db.rb+ should contain the minimum code to setup a database connection, without loading any of
+the applications models.  This can be required in cases where you don't want the models loaded,
+such as when running migrations. This file should be required by +models.rb+.
+
++models.rb+ should contain all code related to your ORM.  This file should be required
 by +app_name.rb+.  This keeps your model code separate from your web code, making it easier
 to use outside of your web code. It allows you to get an IRB shell for accessing your models
 via <tt>irb -r ./models</tt>, without loading the Roda application.
@@ -46,7 +54,7 @@ via irb -r ./models, without loading the Roda application.
 +migrate/+ should create your database migration files, if you are using an ORM that uses
 migrations.
 
-+spec/+ should contain your specifications/tests.  For a small application, it's recommended
++spec/+ (or +test/+ should contain your specifications/tests.  For a small application, it's recommended
 to a have a single file for your model tests, and a single file for your web/integration tests.
 
 +Rakefile+ should contain the rake tasks for the application.  The convention is that the
@@ -83,7 +91,8 @@ The routes used by the +hash_routes+ or +multi_run+ should be stored in routing
 directory, with one file per prefix.
 
 For specs/tests, you should have +spec/models/+ and +spec/web/+, with one file per model in +spec/models/+
-and one file per prefix in +spec/web/+.
+and one file per prefix in +spec/web/+. Substitute +spec+ with +test+ if that is what you are using as the
+name of the directory.
 
 You should have a separate view subdirectory per prefix. If you are using +hash_routes+ and +view_options+ plugins,
 use +set_view_subdir+ in your routing files to specify the subdirectory to use, so it doesn't need to be
@@ -105,7 +114,7 @@ subdirectories in the +routes/+ directory, and nested subdirectories in the +vie
 For a small application, the convention in Roda is to layout your Roda application file (+app_name.rb+) like this:
 
   require 'roda'
-  require './models'
+  require_relative 'models'
 
   class AppName < Roda
     SOME_CONSTANT = 1
@@ -138,24 +147,24 @@ used in your route block or views.
 For larger applications, there are some slight changes to the Roda application file layout:
 
   require 'roda'
-  require './models'
+  require_relative 'models'
 
   class AppName < Roda
     SOME_CONSTANT = 1
 
     use SomeMiddleware
 
-    plugin :render, escape: true
+    plugin :render, escape: true, layout: './layout'
     plugin :assets
     plugin :view_options
     plugin :hash_routes
-    Dir['./routes/*.rb'].each{|f| require f}
+    Dir['routes/*.rb'].each{|f| require_relative f}
 
     route do |r|
       r.hash_routes
     end
 
-    Dir['./helpers/*.rb'].each{|f| require f}
+    Dir['helpers/*.rb'].each{|f| require_relative f}
   end
 
 After loading the +view_options+ and +hash_routes+ plugin, you require all of your

data/doc/release_notes/3.29.0.txt

@@ -0,0 +1,15 @@
+= Improvements
+
+* The common_logger plugin now includes the SCRIPT_NAME when
+  logging, for greater compatibility with typical web server
+  logs.
+
+* The exception_page plugin now handles invalid POST data.
+  Previously, invalid POST data would cause the exception page
+  display to raise an exception.
+
+* An error is now raised if trying to load a plugin that is not a
+  module or a recognized plugin symbol.
+
+* Specs and older release notes are no longer shipped in the
+  gem, reducing gem size by over 35%.

data/doc/release_notes/3.30.0.txt

@@ -0,0 +1,14 @@
+= New Features
+
+* A :relative_paths plugin option has been added to the assets
+  plugin.  This option makes the paths to the asset files in the
+  link and script tags relative paths instead of absolute paths.
+
+= Other Improvements
+
+* The :header matcher in the header_matchers plugin now works
+  correctly for the Content-Type and Content-Length headers, which
+  are not prefixed with HTTP_ in the rack environment.
+
+* The run_append_slash and run_handler plugins now work correctly
+  when used together.

data/doc/release_notes/3.31.0.txt

@@ -0,0 +1,11 @@
+= New Features
+
+* A relative_path plugin has been added, adding a relative_path
+  method that will take an absolute path and make it relative to the
+  current request by prepending an appropriate prefix.  This is
+  helpful when using Roda as a static site generator to generate a
+  site that can be hosted at any subpath or directly from the
+  filesystem.
+
+* In the path plugin, the path method now accepts a :relative
+  option for generating relative paths instead of absolute paths.

data/doc/release_notes/3.32.0.txt

@@ -0,0 +1,42 @@
+= New Features
+
+* render_each in the render_each plugin now automatically handles
+  template names with subdirectories and extensions.  Previously, these
+  caused issues unless the :local option was provided.  So now you
+  can use:
+
+    render_each(foos, "items/foo")
+
+  instead of:
+
+    render_each(foos, "items/foo", :local=>:foo)
+
+* each_partial has been added to the partials plugin.  It operates
+  similarly to render_each, but uses the convention for partial
+  template naming.  So this:
+
+    each_partial(foos, "items/foo")
+
+  is the same as:
+
+    render_each(foos, "items/_foo", :local=>:foo)
+
+= Other Improvements
+
+* The :dependencies option in the assets plugin now works correctly
+  with compiled templates in the render plugin in uncached mode
+  (the default in development).  Previously, modifying a dependency
+  file would not result in recompiling the asset template when
+  requesting the main file.
+
+* Method visibility issues in the following plugins have been fixed:
+
+  * content_security_policy
+  * default_headers
+  * indifferent_params
+  * placeholder_string_matchers
+  * symbol_matchers
+
+  Previously, these plugins made private methods public by mistake
+  when overriding them.  Additionally, Roda.freeze no longer changes
+  the visibility of the set_default_headers private method.

data/doc/release_notes/3.33.0.txt

@@ -0,0 +1,8 @@
+= New Features
+
+* The path plugin now supports a url method, allowing for returning
+  the entire URL instead of just the path for class-based paths.
+
+* The public plugin now supports a :brotli option that will directly
+  serve brotli-compressed files (with .br extension) similar to how the
+  :gzip option directly serves gzipped files (with the .gz extension).

data/lib/roda.rb

@@ -197,6 +197,8 @@ class Roda
               if instance_method(:set_default_headers).owner == ResponseMethods &&
                  instance_method(:default_headers).owner == ResponseMethods
 
+                private
+
                 def set_default_headers
                   @headers['Content-Type'] ||= 'text/html'
                 end
@@ -269,6 +271,7 @@ class Roda
         def plugin(plugin, *args, &block)
           raise RodaError, "Cannot add a plugin to a frozen Roda class" if frozen?
           plugin = RodaPlugins.load_plugin(plugin) if plugin.is_a?(Symbol)
+          raise RodaError, "Invalid plugin type: #{plugin.class.inspect}" unless plugin.is_a?(Module)
           plugin.load_dependencies(self, *args, &block) if plugin.respond_to?(:load_dependencies)
           include(plugin::InstanceMethods) if defined?(plugin::InstanceMethods)
           extend(plugin::ClassMethods) if defined?(plugin::ClassMethods)

data/lib/roda/plugins/_symbol_regexp_matchers.rb

@@ -8,6 +8,8 @@ class Roda
     # using a regexp.
     module SymbolRegexpMatchers
       module RequestMethods
+        private
+
         # The regular expression to use for matching symbols.  By default, any non-empty
         # segment matches.
         def _match_symbol_regexp(s)

data/lib/roda/plugins/assets.rb

@@ -291,6 +291,8 @@ class Roda
     #                 non-compiled mode, but will write the metadata to the file if compile_assets is called.
     # :public :: Path to your public folder, in which compiled files are placed (default: 'public').  Relative
     #            paths will be considered relative to the application's :root option.
+    # :relative_paths :: Use relative paths instead of absolute paths when setting up link and script tags for
+    #                    assets.
     # :sri :: Enables subresource integrity when setting up references to compiled assets. The value should be
     #         :sha256, :sha384, or :sha512 depending on which hash algorithm you want to use.  This changes the
     #         hash algorithm that Roda will use when naming compiled asset files. The default is :sha256, you
@@ -323,10 +325,14 @@ class Roda
 
       # Load the render, caching, and h plugins, since the assets plugin
       # depends on them.
-      def self.load_dependencies(app, _opts = nil)
+      def self.load_dependencies(app, opts = OPTS)
         app.plugin :render
         app.plugin :caching
         app.plugin :h
+
+        if opts[:relative_paths]
+          app.plugin :relative_path
+        end
       end
 
       # Setup the options for the plugin.  See the Assets module RDoc
@@ -399,6 +405,11 @@ class Roda
           opts[s] ||= {} 
         end
 
+        expanded_deps = opts[:expanded_dependencies] = {}
+        opts[:dependencies].each do |file, deps|
+          expanded_deps[File.expand_path(file)] = Array(deps)
+        end
+
         if headers = opts[:headers]
           opts[:css_headers] = headers.merge(opts[:css_headers])
           opts[:js_headers]  = headers.merge(opts[:js_headers])
@@ -406,7 +417,7 @@ class Roda
         opts[:css_headers]['Content-Type'] ||= "text/css; charset=UTF-8".freeze
         opts[:js_headers]['Content-Type']  ||= "application/javascript; charset=UTF-8".freeze
 
-        [:css_headers, :js_headers, :css_opts, :js_opts, :dependencies].each do |s|
+        [:css_headers, :js_headers, :css_opts, :js_opts, :dependencies, :expanded_dependencies].each do |s|
           opts[s].freeze
         end
         [:headers, :css, :js].each do |s|
@@ -621,8 +632,10 @@ class Roda
           stype = ltype.to_s
 
           url_prefix = request.script_name if self.class.opts[:add_script_name]
+          relative_paths = o[:relative_paths]
 
-          if o[:compiled]
+          paths = if o[:compiled]
+            relative_paths = false if o[:compiled_asset_host]
             if ukey = _compiled_assets_hash(type, true)
               ["#{o[:compiled_asset_host]}#{url_prefix}/#{o[:"compiled_#{stype}_prefix"]}.#{ukey}.#{stype}"]
             else
@@ -642,6 +655,14 @@ class Roda
               "#{url_prefix}/#{o[:"#{stype}_prefix"]}#{mtime}#{prefix}#{f}#{o[:"#{stype}_suffix"]}"
             end
           end
+
+          if relative_paths
+            paths.map! do |path|
+              "#{relative_prefix}#{path}"
+            end
+          end
+
+          paths
         end
 
         # Return a string containing html tags for the given asset type.
@@ -716,7 +737,7 @@ class Roda
           content = if file.end_with?(".#{type}")
             ::File.read(file)
           else
-            render_asset_file(file, :template_opts=>o[:"#{type}_opts"])
+            render_asset_file(file, :template_opts=>o[:"#{type}_opts"], :dependencies=>o[:expanded_dependencies][file])
           end
 
           o[:postprocessor] ? o[:postprocessor].call(file, type, content) : content
@@ -746,7 +767,7 @@ class Roda
         # other files, check the modification times of all dependencies and
         # return the maximum.
         def asset_last_modified(file)
-          if deps = self.class.assets_opts[:dependencies][file]
+          if deps = self.class.assets_opts[:expanded_dependencies][file]
             ([file] + Array(deps)).map{|f| ::File.stat(f).mtime}.max
           else
             ::File.stat(file).mtime

data/lib/roda/plugins/caching.rb

@@ -1,5 +1,7 @@
 # frozen-string-literal: true
 
+require 'time'
+
 #
 class Roda
   module RodaPlugins

data/lib/roda/plugins/common_logger.rb

@@ -52,7 +52,7 @@ class Roda
 
           env = @_request.env
 
-          opts[:common_logger_meth].call("#{env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-"} - #{env["REMOTE_USER"] || "-"} [#{Time.now.strftime("%d/%b/%Y:%H:%M:%S %z")}] \"#{env["REQUEST_METHOD"]} #{env["PATH_INFO"]}#{"?#{env["QUERY_STRING"]}" if ((qs = env["QUERY_STRING"]) && !qs.empty?)} #{env["HTTP_VERSION"]}\" #{result[0]} #{((length = result[1]['Content-Length']) && (length unless length == '0')) || '-'} #{elapsed_time}\n")
+          opts[:common_logger_meth].call("#{env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-"} - #{env["REMOTE_USER"] || "-"} [#{Time.now.strftime("%d/%b/%Y:%H:%M:%S %z")}] \"#{env["REQUEST_METHOD"]} #{env["SCRIPT_NAME"]}#{env["PATH_INFO"]}#{"?#{env["QUERY_STRING"]}" if ((qs = env["QUERY_STRING"]) && !qs.empty?)} #{env["HTTP_VERSION"]}\" #{result[0]} #{((length = result[1]['Content-Length']) && (length unless length == '0')) || '-'} #{elapsed_time}\n")
         end
 
         # Create timer instance used for timing

data/lib/roda/plugins/content_security_policy.rb

@@ -304,6 +304,8 @@ class Roda
           @content_security_policy ||= roda_class.opts[:content_security_policy].dup
         end
 
+        private
+
         # Set the appropriate content security policy header.
         def set_default_headers
           super

data/lib/roda/plugins/default_headers.rb

@@ -31,6 +31,8 @@ class Roda
           if owner == Base::ResponseMethods || (owner == response_class && app.opts[:set_default_headers_overridder] == response_class)
             app.opts[:set_default_headers_overridder] = response_class
             response_class.class_eval(<<-END, __FILE__, __LINE__+1)
+              private
+
               def set_default_headers
                 h = @headers
                 #{headers.map{|k,v| "h[#{k.inspect}] ||= #{v.inspect}"}.join('; ')}

data/lib/roda/plugins/exception_page.rb

@@ -244,10 +244,10 @@ END
 
             frames = exception.backtrace.map.with_index do |line, i|
               frame = {:id=>i}
-              if line =~ /(.*?):(\d+)(:in `(.*)')?/
+              if line =~ /\A(.*?):(\d+)(?::in `(.*)')?\Z/
                 filename = frame[:filename] = $1
                 lineno = frame[:lineno] = $2.to_i
-                frame[:function] = $4
+                frame[:function] = $3
 
                 begin
                   lineno -= 1
@@ -261,12 +261,16 @@ END
                 end
 
                 frame
-              else
-                nil
               end
             end.compact
 
             r = @_request
+            begin 
+              post_data = r.POST
+              missing_post = "No POST data"
+            rescue
+              missing_post = "Invalid POST data"
+            end
             info = lambda do |title, id, var, none|
               <<END
   <h3 id="#{id}">#{title}</h3>
@@ -363,7 +367,7 @@ END1
   <h2>Request information</h2>
 
   #{info.call('GET', 'get-info', r.GET, 'No GET data')}
-  #{info.call('POST', 'post-info', r.POST, 'No POST data')}
+  #{info.call('POST', 'post-info', post_data, missing_post)}
   #{info.call('Cookies', 'cookie-info', r.cookies, 'No cookie data')}
   #{info.call('Rack ENV', 'env-info', r.env, 'No Rack env?')}
 </div>