adaptiveconfiguration 1.0.0.beta08 → 1.0.0.beta09

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cca3cc7af7f052e713d6d1065610f79fe1857f4c677c9cf860098b6136aad366
-  data.tar.gz: 28a8496792f95133a62b7a3696d5dfff4b96fa5ed2d8214f50831b4a8c78996b
+  metadata.gz: b83c4f1458551684c09f324ecbb13a64ad2fa51ba83747d2a21f835fa706555f
+  data.tar.gz: f75a7d19d43814c81755f27096e707dbe7ab50ee55354ba42039c5f94fd51143
 SHA512:
-  metadata.gz: 2e8df5aa99cdc79ce4aedac99a737f09c814df5e6287f30c4fb3595ce93fff7417d1311d150e9eddaca8fc6ea60dd82ff7d7ffed946f49463b30411356eeb147
-  data.tar.gz: ac67be155f79e5261c75bd805d0eaec9825cc2aa354b556227c4f9d8968b0cdd2ae634ed0377f024acdf2d4b518a5811a90a6006c42057dbe6911fb9d412c0a0
+  metadata.gz: 3427a2d7edbfc38bd479b461844c43d6f53e61fdde7e479446d87408cf758124879b76c3b4860aacd8f382eacc961c399b64958c8302d1bc1620fca78437fb94
+  data.tar.gz: 19fe7d3db4c51159706c9ec982b5b56694b2c124ef661bf19417606e01463f53f2252b025b5832afdb995ced2fbd857465c9de36c8354ae72a4ff0234a2868d4

data/adaptiveconfiguration.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do | spec |
 
   spec.name          = 'adaptiveconfiguration'
-  spec.version       = '1.0.0.beta08'
+  spec.version       = '1.0.0.beta09'
   spec.authors       = [ 'Kristoph Cichocki-Romanov' ]
   spec.email         = [ 'rubygems.org@kristoph.net' ]
 

data/lib/adaptive_configuration/builder.rb

@@ -1,13 +1,13 @@
-require_relative 'group_builder'
+require_relative 'properties_builder'
 require_relative 'scaffold'
 
-# types must be included to support conversation
+# types must be included to support coersion
 require 'time'
 require 'date'
 require 'uri'
 
 module AdaptiveConfiguration 
