shape_of 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a15e41f23fb7b198036f33f6099ff66a25d2ed5ca9bcc65c12f5ae78417f260a
-  data.tar.gz: df2f851769ee13aac6c5845de131af0c2ade259e96d4c22876ac61091eed0c89
+  metadata.gz: 6e28929cd043b2227c3fcfc7ec697afeebdcd77aa4fe82f3239c0c70518a653b
+  data.tar.gz: ea1433d60b53e1cf9793e5824a02d08d990d079ab67d62684dbf5a9a8278227c
 SHA512:
-  metadata.gz: 955b6f608e4cb0a3be5a8590c7cc260a6cb65b50c84736b129a61729889d1e08c15ff125a2f5cf6509bab558a9c016781363c3874a95230d6f193a5e97c8505b
-  data.tar.gz: d3d8f89ddc5c9d9e54513bfc69529f4262e6036a5dc02db0cf304b777ac16f82a96da50c132a79188faf5ef165381c9e2db8c5c45ec9a935bfc9647d2ee93282
+  metadata.gz: 1f4a6d76316870ae8945faa6de5797647c9aa9cbe259017b7acaf773a75c6100dfea4770d1f290dd2e8abcd37293111b74a6beb60767db6814a4ffab7714fec5
+  data.tar.gz: 8dae349aab3980850618761687ad7b3e61701dd9e29ebdc6880757bb744dd5f708e5a63d931de5121777e619054c7cdddfd8931416cd40a5960448bd89c3e60e

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 Hash, are the core components of this module.
+  # This, along with Array, 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
@@ -161,7 +161,7 @@ module ShapeOf
             if @shape.respond_to? :shape_of?
               @shape.shape_of? elem
             elsif @shape.is_a? ::Array
-              Array[@shape.first].shape_of? elem
+              Array[@shape].shape_of? elem
             elsif @shape.is_a? ::Hash
               Hash[@shape].shape_of? elem
             elsif @shape.is_a? Class
@@ -175,8 +175,7 @@ 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
@@ -223,7 +222,7 @@ module ShapeOf
             if @shape[key].respond_to? :shape_of?
               @shape[key].shape_of? elem
             elsif @shape[key].is_a? ::Array
-              Array[@shape[key].first].shape_of? elem
+              Array[@shape[key]].shape_of? elem
             elsif @shape[key].is_a? ::Hash
               Hash[@shape[key]].shape_of? elem
             elsif @shape[key].is_a? Class
@@ -243,7 +242,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
@@ -281,8 +280,7 @@ 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
@@ -301,14 +299,13 @@ 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
 
-  # Only passes when the key does not exist in the Hash.
+  # Nothing only passes when the key does not exist in the Hash.
   class Nothing < Shape
     def self.shape_of?(object)
       false
@@ -319,12 +316,51 @@ module ShapeOf
     end
   end
 
-  # Union[Integer, Float, Rational, Complex]
+  class Regexp < Shape
+    @internal_class = ::Regexp 
+
+    def self.shape_of?(object)
+      object.instance_of? @internal_class
+    end
+
+    def self.[](shape)
+      raise TypeError, "Shape must be #{::Regexp.inspect}, was #{shape.inspect}" unless shape.instance_of? ::Regexp
+
+      Class.new(self) do
+        @class_name = "#{superclass.name}[#{shape.inspect}]"
+        @shape = shape
+
+        def self.name
+          @class_name
+        end
+
+        def self.to_s
+          @class_name
+        end
+
+        def self.inspect
+          @class_name
+        end
+
+        def self.shape_of?(object)
+          unless object.instance_of?(::Regexp) || object.instance_of?(String)
+            raise TypeError, "expected #{::Regexp.inspect} or #{String.inspect}, was instead #{object.inspect}"
+          end
+
+          if object.instance_of?(::Regexp)
+            @shape == object
+          else # string
+            @shape.match?(object)
+          end
+        end
+      end
+    end
+  end
+
   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.2
+  version: 1.2.0
 platform: ruby
 authors:
 - John Isom
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest