Skip to content

Commit

Permalink
Little improvements, improved Hash and Array validation (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
ahoshaiyan committed Jan 16, 2024
1 parent 712d2dc commit 3cee772
Show file tree
Hide file tree
Showing 14 changed files with 455,098 additions and 25 deletions.
8 changes: 3 additions & 5 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# frozen_string_literal: true

source "https://rubygems.org"
source 'https://rubygems.org'

# Specify your gem's dependencies in mini_defender.gemspec
gemspec

gem "rake", "~> 13.0"

gem "minitest", "~> 5.0"
gem 'rake', '~> 13.0'
gem 'minitest', '~> 5.0'
15 changes: 13 additions & 2 deletions lib/mini_defender/extensions/hash.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,21 @@ class Hash
def expand
expanded = {}

reject{ |_, v| v.is_a?(Hash) || v.is_a?(Array) }.each do |k, v|
each do |k, v|
keys = k.split('.')
node = expanded
node = (node[keys.shift] ||= {}) while keys.length > 1

while keys.length > 1
next_key = keys.shift
next_node = (node[next_key] ||= {})

if next_node.is_a?(Array)
node[next_key] = next_node = next_node.each_with_index.to_h { |value, index| [index.to_s, value] }
end

node = next_node
end

node[keys.shift] = v
end

Expand Down
6 changes: 6 additions & 0 deletions lib/mini_defender/rule.rb
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,12 @@ def coerce(value)
value
end

# This method is used to change the value
# regardless if coercion is required
def force_coerce?
false
end

# @param [Object] attribute
# @param [Object] value
# @param [MiniDefender::Validator] validator
Expand Down
16 changes: 16 additions & 0 deletions lib/mini_defender/rules/array.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@ def self.signature
'array'
end

def initialize(data_mode = 'none')
@data_mode = data_mode
end

def self.make(args)
new(args[0] || 'none')
end

def coerce(value)
@data_mode == 'all' ? value : []
end

def force_coerce?
true
end

def passes?(attribute, value, validator)
value.is_a?(Array)
end
Expand Down
2 changes: 1 addition & 1 deletion lib/mini_defender/rules/currency.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frozen_string_literal: true

require 'countries'
require 'money'

class MiniDefender::Rules::Currency < MiniDefender::Rule
CURRENCIES = Money::Currency.map(&:iso_code).map(&:upcase).uniq
Expand Down
53 changes: 51 additions & 2 deletions lib/mini_defender/rules/hash.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,60 @@ def self.signature
'hash'
end

def initialize(data_mode = 'none', key_type = 'any', value_type = 'any')
@data_mode = data_mode
@key_type = key_type
@value_type = value_type
end

def self.make(args)
new(
args[0] || 'none',
args[1] || 'any',
args[2] || 'any',
)
end

def coerce(value)
@data_mode == 'all' ? value : {}
end

def force_coerce?
true
end

def passes?(attribute, value, validator)
value.is_a?(Hash)
passes = value.is_a?(Hash)

if @key_type == 'string'
passes &= value.all? { |k, _| k.is_a?(String) }
end

case @value_type
when 'string'
passes &= value.all? { |_, v| v.is_a?(String) }
when 'integer'
passes &= value.all? { |_, v| v.is_a?(Integer) }
when 'float'
passes &= value.all? { |_, v| v.is_a?(Float) }
else
# None
end

passes
end

def message(attribute, value, validator)
"The field must be an object."
additional = ''

if @key_type != 'any'
additional += ", key must be #{@key_type}"
end

if @value_type != 'any'
additional += ", value must be #{@value_type}"
end

"The field must be an object#{additional}."
end
end
25 changes: 17 additions & 8 deletions lib/mini_defender/rules_expander.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,23 @@ class RulesExpander
# @param [Hash] flat_data
# @return [Hash]
def expand(rules, flat_data)
rules
.map { |k, v| [Regexp.compile('\A' + k.gsub(/\*/, '\d+') + '\Z'), v] }.to_h
.map { |p, set|
data_rules = flat_data.filter { |k, _| p.match? k }.map { |k, _| [k, set] }
data_rules.length > 0 ? data_rules : [[p.source.gsub(/\\[AZ]/, '').gsub('\d+', '0'), set]]
}
.flatten(1)
.to_h
result = {}

rules.each do |rule_key, rule_set|
unless rule_key.include?('*')
result[rule_key] = rule_set
next
end

k_pattern = Regexp.compile('\A' + rule_key.gsub(/\*/, '\d+') + '\Z')

flat_data.each do |value_key, _|
next unless k_pattern.match?(value_key)
result[value_key] = rule_set
end
end

result
end
end
end
10 changes: 9 additions & 1 deletion lib/mini_defender/validator.rb
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ def validate
[k, @factory.init_set(set)]
end

# Set default values for missing data key compared to rules
data_rules.each do |k, set|
if !@data.key?(k) || @data[k].blank?
set.filter{ |r| r.defaults?(self) }.each do |r|
Expand Down Expand Up @@ -51,18 +52,25 @@ def validate
end

value = coerced = @data[k]
force_coerce = false

rule_set.each do |rule|
next unless rule.active?(self)

value_included &= !rule.excluded?(self)

if rule.passes?(k, coerced, self)
if rule.passes?(k, value, self)
coerced = rule.coerce(coerced)
force_coerce = rule.force_coerce?
else
@errors[k] << rule.error_message(k, value, self)
end
end

if force_coerce
value = coerced
end

if @errors[k].empty? && value_included
@validated[k] = value
@coerced[k] = coerced
Expand Down
2 changes: 1 addition & 1 deletion lib/mini_defender/version.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# frozen_string_literal: true

module MiniDefender
VERSION = "0.4.1"
VERSION = "0.5.0"
end
2 changes: 0 additions & 2 deletions mini_defender.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ Gem::Specification.new do |spec|
spec.license = "MIT"
spec.required_ruby_version = ">= 2.6.0"

# spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"

spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = spec.homepage

Expand Down
Loading

0 comments on commit 3cee772

Please sign in to comment.