class_composer 1.0.2 → 2.1.0

data/lib/class_composer/generator.rb

@@ -1,129 +1,20 @@
 # frozen_string_literal: true
 
 require "class_composer/default_object"
+require "class_composer/generate_config"
+require "class_composer/generator/instance_methods"
+require "class_composer/generator/class_methods"
 
 module ClassComposer
+  FROZEN_TYPES = [
+    DEFAULT_FROZEN_TYPE = FROZEN_RAISE = :raise,
+    FROZEN_LOG_AND_ALLOW = :log_and_allow,
+    FROZEN_LOG_AND_SKIP = :log_and_skip,
+  ]
   module Generator
     def self.included(base)
       base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      COMPOSER_VALIDATE_METHOD_NAME = ->(name) { :"__composer_#{name}_is_valid__?" }
-      COMPOSER_ASSIGNED_ATTR_NAME = ->(name) { :"@__composer_#{name}_value_assigned__" }
-      COMPOSER_ASSIGNED_ARRAY_METHODS = ->(name) { :"@__composer_#{name}_array_methods_set__" }
-
-      def add_composer(name, allowed:, accessor: true, validator: ->(_) { true }, validation_error_klass: ::ClassComposer::ValidatorError, error_klass: ::ClassComposer::Error, **params)
-        default =
-          if params.has_key?(:default)
-            params[:default]
-          else
-            if allowed.is_a?(Array)
-              allowed << ClassComposer::DefaultObject
-            else
-              allowed = [allowed, ClassComposer::DefaultObject]
-            end
-            ClassComposer::DefaultObject
-          end
-
-        allowed.include?(ClassComposer::DefaultObject)
-        validate_proc = __composer_validator_proc__(validator: validator, allowed: allowed, name: name, error_klass: error_klass)
-        __composer_validate_options__!(name: name, validate_proc: validate_proc, default: default, validation_error_klass: validation_error_klass, error_klass: error_klass)
-
-        array_proc = __composer_array_proc__(name: name, validator: validator, allowed: allowed, params: params)
-        __composer_assignment__(name: name, allowed: allowed, params: params, validator: validate_proc, array_proc: array_proc, validation_error_klass: validation_error_klass, error_klass: error_klass)
-        __composer_retrieval__(name: name, default: default, array_proc: array_proc)
-      end
-
-      def __composer_validate_options__!(name:, validate_proc:, default:, params: {}, validation_error_klass:, error_klass:)
-        unless validate_proc.(default)
-          raise validation_error_klass, "Default value [#{default}] for #{self.class}.#{name} is not valid"
-        end
-
-        if instance_methods.include?(name.to_sym)
-          raise error_klass, "[#{name}] is already defined. Ensure composer names are all uniq and do not class with class instance methods"
-        end
-      end
-
-      def __composer_array_proc__(name:, validator:, allowed:, params:)
-        Proc.new do |value, _itself|
-          _itself.send(:"#{name}=", value)
-        end
-      end
-
-      # create assignment method for the incoming name
-      def __composer_assignment__(name:, params:, allowed:, validator:, array_proc:, validation_error_klass:, error_klass:)
-        define_method(:"#{name}=") do |value|
-          is_valid = validator.(value)
-
-          if is_valid
-            instance_variable_set(COMPOSER_ASSIGNED_ATTR_NAME.(name), true)
-            instance_variable_set(:"@#{name}", value)
-          else
-            message = ["#{self.class}.#{name} failed validation. #{name} is expected to be #{allowed}."]
-
-            message << (params[:invalid_message].is_a?(Proc) ? params[:invalid_message].(value) : params[:invalid_message].to_s)
-            if value.is_a?(Array)
-              # we assigned the array value...pop it from the array
-              # must be done after the message is created so that failing value can get passed appropriately
-              value.pop
-            end
-            raise validation_error_klass, message.compact.join(" ")
-          end
-
-          if value.is_a?(Array) && !value.instance_variable_get(COMPOSER_ASSIGNED_ARRAY_METHODS.(name))
-            _itself = itself
-            value.define_singleton_method(:<<) do |val|
-              array_proc.(super(val), _itself)
-            end
-            value.instance_variable_set(COMPOSER_ASSIGNED_ARRAY_METHODS.(name), true)
-          end
-
-          value
-        end
-      end
-
-      # retrieve the value for the name -- Or return the default value
-      def __composer_retrieval__(name:, default:, array_proc:)
-        define_method(:"#{name}") do
-          value = instance_variable_get(:"@#{name}")
-          return value if instance_variable_get(COMPOSER_ASSIGNED_ATTR_NAME.(name))
-
-          if default.is_a?(Array) && !default.instance_variable_get(COMPOSER_ASSIGNED_ARRAY_METHODS.(name))
-            _itself = itself
-            default.define_singleton_method(:<<) do |value|
-              array_proc.(super(value), _itself)
-            end
-            default.instance_variable_set(COMPOSER_ASSIGNED_ARRAY_METHODS.(name), true)
-          end
-
-          default == ClassComposer::DefaultObject ? ClassComposer::DefaultObject.value : default
-        end
-      end
-
-      # create validator method for incoming name
-      def __composer_validator_proc__(validator:, allowed:, name:, error_klass:)
-        if validator && !validator.is_a?(Proc)
-          raise error_klass, "Expected validator to be a Proc. Received [#{validator.class}]"
-        end
-
-        # Proc will validate the entire attribute -- Full assignment must occur before validate is called
-        Proc.new do |value|
-          begin
-            allow =
-              if allowed.is_a?(Array)
-                allowed.include?(value.class)
-              else
-                allowed == value.class
-              end
-            # order is important -- Do not run validator if it is the default object
-            # Default object will likely raise an error if there is a custom validator
-            (allowed.include?(ClassComposer::DefaultObject) && value == ClassComposer::DefaultObject) || (allow && validator.(value))
-          rescue StandardError => e
-            raise error_klass, "#{e} occured during validation for value [#{value}]. Check custom validator for #{name}"
-          end
-        end
-      end
+      base.include(InstanceMethods)
     end
   end
 end

data/lib/class_composer/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ClassComposer
-  VERSION = "1.0.2"
+  VERSION = "2.1.0"
 end

data/lib/class_composer.rb

@@ -6,5 +6,4 @@ require "class_composer/generator"
 module ClassComposer
   class Error < StandardError; end
   class ValidatorError < Error; end
-  # Your code goes here...
 end

metadata

@@ -1,71 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: class_composer
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2022-07-04 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.0
+date: 2024-12-18 00:00:00.000000000 Z
+dependencies: []
 description: Compose configurations for any class.
 email:
 - mattius.taylor@gmail.com
@@ -89,9 +33,18 @@ files:
 - bin/setup
 - class_composer.gemspec
 - docker-compose.yml
+- docs/array_usage.md
+- docs/basic_composer.md
+- docs/basic_composer_example.md
+- docs/composer_blocking.md
+- docs/freezing.md
+- docs/generating_initializer.md
 - lib/class_composer.rb
 - lib/class_composer/default_object.rb
+- lib/class_composer/generate_config.rb
 - lib/class_composer/generator.rb
+- lib/class_composer/generator/class_methods.rb
+- lib/class_composer/generator/instance_methods.rb
 - lib/class_composer/version.rb
 homepage: https://github.com/matt-taylor/class_composer
 licenses:
@@ -107,14 +60,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Easily compose a class via inline code or passed in YAML config. Add instance