st_validation 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d05c5f917d6f84aa0156cde50c68081d41d0fc8328723008785c6056e3a9bf4
-  data.tar.gz: bff39f336727f38a08f86f7ad8b282e9d610937cb4cb0ef564c302bef826abe5
+  metadata.gz: 187366e9fd5c511c575246ccfbc2034ca4e06479b9d29d9d0d462fb58fab4d45
+  data.tar.gz: 43691275ad1ebf833137919ac3096289129de3ea7da6eb06b750e0c9c1cffae2
 SHA512:
-  metadata.gz: '0768162330257a317bbbc80b75ebafabbf8282784ee4a81d39cf1556672856b4c977fffc77e0e207c6556e707961a6781e4c258c765f336ee4624a31d4737959'
-  data.tar.gz: 02e9b0e68e2ca20cb0a89a3f3e366dbd7c141bd33170331a1c4c7849df5101af9d10df32e475ed87f695065ec02ee9accb677a0231668c53a7419c41ec5e21d0
+  metadata.gz: f18f89aeea5ac68140c1f2c99ca1ea76201a9d8303688eb1318ca373abb2db116a1fc73cf70c29adc15ecdc0d2f0f2d81d3a989669397df701f66ae195e7450c
+  data.tar.gz: 1de6b46630ef92a01706d6e37d76f47f63a76f01b4a9540a3a4a99a7b13bd748d19fb37b5804abd8eeca8e9d38522840231c3012220004350158733aa2827062

data/.travis.yml

@@ -5,3 +5,6 @@ cache: bundler
 rvm:
   - 2.5.3
 before_install: gem install bundler -v 2.0.2
+script:
+  - bundle exec rake build
+  - bundle exec rake spec

data/README.org

@@ -1,5 +1,7 @@
 #+TITLE: St. Validation
 
