shaped 0.6.4 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f6ca9518d2b3b0b55988f53d055a48c1344c54d6c8f8497877fb48e8ad621e1
-  data.tar.gz: c7e2be555928b918681670b803ea95b70ad97da25f0b4079be7fa6f16c4f6892
+  metadata.gz: 6243debb70327afd9840f95f340bafd00f2de355e247bba0c6f16f3328c11e6b
+  data.tar.gz: b993c1b5252874d7d76c845bac27331eacf6de59f24b5f6aa8da2e8caa5ff1c1
 SHA512:
-  metadata.gz: 59c995d6a92d07d29b87a565924dbd175f8bce9e7ce158bdc98cf450aa5fb8e5073f78e6eeea5be0a140045e838e3562da9a2562a3263666dceeac23b7ac0368
-  data.tar.gz: 4c3b1e10af00279e075c7094a06b07b8624f3fc165fcea3704db18a5d52ec48b58bf9a8dffd31320465f2bad598d820f193f901be9bbe7f29e2852e7d8eda5a3
+  metadata.gz: 0feed58b9c6ac20113a75ec9d560b69102a8240e192b6ce353d6a2da2e82ca01b9aa6d80422ad0565e3a367537c2bb8de9fe10c7242969a8f56a0ff8cabe824a
+  data.tar.gz: 2dff65af38ece59c0ad34309f8111606cbc7bee03a5be912561965f0e8557eef5253d50d872317a8d0a97669c8a0c98b4906ca57696d194c8d293fa0e37eb005

data/.rubocop.yml

@@ -41,6 +41,8 @@ Layout/SpaceBeforeSemicolon:
   Enabled: false
 Layout/SpaceInsideHashLiteralBraces:
   EnforcedStyle: space
+Lint/ConstantResolution:
+  Enabled: false
 Lint/RedundantSplatExpansion:
   Enabled: false
 Metrics/AbcSize:

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## v0.7.0 (2020-06-24)
+### BREAKING CHANGES
+- Rename the `Or` shape to `Any`
+- Add a `Method` shape (where the shape description is the name of a method which, when called on a
+  test object, must return a truthy value). This is a breaking change because the `Shaped::Shape`
+  constructor will now return an instance of `Shaped::Shapes::Method` rather than
+  `Shaped::Shapes::Equality` when called with a Symbol argument.
+
+### Added
+- Add an `All` shape (w/ multiple sub-shapes, all of which must be matched)
+
 ## v0.6.4 (2020-06-22)
 ### Fixed
 - Make it possible to specify optional keys in a Hash shape (using an `Or` shape as the value)
@@ -92,7 +103,7 @@
   `Shaped::Shapes::Hash`):
   1. `Shaped::Shapes::Class`
   2. `Shaped::Shapes::Equality`
-  3. `Shaped::Shapes::Or`
+  3. `Shaped::Shapes::Any`
 - All hashes and arrays in shape definitions are parsed "recursively" as shape definitions. For
   example, instead of:
 

data/Gemfile.lock

@@ -10,7 +10,7 @@ GIT
 PATH
   remote: .
   specs:
-    shaped (0.6.4)
+    shaped (0.7.0)
       activemodel (~> 6.0)
       activesupport (~> 6.0)
 
