ratalada-contrib 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d30cdd4308ec4495bd965180994b34d26439ba7f0127398562eb381cc8eccc95
-  data.tar.gz: bec8c448d5e15fb2b25478f1cb31e299514fdd2ef9067c81681244e54a0bdae1
+  metadata.gz: cd2d16bc3b97e31abe859281ecc0ba7a322a6bce7dc1a71e854a21d80e470fdb
+  data.tar.gz: 4f4139c69c3183ddae2b4c2df734424e0a18be4d31b10f937491be9718753156
 SHA512:
-  metadata.gz: e72898aabde80621c44d55d2f12a13dcd9210d65c5690aaa444f0b867b81354300e2c6904fbb60e6ddf9c97a784b918616c8dfd3c45ad55ffd84df5fb2d4e19f
-  data.tar.gz: 97151f7ad7867f3856c7da8971b2d9b63318716bb10319f9865a7c12b92dc61c1559756d5a50db14c4c846ed9f777307e091629545e7ad8a68d676c860636b6d
+  metadata.gz: 601080c5ec4fff081b714aaca9d6499bea7eda3d97ef1cfd7f5ea355e00178094c81d52921024d414bf07663fd4090c37d3e943b40bf53c52977629cd85b92f4
+  data.tar.gz: 66c6a9b432555f7d0a542f1eed3d364d108cdb2fbb9b2f4e6cc2f414020997369e2a4ac3518f05402400e09a9cfd3c39c8f7a9bcad4825214966c5635065d661

data/lib/ratalada/contrib/router/file_based/expo.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "mustermann"
+require "mustermann/ast/pattern"
+
+module Mustermann
+  # Expo Router style pattern implementation.
+  #
+  # @example
+  #   Mustermann.new('/[foo]', type: :expo) === '/bar' # => true
+  #
+  # @see Mustermann::Pattern
+  class Expo < AST::Pattern
+    register :expo
+
+    NOT_FOUND = "+not-found"
+    NOT_FOUND_CAPTURE = "unmatched"
+
+    # Turns an Expo Router file path into the route it serves: file extensions
+    # and the +api suffix are dropped, a _layout file stands for its directory,
+    # group segments are invisible and a trailing index is its directory.
+    # Mirrors getContextKey/stripInvisibleSegmentsFromPath in expo-router.
+    # @!visibility private
+    def self.route(string)
+      string   = string.sub(%r{\A(?:\.\.?/|/)+}, "")
+      string   = string.sub(/(\+api)?\.rb$/, "").sub(%r{/?_layout$}, "")
+      segments = (?/ + string.delete_prefix(?/)).split(?/, -1)
+      if segments.last == "index"
+        segments.pop
+      end
+      segments.reject! { |s| s =~ /\A\(.+\)\z/ }
+      if segments.last == NOT_FOUND
+        segments[-1] = "[...#{NOT_FOUND_CAPTURE}]"
+      end
+      segments.join(?/).then { |route| route.empty? ? ?/ : route }
+    end
+
+    def initialize(string, **options)
+      super(Expo.route(string), **options)
+    end
+
+    on(nil, ?]) { |c| unexpected(c) }
+
+    on(?[) do |char|
+      name = expect(%r{[^\[\]/]+}, char: char)
+      expect(?])
+
+      if name.start_with?("...")
+        node(:named_splat, name[3..], constraint: ".+", convert: ->(e) { e.split(?/) })
+      else
+        node(:capture, name)
+      end
+    end
+  end
+end

data/lib/ratalada/contrib/router/file_based/grape_adapter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "ratalada/grape"
+
+require_relative "../file_based"
+
+module Ratalada
+  module Contrib
+    module Router
+      module FileBased
+        # Teaches Grape `route_prefix`, the same way as Sinatra: the paths of
+        # every route defined while it is set hang off it.
+        module GrapeAdapter
+          def route(methods, paths = ["/"], route_options = {}, &block)
+            unless route_prefix.to_s.empty?
+              paths = Array(paths).map { |path| FileBased.join(route_prefix, path.to_s) }
+            end
+
+            super
+          end
+        end
+      end
+    end
+  end
+end
+
+class Grape::API::Instance # rubocop:disable Style/ClassAndModuleChildren
+  class << self
+    attr_accessor :route_prefix
+
+    prepend Ratalada::Contrib::Router::FileBased::GrapeAdapter
+  end
+end

data/lib/ratalada/contrib/router/file_based/hanami_adapter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "ratalada/hanami"
+
+require_relative "../file_based"
+
+module Ratalada
+  module Contrib
+    module Router
+      module FileBased
+        # Teaches Hanami::API `route_prefix`. Hanami's router already carries a
+        # path prefix — it is what `scope` sets for the length of its block —
+        # so this is that, set until the next file.
+        module HanamiAdapter
+          def route_prefix=(prefix)
+            @router.instance_variable_set(:@path_prefix, ::Hanami::Router::Prefix.new("/").join(prefix.to_s))
+          end
+        end
+      end
+    end
+  end
+end
+
+Hanami::API.extend(Ratalada::Contrib::Router::FileBased::HanamiAdapter)

data/lib/ratalada/contrib/router/file_based/sinatra_adapter.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "ratalada/sinatra"
+
+require_relative "../file_based"
+
+module Ratalada
+  module Contrib
+    module Router
+      module FileBased
+        # Teaches Sinatra `route_prefix`: every route defined while it is set
+        # hangs off it, which is how a route file's own `get "/members"` lands
+        # under the prefix its path spelled.
+        module SinatraAdapter
+          def route(verb, path, options = {}, &block)
+            unless route_prefix.to_s.empty?
+              path = FileBased.join(route_prefix, path)
+            end
+
+            super
+          end
+        end
+      end
+    end
+  end
+end
+
+class Sinatra::Base # rubocop:disable Style/ClassAndModuleChildren
+  set :route_prefix, ""
+
+  class << self
+    prepend Ratalada::Contrib::Router::FileBased::SinatraAdapter
+  end
+end

data/lib/ratalada/contrib/router/file_based.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require "ratalada"
+
+require_relative "file_based/expo"
+
+module Ratalada
+  module Contrib
+    module Router
+      module FileBased
+        LAYOUT = "_layout.rb"
+
+        module_function
+
+        # The app, built by whichever Ratalada frontend is in use: every route
+        # file is evaluated into the frontend's own class, under the prefix its
+        # path spells. Requiring the frontend's adapter is what teaches that
+        # class `route_prefix`.
+        def build(directory)
+          map = build_map(directory)
+
+          routes = proc do
+            map.each do |prefix, paths|
+              self.route_prefix = prefix
+              paths.each { |path| class_eval(File.read(path), path, 1) }
+            end
+          end
+
+          Ratalada.frontend.build(routes)
+        end
+
+        # A hash of route => the files that serve it, ordered most specific
+        # first. Mustermann::Expo does the file path => route translation; all
+        # this adds is which files to evaluate and how the adapter spells a
+        # placeholder.
+        #
+        # {
+        #   "/organisations/:id/edit" => ["./app/organisations/[id]/edit.rb"]
+        # }
+        def build_map(directory, placeholder: ":%s", catch_all: "*%s")
+          root = File.expand_path(directory)
+
+          Dir.glob("**/*.rb", base: root)
+            .reject { |relative| relative.split("/").any? { |segment| segment.start_with?("_") } }
+            .map { |relative| [Mustermann::Expo.route(relative), files(root, relative)] }
+            .sort_by { |(route, _paths)| [specificity(route), route] }
+            .to_h { |(route, paths)| [spell(route, placeholder, catch_all), paths] }
+        end
+
+        def files(root, relative)
+          directories = relative.split("/")[0..-2]
+
+          layouts = directories.each_index.map do |index|
+            File.join(root, *directories[0..index], LAYOUT)
+          end
+
+          [File.join(root, LAYOUT), *layouts]
+            .select { |path| File.file?(path) }
+            .push(File.join(root, relative))
+        end
+
+        # An expo route in the adapter's own spelling: "/teams/[team]" => "/teams/:team".
+        # The root route is "" — a prefix nothing hangs off, not a route of "/".
+        def spell(route, placeholder, catch_all)
+          route.delete_suffix("/").gsub(%r{\[(\.\.\.)?([^\[\]/]+)\]}) do
+            format(Regexp.last_match(1) ? catch_all : placeholder, Regexp.last_match(2))
+          end
+        end
+
+        def join(prefix, route)
+          "#{prefix}#{route.delete_suffix("/")}".sub(/\A\z/, "/")
+        end
+
+        def specificity(route)
+          route.split("/").drop(1).map do |segment|
+            case segment
+            when "[...#{Mustermann::Expo::NOT_FOUND_CAPTURE}]" then 3
+            when /\A\[\.\.\..+\]\z/ then 2
+            when /\A\[.+\]\z/ then 1
+            else 0
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ratalada/contrib/version.rb

@@ -2,6 +2,6 @@
 
 module Ratalada
   module Contrib
-    VERSION = "2.0.1"
+    VERSION = "3.0.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratalada-contrib
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Nathan K
@@ -15,14 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mustermann
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '2'
 description: |
   Optional add-on modules for ratalada that do not belong in the core gem.
   Require only the ones you use; each pulls its own framework (the
@@ -41,6 +55,11 @@ files:
 - lib/ratalada/contrib/inertia/helpers.rb
 - lib/ratalada/contrib/inertia/middleware.rb
 - lib/ratalada/contrib/inertia/response.rb
+- lib/ratalada/contrib/router/file_based.rb
+- lib/ratalada/contrib/router/file_based/expo.rb
+- lib/ratalada/contrib/router/file_based/grape_adapter.rb
+- lib/ratalada/contrib/router/file_based/hanami_adapter.rb
+- lib/ratalada/contrib/router/file_based/sinatra_adapter.rb
 - lib/ratalada/contrib/version.rb
 - lib/ratalada/contrib/vite.rb
 homepage: https://github.com/n-at-han-k/ratalada