roda 3.30.0 → 3.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40d384d8a60174df9dcfdb645c5bf607232c44012827659d06691561666d2a74
-  data.tar.gz: 7f8cfedfb18a5125be0cbc7bb77cd60b45f2f869717ae163c9779be3bc054264
+  metadata.gz: 2d6d28c0f8b5197ab3d2a74726150921a435ccdcd8f18c6eb2c9bbe4d1cb2a14
+  data.tar.gz: f1464284c0cb20638bc7575769271c6ea39642ff3b1842fad33b92759db915cd
 SHA512:
-  metadata.gz: d5619d3e9ac99a426662057ba932ae8477d251e8252710f9fce7b33ffb5ccaec45673c3b933906d71e45ec1b4be6444467d5d7ad3be04df6123b66e19432ea4f
-  data.tar.gz: 0da11db1409e19bf6a11b5c2f9e88da573b9e00175de4bf753da1fab2d4877a1ef84013a5194d349237fbc362205efccbc03fd0b56ba800fc6e903583baf9cf1
+  metadata.gz: 4fca0abe3d0072e0a3e7201a089fd708610933ce4d461496bb0c13cbf7d84d2d10010c4007c460953972070d782742dba4d88799fd608f3df1ef7cca58cecef1
+  data.tar.gz: 189a647f809aa732baebc225ea313c59e543d0d0935c8008a85084694161753e0939a7cac4c1f9d010e03785ec792d49b6c3e5643925066e1cda12d0b7701237

data/CHANGELOG

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

data/doc/release_notes/3.31.0.txt

@@ -0,0 +1,11 @@
+= New Features
+
+* A relative_paths 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/lib/roda/plugins/assets.rb

@@ -325,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
@@ -647,10 +651,9 @@ class Roda
             end
           end
 
-          if relative_paths && (slash_count = request.path.count('/')) >= 1
-            relative_prefix = "../" * (slash_count - 1)
+          if relative_paths
             paths.map! do |path|
-              "#{relative_prefix}#{path.slice(1,100000000)}"
+              "#{relative_prefix}#{path}"
             end
           end
 

data/lib/roda/plugins/path.rb

@@ -55,6 +55,8 @@ class Roda
     # :add_script_name :: Prefix the path generated with SCRIPT_NAME. This defaults to the app's
     #                     :add_script_name option.
     # :name :: Provide a different name for the method, instead of using <tt>*_path</tt>.
+    # :relative :: Generate paths relative to the current request instead of absolute paths by prepending
+    #              an appropriate prefix.  This implies :add_script_name.
     # :url :: Create a url method in addition to the path method, which will prefix the string generated
     #         with the appropriate scheme, host, and port.  If true, creates a <tt>*_url</tt>
     #         method.  If a Symbol or String, uses the value as the url method name.
@@ -121,16 +123,31 @@ class Roda
 
           meth = opts[:name] || "#{name}_path"
           url = opts[:url]
+          url_only = opts[:url_only]
+          relative = opts[:relative]
           add_script_name = opts.fetch(:add_script_name, self.opts[:add_script_name])
 
-          if add_script_name || url || opts[:url_only]
+          if relative
+            if (url || url_only)
+              raise RodaError,  "cannot provide :url or :url_only option if using :relative option"
+            end
+            add_script_name = true
+            plugin :relative_path
+          end
+
+          if add_script_name || url || url_only || relative
             _meth = "_#{meth}"
             define_method(_meth, &block)
             private _meth
           end
 
-          unless opts[:url_only]
-            if add_script_name
+          unless url_only
+            if relative
+              define_method(meth) do |*a, &blk|
+                # Allow calling private _method to get path
+                relative_path(request.script_name.to_s + send(_meth, *a, &blk))
+              end
+            elsif add_script_name
               define_method(meth) do |*a, &blk|
                 # Allow calling private _method to get path
                 request.script_name.to_s + send(_meth, *a, &blk)
@@ -140,7 +157,7 @@ class Roda
             end
           end
 
-          if url || opts[:url_only]
+          if url || url_only
             url_meth = if url.is_a?(String) || url.is_a?(Symbol)
               url
             else

data/lib/roda/plugins/relative_path.rb

@@ -0,0 +1,73 @@
+# frozen-string-literal: true
+
+#
+class Roda
+  module RodaPlugins
+    # The relative_path plugin adds a relative_path method that accepts
+    # an absolute path and returns a path relative to the current request
+    # by adding an appropriate prefix:
+    #
+    #   plugin :relative_path
+    #   route do |r|
+    #     relative_path("/foo")
+    #   end
+    #
+    #   # GET /
+    #   "./foo"
+    #
+    #   # GET /bar
+    #   "./foo"
+    #
+    #   # GET /bar/
+    #   "../foo"
+    #
+    #   # GET /bar/baz/quux
+    #   "../../foo"
+    #
+    # It also offers a relative_prefix method that returns a string that can
+    # be prepended to an absolute path.  This can be more efficient if you
+    # need to convert multiple paths.
+    #
+    # This plugin is mostly designed for applications using Roda as a static
+    # site generator, where the generated site can be hosted at any subpath.
+    module RelativePath
+      module InstanceMethods
+        # Return a relative path for the absolute path based on the current path
+        # of the request by adding the appropriate prefix.
+        def relative_path(absolute_path)
+          relative_prefix + absolute_path
+        end
+
+        # Return a relative prefix to append to an absolute path to a relative path
+        # based on the current path of the request.
+        def relative_prefix
+          env = @_request.env
+          script_name = env["SCRIPT_NAME"]
+          path_info = env["PATH_INFO"]
+
+          # Check path begins with slash.  All valid paths should, but in case this
+          # request is bad, just skip using a relative prefix.
+          case script_name.getbyte(0)
+          when nil # SCRIPT_NAME empty
+            unless path_info.getbyte(0) == 47 # PATH_INFO starts with /
+              return ''
+            end
+          when 47 # SCRIPT_NAME starts with /
+            # nothing
+          else
+            return ''
+          end
+
+          slash_count = script_name.count('/') + path_info.count('/')
+          if slash_count > 1
+            ("../" * (slash_count - 2)) << ".."
+          else
+            "."
+          end
+        end
+      end
+    end
+
+    register_plugin(:relative_path, RelativePath)
+  end
+end

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 = 30
+  RodaMinorVersion = 31
 
   # 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.30.0
+  version: 3.31.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-13 00:00:00.000000000 Z
+date: 2020-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -206,6 +206,7 @@ extra_rdoc_files:
 - doc/release_notes/3.28.0.txt
 - doc/release_notes/3.29.0.txt
 - doc/release_notes/3.30.0.txt
+- doc/release_notes/3.31.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -237,6 +238,7 @@ files:
 - doc/release_notes/3.29.0.txt
 - doc/release_notes/3.3.0.txt
 - doc/release_notes/3.30.0.txt
+- doc/release_notes/3.31.0.txt
 - doc/release_notes/3.4.0.txt
 - doc/release_notes/3.5.0.txt
 - doc/release_notes/3.6.0.txt
@@ -316,6 +318,7 @@ files:
 - lib/roda/plugins/placeholder_string_matchers.rb
 - lib/roda/plugins/precompile_templates.rb
 - lib/roda/plugins/public.rb
+- lib/roda/plugins/relative_path.rb
 - lib/roda/plugins/render.rb
 - lib/roda/plugins/render_each.rb
 - lib/roda/plugins/render_locals.rb