class_composer 0.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1bb350ed5d28637c5d2cf2574450eb66459c14c06a49e6f427eaece430df73f
-  data.tar.gz: db684a27bbe7b948380538952c1a9f6a348c6c2c96c1e7774915b92709b0f372
+  metadata.gz: 7d53fe12431ff8f1dd4c42d7282d11a64637a0c3ab573e24a7d83443a8a9cac2
+  data.tar.gz: 0376e66b2fef6bc976289dd1f4e4517830dd0a63c0e12519730efc9786865c9f
 SHA512:
-  metadata.gz: 3a316374ba96891a3b1e202893bb79d125db16126636a981b7a19f5aa3caad8b34756f6b650bbc4632996e2de49e8ceb2399b40773213145570d7804fc77a4bd
-  data.tar.gz: 0e04d577ad1984244d0a89be64c407f456d53641486ec06531d7cf390ce8439029dc8cdea7ee42acadb123d8ee1c5e7888e061a1524cee3b2b52c842fa1282d8
+  metadata.gz: b08e706f2f55865e6d4fab779896450dab524b946412ee8e8be8a673b205a8f3ded0a438db6dbce53d8ebc06c6a88a2dc6cba5a4da3bd5e22a599a205ea9cc0f
+  data.tar.gz: bfa9491b16358fc59b221bd5ac847b861c52a6a5793dca4fc59c81a8ceef3e12c1d3148bd8679833e4c5a643e5738788a9647a1619f9aadc2171b9d497bd0f34

data/CHANGELOG.md

@@ -1,26 +1,15 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+### Versioning
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+**Major:** x - Major Releases with new features that constitute a breaking change
 
-## [Unreleased]
+**Minor:** x.x - Minor changes or features added which are backwords compatible
 
-## [0.0.1] - 2022-06-18
+**Patch:** x.x.x - Patch Updates
 
-### Added
-- New feature 1
-- New feature 2
+# Release Notes
 
-### Changed
-- Changed feature 1
-- Changed feature 2
-
-### Removed
-- Removed feature 1
-- Removed feature 2
-
-### Fixed
-- Bug fix 1
-- Bug fix 2
+|  Date | Version  | Description  |
+|---|---|---|
+| June 2022  | v1.0.0  | Initial launch of Composer

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    class_composer (0.0.1)
+    class_composer (0.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,14 +1,11 @@
 # ClassComposer
 
-Welcome to your new gem! In this directory, you'll find the files you need to be
-able to package up your Ruby library into a gem. Put your Ruby code in the file
-`lib/class_composer`. To experiment with that code, run
-`bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Basic configuration is relatively simple but tedious to do if done multiple times. throughout a project. The intention of `ClassComposer` is to DRY up as much of that configuration as possible to allow you to just write code.
 
 ## Installation
 
+`ClassComposer` is hosted on RubyGems https://rubygems.org/gems/class_composer
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -25,7 +22,138 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic
+
+`add_composer` is the driving method behind the composer gem. It will
+- Add a setter Method
+- Add a getter Method
+- Add instance variable
+- Add validation Method
+
+In short, Composer will behave similarly to `attr_accessor`
+
+
+```ruby
+require 'class_composer'
+
+class MyConfigurableClass
+  include ClassComposer::Generator
+
+  ALLOWED_FIBONACCI = [0, 2, 8, 13, 34]
+
+  add_composer :status, allowed: Integer, default: 35
+  add_composer :number, allowed: Integer, default: 0, validator: -> (val) { val < 50 }
+  # when no default is provided, nil will be returned
+  add_composer :fibbonacci, allowed: Array, validator: ->(val) { val.all? {|i| i.is_a?(Integer) } && val.all? { |i| ALLOWED_FIBONACCI.include?(i) } }, invalid_message: ->(val) { "We only allow #{ALLOWED_FIBONACCI} numbers. Received #{val}" }
+  # Allowed can be passed an array of allowed class types
+  add_composer :type, allowed: [Proc, Integer], default: 35
+end
+
+instance = MyConfigurableClass.new
+instance.type
+=> 35
+instance.number = 75
+ClassComposer::ValidatorError: MyConfigurableClass.number failed validation. number is expected to be Integer.
+from /gem/lib/class_composer/generator.rb:71:in `block in __composer_assignment__`
+instance.number = 15
+=> 15
+instance.number
+=> 15
+instance.fibbonacci
+=> nil
+instance.fibbonacci = [1,2,3]
+ClassComposer::ValidatorError: MyConfigurableClass.fibbonacci failed validation. fibbonacci is expected to be [Array]. We only allow [0, 2, 8, 13, 34] numbers. Received [1, 2, 3]
+from /gem/lib/class_composer/generator.rb:71:in `block in __composer_assignment__`
+instance.fibbonacci = [0,13,34]
+=> [0, 13, 34]
+instance.fibbonacci
+=> [0, 13, 34]
+```
+
+### KWarg Options
+
+```
+allowed
+  - Required: True
+  - What: Expected value of the name of the composed method
+  - Type: Array of Class types or Single Class type
+
+validator
+  - Required: False
+  - What: Custom way to validate the value of the composed method
+  - Type: Proc
+  - Default: ->(_) { true }
+  - By default validation happens on the `allowed` KWARG first and then the passed in validator function. Proc should expect that the type passed in is one of `allowed`
+
+validation_error_klass
+  - Required: false
+  - What: Class to raise when a validation error occurs from `allowed` KWarg or from the passed in `validator` proc
+  - Type: Class
+  - Default: ClassComposer::ValidatorError
+
+validation_error_klass
+  - Required: false
+  - What: Class to raise when a errors occur outside of validation. This can be for composer method errors or proc errors during validation
+  - Type: Class
+  - Default: ClassComposer::Error
+
+default
+  - Required: false
+  - What: This is the default value to set for the composed method
+  - Type: Should match the `allowed` KWarg
+  - Default: nil
+  - Note: When no default value is provided, the return value from the getter will be `nil`. However, this does not mean that NilClass will be an acceptable value during the setter method
+
+invalid_message
+  - Required: False
+  - What: Message to add to the base invalid setter method
+  - Type: Proc or String
+    - Proc: ->(val) { } # where val is the failed value of the setter method
+
+```
+
+### Advanced
+
+#### Usage with Array as Allowed
+Arrays are treated special with the composed methods. `ClassComposer` will inject a custom method `<<` so that it can be treated as a regular array with the added benefit of validation still occuring.
+
+```ruby
+class CustomArrayClass
+  include ClassComposer::Generator
+
+  add_composer :array, allowed: Array, default: [], validator: ->(val) { val.sum < 40 }, invalid_message: ->(val) { "Array sum of [#{val.sum}] must be less than 40" }
+end
+
+instance = CustomArrayClass.new
+instance.array << 1
+instance.array << 2
+instance.array
+=> [1, 2]
+instance.array << 50
+ClassComposer::ValidatorError: CustomArrayClass.array failed validation. array is expected to be Array. Array sum of [53] must be less than 40
+
+```
+
+#### Usage with complex configuration
+
+```ruby
+class ComplexDependencies
+  include ClassComposer::Generator
+
+  add_composer :use_scope, allowed: [TrueClass, FalseClass], default: false
+  add_composer :scope, allowed: Proc
+
+  def scope
+    # skip unless use_scope is explicitly set
+    return -> {} unless @use_scope
+
+    # use passed in scope if present
+    # Otherwise default to blank default
+    @scope || -> {}
+  end
+end
+```
+Adding custom methods allows for higher level of complexity. The methods can be used and accessed just as an `attr_accessor` would.
 
 ## Development
 

data/class_composer.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["Matt Taylor"]
   spec.email   = ["mattius.taylor@gmail.com"]
 
-  spec.summary     = "Describe the gem here"
-  spec.description = "Describe the gem here"
+  spec.summary     = "Easily compose a class via inline code or passed in YAML config. Add instance attributes with custom validations that will DRY up your code"
+  spec.description = "Compose configurations for any class."
   spec.homepage    = "https://github.com/matt-taylor/class_composer"
   spec.license     = "MIT"
 

data/lib/class_composer/default_object.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "class_composer/version"
+
+# This is to add a falsey like default behavior
+# When default value is not passed in let this be an allowed value
+# This is intended to eventually be configurable
+
+module ClassComposer
+  module DefaultObject
+    module_function
+
+    def value
+      nil
+    end
+  end
+end

data/lib/class_composer/generator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "class_composer/version"
+require "class_composer/default_object"
 
 module ClassComposer
   module Generator
@@ -13,22 +13,35 @@ module ClassComposer
       COMPOSER_ASSIGNED_ATTR_NAME = ->(name) { :"@__composer_#{name}_value_assigned__" }
       COMPOSER_ASSIGNED_ARRAY_METHODS = ->(name) { :"@__composer_#{name}_array_methods_set__" }
 
-      def add_composer(name, allowed:, default: nil, accessor: true, validator: ->(_) { true }, **params)
-        validate_proc = __composer_validator_proc__(validator: validator, allowed: allowed, name: name)
-        __composer_validate_options__!(name: name, validate_proc: validate_proc, default: default)
+      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, params: params, validator: validate_proc, array_proc: array_proc)
+        __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:)
+      def __composer_validate_options__!(name:, validate_proc:, default:, params: {}, validation_error_klass:, error_klass:)
         unless validate_proc.(default)
-          raise ClassComposer::ValidatorError, "Default value [#{default}] for #{self.class}.#{name} is not valid"
+          raise validation_error_klass, "Default value [#{default}] for #{self.class}.#{name} is not valid"
         end
 
-        if self.class.instance_methods.include?(name.to_sym)
-          raise ClassComposer::Error, "#{name} is already defined. Ensure composer names are all uniq and do not class with class instance methods"
+        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
 
@@ -39,7 +52,7 @@ module ClassComposer
       end
 
       # create assignment method for the incoming name
-      def __composer_assignment__(name:, params:, validator:, array_proc:)
+      def __composer_assignment__(name:, params:, allowed:, validator:, array_proc:, validation_error_klass:, error_klass:)
         define_method(:"#{name}=") do |value|
           is_valid = validator.(value)
 
@@ -47,11 +60,15 @@ module ClassComposer
             instance_variable_set(COMPOSER_ASSIGNED_ATTR_NAME.(name), true)
             instance_variable_set(:"@#{name}", value)
           else
-            value.pop
-            message = ["#{self.class}.#{name} failed validation."]
+            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)
-            raise ClassComposer::ValidatorError, message.compact.join(" ")
+            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))
@@ -79,14 +96,15 @@ module ClassComposer
             end
             default.instance_variable_set(COMPOSER_ASSIGNED_ARRAY_METHODS.(name), true)
           end
-          default
+
+          default == ClassComposer::DefaultObject ? ClassComposer::DefaultObject.value : default
         end
       end
 
       # create validator method for incoming name
-      def __composer_validator_proc__(validator:, allowed:, name:)
+      def __composer_validator_proc__(validator:, allowed:, name:, error_klass:)
         if validator && !validator.is_a?(Proc)
-          raise ClassComposer::Error, "Expected validator to be a Proc. Received [#{validator.class}]"
+          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
@@ -98,9 +116,11 @@ module ClassComposer
               else
                 allowed == value.class
               end
-            allow && validator.(value)
+            # 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 ClassComposer::Error, "#{e} occured during validation for value [#{value}]. Check custom validator for #{name}"
+            raise error_klass, "#{e} occured during validation for value [#{value}]. Check custom validator for #{name}"
           end
         end
       end

data/lib/class_composer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: class_composer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-24 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug
@@ -66,7 +66,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.17.0
-description: Describe the gem here
+description: Compose configurations for any class.
 email:
 - mattius.taylor@gmail.com
 executables: []
@@ -90,7 +90,7 @@ files:
 - class_composer.gemspec
 - docker-compose.yml
 - lib/class_composer.rb
-- lib/class_composer/array.rb
+- lib/class_composer/default_object.rb
 - lib/class_composer/generator.rb
 - lib/class_composer/version.rb
 homepage: https://github.com/matt-taylor/class_composer
@@ -117,5 +117,6 @@ requirements: []
 rubygems_version: 3.3.11
 signing_key: 
 specification_version: 4
-summary: Describe the gem here
+summary: Easily compose a class via inline code or passed in YAML config. Add instance
+  attributes with custom validations that will DRY up your code
 test_files: []

data/lib/class_composer/array.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-module ClassComposer
-  class Array
-    def initialize(validator)
-      @validator = validator
-      super
-    end
-
-    def <<
-      value = super
-
-
-
-      value
-    end
-  end
-end