kangaru 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04e8f14e4f41534168d56fdc09364a9507553658887f513a1536fe71f6a9c608
-  data.tar.gz: 3af9ce12c3a133964cf66393f0d93339c37ae5329c3bd3ddcd65f53e1f224a28
+  metadata.gz: 15146a85b29524ce8435963bbc25601017d72cafef5cf69331b920219bad4113
+  data.tar.gz: de9a21f5cb27508169c1fec64b60f7a2aeacbb0beaac0b3fa1392288ea5f7728
 SHA512:
-  metadata.gz: 6c9ee4ea2cf630d10e52d9a0a549f0ce77c5751c0469ca523baa91e15aa7eaa2e479e6120a683ad6cfb7aed8a6987cd7209d11a51a1503daa4910721718df1d8
-  data.tar.gz: d7c959405a39a4086409f8e1a739643502ef102b662728dc1859e9bc3f8195cc576b9ee81f93135536141dbbd438e37047be08e1f15048fa18d7a32f1887a883
+  metadata.gz: 03d7d75d0b7c98d7ea7cfa74390fe9bd16ad8d0c02ee7d9e5cc61499b8f545fb90cbf0b8a0361851088b59066f91c0ca24f429747c084d9984ededdd233c5363
+  data.tar.gz: 9ec21c22c2f17b8943e546060fe872d08f43c38038970abdfdafb867eff1a7d134931069ae03eae832171ab280433bf236ca22635c3fa1c59d0bd76382dfa6c4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kangaru (0.1.0)
+    kangaru (0.1.2)
       colorize (~> 1.1)
       erb (~> 4.0)
       sequel (~> 5.72)

data/README.md

@@ -2,6 +2,8 @@
 
 Kangaru is an open-source framework written in Ruby for building powerful and efficient command line applications. This project aims to make it easier for developers to create complex CLI programs with minimal effort, by providing a set of useful tools and libraries in a configurable ecosystem.
 
+> Note: This software is currently in beta mode, meaning it may contain bugs and be subject to changes. Please exercise caution when using this software and report any issues you encounter. The first production-ready release of Kangaru will be version 1.0.0.
+
 ## Features
 
 - MVC architecture drawing heavy inspiration from Rails

data/Steepfile

@@ -3,6 +3,8 @@ target :lib do
 
   check "lib"
 
+  ignore "lib/kangaru/initialisers/rspec*"
+
   configure_code_diagnostics do |hash|
     hash[Steep::Diagnostic::Ruby::FallbackAny] = nil
     hash[Steep::Diagnostic::Ruby::UnknownConstant] = :error

data/kangaru.gemspec

@@ -7,14 +7,20 @@ Gem::Specification.new do |spec|
   spec.email = ["71787007+apexatoll@users.noreply.github.com"]
 
   spec.summary = "A lightweight framework for building command line interfaces"
+  spec.homepage = "https://github.com/apexatoll/kangaru"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.2.0"
 
   spec.files = Dir.chdir(__dir__) do
     `git ls-files`.split("\n").reject do |f|
-      f == __FILE__ || f.match?(/\A(bin|sig|spec|\.git|\.github)/)
+      f == __FILE__ || f.match?(/\A(bin|spec|\.git|\.github)/)
     end
   end
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
+
   spec.bindir = "bin"
   spec.executables = []
   spec.require_paths = ["lib"]

data/lib/kangaru/application.rb

@@ -16,6 +16,10 @@ module Kangaru
       @config ||= Config.new
     end
 
+    def router
+      @router ||= Router.new(namespace:)
+    end
+
     # If called with no env, the config will be applied regardless of current
     # env. If multiple configure calls matching the current env are made, the
     # most recent calls will overwrite older changes.
@@ -39,7 +43,7 @@ module Kangaru
     def run!(*argv)
       request = RequestBuilder.new(argv).build
 
-      Router.new(request, namespace:).resolve
+      router.resolve(request)
     end
 
     def_delegators :paths, :view_path

data/lib/kangaru/concerns/configurable.rb

@@ -14,7 +14,7 @@ module Kangaru
       end
 
       def config
-        Kangaru.application.config.for(self.class.configurator_name) ||
+        Kangaru.application!.config.for(self.class.configurator_name) ||
           raise("inferred configurator not set by application")
       end
     end

data/lib/kangaru/controller.rb

