shape_of 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28b5bdad75322342f66037bc3780c36cc38dcbd932e6daba11480e372cd9bc7d
-  data.tar.gz: c753cadb3a00e5656abf762dc2c0f41dfcc8c604bda53aebeab30c62e231792f
+  metadata.gz: 200845fd006ae0119d06f0b1f3f8b7b908a7c3d8f8c16ebe4856bcb905af5763
+  data.tar.gz: f046ee908eb3715e8028484dac72fa0fa411f24496ad3d71d8c984cf1a33fd7b
 SHA512:
-  metadata.gz: ace4588260223b123c47a17b6f096fb3fdb5d30f84f68ecb53bd1aca7020a1cde2fe1805c05dad248fe544bcbb0cf42e77b7c5473313f2b01c096306a0e22dad
-  data.tar.gz: 4ac6be6efef005e115a44aa7f7a6ee32bc69a058ec13e0336b80284e05e711628f68190ecb9b81fefe181b779f3da20f72c8b3bf55d01a05768b72ed7de754c6
+  metadata.gz: f9d8e53319be78d4f3cf0aa6cc94f19f89c25decc737fecd1d16ce6e4666f35b80bca6ee9aff753ada64e85aa9d8c829cb4af06d67b33c114033c6f57838258a
+  data.tar.gz: d70f5abeb46bd372329189755f901f5d56fa0e9d7d07d3a6724404719844c08ae4792042e6eaf417051e0bf33183f66f23fe29369003eefc0d6f7879157f9756

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 Hash, are the core components of this module.
+  # This, along with Array, 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.first].shape_of? elem
+              Array[@shape].shape_of? elem
             elsif @shape.is_a? ::Hash
               Hash[@shape].shape_of? elem
             elsif @shape.is_a? Class
@@ -175,8 +175,7 @@ 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
@@ -223,7 +222,7 @@ module ShapeOf
             if @shape[key].respond_to? :shape_of?
               @shape[key].shape_of? elem
             elsif @shape[key].is_a? ::Array
-              Array[@shape[key].first].shape_of? elem
+              Array[@shape[key]].shape_of? elem
             elsif @shape[key].is_a? ::Hash
               Hash[@shape[key]].shape_of? elem
             elsif @shape[key].is_a? Class
@@ -243,7 +242,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.shape_of?(object)
       false
@@ -285,8 +284,7 @@ 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
@@ -305,14 +303,13 @@ 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
 
-  # Only passes when the key does not exist in the Hash.
+  # Nothing only passes when the key does not exist in the Hash.
   class Nothing < Shape
     def self.shape_of?(object)
       false
@@ -323,12 +320,10 @@ 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: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - John Isom
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest