shape_of 0.2.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9663853638d239d448381e9ab748aeb7813a76b42ed9bd97c423f6d142c95d80
-  data.tar.gz: b1bdfeb51c08760c7c83519ce640c48d1202d23f3878adb93a2824761525219e
+  metadata.gz: a3927b79cdab33d77c8c7e3d603fa534374db3249711e52ddc38f80fe7f3b261
+  data.tar.gz: 850512ef062009d3573d1030d53a71bca63bd4160d9984abfbb63f419997bb09
 SHA512:
-  metadata.gz: 49cc6be2be276d554b25affe85bd97aca4ff3a134ee2a6334a0d37f35982f34ff28c39d3ce090418d2843b15dbc9d4b5b3bcbe568be69acbed90e31bcfab1ec6
-  data.tar.gz: cbaa2ed60315ffc111228a0f2093e950ad930a5ecbbba25c471f2d55044d1f14829e040e04d6e6705fcb767519994b1df46b67d0e61ea1046d90a54b87ff3057
+  metadata.gz: ad23f6d1177ced41798e95b6021bf95d193d369d12b4acf932257edd6c3b1e782fc15c98c771e7fb2f70c6cffb5d2f5360f9403ebe0da5a68e4233788a05ea30
+  data.tar.gz: 8d3d24c669c79cbe84e739ea36bfd0fc4a09cb415cfa6720ee05126dbde7abb4605a11b9bb8ac54444be3d1e7f00f071453fc85074169b53c0e564f625e87dc8

data/lib/shape_of.rb

@@ -89,11 +89,11 @@ module ShapeOf
   module Assertions
     def assert_shape_of(object, shape)
       if shape.respond_to? :shape_of?
-        assert_operator shape, :shape_of?, object
+        assert shape.shape_of? object
       elsif shape.instance_of? ::Array
-        assert_operator Array[shape.first], :shape_of?, object
+        assert Array[shape.first].shape_of? object
       elsif shape.instance_of? ::Hash
-        assert_operator Hash[shape], :shape_of?, object
+        assert Hash[shape].shape_of? object
       else
         raise TypeError, "Expected #{Shape.inspect}, an #{::Array.inspect}, or a #{::Hash.inspect} as the shape"
       end
@@ -101,11 +101,11 @@ module ShapeOf
 
     def refute_shape_of(object, shape)
       if shape.respond_to? :shape_of?
-        refute_operator shape, :shape_of?, object
+        refute shape.shape_of? object
       elsif shape.instance_of? ::Array
-        refute_operator Array[shape.first], :shape_of?, object
+        refute Array[shape.first].shape_of? object
       elsif shape.instance_of? ::Hash
-        refute_operator Hash[shape], :shape_of?, object
+        refute Hash[shape].shape_of? object
       else
         raise TypeError, "Expected #{Shape.inspect}, an #{::Array.inspect}, or a #{::Hash.inspect} as the shape"
       end
@@ -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
@@ -161,7 +161,7 @@ module ShapeOf
             if @shape.respond_to? :shape_of?
               @shape.shape_of? elem
             elsif @shape.is_a? ::Array
-              Array[@shape].shape_of? elem
+              Array[@shape.first].shape_of? elem
             elsif @shape.is_a? ::Hash
               Hash[@shape].shape_of? elem
             elsif @shape.is_a? Class
@@ -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
@@ -222,7 +223,7 @@ module ShapeOf
             if @shape[key].respond_to? :shape_of?
               @shape[key].shape_of? elem
             elsif @shape[key].is_a? ::Array
-              Array[@shape[key]].shape_of? elem
+              Array[@shape[key].first].shape_of? elem
             elsif @shape[key].is_a? ::Hash
               Hash[@shape[key]].shape_of? elem
             elsif @shape[key].is_a? Class
@@ -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,51 +319,12 @@ module ShapeOf
     end
   end
 
-  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
-
+  # 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.0
+  version: 1.0.2
 platform: ruby
 authors:
 - John Isom
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest