feat: be able to use an Exception (optional)

Author: Nicolab

spec/check/check_validation_spec.cr

@@ -12,6 +12,39 @@ describe "Check" do
     Check::Errors.new.is_a?(Hash).should be_true
   end
 
+  describe "ValidationError" do
+    it "should create Exception taking Errors container" do
+      v = Check.new_validation
+      v.add_error "my_field", "Oops"
+
+      ex = Check::ValidationError.new v.errors
+      ex.should be_a Check::ValidationError
+      ex.should be_a Exception
+      ex.errors.should be_a Check::Errors
+      ex.errors.size.should eq 1
+      ex.errors["my_field"].should eq ["Oops"]
+      ex.message.should eq "Validation error"
+    end
+
+    it "should support custom message, pluralize it if ends with error" do
+      v = Check.new_validation
+      v.add_error "my_field", "Oops"
+
+      ex = Check::ValidationError.new v.errors
+      ex.errors.size.should eq 1
+      ex.message.should eq "Validation error"
+
+      v.add_error "my_field2", "Oops"
+      ex = Check::ValidationError.new v.errors
+      ex.errors.size.should eq 2
+      ex.message.should eq "Validation errors"
+
+      ex = Check::ValidationError.new v.errors, "Bad validation"
+      ex.errors.size.should eq 2
+      ex.message.should eq "Bad validation"
+    end
+  end
+
   it "#new_validation" do
     v = Check.new_validation
     v.class.should eq Check::Validation
@@ -99,6 +132,18 @@ describe "Check" do
       v.valid?.should be_false
     end
 
+    it "#to_exception" do
+      v = Check.new_validation
+      v.add_error "my_field", "Oops"
+
+      ex = v.to_exception
+      ex.should be_a Check::ValidationError
+      ex.should be_a Exception
+      ex.errors.should be_a Check::Errors
+      ex.errors.size.should eq 1
+      ex.errors["my_field"].should eq ["Oops"]
+    end
+
     it "#check with string and symbol keys" do
       v = Check.new_validation
 

src/check.cr

@@ -18,6 +18,19 @@ module Check
   # ```
   alias Errors = Hash(Symbol | String, Array(String))
 
+  # Validation error.
+  # To carry `Errors` into an `Exception`.
+  class ValidationError < Exception
+    def initialize(@errors : Errors, @message = "Validation error")
+      @message = "#{@message}s" if @errors.size > 1 && @message.as(String).ends_with?("error")
+    end
+
+    # Returns `Errors` container (`Hash`).
+    def errors : Errors
+      @errors
+    end
+  end
+
   # Combines a series of checks into one validation instance,
   # with a customized error message for each case.
   #
@@ -318,6 +331,11 @@ module Check
       add_error(key, "") unless valid
       self
     end
+
+    # Creates a new instance of `ValidationError` (`Exception`).
+    def to_exception
+      ValidationError.new @errors
+    end
   end
 
   # Initializes a new `Validation` instance to combine