shape_of 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df01594be1ba045827f1c1065c663546e4f4d6c3a528788baadb79625ecf8ac9
-  data.tar.gz: c97c5fe312f2c85a38986499329367503fda2137c1028a2c4f2c0dac61c6a8db
+  metadata.gz: f553350ffd20cf6d41ccdedd05e1270d9af3e7537888620d59b245bfd1a7a46d
+  data.tar.gz: 8478b7134ffb95be65729e25083c7bc761787bf62c5601b2707c80b417418bfd
 SHA512:
-  metadata.gz: 8b39e010347b15901f6e383cb903da85b18403ea2ceb29b07d430a7e8e8ebc8b68a940aa5e6595afcdfb64510f4b380c7786f22ac613182f6993f9697ad4671c
-  data.tar.gz: 0e9a43e35b97948c20702c3790f44ea6e3eba481cee4b5cd898ac00b995e2987cb86b886948458508807edfb38181389734ff70de851bcad1b3b037f2d58634f
+  metadata.gz: 773d54bc36873a4890a7c71d90a30f1610b924fcac074350952a4e8b08ad3ba5702edc4a4d32eb640edc99fd8f233a8e7dc959aa7824633bd4286fb9f65cf71c
+  data.tar.gz: 1ac8506767c31db60322b1395bbf1cc58ef7854483b24e8aba6e260e482fa2ca49406553fa93ca6cc79911d1e0939a56dcfe3a73a38ce2c7c406eb47c076a32e

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.shape_of?(object)
       false
@@ -284,7 +285,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
@@ -303,13 +305,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
@@ -320,10 +323,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: 0.1.1
+  version: 0.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