kangaru 0.1.0

data/lib/kangaru/paths.rb

@@ -0,0 +1,93 @@
+# Builds Pathname objects for files inside a Ruby gem application. Note that
+# this assumes a conventional Ruby gem file structure.
+#
+# For example:
+#   + some_gem/          (gem_dir)
+#   | + lib/             (lib_dir)
+#   | |-- some_gem.rb    (source)
+#   | | + some_gem/      (app_dir)
+#   | | |-- some_file.rb (path)
+#
+module Kangaru
+  class Paths
+    attr_reader :source
+
+    def initialize(source:)
+      @source = Pathname.new(source)
+    end
+
+    # The directory that contains the gem.
+    def dir
+      @dir ||= gem_path.dirname
+    end
+
+    # Infers the gem name from the source filename.
+    def name
+      @name ||= source.basename(".rb").to_s
+    end
+
+    # Paths inside the root directory of the gem.
+    def gem_path(*fragments, ext: nil)
+      build_path(*fragments, dir: gem_dir, ext:)
+    end
+
+    # Paths inside the lib path of the gem. Conventionally contains two files:
+    # 1. gem_name.rb   (source_file)
+    # 2. gem_name/*.rb (app_path)
+    def lib_path(*fragments, ext: :rb)
+      build_path(*fragments, dir: lib_dir, ext:)
+    end
+
+    # The gem application directory (gem/lib/gem_name).
+    def path(*fragments, ext: :rb)
+      build_path(*fragments, dir: app_dir, ext:)
+    end
+
+    def view_path(*fragments, ext: :erb)
+      build_path(*fragments, dir: views_dir, ext:)
+    end
+
+    def collapsed_dirs
+      [models_dir, controllers_dir].map(&:to_s)
+    end
+
+    private
+
+    MODELS_DIRNAME      = "models".freeze
+    VIEWS_DIRNAME       = "views".freeze
+    CONTROLLERS_DIRNAME = "controllers".freeze
+
+    def gem_dir
+      @gem_dir ||= lib_dir.dirname
+    end
+
+    def lib_dir
+      @lib_dir ||= source.dirname
+    end
+
+    def app_dir
+      @app_dir ||= lib_dir.join(name)
+    end
+
+    def models_dir
+      @models_dir ||= app_dir.join(MODELS_DIRNAME)
+    end
+
+    def views_dir
+      @views_dir ||= app_dir.join(VIEWS_DIRNAME)
+    end
+
+    def controllers_dir
+      @controllers_dir ||= app_dir.join(CONTROLLERS_DIRNAME)
+    end
+
+    def build_path(*fragments, dir:, ext:)
+      return dir if fragments.empty?
+
+      ext  = ".#{ext}" if ext
+      file = "#{fragments.pop}#{ext}"
+
+      dir.join(*fragments, file)
+    end
+  end
+end

data/lib/kangaru/renderer.rb

@@ -0,0 +1,15 @@
+module Kangaru
+  class Renderer
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def render(binding)
+      return unless path.exist?
+
+      ERB.new(path.read, trim_mode: "-").run(binding)
+    end
+  end
+end

data/lib/kangaru/request.rb

@@ -0,0 +1,40 @@
+module Kangaru
+  class Request
+    using Patches::Inflections
+
+    include Concerns::Configurable
+
+    DEFAULT_CONTROLLER = "DefaultController".freeze
+
+    DEFAULT_ACTION = :default
+
+    attr_reader :path, :params
+
+    def initialize(path:, params:)
+      @path = path
+      @params = params
+    end
+
+    def controller
+      return default_controller if path_parser.controller.nil?
+
+      path_parser.controller&.to_class_name&.concat(Controller::SUFFIX) || raise
+    end
+
+    def action
+      path_parser.action || DEFAULT_ACTION
+    end
+
+    private
+
+    def path_parser
+      @path_parser ||= PathParser.new(path)
+    end
+
+    def default_controller
+      return DEFAULT_CONTROLLER if config.default_controller.nil?
+
+      config.default_controller.to_s
+    end
+  end
+end

data/lib/kangaru/request_builder.rb

@@ -0,0 +1,33 @@
+module Kangaru
+  class RequestBuilder
+    ARGUMENT_TOKEN = /^--?/
+
+    attr_reader :tokens
+
+    def initialize(tokens)
+      @tokens = tokens
+    end
+
+    def build
+      Request.new(path:, params:)
+    end
+
+    private
+
+    def path
+      File.join(*path_tokens).prepend("/")
+    end
+
+    def params
+      ArgumentParser.new(*param_tokens).parse
+    end
+
+    def path_tokens
+      tokens.take_while { |token| !token.match?(ARGUMENT_TOKEN) }
+    end
+
+    def param_tokens
+      tokens.drop_while { |token| !token.match?(ARGUMENT_TOKEN) }
+    end
+  end
+end

data/lib/kangaru/router.rb

@@ -0,0 +1,38 @@
+module Kangaru
+  class Router
+    using Patches::Inflections
+    using Patches::Constantise
+
+    attr_reader :request, :namespace
+
+    def initialize(request, namespace: Object)
+      @request   = request
+      @namespace = namespace
+
+      validate_controller_defined!
+      validate_action_defined!
+    end
+
+    def resolve
+      controller_class.new(request).execute
+    end
+
+    private
+
+    def controller_class
+      @controller_class ||= request.controller.constantise(root: namespace)
+    end
+
+    def validate_controller_defined!
+      return if namespace.const_defined?(request.controller)
+
+      raise "#{request.controller} is not defined in #{namespace}"
+    end
+
+    def validate_action_defined!
+      return if controller_class.instance_methods.include?(request.action)
+
+      raise "#{request.action} is not defined by #{request.controller}"
+    end
+  end
+end

data/lib/kangaru/validation/attribute_validator.rb

@@ -0,0 +1,32 @@
+module Kangaru
+  module Validation
+    class AttributeValidator
+      using Patches::Inflections
+
+      attr_reader :model, :attribute
+
+      def initialize(model:, attribute:)
+        @model = model
+        @attribute = attribute
+      end
+
+      def validate(validator, **params)
+        load_validator(validator:, params:).validate
+      end
+
+      private
+
+      def validator_name(validator)
+        "#{validator.to_s.to_class_name}Validator"
+      end
+
+      def load_validator(validator:, params:)
+        name = validator_name(validator)
+
+        raise "#{name} is not defined" unless Validators.const_defined?(name)
+
+        Validators.const_get(name).new(model:, attribute:, params:)
+      end
+    end
+  end
+end

data/lib/kangaru/validation/error.rb

@@ -0,0 +1,32 @@
+module Kangaru
+  module Validation
+    class Error
+      using Patches::Inflections
+
+      MESSAGES = {
+        blank: "can't be blank"
+      }.freeze
+
+      attr_reader :attribute, :type
+
+      def initialize(attribute:, type:)
+        @attribute = attribute
+        @type = type
+      end
+
+      def full_message
+        [human_attribute, message].join(" ")
+      end
+
+      private
+
+      def human_attribute
+        attribute.to_s.to_humanised
+      end
+
+      def message
+        MESSAGES[type] || raise("invalid message type")
+      end
+    end
+  end
+end

data/lib/kangaru/validators/required_validator.rb

@@ -0,0 +1,17 @@
+module Kangaru
+  module Validators
+    class RequiredValidator < Validator
+      def validate
+        return unless value_missing?
+
+        add_error!(:blank)
+      end
+
+      private
+
+      def value_missing?
+        value.nil? || value == "" || value == false
+      end
+    end
+  end
+end

data/lib/kangaru/validators/validator.rb

@@ -0,0 +1,22 @@
+module Kangaru
+  module Validators
+    class Validator
+      attr_reader :model, :attribute, :params, :value
+
+      def initialize(model:, attribute:, params:)
+        @model = model
+        @attribute = attribute
+        @params = params
+        @value = model.public_send(attribute)
+      end
+
+      def validate
+        raise NotImplementedError
+      end
+
+      def add_error!(type)
+        model.errors << Validation::Error.new(attribute:, type:)
+      end
+    end
+  end
+end

data/lib/kangaru/version.rb

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

data/lib/kangaru.rb

@@ -0,0 +1,58 @@
+require "zeitwerk"
+
+require "colorize"
+require "erb"
+require "fileutils"
+require "forwardable"
+require "pathname"
+require "sequel"
+require "sqlite3"
+require "yaml"
+
+module Kangaru
+  COLLAPSED_DIRS = [
+    "#{__dir__}/kangaru/components"
+  ].freeze
+
+  DEFAULT_ENV = :runtime
+
+  INFLECTIONS = {
+    "rspec" => "RSpec"
+  }.freeze
+
+  @loader = Zeitwerk::Loader.for_gem(
+    warn_on_extra_files: false
+  ).tap do |loader|
+    loader.inflector.inflect(INFLECTIONS)
+    loader.collapse(COLLAPSED_DIRS)
+    loader.setup
+  end
+
+  class << self
+    attr_writer :application
+
+    def application
+      @application || raise("application not set")
+    end
+
+    def env=(value)
+      @env = value.to_sym
+    end
+
+    def env
+      @env ||= DEFAULT_ENV
+    end
+
+    def env?(value)
+      env == value
+    end
+
+    def eager_load(namespace)
+      @loader.eager_load_namespace(namespace)
+    end
+
+    def test?
+      env == :test
+    end
+  end
+end

data/rbs_collection.lock.yaml

@@ -0,0 +1,83 @@
+---
+sources:
+- type: git
+  name: apexatoll/gem_signatures
+  revision: '086b4786ad2ada720a3ed3498ab99218e5bfc085'
+  remote: https://github.com/apexatoll/gem_signatures
+  repo_dir: sig
+- type: git
+  name: ruby/gem_rbs_collection
+  revision: 2de2d4535caba275f3b8533684aab110d921f553
+  remote: https://github.com/ruby/gem_rbs_collection.git
+  repo_dir: gems
+path: ".gems"
+gems:
+- name: bigdecimal
+  version: '0'
+  source:
+    type: stdlib
+- name: cgi
+  version: '0'
+  source:
+    type: stdlib
+- name: colorize
+  version: '1.1'
+  source:
+    type: git
+    name: apexatoll/gem_signatures
+    revision: '086b4786ad2ada720a3ed3498ab99218e5bfc085'
+    remote: https://github.com/apexatoll/gem_signatures
+    repo_dir: sig
+- name: dbm
+  version: '0'
+  source:
+    type: stdlib
+- name: erb
+  version: '0'
+  source:
+    type: stdlib
+- name: fileutils
+  version: '0'
+  source:
+    type: stdlib
+- name: forwardable
+  version: '0'
+  source:
+    type: stdlib
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib
+- name: pstore
+  version: '0'
+  source:
+    type: stdlib
+- name: sequel
+  version: '5.72'
+  source:
+    type: git
+    name: apexatoll/gem_signatures
+    revision: '086b4786ad2ada720a3ed3498ab99218e5bfc085'
+    remote: https://github.com/apexatoll/gem_signatures
+    repo_dir: sig
+- name: tempfile
+  version: '0'
+  source:
+    type: stdlib
+- name: yaml
+  version: '0'
+  source:
+    type: stdlib
+- name: zeitwerk
+  version: '2.6'
+  source:
+    type: git
+    name: apexatoll/gem_signatures
+    revision: '086b4786ad2ada720a3ed3498ab99218e5bfc085'
+    remote: https://github.com/apexatoll/gem_signatures
+    repo_dir: sig
+- name: zirconia
+  version: 0.1.2
+  source:
+    type: rubygems
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,24 @@
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+  - type: git
+    name: apexatoll/gem_signatures
+    remote: https://github.com/apexatoll/gem_signatures
+    revision: main
+    repo_dir: sig
+
+path: .gems
+
+gems:
+  - name: rake
+    ignore: true
+  - name: rspec
+    ignore: true
+  - name: rubocop
+    ignore: true
+  - name: steep
+    ignore: true

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: kangaru
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Welham
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.72'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.72'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description:
+email:
+- 71787007+apexatoll@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- kangaru.gemspec
+- lib/kangaru.rb
+- lib/kangaru/application.rb
+- lib/kangaru/argument_parser.rb
+- lib/kangaru/components/component.rb
+- lib/kangaru/concerns/attributes_concern.rb
+- lib/kangaru/concerns/concern.rb
+- lib/kangaru/concerns/configurable.rb
+- lib/kangaru/concerns/validatable.rb
+- lib/kangaru/config.rb
+- lib/kangaru/configurators.rb
+- lib/kangaru/configurators/application_configurator.rb
+- lib/kangaru/configurators/configurator.rb
+- lib/kangaru/configurators/database_configurator.rb
+- lib/kangaru/configurators/external_configurator.rb
+- lib/kangaru/configurators/open_configurator.rb
+- lib/kangaru/configurators/request_configurator.rb
+- lib/kangaru/controller.rb
+- lib/kangaru/database.rb
+- lib/kangaru/inflectors/class_inflector.rb
+- lib/kangaru/inflectors/constant_inflector.rb
+- lib/kangaru/inflectors/constantiser.rb
+- lib/kangaru/inflectors/human_inflector.rb
+- lib/kangaru/inflectors/inflector.rb
+- lib/kangaru/inflectors/inflector_macros.rb
+- lib/kangaru/inflectors/path_inflector.rb
+- lib/kangaru/inflectors/screaming_snakecase_inflector.rb
+- lib/kangaru/inflectors/snakecase_inflector.rb
+- lib/kangaru/inflectors/tokeniser.rb
+- lib/kangaru/initialiser.rb
+- lib/kangaru/initialisers/rspec.rb
+- lib/kangaru/injected_methods.rb
+- lib/kangaru/model.rb
+- lib/kangaru/patches/constantise.rb
+- lib/kangaru/patches/inflections.rb
+- lib/kangaru/patches/source.rb
+- lib/kangaru/patches/symboliser.rb
+- lib/kangaru/path_parser.rb
+- lib/kangaru/paths.rb
+- lib/kangaru/renderer.rb
+- lib/kangaru/request.rb
+- lib/kangaru/request_builder.rb
+- lib/kangaru/router.rb
+- lib/kangaru/validation/attribute_validator.rb
+- lib/kangaru/validation/error.rb
+- lib/kangaru/validators/required_validator.rb
+- lib/kangaru/validators/validator.rb
+- lib/kangaru/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: A lightweight framework for building command line interfaces
+test_files: []