class_composer 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f723db5d8375b56bf7ac7a9e84b6cc0ddb0caa30300b75bf24cae0c6237ec8e0
-  data.tar.gz: '087156c95394f2c965a0cffe757bfbe881ff9e6af4bbfe086997163599fd11a2'
+  metadata.gz: 32a9c6f0ff1d02646977e79cc67c746ae3a24a4fdce5b22003e6c9d0035ea0df
+  data.tar.gz: 55bc12b96385d9772980f9348b8b0d42f1bb0436736fcaaec018fa7f5a681418
 SHA512:
-  metadata.gz: 5402a22f9a561f8f7d1b40d764a3cdcec19030ff13218ffe125d13c8bc1a6d2158f501a6aa1d49612c071653fd1cd25f3a45bfe3c257c249087374194c9efed0
-  data.tar.gz: c3b42f9f53b843acbf404cc1a7188a8af981d45c15b0dcd28d2b11097fc4121c24829a0018f94a04e9f3630b2ba423004edb35343b5c74a3f5c7f7f2e959b23c
+  metadata.gz: a7dfffaa0dbe370e01dfa4e77a666e49fad3ff855b43b839e4d8ff0b31cd0ba547217d834bca792559147bb12aba55f1b0d14e7b18d751b20a893ae34c3ca736
+  data.tar.gz: d4f565781f952e89f2f5234ea1179736888ccf889f6aa94d231933beb96a752146029bc77c9a2afb637feb419075d00e15787af2fab15473da042928e22dbf08

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,117 @@ 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) {  }
+  # when no default is provided, nil will be returned
+  add_composer :fibbonacci, allowed: Array, validator: ->(val) { val.all? {|i| i.is_a?(Integer) } && (val - ALLOWED_FIBONACCI) > 0 }, 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
+```
+
+### 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/lib/class_composer/generator.rb

@@ -13,7 +13,7 @@ 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:, accessor: true, validator: ->(_) { true }, validation_error_klass: ::ClassComposer::ValidatorError, error_klass: ::ClassComposer::Error,**params)
+      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]

data/lib/class_composer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: class_composer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Matt Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-27 00:00:00.000000000 Z
+date: 2022-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry-byebug