mini_defender 0.1.0

data/lib/mini_defender/rules_factory.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module MiniDefender
+  class RulesFactory
+    def self.blueprints
+      @@blueprints ||= []
+    end
+
+    def self.register(klass)
+      blueprints << klass
+    end
+
+    def init_set(rule_set)
+      rule_set = rule_set.split('|') if rule_set.is_a?(String)
+      raise ArgumentError, 'Rule set must be a string or an array' unless rule_set.is_a?(Array)
+
+      rule_set.map do |rule|
+        unless rule.is_a?(String) || rule.is_a?(Rule)
+          raise ArgumentError, 'Rule must be a string or an instance of MiniDefender::Rule'
+        end
+
+        rule.is_a?(String) ? init_rule(rule) : rule
+      end
+    end
+
+    def init_rule(signature)
+      @blueprints ||= RulesFactory.blueprints
+
+      signature = signature.split(':')
+      blueprint = @blueprints.find { |b| b.available? && b.signature == signature[0] }
+      raise ArgumentError, "The rule name #{signature[0]} is invalid or not available" if blueprint.nil?
+
+      blueprint.make(signature[1..].join(':').split(','))
+    end
+  end
+end

data/lib/mini_defender/validates_input.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module MiniDefender::ValidatesInput
+  extend ActiveSupport::Concern
+
+  def validate!(rules, coerced = false)
+    data = params.to_unsafe_hash.deep_stringify_keys
+    validator = MiniDefender::Validator.new(rules, data)
+    validator.validate!
+    coerced ? validator.coerced : validator.data
+  end
+end

data/lib/mini_defender/validation_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class MiniDefender::ValidationError < StandardError
+  attr_reader :errors
+
+  def initialize(msg, errors = {})
+    super(msg)
+    @errors = errors
+  end
+end

data/lib/mini_defender/validator.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module MiniDefender
+  class Validator
+    attr_reader :rules, :data, :errors
+
+    def initialize(rules, data)
+      @rules = rules
+      @data = data.flatten_keys(keep_roots: true)
+      @errors = nil
+      @validated = {}
+      @coerced = {}
+      @expander = RulesExpander.new
+      @factory = RulesFactory.new
+    end
+
+    def validate
+      return unless @errors.nil?
+
+      @errors = {}
+
+      data_rules = @rules.to_h do |k, set|
+        [k, @factory.init_set(set)]
+      end
+
+      data_rules.each do |k, set|
+        if !@data.key?(k) || @data[k].blank?
+          set.filter{ |r| r.defaults?(self) }.each do |r|
+            @data.merge!({k => r.default_value(self)}.flatten_keys(keep_roots: true))
+          end
+        end
+      end
+
+      data_rules = @expander.expand(data_rules, @data)
+
+      data_rules.each do |k, rule_set|
+        @errors[k] = []
+
+        value_included = true
+        required = rule_set.any? { |r| r.implicit?(self) }
+
+        if !@data.key?(k) || @data[k].blank?
+          rule_set.filter{ |r| r.defaults?(self) }.each do |r|
+            @data.merge!({k => r.default_value(self)}.flatten_keys(keep_roots: true))
+          end
+        end
+
+        unless @data.key?(k)
+          @errors[k] << 'The field is missing' if required
+          next
+        end
+
+        value = @data[k]
+        rule_set.each do |rule|
+          next unless rule.active?(self)
+
+          value_included &= !rule.excluded?(self)
+
+          unless rule.passes?(k, value, self)
+            @errors[k] << rule.message(k, value, self)
+          end
+        end
+
+        if @errors[k].empty? && value_included
+          @validated[k] = value
+          @coerced[k] = rule_set.inject(value) { |coerced, rule| rule.coerce(coerced) }
+        end
+      end
+
+      @validated = @validated.expand
+      @coerced = @coerced.expand
+
+      @errors.reject! { |_, v| v.empty? }
+    end
+
+    def validate!
+      validate if @errors.nil?
+      raise ValidationError.new('Data validation failed', @errors) unless @errors.empty?
+    end
+
+    def passes?
+      validate if @errors.nil?
+      @errors.empty?
+    end
+
+    def fails?
+      !passes?
+    end
+
+    def validated
+      validate! if @errors.nil?
+      @validated
+    end
+
+    def coerced
+      validate! if @errors.nil?
+      @coerced
+    end
+
+    # @return [Hash]
+    def neighbors(key, level = 1)
+      pattern = leveled_search_pattern(key, level)
+      @data.filter { |k, _| k.match?(pattern) }
+    end
+
+    # @return [Array]
+    def neighbor_values(key, level = 1)
+      neighbors(key, level).values
+    end
+
+    private
+
+    def leveled_search_pattern(key, level = 1)
+      search_key = key.split('.').map{ |part| Regexp.quote(part) }.reverse
+
+      # Change array indexes to digits pattern according to the desired level
+      while level > 0
+        target_index = search_key.index { |p| p.match?(/\A\d+\z/) }
+        break if target_index.nil?
+        search_key[target_index] = '\d+'
+        level -= 1
+      end
+
+      Regexp.compile("\\A#{search_key.reverse.join('\.')}\\z")
+    end
+  end
+end

data/lib/mini_defender/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MiniDefender
+  VERSION = "0.1.0"
+end

data/lib/mini_defender.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative 'mini_defender/version'
+require_relative 'mini_defender/validator'
+require_relative 'mini_defender/rule'
+require_relative 'mini_defender/rules'
+require_relative 'mini_defender/rules_expander'
+require_relative 'mini_defender/rules_factory'
+require_relative 'mini_defender/validation_error'
+require_relative 'mini_defender/validates_input'
+
+# Extensions to Ruby Core
+require_relative 'mini_defender/extensions/enumerable'
+require_relative 'mini_defender/extensions/hash'
+
+module MiniDefender
+end
+
+# Register Library Rules
+MiniDefender::Rules.constants
+  .map    { |id| MiniDefender::Rules.const_get(id) }
+  .filter { |const| const.ancestors.include?(MiniDefender::Rule) }
+  .filter { |const| const.available? }
+  .each   { |klass| MiniDefender::RulesFactory.register(klass) }

data/mini_defender.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/mini_defender/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "mini_defender"
+  spec.version = MiniDefender::VERSION
+  spec.authors = ["Ali Alhoshaiyan"]
+  spec.email = ["ahoshaiyan@fastmail.com"]
+
+  spec.summary = "A small and efficient validation library for Rails and anything that uses Ruby."
+  spec.description = spec.summary
+  spec.homepage = "https://mini.ahoshaiyan.com"
+  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"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'activesupport', '>= 6.0'
+  spec.add_runtime_dependency 'activemodel', '>= 6.0'
+  spec.add_runtime_dependency 'actionpack', '>= 6.0'
+  spec.add_runtime_dependency 'countries'
+end

data/sig/mini_defender.rbs

@@ -0,0 +1,4 @@
+module MiniDefender
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: mini_defender
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ali Alhoshaiyan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: countries
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A small and efficient validation library for Rails and anything that
+  uses Ruby.
+email:
+- ahoshaiyan@fastmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- LICENSE.txt
+- README.md
+- RULES.md
+- Rakefile
+- lib/mini_defender.rb
+- lib/mini_defender/extensions/enumerable.rb
+- lib/mini_defender/extensions/hash.rb
+- lib/mini_defender/rule.rb
+- lib/mini_defender/rules.rb
+- lib/mini_defender/rules/accepted.rb
+- lib/mini_defender/rules/accepted_if.rb
+- lib/mini_defender/rules/alpha.rb
+- lib/mini_defender/rules/alpha_dash.rb
+- lib/mini_defender/rules/alpha_num.rb
+- lib/mini_defender/rules/array.rb
+- lib/mini_defender/rules/bail.rb
+- lib/mini_defender/rules/between.rb
+- lib/mini_defender/rules/boolean.rb
+- lib/mini_defender/rules/confirmed.rb
+- lib/mini_defender/rules/country_code.rb
+- lib/mini_defender/rules/credit_card.rb
+- lib/mini_defender/rules/date.rb
+- lib/mini_defender/rules/date_eq.rb
+- lib/mini_defender/rules/date_format.rb
+- lib/mini_defender/rules/date_gt.rb
+- lib/mini_defender/rules/date_gte.rb
+- lib/mini_defender/rules/date_lt.rb
+- lib/mini_defender/rules/date_lte.rb
+- lib/mini_defender/rules/declined.rb
+- lib/mini_defender/rules/declined_if.rb
+- lib/mini_defender/rules/default.rb
+- lib/mini_defender/rules/different.rb
+- lib/mini_defender/rules/digits.rb
+- lib/mini_defender/rules/digits_between.rb
+- lib/mini_defender/rules/distinct.rb
+- lib/mini_defender/rules/email.rb
+- lib/mini_defender/rules/ending_with.rb
+- lib/mini_defender/rules/equal.rb
+- lib/mini_defender/rules/excluded.rb
+- lib/mini_defender/rules/excluded_if.rb
+- lib/mini_defender/rules/excluded_unless.rb
+- lib/mini_defender/rules/excluded_with.rb
+- lib/mini_defender/rules/excluded_without.rb
+- lib/mini_defender/rules/exists.rb
+- lib/mini_defender/rules/expiry_date.rb
+- lib/mini_defender/rules/file.rb
+- lib/mini_defender/rules/filled.rb
+- lib/mini_defender/rules/greater_than.rb
+- lib/mini_defender/rules/greater_than_or_equal.rb
+- lib/mini_defender/rules/hash.rb
+- lib/mini_defender/rules/image.rb
+- lib/mini_defender/rules/in.rb
+- lib/mini_defender/rules/in_field.rb
+- lib/mini_defender/rules/integer.rb
+- lib/mini_defender/rules/ip.rb
+- lib/mini_defender/rules/ipv4.rb
+- lib/mini_defender/rules/ipv6.rb
+- lib/mini_defender/rules/json.rb
+- lib/mini_defender/rules/less_than.rb
+- lib/mini_defender/rules/less_than_or_equal.rb
+- lib/mini_defender/rules/luhn.rb
+- lib/mini_defender/rules/mac_address.rb
+- lib/mini_defender/rules/max.rb
+- lib/mini_defender/rules/max_digits.rb
+- lib/mini_defender/rules/mime_types.rb
+- lib/mini_defender/rules/min.rb
+- lib/mini_defender/rules/min_digits.rb
+- lib/mini_defender/rules/national_id.rb
+- lib/mini_defender/rules/not_ending_with.rb
+- lib/mini_defender/rules/not_in.rb
+- lib/mini_defender/rules/not_regex.rb
+- lib/mini_defender/rules/not_starting_with.rb
+- lib/mini_defender/rules/numeric.rb
+- lib/mini_defender/rules/present.rb
+- lib/mini_defender/rules/prohibited.rb
+- lib/mini_defender/rules/prohibited_if.rb
+- lib/mini_defender/rules/prohibited_unless.rb
+- lib/mini_defender/rules/regex.rb
+- lib/mini_defender/rules/required.rb
+- lib/mini_defender/rules/required_if.rb
+- lib/mini_defender/rules/required_unless.rb
+- lib/mini_defender/rules/required_with.rb
+- lib/mini_defender/rules/required_with_all.rb
+- lib/mini_defender/rules/required_without.rb
+- lib/mini_defender/rules/required_without_all.rb
+- lib/mini_defender/rules/size.rb
+- lib/mini_defender/rules/starting_with.rb
+- lib/mini_defender/rules/string.rb
+- lib/mini_defender/rules/timezone.rb
+- lib/mini_defender/rules/unique.rb
+- lib/mini_defender/rules/url.rb
+- lib/mini_defender/rules/uuid.rb
+- lib/mini_defender/rules_expander.rb
+- lib/mini_defender/rules_factory.rb
+- lib/mini_defender/validates_input.rb
+- lib/mini_defender/validation_error.rb
+- lib/mini_defender/validator.rb
+- lib/mini_defender/version.rb
+- mini_defender.gemspec
+- sig/mini_defender.rbs
+homepage: https://mini.ahoshaiyan.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://mini.ahoshaiyan.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A small and efficient validation library for Rails and anything that uses
+  Ruby.
+test_files: []