raindeer 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f7ae1bba0016a40407b2cf3c2aed11c488804e91cc72e31c99196e149b4441f
-  data.tar.gz: 21a6a788f1644a7750a015ae11b8a7139e0fe59c6f8020450255dc6030aa8d56
+  metadata.gz: 469efa25bc152127c137e44e3abff2d3e91aa79e17d9aac36bd18bb9a797f33b
+  data.tar.gz: 58c0b86b6bed031341331505716c7083715fa10569e4b5739ed3cb0a2a4b7209
 SHA512:
-  metadata.gz: 98209c5df7cb9efc6bdb71e692630ced455e862dfa09c9191db122cedfc109b3289e7f193182ef7940775c7e4d9b479e9f62d0d5c869cf72b85949fb34246c5a
-  data.tar.gz: c8bd4fba60835d9fbb4ee61142efda3cfcaa16d7a094cdb1e10b44d3ef3b94c274a1bff9878c639fad31c2d483986561a78c34660dcc7daefe8047da0f555e7e
+  metadata.gz: 6959daa057254a96fb30f2ace877d5dad8d94a6511f488efb6d62a871d29b459b3abf4537e005ac2bb6ca699541a54de943f7fe5226c6e2a7fe3a1cbde0f2239
+  data.tar.gz: e9b8aced4d8ec8ec77a6dbf11f19917bf5dd3db20151590d58d2f769b965d0e90fc3f455948e59841f284aa5fd07048bbf66c9e0127a7be52cfce6941538a559

data/lib/boot.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'low_dependency'
+require 'low_loop'
+
+require_relative 'router/router'
+
+LowDependency.provide('low.loop') do
+  LowLoop.new
+end
+
+LowDependency.provide('rain.router') do
+  # TODO: Use "def method(dependency: Dependency)" in rain router's constructor when this feature is ready.
+  RainRouter.new(low_loop: Low::Providers['low.loop'])
+end
+
+require_relative 'system/system'

data/lib/raindeer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'low_dependency'
+require 'low_event'
+require 'low_node'
+require 'low_type'
+require 'observers'
+
+require_relative 'router/router'
+
+class Raindeer
+  class << self
+    def router(&block)
+      Low::Providers['rain.router'].instance_eval(&block)
+    end
+  end
+end

data/lib/router/route.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Rain
+  class Route
+    include LowType
+
+    attr_reader :path, :verbs
+
+    def initialize(path: String, verbs: Array[String | nil] | [])
+      @path = path
+      @verbs = verbs
+    end
+  end
+end

data/lib/router/route_event.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'low_event'
+
+module Rain
+  class RouteEvent < ::LowEvent
+    attr_reader :route, :params
+
+    def initialize(route:, action: :render, params: Hash | nil)
+      super(action:)
+
+      @route = route
+      @params = params
+    end
+  end
+end

data/lib/router/router.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'low_dependency'
+require 'low_event'
+
+require_relative 'route'
+require_relative 'route_event'
+require_relative 'trie'
+
+module Rain
+  class Router
+    include LowType
+    include Observers
+
+    attr_reader :routes, :trie
+
+    def initialize(low_loop:)
+      @breadcrumbs = []
+      @routes = {}
+      @trie = Trie.new
+
+      observe low_loop
+    end
+
+    def route(path, verbs = [], &block)
+      @breadcrumbs << path
+      path = @breadcrumbs.join
+
+      route = Route.new(path:, verbs: [*verbs])
+      @routes[path] = route
+      @trie.merge(route:)
+
+      block.call if block_given?
+
+      @breadcrumbs.pop
+    end
+
+    def get(path = String, &block)
+      route(path, 'GET', &block)
+    end
+
+    def post(path = String, &block)
+      route(path, 'POST', &block)
+    end
+
+    def update(path = String, &block)
+      route(path, 'UPDATE', &block)
+    end
+
+    def delete(path = String, &block)
+      route(path, 'DELETE', &block)
+    end
+
+    # TODO: Define type: ::Low::Events::RequestEvent
+    # You can override any route/status simply by adding your own observer.
+    def handle(event:)
+      response_event = nil
+
+      @trie.match(path: event.request.path).each do |route_event|
+        response_event = trigger route_event.route.path, event: route_event
+      end
+
+      if response_event.nil?
+        status = LowType::Status[404]
+        response_event = trigger status, action: :render, event: Low::Events::StatusEvent.new(status:, request: event.request)
+      end
+
+      response_event
+    end
+  end
+end
+
+RainRouter = Rain::Router

data/lib/router/trie.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative 'route'
+require_relative 'route_event'
+require_relative 'trie_node'
+
+module Rain
+  class Trie
+    include LowType
+
+    PARAM_DELIMITERS = ['/', ':'].freeze
+    ARG_DELIMITERS = ['/'].freeze
+
+    attr_reader :root_node
+
+    def initialize
+      @root_node = TrieNode.new
+    end
+
+    def root_path_node
+      @root_node.nodes['/']
+    end
+
+    def merge(route:, current_node: @root_node, current_index: 0)
+      path = route.path
+
+      while current_index < path.length
+        key = path[current_index]
+
+        if key == ':'
+          key, current_index = capture_param(current_index:, path:)
+        else
+          current_index += 1
+        end
+
+        current_node = current_node.upsert_child(key:)
+      end
+
+      current_node.route = route
+    end
+
+    def match(path:, current_node: @root_node, current_index: 0, params: {})
+      return [] if (key = path[current_index]).nil?
+
+      route_events = []
+
+      # Static request path segment.
+      if (child_node = current_node.child(key:))
+        route_events << route_event(next_index: current_index + 1, params:, path:, route: child_node.route) if child_node.route
+        route_events = [*route_events, *match(path:, current_node: child_node, current_index: current_index + 1, params:)]
+      end
+
+      # Dynamic request path segment.
+      current_node.params.each do |param|
+        child_node = current_node.child(key: param)
+
+        arg, next_index = capture_arg(arg_start_index: current_index, path:)
+        params[param.delete_prefix(':').to_sym] = arg
+
+        route_events << route_event(next_index:, params:, path:, route: child_node.route) if child_node.route
+        route_events = [*route_events, *match(path:, current_node: child_node, current_index: next_index, params:)]
+      end
+
+      route_events
+    end
+
+    private
+
+    # End nodes render events, mid nodes handle events.
+    def route_event(next_index:, params:, path:, route:)
+      action = path[next_index].nil? ? :render : :handle
+      RouteEvent.new(action:, route:, params:)
+    end
+
+    def capture_param(current_index:, path:)
+      current_index += 1
+      param = [':']
+
+      path[current_index...path.length].chars.each do |char|
+        break if PARAM_DELIMITERS.include?(char)
+
+        current_index += 1
+        param << char
+      end
+
+      [param.join, current_index]
+    end
+
+    def capture_arg(arg_start_index:, path:)
+      next_index = arg_start_index
+      arg = []
+
+      path[arg_start_index...path.length].chars.each do |char|
+        arg << char
+        next_index += 1
+        break if path[next_index].nil? || ARG_DELIMITERS.include?(path[next_index])
+      end
+
+      [arg.join, next_index]
+    end
+  end
+end

data/lib/router/trie_node.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'route'
+
+module Rain
+  class TrieNode
+    include LowType
+    using LowType::Syntax
+
+    # TODO: Represent empty hash/array return value as {}/[] rather than Hash/Array (https://github.com/low-rb/low_type/issues/16)
+    type_reader nodes: Hash[String => TrieNode] | Hash
+    type_reader params: Array[String] | Array
+    type_accessor route: Route | nil
+
+    def initialize
+      @nodes = {}
+      @params = []
+      @route = nil
+    end
+
+    def child(key: String)
+      @nodes[key]
+    end
+
+    def upsert_child(key: String)
+      @params << key if key.start_with?(':')
+      @nodes[key] || @nodes[key] = TrieNode.new
+    end
+  end
+end

data/lib/system/page_not_found_node.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class PageNotFoundNode < LowNode
+  observe Status[404]
+
+  def render(event: StatusEvent)
+    <<~HTML
+      <div class="page-not-found">
+        <em>404</em>
+      </div>
+    HTML
+  end
+end

data/lib/system/system.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative '../raindeer'
+require_relative 'system_node'
+
+Raindeer.router do
+  get '/system'
+end

data/lib/system/system_node.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'page_not_found_node'
+
+class SystemNode < LowNode
+  observe '/system'
+
+  def render(event: RouteEvent)
+    'SYSTEM!'
+  end
+end

data/lib/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Raindeer
-  VERSION = '0.0.0'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raindeer
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - maedi
@@ -9,6 +9,76 @@ bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: low_dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: low_event
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: low_loop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: low_node
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: low_state
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: low_type
   requirement: !ruby/object:Gem::Requirement
@@ -23,6 +93,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: antlers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: expressions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: observers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A new Ruby framework. Coming soon...
 email:
 - maediprichard@gmail.com
@@ -30,6 +142,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/boot.rb
+- lib/raindeer.rb
+- lib/router/route.rb
+- lib/router/route_event.rb
+- lib/router/router.rb
+- lib/router/trie.rb
+- lib/router/trie_node.rb
+- lib/system/page_not_found_node.rb
+- lib/system/system.rb
+- lib/system/system_node.rb
 - lib/version.rb
 homepage: https://codeberg.org/raindeer/raindeer
 licenses: []