constrain 0.3.3 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04e9db24a4fdaf9e637bbebb861344d3e63b9a4f2e6923f05cf69387459470de
-  data.tar.gz: fd26404b3458bb5fd8fb63b5cb73e83bce681a9920f6aee70ed7b2f86ea9275d
+  metadata.gz: c3983b4e793cdb6dce194d422e4ac27a0781fc4d4956383cb758444100923dc5
+  data.tar.gz: '06029816512b72fca6993cee9dd7fce0a165a5e03d1e7d7292df277dd8cea1bd'
 SHA512:
-  metadata.gz: cfda3b10415cb633b4c6aecb9819984d4ead39490e3acf2bb6e727b6f87e44c9b4f16fbcd48c6538c9167366b6b0eccf900a9bca4eeb399c07759a73e706b223
-  data.tar.gz: f297b0b6c61ea48c94c314c204a4d9904e0b744fb6fb00fbe9523af93a2c61a31b985ac0b408d3b02c13c9c382c6afb5fb9353bdd03d3a9d4875ee0368c383d4
+  metadata.gz: aab2f97456b574a849e5b130f4af473efd755a89a844207f057e10722a32dc664915a1c5e4ed3d03140adec0ddb5cfa7ea15d1fadc9681ec65d4a46d6288de99
+  data.tar.gz: 2f8c4cfe16ae3712aaedab413b5235764a03e6b89dfcb6946d01abbf739537ed0b4d55dde0728e7a58d0569ff6b99e79cb1daec5b6229cd436015d3f20e27d5d

data/README.md

@@ -47,16 +47,17 @@ have it available in all child classes
 
 ## Methods
 
-#### constrain(value, \*expressions, message = nil, unwind: 0)
+#### constrain(value, \*expressions, message: nil, unwind: 0)
 
 Return the given value if it matches at least one of the expressions and raise a
 Constrain::TypeError if not. The value is matched against the expressions using
 the #=== operator so anything you can put into the 'when' clause of a 'case'
 statement can be used. #constrain raise a Constrain::MatchError if the value
-doesn't match any expression 
+doesn't match any expression and an ArgumentError if there is a syntax error in
+the expression 
 
-The error message can be customized by added the message argument and a number
-of backtrace leves can be skipped by setting :unwind option. By default the
+The error message can be customized by adding the message option and a number
+of backtrace leves can be skipped using the :unwind option. By default the
 backtrace will refer to the point of the call of \#constrain. \#constrain
 raises a Constrain::Error exception if there is an error in the syntax of the
 class expression
@@ -65,9 +66,8 @@ class expression
 want an exception if the parameters doesn't match the expected, but because it
 returns the value if successful it can be used to check the validity of
 variables in expressions too, eg. `return constrain(result_of_complex_computation, Integer)` 
-to check the return value of a method
 
-#### Constrain.constrain(value, \*expressions, message = nil, unwind: 0)
+#### Constrain.constrain(value, \*expressions, message: nil, unwind: 0)
 
 Class method version of #constrain. It is automatically added to classes that
 include Constrain
@@ -77,8 +77,8 @@ include Constrain
 
 It matches value against the class expressions like #constrain but returns true
 or false as result. It is automatically added to classes that include
-Constrain. Constrain.constrain? raises a Constrain::Error exception if there
-is an error in the syntax of the class expression
+Constrain. Constrain.constrain? raises a ArgumentError exception if there
+is an error in the syntax of the expression
 
 
 ## Expressions

data/lib/constrain/version.rb

@@ -1,3 +1,3 @@
 module Constrain
-  VERSION = "0.3.3"
+  VERSION = "0.5.1"
 end

data/lib/constrain.rb

@@ -1,13 +1,10 @@
 require "constrain/version"
 
 module Constrain
-  # Raised on any error
-  class Error < StandardError; end
-
   # Raised if types doesn't match a class expression
-  class MatchError < Error
-    def initialize(value, exprs, msg = nil, unwind: 0)
-      super msg || "Expected #{value.inspect} to match #{Constrain.fmt_exprs(exprs)}"
+  class MatchError < StandardError
+    def initialize(value, exprs, message: nil, unwind: 0)
+      super message || "Expected #{value.inspect} to match #{Constrain.fmt_exprs(exprs)}"
     end
   end
 
@@ -31,7 +28,7 @@ module Constrain
   #   constrain(value, *values, unwind: 0)
   #
   # Check that value matches one of the class expressions. Raises a
-  # Constrain::Error if the expression is invalid and a Constrain::MatchError if
+  # ArgumentError if the expression is invalid and a Constrain::MatchError if
   # the value doesn't match. The exception's backtrace skips :unwind number of
   # entries
   def self.constrain(value, *exprs)
@@ -39,14 +36,16 @@ module Constrain
   end
 
   # Return true if the value matches the class expression. Raises a
-  # Constrain::Error if the expression is invalid
+  # ArgumentError if the expression is invalid
   def self.constrain?(value, *exprs)
     do_constrain?(value, *exprs)
   end
 
   module ClassMethods
     # See Constrain.constrain
-    def constrain(*args) Constrain.do_constrain(*args) end
+    def constrain(*args) 
+
+    Constrain.do_constrain(*args) end
 
     # See Constrain.constrain?
     def constrain?(*args) Constrain.do_constrain?(*args) end
@@ -58,17 +57,18 @@ module Constrain
   def self.do_constrain(value, *exprs)
     if exprs.last.is_a?(Hash)
       unwind = (exprs.last.delete(:unwind) || 0) + 1
-      !exprs.last.empty? or exprs.pop
+      message = exprs.last.delete(:message)
+      !exprs.last.empty? or exprs.pop # Remove option hash if empty
     else
       unwind = 1
+      message = nil
     end
-    msg = exprs.pop if exprs.last.is_a?(String)
     
     begin
-      !exprs.empty? or raise Error, "Empty constraint"
+      !exprs.empty? or raise ArgumentError, "Empty constraint"
       exprs.any? { |expr| Constrain.do_constrain_value?(value, expr) } or 
-          raise MatchError.new(value, exprs, msg, unwind: unwind)
-    rescue Error => ex
+          raise MatchError.new(value, exprs, message: message, unwind: unwind)
+    rescue ArgumentError, Constrain::MatchError => ex
       ex.set_backtrace(caller[1 + unwind..-1])
       raise
     end
@@ -77,7 +77,7 @@ module Constrain
 
   def self.do_constrain?(value, *exprs)
     begin
-      !exprs.empty? or raise Error, "Empty constraint"
+      !exprs.empty? or raise ArgumentError, "Empty constraint"
       exprs.any? { |expr| Constrain.do_constrain_value?(value, expr) }
     end
   end
@@ -87,7 +87,7 @@ module Constrain
       when Class, Module
         value.is_a?(expr)
       when Array
-        !expr.empty? or raise Error, "Empty array in constraint"
+        !expr.empty? or raise ArgumentError, "Empty array in constraint"
         value.is_a?(Array) && value.all? { |elem| expr.any? { |e| Constrain.constrain?(elem, e) } }
       when Hash
         value.is_a?(Hash) && value.all? { |key, value|
@@ -117,7 +117,6 @@ module Constrain
 
   # Render a class expression as a String. Same as +expr.inspect+ except that
   # Proc objects are rendered as "Proc@<sourcefile>>:<linenumber>"
-  #
   def self.fmt_expr(expr)
     case expr
       when Class, Module; expr.to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: constrain
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.5.1
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-21 00:00:00.000000000 Z
+date: 2022-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov