bridgetown-routes 1.3.4 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16347dadf3ce286824c397b0407d648ebf4f50e72780d0932b74038235e78c27
-  data.tar.gz: b27b57fa4edf117798108ad0396e9e83ae39634656bdd5244a571bf5d175a70e
+  metadata.gz: 445dae142f84283ec22f242dc381dde6d13ffa7fa22ba2957f560ffc5c22ccc7
+  data.tar.gz: 45672d79f98dd967de6956f1f75729394c5a4ece377c8892fbe0947a2e0a8d74
 SHA512:
-  metadata.gz: bde4592c7d79d3129e089c992c9b9e8aebb86361b3671b76772aebea37215b9df9340dbf3a5e179986df936437cdbc9acf92361741933d10f252ba66bf16d12a
-  data.tar.gz: 4b9468c44bf67027e6b7b860af1c18acd8517ba40bb866546324180e91f12314101ead50c8a64d8d27e49776ca4108f710f015b7b6e827e0ca24e0cd4fb1c88c
+  metadata.gz: ee45e46edfe8059955607110dfda8d0c32c683f3e050de3ecde535994f97a2a28f00e1f4f3c3f15a36dbc6aa848fcfbe59bfaafb3b0e4efe92e05ae7d53ca700
+  data.tar.gz: '08a58986c7d2ee3727937c0d6a4cb020a020aa4678775408e99c24c2ea8627b72fb9a9fd4289cfe41e680935be66c9703218f9141e8d370767324a7e06298f26'

data/.rubocop.yml

@@ -4,3 +4,4 @@ inherit_from: ../.rubocop.yml
 AllCops:
   Exclude:
     - "*.gemspec"
+    - "test/ssr/src/**/*.rb"

data/bridgetown-routes.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../bridgetown-core/lib/bridgetown-core/version"
+require_relative "../bridgetown-foundation/lib/bridgetown/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "bridgetown-routes"

data/lib/bridgetown-routes/code_blocks.rb

@@ -6,8 +6,11 @@ module Bridgetown
       class << self
         attr_accessor :blocks
 
-        def add_route(name, file_code = nil, &block)
+        def add_route(name, file_code = nil, front_matter_line_count = nil, &block)
           block.instance_variable_set(:@_route_file_code, file_code) if file_code
+          if front_matter_line_count
+            block.instance_variable_set(:@_front_matter_line_count, front_matter_line_count)
+          end
 
           @blocks ||= {}
           @blocks[name] = block
@@ -30,18 +33,23 @@ module Bridgetown
 
           code = File.read(file)
           code_postmatch = nil
-          ruby_content = code.match(Bridgetown::FrontMatterImporter::RUBY_BLOCK)
+          ruby_content = code.match(Bridgetown::FrontMatter::Loaders::Ruby::BLOCK)
+          front_matter_line_count = nil
           if ruby_content
             code = ruby_content[1]
