shape_of 1.0.2 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +4 -4
  2. data/lib/shape_of.rb +14 -19
  3. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a3927b79cdab33d77c8c7e3d603fa534374db3249711e52ddc38f80fe7f3b261
4
- data.tar.gz: 850512ef062009d3573d1030d53a71bca63bd4160d9984abfbb63f419997bb09
3
+ metadata.gz: 0f32c3530c617efc49481f9e952d30996e62b429f591f28bad0b9c9bfaa161da
4
+ data.tar.gz: b33c421e8bfac97b74e58970a7cacd6eb4ccc55c60637a5410ba4f688286a1a6
5
5
  SHA512:
6
- metadata.gz: ad23f6d1177ced41798e95b6021bf95d193d369d12b4acf932257edd6c3b1e782fc15c98c771e7fb2f70c6cffb5d2f5360f9403ebe0da5a68e4233788a05ea30
7
- data.tar.gz: 8d3d24c669c79cbe84e739ea36bfd0fc4a09cb415cfa6720ee05126dbde7abb4605a11b9bb8ac54444be3d1e7f00f071453fc85074169b53c0e564f625e87dc8
6
+ metadata.gz: 0bc0af5a46a7a8285ecebd29f76c2146032043346cc4604750835521f885062662732129fb807ea7059d815d9f90571abab52d3b84764a5886268303f1ed9882
7
+ data.tar.gz: d18852f3ba98bfde393ad39466d4860b0c6eff6aa643d16fb237dba4170b1c46a5fd11abcb7cbbe3450376e7f8ba4799f075b9339c6dfeab8f70cc689189494e
data/lib/shape_of.rb CHANGED
@@ -89,11 +89,11 @@ module ShapeOf
89
89
  module Assertions
90
90
  def assert_shape_of(object, shape)
91
91
  if shape.respond_to? :shape_of?
92
- assert shape.shape_of? object
92
+ assert_operator shape, :shape_of?, object
93
93
  elsif shape.instance_of? ::Array
94
- assert Array[shape.first].shape_of? object
94
+ assert_operator Array[shape.first], :shape_of?, object
95
95
  elsif shape.instance_of? ::Hash
96
- assert Hash[shape].shape_of? object
96
+ assert_operator Hash[shape], :shape_of?, object
97
97
  else
98
98
  raise TypeError, "Expected #{Shape.inspect}, an #{::Array.inspect}, or a #{::Hash.inspect} as the shape"
99
99
  end
@@ -101,11 +101,11 @@ module ShapeOf
101
101
 
102
102
  def refute_shape_of(object, shape)
103
103
  if shape.respond_to? :shape_of?
104
- refute shape.shape_of? object
104
+ refute_operator shape, :shape_of?, object
105
105
  elsif shape.instance_of? ::Array
106
- refute Array[shape.first].shape_of? object
106
+ refute_operator Array[shape.first], :shape_of?, object
107
107
  elsif shape.instance_of? ::Hash
108
- refute Hash[shape].shape_of? object
108
+ refute_operator Hash[shape], :shape_of?, object
109
109
  else
110
110
  raise TypeError, "Expected #{Shape.inspect}, an #{::Array.inspect}, or a #{::Hash.inspect} as the shape"
111
111
  end
@@ -127,9 +127,9 @@ module ShapeOf
127
127
  end
128
128
  end
129
129
 
130
- # Array[shape] denotes that it is an array of shapes.
130
+ # Array[Shape] denotes that it is an array of shapes.
131
131
  # It checks every element in the array and verifies that the element is in the correct shape.
132
- # This, along with Hash, are the core components of this module.
132
+ # This, along with Array, are the core components of this module.
133
133
  # Note that a ShapeOf::Array[Integer].shape_of?([]) will pass because it is vacuously true for an empty array.
134
134
  class Array < Shape
135
135
  @internal_class = ::Array
@@ -161,7 +161,7 @@ module ShapeOf
161
161
  if @shape.respond_to? :shape_of?
162
162
  @shape.shape_of? elem
163
163
  elsif @shape.is_a? ::Array
164
- Array[@shape.first].shape_of? elem
164
+ Array[@shape].shape_of? elem
165
165
  elsif @shape.is_a? ::Hash
166
166
  Hash[@shape].shape_of? elem
167
167
  elsif @shape.is_a? Class
@@ -175,8 +175,7 @@ module ShapeOf
175
175
  end
176
176
  end
177
177
 
178
- # Hash[key: shape, ...] denotes it is a hash of shapes with a very specific structure.
179
- # Hash (without square brackets) is just a hash with any shape.
178
+ # 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.
180
179
  # This, along with Array, are the core components of this module.
181
180
  # Note that the keys are converted to strings for comparison for both the shape and object provided.
182
181
  class Hash < Shape
@@ -223,7 +222,7 @@ module ShapeOf
223
222
  if @shape[key].respond_to? :shape_of?
224
223
  @shape[key].shape_of? elem
225
224
  elsif @shape[key].is_a? ::Array
226
- Array[@shape[key].first].shape_of? elem
225
+ Array[@shape[key]].shape_of? elem
227
226
  elsif @shape[key].is_a? ::Hash
228
227
  Hash[@shape[key]].shape_of? elem
229
228
  elsif @shape[key].is_a? Class
@@ -243,7 +242,7 @@ module ShapeOf
243
242
  end
244
243
  end
245
244
 
246
- # Union[shape1, shape2, ...] denotes that it can be of one the provided shapes.
245
+ # Union[Shape1, Shape2, ...] denotes that it can be of one the provided shapes
247
246
  class Union < Shape
248
247
  def self.[](*shapes)
249
248
  Class.new(self) do
@@ -281,8 +280,7 @@ module ShapeOf
281
280
  end
282
281
  end
283
282
 
284
- # Optional[shape] denotes that the usual type is a shape, but is optional
285
- # (meaning if it is nil or the key is not present in the Hash, it's still true)
283
+ # 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)
286
284
  class Optional < Shape
287
285
  def self.[](shape)
288
286
  raise TypeError, "Shape cannot be nil" if shape.nil? || shape == NilClass
@@ -301,14 +299,13 @@ module ShapeOf
301
299
  end
302
300
  end
303
301
 
304
- # Anything matches unless key does not exist in the Hash.
305
302
  class Any < Shape
306
303
  def self.shape_of?(object)
307
304
  true
308
305
  end
309
306
  end
310
307
 
311
- # Only passes when the key does not exist in the Hash.
308
+ # Nothing only passes when the key does not exist in the Hash.
312
309
  class Nothing < Shape
313
310
  def self.shape_of?(object)
314
311
  false
@@ -319,12 +316,10 @@ module ShapeOf
319
316
  end
320
317
  end
321
318
 
322
- # Union[Integer, Float, Rational, Complex]
323
319
  Numeric = Union[Integer, Float, Rational, Complex].tap do |this|
324
320
  this.instance_variable_set(:@class_name, this.name.sub(/Union.*/, 'Numeric'))
325
321
  end
326
322
 
327
- # Union[TrueClass, FalseClass]
328
323
  Boolean = Union[TrueClass, FalseClass].tap do |this|
329
324
  this.instance_variable_set(:@class_name, this.name.sub(/Union.*/, 'Boolean'))
330
325
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: shape_of
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.2
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - John Isom
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-05-28 00:00:00.000000000 Z
11
+ date: 2021-05-17 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: minitest