shape_of 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3927b79cdab33d77c8c7e3d603fa534374db3249711e52ddc38f80fe7f3b261
-  data.tar.gz: 850512ef062009d3573d1030d53a71bca63bd4160d9984abfbb63f419997bb09
+  metadata.gz: 0f32c3530c617efc49481f9e952d30996e62b429f591f28bad0b9c9bfaa161da
+  data.tar.gz: b33c421e8bfac97b74e58970a7cacd6eb4ccc55c60637a5410ba4f688286a1a6
 SHA512:
-  metadata.gz: ad23f6d1177ced41798e95b6021bf95d193d369d12b4acf932257edd6c3b1e782fc15c98c771e7fb2f70c6cffb5d2f5360f9403ebe0da5a68e4233788a05ea30
-  data.tar.gz: 8d3d24c669c79cbe84e739ea36bfd0fc4a09cb415cfa6720ee05126dbde7abb4605a11b9bb8ac54444be3d1e7f00f071453fc85074169b53c0e564f625e87dc8
+  metadata.gz: 0bc0af5a46a7a8285ecebd29f76c2146032043346cc4604750835521f885062662732129fb807ea7059d815d9f90571abab52d3b84764a5886268303f1ed9882
+  data.tar.gz: d18852f3ba98bfde393ad39466d4860b0c6eff6aa643d16fb237dba4170b1c46a5fd11abcb7cbbe3450376e7f8ba4799f075b9339c6dfeab8f70cc689189494e

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.[](*shapes)
       Class.new(self) do
@@ -281,8 +280,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
@@ -301,14 +299,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
@@ -319,12 +316,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: 1.0.2
+  version: 1.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