method_argument_constraints 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 811e1791560b4fa12bb4beacde28f07a7e93bb0a9d7e9f82bd8af7046bf84f7b
+  data.tar.gz: f0e2d9dc9fda5b1ae35fe162d37a0e8491a78c01055a85a9ba5373c595b24dd0
+SHA512:
+  metadata.gz: 136425ad0dfaf09afb89a631da1e086973cf3c6f4efc050aaffec5a3a20ec97f5335a8fdb6679c64cec96f3eef92e66ddf744af516d72dad01e16ed759c95020
+  data.tar.gz: 83556167a7132b14ea9c38ae7abb848ad0a08a578e284bebdff43adc2d789bf31d8eb4c4606096565ffecbbbb786fabd08992450e456fe871d431c7d2602e647

data/lib/method_argument_constraints.rb

@@ -0,0 +1,83 @@
+module MethodArgumentConstraints
+  class RequirementsFailed < StandardError; end
+  class WrongDataTypeError < StandardError; end
+  class NoBindingError < StandardError; end
+
+  def method_constraints!(caller_binding, params)
+    raise NoBindingError.new("No binding passed for method using method_constraints!") unless caller_binding.is_a? Binding
+    caller_method = caller_locations(1,1).first.label
+    arguments = _method_attributes(caller_binding, caller_method, params)
+    evaluations = []
+    arguments.each do |param_name, param_details|
+      evaluations << _validate_param(param_name, param_details)
+    end
+    evaluations.compact!
+    return if evaluations.empty?
+    raise RequirementsFailed.new(_build_failure_error(evaluations))
+  end
+
+  private def _build_failure_error(evaluations)
+    evaluations_formatted = evaluations.inject("") do |final_string, evaluation|
+      "#{final_string} #{evaluation.class}: #{evaluation.message}\n"
+    end
+    "Requirements failed with the following errors: \n#{evaluations_formatted}"
+  end
+
+  private def _validate_param(param_name, param_details)
+    param_value = param_details[:value]
+    param_constraint = param_details[:constraint]
+    if param_details[:required]
+      return if param_constraint.nil?
+      unless _requirement_passed?(param_value, param_constraint, param_name)
+        _build_required_param_error(param_name, param_constraint)
+      end
+    else
+      return if param_value.nil? || param_constraint.nil?
+      unless _requirement_passed?(param_value, param_constraint, param_name)
+        _optional_param_error(param_name, param_constraint)
+      end
+    end
+  end
+
+  private def _requirement_passed?(param_value, param_constraint, param_name)
+    if param_constraint.is_a? Proc
+      param_constraint.call(param_value, param_name)
+    elsif param_constraint.is_a? Symbol
+      public_send(param_constraint, param_value, param_name)
+    else
+      param_value.is_a?(param_constraint)
+    end
+  end
+
+  private def _build_required_param_error(param_name, param_constraint)
+    if param_constraint.is_a?(Proc) || param_constraint.is_a?(Symbol)
+      message = "#{param_name} failed required validation it does not meet set constraint"
+    else
+      message = "#{param_name} failed required validation as it is not off type #{param_constraint}"
+    end
+    WrongDataTypeError.new(message)
+  end
+
+  private def _optional_param_error(param_name, param_constraint)
+    if param_constraint.is_a?(Proc) || param_constraint.is_a?(Symbol)
+      message = "#{param_name} failed required validation it does not meet set constraint"
+    else
+      message = "#{param_name} failed optional param validation as it is not off type #{param_constraint} or set to nil"
+    end
+    WrongDataTypeError.new(message)
+  end
+
+  private def _method_attributes(method_binding, method_name, constraints)
+    method(method_name).parameters.each_with_object({}) do |parameter, attributes|
+      required_or_optional = parameter.first
+      name = parameter.last
+      attributes[name] = {
+        required: (required_or_optional == :req),
+        value: method_binding.local_variable_get(name),
+        constraint: constraints.dig(name)
+      }
+    end
+  end
+end
+
+Object.include MethodArgumentConstraints

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: method_argument_constraints
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Etsenake
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-08-02 00:00:00.000000000 Z
+dependencies: []
+description: Call method_contraints! with the param name and constraint to enforce
+  validation on it
+email:
+- etsenake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/method_argument_constraints.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Asserts argument constraints on method arguments
+test_files: []