kangaru 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15146a85b29524ce8435963bbc25601017d72cafef5cf69331b920219bad4113
-  data.tar.gz: de9a21f5cb27508169c1fec64b60f7a2aeacbb0beaac0b3fa1392288ea5f7728
+  metadata.gz: 14de853c7d43559d44b5dab8ca97090305697c8cb14245b9647b1f67d17036a6
+  data.tar.gz: 96572ecb84ae6cc4a74833d0456678bf66b8dcfbe701977ba6c920236cba5c64
 SHA512:
-  metadata.gz: 03d7d75d0b7c98d7ea7cfa74390fe9bd16ad8d0c02ee7d9e5cc61499b8f545fb90cbf0b8a0361851088b59066f91c0ca24f429747c084d9984ededdd233c5363
-  data.tar.gz: 9ec21c22c2f17b8943e546060fe872d08f43c38038970abdfdafb867eff1a7d134931069ae03eae832171ab280433bf236ca22635c3fa1c59d0bd76382dfa6c4
+  metadata.gz: ad440db45f269703c52939c80b0534b527c54e3649e15f2206af920818b2f8b5529c52a9127364a74b7f72d38fe56976ee5a6d8fe610585365a67bcb46b30176
+  data.tar.gz: 67ca725ea8b804a30a0ea4769a0203af75601e546dcfe56dc237f308bda356cc6029e5c01921064044188d955c667e0d74e643f0d52cf309ebecf04403cf157c

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.2)
+    kangaru (0.2.1)
       colorize (~> 1.1)
       erb (~> 4.0)
       sequel (~> 5.72)

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
@@ -20,11 +24,8 @@ module Kangaru
       @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.
-    def configure(env = nil, &block)
-      block.call(config) if current_env?(env)
+    def configure(&block)
+      block.call(config)
     end
 
     def configured?
@@ -34,7 +35,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,16 +49,15 @@ module Kangaru
       router.resolve(request)
     end
 
-    def_delegators :paths, :view_path
+    def const_get(const)
+      return unless namespace.const_defined?(const)
 
-    private
+      namespace.const_get(const)
+    end
 
-    # Returns true if nil as this is represents all envs.
-    def current_env?(env)
-      return true if env.nil?
+    def_delegators :paths, :view_path
 
-      Kangaru.env?(env)
-    end
+    private
 
     def autoloader
       @autoloader ||= Zeitwerk::Loader.new.tap do |loader|
@@ -65,6 +67,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/initialiser.rb

@@ -6,7 +6,7 @@ module Kangaru
       Kangaru.application = Application.new(source:, namespace:)
       Kangaru.eager_load(Initialisers)
 
-      namespace.extend InjectedMethods
+      namespace.extend Interface
     end
   end
 end

data/lib/kangaru/interface.rb

@@ -0,0 +1,39 @@
+module Kangaru
+  module Interface
+    def run!(*argv)
+      Kangaru.application!.run!(*argv)
+    end
+
+    def config
+      Kangaru.application!.config
+    end
+
+    def configure(env: nil, &)
+      return unless env_applies?(env)
+
+      Kangaru.application!.configure(&)
+    end
+
+    def config_path(path, env: nil)
+      return unless env_applies?(env)
+
+      Kangaru.application!.config_path = path
+    end
+
+    def apply_config!
+      Kangaru.application!.apply_config!
+    end
+
+    def database
+      Kangaru.application!.database
+    end
+
+    private
+
+    def env_applies?(env)
+      return true if env.nil?
+
+      Kangaru.env?(env)
+    end
+  end
+end

data/lib/kangaru/version.rb

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

data/sig/kangaru/application.rbs

@@ -2,15 +2,21 @@ 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
 
-    def configure: (?Symbol?) { (Config) -> void } -> void
+    def configure: { (Config) -> void } -> void
 
     def configured?: -> bool
 
@@ -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
 
@@ -25,10 +34,10 @@ module Kangaru
 
     @configured: bool
 
-    def current_env?: (Symbol?) -> bool
-
     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/initialiser.rbs

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

data/sig/kangaru/interface.rbs

@@ -0,0 +1,21 @@
+module Kangaru
+  module Interface
+    type env = Symbol?
+
+    def run!: (*String) -> void
+
+    def config: -> Config
+
+    def configure: (?env: env) { (Config) -> void } -> void
+
+    def apply_config!: -> void
+
+    def config_path: (String, ?env: env) -> void
+
+    def database: -> Database?
+
+    private
+
+    def env_applies?: (Symbol?) -> bool
+  end
+end

data/sig/kangaru.rbs

@@ -21,9 +21,4 @@ module Kangaru
 
     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.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Chris Welham
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-08 00:00:00.000000000 Z
+date: 2023-11-14 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
@@ -130,7 +127,7 @@ files:
 - 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/interface.rb
 - lib/kangaru/model.rb
 - lib/kangaru/patches/constantise.rb
 - lib/kangaru/patches/inflections.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
@@ -180,7 +174,7 @@ files:
 - sig/kangaru/inflectors/tokeniser.rbs
 - sig/kangaru/initialiser.rbs
 - sig/kangaru/initialisers/rspec.rbs
-- sig/kangaru/injected_methods.rbs
+- sig/kangaru/interface.rbs
 - sig/kangaru/model.rbs
 - sig/kangaru/patches/constantise.rbs
 - sig/kangaru/patches/inflections.rbs

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/lib/kangaru/injected_methods.rb

@@ -1,23 +0,0 @@
-module Kangaru
-  module InjectedMethods
-    def run!(*argv)
-      Kangaru.application!.run!(*argv)
-    end
-
-    def config
-      Kangaru.application!.config
-    end
-
-    def configure(env = nil, &)
-      Kangaru.application!.configure(env, &)
-    end
-
-    def apply_config!
-      Kangaru.application!.apply_config!
-    end
-
-    def database
-      Kangaru.application!.database
-    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

data/sig/kangaru/injected_methods.rbs

@@ -1,17 +0,0 @@
-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