-            code_postmatch = ruby_content.post_match
+            code_postmatch = ruby_content.post_match.lstrip
+            front_matter_line_count = code.lines.count - 1
+            if code.match?(%r!^\s*render_with(\s|\()!).! && code.match?(%r!r\.[a-z]+\s+do!).!
+              code.concat("\nrender_with {}")
+            end
           end
 
-          code = <<~RUBY
-            add_route(#{file_slug.inspect}, #{code_postmatch.inspect}) do |r|
-              #{code}
-            end
-          RUBY
-          instance_eval(code, file, ruby_content ? 1 : 0)
+          # rubocop:disable Style/DocumentDynamicEvalDefinition, Style/EvalWithLocation
+          code_proc = Kernel.eval(
+            "proc {|r| #{code} }", TOPLEVEL_BINDING, file, ruby_content ? 2 : 1
+          )
+          add_route(file_slug, code_postmatch, front_matter_line_count, &code_proc)
+          # rubocop:enable Style/DocumentDynamicEvalDefinition, Style/EvalWithLocation
         end
       end
     end

data/lib/bridgetown-routes/manifest.rb

@@ -2,97 +2,111 @@
 
 module Bridgetown
   module Routes
-    module Manifest
-      class << self
-        def generate_manifest(site) # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity
-          return @route_manifest[site.label] if @route_manifest && Bridgetown.env.production?
+    class Manifest
+      attr_reader :site, :config, :manifest
+
+      def initialize(site, cache_routes: Bridgetown.env.production?)
+        @site = site
+        @manifest = []
+        @config = site.config.routes
+        @cache_routes = cache_routes
+        @islands_dir = File.expand_path(site.config.islands_dir, site.config.source)
+      end
 
-          new_manifest = []
-          routable_extensions = site.config.routes.extensions.join(",")
+      def routable_extensions = config.extensions.join(",")
 
-          site.config.routes.source_paths.each do |routes_dir|
-            routes_dir = File.expand_path(routes_dir, site.config.source)
+      def routes
+        return @manifest if !@manifest.empty? && @cache_routes
 
-            # @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
+        @manifest = []
 
-              file_slug, segment_keys = file_slug_and_segments(site, routes_dir, file)
+        # Loop through all the directories (`src/_routes`, etc) looking for route files, then
+        # sort them and add them to the manifest:
+        expand_source_paths_with_islands.each do |routes_dir|
+          @manifest += glob_routes(routes_dir).map do |file|
+            file_slug, segment_keys = file_slug_and_segments(routes_dir, file)
 
-              # generate localized file slugs
-              localized_file_slugs = generate_localized_file_slugs(site, file_slug)
+            # generate localized file slugs
+            localized_file_slugs = generate_localized_file_slugs(file_slug)
 
-              [file, localized_file_slugs, segment_keys]
-            end
+            [file, localized_file_slugs, segment_keys]
+          end.then { sort_routes! _1 }
+        end
 
-            new_manifest += sort_routes!(routes)
-          end
+        @manifest
+      end
+
+      def expand_source_paths_with_islands
+        # clear out any past islands folders
+        config.source_paths.reject! { _1.start_with?(@islands_dir) }
 
-          @route_manifest ||= {}
-          @route_manifest[site.label] = new_manifest
+        Dir.glob("#{@islands_dir}/**/routes").each do |route_folder|
+          config.source_paths << route_folder
         end
 
-        def sort_routes!(routes)
-          routes.sort! do |route_a, route_b|
-            # @type [String]
-            slug_a = route_a[1][0]
-            # @type [String]
-            slug_b = route_b[1][0]
-
-            # @type [Integer]
-            weight1 = slug_a.count("/") <=> slug_b.count("/")
-            if weight1.zero?
-              slug_b.count("/:") <=> slug_a.count("/:")
-            else
-              weight1
-            end
-          end.reverse!
+        config.source_paths.map { File.expand_path _1, site.config.source }
+      end
+
+      def glob_routes(dir, pattern = "**/*")
+        files = Dir.glob("#{dir}/#{pattern}.{#{routable_extensions}}")
+        files.reject! do |file|
+          File.basename(file, ".*").then { _1.start_with?("_", ".") || _1.end_with?(".test") }
+        end
+        files
+      end
+
+      def file_slug_and_segments(routes_dir, file)
+        # @type [String]
+        file_slug = file.delete_prefix("#{routes_dir}/").then do |f|
+          if routes_dir.start_with?(@islands_dir)
+            # convert _islands/foldername/routes/someroute.rb to foldername/someroute.rb
+            f = routes_dir.delete_prefix("#{@islands_dir}/").sub(%r!/routes$!, "/") + f
+          end
+          [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
 
-        def locale_for(slug, site)
-          possible_locale_segment = slug.split("/").first.to_sym
+        [file_slug, segment_keys]
+      end
 
-          if site.config.available_locales.include? possible_locale_segment
-            possible_locale_segment
+      def generate_localized_file_slugs(file_slug)
+        site.config.available_locales.map do |locale|
+          if locale == site.config.default_locale && !site.config.prefix_default_locale
+            file_slug
           else
-            site.config.default_locale
+            "#{locale}/#{file_slug}"
           end
         end
+      end
 
-        private
-
-        def file_slug_and_segments(site, routes_dir, file)
+      def sort_routes!(routes)
+        routes.sort! do |route_a, route_b|
+          # @type [String]
+          slug_a = route_a[1][0]
           # @type [String]
-          file_slug = file.delete_prefix("#{routes_dir}/").then do |f|
-            if routes_dir.start_with?(
-              File.expand_path(site.config[:islands_dir], site.config.source)
-            )
-              f = "#{site.config[:islands_dir].delete_prefix("_")}/#{f}"
-            end
-            [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)}"
+          slug_b = route_b[1][0]
+
+          # @type [Integer]
+          weight1 = slug_a.count("/") <=> slug_b.count("/")
+          if weight1.zero?
+            slug_b.count("/:") <=> slug_a.count("/:")
+          else
+            weight1
           end
+        end.reverse!
+      end
 
-          [file_slug, segment_keys]
-        end
+      def locale_for(slug)
+        possible_locale_segment = slug.split("/").first.to_sym
 
-        def generate_localized_file_slugs(site, file_slug)
-          site.config.available_locales.map do |locale|
-            if locale == site.config.default_locale && !site.config.prefix_default_locale
-              file_slug
-            else
-              "#{locale}/#{file_slug}"
-            end
-          end
+        if site.config.available_locales.include? possible_locale_segment
+          possible_locale_segment
+        else
+          site.config.default_locale
         end
       end
     end

data/lib/bridgetown-routes/manifest_router.rb

@@ -1,55 +1,11 @@
 # frozen_string_literal: true
 
-require "bridgetown-core/rack/routes"
-
 module Bridgetown
   module Routes
     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
-
-        Bridgetown::Routes::Manifest.generate_manifest(bridgetown_site).each do |route|
-          file, localized_file_slugs, segment_keys = route
-
-          localized_file_slugs.each do |file_slug|
-            add_route(r, file, file_slug, segment_keys)
-          end
-        end
-
-        nil
-      end
-
-      private
-
-      def add_route(route, file, file_slug, segment_keys)
-        route.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, @_roda_app
-
-          segment_values.each_with_index do |value, index|
-            route.params[segment_keys[index]] ||= value
-          end
-
-          # set route locale
-          locale = Bridgetown::Routes::Manifest.locale_for(file_slug, bridgetown_site)
-          I18n.locale           = locale
-          route.params[:locale] = locale
-
-          route_block = Bridgetown::Routes::CodeBlocks.route_block(file_slug)
-          response.instance_variable_set(
-            :@_route_file_code, route_block.instance_variable_get(:@_route_file_code)
-          ) # could be nil
-          @_roda_app.instance_exec(route, &route_block)
-        end
-      end
+      route(&:file_routes)
     end
   end
 end

data/lib/bridgetown-routes.rb

@@ -11,13 +11,20 @@ module Bridgetown
 end
 
 # @param config [Bridgetown::Configuration::ConfigurationDSL]
-Bridgetown.initializer :"bridgetown-routes" do |config|
+Bridgetown.initializer :"bridgetown-routes" do |
+  config,
+  additional_source_paths: [],
+  additional_extensions: []
+|
   config.init :ssr # ensure we already have touchdown!
 
   config.routes ||= {}
-  config.routes.source_paths ||= ["_routes", "#{config.islands_dir}/routes"]
+  config.routes.source_paths ||= ["_routes"]
   config.routes.extensions ||= %w(rb md serb erb liquid)
 
+  config.routes.source_paths += Array(additional_source_paths)
+  config.routes.extensions += Array(additional_extensions)
+
   config.only :server do
     require_relative "bridgetown-routes/manifest_router"
   end

data/lib/roda/plugins/bridgetown_routes.rb

@@ -25,14 +25,67 @@ class Roda
       end
 
       def self.configure(app, _opts = {})
-        return unless app.opts[:bridgetown_site].nil?
+        app.root_hook do
+          routes_dir = File.expand_path(
+            bridgetown_site.config.routes.source_paths.first,
+            bridgetown_site.config.source
+          )
+          file = routes_manifest.glob_routes(routes_dir, "index").first
+          next unless file
+
+          run_file_route(file, slug: "index")
+        end
+
+        if app.opts[:bridgetown_site]
+          app.opts[:routes_manifest] ||=
+            Bridgetown::Routes::Manifest.new(app.opts[:bridgetown_site])
+          return
+        end
 
         raise "Roda app failure: the bridgetown_ssr plugin must be registered before " \
               "bridgetown_routes"
       end
 
       module InstanceMethods
-        def render_with(data: {}) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+        def routes_manifest
+          self.class.opts[:routes_manifest]
+        end
+
+        def run_file_route(file, slug:)
+          response["X-Bridgetown-Routes"] = "1"
+          # eval_route_file caches when Bridgetown.env.production?
+          Bridgetown::Routes::CodeBlocks.eval_route_file file, slug, self
+
+          # set route locale
+          locale = routes_manifest.locale_for(slug)
+          I18n.locale = request.params[:locale] = locale
+
+          # get the route block extracted from the file at slug
+          route_block = Bridgetown::Routes::CodeBlocks.route_block(slug)
+          response.instance_variable_set(
+            :@_route_file_code, route_block.instance_variable_get(:@_route_file_code)
+          ) # could be nil
+          response.instance_variable_set(
+            :@_front_matter_line_count,
+            route_block.instance_variable_get(:@_front_matter_line_count)
+          ) # could be nil
+          instance_exec(request, &route_block)
+        end
+
+        def front_matter(&block)
+          b = block.binding
+          denylisted = %i(r argv)
+          data = b.local_variables.filter_map do |key|
+            next if denylisted.any? key
+
+            [key, b.local_variable_get(key)]
+          end.to_h
+
+          Bridgetown::FrontMatter::RubyFrontMatter.new(data:).tap { _1.instance_exec(&block) }.to_h
+        end
+
+        def render_with(data: {}, &) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
+          data = front_matter(&) if data.empty? && block_given?
           path = Kernel.caller_locations(1, 1).first.path
           source_path = Pathname.new(path).relative_path_from(
             bridgetown_site.in_source_dir("_routes")
@@ -50,14 +103,16 @@ class Roda
             )
           ).read do
             data[:_collection_] = bridgetown_site.collections.pages
+            data[:_original_path_] = path
             data[:_relative_path_] = source_path
+            data[:_front_matter_line_count_] = response._front_matter_line_count
             data[:_content_] = code
             data
           end
 
           Bridgetown::Model::Base.new(data).to_resource.tap do |resource|
             resource.roda_app = self
-          end.read!.transform!.output
+          end.read!
         end
 
         def render(...)
@@ -65,17 +120,45 @@ class Roda
         end
 
         def view(view_class: Bridgetown::ERBView)
+          # TODO: support user choosing templates by extension rather than class
           response._fake_resource_view(
-            view_class: view_class, roda_app: self, bridgetown_site: bridgetown_site
+            view_class:, roda_app: self, bridgetown_site:
           )
         end
       end
 
+      module RequestMethods
+        # This runs through all of the routes in the manifest, setting up Roda blocks for execution
+        def file_routes
+          scope.routes_manifest.routes.each do |route|
+            file, localized_file_slugs, segment_keys = route
+
+            localized_file_slugs.each do |slug|
+              # This sets up an initial Roda route block at the slug, and handles segments as params
+              #
+              # _routes/nested/[slug].erb -> "nested/:slug"
+              # "nested/123" -> r.params[:slug] == 123
+              on slug do |*segment_values|
+                segment_values.each_with_index do |value, index|
+                  params[segment_keys[index]] ||= value
+                end
+
+                # This is provided as an instance method by our Roda plugin:
+                scope.run_file_route(file, slug:)
+              end
+            end
+          end
+
+          nil # be sure not to return the above array loop
+        end
+      end
+
       module ResponseMethods
         # template string provided, if available, by the saved code block
-        def _route_file_code
-          @_route_file_code
-        end
+        def _route_file_code = @_route_file_code
+
+        # we need to know where the real template starts for good error reporting
+        def _front_matter_line_count = @_front_matter_line_count
 
         def _fake_resource_view(view_class:, roda_app:, bridgetown_site:)
           @_fake_resource_views ||= {}
@@ -83,7 +166,7 @@ class Roda
             # TODO: use a Stuct for better performance...?
             HashWithDotAccess::Hash.new({
               data: {},
-              roda_app: roda_app,
+              roda_app:,
               site: bridgetown_site,
             })
           )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-routes
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 2.0.0.beta2
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 2024-08-18 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.3.4
+        version: 2.0.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: 2.0.0.beta2
 - !ruby/object:Gem::Dependency
   name: roda-route_list
   requirement: !ruby/object:Gem::Requirement
@@ -73,11 +73,11 @@ 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.2.33
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A Bridgetown plugin to add support for file-based Roda backend routes within