constrain 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e48891d02cd81470d1f83543f6db1f7da99d75f3afe05cdc57b2c1e63d7a2ff9
-  data.tar.gz: dd37d53ea1080db393871ede639a653f985cc38373314d8b23b5013f3d8f9803
+  metadata.gz: 21ca1b88c0ffb91b40a2a2335ead91e2570108f8b67eaa9ea7fa3ebe00ada4c4
+  data.tar.gz: '083da1149466231ca8de0dc216cb00c46c540ebc1b7558a0d26422c33b5af9c4'
 SHA512:
-  metadata.gz: f2b8bf75caa5936d24773c662f4f43da95820c7245770a1b07c80e82e397aaeea06927e749fb9e1d615daebee3be92ccfa0001ebf334a1d4ceab19d87c225c3c
-  data.tar.gz: '082302ac6cbd3a638f4175a2a91cb3e6bb73e75032d08e9eb21c1e41fff122a3909c983bdf1068bf383b1c32fd93e91808abc687301e446f9c4ef0b05ab2b21e'
+  metadata.gz: 7b40d638495bf36bd661fd1f8ab7845ec177a3f5cb2f73ddfd400976a9b02f9f8b2f16b2b0301b287cd419c43a2e961e895f96b6e9fd7a46545c96c71a954a28
+  data.tar.gz: 7be37bc44024db00f04d1355cc4bf340ca8728b2ff3014e27bda54f551bab85843f383f61890a8eaf63c65a14907061b3ce49f676732e1b0ad774b0e0e727541

data/README.md

@@ -58,7 +58,7 @@ end
 ```
 
 The alternative is to include the constrain Module in a common root class to
-have it available in all child class
+have it available in all child classes
 
 ## Methods
 
@@ -68,7 +68,7 @@ Return the given value if it matches at least one of the class-expressions and r
 Constrain::TypeError if not. 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 backtrace will refer to the point of the call of
-\#constrain. \#constrain araises a Constrain::Error exception if there is
+\#constrain. \#constrain raises a Constrain::Error exception if there is
 an error in the syntax of the class expression
 
 \#constrain is typically used to type-check parameters in methods where you
@@ -77,13 +77,19 @@ 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, \*class-expressions, message = nil, unwind: 0)
+
+Class method version of #constrain. It is automatically added to classes that
+include Constrain
+
 
 #### Constrain.constrain?(value, \*class-expression) -> true or false
 
 It matches value against the class expressions like #constrain but returns true
 or false as result and can be used to handle complex type expressions
-dynamically. It is made a class method to minimize namespace pollution
-
+dynamically. 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
 
 ## Class Expressions
 

data/lib/constrain.rb

@@ -1,4 +1,18 @@
 require "constrain/version"
+module Foo
+
+  module InstanceMethods
+    def bar1
+      'bar1'
+    end
+  end
+
+  module ClassMethods
+    def bar2
+      'bar2'
+    end
+  end
+end
 
 module Constrain
   # Raised on any error
@@ -11,23 +25,60 @@ module Constrain
     end
   end
 
+  def self.included base
+    base.extend ClassMethods
+  end
+
+  # See Constrain.constrain
+  def constrain(value, *exprs)
+    Constrain.do_constrain(value, *exprs)
+  end
+
+  def constrain?(value, expr)
+    Constrain.do_constrain?(value, expr)
+  end
+
   # :call-seq:
   #   constrain(value, *class-expressions, unwind: 0)
   #
   # Check that value matches one of the class expressions. Raises a
   # Constrain::Error if the expression is invalid and a Constrain::TypeError if
-  # the value doesn't match. The exception's backtrace skips :unwind number of entries
-  def constrain(value, *exprs) #, unwind: 0)
+  # the value doesn't match. The exception's backtrace skips :unwind number of
+  # entries
+  def self.constrain(value, *exprs)
+    do_constrain(value, *exprs)
+  end
+
+  # Return true if the value matches the class expression. Raises a
+  # Constrain::Error if the expression is invalid
+  #
+  # TODO: Allow *exprs
+  def self.constrain?(value, expr)
+    do_constrain?(value, expr)
+  end
+
+  module ClassMethods
+    # See Constrain.constrain
+    def constrain(*args) Constrain.do_constrain(*args) end
+
+    # See Constrain.constrain?
+    def constrain?(*args) Constrain.do_constrain?(*args) end
+  end
+
+  # unwind is automatically incremented by one because ::do_constrain is always
+  # called from one of the other constrain methods
+  #
+  def self.do_constrain(value, *exprs)
     if exprs.last.is_a?(Hash)
-      unwind = exprs.last.delete(:unwind) || 0
+      unwind = (exprs.last.delete(:unwind) || 0) + 1
       !exprs.last.empty? or exprs.pop
     else
-      unwind = 0
+      unwind = 1
     end
     msg = exprs.pop if exprs.last.is_a?(String)
     begin
       !exprs.empty? or raise Error, "Empty class expression"
-      exprs.any? { |expr| Constrain.constrain?(value, expr) } or 
+      exprs.any? { |expr| Constrain.do_constrain?(value, expr) } or 
           raise TypeError.new(value, exprs, msg, unwind: unwind)
     rescue Error => ex
       ex.set_backtrace(caller[1 + unwind..-1])
@@ -36,23 +87,21 @@ module Constrain
     value
   end
 
-  # Return true if the value matches the class expression. Raises a
-  # Constrain::Error if the expression is invalid
-  def self.constrain?(value, expr)
+  def self.do_constrain?(value, expr)
     case expr
       when Class, Module
         value.is_a?(expr)
       when Array
         !expr.empty? or raise Error, "Empty array"
-        value.is_a?(Array) && value.all? { |elem| expr.any? { |e| constrain?(elem, e) } }
+        value.is_a?(Array) && value.all? { |elem| expr.any? { |e| Constrain.constrain?(elem, e) } }
       when Hash
         value.is_a?(Hash) && value.all? { |key, value|
           expr.any? { |key_expr, value_expr|
             [[key, key_expr], [value, value_expr]].all? { |value, expr|
               if expr.is_a?(Array) && (expr.size > 1 || expr.first.is_a?(Array))
-                expr.any? { |e| constrain?(value, e) }
+                expr.any? { |e| Constrain.do_constrain?(value, e) }
               else
-                constrain?(value, expr)
+                Constrain.constrain?(value, expr)
               end
             }
           }

data/lib/constrain/version.rb

@@ -1,3 +1,3 @@
 module Constrain
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: constrain
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Claus Rasmussen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
+date: 2021-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov