shape_of 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b4935ae23d9b1478648c71bf1c2fa2f1ef02cd0ca8817ad5ba8b82e4a3e1af1
-  data.tar.gz: f67e5ef3f03f1ad27d55d10b2c2400cfed6d216de7d8e35d6b81f5f643d19289
+  metadata.gz: a15e41f23fb7b198036f33f6099ff66a25d2ed5ca9bcc65c12f5ae78417f260a
+  data.tar.gz: df2f851769ee13aac6c5845de131af0c2ade259e96d4c22876ac61091eed0c89
 SHA512:
-  metadata.gz: 14cda0fb707a8a43269f9f19f52994920b2117449c0afcd3911c41706320cb0fb0b7565922ab627ad1be66908de9bf32d120f86db27b0bd2aa2fe086a80adcd9
-  data.tar.gz: ae65c4e28e748a9f3e361c51a66a4e84da83d07c7f579cb03758e1bf126b5d858a48a38949a10653704edc97fac6201d4ff1725773ca26e8dbc7da3fb89c76f4
+  metadata.gz: 955b6f608e4cb0a3be5a8590c7cc260a6cb65b50c84736b129a61729889d1e08c15ff125a2f5cf6509bab558a9c016781363c3874a95230d6f193a5e97c8505b
+  data.tar.gz: d3d8f89ddc5c9d9e54513bfc69529f4262e6036a5dc02db0cf304b777ac16f82a96da50c132a79188faf5ef165381c9e2db8c5c45ec9a935bfc9647d2ee93282

data/lib/shape_of.rb

@@ -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
@@ -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
@@ -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.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - John Isom
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-20 00:00:00.000000000 Z
+date: 2021-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest