ruby-livr 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 43a065b27ff89d4be35e4ee14ced13cf49da7cba
-  data.tar.gz: c92bd4fab2be4a2d5439446de2a1a17830414a10
+SHA256:
+  metadata.gz: f6657ac44abc483ea73c0cdd20e26300ef34bdf9dde0e8e65ca6bd90428b2401
+  data.tar.gz: a0fb5076c7de93858bfcd224f25981d6e23d04b96f27c85df8b91b8c0e7f96b2
 SHA512:
-  metadata.gz: be28f102a0c2e5f1448496904264d1837bc591c4070bf2cf505368397c3433debfa58c9c6ef904ce783193ad4ed333056a822c7e53d9933997cb6e2098234989
-  data.tar.gz: 715d4b10d9282d7c80a78cc4eb5bcca8f9a43812258de02f3f7e427ee373f08cfc68c03fe7e823a122a0c50ba898d81614bfb8021c75d8cfbbd109c1c99862ff
+  metadata.gz: 6fea4e70535d7de501da828e551d4d247764cdaec995f4f7e23dfab4191ac026151eee4672ae570bab6a399278af4da8363f2099d5eede23cc4e40dfbd5c7cf1
+  data.tar.gz: 84b829178bc3f29fd8e7e2fd47e2ba85c173a34a33667d2782b86170ba6b128ed4ed377342752a0157dde3b925cc720e6a6bc51e2782bf47801fb3aac0d391df

data/.github/workflows/test.yml

@@ -0,0 +1,23 @@
+name: test
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    # ubuntu-24.04, not ubuntu-latest: setup-ruby has no Ruby 2.7-3.1 builds for ubuntu-26.04
+    runs-on: ubuntu-24.04
+    # head is the next Ruby in development: its failures are early warnings, not a broken build
+    continue-on-error: ${{ matrix.ruby == 'head' }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.7', '3.0', '3.1', '3.2', '3.3', '3.4', '4.0', 'head']
+    steps:
+      - uses: actions/checkout@v7
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - run: bundle exec rspec

data/.gitignore

@@ -1,2 +1,3 @@
 .ruby-version
 *.gem
+Gemfile.lock

data/Readme.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/fuksito/ruby-livr.svg?branch=master)](https://travis-ci.org/fuksito/ruby-livr)
+[![test](https://github.com/fuksito/ruby-livr/actions/workflows/test.yml/badge.svg)](https://github.com/fuksito/ruby-livr/actions/workflows/test.yml)
 
 # LIVR Validator
 LIVR.Validator - Lightweight validator supporting Language Independent Validation Rules Specification (LIVR)
@@ -41,7 +41,7 @@ validator = LIVR::Validator.new({
 
 Feel free to register your own rules:
 
-You can use aliases(prefferable, syntax covered by the specification) for a lot of cases:
+You can use aliases (prefferable, syntax covered by the specification) for a lot of cases:
 
 ```ruby
 validator = LIVR::Validator.new({

data/lib/livr/aliased_rule.rb

@@ -6,20 +6,26 @@ module LIVR
       raise "Alias rules required" unless _alias["rules"].present?
 
       @alias = _alias
-      @validator = Validator.new(value: Array.wrap(@alias["rules"]))
     end
 
+    # A rule for every use: each one gets the rules of the validator that uses it
     def new(*args)
-      self
+      dup
+    end
+
+    def rule_builders=(rule_builders)
+      @validator = Validator.new(value: Array.wrap(@alias["rules"])).register_rules(rule_builders).prepare
     end
 
     def call(value, user_data, field_results)
-      result = @validator.validate({ value: value })
+      self.rule_builders = {} unless @validator # built outside of a validator: default rules only
+      # A missing value stays missing, unless the rules change it
+      result = @validator.validate(value.nil? ? {} : { value: value })
       if result
-        field_results << result[:value]
+        field_results << result[:value] if result.has_key?(:value)
         return
       else
-        return @alias.fetch("error", @validator.get_errors)
+        return @alias["error"] || @validator.get_errors[:value]
       end
     end
   end

data/lib/livr/rule.rb

@@ -17,5 +17,18 @@ module LIVR
     def is_no_value(value)
       value == nil || value == ""
     end
+
+    # Base 10: Integer() alone reads "010" as an octal and "0x10" as a hexadecimal number.
+    # No underscores: Integer() and Float() read "1_000" as 1000, like a Ruby literal.
+    def to_integer(value)
+      return if value.to_s.include?("_")
+      Integer(value.to_s, 10) rescue nil
+    end
+
+    # Integers stay integers: "10" is 10, "1.5" is 1.5
+    def to_number(value)
+      return if value.to_s.include?("_")
+      to_integer(value) || (Float(value.to_s) rescue nil)
+    end
   end
 end

data/lib/livr/rules/common.rb

@@ -4,8 +4,7 @@ module LIVR
 
       class Required < Rule
         def call(value, user_data, field_results)
-          return if value.in?([[], {}])
-          "REQUIRED" if value.blank?
+          "REQUIRED" if is_no_value(value)
         end
       end
 

data/lib/livr/rules/meta.rb

@@ -4,10 +4,15 @@ module LIVR
 
       class NestedObject < Rule
         def initialize(livr)
-          @validator = Validator.new(livr).prepare
+          @livr = livr
+        end
+
+        def rule_builders=(rule_builders)
+          @validator = Validator.new(@livr).register_rules(rule_builders).prepare
         end
 
         def call(nested_object, user_data, field_results)
+          self.rule_builders = {} unless @validator # built outside of a validator: default rules only
           return if is_no_value(nested_object)
           return 'FORMAT_ERROR' unless nested_object.is_a?(Hash)
 
@@ -25,13 +30,18 @@ module LIVR
       class VariableObject < Rule
         def initialize(selector_field, livrs)
           @selector_field = selector_field
+          @livrs = livrs
+        end
+
+        def rule_builders=(rule_builders)
           @validators = {}
-          livrs.each do |selector_value, livr|
-            @validators[selector_value] = Validator.new(livr).prepare
+          @livrs.each do |selector_value, livr|
+            @validators[selector_value] = Validator.new(livr).register_rules(rule_builders).prepare
           end
         end
 
         def call(object, user_data, field_results)
+          self.rule_builders = {} unless @validators # built outside of a validator: default rules only
           return if is_no_value(object)
           if ( !object.is_a?(Hash) || !object[@selector_field] || !@validators[ object[@selector_field] ] )
             return 'FORMAT_ERROR'
@@ -51,11 +61,15 @@ module LIVR
 
       class ListOf < Rule
         def initialize(*rules)
-          livr = { field: rules.flatten }
-          @validator = Validator.new(livr).prepare
+          @livr = { field: rules.flatten }
+        end
+
+        def rule_builders=(rule_builders)
+          @validator = Validator.new(@livr).register_rules(rule_builders).prepare
         end
 
         def call(values, user_data, field_results)
+          self.rule_builders = {} unless @validator # built outside of a validator: default rules only
           return if is_no_value(values)
           return 'FORMAT_ERROR' unless values.is_a?(Array)
 
@@ -87,10 +101,15 @@ module LIVR
 
       class ListOfObjects < Rule
         def initialize(livr)
-          @validator = Validator.new(livr).prepare
+          @livr = livr
+        end
+
+        def rule_builders=(rule_builders)
+          @validator = Validator.new(@livr).register_rules(rule_builders).prepare
         end
 
         def call(objects, user_data, field_results)
+          self.rule_builders = {} unless @validator # built outside of a validator: default rules only
           return if is_no_value(objects)
           return 'FORMAT_ERROR' unless objects.is_a?(Array)
 
@@ -124,13 +143,18 @@ module LIVR
       class ListOfDifferentObjects < Rule
         def initialize(selector_field, livrs)
           @selector_field = selector_field
+          @livrs = livrs
+        end
+
+        def rule_builders=(rule_builders)
           @validators = {}
-          livrs.each do |selector_value, livr|
-            @validators[selector_value] = Validator.new(livr).prepare
+          @livrs.each do |selector_value, livr|
+            @validators[selector_value] = Validator.new(livr).register_rules(rule_builders).prepare
           end
         end
 
         def call(objects, user_data, field_results)
+          self.rule_builders = {} unless @validators # built outside of a validator: default rules only
           return if is_no_value(objects)
           return 'FORMAT_ERROR' unless objects.is_a?(Array)
 
@@ -140,6 +164,7 @@ module LIVR
 
           objects.each do |object|
             if !object.is_a?(Hash) || !object[@selector_field] || !@validators[ object[@selector_field] ]
+              has_errors = true
               errors << 'FORMAT_ERROR'
               next
             end
@@ -170,20 +195,26 @@ module LIVR
       class Or < Rule
         def initialize(*rule_sets)
           @rule_sets = rule_sets
+        end
+
+        def rule_builders=(rule_builders)
           @validators = @rule_sets.map do |rules|
             livr = { field: rules }
-            Validator.new(livr).prepare
+            Validator.new(livr).register_rules(rule_builders).prepare
           end
         end
 
         def call(value, user_data, field_results)
-          return if is_no_value(value)
+          self.rule_builders = {} unless @validators # built outside of a validator: default rules only
+          # Empty and missing values go to the rule sets too ("required" can be one of them).
+          # A missing value stays missing, unless a rule set changes it.
+          input = value.nil? ? {} : { field: value }
 
           last_error = nil
           @validators.each do |validator|
-            result = validator.validate(field: value)
+            result = validator.validate(input)
             if result
-              field_results << result[:field]
+              field_results << result[:field] if result.has_key?(:field)
               return nil
             else
               last_error = validator.get_errors[:field]

data/lib/livr/rules/modifiers.rb

@@ -16,24 +16,24 @@ module LIVR
 
       class Trim < Rule
         def call(value, user_data, field_results)
-          return if is_no_value(value) || value.is_a?(Hash)
-          field_results << value.to_s.mb_chars.strip
+          return if is_no_value(value) || value.is_a?(Hash) || value.is_a?(Array)
+          field_results << value.to_s.strip
           return
         end
       end
 
       class ToLc < Rule
         def call(value, user_data, field_results)
-          return if is_no_value(value) || value.is_a?(Hash)
-          field_results << value.to_s.mb_chars.downcase
+          return if is_no_value(value) || value.is_a?(Hash) || value.is_a?(Array)
+          field_results << value.to_s.downcase
           return
         end
       end
 
       class ToUc < Rule
         def call(value, user_data, field_results)
-          return if is_no_value(value) || value.is_a?(Hash)
-          field_results << value.to_s.mb_chars.upcase
+          return if is_no_value(value) || value.is_a?(Hash) || value.is_a?(Array)
+          field_results << value.to_s.upcase
           return
         end
       end
@@ -45,8 +45,8 @@ module LIVR
         end
 
         def call(value, user_data, field_results)
-          return if is_no_value(value) || value.is_a?(Hash)
-          field_results << value.to_s.mb_chars.gsub(@re, '')
+          return if is_no_value(value) || value.is_a?(Hash) || value.is_a?(Array)
+          field_results << value.to_s.gsub(@re, '')
           return
         end
       end
@@ -58,8 +58,8 @@ module LIVR
         end
 
         def call(value, user_data, field_results)
-          return if is_no_value(value) || value.is_a?(Hash)
-          field_results << value.to_s.mb_chars.gsub(@re, '')
+          return if is_no_value(value) || value.is_a?(Hash) || value.is_a?(Array)
+          field_results << value.to_s.gsub(@re, '')
           return
         end
       end

data/lib/livr/rules/numeric.rb

@@ -7,7 +7,7 @@ module LIVR
           return if is_no_value(value)
           return 'FORMAT_ERROR' if !is_primitive(value)
 
-          value_int = Integer(value.to_s) rescue nil
+          value_int = to_integer(value)
           if value_int.nil?
             return "NOT_INTEGER"
           end
@@ -23,7 +23,7 @@ module LIVR
           return if is_no_value(value)
           return 'FORMAT_ERROR' if !is_primitive(value)
 
-          value_int = Integer(value.to_s) rescue nil
+          value_int = to_integer(value)
 
           return "NOT_POSITIVE_INTEGER" if value_int.nil?
           return "NOT_POSITIVE_INTEGER" unless value_int.positive?
@@ -70,7 +70,7 @@ module LIVR
           return if is_no_value(value)
           return 'FORMAT_ERROR' if !is_primitive(value)
 
-          value = Float(value.to_s) rescue nil
+          value = to_number(value)
           if value.nil?
             return "NOT_NUMBER"
           end
@@ -93,7 +93,7 @@ module LIVR
           return if is_no_value(value)
           return 'FORMAT_ERROR' if !is_primitive(value)
 
-          value = Float(value.to_s) rescue nil
+          value = to_number(value)
           if value.nil?
             return "NOT_NUMBER"
           end
@@ -117,7 +117,7 @@ module LIVR
           return if is_no_value(value)
           return 'FORMAT_ERROR' if !is_primitive(value)
 
-          value = Float(value.to_s) rescue nil
+          value = to_number(value)
           if value.nil?
             return "NOT_NUMBER"
           end

data/lib/livr/rules/special.rb

@@ -3,15 +3,15 @@ module LIVR
     module Special
 
       class Email < Rule
+        # The same expression as in the reference implementation: one "@" only and no "_" in the domain.
+        # [:space:] is Unicode-aware, like \s in JavaScript. \A and \z, not ^ and $: they match at line breaks.
+        EMAIL_RE = /\A(?:[^<>()\[\]\\.,;:[:space:]@"]+(?:\.[^<>()\[\]\\.,;:[:space:]@"]+)*|"[^@\n\r\u2028\u2029]+")@(?:\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\]|(?:[a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,})\z/
+
         def call(value, user_data, field_results)
           return if is_no_value(value)
           return 'FORMAT_ERROR' if !is_primitive(value)
 
-          value = value.to_s
-          email_re = /^([\w\-_+]+(?:\.[\w\-_+]+)*)@((?:[\w\-]+\.)*\w[\w\-]{0,66})\.([a-z]{2,6}(?:\.[a-z]{2})?)$/i
-          return "WRONG_EMAIL" unless email_re.match(value)
-          return "WRONG_EMAIL" if  /\@.*\@/.match(value)
-          return "WRONG_EMAIL" if /\@.*_/.match(value)
+          return "WRONG_EMAIL" unless EMAIL_RE.match(value.to_s)
           return
         end
       end
@@ -25,12 +25,15 @@ module LIVR
           return if is_no_value(value)
           return 'FORMAT_ERROR' if !is_primitive(value)
 
-          return "FIELDS_NOT_EQUAL" if value != user_data[@field]
+          # Compared as strings: "10" and 10 are equal. A missing field is not equal to any value.
+          other_value = user_data[@field]
+          return "FIELDS_NOT_EQUAL" unless is_primitive(other_value) && value.to_s == other_value.to_s
         end
       end
 
       class Url < Rule
-        URL_RE_STR = '^(?:(?:http|https)://)(?:\\S+(?::\\S*)?@)?(?:(?:(?:[1-9]\\d?|1\\d\\d|2[0-1]\\d|22[0-3])(?:\\.(?:1?\\d{1,2}|2[0-4]\\d|25[0-5])){2}(?:\\.(?:[0-9]\\d?|1\\d\\d|2[0-4]\\d|25[0-4]))|(?:(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)(?:\\.(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)*(?:\\.(?:[a-z\\u00a1-\\uffff]{2,})))\\.?|localhost)(?::\\d{2,5})?(?:[/?#]\\S*)?$'
+        # \A and \z, not ^ and $: they match at line breaks in Ruby.
+        URL_RE_STR = '\\A(?:(?:http|https)://)(?:\\S+(?::\\S*)?@)?(?:(?:(?:[1-9]\\d?|1\\d\\d|2[0-1]\\d|22[0-3])(?:\\.(?:1?\\d{1,2}|2[0-4]\\d|25[0-5])){2}(?:\\.(?:[0-9]\\d?|1\\d\\d|2[0-4]\\d|25[0-4]))|(?:(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)(?:\\.(?:[a-z\\u00a1-\\uffff0-9]-*)*[a-z\\u00a1-\\uffff0-9]+)*(?:\\.(?:[a-z\\u00a1-\\uffff]{2,})))\\.?|localhost)(?::\\d{2,5})?(?:[/?#]\\S*)?\\z'
         URL_RE =  Regexp.compile(URL_RE_STR, "i")
         MAX_URL_LENGTH = 2083
 
@@ -38,7 +41,7 @@ module LIVR
           return if is_no_value(value)
           return 'FORMAT_ERROR' if !is_primitive(value)
 
-          if value.length < MAX_URL_LENGTH && URL_RE.match(value)
+          if value.to_s.length < MAX_URL_LENGTH && URL_RE.match(value.to_s)
             return
           else
             'WRONG_URL'
@@ -51,7 +54,9 @@ module LIVR
           return if is_no_value(value)
           return 'FORMAT_ERROR' if !is_primitive(value)
 
-          return "WRONG_DATE" unless value.length == "YYYY-MM-DD".length
+          value = value.to_s
+          # Date.strptime alone accepts "2020-01-1x" and "+020-01-01"
+          return "WRONG_DATE" unless value =~ /\A\d{4}-\d{2}-\d{2}\z/
 
           date = Date.strptime(value, '%Y-%m-%d') rescue nil
           unless date

data/lib/livr/validator.rb

@@ -3,7 +3,7 @@ module LIVR
     def initialize(rules, is_auto_trim=false)
       @rules = rules
       @is_prepared = false
-      @validator_builders = {}
+      @validator_builders = {}.with_indifferent_access
       @validators = {}
       @is_auto_trim = is_auto_trim
 
@@ -110,7 +110,12 @@ module LIVR
       if @validator_builders[name].blank?
         raise "Rule ['#{name}'] not registered"
       end
-      @validator_builders[name].new(*args)
+      validator = @validator_builders[name].new(*args)
+
+      # Meta rules and aliases validate with validators of their own. They get the rules
+      # of this validator, so that aliases and custom rules can be used inside them.
+      validator.rule_builders = @validator_builders if validator.respond_to?(:rule_builders=)
+      validator
     end
 
     private

data/lib/livr.rb

@@ -1,5 +1,7 @@
 require 'json'
 require 'date'
+# activesupport 6.x uses Logger without loading it, which fails with concurrent-ruby 1.3.5 and later
+require 'logger'
 require 'active_support/all'
 
 require_relative "livr/validator.rb"

data/ruby-livr.gemspec

@@ -1,7 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = "ruby-livr"
-  gem.version     = "2.0.0"
-  gem.date        = "2017-12-22"
+  gem.version     = "2.1.0"
   gem.summary     = "Implementation of LIVR v2.0"
   gem.description = "Language Independent Validation Rules. Implements 2.0 specification"
   gem.authors     = ["Vitaliy Yanchuk"]
@@ -14,6 +13,8 @@ Gem::Specification.new do |gem|
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "activesupport", '~> 5'
-  gem.add_development_dependency "rspec", "3.7"
+  gem.required_ruby_version = ">= 2.7"
+
+  gem.add_dependency "activesupport", '>= 5', '< 9'
+  gem.add_development_dependency "rspec", "~> 3.7"
 end

data/spec/01-test_suite_spec.rb

@@ -5,9 +5,13 @@ def read_file(dir, filename)
   JSON.parse(data)
 end
 
+def read_aliases(dir)
+  dir.join("aliases.json").exist? ? read_file(dir, "aliases") : []
+end
+
 RSpec.describe "test_suite " do
 
-  %w[ positive negative ].each do |spec_dir|
+  %w[ positive negative aliases_positive aliases_negative ].each do |spec_dir|
     context spec_dir do
       dirs = Pathname.new("#{SPEC_ROOT}/test_suite/#{spec_dir}").children.select(&:directory?)
       dirs.each do |dir|
@@ -16,10 +20,11 @@ RSpec.describe "test_suite " do
           input = read_file(dir, "input")
 
           validator = LIVR::Validator.new(rules)
+          read_aliases(dir).each { |_alias| validator.register_aliased_rule(_alias) }
           result = validator.validate(input)
           errors = validator.get_errors
 
-          if spec_dir == 'positive'
+          if spec_dir.end_with?('positive')
             expected_result = read_file(dir, "output")
             expect(result).to eq(expected_result)
           else

data/spec/02-aliases_spec.rb

@@ -18,4 +18,33 @@ RSpec.describe "aliases" do
     expect(validator.get_errors).to eq({"password" => "WEAK_PASSWORD"})
   end
 
-end
+  it "Validates with aliases and custom rules inside meta rules" do
+    weak_password = Class.new(LIVR::Rule) do
+      def call(value, user_data, field_results)
+        "WEAK_PASSWORD" if value.to_s.length < 6
+      end
+    end
+
+    validator = LIVR::Validator.new({
+      "user"      => "user",
+      "passwords" => { "list_of" => "weak_password" }
+    })
+    validator.register_aliased_rule({
+      "name"  => "user",
+      "rules" => { "nested_object" => { "age" => "adult_age" } }
+    })
+    validator.register_aliased_rule({
+      "name"  => "adult_age",
+      "rules" => [ "positive_integer", { "min_number" => 18 } ]
+    })
+    validator.register_rules("weak_password" => weak_password)
+
+    output = validator.validate({ "user" => { "age" => 10 }, "passwords" => [ "abc", "abcdefg" ] })
+    expect(output).to eq(false)
+    expect(validator.get_errors).to eq({
+      "user"      => { "age" => "TOO_LOW" },
+      "passwords" => [ "WEAK_PASSWORD", nil ]
+    })
+  end
+
+end

data/spec/04-custom_filters_spec.rb

@@ -50,5 +50,16 @@ RSpec.describe "custom_filters" do
                         )
   end
 
-end
+  it 'Validate data with rules registered with symbol names' do
+    validator = LIVR::Validator.new(
+      "word1" => ['my_trim2'],
+      "word2" => [{ my_trim2: [] }]
+    )
+    validator.register_rules(my_trim2: MyTrim)
+
+    output = validator.validate("word1" => ' wordOne ', "word2" => ' wordTwo ')
 
+    expect(output).to eq("word1" => 'wordOne', "word2" => 'wordTwo')
+  end
+
+end