dynamicschema 1.0.0.beta01 → 1.0.0.beta03

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32cb8398626d7ac822a228c89778e566ef62182b054ab267b8edf45bc718eda3
-  data.tar.gz: 3475b1a090f57e4702076677b426300c892d91a06ac55841cd6e48657f69d7aa
+  metadata.gz: 5685a6ff1c79676a075f3f7f2cd5863c35466a402c79f3af46c2e164eb37581a
+  data.tar.gz: 374fbd61c218c4dc4bc6620d18fa3a973d197aa96032c6c2998bb4d3ed8da378
 SHA512:
-  metadata.gz: a39f196fc0f7e3a657a6e776163ac5d1d90d42ff8cba556b99691074dead341d42bc9e8230cfab4ece6fd81617540a09462278ce4d5fbca97eadec218ee09902
-  data.tar.gz: bd2c0f880a7c088ccecd5df2574acf32e6242dacac8b730d44141d9b95f334828c0b39c860a24f7abd7e815eaf82c97499119c95664f565b557f80688ad955ac
+  metadata.gz: 80c7ae562b99ddabf6fe6220a995d845beda151c13683aff13891c47e089700579cb7a099b08a4ac789569ab0499612c2f467222661082b1794cbb75d424a1d9
+  data.tar.gz: 2da0f6cf54388b6e2e5d3f3ac05214c6f3ea27c8c763fb1ac9a84bbbddbad92d21b29db328c70388653ffd4317a409a58b0165323626e2e2ea2988b188df14c3

data/README.md

@@ -57,6 +57,9 @@ You can find a full OpenAI request example in the `/examples` folder of this rep
   - [as Option](#as-option)
   - [in Option (Values Only)](#in-option)
   - [arguments Option](#arguments-option)
+- [Class Schema](#class-schemas)
+  - [Definable](#definable) 
+  - [Buildable](#buildable) 
 - [Validation Methods](#validation-methods)
   - [Validation Rules](#validation-rules) 
   - [validate!](#validate)
@@ -136,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
@@ -186,7 +189,7 @@ 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'
@@ -233,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 ]
@@ -414,6 +417,104 @@ result = schema.build! do
 end
 ```
 
+## Class Schemas
+
+DynamicSchema provides a number of modules you can include into your own classes to simplify 
+their definition and construction. 
+
+### Definable 
+
+The `Definable` module, when inclued in a class, will add the `schema` and the `builder` class 
+methods. 
+
+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 ). 
+
+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
+      port  String 
+      name  String 
+    end 
+  end 
+
+  def initalize( attributes = {} )
+    # validate the attributes 
+    self.class.builder.validate!( attributes )
+    # retain them for future access 
+    @attributes = attributes&.dup 
+  end
+
+end 
+```
+
+### Buildable 
+
+The `Buildable` module can be included in a class, in addition to `Definable` to faciliate 
+building that class using a schema assisted builder pattern. The `Buildable` module adds 
+`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 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 a class method `builder` ( which `Definable` 
+provides ) and an initializer that accepts a `Hash` of attributes.
+
+```ruby
+class Setting 
+  include DynamicSchema::Definable 
+  include DynamicSchema::Buildable
+  schema do 
+    name String 
+  end 
+end 
+
+class DatabaSetting < Setting  
+  schema do 
+    database do 
+      adapter   Symbol, 
+      host      String
+      port      String 
+      name      String 
+    end 
+  end 
+
+  def initalize( attributes = {} )
+    # validate the attributes 
+    self.class.builder.validate!( attributes )
+    # retain them for the future  
+    @attributes = attributes&.dup 
+  end
+end 
+
+database_settings = DatabaSettings.build! name: 'settings.database' do 
+  database adapter: :pg do 
+    host     "localhost"
+    port     "127.0.0.1"
+    name     "mydb"
+  end 
+end
+```
+
 ## Validation
 
 DynamicSchema provides three different methods for validating Hash structures against your 

data/dynamicschema.gemspec

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

data/lib/dynamic_schema/buildable.rb

@@ -0,0 +1,22 @@
+module DynamicSchema 
+  module Buildable
+
+    def self.included( base )
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def build( attributes = nil, &block )
+        new( builder.build( attributes, &block ) )
+      end 
+
+      def build!( attributes = nil, &block )
+        new( builder.build!( attributes, &block ) )
+      end 
+
+    end 
+
+  end
+end
+

data/lib/dynamic_schema/definable.rb

@@ -0,0 +1,47 @@
+module DynamicSchema 
+  module Definable 
+
+    def self.included( base )
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def schema( &block )
+        @_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 |
+            instance_eval( &block )
+          end
+        end
+      end
+
+      def builder 
+        @_builder ||= DynamicSchema.define( &schema )
+      end
+
+    protected 
+
+      def _collect_schema
+        schema_blocks = []
+        if superclass.singleton_methods.include?( :_collect_schema )
+          schema_blocks.concat( superclass._collect_schema )
+        end
+        schema_blocks.concat( @_schema ) if defined?( @_schema )
+        schema_blocks
+      end
+
+    end 
+
+  end
+end
+

data/lib/dynamic_schema/receiver.rb

@@ -103,7 +103,9 @@ module DynamicSchema
         @defaults_assigned[ method ] = false
         @values[ name ] = value 
       else
-        super
+        ::Kernel.raise ::NoMethodError, 
+          "There is no schema value or object '#{method}' defined in this scope which includes: " \
+          "#{@schema.keys.join( ', ' )}." 
       end
     end
 

data/lib/dynamic_schema.rb

@@ -1,6 +1,8 @@
 require_relative 'dynamic_schema/errors'
 require_relative 'dynamic_schema/builder'
-require_relative 'dynamic_schema/definition'
+
+require_relative 'dynamic_schema/definable'
+require_relative 'dynamic_schema/buildable'
 
 module DynamicSchema  
   def self.define( schema = {}, &block )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamicschema
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta01
+  version: 1.0.0.beta03
 platform: ruby
 authors:
 - Kristoph Cichocki-Romanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-25 00:00:00.000000000 Z
+date: 2024-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -55,10 +55,11 @@ files:
 - README.md
 - dynamicschema.gemspec
 - lib/dynamic_schema.rb
+- lib/dynamic_schema/buildable.rb
 - lib/dynamic_schema/builder.rb
 - lib/dynamic_schema/builder_methods/conversion.rb
 - lib/dynamic_schema/builder_methods/validation.rb
-- lib/dynamic_schema/definition.rb
+- lib/dynamic_schema/definable.rb
 - lib/dynamic_schema/errors.rb
 - lib/dynamic_schema/receiver.rb
 - lib/dynamic_schema/resolver.rb

data/lib/dynamic_schema/definition.rb

@@ -1,23 +0,0 @@
-require_relative 'builder'
-
-module DynamicSchema
-	module Definition
-
-    def schema( schema = nil, &block )
-      return @_schema_builder if ( schema.nil? || schema.empty? ) && !block
-      @_schema_builder = DynamicSchema::Builder.new( schema ).define( &block )
-    end
-
-    def build_with_schema( attributes = nil, &block )
-      raise RuntimeError, "The schema has not been defined." if @_schema_builder.nil?
-      @_schema_builder.build( attributes, &block )
-    end
-    
-    def build_with_schema!( attributes = nil, &block )
-      raise RuntimeError, "The schema has not been defined." if @_schema_builder.nil?
-      @_schema_builder.build!( attributes, &block )
-    end
-
-  end
-end
-