hashy_validator 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb2d96afac20d3a5de238c5909ba7001ebfabdbbb790ea9b0ead248853018005
-  data.tar.gz: 299cb764bb7dfcd2bc69ef07cd791d8b76726b69eb0f7a12a0f28c7b1d71d55f
+  metadata.gz: 65bbe593f0a313de084f7bd4a7ab23075422a068a7bea5dc6903f55a7243b09e
+  data.tar.gz: b86b243a6e39958a38b8c51bd1d2ce2644e0581a6929956faf74d8c83cab2a34
 SHA512:
-  metadata.gz: 6d27b7aa8aae40311a1526fd5fd70c38f962e646d5a73618295f24b874e29cca0d76661111dfbeb7fccf86ccbc5e199201ac0ef4dea5293d0e8838ea2615f401
-  data.tar.gz: 6a2c04d418e28ad116b0d70b2b6d31c58bd0ffff4aa9aaf9e1f3648f8cacbcc4556a90894bb835a7da4b6430d20b42a1e84a9b4a51e64345e2cf4f0b971f76af
+  metadata.gz: af7fd7055e2bf2462ae5784668f7c42d502abfd293e72c4ded6d17d5694182b92342ffb3f22a45063534d81ad53b15c0652092e66490abe46a8428a8acfba166
+  data.tar.gz: 74a8d08f9409cd379a2be4af5a82118323ed36dbfb097cddac2fc9b8860348efb37d401c18da6040dbd04bc70adde05483dd72d600fc716d1c58af1d5c7fbd2b

data/CHANGELOG.md

@@ -5,9 +5,26 @@ All notable changes to this project will be documented in this file.
 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).
 
