constrain 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e58649bbac9af8f3464dedd63c6c76e72c6f37440da629a10b5aba3319972214
-  data.tar.gz: c82c606c419af6c2af55aaca6a57bf03d2229917241bf800d32dba8d8a6a512c
+  metadata.gz: ff3fb59b6d713b01843aa67e4e90855e58f99b1fcffa8ff27ae66b53987d9672
+  data.tar.gz: 98237076729ee99035e1af426308f12ef36963879950287f107486ae0485e061
 SHA512:
-  metadata.gz: 6e0b90a537bea77af54c907ccb7fb1ea0a501623ba42c793c94ac446cfcbee615cac3d2937ec86741af883698ef3558ba4a3bc34030e3d1be68c36730e159097
-  data.tar.gz: 3d0212bdafd1a03d9058b8ad94bc423f346ec6b36752c1dbbc11b2f3b319d77493754cb68be712ce7dc7ab02986eab1329b7fa42ec116b770a0e31517c9c7124
+  metadata.gz: 533a2c7486903550fa42c3f349417130a8dd69642adf6d2e27599bd9f5e4b6be3fca0dcfcc58370cf4d64169952e06df5a0ad76603d424741f0c7846301f66ac
+  data.tar.gz: 95ee72d76e6ccfdd7faffd971214ecc6b171ab1a58debfd5a6a043a0764e8f154a910a7086399363a4bc88e94406a7a048f5efa32cadf5c1d8ded2e1725fcc37

data/TODO

@@ -1,11 +1,15 @@
 
-o Allow 'constrain SomeClass < SomeOtherClass'
+o Use | to create class-or expressions
+  o Old: Class | Class syntax
+o Use & to construct tuple expressions
+  o Old: A tuple method: "Symbol => constrain.tuple(String, Integer)"
+o Better error message for 'constrain EXPR'
+o Explain that 'constrain EXPR' can be used for 'constrain SomeClass < AnotherClass'
 o Match ranges and regular expressions
-o A tuple method: "Symbol => constrain.tuple(String, Integer)"
 o An array and hash method: "Symbol => constrain.array(Integer), String => constrain.hash(Symbol, Integer)"
-o Class | Class syntax
 o Constrained attributes: constrain_reader, constrain_writer, constrain_accessor: 
 o Messages should include info about the unexpected element type in arrays (and maybe more): "Expected [#<PgGraph::Data::Record:public.pings[1] {id: 1, name: 'Ping A'}>, #<PgGraph::Data::Record:public.pings[2] {id: 2, name: 'Ping B'}>, nil] to match [PgGraph::Data::Record]
 
 + constrain value, class-expr, "Error message"
 + Check against values: 'constrain arg, :one_value, :another_value, 1, 2, 3'
++ Allow 'constrain EXRP'

data/lib/constrain/version.rb

@@ -1,3 +1,3 @@
 module Constrain
-  VERSION = "0.7.0"
+  VERSION = "0.9.0"
 end

data/lib/constrain.rb

@@ -3,8 +3,12 @@ require "constrain/version"
 module Constrain
   # Raised if types doesn't match a class expression
   class MatchError < StandardError
-    def initialize(value, exprs, message: nil, unwind: 0)
-      super message || "Expected #{value.inspect} to match #{Constrain.fmt_exprs(exprs)}"
+    def initialize(value, exprs, message: nil, unwind: 0, not_argument: false, not_value: nil)
+      if not_argument
+        super message || "Expected #{value.inspect} to not equal #{not_value.inspect}"
+      else
+        super message || "Expected #{value.inspect} to match #{Constrain.fmt_exprs(exprs)}"
+      end
     end
   end
 
@@ -12,17 +16,6 @@ module Constrain
     base.extend ClassMethods
   end
 
-  # See Constrain.constrain
-  def constrain(value, *exprs)
-    Constrain.do_constrain(value, *exprs)
-  end
-
-  # Like #constrain but returns true/false to indicate the result instead of
-  # raising an exception
-  def constrain?(value, *exprs)
-    Constrain.do_constrain?(value, *exprs)
-  end
-
   # :call-seq:
   #   constrain(value, *class-expressions, unwind: 0)
   #   constrain(value, *values, unwind: 0)
@@ -31,38 +24,41 @@ module Constrain
   # 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)
-    do_constrain(value, *exprs)
+  def self.constrain(value, *exprs, **opts)
+    do_constrain(value, *exprs, **opts)
   end
 
-  # Return true if the value matches the class expression. Raises a
-  # ArgumentError if the expression is invalid
-  def self.constrain?(value, *exprs)
-    do_constrain?(value, *exprs)
+  # See Constrain.constrain
+  def constrain(...) = Constrain.do_constrain(...)
+
+  # Like #constrain but returns true/false to indicate the result instead of
+  # raising an exception
+  def self.constrain?(value, *exprs, **opts)
+    do_constrain?(value, *exprs, **opts)
   end
 
+  # See Constrain.constrain?
+  def constrain?(...) = Constrain.do_constrain?(...)
+
   module ClassMethods
     # See Constrain.constrain
-    def constrain(*args) 
-
-    Constrain.do_constrain(*args) end
+    def constrain(...) Constrain.do_constrain(...) end
 
     # See Constrain.constrain?
-    def constrain?(*args) Constrain.do_constrain?(*args) end
+    def constrain?(...) Constrain.do_constrain?(...) end
   end
 
+  # :call-seq:
+  #   do_constrain(value, *exprs, unwind: 0, message: nil, not: nil)
+  #
   # 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) + 1
-      message = exprs.last.delete(:message)
-      !exprs.last.empty? or exprs.pop # Remove option hash if empty
-    else
-      unwind = 1
-      message = nil
-    end
+  def self.do_constrain(value, *exprs, unwind: 0, message: nil, **opts)
+    opts.keys.empty? || opts.keys == [:not] or raise ArgumentError
+    unwind += 1
+    not_argument = opts.key?(:not)
+    not_value = opts[:not]
     
     begin
       if exprs.empty?
@@ -71,6 +67,10 @@ module Constrain
         exprs.any? { |expr| Constrain.do_constrain_value?(value, expr) } or 
             raise MatchError.new(value, exprs, message: message, unwind: unwind)
       end
+      !not_argument || value != not_value or 
+          raise MatchError.new(
+              value, exprs, message: message, unwind: unwind, not_argument: true, not_value: not_value)
+        
     rescue ArgumentError, Constrain::MatchError => ex
       ex.set_backtrace(caller[1 + unwind..-1])
       raise
@@ -78,17 +78,19 @@ module Constrain
     value
   end
 
-  def self.do_constrain?(value, *exprs)
+  def self.do_constrain?(...)
     begin
-      !exprs.empty? or raise ArgumentError, "Empty constraint"
-      exprs.any? { |expr| Constrain.do_constrain_value?(value, expr) }
+      do_constrain(...)
+    rescue MatchError
+      return false
     end
+    true
   end
 
   def self.do_constrain_value?(value, expr)
     case expr
       when Class, Module
-        value.is_a?(expr)
+        expr === value
       when Array
         !expr.empty? or raise ArgumentError, "Empty array in constraint"
         value.is_a?(Array) && value.all? { |elem| expr.any? { |e| Constrain.constrain?(elem, e) } }

metadata

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