bridgetown-routes 1.1.0 → 1.2.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a11374ed49fc22fc99092950f3d5dd0418b340c50d687d3f6ba836a045b53f33
-  data.tar.gz: 9498463a8902d6647538b808dbb779cbb9f35b6a978a32b1578b3472088a8bc7
+  metadata.gz: 0e3b03206a50338a4e3ad893d9fda292c90b153d53e55045b2e6d49f551af180
+  data.tar.gz: b3537ceca41ac4773208d1675a4b26033b333512df54fac27f0aa4cf8b4a66c5
 SHA512:
-  metadata.gz: 612470809a8fb20f6c5221cc0124fda5deb8c31c9ab4b73baf4bd43eab6e046deb2f7ec0b5e72e5ed538f465bb650fa14d56340eaab4fbdb4c7feda074a117d8
-  data.tar.gz: bd14cd6864fb78314de78b606e90a68ab4dcf6bd9f56f03aa7d9ca57d56110122b1602621a77b588eb961377ed2bd4ca03eed10c8fa2a4cf6f761a63251e71bb
+  metadata.gz: 50788587781e7305668e878421e4553c14236775f30a870ae3a61833fd941d92a3607dc7c00cc9ed75d20d21f9595adb39a5c14b84ebb5014d959c05e576ce3e
+  data.tar.gz: 2230eb95ef39cf36ece5125eae4150c6f1d9a050a92342313f53b5912b44921a61648226fd99809665f7c50dfb330eff9906b1a2aac42b1198f3f5007201992a

data/bridgetown-routes.gemspec

@@ -14,6 +14,13 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features)/!) }
   spec.require_paths = ["lib"]
 
+  spec.metadata      = {
+    "source_code_uri" => "https://github.com/bridgetownrb/bridgetown",
+    "bug_tracker_uri" => "https://github.com/bridgetownrb/bridgetown/issues",
+    "changelog_uri"   => "https://github.com/bridgetownrb/bridgetown/releases",
+    "homepage_uri"    => spec.homepage,
+  }
+
   spec.add_dependency("bridgetown-core", Bridgetown::VERSION)
   spec.add_dependency("roda-route_list", ">= 2.1")
 end

data/lib/bridgetown-routes/flash_additions.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Routes
+    module FlashHashAdditions
+      def info
+        self["info"]
+      end
+
+      def info=(val)
+        self["info"] = val
+      end
+
+      def alert
+        self["alert"]
+      end
+
+      def alert=(val)
+        self["alert"] = val
+      end
+    end
+
+    module FlashHashIndifferent
+      def []=(key, val)
+        @next[key.to_s] = val
+      end
+    end
+
+    module FlashNowHashIndifferent
+      def []=(key, val)
+        super(key.to_s, val)
+      end
+
+      def [](key)
+        super(key.to_s)
+      end
+    end
+  end
+end

data/lib/bridgetown-routes/manifest.rb

@@ -4,42 +4,51 @@ module Bridgetown
   module Routes
     module Manifest
       class << self
-        # TODO: make this extensible
-        def routable_extensions
-          %w(rb md serb erb liquid)
-        end
-
-        def generate_manifest # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
-          return @route_manifest if @route_manifest && Bridgetown.env.production?
-
-          routes_dir = Bridgetown::Current.site.in_source_dir("_routes")
-          # @type [Array]
-          routes = Dir.glob(
-            routes_dir + "/**/*.{#{routable_extensions.join(",")}}"
-          ).filter_map do |file|
-            if File.basename(file).start_with?("_", ".") ||
-                File.basename(file, ".*").end_with?(".test")
-              next
-            end
-
-            # @type [String]
-            file_slug = file.delete_prefix("#{routes_dir}/").then do |f|
-              [File.dirname(f), File.basename(f, ".*")].join("/").delete_prefix("./")
-            end.delete_suffix("/index")
-            segment_keys = []
-            file_slug.gsub!(%r{\[([^/]+)\]}) do |_segment|
-              segment_keys << Regexp.last_match(1)
-              ":#{Regexp.last_match(1)}"
+        def generate_manifest(site) # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+          return @route_manifest[site.label] if @route_manifest && Bridgetown.env.production?
+
+          new_manifest = []
+          routable_extensions = site.config.routes.extensions.join(",")
+
+          site.config.routes.source_paths.each do |routes_dir|
+            routes_dir = File.expand_path(routes_dir, site.config.source)
+
+            # @type [Array]
+            routes = Dir.glob(
+              routes_dir + "/**/*.{#{routable_extensions}}"
+            ).filter_map do |file|
+              if File.basename(file).start_with?("_", ".") ||
+                  File.basename(file, ".*").end_with?(".test")
+                next
+              end
+
+              # @type [String]
+              file_slug = file.delete_prefix("#{routes_dir}/").then do |f|
+                [File.dirname(f), File.basename(f, ".*")].join("/").delete_prefix("./")
+              end.delete_suffix("/index")
+              segment_keys = []
+              file_slug.gsub!(%r{\[([^/]+)\]}) do |_segment|
+                segment_keys << Regexp.last_match(1)
+                ":#{Regexp.last_match(1)}"
+              end
+
+              [file, file_slug, segment_keys]
             end
 
-            [file, file_slug, segment_keys]
+            new_manifest += sort_routes!(routes)
           end
+          @route_manifest ||= {}
+          @route_manifest[site.label] = new_manifest
+        end
 
+        def sort_routes!(routes)
           routes.sort! do |route_a, route_b|
             # @type [String]
             _, slug_a = route_a
+            # @type [String]
             _, slug_b = route_b
 
+            # @type [Integer]
             weight1 = slug_a.count("/") <=> slug_b.count("/")
             if weight1.zero?
               slug_b.count("/:") <=> slug_a.count("/:")
@@ -47,8 +56,6 @@ module Bridgetown
               weight1
             end
           end.reverse!
-
-          @route_manifest = routes
         end
       end
     end

data/lib/bridgetown-routes/{roda_router.rb → manifest_router.rb}

@@ -1,26 +1,27 @@
 # frozen_string_literal: true
 
+require "bridgetown-core/rack/routes"
+
 module Bridgetown
   module Routes
-    module RodaRouter
-      def self.start!(app) # rubocop:todo Metrics/MethodLength
-        unless Bridgetown::Current.site
+    class ManifestRouter < Bridgetown::Rack::Routes
+      priority :lowest
+
+      route do |r|
+        unless bridgetown_site
           Bridgetown.logger.warn(
             "The `bridgetown_routes` plugin hasn't been configured in the Roda app."
           )
           return
         end
 
-        r = app.request
-        response = app.response
-
-        Bridgetown::Routes::Manifest.generate_manifest.each do |route|
+        Bridgetown::Routes::Manifest.generate_manifest(bridgetown_site).each do |route|
           file, file_slug, segment_keys = route
 
           r.on file_slug do |*segment_values|
             response["X-Bridgetown-SSR"] = "1"
             # eval_route_file caches when Bridgetown.env.production?
-            Bridgetown::Routes::CodeBlocks.eval_route_file file, file_slug, app
+            Bridgetown::Routes::CodeBlocks.eval_route_file file, file_slug, @_roda_app
 
             segment_values.each_with_index do |value, index|
               r.params[segment_keys[index]] ||= value
@@ -30,7 +31,7 @@ module Bridgetown
             response.instance_variable_set(
               :@_route_file_code, route_block.instance_variable_get(:@_route_file_code)
             ) # could be nil
-            app.instance_exec(r, &route_block)
+            @_roda_app.instance_exec(r, &route_block)
           end
         end
 

data/lib/bridgetown-routes/view_helpers.rb

@@ -1,77 +1,47 @@
 # frozen_string_literal: true
 
+require_relative "flash_additions"
+
 module Bridgetown
   module Routes
-    module FlashHashAdditions
-      def info
-        self["info"]
-      end
-
-      def info=(val)
-        self["info"] = val
-      end
-
-      def alert
-        self["alert"]
-      end
-
-      def alert=(val)
-        self["alert"] = val
-      end
-    end
-
-    module FlashHashIndifferent
-      def []=(key, val)
-        @next[key.to_s] = val
-      end
-    end
+    module ViewHelpers
+      # This flash is only used as a stub for views in case there's no Roda flash
+      # available in the rendering context
+      class Flash < Hash
+        include Bridgetown::Routes::FlashHashAdditions
 
-    module FlashNowHashIndifferent
-      def []=(key, val)
-        super(key.to_s, val)
+        def now
+          self
+        end
       end
 
-      def [](key)
-        super(key.to_s)
+      def roda_app
+        view.resource&.roda_app
       end
-    end
-  end
-end
 
-module Bridgetown
-  module Routes
-    class BlankFlash < Hash
-      include Bridgetown::Routes::FlashHashAdditions
-
-      def now
-        self
-      end
-    end
-
-    module ViewHelpers
       def request
-        view.resource&.roda_app&.request
+        roda_app&.request
       end
       alias_method :r, :request
 
       def response
-        view.resource&.roda_app&.response
+        roda_app&.response
       end
 
       def flash
-        view.resource&.roda_app&.flash || _basic_flash
+        roda_app&.flash || _blank_flash
       end
 
-      def _basic_flash
-        @_basic_flash ||= BlankFlash.new
+      def _blank_flash
+        @_blank_flash ||= Flash.new
       end
 
       def csrf_tag(...)
-        request.scope.csrf_tag(...)
+        roda_app.csrf_tag(...)
       end
 
       def csrf_token(...)
-        request.scope.csrf_token(...)
+        roda_app.csrf_token(...)
       end
     end
   end

data/lib/bridgetown-routes.rb

@@ -1,57 +1,47 @@
 # frozen_string_literal: true
 
 require "bridgetown-core"
-require "bridgetown-core/version"
-
-require_relative "bridgetown-routes/view_helpers"
-
-# Roda isn't defined for Bridgetown build-only
-require_relative "roda/plugins/bridgetown_routes" if defined?(Roda)
 
 module Bridgetown
   module Routes
     autoload :CodeBlocks, "bridgetown-routes/code_blocks"
     autoload :Manifest, "bridgetown-routes/manifest"
     autoload :RodaRouter, "bridgetown-routes/roda_router"
+  end
+end
 
-    # rubocop:disable Bridgetown/NoPutsAllowed
-    def self.print_roda_routes
-      # TODO: this needs to be fully documented, currently no info on how to generate .routes.json
-      routes = begin
-        JSON.parse(File.read("#{Dir.pwd}/.routes.json"))
-      rescue StandardError
-        []
-      end
-      puts
-      puts "Routes:"
-      puts "======="
-      if routes.blank?
-        puts "No routes found. Have you commented all of your routes?"
-        puts "Documentation: https://github.com/jeremyevans/roda-route_list#basic-usage-"
-      end
+# @param config [Bridgetown::Configuration::ConfigurationDSL]
+Bridgetown.initializer :"bridgetown-routes" do |config|
+  config.init :ssr # ensure we already have touchdown!
 
-      routes.each do |route|
-        puts [route["methods"]&.join("|") || "GET", route["path"]].compact.join(" ")
-      end
-    end
-    # rubocop:enable Bridgetown/NoPutsAllowed
+  config.routes ||= {}
+  config.routes.source_paths ||= ["_routes"]
+  config.routes.extensions ||= %w(rb md serb erb liquid)
+
+  config.only :server do
+    require_relative "bridgetown-routes/manifest_router"
+  end
+
+  config.roda do |app|
+    app.plugin :bridgetown_routes
   end
-end
 
-module RodaResourceExtension
-  module RubyResource
-    def roda_app=(app)
-      unless app.is_a?(Bridgetown::Rack::Roda)
-        raise Bridgetown::Errors::FatalException,
-              "Resource's assigned Roda app must be of type `Bridgetown::Rack::Roda'"
+  require_relative "bridgetown-routes/view_helpers"
+
+  config.builder :BridgetownRoutesBuilder do
+    def build
+      define_resource_method :roda_app do
+        @roda_app
       end
 
-      @roda_app = app
-    end
+      define_resource_method :roda_app= do |app|
+        unless app.is_a?(Bridgetown::Rack::Roda)
+          raise Bridgetown::Errors::FatalException,
+                "Resource's assigned Roda app must be of type `Bridgetown::Rack::Roda'"
+        end
 
-    def roda_app
-      @roda_app
+        @roda_app = app
+      end
     end
   end
 end
-Bridgetown::Resource.register_extension RodaResourceExtension

data/lib/roda/plugins/bridgetown_routes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "roda/plugins/flash"
+require_relative "../../bridgetown-routes/flash_additions"
 
 Roda::RodaPlugins::Flash::FlashHash.include Bridgetown::Routes::FlashHashAdditions,
                                             Bridgetown::Routes::FlashHashIndifferent
@@ -34,7 +35,7 @@ class Roda
         def render_with(data: {}) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
           path = Kernel.caller_locations(1, 1).first.path
           source_path = Pathname.new(path).relative_path_from(
-            Bridgetown::Current.site.in_source_dir("_routes")
+            bridgetown_site.in_source_dir("_routes")
           )
           code = response._route_file_code
 
@@ -48,7 +49,7 @@ class Roda
               self, Addressable::URI.encode(source_path.to_s)
             )
           ).read do
-            data[:_collection_] = Bridgetown::Current.site.collections.pages
+            data[:_collection_] = bridgetown_site.collections.pages
             data[:_relative_path_] = source_path
             data[:_content_] = code
             data

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-routes
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0.beta1
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2022-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0.beta1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.0.beta1
 - !ruby/object:Gem::Dependency
   name: roda-route_list
   requirement: !ruby/object:Gem::Requirement
@@ -49,14 +49,19 @@ files:
 - bridgetown-routes.gemspec
 - lib/bridgetown-routes.rb
 - lib/bridgetown-routes/code_blocks.rb
+- lib/bridgetown-routes/flash_additions.rb
 - lib/bridgetown-routes/manifest.rb
-- lib/bridgetown-routes/roda_router.rb
+- lib/bridgetown-routes/manifest_router.rb
 - lib/bridgetown-routes/view_helpers.rb
 - lib/roda/plugins/bridgetown_routes.rb
 homepage: https://github.com/bridgetownrb/bridgetown/tree/main/bridgetown-routes
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/bridgetownrb/bridgetown
+  bug_tracker_uri: https://github.com/bridgetownrb/bridgetown/issues
+  changelog_uri: https://github.com/bridgetownrb/bridgetown/releases
+  homepage_uri: https://github.com/bridgetownrb/bridgetown/tree/main/bridgetown-routes
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -68,9 +73,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.4
 signing_key: