shape_of 1.0.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6029b808200bb28201b18af2fac69cdd6c7ef68a27c55d7c94d95ee459dcdc3e
-  data.tar.gz: 7a07a494f474b3ed1fb1f33d0f6f6633b5e2c1a27b69abe3f37cbcba7c60cb86
+  metadata.gz: a15e41f23fb7b198036f33f6099ff66a25d2ed5ca9bcc65c12f5ae78417f260a
+  data.tar.gz: df2f851769ee13aac6c5845de131af0c2ade259e96d4c22876ac61091eed0c89
 SHA512:
-  metadata.gz: 1874ea9da0b26864298dd7b9ccd5874fa39301c05c83e83ec18d4943726c6a58c877bed7e2fdafb5ad64cdbb40afe3a5611673e591a97315265644cd05741b8c
-  data.tar.gz: b9c36bdcc7fb8b5ef7f5913e7ec5fd34cbfc9dbffc5e8bd7a058f54f0ace2adafa9ed937a710a5780a3755b785a456d571af4bd67140d095d0de8c4d3d8df989
+  metadata.gz: 955b6f608e4cb0a3be5a8590c7cc260a6cb65b50c84736b129a61729889d1e08c15ff125a2f5cf6509bab558a9c016781363c3874a95230d6f193a5e97c8505b
+  data.tar.gz: d3d8f89ddc5c9d9e54513bfc69529f4262e6036a5dc02db0cf304b777ac16f82a96da50c132a79188faf5ef165381c9e2db8c5c45ec9a935bfc9647d2ee93282

data/lib/shape_of.rb

@@ -89,11 +89,11 @@ module ShapeOf
   module Assertions
     def assert_shape_of(object, shape)
       if shape.respond_to? :shape_of?
-        assert shape.shape_of? object
+        assert_operator shape, :shape_of?, object
       elsif shape.instance_of? ::Array
-        assert Array[shape.first].shape_of? object
+        assert_operator Array[shape.first], :shape_of?, object
       elsif shape.instance_of? ::Hash
-        assert Hash[shape].shape_of? object
+        assert_operator Hash[shape], :shape_of?, object
       else
         raise TypeError, "Expected #{Shape.inspect}, an #{::Array.inspect}, or a #{::Hash.inspect} as the shape"
       end
@@ -101,11 +101,11 @@ module ShapeOf
 
     def refute_shape_of(object, shape)
       if shape.respond_to? :shape_of?
-        refute shape.shape_of? object
+        refute_operator shape, :shape_of?, object
       elsif shape.instance_of? ::Array
-        refute Array[shape.first].shape_of? object
+        refute_operator Array[shape.first], :shape_of?, object
       elsif shape.instance_of? ::Hash
-        refute Hash[shape].shape_of? object
+        refute_operator Hash[shape], :shape_of?, object
       else
         raise TypeError, "Expected #{Shape.inspect}, an #{::Array.inspect}, or a #{::Hash.inspect} as the shape"
       end
@@ -127,9 +127,9 @@ module ShapeOf
     end
   end
 
-  # Array[Shape] denotes that it is an array of shapes.
+  # Array[shape] denotes that it is an array of shapes.
   # It checks every element in the array and verifies that the element is in the correct shape.
-  # This, along with Array, are the core components of this module.
+  # This, along with Hash, are the core components of this module.
   # Note that a ShapeOf::Array[Integer].shape_of?([]) will pass because it is vacuously true for an empty array.
   class Array < Shape
     @internal_class = ::Array
@@ -161,7 +161,7 @@ module ShapeOf
             if @shape.respond_to? :shape_of?
               @shape.shape_of? elem
             elsif @shape.is_a? ::Array
-              Array[@shape].shape_of? elem
+              Array[@shape.first].shape_of? elem
             elsif @shape.is_a? ::Hash
               Hash[@shape].shape_of? elem
             elsif @shape.is_a? Class
@@ -175,7 +175,8 @@ module ShapeOf
     end
   end
 
-  # Hash[key: Shape, ...] denotes it is a hash of shapes with a very specific structure. Hash (without square brackets) is just a hash with any shape.
+  # Hash[key: shape, ...] denotes it is a hash of shapes with a very specific structure.
+  # Hash (without square brackets) is just a hash with any shape.
   # This, along with Array, are the core components of this module.
   # Note that the keys are converted to strings for comparison for both the shape and object provided.
   class Hash < Shape
@@ -222,7 +223,7 @@ module ShapeOf
             if @shape[key].respond_to? :shape_of?
               @shape[key].shape_of? elem
             elsif @shape[key].is_a? ::Array
-              Array[@shape[key]].shape_of? elem
+              Array[@shape[key].first].shape_of? elem
             elsif @shape[key].is_a? ::Hash
               Hash[@shape[key]].shape_of? elem
             elsif @shape[key].is_a? Class
@@ -242,7 +243,7 @@ module ShapeOf
     end
   end
 
-  # Union[Shape1, Shape2, ...] denotes that it can be of one the provided shapes
+  # Union[shape1, shape2, ...] denotes that it can be of one the provided shapes.
   class Union < Shape
     def self.[](*shapes)
       Class.new(self) do
@@ -280,7 +281,8 @@ module ShapeOf
     end
   end
 
-  # Optional[Shape] denotes that the usual type is a Shape, but is optional (meaning if it is nil or the key is not present in the Hash, it's still true)
+  # Optional[shape] denotes that the usual type is a shape, but is optional
+  # (meaning if it is nil or the key is not present in the Hash, it's still true)
   class Optional < Shape
     def self.[](shape)
       raise TypeError, "Shape cannot be nil" if shape.nil? || shape == NilClass
@@ -299,13 +301,14 @@ module ShapeOf
     end
   end
 
+  # Anything matches unless key does not exist in the Hash.
   class Any < Shape
     def self.shape_of?(object)
       true
     end
   end
 
-  # Nothing only passes when the key does not exist in the Hash.
+  # Only passes when the key does not exist in the Hash.
   class Nothing < Shape
     def self.shape_of?(object)
       false
@@ -316,10 +319,12 @@ module ShapeOf
     end
   end
 
+  # Union[Integer, Float, Rational, Complex]
   Numeric = Union[Integer, Float, Rational, Complex].tap do |this|
     this.instance_variable_set(:@class_name, this.name.sub(/Union.*/, 'Numeric'))
   end
 
+  # Union[TrueClass, FalseClass]
   Boolean = Union[TrueClass, FalseClass].tap do |this|
     this.instance_variable_set(:@class_name, this.name.sub(/Union.*/, 'Boolean'))
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shape_of
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.2
 platform: ruby
 authors:
 - John Isom
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-15 00:00:00.000000000 Z
+date: 2021-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest