valligator 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86beebd4198e35c0e7accf7e5ae49e8e100793f7
-  data.tar.gz: 3d1cf322859147e0c6e238cdc74b7d3a3a32f482
+  metadata.gz: b3d8ebc145692776bf7f9420a41868941aa287db
+  data.tar.gz: 300432e7de9d78593c799de84373b4921b9225e6
 SHA512:
-  metadata.gz: 46e30c31a694e91f20d1488b32b619b08cd0e2aad583f7a6c20cf97d77d245c5f7299f60eccfb972e3ead9a0bdff20377949eae2c15b181de7e998b017b39799
-  data.tar.gz: 8a794b107f51b596f1bb3de90c280e3d1170db81ee9188b54a434f004fac43744028cc0ffcb46cb3d6718dd2d0388acb6570baa687d3932ec51443c19da74338
+  metadata.gz: 7ecb1005fddd355b81c7730ea47ad75ba9b9342221626ed9c38c075d41f34c344b1fc8f377ebbd8657270a190af72d31faf75c96adceb368a122735d4746b1fb
+  data.tar.gz: f3de17e331ed5aaf1abfb1d3419133c11d22485106352d4d3cb8ea0f9349b8c214581c4e447b4d4bb33a2f0dffb6800a0be967b2d15ab7e8eb68334d7c53c74b

data/HISTORY.md

@@ -1,12 +1,23 @@
+#### 1.0.4
+  - Valligator::ValidationError.validation_stack returns the exact position in validation method chain where the validation fails
+  - **is_kind_of** got a new alias **is_an**
+  - **is_not_kind_of** got a new alias **is_not_an**
+  - all alias methods were replaced with ruby's built-in **alias_method**, so error messages will refer to the original  method name:
+      Example:
+        123.is_a(String)
+        # old behavior
+        Valligator::ValidationError: wrong number of arguments (0 for 1..Infinity) at `testee#1.is_a
+        # new behavior
+        Valligator::ValidationError: wrong number of arguments (0 for 1..Infinity) at `testee#1.is_kind_of
+
 #### 1.0.3
   - **is_instance_of** renamed to **is_kind_of**
   - **is_not_instance_of** renamed to **is_not_kind_of**
   - new helper method: Valligator::Helper#vh(Hash)
 
 #### 1.0.2
-  - **is_instance_of** got alias **is_a**
-  - **is_not_instance_of** got alias **is_not_a**
+  - **is_instance_of** got a new alias **is_a**
+  - **is_not_instance_of** got a new alias **is_not_a**
 
-#### 1.0.3
-  - **is_instance_of** renamed to **is_kind_of**
-  - **is_not_instance_of** renamed to **is_not_kind_of**
+#### 1.0.1
+  - couple bug fixes

data/README.md

@@ -46,7 +46,7 @@ The validations passes when testee responds to all (or none in negative case) th
 
 
 #### is_kind_of, is_not_kind_of
-Aliases: **is_a** and **is_not_a**.
+Aliases: **is_a**, **is_an** and **is_not_a**, **is_not_an**.
 
 ```
   testee.is_kind_of(*classes)
@@ -84,7 +84,7 @@ If it does not sound clear, then it is something like this:
   # is the same as:
 
   value = :foo.size
-  raise !!value.instance_eval { self == 10 }
+  raise if !value.instance_eval { self == 10 }
 ```
 
 I use _instance_eval_ so that the _value_ could be assessed as _self_, and one would not need to access it using standard block params definition: {|value| value == 10 }.
@@ -103,7 +103,7 @@ Each statement, if it does not fail, returns an instance of the Valligator, so t
 When validation fails a Valligator::ValidationError is raised.
 
 ```
-Valligator.new(:foo).is_empty? #=>
+Valligator.new(:foo).is(:empty?) #=>
     Valligator::ValidationError: `testee#1': method `empty?' returned falsy value
 ```
 
@@ -115,6 +115,19 @@ testee.is_a(String).has(:size){self > 10} #=>
   Valligator::ValidationError: `short': method `size' returned falsy value
 ```
 
+If there was a chain of validations, you can get the exact position of the one that failed:
+
+```
+testee = Valligator.new(:foo1)
+begin
+  # it should die on :boom
+  testee.is_kind_of(Symbol).asserts_not(:empty?).speaks(:boom).has(:to_s){ self == 'foo' }
+rescue => e
+  puts e.validation_stack  #=> "is_kind_of.asserts_not.speaks"
+end
+
+```
+
 ## Examples
 
 Validate that testee is an instance of String
@@ -132,7 +145,7 @@ Validate that all testees have size == 3 and start with 'b' and they are Strings
 ```
 testees = ['boo', 'bar', :baz]
 Valligator.new(*testees).has(:size){self == 3}.has(:[], 0){self == 'b'}.is_a(String) #=>
-  Valligator::ValidationError: `testee#3': should be Symbol
+  Valligator::ValidationError: `testee#3': should not be Symbol
 ```
 
 Validate that all hash values are Integers <= 2

data/VERSION

@@ -1 +1 @@
-1.0.3
+1.0.4

data/lib/valligator.rb

@@ -2,12 +2,20 @@ require 'pathname'
 require_relative 'valligator_helper'
 
 class Valligator
-  VERSION         = File.read(Pathname(__FILE__).dirname.join('../VERSION')).strip
+  VERSION  = File.read(Pathname(__FILE__).dirname.join('../VERSION')).strip
+  INFINITY = 1/0.0
+  Error    = Class.new(StandardError)
 
-  Error           = Class.new(StandardError)
-  ValidationError = Class.new(Error)
 
-  INFINITY = 1/0.0
+  class ValidationError < Error
+    attr_reader :validation_stack
+
+    def initialize(message, stack)
+      super(message)
+      @validation_stack = stack.join('.')
+    end
+  end
+
 
   attr_reader :testees
   attr_reader :names
@@ -78,7 +86,8 @@ class Valligator
   def is_kind_of(*classes)
     clone._is_kind_of(__method__, *classes)
   end
-
+  alias_method :is_a,  :is_kind_of
+  alias_method :is_an, :is_kind_of
 
   # Passes when the testee is not an instance of all of the classes
   #
@@ -95,20 +104,8 @@ class Valligator
   def is_not_kind_of(*classes)
     clone._is_kind_of(__method__, *classes)
   end
-
-
-  # Is an alias for {#is_kind_of} method
-  #
-  def is_a(*classes)
-    clone._is_kind_of(__method__, *classes)
-  end
-
-
-  # Is an alias for {#is_not_kind_of} method
-  #
-  def is_not_a(*classes)
-    clone._is_kind_of(__method__, *classes)
-  end
+  alias_method :is_not_a,  :is_not_kind_of
+  alias_method :is_not_an, :is_not_kind_of
 
 
   # Passes when the testee responds to all the methods
@@ -168,6 +165,8 @@ class Valligator
   def asserts(method, *args, &block)
     clone._asserts(__method__, method, *args, &block)
   end
+  alias_method :is,  :asserts
+  alias_method :has, :asserts
 
 
   # When no block given it passes if the testee, called with a given method and arguments, returns falsy value.
@@ -197,34 +196,8 @@ class Valligator
   def asserts_not(method, *args, &block)
     clone._asserts(__method__, method, *args, &block)
   end
-
-
-  # Is an alias for {#asserts} method
-  #
-  def is(method, *args, &block)
-    clone._asserts(__method__, method, *args, &block)
-  end
-
-
-  # Is an alias for {#asserts_not} method
-  #
-  def is_not(method, *args, &block)
-    clone._asserts(__method__, method, *args, &block)
-  end
-
-
-  # Is an alias for {#asserts} method
-  #
-  def has(method, *args, &block)
-    clone._asserts(__method__, method, *args, &block)
-  end
-
-
-  # Is an alias for {#asserts_not} method
-  #
-  def does_not_have(method, *args, &block)
-    clone._asserts(__method__, method, *args, &block)
-  end
+  alias_method :is_not,        :asserts_not
+  alias_method :does_not_have, :asserts_not
 
 
   protected
@@ -351,7 +324,7 @@ class Valligator
   # @param option [nil,String] msg Error explanation (when required)
   #
   def validation_error(idx, msg)
-    raise(ValidationError, "`%s': %s" % [name_by_idx(idx), msg])
+    raise ValidationError.new("`%s': %s" % [name_by_idx(idx), msg], self.stack)
   end
 
 

data/test/lib/valligator/errors_test.rb

@@ -103,4 +103,14 @@ class TestErrors < Minitest::Test
     assert_equal expected, err.message
   end
 
+
+  #-------------------------------------
+  # #validation_stack
+  #-------------------------------------
+
+  def test__stack_attribute
+    err = assert_raises(error) { v(:foo).is_a(Symbol).is_not_empty?.speaks(:boom).has(:size) { self > 0 } }
+    assert 'is_kind_of.asserts_not.speaks', err.validation_stack
+  end
+
 end

data/test/lib/valligator/is_instance_of_test.rb

@@ -8,27 +8,25 @@ class TestIsInstanceOf < Minitest::Test
     Valligator::ValidationError
   end
 
-  positive_statements = [:is_kind_of, :is_a]
-  negative_statements = [:is_not_kind_of, :is_not_a]
-  all_statements = positive_statements + negative_statements
+  positive_statements = [:is_kind_of, :is_a, :is_an]
+  negative_statements = [:is_not_kind_of, :is_not_a, :is_not_an]
 
-  all_statements.each do |method|
+
+  positive_statements.each do |method|
     define_method 'test_that__%s__fails_on_wrong_number_of_arguments' % method do
-      expected = "wrong number of arguments (0 for 1..Infinity) at `testee#1.%s'" % method
+      expected = "wrong number of arguments (0 for 1..Infinity) at `testee#1.is_kind_of'"
       err = assert_raises(ArgumentError) { v(:a).send(method) }
       assert_equal expected, err.message
     end
 
 
     define_method 'test_that__%s__fails_on_wrong_argument_type' % method do
-      expected = "wrong argument type (arg#1 is a NilClass instead of Class) at `testee#1.%s'" % method
+      expected = "wrong argument type (arg#1 is a NilClass instead of Class) at `testee#1.is_kind_of'"
       err = assert_raises(ArgumentError) { v(:a).send(method, nil) }
       assert_equal expected, err.message
     end
-  end
 
 
-  positive_statements.each do |method|
     define_method 'test_that__%s__returns_an_instance_of_valligator' % method do
       assert_instance_of Valligator, v(:a).send(method, Symbol)
     end
@@ -50,6 +48,19 @@ class TestIsInstanceOf < Minitest::Test
 
 
   negative_statements.each do |method|
+    define_method 'test_that__%s__fails_on_wrong_number_of_arguments' % method do
+      expected = "wrong number of arguments (0 for 1..Infinity) at `testee#1.is_not_kind_of'"
+      err = assert_raises(ArgumentError) { v(:a).send(method) }
+      assert_equal expected, err.message
+    end
+
+
+    define_method 'test_that__%s__fails_on_wrong_argument_type' % method do
+      expected = "wrong argument type (arg#1 is a NilClass instead of Class) at `testee#1.is_not_kind_of'"
+      err = assert_raises(ArgumentError) { v(:a).send(method, nil) }
+      assert_equal expected, err.message
+    end
+
     define_method 'test_that__%s__returns_an_instance_of_valligator' % method do
       assert_instance_of Valligator, v(:a).send(method, String)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valligator
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Konstantin Dzreev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
+date: 2017-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest