hv 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ce070297444b94651fa7b6123b493acc5711fff
-  data.tar.gz: 1d560767fb9fad4d9e92743ad1a5d8fd8e0f3808
+  metadata.gz: 382af5e307f795cc879af3a04448005e158c1411
+  data.tar.gz: ed1fb6de9cbc9484422611da80b6b596d7e33492
 SHA512:
-  metadata.gz: d821845aba2b7d75ad702f4020b080443cdf29822f772a51d9b529200186ad2b9146e6d89d69e5683c8285bf3ef88f0e7e0dc002657c5605cbfc04e7ba85e429
-  data.tar.gz: 70dff345ce9442850dde2fbfa3d6b67b5056cfebd7db73fa5f5a3f6a89140511c2e7de17495fd86f49f926457f88667a61ef838f99637f54e694642213936223
+  metadata.gz: 72147820be7345306117a71fa16213366899af3400e6da653719c2b482ef85452c1ab3b20443b2bc46ef68079f854af0664e03fff4b328450df1120390aaa5d3
+  data.tar.gz: b91bb0731afe3ce6df264aa2f3ea67315883980768f839435fdb93d911b45f3789bcfae7f92a0452df10bf558928d7db5e45f6a78e332c6cae2c4f14beda4da2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hv (0.1.0)
+    hv (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -32,6 +32,74 @@ schema = Schema.new(schema)
 schema.validates?({people: [{name: "juan"}, {name: "chus"}]}) # => true
 ```
 
+Another example with custom validators and error processing
+
+```ruby
+
+ module MyAwesomeErrorProcessor
+
+    def self.call(result, i18n_errors_hash)
+        result.map do |path, validator, spec, given|
+        path_text = path.empty? ? "" : " in #{path}"
+        i18n_errors_hash[validator] % {path: path_text, validator: validator, spec: spec, given: given.inspect}
+        end
+    end
+
+end
+
+module I18nErrors
+
+    def self.translations
+        keys = {
+        type?: "Expected %{given} to be a %{spec}",
+        accept_if_underage: "You must accept if you're under 18"
+        }
+        keys.default = "Expected %{given}%{path} to be %{validator}:%{spec}"
+        keys
+    end
+
+end
+
+
+signUpForm = Hv::Schema.new do
+
+    # set_schema: set the schema structure.
+    set_schema ({
+        name: {type?: String},
+        # Custom validator :email?
+        email: {email?: true},
+        age: {type?: Integer},
+        accept_underage: {types?: [TrueClass, FalseClass]}
+    })
+
+    # set_error_processor: accepts is an object that respond to call(result, i18n), it could be a block
+    set_error_processor MyAwesomeErrorProcessor
+
+    # set_i18n_errors: accepts a hash with validators names as keys
+    set_i18n_errors I18nErrors.translations
+
+    # validator: define a new validator key
+    validator :email? do |spec, value, path|
+        is_email = validate_type?(String, value, path) &&
+                    validate_format?(/\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i, value, path)
+        !(is_email ^ spec)
+    end
+
+    # validate: define a custom validation block. You must add_error() if validation doesn't match.
+    validate :accept_if_underage do |input|
+        if (!input[:accept_underage] && input[:age] < 18)
+        add_error([:accept_underage], :accept_if_underage, true, input[:accept_underage])
+        end
+    end
+
+end
+
+signUpForm.validates?({name: "Jhon", email: "jhon@me.com", age: 15, accept_underage: false})
+# => false
+signUpForm.errors
+# => ["You must accept if you're under 18"]
+```
+
 Check 'test' folder for more validators examples.
 
 

data/Rakefile

@@ -8,3 +8,7 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task :default => :test
+
+task :benchmark do
+  puts `bundle exec ruby benchmarks/validate_input.rb`
+end

data/lib/hv/errors_processor.rb

@@ -1,9 +1,18 @@
 module Hv
   module ErrorsProcessor
-    def self.call(result)
+
+    def self.i18n_errors
+      keys = {
+        type?: "Expected %{given} to be a %{spec}"
+      }
+      keys.default = "Expected %{given}%{path} to be %{validator}:%{spec}"
+      keys
+    end
+
+    def self.call(result, i18n_errors_hash)
       result.map do |path, validator, spec, given|
         path_text = path.empty? ? "" : " in #{path}"
-        "Expected #{given.inspect}#{path_text} to be #{validator}:#{spec}"
+        i18n_errors_hash[validator] % {path: path_text, validator: validator, spec: spec, given: given.inspect}
       end
     end
   end

data/lib/hv/schema.rb

@@ -1,36 +1,79 @@
 module Hv
   class Schema
 
-    def initialize(schema)
+    def initialize(schema={}, &block)
       @schema = schema
+      @custom_validators = {}
+      @custom_validators_keys = []
+      @errors_processor = Hv::ErrorsProcessor
+      @i18n_errors = Hv::ErrorsProcessor.i18n_errors
+      self.instance_eval(&block) if block_given?
     end
 
     def result
       @result
     end
 
+    def set_schema(schema)
+      @schema = schema
+    end
+
     def validates?(input)
+      @skip_paths = []
       @result = []
       validate_schema(@schema, input, [])
+      run_custom_validators(input)
+      @result.empty?
+    end
+
+    def errors(errors_processor=nil, i18n_errors=nil)
+      i18n_errors = i18n_errors || @i18n_errors
+      errors_processor = errors_processor || @errors_processor
+      errors_processor.call(@result, i18n_errors)
     end
 
-    def errors(errors_processor=Hv::ErrorsProcessor)
-      errors_processor.call(@result)
+    def validate(custom_validator_name, &block)
+      @custom_validators[custom_validator_name] = block
+    end
+
+    def validator(key, &block)
+      @custom_validators_keys << key
+      define_singleton_method "validate_#{key}", block
+    end
+
+    def set_error_processor(error_processor)
+      @errors_processor = error_processor
+    end
+
+    def set_i18n_errors(hash)
+      @i18n_errors = hash
     end
 
     private
 
     def validator_key?(key)
       allowed_validators.include?(key) ||
-      custom_validators.include?(key)
+      @custom_validators_keys.include?(key)
     end
 
     def allowed_validators
       [:optional?, :format?, :min_size?, :max_size?, :size?, :lt?, :gt?, :types?, :type?, :enum?, :proc?, :array?, :empty?]
     end
 
-    def custom_validators
-      []
+    def parent_is_optional?(path)
+      @skip_paths.any? { |parent_path|
+        (parent_path - path).empty?
+      }
+    end
+
+    def run_custom_validators(input)
+      @custom_validators.each do |name, blk|
+        blk.call(input)
+      end
+    end
+
+    def add_error(path, key, _spec, value)
+      @result << [path, key, _spec, value]
     end
 
     def validate_schema(spec, value, path=nil)
@@ -40,19 +83,24 @@ module Hv
           validate_schema(_spec, _value, [path, key].flatten)
         else
           match = if value.nil? && optional_attr?(path)
+            @skip_paths << path
             true
           else
             next if key == :optional?
-            method("validate_#{key}").call(_spec, value, path)
+            next if parent_is_optional?(path)
+            send("validate_#{key}",_spec, value, path)
           end
-          @result << [path, key, _spec, value] unless match
+          add_error(path, key, _spec, value) unless match
         end
       end
-      @result.empty?
     end
 
-    def optional_attr?(path)
-      (@schema.dig(*path) || {})[:optional?]
+    def optional_attr?(path=[])
+      if path.empty?
+        @schema[:optional?]
+      else
+        (@schema.dig(*path) || {})[:optional?]
+      end
     end
 
     def validate_enum?(spec, value, path)

data/lib/hv/version.rb

@@ -1,3 +1,3 @@
 module Hv
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hv
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Monkey Square Lab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-07 00:00:00.000000000 Z
+date: 2018-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ files:
 - lib/hv/schema.rb
 - lib/hv/version.rb
 - releases/hv-0.1.0.gem
+- releases/hv-0.1.1.gem
 homepage: https://github.com/monkeysquarelab/hv
 licenses:
 - MIT