@@ -61,9 +61,9 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.19.1)
-    parser (2.7.1.3)
-      ast (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -90,13 +90,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
-    rubocop (0.85.1)
+    rubocop (0.86.0)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.0.3)
+      rubocop-ast (>= 0.0.3, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-ast (0.0.3)

data/README.md

@@ -21,15 +21,17 @@ Validate the "shape" of Ruby objects!
       * [Shaped::Shapes::Array](#shapedshapesarray)
       * [Shaped::Shapes::Class](#shapedshapesclass)
          * [ActiveModel validations](#activemodel-validations)
+      * [Shaped::Shapes::Method](#shapedshapesmethod)
       * [Shaped::Shapes::Callable](#shapedshapescallable)
       * [Shaped::Shapes::Equality](#shapedshapesequality)
-      * [Shaped::Shapes::Or](#shapedshapesor)
+      * [Shaped::Shapes::Any](#shapedshapesany)
+      * [Shaped::Shapes::All](#shapedshapesall)
       * [#to_s](#to_s)
    * [Development](#development)
    * [For maintainers](#for-maintainers)
    * [License](#license)
 
-<!-- Added by: david, at: Fri Jun 19 21:29:30 PDT 2020 -->
+<!-- Added by: david, at: Wed Jun 24 13:56:49 PDT 2020 -->
 
 <!--te-->
 
@@ -91,7 +93,7 @@ types (all of which inherit from `Shaped::Shape`):
 1. `Shaped::Shapes::Class`
 1. `Shaped::Shapes::Callable`
 1. `Shaped::Shapes::Equality`
-1. `Shaped::Shapes::Or`
+1. `Shaped::Shapes::Any`
 
 Examples illustrating the use of each shape type are below.
 
@@ -204,6 +206,21 @@ shape.matched_by?('a@b.c') # too short
 # => false
 ```
 
+## Shaped::Shapes::Method
+
+This shape allows specifying a method name that, when called upon a test object, must return a
+truthy value in order for `matched_by?` to be true.
+
+```rb
+shape = Shaped::Shape(:odd?)
+
+shape.matched_by?(55)
+# => true
+
+shape.matched_by?(60)
+# => false
+```
+
 ## Shaped::Shapes::Callable
 
 This shape is very powerful if you need a very customized shape definition; you can define any
@@ -282,7 +299,7 @@ shape.matched_by?(verification_code: '321cba', new_role: 'SuperAdmin')
 # => false
 ```
 
-## Shaped::Shapes::Or
+## Shaped::Shapes::Any
 
 This shape is used behind the scenes to build "compound matchers", such as an Array shape that
 allows multiple different classes:
@@ -299,7 +316,7 @@ shape.matched_by?([0.333, 55])
 # => false
 ```
 
-You can build an `Or` shape by invoking the `Shaped::Shape` constructor with more than one argument.
+You can build an `Any` shape by invoking the `Shaped::Shape` constructor with more than one argument.
 Below is a (rather artificial) example illustrating this. To match this `shape`, an object must be
 either greater than zero OR an Integer (or both).
 
@@ -316,6 +333,23 @@ shape.matched_by?(-11.5) # it's neither greater than 0 nor an Integer
 # => false
 ```
 
+## Shaped::Shapes::All
+
+This shape can be used to combine multiple checks, all of which must be true for a test object in
+order for `#matched_by?` to be true:
+
+```rb
+shape = Shaped::Shapes::All.new(Numeric, ->(number) { number.even? })
+shape.to_s
+# => "Numeric AND Proc test defined at (eval):10"
+
+shape.matched_by?(22) # 22 is both a Numeric and `#even?`
+# => true
+
+shape.matched_by?(33) # 33 is a Numeric but it's not `#even?`
+# => false
+```
+
 ## `#to_s`
 
 Each Shape type implements a `#to_s` instance method that aims to provide a relatively clear

data/lib/shaped.rb

@@ -13,7 +13,7 @@ module Shaped
   def self.Shape(*shape_descriptions)
     validation_options = shape_descriptions.extract_options!
     if shape_descriptions.size >= 2
-      Shaped::Shapes::Or.new(*shape_descriptions, validation_options)
+      Shaped::Shapes::Any.new(*shape_descriptions, validation_options)
     else
       # If the shape_descriptions argument list was just one hash, then `extract_options!` would
       # have removed it, making `shape_descriptions` an empty array, so we need to "restore" the
@@ -30,6 +30,7 @@ module Shaped
       when Shaped::Shape then shape_description
       when Hash then Shaped::Shapes::Hash.new(shape_description)
       when Array then Shaped::Shapes::Array.new(shape_description)
+      when Symbol then Shaped::Shapes::Method.new(shape_description)
       when Class then Shaped::Shapes::Class.new(shape_description, validation_options)
       else
         if shape_description.respond_to?(:call)

data/lib/shaped/shapes/all.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class Shaped::Shapes::All < Shaped::Shape
+  def initialize(*shape_descriptions)
+    validation_options = shape_descriptions.extract_options!
+    if shape_descriptions.size <= 1
+      raise(Shaped::InvalidShapeDescription, <<~ERROR.squish)
+        A #{self.class} description must be a list of two or more shape descriptions.
+      ERROR
+    end
+
+    @shapes =
+      shape_descriptions.map do |description|
+        Shaped::Shape(description, validation_options)
+      end
+  end
+
+  def matched_by?(object)
+    @shapes.all? { |shape| shape.matched_by?(object) }
+  end
+
+  def to_s
+    @shapes.map(&:to_s).join(' AND ')
+  end
+end

data/lib/shaped/shapes/{or.rb → any.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class Shaped::Shapes::Or < Shaped::Shape
+class Shaped::Shapes::Any < Shaped::Shape
   def initialize(*shape_descriptions)
     validation_options = shape_descriptions.extract_options!
     if shape_descriptions.size <= 1

data/lib/shaped/shapes/method.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Shaped::Shapes::Method < Shaped::Shape
+  def initialize(method_name)
+    @method_name = method_name
+  end
+
+  def matched_by?(object)
+    !!object.public_send(@method_name)
+  end
+
+  def to_s
+    "object returning truthy for ##{@method_name}"
+  end
+end

data/lib/shaped/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shaped
-  VERSION = '0.6.4'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shaped
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.0
 platform: ruby
 authors:
 - David Runger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -65,12 +65,14 @@ files:
 - bin/setup
 - lib/shaped.rb
 - lib/shaped/shape.rb
+- lib/shaped/shapes/all.rb
+- lib/shaped/shapes/any.rb
 - lib/shaped/shapes/array.rb
 - lib/shaped/shapes/callable.rb
 - lib/shaped/shapes/class.rb
 - lib/shaped/shapes/equality.rb
 - lib/shaped/shapes/hash.rb
-- lib/shaped/shapes/or.rb
+- lib/shaped/shapes/method.rb
 - lib/shaped/version.rb
 - shaped.gemspec
 homepage: https://github.com/davidrunger/shaped