@@ -13,7 +13,7 @@ module Kangaru
     end
 
     def execute
-      public_send(request.action)
+      return unless public_send(request.action)
 
       renderer_for(request.action.to_s).render(binding)
     end
@@ -30,7 +30,7 @@ module Kangaru
     private
 
     def view_path(file)
-      Kangaru.application.view_path(self.class.path, file)
+      Kangaru.application!.view_path(self.class.path, file)
     end
 
     def renderer_for(file)
@@ -43,9 +43,9 @@ module Kangaru
     # within the application namespace by delegating const lookups to said
     # namespace if the constant is not in scope from the current class.
     def self.const_missing(const)
-      return super unless Kangaru.application.namespace.const_defined?(const)
+      return super unless Kangaru.application!.namespace.const_defined?(const)
 
-      Kangaru.application.namespace.const_get(const)
+      Kangaru.application!.namespace.const_get(const)
     end
 
     private_class_method :const_missing

data/lib/kangaru/database.rb

@@ -31,7 +31,7 @@ module Kangaru
       Sequel::Migrator.run(handler, migration_path)
     end
 
-    def_delegators :handler, :tables
+    def_delegators :handler, :rollback_on_exit, :tables, :transaction
 
     private
 

data/lib/kangaru/initialisers/rspec/kangaru_helper.rb

@@ -0,0 +1,18 @@
+module Kangaru
+  module Initialisers
+    module RSpec
+      module KangaruHelper
+        def run_in_transaction(&block)
+          database = Kangaru.application&.database
+
+          return block.call if database.nil?
+
+          database.transaction do
+            block.call
+            database.rollback_on_exit
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kangaru/initialisers/rspec/request_helper.rb

@@ -0,0 +1,72 @@
+module Kangaru
+  module Initialisers
+    module RSpec
+      module RequestHelper
+        attr_reader :request
+
+        def stub_output(&block)
+          stdout  = $stdout
+          stderr  = $stderr
+          $stdout = File.open(File::NULL, "w")
+          $stderr = File.open(File::NULL, "w")
+
+          block.call
+
+          $stdout = stdout
+          $stderr = stderr
+        end
+
+        def resolve(path, params:)
+          @request = Kangaru::Request.new(path:, params:)
+
+          Kangaru.application.router.resolve(request)
+        end
+
+        def view_path(name)
+          Kangaru.application!.view_path(described_class.path, name.to_s)
+        end
+
+        if Object.const_defined?(:RSpec)
+          extend ::RSpec::Matchers::DSL
+
+          matcher :render_template do |name|
+            supports_block_expectations
+
+            match do |action|
+              renderer = instance_double(Kangaru::Renderer, render: nil)
+              allow(Kangaru::Renderer).to receive(:new).and_return(renderer)
+              expect(Kangaru::Renderer).not_to have_received(:new)
+
+              action.call
+
+              expect(Kangaru::Renderer)
+                .to have_received(:new)
+                .with(view_path(name))
+                .once
+
+              expect(renderer)
+                .to have_received(:render)
+                .once
+            end
+          end
+        end
+      end
+
+      if Object.const_defined?(:RSpec)
+        ::RSpec.configure do |config|
+          file_path = %r{spec/.*/controllers/}
+
+          config.define_derived_metadata(file_path:) do |metadata|
+            metadata[:type] = :request
+          end
+
+          config.include RequestHelper, type: :request
+
+          config.around(type: :request) do |spec|
+            stub_output { spec.run }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/kangaru/initialisers/rspec.rb

@@ -2,8 +2,14 @@ module Kangaru
   module Initialisers
     module RSpec
       if Object.const_defined?(:RSpec)
-        ::RSpec.configure do
+        ::RSpec.configure do |config|
           Kangaru.env = :test
+
+          config.include KangaruHelper
+
+          config.around do |spec|
+            run_in_transaction { spec.run }
+          end
         end
       end
     end

data/lib/kangaru/injected_methods.rb

@@ -1,23 +1,23 @@
 module Kangaru
   module InjectedMethods
     def run!(*argv)
-      Kangaru.application.run!(*argv)
+      Kangaru.application!.run!(*argv)
     end
 
     def config
-      Kangaru.application.config
+      Kangaru.application!.config
     end
 
     def configure(env = nil, &)
-      Kangaru.application.configure(env, &)
+      Kangaru.application!.configure(env, &)
     end
 
     def apply_config!
-      Kangaru.application.apply_config!
+      Kangaru.application!.apply_config!
     end
 
     def database
-      Kangaru.application.database
+      Kangaru.application!.database
     end
   end
 end

data/lib/kangaru/router.rb

@@ -5,15 +5,16 @@ module Kangaru
 
     attr_reader :request, :namespace
 
-    def initialize(request, namespace: Object)
-      @request   = request
+    def initialize(namespace: Object)
       @namespace = namespace
+    end
+
+    def resolve(request)
+      @request = request
 
       validate_controller_defined!
       validate_action_defined!
-    end
 
-    def resolve
       controller_class.new(request).execute
     end
 

data/lib/kangaru/version.rb

@@ -1,3 +1,3 @@
 module Kangaru
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.2".freeze
 end

data/lib/kangaru.rb

@@ -29,10 +29,10 @@ module Kangaru
   end
 
   class << self
-    attr_writer :application
+    attr_accessor :application
 
-    def application
-      @application || raise("application not set")
+    def application!
+      application || raise("application not set")
     end
 
     def env=(value)

data/sig/class.rbs

@@ -0,0 +1,3 @@
+class Class
+  def class_eval: ?{ [self: Class]-> void } -> void | ...
+end

data/sig/kangaru/application.rbs

@@ -0,0 +1,34 @@
+module Kangaru
+  class Application
+    extend Forwardable
+
+    attr_reader paths: Paths
+    attr_reader namespace: Module
+    attr_reader config: Config
+    attr_reader database: Database?
+    attr_reader router: Router
+
+    def initialize: (source: String, namespace: Module) -> void
+
+    def configure: (?Symbol?) { (Config) -> void } -> void
+
+    def configured?: -> bool
+
+    def apply_config!: -> void
+
+    def run!: (*String) -> void
+
+    # Delegated to paths
+    def view_path: (*String, ?ext: Symbol?) -> Pathname
+
+    private
+
+    @configured: bool
+
+    def current_env?: (Symbol?) -> bool
+
+    attr_reader autoloader: Zeitwerk::Loader
+
+    def setup_database!: -> Database?
+  end
+end

data/sig/kangaru/argument_parser.rbs

@@ -0,0 +1,17 @@
+module Kangaru
+  class ArgumentParser
+    attr_reader tokens: Array[String]
+
+    def initialize: (*String) -> void
+
+    def parse: -> Hash[Symbol, untyped]
+
+    private
+
+    def grouped_argument_tokens: -> Array[Array[String]]
+
+    def parse_key: (String) -> Symbol
+
+    def parse_value: (Array[untyped]) -> untyped
+  end
+end

data/sig/kangaru/components/component.rbs

@@ -0,0 +1,9 @@
+module Kangaru
+  class Component
+    def render: -> void
+
+    private
+
+    def view_file: -> Pathname
+  end
+end

data/sig/kangaru/concerns/attributes_concern.rbs

@@ -0,0 +1,25 @@
+module Kangaru
+  module Concerns
+    module AttributesConcern
+      extend Concern
+
+      module ClassMethods
+        def attributes: -> Array[Symbol]
+
+        def defaults: -> Hash[Symbol, untyped]
+
+        def set_default: (**untyped) -> void
+
+        @defaults: Hash[Symbol, untyped]
+      end
+
+      extend ClassMethods
+
+      attr_reader defaults: Hash[Symbol, untyped]
+
+      def instance_methods: -> Array[Symbol]
+
+      def initialize: (**untyped) -> void
+    end
+  end
+end

data/sig/kangaru/concerns/concern.rbs

@@ -0,0 +1,15 @@
+module Kangaru
+  module Concerns
+    module Concern : Module
+      @included: untyped
+
+      def append_features: (untyped) -> void
+
+      def class_methods: { [self: singleton(Class)] -> void } -> void
+
+      def included: (?untyped?) ?{ -> void } -> void
+
+      def evaluate_concern_blocks!: (untyped) -> void
+    end
+  end
+end

data/sig/kangaru/concerns/configurable.rbs

@@ -0,0 +1,15 @@
+module Kangaru
+  module Concerns
+    module Configurable
+      extend Concern
+      extend ClassMethods
+
+      module ClassMethods
+        def configurator_name: -> String
+      end
+
+      def name: -> String
+      def config: [C < Configurators::Configurator] -> C
+    end
+  end
+end

