shaped 0.6.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21fd29373698c83855364dd4e9dec36d55d99f5ed4f7c3922d95241f8198dc7b
-  data.tar.gz: 0ec1c71a7d37bc7a6a294f240e9a570a348b1fdee8364fbd405f4d79cd38ddaf
+  metadata.gz: b3fda7351bf12258e204d3b16b43728f2d42daeee4cf67a022ad0b6bb2a46c70
+  data.tar.gz: 72866461bd6422824d424f2593659d89eab25b66f9f834ecec11aae690f4d5fd
 SHA512:
-  metadata.gz: 92f598d534e5162093a978d4787d4f428f874ccacb2390d925dfe66de94e71a8f17933aa2b13ff258d66d15f72a04789e4355c72dc27ef60542cf81d2db5d52c
-  data.tar.gz: cd4a04e7b0485a8e420f017f905b5568eab443482b95b36057cc4a0c0536e01f871363439665936042e52e7a724e9dc69132266e07d7de0993c2a3e84f0fc884
+  metadata.gz: 154eb78ea527ab740be7bea30b6dec6687706707e5c32da17fc68bd0095137d06b6cc18c202358e86967c82fdcb0b983eed25ba19cdffc049138f99f69f18ab7
+  data.tar.gz: 6f94a4300de38ad85718ce7f7e953ebc6ed131bb0a77973633a7bf88ced9db1135fa7d20b64da416f77923f409d13ad16119a3673e58fe295679cbc9e5173e58

data/.rubocop.yml

@@ -1,142 +1,5 @@
-AllCops:
-  EnabledByDefault: true
-  Exclude:
-    - !ruby/regexp /\/db\/migrate/201[1-8].*\.rb\z/
-    # auto-generated files; best to leave as-is
-    - bin/{annotate,brakeman,bundle,database_consistency,pallets,rubocop,sidekiq}
-    - db/schema.rb
-    - lib/tasks/auto_annotate_models.rake
-    - node_modules/**/*
-  TargetRubyVersion: 2.7
-Bundler/GemComment:
-  Enabled: false
-Layout/ArgumentAlignment:
-  EnforcedStyle: with_fixed_indentation
-Layout/ClassStructure:
-  ExpectedOrder:
-      - module_inclusion
-      - constants
-      - public_class_methods
-      - initializer
-      - public_methods
-      - protected_methods
-      - private_methods
-Layout/DotPosition:
-  EnforcedStyle: trailing
-Layout/FirstArgumentIndentation:
-  Enabled: false # this rule doesn't play nicely with the way that I like to use `memoize`
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
-Layout/LineLength:
-  IgnoredPatterns:
-    # ignore line length if the line is a comment without any spaces; it's probably not something we
-    # can fix (e.g. a long file path)
-    - !ruby/regexp /^ *#? [\S]+$/
-  Max: 100
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-Layout/SpaceBeforeBlockBraces:
-  Enabled: false
-Layout/SpaceBeforeSemicolon:
-  Enabled: false
-Layout/SpaceInsideHashLiteralBraces:
-  EnforcedStyle: space
-Lint/RedundantSplatExpansion:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/BlockLength:
-  Enabled: false
-Metrics/ClassLength:
-  Enabled: false
-Metrics/MethodLength:
-  Max: 30
-Naming/RescuedExceptionsVariableName:
-  Enabled: false
-Style/BlockDelimiters:
-  Enabled: false
-Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
-Style/CollectionMethods:
-  Enabled: false
-Style/ConstantVisibility:
-  Enabled: false
-Style/Copyright:
-  Enabled: false
-Style/DisableCopsWithinSourceCodeDirective:
-  Enabled: false
-Style/Documentation:
-  Enabled: false
-Style/DocumentationMethod:
-  Enabled: false
-Style/EmptyCaseCondition:
-  Enabled: false
-Style/FrozenStringLiteralComment:
-  Enabled: true
-Style/GlobalVars:
-  Enabled: false
-Style/GuardClause:
-  Enabled: false
-Style/IfUnlessModifier:
-  Enabled: false
-Style/InlineComment:
-  Enabled: false
-Style/Lambda:
-  Enabled: false
-Style/MethodCallWithArgsParentheses:
-  IgnoredMethods:
-    - add_runtime_dependency
-    - desc
-    - fail
-    - file
-    - gem
-    - head
-    - include
-    - integer
-    - load
-    - p
-    - print
-    - puts
-    - render
-    - require
-    - require_relative
-    - ruby
-    - run
-    - string
-    - source
-Style/MissingElse:
-  Enabled: false
-Style/NegatedIf:
-  Enabled: false
-Style/ImplicitRuntimeError:
-  Enabled: false
-Style/MethodCalledOnDoEndBlock:
-  Enabled: false
-Style/NumericPredicate:
-  Enabled: false
-Style/ParenthesesAroundCondition:
-  Enabled: false
-Style/RescueModifier:
-  Enabled: false
-Style/RescueStandardError:
-  Enabled: false
-Style/ReturnNil:
-  Enabled: false
-Style/RegexpLiteral:
-  Enabled: false
-Style/Semicolon:
-  Enabled: false
-Style/SignalException:
-  Enabled: false
-Style/StderrPuts:
-  Enabled: false
-Style/StringHashKeys:
-  Enabled: false
-Style/TernaryParentheses:
-  Enabled: false
-Style/TrailingCommaInArguments:
-  EnforcedStyleForMultiline: comma
-Style/TrailingCommaInArrayLiteral:
-  EnforcedStyleForMultiline: comma
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: comma
+inherit_gem:
+  runger_style:
+    - rulesets/default.yml # gem 'rubocop'
+    - rulesets/performance.yml # gem 'rubocop-performance'
+    - rulesets/rspec.yml # gem 'rubocop-rspec'

data/.travis.yml

@@ -10,5 +10,5 @@ notifications:
     on_success: never
     on_failure: always
 script:
-  - bin/rubocop $(git ls-tree -r HEAD --name-only) --force-exclusion --format clang
+  - bin/rubocop --format clang
   - bin/rspec

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## v0.7.1 (2020-07-02)
+### Internal
+- Source Rubocop rules/config from `runger_style` gem
+
+## 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)
+
+### Docs
+- Remove explicit `git push` from release instructions
+
+## v0.6.3 (2020-06-21)
+### Docs
+- Add badges for Dependabot status and RubyGems version
+
+## v0.6.2 (2020-06-21)
+### Docs
+- Update README.md and `bin/release` to reflect release via RubyGems
+
 ## v0.6.1 (2020-06-20)
 ### Docs
 - Add Travis build status badge to README.md
@@ -77,7 +107,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

@@ -5,10 +5,15 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in shaped.gemspec
 gemspec
 
-gem 'amazing_print'
-gem 'pry-byebug'
-gem 'rake'
-gem 'rubocop'
+group :development, :test do
+  gem 'amazing_print'
+  gem 'pry-byebug'
+  gem 'rake'
+  gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'runger_style', github: 'davidrunger/runger_style', require: false
+end
 
 group :test do
   gem 'codecov', require: false

data/Gemfile.lock

@@ -7,10 +7,16 @@ GIT
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
 
+GIT
+  remote: https://github.com/davidrunger/runger_style.git
+  revision: 6aef7c7978c9b5306e518c18a067e2fdad2c8da1
+  specs:
+    runger_style (0.2.1)
+
 PATH
   remote: .
   specs:
-    shaped (0.6.1)
+    shaped (0.7.1)
       activemodel (~> 6.0)
       activesupport (~> 6.0)
 
@@ -61,9 +67,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)
@@ -71,7 +77,7 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     rainbow (3.0.0)
-    rake (12.3.3)
+    rake (13.0.1)
     rb-fsevent (0.10.4)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -90,17 +96,21 @@ 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)
       parser (>= 2.7.0.1)
+    rubocop-performance (1.6.1)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.40.0)
+      rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
     shellany (0.0.1)
     simplecov (0.18.5)
@@ -113,7 +123,7 @@ GEM
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
     url (0.3.2)
-    zeitwerk (2.3.0)
+    zeitwerk (2.3.1)
 
 PLATFORMS
   ruby
@@ -126,6 +136,9 @@ DEPENDENCIES
   rake
   rspec
   rubocop
+  rubocop-performance
+  rubocop-rspec
+  runger_style!
   shaped!
 
 BUNDLED WITH

data/README.md

@@ -1,5 +1,7 @@
 [![codecov](https://codecov.io/gh/davidrunger/shaped/branch/master/graph/badge.svg)](https://codecov.io/gh/davidrunger/shaped)
 [![Build Status](https://travis-ci.com/davidrunger/shaped.svg?branch=master)](https://travis-ci.com/davidrunger/shaped)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=davidrunger/shaped)](https://dependabot.com)
+[![Gem Version](https://badge.fury.io/rb/shaped.svg)](https://badge.fury.io/rb/shaped)
 
 # Shaped
 
@@ -19,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-->
 
@@ -41,11 +45,10 @@ useful), but for now supporting `active_actions` is `shaped`'s *raison d'être*.
 
 # Installation
 
-Add the gem to your application's `Gemfile`. Because the gem is not released via RubyGems, you will
-need to install it from GitHub.
+Add the gem to your application's `Gemfile`:
 
 ```rb
-gem 'shaped', git: 'https://github.com/davidrunger/shaped.git'
+gem 'shaped'
 ```
 
 And then execute:
@@ -55,11 +58,10 @@ $ bundle install
 ```
 
 If you want to install the gem on your system independent of a project with a `Gemfile`, then you
-can easily do so via [`specific_install`](https://github.com/rdp/specific_install):
+can execute
 
 ```
-$ gem install specific_install
-$ gem specific_install davidrunger/shaped
+$ gem install shaped
 ```
 
 # Usage
@@ -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
@@ -358,8 +392,8 @@ To release a new version:
 3. update the version number in `version.rb`
 4. `bundle install` (which will update `Gemfile.lock`)
 5. commit the changes with a message like `Prepare to release v0.1.1`
-6. push the changes to `origin/master` (GitHub) via `git push`
-7. run `bin/release`, which will create a git tag for the version and push git commits and tags
+6. run `bin/release` (which will create a git tag for the version, push git commits and
+   tags to GitHub, and push the gem to RubyGems)
 
 # License
 

data/bin/_guard-core

@@ -17,7 +17,7 @@ ENV['BUNDLE_GEMFILE'] ||= File.expand_path(
 bundle_binstub = File.expand_path('bundle', __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/guard

@@ -17,7 +17,7 @@ ENV['BUNDLE_GEMFILE'] ||= File.expand_path(
 bundle_binstub = File.expand_path('bundle', __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.

data/bin/release

@@ -13,4 +13,4 @@ if ! [[ $COMMIT_MESSAGE =~ ^Prepare[[:space:]]to[[:space:]]release[[:space:]]v[0
   exit 1;
 fi
 
-bundle exec rake build release:guard_clean release:source_control_push
+bundle exec rake release

data/bin/rspec

@@ -18,7 +18,7 @@ ENV['BUNDLE_GEMFILE'] ||=
 bundle_binstub = File.expand_path('bundle', __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
     load(bundle_binstub)
   else
     abort(<<~ERROR)

data/bin/rubocop

@@ -14,7 +14,7 @@ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE_
 bundle_binstub = File.expand_path('bundle', __dir__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
     load(bundle_binstub)
   else
     abort(<<~ERROR)

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
@@ -27,8 +27,10 @@ module Shaped
         end
 
       case shape_description
+      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/hash.rb

@@ -12,9 +12,6 @@ class Shaped::Shapes::Hash < Shaped::Shape
   def matched_by?(hash)
     return false if !hash.is_a?(Hash)
 
-    missing_keys = expected_keys - hash.keys
-    return false if missing_keys.any?
-
     @hash_description.all? do |key, expected_value_shape|
       expected_value_shape.matched_by?(hash[key])
     end
@@ -28,10 +25,4 @@ class Shaped::Shapes::Hash < Shaped::Shape
 
     "{ #{printable_shape_description} }"
   end
-
-  private
-
-  def expected_keys
-    @hash_description.keys
-  end
 end

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.1'
+  VERSION = '0.7.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shaped
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.1
 platform: ruby
 authors:
 - David Runger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-22 00:00:00.000000000 Z
+date: 2020-07-02 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