shape_of 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40c924b58fbcf750b029d9443d531492242529e8d224e5d5a8c933443498a1b4
-  data.tar.gz: 884e972b2ae57c5eeb884893858ba2ffee942249b2c3185296a5cf86b8604959
+  metadata.gz: a3927b79cdab33d77c8c7e3d603fa534374db3249711e52ddc38f80fe7f3b261
+  data.tar.gz: 850512ef062009d3573d1030d53a71bca63bd4160d9984abfbb63f419997bb09
 SHA512:
-  metadata.gz: 531a580e88cecba248bbe3709e869517950ea7b96ac5407138a13aafc5a99709925f1a28d74914d4af8f9e94b36e5ce956abf65c51295c7bcd24e65a63bf7913
-  data.tar.gz: 344c4ee899ec0b0b21df0bc30d6895b628e75264e5af20cbaeee72656ed649ca73201448d085a9487435193166b26c7fa087a48afb5cbe65958c1bad9b9373ef
+  metadata.gz: ad23f6d1177ced41798e95b6021bf95d193d369d12b4acf932257edd6c3b1e782fc15c98c771e7fb2f70c6cffb5d2f5360f9403ebe0da5a68e4233788a05ea30
+  data.tar.gz: 8d3d24c669c79cbe84e739ea36bfd0fc4a09cb415cfa6720ee05126dbde7abb4605a11b9bb8ac54444be3d1e7f00f071453fc85074169b53c0e564f625e87dc8

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.0.1
+  version: 1.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