livr 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a59ab4f18e3a1db2fe7ed7b6e5365ed63544ca90
+  data.tar.gz: 63b213075c97a72ed0875e04bd5fe53cc8d026e7
+SHA512:
+  metadata.gz: b712d0fdfb811ded2d7c09fd9c84f171b1df2113a814d3f5256dc96e8dfa93d9400ff19c67a6ff3326a215d304dbba5a7531a39afc0ab7af516fa0ad50ea47b9
+  data.tar.gz: 1431c58c4d85d3e795b7f03adec4b306acc5f8af85ded780f9fb1de517f8637e5141638c47c6acaf025ccbc9e87124870ad4113c7c30edb4f591084365ddf800

data/.travis.yml

@@ -0,0 +1,6 @@
+script: 'rake test'
+rvm:
+  - 2.2
+  - 2.1
+  - 2.0.0
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,240 @@
+[![Build Status](https://travis-ci.org/maktwin/ruby-validator-livr.svg?branch=master)](https://travis-ci.org/maktwin/ruby-validator-livr)
+
+# NAME
+LIVR - Lightweight validator supporting Language Independent Validation Rules Specification (LIVR)
+
+# SYNOPSIS
+Common usage:
+
+    require 'LIVR'
+    LIVR.default_auto_trim('is_auto_trim')
+
+    validator = LIVR.new({
+      'name'      => 'required',
+      'email'     => [ 'required', 'email' ],
+      'gender'    => { 'one_of' => ['male', 'female'] },
+      'phone'     => { 'max_length' => 10 },
+      'password'  => [ 'required', {'min_length' => 10} ],
+      'password2' => { 'equal_to_field' => 'password' }
+    })
+
+    valid_data = validator.validate(user_data)
+
+    if valid_data
+      save_user(valid_data)
+    else
+      errors = validator.get_errors
+    end
+
+
+You can use filters separately or can combine them with validation:
+
+    validator = LIVR.new({
+      'email' => [ 'required', 'trim', 'email', 'to_lc' ]
+    })
+
+Feel free to register your own rules:
+
+You can use aliases(prefferable, syntax covered by the specification) for a lot of cases:
+
+    validator = LIVR.new({
+      'password' => ['required', 'strong_password']
+    })
+
+    validator.register_aliased_rule({ 
+      'name'  => 'strong_password',
+      'rules' => {'min_length' => 6},
+      'error' => 'WEAK_PASSWORD'
+    })
+
+Or you can write more sophisticated rules directly:
+
+    validator = LIVR.new({
+      'password' => ['required', 'strong_password']
+    })
+
+    validator.register_rules({
+      'strong_password' => lambda do |args|
+        lambda do |value, params, output|
+          return if value.nil? or value.eql?('')
+          return 'WEAK_PASSWORD' if value.to_s.length < 6
+        end
+      end
+    })
+
+# DESCRIPTION
+See ['LIVR Specification'](http://livr-spec.org) for detailed documentation and list of supported rules.
+
+Features:
+
+ * Rules are declarative and language independent
+ * Any number of rules for each field
+ * Return together errors for all fields
+ * Excludes all fields that do not have validation rules described
+ * Has possibility to validatate complex hierarchical structures
+ * Easy to describe and undersand rules
+ * Returns understandable error codes(not error messages)
+ * Easy to add own rules
+ * Rules are be able to change results output ("trim", "nested\_object", for example)
+ * Multipurpose (user input validation, configs validation, contracts programming etc)
+
+# INSTALL
+
+Install LIVR from RubyGems using gem::
+
+    gem install livr
+
+# CLASS METHODS
+
+## LIVR.new(livr, is_auto_trim)
+Contructor creates validator objects.
+livr - validations rules. Rules description is available here - https://github.com/koorchik/LIVR
+
+is_auto_trim - asks validator to trim all values before validation. Output will be also trimmed.
+if is_auto_trim is nil than default_auto_trim value will be used.
+
+## LIVR.register_aliased_default_rule(alias)
+alias - is a hash that contains: name, rules, error (optional).
+
+    LIVR.register_aliased_default_rule({
+      'name'  => 'valid_address',
+      'rules' => { 'nested_object' => {
+        'country' => 'required',
+        'city' => 'required',
+        'zip' => 'positive_integer'
+      }}
+    })
+
+Then you can use "valid\_address" for validation:
+
+    {
+      'address' => 'valid_address'
+    }
+
+
+You can register aliases with own errors: 
+
+    LIVR.register_aliased_default_rule({
+      'name' => 'adult_age',
+      'rules' => [ 'positive_integer', { 'min_number' => 18 } ],
+      'error' => 'WRONG_AGE'
+    })
+
+All rules/aliases for the validator are equal. The validator does not distinguish "required", "list\_of\_different\_objects" and "trim" rules. So, you can extend validator with any rules/alias you like.
+
+## LIVR.register_default_rules({"rule\_name" => rule_builder })
+rule_builder - is a lambda function which will be called for building single rule validator.
+
+    LIVR.register_default_rules({
+      'my_rule' => lambda do |args|
+        rule_builders = args.pop
+        # rule_builders - are rules from original validator
+        # to allow you create new validator with all supported rules
+        # validator = LIVR.new(livr).register_rules(rule_builders).prepare
+    
+        lambda do |value, params, output|
+          return "SOME_ERROR_CODE" if notValid
+        end
+      end
+    })
+
+Then you can use "my\_rule" for validation:
+    
+    {
+      'name1' => 'my_rule', # Call without parameters
+      'name2' => { 'my_rule': arg1 }, # Call with one parameter.
+      'name3' => { 'my_rule': [arg1] }, # Call with one parameter.
+      'name4' => { 'my_rule': [ arg1, arg2, arg3 ] } # Call with many parameters.
+    }
+
+Here is "max\_number" implemenation:
+
+    max_number = lambda do |args|
+      max_number = args.shift
+      lambda do |value, params, output|
+        # We do not validate empty fields. We have "required" rule for this purpose
+        return if value.nil? or value.eql?('')
+        # return error message
+        return 'TOO_HIGH' if value.to_f > max_number
+      end
+    end
+    LIVR.register_default_rules({'max_number' => max_number})
+
+All rules for the validator are equal. The validator does not distinguish "required", "list\_of\_different\_objects" and "trim" rules. So, you can extend validator with any rules you like.
+
+## LIVR.get_default_rules
+returns object containing all default rule_builders for the validator. You can register new rule or update existing one with "register_rules" method.
+
+## LIVR.default_auto_trim(is_auto_trim)
+Enables or disables automatic trim for input data. If is on then every new validator instance will have auto trim option enabled
+
+
+# OBJECT METHODS
+
+## validator.validate(input)
+Validates user input. On success returns valid_data (contains only data that has described validation rules). On error return false.
+
+    my valid_data = validator.validate(input)
+
+    if valid_data
+      # use valid_data
+    else
+      errors = validator.get_errors
+    end
+
+## validator.get_errors
+Returns errors object.
+
+   {
+      "field1" => "ERROR_CODE",
+      "field2" => "ERROR_CODE",
+        ...
+    }
+
+For example:
+
+    {
+      "country"  => "NOT_ALLOWED_VALUE",
+      "zip"      => "NOT_POSITIVE_INTEGER",
+      "street"   => "REQUIRED",
+      "building" => "NOT_POSITIVE_INTEGER"
+    }
+
+## validator.register_rules({"rule_name": rule_builder})
+
+rule_builder - is a lambda function which will be called for building single rule validator.
+
+See "LIVR.register_default_rules" for rules examples.
+
+## validator.register_aliased_rule(alias)
+
+alias - is a composite validation rule. 
+
+See "LIVR.register_aliased_default_rule" for rules examples.
+
+## validator.get_rules
+returns object containing all rule_builders for the validator. You can register new rule or update existing one with "register_rules" method.
+
+# AUTHOR
+koorchik (Viktor Turskyi), maktwin (Maksym Panchokha)
+
+# BUGS
+Please report any bugs or feature requests to Github https://github.com/maktwin/ruby-validator-livr
+
+# LICENSE AND COPYRIGHT
+
+Copyright 2012 Viktor Turskyi.
+
+This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:
+
+http://www.perlfoundation.org/artistic_license_2_0
+
+Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.
+
+If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.
+
+This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
+
+This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
+
+Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = Dir['test/*.rb'].select { |file| file =~ /\d{2}\-test./ }
+end
+
+desc "Run tests"
+task :default => :test

data/lib/LIVR.rb

@@ -0,0 +1,221 @@
+require "LIVR/Rules/Common"
+require "LIVR/Rules/Filters"
+require "LIVR/Rules/Numerics"
+require "LIVR/Rules/Strings"
+require "LIVR/Rules/Special"
+require "LIVR/Rules/Helpers"
+
+class LIVR
+  @@IS_DEFAULT_AUTO_TRIM = false
+  @@DEFAULT_RULES = {
+    'required'                  => Common.method(:required),
+    'not_empty'                 => Common.method(:not_empty),
+    'not_empty_list'            => Common.method(:not_empty_list),
+
+    'trim'                      => Filters.method(:trim),
+    'to_lc'                     => Filters.method(:to_lc),
+    'to_uc'                     => Filters.method(:to_uc),
+    'remove'                    => Filters.method(:remove),
+    'leave_only'                => Filters.method(:leave_only),
+
+    'integer'                   => Numerics.method(:integers),
+    'positive_integer'          => Numerics.method(:positive_integer),
+    'decimal'                   => Numerics.method(:decimal),
+    'positive_decimal'          => Numerics.method(:positive_decimal),
+    'max_number'                => Numerics.method(:max_number),
+    'min_number'                => Numerics.method(:min_number),
+    'number_between'            => Numerics.method(:number_between),
+
+    'one_of'                    => Strings.method(:one_of),
+    'max_length'                => Strings.method(:max_length),
+    'min_length'                => Strings.method(:min_length),
+    'length_equal'              => Strings.method(:length_equal),
+    'length_between'            => Strings.method(:length_between),
+    'like'                      => Strings.method(:like),
+
+    'email'                     => Special.method(:email),
+    'url'                       => Special.method(:url),
+    'iso_date'                  => Special.method(:iso_date),
+    'equal_to_field'            => Special.method(:equal_to_field),
+
+    'nested_object'             => Helpers.method(:nested_object),
+    'list_of'                   => Helpers.method(:list_of),
+    'list_of_objects'           => Helpers.method(:list_of_objects),
+    'list_of_different_objects' => Helpers.method(:list_of_different_objects)
+  }
+
+  def initialize(livr_rules, is_auto_trim = false)
+    @is_prepare = false
+    @livr_rules = livr_rules
+    @validators = {}
+    @errors       = false
+    @validator_builders = {}
+
+    if is_auto_trim
+      @is_auto_trim = is_auto_trim
+    else
+      @is_auto_trim = @@IS_DEFAULT_AUTO_TRIM
+    end
+    register_rules(@@DEFAULT_RULES)
+    self
+  end
+
+  def register_rules(rules)
+    rules.each do |rule_name, rule_builder|
+      raise "RULE_BUILDER [%s] SHOULD BE A CODEREF" % rule_name unless rule_builder.respond_to? :call
+      @validator_builders[rule_name] = rule_builder
+    end
+    self
+  end
+
+  def register_aliased_rule(alias_hash)
+    raise 'Alias name required' if alias_hash['name'].nil?
+    @validator_builders[alias_hash['name']] = self.class._build_aliased_rule(alias_hash)
+    self
+  end
+
+  def self.register_default_rules(rules)
+    rules.each do |rule_name, rule_builder|
+      raise "RULE_BUILDER [%s] SHOULD BE A CODEREF" % rule_name unless rule_builder.respond_to? :call
+      @@DEFAULT_RULES[rule_name] = rule_builder
+    end
+    self
+  end
+
+  def self.register_aliased_default_rule(alias_hash)
+    raise 'Alias name required' if alias_hash['name'].nil?
+    @@DEFAULT_RULES[alias_hash['name']] = _build_aliased_rule(alias_hash)
+    self
+  end
+
+  def self.default_auto_trim(is_auto_trim)
+    @@IS_DEFAULT_AUTO_TRIM = !!is_auto_trim
+  end
+
+  def prepare
+    return unless @is_prepare == false
+
+    @livr_rules.each do |field, field_rules|
+      field_rules = [field_rules] unless field_rules.kind_of? Array
+      validators = []
+
+      field_rules.each do |rule|
+        name, args = _parse_rule(rule)
+        validators.push(_build_validator(name, args))
+      end
+      @validators[field] = validators
+    end
+
+    @is_prepare = true
+    self
+  end
+
+  def _parse_rule(livr_rule)
+    if livr_rule.kind_of? Hash
+      name = livr_rule.keys[0]
+      args = livr_rule[name]
+      args = [args] unless args.kind_of? Array
+    else
+      name = livr_rule
+      args = []
+    end
+
+    [name, args]
+  end
+
+  def _build_validator(name, args)
+    raise "Rule [%s] not registered" % [name] unless @validator_builders.has_key?(name)
+
+    allArgs = args
+    allArgs.push(get_rules)
+    @validator_builders[name].call(allArgs)
+  end
+
+  def self._build_aliased_rule(alias_hash)
+    raise 'Alias name required'  if alias_hash['name'].nil?
+    raise 'Alias rules required' if alias_hash['rules'].nil?
+
+    livr = {:value => alias_hash['rules']}
+    lambda do |args|
+      rule_builders = args.pop
+      validator = LIVR.new(livr).register_rules(rule_builders).prepare
+      lambda do |value, unuse, output|
+        result = validator.validate({:value => value})
+        if result
+          output.push(result[:value])
+          return
+        else
+          validator_errors = validator.get_errors
+          return alias_hash['error'] || validator_errors[:value]
+        end
+      end
+    end
+  end
+
+  def validate(data)
+    prepare unless @is_prepare
+    unless data.kind_of? Hash
+      @errors = 'FORMAT_ERROR'
+      return
+    end
+
+    data = _auto_trim(data) if @is_auto_trim
+    result, errors = {}, {}
+    @validators.each do |field_name, validators|
+      next if validators.empty?
+      field_result = []
+      value = data.has_key?(field_name) ? data[field_name] : nil
+      validators.each do |v_cb|
+        arg = result.has_key?(field_name) ? result[field_name] : value
+        error_code = v_cb.call(arg, data, field_result)
+        if error_code
+          errors[field_name] = error_code
+          break
+        elsif data.has_key?(field_name)
+          result[field_name] = field_result.empty? ? value : field_result[0]
+        end
+      end
+    end
+
+    if errors.empty?
+      @errors = nil
+      return result
+    else
+      @errors = errors
+      return false
+    end
+  end
+
+  def get_rules
+    @validator_builders
+  end
+
+  def get_errors
+    @errors
+  end
+
+  def self.get_default_rules
+    @@DEFAULT_RULES
+  end
+
+  def _auto_trim(data)
+    if data.kind_of? String
+      data.strip!
+      return data
+    elsif data.kind_of? Hash
+      trimmed_data = {}
+      data.each do |key, value|
+        trimmed_data[key] = _auto_trim(value)
+      end
+      return trimmed_data
+    elsif data.kind_of? Array
+      trimmed_data = []
+      data.each do |value|
+        trimmed_data << _auto_trim(value)
+      end
+      return trimmed_data
+    end
+
+    return data
+  end
+end