+[[https://rubygems.org/gems/st_validation][https://badge.fury.io/rb/st_validation.svg]] [[https://travis-ci.org/Nondv/st_validation.rb][https://travis-ci.org/Nondv/st_validation.rb.svg?branch=master]]
+
 Incredibly simple and customisable validation DSL
 
 #+BEGIN_SRC ruby
@@ -37,6 +39,8 @@ is_valid_user.call(
       - [[#maybe-optional-values][Maybe (optional values)]]
   - [[#tinkering-dsl][Tinkering DSL]]
     - [[#important-note][Important note!]]
+  - [[#explain][explain]]
+  - [[#testing][Testing]]
 - [[#contributing][Contributing]]
 - [[#license][License]]
 
@@ -182,6 +186,45 @@ The process stops when no transformation changed the blueprint.
 
 Do *not* rely on order; it's not guarantueed.
 
+** explain
+
+For development purposes there's a =#explain= method defined in =StValidation::AbstractValidator=.
+The purpose of it is to show why a value didn't pass validation.
+
+For your custom validators you should implement =#generate_explanation(value)= method.
+
+#+BEGIN_SRC ruby
+validator = StValidation.build(
+  id: Integer,
+  email: String,
+)
+
+validator.explain(
+  id: '123',
+  email: 'user@example.com'
+)
+# ==> { id: 'Expected Integer got String' }
+#+END_SRC
+
+** Testing
+
+There's a rspec matcher:
+
+#+BEGIN_SRC ruby
+require 'st_validation/rspec'
+
+RSpec.describe 'user hash' do
+  it 'matches schema' do
+    user = build_user_hash
+    expect(user).to pass_st_validation(
+      id: Integer,
+      name: String,
+      age: Set[NilClass, Integer]
+    )
+  end
+end
+
+#+END_SRC
 
 * Contributing
 

data/lib/st_validation/abstract_validator.rb

@@ -1,11 +1,23 @@
 module StValidation
   class AbstractValidator
-    def call
+    def call(_value)
       raise 'implement this'
     end
 
     def to_proc
       ->(x) { call(x) }
     end
+
+    def explain(value)
+      generate_explanation(value)
+    rescue StandardError => error
+      "#explain failed with #{error.class}: #{error.message}"
+    end
+
+    private
+
+    def generate_explanation(_value)
+      raise "#{self.class}#generate_explanation is not implemented"
+    end
   end
 end

data/lib/st_validation/rspec.rb

@@ -0,0 +1,21 @@
+require 'pp'
+require 'rspec/expectations'
+
+RSpec::Matchers.define :pass_st_validation do |validator|
+  unless validator.is_a?(StValidation::AbstractValidator)
+    validator = StValidation.build(validator)
+  end
+
+  match do |actual|
+    validator.call(actual)
+  end
+
+  failure_message do |actual|
+    output = PP.pp(validator.explain(actual), '')
+    "value didn't pass St. Validation. #explain output:\n#{output}"
+  end
+
+  failure_message_when_negated do |_actual|
+    "value wasn't supposed pass St. Validation"
+  end
+end

data/lib/st_validation/validator_factory.rb

@@ -1,5 +1,25 @@
+require_relative 'abstract_validator'
+
 module StValidation
   class ValidatorFactory
+    class ProcValidatorWrapper < AbstractValidator
+      def initialize(proc_object)
+        @proc_object = proc_object
+      end
+
+      def call(value)
+        @proc_object.call(value)
+      end
+
+      private
+
+      def generate_explanation(value)
+        return nil if call(value)
+
+        @proc_object.source_location
+      end
+    end
+
     attr_reader :transformations
 
     def initialize(transformations = [])
@@ -13,8 +33,9 @@ module StValidation
         result = transformations.reduce(result) { |res, t| t.call(res, self) }
         break if result == old
       end
+      result = ProcValidatorWrapper.new(result) if result.is_a?(Proc)
 
-      raise InvalidBlueprintError unless result.is_a?(Proc) || result.is_a?(AbstractValidator)
+      raise InvalidBlueprintError unless result.is_a?(AbstractValidator)
 
       result
     end

data/lib/st_validation/validators/array_validator.rb

@@ -12,6 +12,14 @@ module StValidation
 
         value.all?(&@validator)
       end
+
+      private
+
+      def generate_explanation(value)
+        return 'not an array' unless value.is_a?(Array)
+
+        value.map { |e| @validator.explain(e) }
+      end
     end
   end
 end

data/lib/st_validation/validators/class_validator.rb

@@ -10,6 +10,14 @@ module StValidation
       def call(value)
         value.is_a?(@klass)
       end
+
+      private
+
+      def generate_explanation(value)
+        return nil if call(value)
+
+        "expected #{@klass} got #{value.class}"
+      end
     end
   end
 end

data/lib/st_validation/validators/hash_validator.rb

@@ -8,8 +8,7 @@ module StValidation
       end
 
       def call(value)
-        return false unless value.is_a?(Hash) &&
-                            (value.keys - validators.keys).empty?
+        return false unless value.is_a?(Hash) && extra_keys(value).empty?
 
         validators.each { |k, v| return false unless v.call(value[k]) }
         true
@@ -18,6 +17,22 @@ module StValidation
       private
 
       attr_reader :validators
+
+      def generate_explanation(value)
+        return 'not a hash' unless value.is_a?(Hash)
+
+        result = validators
+                 .reduce({}) { |a, (k, v)| a.merge(k => v.explain(value[k])) }
+                 .compact
+
+        extra_keys(value).each { |k| result[k] = 'extra key detected' }
+
+        result.empty? ? nil : result
+      end
+
+      def extra_keys(hash)
+        hash.keys - validators.keys
+      end
     end
   end
 end

data/lib/st_validation/validators/union_validator.rb

@@ -16,6 +16,12 @@ module StValidation
       def call(value)
         @validators.any? { |v| v.call(value) }
       end
+
+      private
+
+      def generate_explanation(value)
+        @validators.map { |v| v.explain(value) }
+      end
     end
   end
 end

data/lib/st_validation/version.rb

@@ -1,3 +1,3 @@
 module StValidation
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: st_validation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dmitry Non
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-07 00:00:00.000000000 Z
+date: 2019-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - lib/st_validation.rb
 - lib/st_validation/abstract_validator.rb
 - lib/st_validation/errors.rb
+- lib/st_validation/rspec.rb
 - lib/st_validation/validator_factory.rb
 - lib/st_validation/validators/array_validator.rb
 - lib/st_validation/validators/class_validator.rb