data/sig/kangaru/concerns/validatable.rbs

@@ -0,0 +1,28 @@
+module Kangaru
+  module Concerns
+    module Validatable
+      type validations = Hash[Symbol, Hash[Symbol, untyped]]
+
+      extend Concern
+      extend ClassMethods
+
+      attr_reader validation_rules: validations
+
+      module ClassMethods
+        attr_reader validation_rules: validations
+
+        def validates: (Symbol, **untyped) -> void
+      end
+
+      attr_reader errors: Array[Validation::Error]
+
+      def validate: -> void
+
+      def valid?: -> bool
+
+      private
+
+      def validator_for: (Symbol) -> Validation::AttributeValidator
+    end
+  end
+end

data/sig/kangaru/config.rbs

@@ -0,0 +1,27 @@
+module Kangaru
+  class Config
+    type configurator = Configurators::Configurator
+
+    attr_reader configurators: Hash[Symbol, configurator]
+
+    def initialize: -> void
+
+    def serialise: -> Hash[Symbol, Hash[Symbol, untyped]]
+
+    def import_external_config!: -> void
+
+    def for: (String) -> untyped
+
+    # Configurators
+    attr_reader application: Configurators::ApplicationConfigurator
+    attr_reader database:    Configurators::DatabaseConfigurator
+    attr_reader external:    Configurators::ExternalConfigurator
+    attr_reader request:     Configurators::RequestConfigurator
+
+    private
+
+    def set_configurators!: -> Hash[Symbol, configurator]
+
+    def external_config_exists?: -> bool
+  end
+end

data/sig/kangaru/configurators/application_configurator.rbs

@@ -0,0 +1,7 @@
+module Kangaru
+  module Configurators
+    class ApplicationConfigurator < Configurator
+      attr_accessor config_path: String
+    end
+  end
+end

data/sig/kangaru/configurators/configurator.rbs

@@ -0,0 +1,14 @@
+module Kangaru
+  module Configurators
+    class Configurator
+      include Concerns::AttributesConcern
+      extend  Concerns::AttributesConcern::ClassMethods
+
+      def self.key: -> Symbol
+
+      def self.name: -> String
+
+      def serialise: -> Hash[Symbol, untyped]
+    end
+  end
+end

data/sig/kangaru/configurators/database_configurator.rbs

@@ -0,0 +1,9 @@
+module Kangaru
+  module Configurators
+    class DatabaseConfigurator < Configurator
+      attr_accessor adaptor: Symbol
+      attr_accessor path: String
+      attr_accessor migration_path: String
+    end
+  end
+end

data/sig/kangaru/configurators/external_configurator.rbs

@@ -0,0 +1,6 @@
+module Kangaru
+  module Configurators
+    class ExternalConfigurator < OpenConfigurator
+    end
+  end
+end

data/sig/kangaru/configurators/open_configurator.rbs

@@ -0,0 +1,11 @@
+module Kangaru
+  module Configurators
+    class OpenConfigurator < Configurator
+      def self.from_yaml_file: (String) -> instance
+
+      private
+
+      def set_accessors!: (**untyped) -> void
+    end
+  end
+end

data/sig/kangaru/configurators/request_configurator.rbs

@@ -0,0 +1,7 @@
+module Kangaru
+  module Configurators
+    class RequestConfigurator < Configurator
+      attr_accessor default_controller: (String | Symbol | singleton(Controller))
+    end
+  end
+end

data/sig/kangaru/configurators.rbs

@@ -0,0 +1,7 @@
+module Kangaru
+  module Configurators
+    BASE_CONFIGURATORS: Array[singleton(Configurator)]
+
+    def self.classes: -> Array[singleton(Configurator)]
+  end
+end

data/sig/kangaru/controller.rbs

@@ -0,0 +1,23 @@
+module Kangaru
+  class Controller
+    extend Forwardable
+
+    SUFFIX: String
+
+    attr_reader request: Request
+
+    def initialize: (Request) -> void
+
+    def execute: -> void
+
+    def self.path: -> String
+
+    def params: -> Hash[Symbol, untyped]
+    
+    private
+
+    def view_path: (String) -> Pathname
+
+    def renderer_for: (String) -> Renderer
+  end
+end

data/sig/kangaru/database.rbs

