dynamicschema 1.0.0.beta02 → 1.0.0.beta04

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0251af8d67cb7dbbaeea74a21dd72dd2385e2449d4aa41c48753f4b05428dfed
-  data.tar.gz: ce213906df2fe4facdf469717c61f5138aa3cae7469ba0ac3d5dc21e6dadd958
+  metadata.gz: 2bbda4319f58741ceca992dec756544aeaa8f9b293afa0bee507ba94636405f4
+  data.tar.gz: 67283d904c6d84994d724d2e5a934332f78661bfa1173b0e0a6b4026a1b0a788
 SHA512:
-  metadata.gz: 48b889c8c37b1a454819a5ea8de9d63179348b7cede7ce043f0972bef384012cb9ed3a4aaabe8a739f3d51e21bee0f3315231fc5ea6b80cab48c945f3ac17919
-  data.tar.gz: 3b317ae13cfb0d558fe8f77267136e2132842780f39331ccf192e7f5b65d397ea1ac8bb3fa8d615f38afb9c1adf09a227a689921d63237525b8f6fc04b040cfa
+  metadata.gz: 2fa81eb8ff0e153e2d9900eea14f26dbdc71ce90bb1b4595c9091330da1d8f6c7fdcd0fa2e8273a64346c08f5baca9a4d2519db7e67b35ea20da6d49a1adde16
+  data.tar.gz: 3d86d903925519d2813c379d528ada3a678e80cdf3c24287697c19ab0b3fb9ad9062f21c36bc219f5dceef384fb19bcc1208117416e964906e5cee5b4d9ae7db

data/README.md

@@ -139,7 +139,7 @@ as well as a `Hash` of options, all of which are optional:
 require 'dynamic_schema'
 
 # define a schema structure with values
-schema = DynamicSchema::Builder.new.define do
+schema = DynamicSchema.define do
   api_key
   version, String, default: '1.0'
 end
@@ -189,12 +189,12 @@ Notice an *object* does not accept a type as it is always of type `Object`.
 ```ruby
 require 'dynamic_schema'
 
-schema = DynamicSchema::Builder.new do
+schema = DynamicSchema.define do
   api_key, String
   chat_options do
     model String, default: 'claude-3'
     max_tokens Integer, default: 1024
-    temperature, Float, default: 0.5, in: 0..1
+    temperature Float, default: 0.5, in: 0..1
     stream [ TrueClass, FalseClass ]
   end
 end
@@ -236,7 +236,7 @@ the value. If you want to specify multiple types simply provide an array of type
 ```ruby
 require 'dynamic_schema'
 
-schema = DynamicSchema::Builder.new do
+schema = DynamicSchema.define do
   typeless_value
   symbol_value      Symbol 
   boolean_value     [ TrueClass, FalseClass ]
@@ -424,16 +424,30 @@ their definition and construction.
 
 ### Definable 
 
-The `Definable` module, when inclued in a class, will add a `schema` class method to your class.
-You can call `schema` with a block and define a schema directly inside your class. The `schema`
-method can be called repeatedly, with subsequent calls augmenting, any preexsiting schema. 
+The `Definable` module, when inclued in a class, will add the `schema` and the `builder` class 
+methods. 
 
-This can be used in a class hierarchy to augment base class schemas in derived classes. 
+By calling `schema` with a block you can define a schema for that specific class. You may also 
+retrieve the defined schema by calling 'schema' ( with or without a block ). The 'schema' method
+may be called repeatedly to build up a schema with each call adding to the existing schema 
+( replacing values and objects of the same name if they appear in subsequent calls ). 
 
-```
-class DatabaSettings 
+The `schema` method will integrate with a class hierarchy. By including Definable in a base class 
+you can call `schema` to define a schema for that base class and then in subsequent dervied classes
+to augment it for those classes. 
+
+The `builder` method will return a memoized builder of the schema defined by calls to the `schema` 
+method which can be used to build and validate schema conformant hashes. 
+
+```ruby 
+class Setting 
   include DynamicSchema::Definable 
-  
+  schema do 
+    name String 
+  end 
+end 
+
+class DatabaSetting < Setting  
   schema do 
     database do 
       host  String
@@ -444,12 +458,9 @@ class DatabaSettings
 
   def initalize( attributes = {} )
     # validate the attributes 
-    schema_builder = DynamicSchema::Builder.new.define( &class.schema )
-    schema_builder.validate!( attributes )
-    # initialize from the given attributes here 
-    @host = attributes[ :database ][ :host ]
-    @port = attributes[ :database ][ :port ]
-    @name = attributes[ :database ][ :name ]
+    self.class.builder.validate!( attributes )
+    # retain them for future access 
+    @attributes = attributes&.dup 
   end
 
 end 
@@ -462,19 +473,25 @@ building that class using a schema assisted builder pattern. The `Buildable` mod
 `build!` and `build` methods to the class which can be used to build that class, with and 
 without validation respectivelly. 
 
-These methods accept both a hash with attitbutes that follow the schema, as well as a block 
+These methods accept both a hash with attributes that follow the schema, as well as a block 
 that can be used to build the class instance. The attributes and block can be used simultanously. 
 
-**Important** Note that `Buildable` requires that the initializer accept a `Hash` of attributes.
+**Important** Note that `Buildable` requires a class method `builder` ( which `Definable` 
+provides ) and an initializer that accepts a `Hash` of attributes.
 
-```
-class DatabaSettings 
+```ruby
+class Setting 
   include DynamicSchema::Definable 
   include DynamicSchema::Buildable
-  
+  schema do 
+    name String 
+  end 
+end 
+
+class DatabaSetting < Setting  
   schema do 
     database do 
-      adapter   Symbol 
+      adapter   Symbol, 
       host      String
       port      String 
       name      String 
@@ -482,18 +499,20 @@ class DatabaSettings
   end 
 
   def initalize( attributes = {} )
-    # assign the attributes
-    # ...
+    # validate the attributes 
+    self.class.builder.validate!( attributes )
+    # retain them for the future  
+    @attributes = attributes&.dup 
   end
-
 end 
 
-database_settings = DatabaSettings.build! adapter: :pg do 
-  host     "localhost"
-  port     "127.0.0.1"
-  name     "mydb"
+database_settings = DatabaSettings.build! name: 'settings.database' do 
+  database adapter: :pg do 
+    host     "localhost"
+    port     "127.0.0.1"
+    name     "mydb"
+  end 
 end
-
 ```
 
 ## Validation

data/dynamicschema.gemspec

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

data/lib/dynamic_schema/buildable.rb

@@ -8,13 +8,11 @@ module DynamicSchema
     module ClassMethods
 
       def build( attributes = nil, &block )
-        @_builder ||= Builder.new.define( &self.schema )
-        new( @_builder.build( attributes, &block ) )
+        new( builder.build( attributes, &block ) )
       end 
 
       def build!( attributes = nil, &block )
-        @_builder ||= Builder.new.define( &self.schema )
-        new( @_builder.build!( attributes, &block ) )
+        new( builder.build!( attributes, &block ) )
       end 
 
     end 

data/lib/dynamic_schema/builder.rb

@@ -15,7 +15,7 @@ module DynamicSchema
     end
 
     def define( &block )
-      self.schema = Resolver.new( self.schema ).resolve( &block ).schema 
+      self.schema = Resolver.new( self.schema ).resolve( &block )._schema 
       self
     end 
 

data/lib/dynamic_schema/builder_methods/validation.rb

@@ -61,7 +61,7 @@ module DynamicSchema
               if criteria[ :type ] == Object
                 traverse_and_validate_values( 
                   values[ name ],
-                  schema: criteria[ :schema ] ||= criteria[ :resolver ].schema,
+                  schema: criteria[ :schema ] ||= criteria[ :resolver ]._schema,
                   path: "#{ ( path || '' ) + ( path ? '/' : '' ) + key.to_s }", 
                   &block 
                 )
@@ -80,7 +80,7 @@ module DynamicSchema
                 groups.each do | group |
                   traverse_and_validate_values(
                     group, 
-                    schema: criteria[ :schema ] ||= criteria[ :resolver ].schema,
+                    schema: criteria[ :schema ] ||= criteria[ :resolver ]._schema,
                     path: "#{ ( path || '' ) + ( path ? '/' : '' ) + key.to_s }", 
                     &block 
                   )

data/lib/dynamic_schema/definable.rb

@@ -8,8 +8,15 @@ module DynamicSchema
     module ClassMethods
 
       def schema( &block )
-        @_schema ||= []
-        @_schema << block if block_given?
+        @_schema ||= [] 
+        if block_given? 
+          # note that the memoized builder is reset when schema is called with a new block so 
+          # that additions to the schema are incorporated into future builder ( but this does
+          # not work if the schema is updated on a superclass after this class' builder has 
+          # been returned )
+          @_builder = nil 
+          @_schema << block 
+        end
         schema_blocks = _collect_schema
         proc do
           schema_blocks.each do | block |
@@ -18,6 +25,10 @@ module DynamicSchema
         end
       end
 
+      def builder 
+        @_builder ||= DynamicSchema.define( &schema )
+      end
+
     protected 
 
       def _collect_schema

data/lib/dynamic_schema/receiver.rb

@@ -197,7 +197,7 @@ module DynamicSchema
           Receiver.new( 
             attributes,
             converters: @converters, 
-            schema: criteria[ :schema ] ||= criteria[ :resolver ].schema 
+            schema: criteria[ :schema ] ||= criteria[ :resolver ]._schema 
           )
       end
       value.instance_eval( &block ) if block
@@ -213,7 +213,7 @@ module DynamicSchema
         receiver = Receiver.new( 
           a,
           converters: @converters, 
-          schema: criteria[ :schema ] ||= criteria[ :resolver ].schema 
+          schema: criteria[ :schema ] ||= criteria[ :resolver ]._schema 
         )
         receiver.instance_eval( &block ) if block
         receiver

data/lib/dynamic_schema/resolver.rb

@@ -22,7 +22,8 @@ module DynamicSchema
       self
     end
         
-    def schema 
+    def _schema 
+
       if !@resolved && @block 
         @resolved_blocks << @block unless @resolved_blocks.include?( @block )
         self.instance_eval( &@block ) 
@@ -31,6 +32,29 @@ module DynamicSchema
       @schema 
     end
 
+    def _value( name, options )
+      name = name.to_sym
+      ::Kernel.raise ::NameError, "The name '#{name}' is reserved and cannot be used for parameters." \
+        if ::DynamicSchema::Receiver.instance_methods.include?( name )
+  
+      _validate_in!( name, options[ :type ], options[ :in ] ) if options[ :in ] 
+      
+      @schema[ name ] = options
+      self
+    end
+
+    def _object( name, options = {}, &block )
+      name = name.to_sym
+      ::Kernel.raise ::NameError, "The name '#{name}' is reserved and cannot be used for parameters." \
+        if ::DynamicSchema::Receiver.instance_methods.include?( name )
+
+      @schema[ name ] = options.merge( {
+        type: ::Object,
+        resolver: Resolver.new( resolved_blocks: @resolved_blocks ).resolve( &block )
+      } )    
+      self
+    end
+
     def method_missing( method, *args, &block )
       first = args.first
       options = nil
@@ -58,9 +82,9 @@ module DynamicSchema
 
       type = options[ :type ]
       if type == ::Object || type.nil? && block 
-        _append_object( method, options, &block )
+        _object( method, options, &block )
       else 
-        _append_value( method, options )
+        _value( method, options )
       end
     
     end
@@ -92,27 +116,6 @@ module DynamicSchema
   
   private
 
-    def _append_value( name, options )
-      ::Kernel.raise ::NameError, "The name '#{name}' is reserved and cannot be used for parameters." \
-        if ::DynamicSchema::Receiver.instance_methods.include?( name )
-  
-      _validate_in!( name, options[ :type ], options[ :in ] ) if options[ :in ] 
-      
-      @schema[ name ] = options
-      self
-    end
-
-    def _append_object( name, options = {}, &block )
-      ::Kernel.raise ::NameError, "The name '#{name}' is reserved and cannot be used for parameters." \
-        if ::DynamicSchema::Receiver.instance_methods.include?( name )
-
-      @schema[ name ] = options.merge( {
-        type: ::Object,
-        resolver: Resolver.new( resolved_blocks: @resolved_blocks ).resolve( &block )
-      } )    
-      self
-    end
-
     def _validate_in!( name, type, in_option )
       ::Kernel.raise ::TypeError,
             "The parameter '#{name}' includes the :in option but it does not respond to 'include?'." \

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamicschema
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta02
+  version: 1.0.0.beta04
 platform: ruby
 authors:
 - Kristoph Cichocki-Romanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec