bridgetown-routes 1.0.0.alpha2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7d99af4d6cf66c15ad4ca1da7044ca24142f45dbf6035696573dbb8e5033f8c7
+  data.tar.gz: 8418e77c8b4bd9263468149ba6d231d5a51b6922ffe299291374b8abb8e2ba80
+SHA512:
+  metadata.gz: 5f0528d922fbf73a90edf3f62fd584f8fba34853337228b2fa16dcb3e2f31a927d0c6e30ebe549a4762aa56f9649812c03d4c9be5b5f9e1597fac4e00d8c25ff
+  data.tar.gz: b17f234af39b21ec58721c842eb6f4bbd6294c579f0c4a9cf0884ad0a891aaf873e33b7a01d34efef9abd7d496281dd9ab42a5454ce6648320046ef555e2555d

data/.rubocop.yml

@@ -0,0 +1,6 @@
+---
+inherit_from: ../.rubocop.yml
+
+AllCops:
+  Exclude:
+    - "*.gemspec"

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+
+task spec: :test
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+end

data/bridgetown-routes.gemspec

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "../bridgetown-core/lib/bridgetown-core/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-routes"
+  spec.version       = Bridgetown::VERSION
+  spec.author        = "Bridgetown Team"
+  spec.email         = "maintainers@bridgetownrb.com"
+  spec.summary       = "A Bridgetown plugin to add support for file-based Roda backend routes within the source folder."
+  spec.homepage      = "https://github.com/bridgetownrb/bridgetown/tree/main/bridgetown-routes"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features)/!) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency("bridgetown-core", Bridgetown::VERSION)
+  spec.add_dependency("roda-route_list", ">= 2.1")
+end

data/lib/bridgetown-routes/code_blocks.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Routes
+    module CodeBlocks
+      class << self
+        attr_accessor :blocks
+
+        def add_route(name, file_code = nil, &block)
+          block.instance_variable_set(:@_route_file_code, file_code) if file_code
+
+          @blocks ||= {}
+          @blocks[name] = block
+        end
+
+        # @param name [String]
+        def route_defined?(name)
+          blocks&.key?(name)
+        end
+
+        def route_block(name)
+          blocks[name] if route_defined?(name)
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown-routes/helpers.rb

@@ -0,0 +1,30 @@
+# 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

data/lib/bridgetown-routes/manifest.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Routes
+    module Manifest
+      class << self
+        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 = File.expand_path("src/_routes", Dir.pwd)
+          # @type [Array]
+          routes = Dir.glob(routes_dir + "/**/*.{#{routable_extensions.join(",")}}").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.compact
+
+          routes.sort! do |route_a, route_b|
+            # @type [String]
+            _, slug_a = route_a
+            _, slug_b = route_b
+
+            weight1 = slug_a.count("/") <=> slug_b.count("/")
+            if weight1.zero?
+              slug_b.count("/:") <=> slug_a.count("/:")
+            else
+              weight1
+            end
+          end.reverse!
+
+          @route_manifest = routes
+        end
+      end
+    end
+  end
+end

data/lib/bridgetown-routes/roda_router.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Bridgetown
+  module Routes
+    module RodaRouter
+      def self.start!(app) # rubocop:disable Metrics/MethodLength
+        r = app.request
+        response = app.response
+
+        Bridgetown::Routes::Manifest.generate_manifest.each do |route|
+          file, file_slug, segment_keys = route
+
+          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
+
+            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(
+              :@_route_file_code, route_block.instance_variable_get(:@_route_file_code)
+            ) # could be nil
+            app.instance_exec(&route_block)
+          end
+        end
+
+        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.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "bridgetown-core"
+require "bridgetown-core/version"
+
+require_relative "roda/plugins/bridgetown_routes"
+
+require_relative "bridgetown-routes/helpers"
+
+module Bridgetown
+  module Routes
+    autoload :CodeBlocks, "bridgetown-routes/code_blocks"
+    autoload :Manifest, "bridgetown-routes/manifest"
+    autoload :RodaRouter, "bridgetown-routes/roda_router"
+
+    # rubocop:disable Bridgetown/NoPutsAllowed
+    def self.print_roda_routes
+      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
+
+      routes.each do |route|
+        puts [route["methods"]&.join("|") || "GET", route["path"]].compact.join(" ")
+      end
+    end
+    # rubocop:enable Bridgetown/NoPutsAllowed
+  end
+end

data/lib/roda/plugins/bridgetown_routes.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require "roda/plugins/flash"
+
+class Roda
+  module RodaPlugins
+    module BridgetownRoutes
+      def self.load_dependencies(app)
+        app.plugin :slash_path_empty # now /hello and /hello/ are both matched
+        app.plugin :placeholder_string_matchers
+        app.plugin :flash
+        app.plugin :route_csrf, check_header: true
+      end
+
+      def self.configure(app, _opts = {})
+        return unless app.opts[:bridgetown_site].nil?
+
+        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
+          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
+
+          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[:_collection_] = Bridgetown::Current.site.collections.pages
+            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
+          end.read!.transform!.output
+        end
+
+        ruby2_keywords def render(*args, &block)
+          view.render(*args, &block)
+        end
+
+        def view(view_class: Bridgetown::ERBView)
+          response._fake_resource_view(
+            view_class: view_class, request: request, bridgetown_site: bridgetown_site
+          )
+        end
+      end
+
+      module ResponseMethods
+        def _fake_resource_view(view_class:, request:, 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,
+              },
+              site: bridgetown_site,
+            })
+          )
+        end
+      end
+    end
+
+    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

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-routes
+version: !ruby/object:Gem::Version
+  version: 1.0.0.alpha2
+platform: ruby
+authors:
+- Bridgetown Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.alpha2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.alpha2
+- !ruby/object:Gem::Dependency
+  name: roda-route_list
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: 
+email: maintainers@bridgetownrb.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Rakefile
+- 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/roda/plugins/bridgetown_routes.rb
+homepage: https://github.com/bridgetownrb/bridgetown/tree/main/bridgetown-routes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: A Bridgetown plugin to add support for file-based Roda backend routes within
+  the source folder.
+test_files: []