@@ -0,0 +1,31 @@
+module Kangaru
+  class Database
+    extend Forwardable
+
+    include Concerns::AttributesConcern
+    extend  Concerns::AttributesConcern::ClassMethods
+
+    PLUGINS: Array[Symbol]
+
+    attr_accessor adaptor: Symbol
+    attr_accessor path: String
+    attr_accessor migration_path: String
+
+    attr_reader handler: Sequel::Database
+
+    def setup!: -> void
+
+    def migrate!: -> void
+
+    # Delegated to handler
+    def rollback_on_exit: -> void
+    def tables: -> Array[Symbol]
+    def transaction: { -> void } -> void
+
+    private
+
+    def migrations_exist?: -> bool
+
+    def setup_sqlite!: -> Sequel::Database
+  end
+end

data/sig/kangaru/inflectors/class_inflector.rbs

@@ -0,0 +1,6 @@
+module Kangaru
+  module Inflectors
+    class ClassInflector < Inflector
+    end
+  end
+end

data/sig/kangaru/inflectors/constant_inflector.rbs

@@ -0,0 +1,7 @@
+module Kangaru
+  module Inflectors
+    class ConstantInflector < ClassInflector
+      LAST_WORD: Regexp
+    end
+  end
+end

data/sig/kangaru/inflectors/constantiser.rbs

@@ -0,0 +1,9 @@
+module Kangaru
+  module Inflectors
+    class Constantiser
+      attr_reader string: String
+
+      def self.constantise: (String, ?root: Module) -> untyped
+    end
+  end
+end

data/sig/kangaru/inflectors/human_inflector.rbs

@@ -0,0 +1,6 @@
+module Kangaru
+  module Inflectors
+    class HumanInflector < Inflector
+    end
+  end
+end

data/sig/kangaru/inflectors/inflector.rbs

@@ -0,0 +1,47 @@
+module Kangaru
+  module Inflectors
+    class Inflector
+      type token_groups = Array[Array[String]]
+
+      extend InflectorMacros
+
+      DEFAULT_GROUP_JOINER: String
+
+      attr_reader string: String
+
+      def initialize: (String) -> void
+
+      def inflect: -> String
+
+      def self.inflect: (String) -> String
+
+      private
+
+      attr_reader tokeniser: Tokeniser
+
+      def class_attribute: (Symbol) -> untyped
+
+      def input_filter: -> untyped
+
+      def token_transformer: -> untyped
+
+      def token_joiner: -> untyped
+
+      def group_joiner: -> untyped
+
+      def post_processor: -> untyped
+
+      def filter_input: (String) -> String
+
+      def transform_and_join_tokens: (Array[Array[String]]) -> Array[String]
+
+      def transform_token: (String) -> String
+
+      def join_tokens: (Array[String]) -> String
+
+      def join_groups: (Array[String]) -> String
+
+      def post_process: (String) -> String
+    end
+  end
+end

data/sig/kangaru/inflectors/inflector_macros.rbs

@@ -0,0 +1,23 @@
+module Kangaru
+  module Inflectors
+    module InflectorMacros
+      @input_filter: untyped
+      @token_transformer: untyped
+      @token_joiner: untyped
+      @group_joiner: untyped
+      @post_processor: untyped
+
+      def inherited: (Class) -> void
+
+      def filter_input_with: (Regexp) -> void
+
+      def transform_tokens_with: (?Symbol?) ?{ (String) -> String } -> void
+
+      def join_tokens_with: (String) -> void
+
+      def join_groups_with: (String) -> void
+
+      def post_process_with: (?Symbol?) ?{ (String) -> String } -> void
+    end
+  end
+end

data/sig/kangaru/inflectors/path_inflector.rbs

@@ -0,0 +1,7 @@
+module Kangaru
+  module Inflectors
+    class PathInflector < Inflector
+      def inflect: (?with_ext: String?) -> String
+    end
+  end
+end

data/sig/kangaru/inflectors/screaming_snakecase_inflector.rbs

@@ -0,0 +1,6 @@
+module Kangaru
+  module Inflectors
+    class ScreamingSnakecaseInflector < SnakecaseInflector
+    end
+  end
+end

data/sig/kangaru/inflectors/snakecase_inflector.rbs

@@ -0,0 +1,6 @@
+module Kangaru
+  module Inflectors
+    class SnakecaseInflector < Inflector
+    end
+  end
+end

data/sig/kangaru/inflectors/tokeniser.rbs

@@ -0,0 +1,14 @@
+module Kangaru
+  module Inflectors
+    class Tokeniser
+      GROUP_DELIMITER: Regexp
+      TOKEN_DELIMITER: Regexp
+
+      attr_reader string: String
+
+      def initialize: (String) -> void
+
+      def split: -> Array[Array[String]]
+    end
+  end
+end

data/sig/kangaru/initialiser.rbs

@@ -0,0 +1,9 @@
+module Kangaru
+  module Initialiser
+    module InjectedMethods
+      include Kangaru::_ApplicationMethods
+    end
+
+    def self.extended: (Module) -> void
+  end
+end

data/sig/kangaru/initialisers/rspec.rbs

@@ -0,0 +1,6 @@
+module Kangaru
+  module Initialisers
+    module RSpec
+    end
+  end
+end

data/sig/kangaru/injected_methods.rbs

@@ -0,0 +1,17 @@
+module Kangaru
+  module InjectedMethods
+    interface _InjectedMethods
+      def run!: (*String) -> void
+
+      def config: -> Config
+
+      def configure: (?Symbol?) { (Config) -> void } -> void
+
+      def apply_config!: -> void
+
+      def database: -> Database?
+    end
+
+    include _InjectedMethods
+  end
+end

data/sig/kangaru/model.rbs

@@ -0,0 +1,16 @@
+module Kangaru
+  # This is a hacky fix to ensure that the definition of Model via Class.new is
+  # typed to be the same as if it was called with `class Model; end`.
+  # This is to prevent the inherited hook trying to find a `models` database
+  # table when Sequel::Model is inherited in the conventional way.
+  class Class
+    def self.new: (untyped) { -> void } -> singleton(Model)
+  end
+
+  class Model < Sequel::Model
+    include Concerns::Validatable
+    extend  Concerns::Validatable::ClassMethods
+
+    def self.enum: (Symbol, **Integer) -> void
+  end
+end

data/sig/kangaru/patches/constantise.rbs

@@ -0,0 +1,9 @@
+module Kangaru
+  module Patches
+    module Constantise : String
+      class ::String
+        def constantise: (?root: Module) -> untyped
+      end
+    end
+  end
+end

data/sig/kangaru/patches/inflections.rbs

@@ -0,0 +1,15 @@
+module Kangaru
+  module Patches
+    module Inflections : String
+      class ::String
+        def to_class_name: -> String
+
+        def to_constant_name: -> String
+
+        def to_snakecase: -> String
+
+        def to_humanised: -> String
+      end
+    end
+  end
+end

data/sig/kangaru/patches/source.rbs

@@ -0,0 +1,9 @@
+module Kangaru
+  module Patches
+    module Source : Module
+      class ::Module
+        def source: -> String
+      end
+    end
+  end
+end

data/sig/kangaru/patches/symboliser.rbs

@@ -0,0 +1,13 @@
+module Kangaru
+  module Patches
+    module Symboliser : Enumerable[untyped]
+      class ::Hash[unchecked out K, unchecked out V]
+        def symbolise: -> Hash[Symbol, untyped]
+      end
+
+      class Array[unchecked out Elem]
+        def symbolise: -> Hash[Symbol, untyped]
+      end
+    end
+  end
+end

data/sig/kangaru/path_parser.rbs

@@ -0,0 +1,19 @@
+module Kangaru
+  class PathParser
+    attr_reader path: String
+
+    def initialize: (String) -> void
+
+    def controller: -> String?
+
+    def action: -> Symbol?
+
+    def id: -> Integer?
+
+    private
+
+    MATCHERS: Hash[Symbol, Regexp]
+
+    def match: (Symbol, ?cast: Symbol) -> untyped
+  end
+end

data/sig/kangaru/paths.rbs

@@ -0,0 +1,35 @@
+module Kangaru
+  class Paths
+    attr_reader source: Pathname
+    attr_reader dir: Pathname
+    attr_reader name: String
+
+    def initialize: (source: String) -> void
+
+    def gem_path: (*String, ?ext: Symbol?) -> Pathname
+
+    def lib_path: (*String, ?ext: Symbol?) -> Pathname
+
+    def path: (*String, ?ext: Symbol?) -> Pathname
+
+    def view_path: (*String, ?ext: Symbol?) -> Pathname
+
+    def collapsed_dirs: -> Array[String]
+
+    private
+
+    MODELS_DIRNAME: String
+    VIEWS_DIRNAME: String
+    CONTROLLERS_DIRNAME: String
+
+    attr_reader gem_dir: Pathname
+    attr_reader lib_dir: Pathname
+    attr_reader app_dir: Pathname
+
+    attr_reader models_dir: Pathname
+    attr_reader views_dir: Pathname
+    attr_reader controllers_dir: Pathname
+
+    def build_path: (*String, dir: Pathname, ext: Symbol?) -> Pathname
+  end
+end

data/sig/kangaru/renderer.rbs

@@ -0,0 +1,9 @@
+module Kangaru
+  class Renderer
+    attr_reader path: Pathname
+
+    def initialize: (Pathname) -> void
+
+    def render: (Binding) -> void
+  end
+end

data/sig/kangaru/request.rbs

@@ -0,0 +1,24 @@
+module Kangaru
+  class Request
+    include Concerns::Configurable
+
+    DEFAULT_CONTROLLER: String
+
+    DEFAULT_ACTION: Symbol
+
+    attr_reader path: String
+    attr_reader params: Hash[Symbol, untyped]
+
+    def initialize: (path: String, params: Hash[Symbol, untyped]) -> void
+
+    def controller: -> String
+
+    def action: -> Symbol
+
+    private
+
+    attr_reader path_parser: PathParser
+
+    def default_controller: -> String
+  end
+end

data/sig/kangaru/request_builder.rbs

@@ -0,0 +1,21 @@
+module Kangaru
+  class RequestBuilder
+    ARGUMENT_TOKEN: Regexp
+
+    attr_reader tokens: Array[String]
+
+    def initialize: (Array[String]) -> void
+
+    def build: -> Request
+
+    private
+
+    def path: -> String
+
+    def params: -> Hash[Symbol, untyped]
+
+    def path_tokens: -> Array[String]
+
+    def param_tokens: -> Array[String]
+  end
+end

data/sig/kangaru/router.rbs

@@ -0,0 +1,26 @@
+module Kangaru
+  class Router
+    extend Forwardable
+
+    attr_reader request: Request
+    attr_reader namespace: Module
+
+    def initialize: (?namespace: Module) -> void
+
+    def resolve: (Request) -> void
+
+    private
+
+    @controller_class: untyped
+
+    # Delegated to command
+    def controller_name: -> String
+    def action: -> Symbol
+
+    def controller_class: -> untyped
+
+    def validate_controller_defined!: -> void
+
+    def validate_action_defined!: -> void
+  end
+end

data/sig/kangaru/validation/attribute_validator.rbs

@@ -0,0 +1,21 @@
+module Kangaru
+  module Validation
+    class AttributeValidator
+      attr_reader model: untyped
+      attr_reader attribute: Symbol
+
+      def initialize: (model: untyped, attribute: Symbol) -> void
+
+      def validate: (Symbol, **untyped) -> void
+
+      private
+
+      def validator_name: (Symbol) -> String
+
+      def load_validator: (
+        validator: Symbol,
+        params: Hash[Symbol, untyped]
+      ) -> Validators::Validator
+    end
+  end
+end

data/sig/kangaru/validation/error.rbs

@@ -0,0 +1,20 @@
+module Kangaru
+  module Validation
+    class Error
+      MESSAGES: Hash[Symbol, String]
+
+      attr_reader attribute: Symbol
+      attr_reader type: Symbol
+
+      def initialize: (attribute: Symbol, type: Symbol) -> void
+
+      def full_message: -> String
+
+      private
+
+      def human_attribute: -> String
+
+      def message: -> String
+    end
+  end
+end

data/sig/kangaru/validators/required_validator.rbs

@@ -0,0 +1,9 @@
+module Kangaru
+  module Validators
+    class RequiredValidator < Validator
+      private
+
+      def value_missing?: -> bool
+    end
+  end
+end

data/sig/kangaru/validators/validator.rbs

@@ -0,0 +1,20 @@
+module Kangaru
+  module Validators
+    class Validator
+      attr_reader model: untyped
+      attr_reader attribute: Symbol
+      attr_reader params: Hash[Symbol, untyped]
+      attr_reader value: untyped
+
+      def initialize: (
+        model: untyped,
+        attribute: Symbol,
+        params: Hash[Symbol, untyped]
+      ) -> void
+
+      def validate: -> void
+
+      def add_error!: (Symbol) -> void
+    end
+  end
+end

data/sig/kangaru.rbs

@@ -0,0 +1,29 @@
+module Kangaru
+  VERSION: String
+
+  COLLAPSED_DIRS: Array[String]
+  DEFAULT_ENV: Symbol
+  INFLECTIONS: Hash[String, String]
+
+  extend ClassMethods
+
+  module ClassMethods
+    @loader: Zeitwerk::Loader
+
+    attr_accessor application: Application?
+    attr_accessor env: Symbol
+
+    def application!: -> Application
+
+    def env?: (Symbol) -> bool
+
+    def eager_load: (Module) -> void
+
+    def test?: -> bool
+  end
+
+  # Included in target applications that extend Kangaru::Initialiser.
+  interface _ApplicationMethods
+    include InjectedMethods::_InjectedMethods
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kangaru
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Chris Welham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-07 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -128,6 +128,8 @@ files:
 - lib/kangaru/inflectors/tokeniser.rb
 - lib/kangaru/initialiser.rb
 - lib/kangaru/initialisers/rspec.rb
+- lib/kangaru/initialisers/rspec/kangaru_helper.rb
+- lib/kangaru/initialisers/rspec/request_helper.rb
 - lib/kangaru/injected_methods.rb
 - lib/kangaru/model.rb
 - lib/kangaru/patches/constantise.rb
@@ -147,10 +149,60 @@ files:
 - lib/kangaru/version.rb
 - rbs_collection.lock.yaml
 - rbs_collection.yaml
-homepage:
+- sig/class.rbs
+- sig/kangaru.rbs
+- sig/kangaru/application.rbs
+- sig/kangaru/argument_parser.rbs
+- sig/kangaru/components/component.rbs
+- sig/kangaru/concerns/attributes_concern.rbs
+- sig/kangaru/concerns/concern.rbs
+- sig/kangaru/concerns/configurable.rbs
+- sig/kangaru/concerns/validatable.rbs
+- sig/kangaru/config.rbs
+- sig/kangaru/configurators.rbs
+- sig/kangaru/configurators/application_configurator.rbs
+- sig/kangaru/configurators/configurator.rbs
+- sig/kangaru/configurators/database_configurator.rbs
+- sig/kangaru/configurators/external_configurator.rbs
+- sig/kangaru/configurators/open_configurator.rbs
+- sig/kangaru/configurators/request_configurator.rbs
+- sig/kangaru/controller.rbs
+- sig/kangaru/database.rbs
+- sig/kangaru/inflectors/class_inflector.rbs
+- sig/kangaru/inflectors/constant_inflector.rbs
+- sig/kangaru/inflectors/constantiser.rbs
+- sig/kangaru/inflectors/human_inflector.rbs
+- sig/kangaru/inflectors/inflector.rbs
+- sig/kangaru/inflectors/inflector_macros.rbs
+- sig/kangaru/inflectors/path_inflector.rbs
+- sig/kangaru/inflectors/screaming_snakecase_inflector.rbs
+- sig/kangaru/inflectors/snakecase_inflector.rbs
+- sig/kangaru/inflectors/tokeniser.rbs
+- sig/kangaru/initialiser.rbs
+- sig/kangaru/initialisers/rspec.rbs
+- sig/kangaru/injected_methods.rbs
+- sig/kangaru/model.rbs
+- sig/kangaru/patches/constantise.rbs
+- sig/kangaru/patches/inflections.rbs
+- sig/kangaru/patches/source.rbs
+- sig/kangaru/patches/symboliser.rbs
+- sig/kangaru/path_parser.rbs
+- sig/kangaru/paths.rbs
+- sig/kangaru/renderer.rbs
+- sig/kangaru/request.rbs
+- sig/kangaru/request_builder.rbs
+- sig/kangaru/router.rbs
+- sig/kangaru/validation/attribute_validator.rbs
+- sig/kangaru/validation/error.rbs
+- sig/kangaru/validators/required_validator.rbs
+- sig/kangaru/validators/validator.rbs
+homepage: https://github.com/apexatoll/kangaru
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/apexatoll/kangaru
+  source_code_uri: https://github.com/apexatoll/kangaru
+  changelog_uri: https://github.com/apexatoll/kangaru/releases
 post_install_message:
 rdoc_options: []
 require_paths: