shape_of 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf335e236284c12e251182de9ed6d299a732e9a9c08802702da1982e74c07a05
-  data.tar.gz: 417d9223a3a039c70205dcff26d23844a5067e2ffe2dad1b38f3d84644399123
+  metadata.gz: 752eb59a030bfd813d4d4a06fb470860dcc4906566601b606b31ae6d2e9a377e
+  data.tar.gz: 8549d7a936ead7069f6a2976045b1b9a2a41514dd2aa87086a0009c030c1b2cc
 SHA512:
-  metadata.gz: bb681e7c250d0ef0f81c66ebbf126cc1f7f13fef4dce314364686fa6301181009a0e8e961a6ea23e724aea6737bcde9643a096e168379a43825e953050fe97b1
-  data.tar.gz: a46c0b1712c6003c75edf9a5641fc03f1a64672b0b6e2882cfaa996a8b3a0609306b53a0184d6cb2924132cc4ca94f55b0adf2fc4413822224568518c1eeca30
+  metadata.gz: efe740174b7c8f1c4ede6040e118038cd97e6f7e6b3e21b19e5d97d947bfbe2aaf4399b9b3b905893735eeaeb5b1277ec4188980a5a2874468fd989068a4fbea
+  data.tar.gz: 9bef6f76ff9fcb92ae39c1fa88c3cd608d843cff8ce189de92651a77ee92aba7343dfe2459e7d79f75167508a46a8ebea55d1b60aaa2169940a340428378b03b

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: 0.2.1
+  version: 0.2.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