be_valid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abbbdea456536973df02299690f700bab640ac727c65fd257048e6427a20964c
+  data.tar.gz: 43bbbba7ed6a4ef05ca0a0f0a713108f17dc3aa97a4a981e6a65b1022015136b
+SHA512:
+  metadata.gz: 6389b8bf085014beb16d64fc0a559d945ebbef1f2e8d2f78900323c5650a69ba66abef5cc74158fd1093424031c1aefc3b915cb32b63036e2461219b4a36ac49
+  data.tar.gz: e59092fc516be70996b024c886fb21562298d1022582b42b689fa27cf8ef1b20d3439856584a518687c36bb6d8deabbbc09d7d9e8185a11a06e7647c26893e07

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in be_valid.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    be_valid (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.5)
+      activesupport (= 5.2.5)
+    activerecord (5.2.5)
+      activemodel (= 5.2.5)
+      activesupport (= 5.2.5)
+      arel (>= 9.0)
+    activesupport (5.2.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    concurrent-ruby (1.1.8)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    rake (10.5.0)
+    sqlite3 (1.4.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.9)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5)
+  be_valid!
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  sqlite3 (~> 1.4)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 John Stewart (johnsinco)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,62 @@
+# BeValid
+
+BeValid is a custom ActiveModel / Rails validator that helps with "conditional" validation. IE you can setup field-level validations that depend
+upon complex state within the object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'be_valid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install be_valid
+
+## Usage
+
+Examples:
+
+```ruby
+class Account
+  validates :email, 
+    must_be: {
+      present: true,
+      when: {
+        status: 'active'
+      }
+    }
+ 
+  validates :birthdate,
+    must_be: {
+      before: -> { 18.years.ago }
+    },
+    when: {
+      account_type: :adult?
+    }
+
+    validates :open_date, date: {time: true, before: :now}
+
+    validates :late_fee,
+      must_be: { 
+        equal_to: 0,
+        when: { 
+          status: 'current',
+          customer_type: :premier? 
+        },
+        rule_name: :premier_customer_waived_fee
+      },
+      allow_blank: true
+
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/be_valid.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "be_valid/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "be_valid"
+  spec.version       = BeValid::VERSION
+  spec.authors       = ["John Stewart (johnsinco)"]
+  spec.email         = ["johnstewartco@outlook.com"]
+
+  spec.summary       = %q{Custom Ruby on Rails Validation library supporting 'conditional' validation}
+  spec.description   = %q{Provides more advanced and flexible 'if then then that' style conditional validation. Validate fields based on the values of other fields in your model.}
+  spec.homepage      = "https://github.com/johnsinco/be_then"
+  spec.license       = "MIT"
+
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "activerecord", "~> 5"
+  spec.add_development_dependency "sqlite3", "~> 1.4"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "be_valid"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/be_valid.rb

@@ -0,0 +1,9 @@
+require 'be_valid/be_valid'
+
+begin
+  require 'validators/must_be_validator'
+  require 'validators/date_validator'
+rescue 
+  'unable to loan be_valid validator'
+  nil
+end

data/lib/be_valid/be_valid.rb

@@ -0,0 +1,18 @@
+module BeValid
+  def self.config
+    @@config ||= Configuration.new
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config)
+  end
+
+  class Configuration
+    attr_accessor :notice_rules
+
+    def initialize
+      @notice_rules= []
+    end
+  end
+end

data/lib/be_valid/version.rb

@@ -0,0 +1,3 @@
+module BeValid
+  VERSION = "0.1.0"
+end

data/lib/validators/date_validator.rb

@@ -0,0 +1,90 @@
+class DateValidator < ActiveModel::EachValidator
+
+  # https://stackoverflow.com/questions/28538080/rails-validate-dates-in-model-before-type-cast
+
+  def validate_each(record, attribute, value)
+
+    @error_hash = options[:error_level].present? ? record.send(options[:error_level]) : record.errors
+
+    original_value = record.read_attribute_before_type_cast( attribute )
+    # dont display date format error unless date could not be parsed
+    if value.nil?
+      # if blank date was given it's still not a format issue, still show message if desired
+      return if original_value.blank? && options[:allow_blank]
+
+      # display helpful date format validation message with original value
+      message = options[:time] ?  ": #{original_value} is not a valid value. Value must be a date in YYYY-MM-DD or YYYY-MM-DD HH:MM:SS format." : ": #{original_value} is not a valid value. Value must be a date in YYYY-MM-DD."
+      @error_hash.add(attribute, (options[:message] || message))
+    else
+      # handle validation options on valid date instances
+      return unless value.respond_to?(:strftime)
+      if(options[:after] && (after_message = validate_after_option(record, attribute, value, original_value)) != true)
+        @error_hash.add(attribute, (options[:after_message] || "#{after_message}."))
+      end
+      if(options[:before] && (before_message = validate_before_option(record, attribute, value, original_value)) != true)
+        @error_hash.add(attribute, (options[:before_message] || "#{before_message}."))
+      end
+    end
+  end
+
+  def validate_after_option(record, attribute, value, original_value)
+    date, value = date_for(record, value, options[:after])
+    return true unless date.present?
+    return true if value.present? && date.present? && (value && date && value >= date)
+
+    after_message = ": #{original_value} is not a valid value."
+    if options[:after] == :now || options[:after] == :today
+      after_message << " Date cannot be in the past"
+    elsif options[:after].respond_to?(:strftime)
+      after_message << " Date cannot be before #{options[:after]}"
+    elsif options[:after].is_a? Proc
+      after_message << " Date cannot be before #{options[:after].call(record)}"
+    elsif record.respond_to?(options[:after])
+      after_message << " Date cannot be before #{options[:after]}"
+    end
+    after_message
+  end
+
+  def validate_before_option(record, attribute, value, original_value)
+    date, value = date_for(record, value, options[:before])
+    return true unless date.present?
+    return true if value.present? && date.present? && (value && date && value <= date)
+
+      before_message = ": #{original_value} is not a valid value."
+      if options[:before] == :now || options[:before] == :today
+        before_message << " Date cannot be in the future" 
+      elsif options[:before].respond_to?(:strftime)
+        before_message << " Date cannot be after #{options[:before]}"
+      elsif options[:before].is_a? Proc
+        before_message << " Date cannot be after #{options[:before].call(record)}"
+      elsif record.respond_to?(options[:before])
+        before_message << " Date cannot be after #{options[:before]}"
+      end
+      before_message
+  end
+
+  # source: https://github.com/fnando/validators/blob/main/lib/validators/validates_datetime.rb
+  def date_for(record, value, option)
+    date = case option
+           when :today
+             Date.today
+           when :now
+             Time.now + 60  # be lenient on now for server clocks
+           when Time, Date, DateTime, ActiveSupport::TimeWithZone
+             option
+           when Proc
+             option.call(record)
+           else
+             record.__send__(option) if record.respond_to?(option)
+           end
+    return unless date.present?
+    date = date.to_date unless options[:time]
+    if date.is_a?(Time)
+      value = value.to_time
+    elsif date.is_a?(Date)
+      value = value.to_date
+    end
+    [date, value]
+  end
+
+end

data/lib/validators/must_be_validator.rb

@@ -0,0 +1,97 @@
+class MustBeValidator < ActiveModel::EachValidator
+  MATCHERS = {
+    equal_to: :==,
+    greater_than: :>,
+    greater_or_equal_to: :>=,
+    less_than: :<,
+    less_or_equal_to: :<=,
+    not_equal_to: :!=,
+    matching: :=~,
+    # one_of: :in?
+  }.freeze
+
+  MESSAGE_PREFIX = "must be"
+  ERRORS_METHOD = :errors
+
+  def validate_each(record, attribute, value) 
+    raise "must_be_validator requires at least one comparison operator for attribute." unless options.slice(MATCHERS.keys + [:blank, :present])
+
+    original_value = record.read_attribute_before_type_cast( attribute )
+
+    message = self.class::MESSAGE_PREFIX.dup
+
+    return if options[:blank] && value.blank?
+    message << " blank" if options[:blank]
+
+    return if options[:present] && value.present?
+    message << " present" if options[:present]
+
+    return if options[:one_of] && options[:one_of].include?(value)
+    message = ": '#{value}' is not a valid value" if options[:one_of]
+
+    return if options[:not_any_of] && !(options[:not_any_of].include?(value))
+    message = ": '#{value}' is not a valid value" if options[:not_any_of]
+
+    return if options[:only_from] && (options[:only_from] & Array(value) == Array(value))
+    message = ": #{Array(value).join(",").gsub('"', '\'')} is not a valid value" if options[:only_from]
+
+    # handle before and after date comparisons using date validator
+    if options[:before] 
+      before_resp = DateValidator.new(options.merge(attributes: attributes)).validate_before_option(record, attribute, value, original_value)
+      return if before_resp == true
+      message = before_resp
+    end
+    if options[:after] 
+      after_resp = DateValidator.new(options.merge(attributes: attributes)).validate_after_option(record, attribute, value, original_value)
+      return if after_resp == true
+      message = after_resp
+    end
+
+    options.slice(*MATCHERS.keys).each do |key, operand|
+      operand_msg = operand.is_a?(Regexp) ? operand.inspect : operand.to_s
+      operand = record.send(operand) if operand.is_a? Symbol
+      return if operand.nil?
+      return if value&.send(MATCHERS[key], operand)
+      return if key == :not_equal_to && value != operand
+      message << " #{key.to_s.humanize(capitalize: false)} #{operand_msg}"
+    end
+
+    if options[:when].present?
+      # check if conditions to validate satisfied
+      conditions = options[:when]
+      raise "Invalid :when option provided to must_be, must be a Hash or method" unless (conditions.is_a? Hash || conditions.is_a?(Method))
+      # add error message with predicate info
+      message << " when "
+      condition_errors = []
+      conditions.each do |field, values|
+        case values
+        when Regexp
+          return if !values.match?(record[field])
+          condition_errors << "#{field} = #{record[field]}"
+        when Array
+          return if !values.include?(record[field])
+          condition_errors << "#{field} = #{record[field]}"
+        when Symbol
+          return if !record.send(field)&.send(values)
+          condition_errors << "#{field} is #{values.to_s.gsub('?', '')}"
+        else
+          return if values != record[field]
+          condition_errors << "#{field} = #{record[field]}"
+        end
+      end
+      message << condition_errors.join(' and ')
+    end
+
+    if options[:one_of] && options.fetch(:show_values, true)
+      message << ". Valid values: #{options[:one_of].join(', ')}"
+    end
+    if options[:only_from] && options.fetch(:show_values, true)
+      message << ". Valid values: #{options[:only_from].join(', ')}"
+    end
+    if options[:not_any_of] && options.fetch(:show_values, true)
+      message << ". Invalid values: #{options[:not_any_of].join(', ')}"
+    end
+
+    record.send(self.class::ERRORS_METHOD).add(attribute, (options[:message] || "#{message}."), rule_name: options[:rule_name])
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: be_valid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Stewart (johnsinco)
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Provides more advanced and flexible 'if then then that' style conditional
+  validation. Validate fields based on the values of other fields in your model.
+email:
+- johnstewartco@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- be_valid.gemspec
+- bin/console
+- bin/setup
+- lib/be_valid.rb
+- lib/be_valid/be_valid.rb
+- lib/be_valid/version.rb
+- lib/validators/date_validator.rb
+- lib/validators/must_be_validator.rb
+homepage: https://github.com/johnsinco/be_then
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key:
+specification_version: 4
+summary: Custom Ruby on Rails Validation library supporting 'conditional' validation
+test_files: []