-### [0.1.3](https://www.github.com/flecto-io/hashy-validator/compare/v0.1.2...v0.1.3) (2024-01-13)
+### [0.1.5](https://www.github.com/flecto-io/hashy-validator/compare/v0.1.4...v0.1.5) (2024-09-05)
 
 
+### Bug Fixes
+
+* add hashy_object ([35e1ccf](https://www.github.com/flecto-io/hashy-validator/commit/35e1ccf1cff9d95df069961c8ac1b3fec6d23645))
+
+### [0.1.4](https://www.github.com/flecto-io/hashy-validator/compare/v0.1.3...v0.1.4) (2024-08-24)
+
+
+### Bug Fixes
+
+* Accepts dependencies version of activerecord lower than 8 ([eab4692](https://www.github.com/flecto-io/hashy-validator/commit/eab46925196ada0db0c408037cdf90b9ce4dacca))
+
+### [0.1.2](https://www.github.com/flecto-io/hashy-validator/compare/v0.1.2...v0.1.3) (2024-01-13)
+
+### Changes
+
+* Production ready
+
 ### Bug Fixes
 
 * changelog ([6b8c151](https://www.github.com/flecto-io/hashy-validator/commit/6b8c15105bd085dafa6358f27f780ad4826a42e7))

data/README.md

@@ -8,7 +8,6 @@
 HashyValidator is a custom Ruby on Rails validator designed to validate an array of hashes based on [HashValidator](https://github.com/jamesbrooks/hash_validator) criteria but also the following new criteria:
 - `unique`: A value within each hash that has to be unique across the whole array
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -17,8 +16,6 @@ Add this line to your application's Gemfile:
 gem 'hashy_validator'
 ```
 
-<b>THIS GEM IS NOT READY FOR PRODUCTION YET!</b>
-
 And then execute:
 
 ```bash
@@ -42,14 +39,20 @@ To leverage HashyValidator in your Rails model, follow these steps:
    ```ruby
    class YourModel < ApplicationRecord
      validates :pricing, hashy_array: {
-       minutes: HashValidator.multiple('required', 'integer', 'unique'),
-       price_cents: HashValidator.multiple('required', 'integer')
+       minutes: HashValidator.multiple('integer', 'unique'),
+       price_cents: HashValidator.multiple('integer')
      }
    end
    ```
    
    Customize each entry validators according to [HashValidator](https://github.com/jamesbrooks/hash_validator) criteria
 
+# Testing
+
+```bash
+rake test
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration. To ease up contribution we provide a VSCode _devcontainer_ to run the project in a container.

data/hashy_validator.gemspec

@@ -14,12 +14,15 @@ Gem::Specification.new do |spec|
     spec.require_paths = ["lib"]
     spec.files = Dir["{lib}/**/*"] + ["README.md", "CHANGELOG.md", "hashy_validator.gemspec"]
 
-    spec.add_dependency "activerecord", ">= 6.0.0", "<= 7.2.0"
+    spec.add_dependency "activerecord", ">= 6.0.0", "< 8.0.0"
     spec.add_dependency "hash_validator", "~> 1.1"
 
     spec.add_development_dependency 'sqlite3', '~> 1.4'
     spec.add_development_dependency 'rake', '~> 13.1.0'
     spec.add_development_dependency 'simplecov', '0.17.1'
+    spec.add_development_dependency 'rubocop', '~> 1.59'
+    spec.add_development_dependency 'rubocop-shopify', '~> 2.14'
+    spec.add_development_dependency 'pry', '~> 0.14.1'
 
     if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3")
         spec.add_development_dependency 'minitest', '>= 5.15.0', '< 5.16'

data/lib/hashy_validator/hashy_array_validator.rb

@@ -1,63 +1,45 @@
+# frozen_string_literal: true
+
 class HashyArrayValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
-    instance_value = HashyValueValidator.new(value)
-    unless instance_value.is_valid
+    instance_value = HashyValueValidator.new(value, options)
+
+    unless instance_value.valid?
       record.errors.add(attribute, instance_value.reason)
       return false
     end
 
-    value = instance_value.value
+    unless instance_value.value.is_a?(Array)
+      record.errors.add(attribute, :not_an_array)
+      return false
+    end
 
-    # look for boolean and unique validator entries
-    unique_attrs = {}
-    boolean_attrs = []
-    validations =
-      # force validator keys to be strings
-      options.stringify_keys.map do |val_attr,val|
-        if (val.is_a?(HashValidator::Validations::Multiple) && val.validations.include?('boolean')) || (val.is_a?(String) && val == 'boolean')
-          boolean_attrs << val_attr
-          [val_attr, val]
-        elsif val.is_a?(HashValidator::Validations::Multiple) && val.validations.include?('unique')
-          # if unique key present, then remove that entry (since its not from HashValidator standard) and keep its history
-          unique_attrs[val_attr] ||= []
-          # we have to make a new object to remove the unique entry,
-          # because deleting it directly from the original object (val) would result into deleting the verification forever
-          new_val = HashValidator::Validations::Multiple.new(val.validations.reject{|v| v == 'unique'})
-          # return the value
-          val.validations.blank? ? nil : [val_attr, new_val]
-        elsif val.is_a?(String) && val == 'unique'
-          # same as above but substring
-          unique_attrs[val_attr] ||= []
-          nil
-        else
-          [val_attr, val]
-        end
-      end.compact.to_h
+    value = instance_value.value
 
     # force all array entries to have string keys
     # discard keys that do not have validators
-    value = value.map{ |e| e.stringify_keys.slice(*validations.keys) }
+    value = value.map { |e| e.stringify_keys.slice(*instance_value.validations.keys) }
 
     # we validate each object in the array
     value.each do |t|
       # if boolean found as any of the validations we force value to boolean - if present
-      boolean_attrs.each do |boolean_attr|
-        t[boolean_attr] = get_boolean_value(t[boolean_attr]) if t.key?(boolean_attr)
+      instance_value.boolean_attrs.each do |boolean_attr|
+        t[boolean_attr] = HashyValueValidator.get_boolean_value(t[boolean_attr]) if t.key?(boolean_attr)
       end
 
       # keep track of unique values and add error if needed
-      unique_attrs.keys.each do |unique_attr|
-        if unique_attrs[unique_attr].include?(t[unique_attr])
+      instance_value.unique_attrs.each_key do |unique_attr|
+        if instance_value.unique_attrs[unique_attr].include?(t[unique_attr])
           record.errors.add(attribute, "'#{unique_attr}' not unique")
         else
-          unique_attrs[unique_attr] << t[unique_attr]
+          instance_value.unique_attrs[unique_attr] << t[unique_attr]
         end
       end
 
       # use default hash validator
-      validator = HashValidator.validate(t, validations)
+      validator = HashValidator.validate(t, instance_value.validations)
       unless validator.valid?
-        validator.errors.each { |k,v| record.errors.add(attribute, "'#{k.to_s}' #{v}") }
+        validator.errors.each { |k, v| record.errors.add(attribute, "'#{k}' #{v}") }
       end
     end
 
@@ -65,12 +47,4 @@ class HashyArrayValidator < ActiveModel::EachValidator
     # we use send write param so we also support attr_accessor attributes
     record.send("#{attribute}=", value)
   end
-
-  private
-
-  def get_boolean_value(value)
-    return true if value == true || value == 'true'
-    return false if value == false || value == 'false'
-    nil
-  end
 end

data/lib/hashy_validator/hashy_object_validator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+class HashyObjectValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    instance_value = HashyValueValidator.new(value, options)
+
+    # Do not validate empty hash
+    return if instance_value.value.keys.empty?
+
+    unless instance_value.valid?
+      record.errors.add(attribute, instance_value.reason)
+      return false
+    end
+
+    if instance_value.value.is_a?(Array)
+      record.errors.add(attribute, :not_an_object)
+      return false
+    end
+
+    # force all array entries to have string keys
+    # discard keys that do not have validators
+    value = instance_value.value.stringify_keys.slice(*instance_value.validations.keys)
+
+    # we validate each object in the array
+    # if boolean found as any of the validations we force value to boolean - if present
+    instance_value.boolean_attrs.each do |boolean_attr|
+      value[boolean_attr] = HashyValueValidator.get_boolean_value(t[boolean_attr]) if value.key?(boolean_attr)
+    end
+
+    # keep track of unique values and add error if needed
+    instance_value.unique_attrs.each_key do |unique_attr|
+      if instance_value.unique_attrs[unique_attr].include?(value[unique_attr])
+        record.errors.add(attribute, "'#{unique_attr}' not unique")
+      else
+        instance_value.unique_attrs[unique_attr] << t[unique_attr]
+      end
+    end
+
+    # use default hash validator
+    validator = HashValidator.validate(value, instance_value.validations)
+    unless validator.valid?
+      validator.errors.each { |k, v| record.errors.add(attribute, "'#{k}' #{v}") }
+    end
+
+    # update the value even if errors found
+    # we use send write param so we also support attr_accessor attributes
+    record.send("#{attribute}=", value)
+  end
+end

data/lib/hashy_validator/hashy_value_validator.rb

@@ -1,42 +1,72 @@
+# frozen_string_literal: true
+
 class HashyValueValidator
-    def initialize(value)
-      @value = value.blank? ? [] : value
-      @valid = true
-      @reason = nil
-  
-      check_parse_value
-      check_is_array
-      
-      @value
-    end
-  
-    def is_valid
-      @valid
-    end
-  
-    def value
-      @value
-    end
-
-    def reason
-      @reason
-    end
-  
-    private
-  
-    def check_parse_value
-      begin
-        @value = JSON.parse(@value) if @value.is_a?(String)
-      rescue JSON::ParserError
-        @valid = false
-        @reason = :invalid
-      end
-    end
-  
-    def check_is_array
-      unless @value.is_a?(Array)
-        @valid = false
-        @reason = :not_an_array
-      end
-    end
-  end
+  def initialize(value, options = {})
+    @value = value.blank? ? [] : value
+    @valid = true
+    @reason = nil
+    @validations = {}
+    @unique_attrs = {}
+    @boolean_attrs = []
+
+    check_parse_value
+    define_validations(options)
+  end
+
+  def valid?
+    @valid
+  end
+
+  attr_reader :value, :reason, :validations, :unique_attrs, :boolean_attrs
+
+  def self.get_boolean_value(value)
+    return true if [true, "true"].include?(value)
+    return false if [false, "false"].include?(value)
+
+    nil
+  end
+
+  private
+
+  def check_parse_value
+    @value = JSON.parse(@value) if @value.is_a?(String)
+  rescue JSON::ParserError
+    @valid = false
+    @reason = :invalid
+  end
+
+  def define_validations(options)
+    # look for boolean and unique validator entries
+    unique_attrs = {}
+    boolean_attrs = []
+    validations =
+      # force validator keys to be strings
+      options.stringify_keys.map do |val_attr, val|
+        is_multiple = val.is_a?(HashValidator::Validations::Multiple)
+        if (is_multiple && val.validations.include?("boolean")) || (val.is_a?(String) && val == "boolean")
+          boolean_attrs << val_attr
+          [val_attr, val]
+        elsif is_multiple && val.validations.include?("unique")
+          # if unique key present, then remove that entry
+          # (since its not from HashValidator standard) and keep its history
+          unique_attrs[val_attr] ||= []
+          # we have to make a new object to remove the unique entry,
+          # because deleting it directly from the original object
+          # (val) would result into deleting the verification forever
+          new_val = HashValidator::Validations::Multiple.new(val.validations.reject { |v| v == "unique" })
+          # return the value
+          val.validations.blank? ? nil : [val_attr, new_val]
+        elsif val.is_a?(String) && val == "unique"
+          # same as above but substring
+          unique_attrs[val_attr] ||= []
+          nil
+        else
+          [val_attr, val]
+        end
+      end.compact.to_h
+
+    @validations = validations
+    @unique_attrs = unique_attrs
+    @boolean_attrs = boolean_attrs
+  end
+end

data/lib/hashy_validator/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 module HashyValidator
-    module Version
-      MAJOR = 0
-      MINOR = 1
-      PATCH = 2
-      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
-    end
-  end
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 5
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/lib/hashy_validator.rb

@@ -1,4 +1,7 @@
-require 'active_record'
-require 'hash_validator'
-require_relative './hashy_validator/hashy_value_validator'
-require_relative './hashy_validator/hashy_array_validator'
+# frozen_string_literal: true
+
+require "active_record"
+require "hash_validator"
+require_relative "hashy_validator/hashy_value_validator"
+require_relative "hashy_validator/hashy_array_validator"
+require_relative "hashy_validator/hashy_object_validator"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashy_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Flecto Team
@@ -17,9 +17,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 7.2.0
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +27,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.0.0
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 7.2.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: hash_validator
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,48 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.17.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.59'
+- !ruby/object:Gem::Dependency
+  name: rubocop-shopify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +156,7 @@ files:
 - hashy_validator.gemspec
 - lib/hashy_validator.rb
 - lib/hashy_validator/hashy_array_validator.rb
+- lib/hashy_validator/hashy_object_validator.rb
 - lib/hashy_validator/hashy_value_validator.rb
 - lib/hashy_validator/version.rb
 homepage: 
@@ -134,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Custom Active Model validator for validating arrays of hashes