dynamicschema 1.0.0.beta01 → 1.0.0.beta02

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32cb8398626d7ac822a228c89778e566ef62182b054ab267b8edf45bc718eda3
-  data.tar.gz: 3475b1a090f57e4702076677b426300c892d91a06ac55841cd6e48657f69d7aa
+  metadata.gz: 0251af8d67cb7dbbaeea74a21dd72dd2385e2449d4aa41c48753f4b05428dfed
+  data.tar.gz: ce213906df2fe4facdf469717c61f5138aa3cae7469ba0ac3d5dc21e6dadd958
 SHA512:
-  metadata.gz: a39f196fc0f7e3a657a6e776163ac5d1d90d42ff8cba556b99691074dead341d42bc9e8230cfab4ece6fd81617540a09462278ce4d5fbca97eadec218ee09902
-  data.tar.gz: bd2c0f880a7c088ccecd5df2574acf32e6242dacac8b730d44141d9b95f334828c0b39c860a24f7abd7e815eaf82c97499119c95664f565b557f80688ad955ac
+  metadata.gz: 48b889c8c37b1a454819a5ea8de9d63179348b7cede7ce043f0972bef384012cb9ed3a4aaabe8a739f3d51e21bee0f3315231fc5ea6b80cab48c945f3ac17919
+  data.tar.gz: 3b317ae13cfb0d558fe8f77267136e2132842780f39331ccf192e7f5b65d397ea1ac8bb3fa8d615f38afb9c1adf09a227a689921d63237525b8f6fc04b040cfa

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)
@@ -414,6 +417,85 @@ 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 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. 
+
+This can be used in a class hierarchy to augment base class schemas in derived classes. 
+
+```
+class DatabaSettings 
+  include DynamicSchema::Definable 
+  
+  schema do 
+    database do 
+      host  String
+      port  String 
+      name  String 
+    end 
+  end 
+
+  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 ]
+  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 attitbutes 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.
+
+```
+class DatabaSettings 
+  include DynamicSchema::Definable 
+  include DynamicSchema::Buildable
+  
+  schema do 
+    database do 
+      adapter   Symbol 
+      host      String
+      port      String 
+      name      String 
+    end 
+  end 
+
+  def initalize( attributes = {} )
+    # assign the attributes
+    # ...
+  end
+
+end 
+
+database_settings = DatabaSettings.build! adapter: :pg do 
+  host     "localhost"
+  port     "127.0.0.1"
+  name     "mydb"
+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.beta02'
   spec.authors        = [ 'Kristoph Cichocki-Romanov' ]
   spec.email          = [ 'rubygems.org@kristoph.net' ]
 

data/lib/dynamic_schema/buildable.rb

@@ -0,0 +1,24 @@
+module DynamicSchema 
+  module Buildable
+
+    def self.included( base )
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def build( attributes = nil, &block )
+        @_builder ||= Builder.new.define( &self.schema )
+        new( @_builder.build( attributes, &block ) )
+      end 
+
+      def build!( attributes = nil, &block )
+        @_builder ||= Builder.new.define( &self.schema )
+        new( @_builder.build!( attributes, &block ) )
+      end 
+
+    end 
+
+  end
+end
+

data/lib/dynamic_schema/definable.rb

@@ -0,0 +1,36 @@
+module DynamicSchema 
+  module Definable 
+
+    def self.included( base )
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def schema( &block )
+        @_schema ||= []
+        @_schema << block if block_given?
+        schema_blocks = _collect_schema
+        proc do
+          schema_blocks.each do | block |
+            instance_eval( &block )
+          end
+        end
+      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.beta02
 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
-