hashy_validator 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9dd65790f50202be82f7f2c267651b6b06c129a95da0dc0aa60fff5e5b34b9d
-  data.tar.gz: 431fc62400f0153ebde529bc5c9b257b4fe6fd6a030136ccc3cba46c237a1821
+  metadata.gz: bb2d96afac20d3a5de238c5909ba7001ebfabdbbb790ea9b0ead248853018005
+  data.tar.gz: 299cb764bb7dfcd2bc69ef07cd791d8b76726b69eb0f7a12a0f28c7b1d71d55f
 SHA512:
-  metadata.gz: b162ee8865567d7029043f2812ef1c6ecb851c024fb65dcef09220a43825acee3ba79fbd04e1733c4312df84fe8a468531438707aa65fe646bf6155df012e4a2
-  data.tar.gz: 1b5d3941d9e5b19052c0aa6ec5250576a93bf8d87e538ab6de2f94f5faed9f28a301bc42afefa471654277d508d414f2db165d40396f85ec2504936ea7653cb2
+  metadata.gz: 6d27b7aa8aae40311a1526fd5fd70c38f962e646d5a73618295f24b874e29cca0d76661111dfbeb7fccf86ccbc5e199201ac0ef4dea5293d0e8838ea2615f401
+  data.tar.gz: 6a2c04d418e28ad116b0d70b2b6d31c58bd0ffff4aa9aaf9e1f3648f8cacbcc4556a90894bb835a7da4b6430d20b42a1e84a9b4a51e64345e2cf4f0b971f76af

data/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Changelog
+
+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)
+
+
+### Bug Fixes
+
+* changelog ([6b8c151](https://www.github.com/flecto-io/hashy-validator/commit/6b8c15105bd085dafa6358f27f780ad4826a42e7))
+* organization ([abd87b7](https://www.github.com/flecto-io/hashy-validator/commit/abd87b7a04d092b87f0d400ac087261bfc4bd07e))
+
+### [0.1.1](https://www.github.com/flecto-io/hashy-validator/compare/v0.1.0...v0.1.1) (2024-01-11)
+
+### Bug Fixes
+
+* not initialized Class::HashValidator ([798ba63](https://www.github.com/flecto-io/hashy-validator/commit/798ba637885a4c9863351506b10d689a5f1c8a60))
+
+## 0.1.0 (2024-01-11)
+
+
+### Bug Fixes
+
+* Code Climate coverage reporter is not compatible ([8df1ec3](https://www.github.com/flecto-io/hashy-validator/commit/8df1ec308a940a8f84e01456e1f9d0851c15035b))
+* unique validation ([3c9a6dc](https://www.github.com/flecto-io/hashy-validator/commit/3c9a6dcc02d43cfb81103a52b3632d0d51c0329e))
+- Validation lib
+- Version module
+
+## [Unreleased]
+
+## Fixed
+
+- Class::HashValidator not initialized

data/README.md

@@ -0,0 +1,60 @@
+<div style="display: flex">
+  <a href="https://codeclimate.com/github/flecto-io/hashy-validator/maintainability"><img src="https://api.codeclimate.com/v1/badges/8818718c3f8ac08a1f05/maintainability" /></a>
+  <a href="https://codeclimate.com/github/flecto-io/hashy-validator/test_coverage"><img src="https://api.codeclimate.com/v1/badges/8818718c3f8ac08a1f05/test_coverage" /></a>
+</div>
+
+# HashyValidator
+
+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:
+
+```ruby
+gem 'hashy_validator'
+```
+
+<b>THIS GEM IS NOT READY FOR PRODUCTION YET!</b>
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install hashy_validator
+```
+
+## Usage
+
+To leverage HashyValidator in your Rails model, follow these steps:
+
+1. Add the gem to your Gemfile and run `bundle install` as mentioned above.
+
+2. In your model, use the `validate` method to apply the `hashy_array` validation.
+
+   ```ruby
+   class YourModel < ApplicationRecord
+     validates :pricing, hashy_array: {
+       minutes: HashValidator.multiple('required', 'integer', 'unique'),
+       price_cents: HashValidator.multiple('required', 'integer')
+     }
+   end
+   ```
+   
+   Customize each entry validators according to [HashValidator](https://github.com/jamesbrooks/hash_validator) criteria
+
+## 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.
+Before submitting a PR do not forget to run all tests by doing `rake test` or against a single file `ruby -I. test/validation_sqlite_test.rb`.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/hashy_validator.gemspec

@@ -0,0 +1,29 @@
+require_relative "lib/hashy_validator/version"
+
+Gem::Specification.new do |spec|
+    spec.name        = 'hashy_validator'
+    spec.version     = HashyValidator::Version::STRING
+    spec.date        = '2013-12-31'
+    spec.summary     = 'Custom Active Model validator for validating arrays of hashes'
+    spec.description = 'The hashy_validator gem provides the HashyArrayValidator, a custom Active Model validator designed to validate arrays of hashes within ActiveRecord model attributes. Utilizing the HashValidator gem, on top of hash_validator gem. The gem includes a comprehensive test suite using the minitest framework.'
+    spec.authors     = ['Flecto Team']
+    spec.email       = 'dev@flecto.io'
+
+    
+    spec.required_ruby_version = '>= 2.0.0'
+    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 "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'
+
+    if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("3")
+        spec.add_development_dependency 'minitest', '>= 5.15.0', '< 5.16'
+    else
+        spec.add_development_dependency 'minitest', '>= 5.15.0'
+    end
+end

data/lib/hashy_validator/hashy_array_validator.rb

@@ -0,0 +1,76 @@
+class HashyArrayValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    instance_value = HashyValueValidator.new(value)
+    unless instance_value.is_valid
+      record.errors.add(attribute, instance_value.reason)
+      return false
+    end
+
+    value = instance_value.value
+
+    # 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
+
+    # 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) }
+
+    # 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)
+      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])
+          record.errors.add(attribute, "'#{unique_attr}' not unique")
+        else
+          unique_attrs[unique_attr] << t[unique_attr]
+        end
+      end
+
+      # use default hash validator
+      validator = HashValidator.validate(t, validations)
+      unless validator.valid?
+        validator.errors.each { |k,v| record.errors.add(attribute, "'#{k.to_s}' #{v}") }
+      end
+    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
+
+  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_value_validator.rb

@@ -0,0 +1,42 @@
+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

data/lib/hashy_validator/version.rb

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

data/lib/hashy_validator.rb

@@ -0,0 +1,4 @@
+require 'active_record'
+require 'hash_validator'
+require_relative './hashy_validator/hashy_value_validator'
+require_relative './hashy_validator/hashy_array_validator'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashy_validator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Flecto Team
@@ -108,7 +108,14 @@ email: dev@flecto.io
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- CHANGELOG.md
+- README.md
+- hashy_validator.gemspec
+- lib/hashy_validator.rb
+- lib/hashy_validator/hashy_array_validator.rb
+- lib/hashy_validator/hashy_value_validator.rb
+- lib/hashy_validator/version.rb
 homepage: 
 licenses: []
 metadata: {}