bridgetown-routes 1.0.0.alpha2 → 1.0.0.alpha6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d99af4d6cf66c15ad4ca1da7044ca24142f45dbf6035696573dbb8e5033f8c7
-  data.tar.gz: 8418e77c8b4bd9263468149ba6d231d5a51b6922ffe299291374b8abb8e2ba80
+  metadata.gz: 862c93a20ddca076132f99fece6aad13aa7832540251160f1b701675a0751b48
+  data.tar.gz: a25355e13e76aeff83c6566329d3e27ceb6cd7b5b8ea0380a9b1671deb1b1dac
 SHA512:
-  metadata.gz: 5f0528d922fbf73a90edf3f62fd584f8fba34853337228b2fa16dcb3e2f31a927d0c6e30ebe549a4762aa56f9649812c03d4c9be5b5f9e1597fac4e00d8c25ff
-  data.tar.gz: b17f234af39b21ec58721c842eb6f4bbd6294c579f0c4a9cf0884ad0a891aaf873e33b7a01d34efef9abd7d496281dd9ab42a5454ce6648320046ef555e2555d
+  metadata.gz: 5f33bf8a6cf93ae662dcc0114467d107a01ccce02fccbf2fec98ef05ec02774d9db91b91c7f0a1c584a8e7879f6267cadf92b61fac5be06d53356778dc3d37bb
+  data.tar.gz: 659e1198862118b090f41618e2e326dc9a633bf3860a64f35c11946bd42764cb368c29453b04c86494bf49faf23180e30e6e9fd8d262e075eb5e5fd9b94a7b69

data/lib/bridgetown-routes/code_blocks.rb

@@ -21,6 +21,29 @@ module Bridgetown
         def route_block(name)
           blocks[name] if route_defined?(name)
         end
+
+        def eval_route_file(file, file_slug, app) # rubocop:disable Lint/UnusedMethodArgument
+          if Bridgetown.env.production? && Bridgetown::Routes::CodeBlocks.route_defined?(file_slug)
+            # we don't need to re-eval the file in production because it won't be changing underfoot
+            return
+          end
+
+          code = File.read(file)
+          code_postmatch = nil
+          ruby_content = code.match(Bridgetown::FrontMatterImporter::RUBY_BLOCK)
+          if ruby_content
+            code = ruby_content[1]
+            code_postmatch = ruby_content.post_match
+          end
+
+          code = <<~RUBY
+            r = app.request
+            add_route(#{file_slug.inspect}, #{code_postmatch.inspect}) do
+              #{code}
+            end
+          RUBY
+          instance_eval(code, file, -1)
+        end
       end
     end
   end

data/lib/bridgetown-routes/manifest.rb

@@ -4,6 +4,7 @@ module Bridgetown
   module Routes
     module Manifest
       class << self
+        # TODO: make this extensible
         def routable_extensions
           %w(rb md serb erb liquid)
         end
@@ -11,7 +12,7 @@ module Bridgetown
         def generate_manifest # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
           return @route_manifest if @route_manifest && Bridgetown.env.production?
 
-          routes_dir = File.expand_path("src/_routes", Dir.pwd)
+          routes_dir = Bridgetown::Current.site.in_source_dir("_routes")
           # @type [Array]
           routes = Dir.glob(routes_dir + "/**/*.{#{routable_extensions.join(",")}}").map do |file|
             if File.basename(file).start_with?("_", ".") ||

data/lib/bridgetown-routes/roda_router.rb

@@ -3,7 +3,7 @@
 module Bridgetown
   module Routes
     module RodaRouter
-      def self.start!(app) # rubocop:disable Metrics/MethodLength
+      def self.start!(app)
         r = app.request
         response = app.response
 
@@ -12,17 +12,15 @@ module Bridgetown
 
           r.on file_slug do |*segment_values|
             response["X-Bridgetown-SSR"] = "1"
-            unless Bridgetown.env.production? &&
-                Bridgetown::Routes::CodeBlocks.route_defined?(file_slug)
-              eval_route_file file, file_slug, app
-            end
+            # eval_route_file caches when Bridgetown.env.production?
+            Bridgetown::Routes::CodeBlocks.eval_route_file file, file_slug, app
 
             segment_values.each_with_index do |value, index|
               r.params[segment_keys[index]] ||= value
             end
 
             route_block = Bridgetown::Routes::CodeBlocks.route_block(file_slug)
-            app.instance_variable_set(
+            response.instance_variable_set(
               :@_route_file_code, route_block.instance_variable_get(:@_route_file_code)
             ) # could be nil
             app.instance_exec(&route_block)
@@ -31,24 +29,6 @@ module Bridgetown
 
         nil
       end
-
-      def self.eval_route_file(file, file_slug, app) # rubocop:disable Lint/UnusedMethodArgument
-        code = File.read(file)
-        code_postmatch = nil
-        ruby_content = code.match(Bridgetown::FrontMatterImporter::RUBY_BLOCK)
-        if ruby_content
-          code = ruby_content[1]
-          code_postmatch = ruby_content.post_match
-        end
-
-        code = <<~RUBY
-          r = app.request
-          Bridgetown::Routes::CodeBlocks.add_route(#{file_slug.inspect}, #{code_postmatch.inspect}) do
-            #{code}
-          end
-        RUBY
-        instance_eval(code, file, -1)
-      end
     end
   end
 end

data/lib/bridgetown-routes/view_helpers.rb

@@ -0,0 +1,80 @@
+# 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
+
+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
+      end
+      alias_method :r, :request
+
+      def response
+        view.resource&.roda_app&.response
+      end
+
+      def flash
+        view.resource&.roda_app&.flash || _basic_flash
+      end
+
+      def _basic_flash
+        @_basic_flash ||= BlankFlash.new
+      end
+
+      # def csrf_tag(...)
+      #   request.scope.csrf_tag(...)
+      # end
+
+      # def csrf_token(...)
+      #   request.scope.csrf_token(...)
+      # end
+    end
+  end
+end
+
+Bridgetown::RubyTemplateView::Helpers.include Bridgetown::Routes::ViewHelpers

data/lib/bridgetown-routes.rb

@@ -3,9 +3,10 @@
 require "bridgetown-core"
 require "bridgetown-core/version"
 
-require_relative "roda/plugins/bridgetown_routes"
+require_relative "bridgetown-routes/view_helpers"
 
-require_relative "bridgetown-routes/helpers"
+# Roda isn't defined for Bridgetown build-only
+require_relative "roda/plugins/bridgetown_routes" if defined?(Roda)
 
 module Bridgetown
   module Routes
@@ -35,3 +36,21 @@ module Bridgetown
     # rubocop:enable Bridgetown/NoPutsAllowed
   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'"
+      end
+
+      @roda_app = app
+    end
+
+    def roda_app
+      @roda_app
+    end
+  end
+end
+Bridgetown::Resource.register_extension RodaResourceExtension

data/lib/roda/plugins/bridgetown_routes.rb

@@ -2,6 +2,17 @@
 
 require "roda/plugins/flash"
 
+Roda::RodaPlugins::Flash::FlashHash.include Bridgetown::Routes::FlashHashAdditions,
+                                            Bridgetown::Routes::FlashHashIndifferent
+Roda::RodaPlugins::Flash::FlashHash.class_eval do
+  def initialize(hash = {})
+    super(hash || {})
+    now.singleton_class.include Bridgetown::Routes::FlashHashAdditions,
+                                Bridgetown::Routes::FlashNowHashIndifferent
+    @next = {}
+  end
+end
+
 class Roda
   module RodaPlugins
     module BridgetownRoutes
@@ -20,27 +31,31 @@ class Roda
       end
 
       module InstanceMethods
-        def render_with(data: {}) # rubocop:todo Metrics/AbcSize
+        def render_with(data: {}) # rubocop:todo Metrics/AbcSize, Metrics/MethodLength
           path = Kernel.caller_locations(1, 1).first.absolute_path
-          source_path = Pathname.new(path).relative_path_from(Bridgetown::Current.site.source)
-          code = @_route_file_code
+          source_path = Pathname.new(path).relative_path_from(
+            Bridgetown::Current.site.in_source_dir("_routes")
+          )
+          code = response._route_file_code
 
           unless code.present?
             raise Bridgetown::Errors::FatalException,
                   "`render_with' method must be called from a template-based file in `src/_routes'"
           end
 
-          data = Bridgetown::Model::BuilderOrigin.new("builder://#{source_path}").read do
+          data = Bridgetown::Model::BuilderOrigin.new(
+            Bridgetown::Model::BuilderOrigin.id_for_builder_path(
+              self, Addressable::URI.encode(source_path.to_s)
+            )
+          ).read do
             data[:_collection_] = Bridgetown::Current.site.collections.pages
+            data[:_relative_path_] = source_path
             data[:_content_] = code
             data
           end
 
           Bridgetown::Model::Base.new(data).to_resource.tap do |resource|
-            resource.roda_data[:request] = request
-            resource.roda_data[:response] = response
-            resource.roda_data[:flash] = nil
-            #            resource.roda_data[:flash] = flash
+            resource.roda_app = self
           end.read!.transform!.output
         end
 
@@ -50,23 +65,24 @@ class Roda
 
         def view(view_class: Bridgetown::ERBView)
           response._fake_resource_view(
-            view_class: view_class, request: request, bridgetown_site: bridgetown_site
+            view_class: view_class, roda_app: self, bridgetown_site: bridgetown_site
           )
         end
       end
 
       module ResponseMethods
-        def _fake_resource_view(view_class:, request:, bridgetown_site:)
+        # template string provided, if available, by the saved code block
+        def _route_file_code
+          @_route_file_code
+        end
+
+        def _fake_resource_view(view_class:, roda_app:, bridgetown_site:)
           @_fake_resource_views ||= {}
           @_fake_resource_views[view_class] ||= view_class.new(
             # TODO: use a Stuct for better performance...?
             HashWithDotAccess::Hash.new({
               data: {},
-              roda_data: {
-                request: request,
-                response: self,
-                flash: nil, # flash,
-              },
+              roda_app: roda_app,
               site: bridgetown_site,
             })
           )
@@ -77,30 +93,3 @@ class Roda
     register_plugin :bridgetown_routes, BridgetownRoutes
   end
 end
-
-module RodaResourceExtension
-  module RubyResource
-    def roda_data
-      @roda_data ||= HashWithDotAccess::Hash.new
-    end
-  end
-end
-Bridgetown::Resource.register_extension RodaResourceExtension
-
-Roda::RodaPlugins::Flash::FlashHash.class_eval do
-  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown-routes
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha2
+  version: 1.0.0.alpha6
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-16 00:00:00.000000000 Z
+date: 2021-10-26 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.0.0.alpha2
+        version: 1.0.0.alpha6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.0.alpha2
+        version: 1.0.0.alpha6
 - !ruby/object:Gem::Dependency
   name: roda-route_list
   requirement: !ruby/object:Gem::Requirement
@@ -49,9 +49,9 @@ files:
 - bridgetown-routes.gemspec
 - lib/bridgetown-routes.rb
 - lib/bridgetown-routes/code_blocks.rb
-- lib/bridgetown-routes/helpers.rb
 - lib/bridgetown-routes/manifest.rb
 - lib/bridgetown-routes/roda_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:

data/lib/bridgetown-routes/helpers.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Bridgetown
-  module Routes
-    module ViewHelpers
-      def request
-        view.resource&.roda_data&.request
-      end
-      alias_method :r, :request
-
-      def response
-        view.resource&.roda_data&.response
-      end
-
-      def flash
-        view.resource&.roda_data&.flash
-      end
-
-      # def csrf_tag(...)
-      #   request.scope.csrf_tag(...)
-      # end
-
-      # def csrf_token(...)
-      #   request.scope.csrf_token(...)
-      # end
-    end
-  end
-end
-
-Bridgetown::RubyTemplateView::Helpers.include Bridgetown::Routes::ViewHelpers