kangaru 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f81016147f4602231fda1758cc6064101872f31d56d65aa830d3917caef5fae
-  data.tar.gz: 117244d96c1de48b808bcd8a68810d1582d39f60e26969e393057297cb711363
+  metadata.gz: db7c4419e9f9d9661c4d12498fcb5450cde2f209958f0bb7249a39dec4a93b54
+  data.tar.gz: 43b3237bf249c4c4a3ef59eddbd4328a7b03a0084d9c69296557bab93d0b1492
 SHA512:
-  metadata.gz: c4eb18b51418ae6c2286f7091e18335e8d7f710bd405c36fa190ddf5ecbd0d3a55107e1e6ec25fc3dae5be46774e6531b692e2d1c207660a0aef4aa87eefc5f9
-  data.tar.gz: 0fa8ecd03c0ac6d392c3e4555e0edc62dac602814707e781b6bc971f20ca85cf968937bddb281cb8d7716de521dc0673672852c51a49858ba48a3b31faa8548e
+  metadata.gz: c2c5dff9c5ecd0a4401261203f6c89d5837b7824dae3e88d8dd1ad7683f7ae9b65200892d81f4d20d181acca253c5b4dab9b48c24dae32c069dd3ddcea8fd5d9
+  data.tar.gz: 6b1c7bbef5ef7a08437b5bd33b7fcfa8d2106bd29b52f8df7e56a228caff297fd22df609b96d8a6828390d6bc503bf4105fab52064efb1b4e146866e81a30162

data/.rubocop.yml

@@ -73,3 +73,5 @@ RSpec/NestedGroups:
   Enabled: false
 RSpec/SharedExamples:
   Enabled: false
+RSpec/ExampleLength:
+  Max: 7

data/Gemfile.lock

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

data/README.md

@@ -2,7 +2,7 @@
 
 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 0.2.0.
+> 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
 

data/kangaru.gemspec

@@ -7,6 +7,7 @@ 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"
 
@@ -15,6 +16,11 @@ Gem::Specification.new do |spec|
       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

@@ -2,8 +2,12 @@ module Kangaru
   class Application
     extend Forwardable
 
+    class InvalidConfigError < StandardError; end
+
     attr_reader :paths, :namespace, :database
 
+    attr_accessor :config_path
+
     def initialize(source:, namespace:)
       @paths = Paths.new(source:)
       @namespace = namespace
@@ -34,7 +38,9 @@ module Kangaru
     def apply_config!
       raise "config already applied" if configured?
 
-      config.import_external_config!
+      config.import!(config_path) unless config_path.nil?
+
+      validate_config!
 
       @database = setup_database!
       @configured = true
@@ -46,6 +52,12 @@ module Kangaru
       router.resolve(request)
     end
 
+    def const_get(const)
+      return unless namespace.const_defined?(const)
+
+      namespace.const_get(const)
+    end
+
     def_delegators :paths, :view_path
 
     private
@@ -65,6 +77,14 @@ module Kangaru
       end
     end
 
+    def validate_config!
+      return if config.valid?
+
+      message = config.errors.map(&:full_message).join(", ")
+
+      raise InvalidConfigError, message
+    end
+
     def setup_database!
       return unless config.database.adaptor
 

data/lib/kangaru/concerns/attributes_concern.rb

@@ -22,6 +22,10 @@ module Kangaru
       def initialize(**attributes)
         attributes = self.class.defaults.merge(**attributes)
 
+        merge!(**attributes)
+      end
+
+      def merge!(**attributes)
         attributes.slice(*self.class.attributes).each do |attr, value|
           instance_variable_set(:"@#{attr}", value)
         end

data/lib/kangaru/concerns/configurable.rb

@@ -3,18 +3,19 @@ module Kangaru
     module Configurable
       extend Concern
 
-      using Patches::Constantise
+      using Patches::Inflections
 
       class_methods do
-        def configurator_name
+        def configurator_key
           (name || raise("class name not set"))
-            .gsub(/^(.*?)::/, "\\1::Configurators::")
-            .concat("Configurator")
+            .gsub(/^.*::/, "")
+            .to_snakecase
+            .to_sym
         end
       end
 
       def config
-        Kangaru.application!.config.for(self.class.configurator_name) ||
+        Kangaru.application!.config[self.class.configurator_key] ||
           raise("inferred configurator not set by application")
       end
     end

data/lib/kangaru/config.rb

@@ -1,27 +1,38 @@
 module Kangaru
   class Config
