shape_of 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64fc24c8d36d335c6052f39457aac2f62dd4155538e57dda11c78e080748bac7
-  data.tar.gz: ff28778300c41c9352a83da9d6ae2b95c75150dd5429abfd5e3a90c0dd1397e5
+  metadata.gz: f227bdcd2eb6f6161a565d653a11510cdbaeb9f7dca33d7e99ed704f574412b1
+  data.tar.gz: 177e743c8a22d03f56d7609ae478bd4ba5febd9b4da66e63b91ecab6a5119d11
 SHA512:
-  metadata.gz: 0725a89f09c62099a96287fdc2c14080d004de6f1682e9cf09cefc6ed7300e535cfb7d375f7e913d8ccd22b5f2b23b52da8072aa85dbfe2cca3dc7d6480672b5
-  data.tar.gz: e285973c38a51f6fcbb662e82322ea9bcb291388617849e0b86bdfd0e44cf2c4007ae456f5259fffef63f80d178c3f94016b49fa4ef2096c4d39a2e7992ae84d
+  metadata.gz: a06688a7273bc87e05a96c4d3efedffc4281dd29fdb005c07477be380e17f655c9c17e7d2947900d87989fb45ee2171e226194531f51d2487dd47df082e3e69b
+  data.tar.gz: 5b633d82d85b04fd41463d5a43dbda8da587a458bb77a50e02c8694202e26bc0a2eefb395924bd9d5ac50bdeca821ac66924aa0793f57f34afb1c50b358d705e

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,6 +319,9 @@ module ShapeOf
     end
   end
 
+  # Matches a Regexp against a String using Regexp#match?.
+  # Pretty much a wrapper around Regexp because a Regexp instance will be tested for equality
+  # in the ShapeOf::Hash and ShapeOf::Array since it's not a class.
   class Pattern < Shape
     def self.[](shape)
       raise TypeError, "Shape must be #{Regexp.inspect}, was #{shape.inspect}" unless shape.instance_of? Regexp
@@ -345,10 +351,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: 2.0.1
+  version: 2.0.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