roda 3.32.0 → 3.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a342192f0ab697bea9c4e5b55669644f06fe16e161539b1efc3d10f3c6b9947
-  data.tar.gz: cf01944fe14494efd606cd892cbbbae5b5128f5a1d83c5e411bd4c64cc6e4321
+  metadata.gz: 0f9ede53406b16bff69c2115f7d35e808835e300ca866a5caadde9b9fad9d206
+  data.tar.gz: f78eb239a3d15e83879b8a7272f07959a00b6d94e93595f6871841144d3d718b
 SHA512:
-  metadata.gz: e5de72f1385942855bd2c8e1c0f6be5187430d7d83112d7400bc573f045456a445166edfdbb6a7f70779c7b008745e8063bd44274b0111dec95643f87cfe12fe
-  data.tar.gz: b69e2fb41045d19c1f9e79dd2d1a87ca691fcd8de975bd34e37456cd6c5183cd2a6ad6bb59a07594527588d2903ef1bceea5f356a809aef03c01e5f64415246b
+  metadata.gz: 45e3020a3509bacc5f39107659fca5e64ba25c322c18af6a62b976308f5bac2ac44a18d54bc82d9b1d4260e260883208ce8210ac2fb660e09b63b65401abfed6
+  data.tar.gz: 5a00af14f4d6e01c472a23b59f5a51eec66fc55c2d8d34069de869d7ff487913ff6ab1d21023b8207f5fdf18ad6354f30520b3cf89d2491de4b330c1ae30f10a

data/CHANGELOG

@@ -1,3 +1,9 @@
+= 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)

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.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/plugins/path.rb

@@ -10,7 +10,8 @@ class Roda
     #
     # Additionally, you can call the +path+ class method with a class and a block, and it will register
     # the class.  You can then call the +path+ instance method with an instance of that class, and it will
-    # execute the block in the context of the route block scope with the arguments provided to path.
+    # execute the block in the context of the route block scope with the arguments provided to path. You
+    # can call the +url+ instance method with the same arguments as the +path+ method to get the full URL.
     #
     # Example:
     #
@@ -46,11 +47,11 @@ class Roda
     #
     #     r.post 'quux' do
     #       bar = Quux[1]
-    #       r.redirect path(quux, '/bar') # /quux/1/bar
+    #       r.redirect url(quux, '/bar') # http://example.com/quux/1/bar
     #     end
     #   end
     #
-    # The path method accepts the following options when not called with a class:
+    # The path class method accepts the following options when not called with a class:
     #
     # :add_script_name :: Prefix the path generated with SCRIPT_NAME. This defaults to the app's
     #                     :add_script_name option.
@@ -62,7 +63,7 @@ class Roda
     #         method.  If a Symbol or String, uses the value as the url method name.
     # :url_only :: Do not create a path method, just a url method.
     #
-    # Note that if :add_script_name, :url, or :url_only is used, the path method will also create a
+    # Note that if :add_script_name, :relative, :url, or :url_only is used, the path method will also create a
     # <tt>_*_path</tt> private method.
     module Path
       DEFAULT_PORTS = {'http' => 80, 'https' => 443}.freeze
@@ -165,14 +166,8 @@ class Roda
             end
 
             url_block = lambda do |*a, &blk|
-              r = request
-              scheme = r.scheme
-              port = r.port
-              uri = ["#{scheme}://#{r.host}#{":#{port}" unless DEFAULT_PORTS[scheme] == port}"]
-              uri << request.script_name.to_s if add_script_name
               # Allow calling private _method to get path
-              uri << send(_meth, *a, &blk)
-              File.join(uri)
+              "#{_base_url}#{request.script_name if add_script_name}#{send(_meth, *a, &blk)}"
             end
 
             define_method(url_meth, &url_block)
@@ -207,6 +202,21 @@ class Roda
           path = request.script_name.to_s + path if opts[:add_script_name]
           path
         end
+
+        # Similar to #path, but returns a complete URL.
+        def url(*args, &block)
+          "#{_base_url}#{path(*args, &block)}"
+        end
+
+        private
+
+        # The string to prepend to the path to make the path a URL.
+        def _base_url
+          r = @_request
+          scheme = r.scheme
+          port = r.port
+          "#{scheme}://#{r.host}#{":#{port}" unless DEFAULT_PORTS[scheme] == port}"
+        end
       end
     end
 

data/lib/roda/plugins/public.rb

@@ -42,6 +42,8 @@ class Roda
       # :default_mime :: The default mime type to use if the mime type is not recognized.
       # :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.
       # :headers :: A hash of headers to use for statically served files
       # :root :: Use this option for the root of the public directory (default: "public")
       def self.configure(app, opts={})
@@ -52,6 +54,7 @@ class Roda
         end
         app.opts[:public_server] = ::Rack::File.new(app.opts[:public_root], opts[:headers]||{}, opts[:default_mime] || 'text/plain')
         app.opts[:public_gzip] = opts[:gzip]
+        app.opts[:public_brotli] = opts[:brotli]
       end
 
       module RequestMethods
@@ -65,23 +68,8 @@ class Roda
             server = roda_opts[:public_server]
             path = ::File.join(server.root, *public_path_segments(path))
 
-            if roda_opts[:public_gzip] && env['HTTP_ACCEPT_ENCODING'] =~ /\bgzip\b/
-              gzip_path = path + '.gz'
-
-              if public_file_readable?(gzip_path)
-                res = public_serve(server, gzip_path)
-                headers = res[1]
-
-                unless res[0] == 304
-                  if mime_type = ::Rack::Mime.mime_type(::File.extname(path), 'text/plain')
-                    headers['Content-Type'] = mime_type
-                  end
-                  headers['Content-Encoding'] = 'gzip'
-                end
-
-                halt res
-              end
-            end
+            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 public_file_readable?(path)
               halt public_serve(server, path)
@@ -113,6 +101,26 @@ class Roda
           # :nocov:
         end
 
+        def public_serve_compressed(server, path, suffix, encoding)
+          if env['HTTP_ACCEPT_ENCODING'] =~ /\b#{encoding}\b/
+            compressed_path = path + suffix
+
+            if public_file_readable?(compressed_path)
+              res = public_serve(server, compressed_path)
+              headers = res[1]
+
+              unless res[0] == 304
+                if mime_type = ::Rack::Mime.mime_type(::File.extname(path), 'text/plain')
+                  headers['Content-Type'] = mime_type
+                end
+                headers['Content-Encoding'] = encoding
+              end
+
+              halt res
+            end
+          end
+        end
+
         if ::Rack.release > '2'
           # Serve the given path using the given Rack::File server.
           def public_serve(server, path)

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 = 32
+  RodaMinorVersion = 33
 
   # 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.32.0
+  version: 3.33.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -208,6 +208,7 @@ extra_rdoc_files:
 - doc/release_notes/3.30.0.txt
 - doc/release_notes/3.31.0.txt
 - doc/release_notes/3.32.0.txt
+- doc/release_notes/3.33.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -241,6 +242,7 @@ files:
 - doc/release_notes/3.30.0.txt
 - doc/release_notes/3.31.0.txt
 - doc/release_notes/3.32.0.txt
+- doc/release_notes/3.33.0.txt
 - doc/release_notes/3.4.0.txt
 - doc/release_notes/3.5.0.txt
 - doc/release_notes/3.6.0.txt