+    using Patches::Symboliser
+
     attr_reader :configurators
 
     def initialize
       @configurators = set_configurators!
     end
 
+    def import!(path)
+      read_external_config(path).each do |key, config|
+        configurators[key]&.merge!(**config)
+      end
+    end
+
     def serialise
       configurators.transform_values(&:serialise)
     end
 
-    def import_external_config!
-      return unless external_config_exists?
+    def [](key)
+      configurators[key.to_sym]
+    end
 
-      @external = Configurators::ExternalConfigurator
-                    .from_yaml_file(application.config_path)
+    def valid?
+      validate
+      errors.empty?
     end
 
-    # Returns the configurator instance with the given class name.
-    def for(configurator_name)
-      configurators.values.find do |configurator|
-        configurator.class.name == configurator_name # rubocop:disable Style
-      end
+    def validate
+      configurators.each_value(&:validate)
+    end
+
+    def errors
+      configurators.values.flat_map(&:errors)
     end
 
     private
@@ -38,8 +49,10 @@ module Kangaru
       end
     end
 
-    def external_config_exists?
-      application.config_path && File.exist?(application.config_path)
+    def read_external_config(path)
+      return {} unless File.exist?(path)
+
+      YAML.load_file(path)&.symbolise || {}
     end
   end
 end

data/lib/kangaru/configurator.rb

@@ -0,0 +1,21 @@
+module Kangaru
+  class Configurator
+    include Concerns::AttributesConcern
+    include Concerns::Validatable
+
+    using Patches::Inflections
+
+    def self.key
+      to_s.gsub(/^.*::(?!.*::)/, "")
+          .delete_suffix("Configurator")
+          .to_snakecase
+          .to_sym
+    end
+
+    def serialise
+      self.class.attributes.to_h do |setting|
+        [setting, send(setting)]
+      end.compact
+    end
+  end
+end

data/lib/kangaru/configurators.rb

@@ -1,12 +1,21 @@
 module Kangaru
   module Configurators
-    # These are not set as accessors by Config instances as they are abstract.
-    BASE_CONFIGURATORS = [Configurator, OpenConfigurator].freeze
-
     def self.classes
-      constants.map    { |constant| const_get(constant) }
-               .select { |constant| constant.is_a?(Class) }
-               .reject { |constant| BASE_CONFIGURATORS.include?(constant) }
+      load_classes(self) + load_classes(application_configurators)
+    end
+
+    def self.application_configurators
+      Kangaru.application&.const_get(:Configurators)
     end
+
+    def self.load_classes(root)
+      return [] if root.nil?
+
+      root.constants.map    { |const| root.const_get(const) }
+                    .select { |const| const.is_a?(Class) }
+    end
+
+    private_class_method :application_configurators
+    private_class_method :load_classes
   end
 end

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

@@ -2,8 +2,6 @@ module Kangaru
   module Initialisers
     module RSpec
       module RequestHelper
-        extend ::RSpec::Matchers::DSL
-
         attr_reader :request
 
         def stub_output(&block)
@@ -28,24 +26,28 @@ module Kangaru
           Kangaru.application!.view_path(described_class.path, name.to_s)
         end
 
-        matcher :render_template do |name|
-          supports_block_expectations
+        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)
+            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
+              action.call
 
-            expect(Kangaru::Renderer)
-              .to have_received(:new)
-              .with(view_path(name))
-              .once
+              expect(Kangaru::Renderer)
+                .to have_received(:new)
+                .with(view_path(name))
+                .once
 
-            expect(renderer)
-              .to have_received(:render)
-              .once
+              expect(renderer)
+                .to have_received(:render)
+                .once
+            end
           end
         end
       end

data/lib/kangaru/injected_methods.rb

@@ -12,6 +12,10 @@ module Kangaru
       Kangaru.application!.configure(env, &)
     end
 
+    def import_config_from!(path)
+      Kangaru.application!.config_path = path
+    end
+
     def apply_config!
       Kangaru.application!.apply_config!
     end

data/lib/kangaru/version.rb

@@ -1,3 +1,3 @@
 module Kangaru
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end

data/sig/kangaru/application.rbs

@@ -2,10 +2,16 @@ module Kangaru
   class Application
     extend Forwardable
 
+    class InvalidConfigError < StandardError
+    end
+
     attr_reader paths: Paths
     attr_reader namespace: Module
-    attr_reader config: Config
     attr_reader database: Database?
+
+    attr_accessor config_path: String
+
+    attr_reader config: Config
     attr_reader router: Router
 
     def initialize: (source: String, namespace: Module) -> void
@@ -18,6 +24,9 @@ module Kangaru
 
     def run!: (*String) -> void
 
+    def const_get: (String | Symbol) -> Module?
+                 | (String | Symbol) -> Class?
+
     # Delegated to paths
     def view_path: (*String, ?ext: Symbol?) -> Pathname
 
@@ -29,6 +38,8 @@ module Kangaru
 
     attr_reader autoloader: Zeitwerk::Loader
 
+    def validate_config!: -> void
+
     def setup_database!: -> Database?
   end
 end

data/sig/kangaru/concerns/attributes_concern.rbs

@@ -20,6 +20,8 @@ module Kangaru
       def instance_methods: -> Array[Symbol]
 
       def initialize: (**untyped) -> void
+
+      def merge!: (**untyped) -> void
     end
   end
 end

data/sig/kangaru/concerns/configurable.rbs

@@ -5,11 +5,11 @@ module Kangaru
       extend ClassMethods
 
       module ClassMethods
-        def configurator_name: -> String
+        def configurator_key: -> Symbol
       end
 
       def name: -> String
-      def config: [C < Configurators::Configurator] -> C
+      def config: -> untyped
     end
   end
 end

data/sig/kangaru/config.rbs

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

data/sig/kangaru/configurator.rbs

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

data/sig/kangaru/configurators.rbs

@@ -1,7 +1,11 @@
 module Kangaru
   module Configurators
-    BASE_CONFIGURATORS: Array[singleton(Configurator)]
-
     def self.classes: -> Array[singleton(Configurator)]
+
+    private
+
+    def self.application_configurators: -> Module?
+
+    def self.load_classes: (Module?) -> Array[singleton(Configurator)]
   end
 end

data/sig/kangaru/injected_methods.rbs

@@ -9,6 +9,8 @@ module Kangaru
 
       def apply_config!: -> void
 
+      def import_config_from!: (String) -> void
+
       def database: -> Database?
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kangaru
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Welham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-08 00:00:00.000000000 Z
+date: 2023-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -107,12 +107,9 @@ files:
 - lib/kangaru/concerns/configurable.rb
 - lib/kangaru/concerns/validatable.rb
 - lib/kangaru/config.rb
+- lib/kangaru/configurator.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
@@ -159,12 +156,9 @@ files:
 - sig/kangaru/concerns/configurable.rbs
 - sig/kangaru/concerns/validatable.rbs
 - sig/kangaru/config.rbs
+- sig/kangaru/configurator.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
@@ -196,10 +190,13 @@ files:
 - sig/kangaru/validation/error.rbs
 - sig/kangaru/validators/required_validator.rbs
 - sig/kangaru/validators/validator.rbs
-homepage:
+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:

data/lib/kangaru/configurators/application_configurator.rb

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

data/lib/kangaru/configurators/configurator.rb

@@ -1,22 +0,0 @@
-module Kangaru
-  module Configurators
-    class Configurator
-      include Concerns::AttributesConcern
-
-      using Patches::Inflections
-
-      def self.key
-        to_s.gsub(/^.*::(?!.*::)/, "")
-            .delete_suffix("Configurator")
-            .to_snakecase
-            .to_sym
-      end
-
-      def serialise
-        self.class.attributes.to_h do |setting|
-          [setting, send(setting)]
-        end.compact
-      end
-    end
-  end
-end

data/lib/kangaru/configurators/external_configurator.rb

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

data/lib/kangaru/configurators/open_configurator.rb

@@ -1,33 +0,0 @@
-# Similar to a standard configurator, except on initialisation, it will set
-# accessors for every attribute specified. This means that the super call will
-# lead to each value being set as if the accessor was defined in the class.
-module Kangaru
-  module Configurators
-    class OpenConfigurator < Configurator
-      using Patches::Symboliser
-
-      def initialize(**)
-        set_accessors!(**)
-
-        super
-      end
-
-      # Import contents of a yaml file
-      def self.from_yaml_file(path)
-        raise "path does not exist" unless File.exist?(path)
-
-        attributes = YAML.load_file(path).symbolise
-
-        new(**attributes)
-      end
-
-      private
-
-      def set_accessors!(**attributes)
-        attributes.each_key do |key|
-          self.class.class_eval { attr_accessor key }
-        end
-      end
-    end
-  end
-end

data/sig/kangaru/configurators/application_configurator.rbs

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

data/sig/kangaru/configurators/configurator.rbs

@@ -1,14 +0,0 @@
-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/external_configurator.rbs

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

data/sig/kangaru/configurators/open_configurator.rbs

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