-  class Builder < GroupBuilder
+  class Builder < PropertiesBuilder
 
     DEFAULT_CONVERTERS = {
 
@@ -106,8 +106,7 @@ module AdaptiveConfiguration
 
       path.chomp( '/' ) if path
       unless values.is_a?( Hash )
-        # TODO: raise error
-        return
+        raise ArgumentError, "The values must always be a Hash." 
       end
 
       definitions.each do | key, definition |
@@ -117,10 +116,14 @@ module AdaptiveConfiguration
 
         if definition[ :required ] && 
            ( !value || ( value.respond_to?( :empty ) && value.empty? ) )
-          block.call( RequirementUnmetError.new( path: path, key: key ) )
+          block.call( RequiredOptionError.new( path: path, key: key ) )
+        elsif definition[ :in ] && !definition[ :in ].include?( value )
+          block.call( 
+            InOptionError.new( path: path, key: key, option: definition[ :in ], value: value )
+          )
         elsif !definition[ :default_assigned ] && !value.nil?
           unless definition[ :array ]
-            if definition[ :type ] == :group
+            if definition[ :type ] == Object
               traverse_and_validate_values( 
                 values[ name ],
                 definitions: definition[ :definitions ],
@@ -137,7 +140,7 @@ module AdaptiveConfiguration
               end
             end
           else 
-            if definition[ :type ] == :group
+            if definition[ :type ] == Object
               groups = Array( value )
               groups.each do | group |
                 traverse_and_validate_values(

data/lib/adaptive_configuration/errors.rb

@@ -2,7 +2,6 @@ module AdaptiveConfiguration
   
   class Error < StandardError; end
 
-
   class IncompatibleTypeError < Error
 
     attr_reader :keypath 
@@ -17,12 +16,12 @@ module AdaptiveConfiguration
       @type = type
       type_text = @type.respond_to?( :join ) ? type.join( ', ' ) : type
 
-      super( "The parameter '#{@keypath}' expects #{type_text} but received incompatible #{value.class.name}." )
+      super( "The parameter '#{@keypath}' expects '#{type_text}' but incompatible '#{value.class.name}' was given." )
     end
 
   end
 
-  class RequirementUnmetError < Error
+  class RequiredOptionError < Error
 
     attr_reader :keypath 
     attr_reader :key 
@@ -31,7 +30,21 @@ module AdaptiveConfiguration
       path = path ? path.chomp( '/' ) : nil 
       @key = key
       @keypath = path ? ( path + '/' + @key.to_s ) : key.to_s    
-      super( "The parameter #{@keypath} is required." )
+      super( "The parameter '#{@keypath}' is required but no value was given." )
+    end
+
+  end
+
+  class InOptionError < Error 
+    
+    attr_reader :keypath 
+    attr_reader :key 
+
+    def initialize( path: nil, key:, option:, value: )
+      path = path ? path.chomp( '/' ) : nil 
+      @key = key
+      @keypath = path ? ( path + '/' + @key.to_s ) : key.to_s    
+      super( "The parameter '#{@keypath}' must be in '#{option.to_s}' but '#{value.to_s}' was given." )
     end
 
   end

data/lib/adaptive_configuration/{group_builder.rb → properties_builder.rb}

@@ -1,7 +1,7 @@
 require_relative 'scaffold'
 
 module AdaptiveConfiguration 
-  class GroupBuilder
+  class PropertiesBuilder
 
     attr_reader :definitions
 
@@ -25,23 +25,33 @@ module AdaptiveConfiguration
         options = args[ 1 ] || {}
         options[ :type ] = args.first
       end
+
+      validate_in!( name, options[ :type ], options[ :in ] ) if options[ :in ] 
       
       @definitions[ name ] = options
     end
 
-    def group( name, options = {}, &block )
+    def parameters( name, options = {}, &block )
       
       raise NameError, "The name '#{name}' is reserved and cannot be used for parameters." \
         if AdaptiveConfiguration::Scaffold.instance_methods.include?( name )
       
-      builder = GroupBuilder.new
+      builder = PropertiesBuilder.new
       builder.instance_eval( &block ) if block
       @definitions[ name ] = options.merge( { 
-        type: :group, 
+        type: Object, 
         definitions: builder.definitions 
       } )
 
     end
 
+  private
+
+    def validate_in!( name, type, in_option )
+     raise TypeError,
+            "The parameter '#{name}' includes the :in option but it does not respond to 'include?'." \
+        unless in_option.respond_to?( :include? )
+    end
+
   end
 end

data/lib/adaptive_configuration/scaffold.rb

@@ -85,7 +85,7 @@ module AdaptiveConfiguration
         name = definition[ :as ] || method
 
         unless definition[ :array ] 
-          if definition[ :type ] == :group
+          if definition[ :type ] == ::Object
             value = args.first 
             context = @values[ name ]
             if context.nil? || value  
@@ -107,7 +107,7 @@ module AdaptiveConfiguration
           @values[ name ] = definition[ :default_assigned ] ? 
             ::Array.new : 
             @values[ name ] || ::Array.new
-          if definition[ :type ] == :group
+          if definition[ :type ] == ::Object
             values = [ args.first ].flatten
             values = values.map do | v |
               context = Scaffold.new( 

data/lib/adaptive_configuration/validatable.rb

@@ -0,0 +1,26 @@
+require_relative 'builder'
+
+module AdaptiveConfiguration
+	module Configurable
+
+    def configuration( &block )
+      @configuration_builder ||= AdaptiveConfiguration::Builder.new 
+      @configuration_builder.instance_eval( &block )
+      @configuration_builder
+    end
+
+    def configure( attributes = nil, &block )
+      raise RuntimeError, "The configuration has not been defined." \
+        if @configuration_builder.nil?
+      configuration = @configuration_builder.build( attributes, &block )
+    end
+    
+    def configure!( attributes = nil, &block )
+      raise RuntimeError, "The configuration has not been defined." \
+        if @configuration_builder.nil?
+      configuration = @configuration_builder.build!( attributes, &block )
+    end
+
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adaptiveconfiguration
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta08
+  version: 1.0.0.beta09
 platform: ruby
 authors:
 - Kristoph Cichocki-Romanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-13 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,8 +58,9 @@ files:
 - lib/adaptive_configuration/builder.rb
 - lib/adaptive_configuration/configurable.rb
 - lib/adaptive_configuration/errors.rb
-- lib/adaptive_configuration/group_builder.rb
+- lib/adaptive_configuration/properties_builder.rb
 - lib/adaptive_configuration/scaffold.rb
+- lib/adaptive_configuration/validatable.rb
 homepage: https://github.com/EndlessInternational/adaptive_configuration
 licenses:
 - MIT