shaped 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21fd29373698c83855364dd4e9dec36d55d99f5ed4f7c3922d95241f8198dc7b
+  data.tar.gz: 0ec1c71a7d37bc7a6a294f240e9a570a348b1fdee8364fbd405f4d79cd38ddaf
+SHA512:
+  metadata.gz: 92f598d534e5162093a978d4787d4f428f874ccacb2390d925dfe66de94e71a8f17933aa2b13ff258d66d15f72a04789e4355c72dc27ef60542cf81d2db5d52c
+  data.tar.gz: cd4a04e7b0485a8e420f017f905b5568eab443482b95b36057cc4a0c0536e01f871363439665936042e52e7a724e9dc69132266e07d7de0993c2a3e84f0fc884

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,142 @@
+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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/.travis.yml

@@ -0,0 +1,14 @@
+---
+language: ruby
+os: linux
+dist: bionic
+cache: bundler
+rvm:
+  - 2.7.0
+notifications:
+  email:
+    on_success: never
+    on_failure: always
+script:
+  - bin/rubocop $(git ls-tree -r HEAD --name-only) --force-exclusion --format clang
+  - bin/rspec

data/CHANGELOG.md

@@ -0,0 +1,135 @@
+## v0.6.1 (2020-06-20)
+### Docs
+- Add Travis build status badge to README.md
+
+## v0.6.0 (2020-06-19)
+### Fixed
+- Fix bug that would occur in the `Shaped::Shape(...)` constructor when provided with a falsy first
+  argument.
+
+## v0.5.8 (2020-06-19)
+### Docs
+- Document ActiveModel-style validations (which are available for `Shaped::Shapes::Class`)
+
+## v0.5.7 (2020-06-19)
+### Docs
+- Wrap lines in README.md to a max of 100 characters
+
+## v0.5.6 (2020-06-19)
+### Docs
+- Add a table of contents to README.md
+
+## v0.5.5 (2020-06-19)
+### Docs
+- Add `require 'shaped'` to first example in README.md
+
+## v0.5.4 (2020-06-19)
+### Specs
+- Fix typo in test (`@number.event?` => `@number.even?`)
+
+## v0.5.3 (2020-06-19)
+### Docs
+- Fill out the "Usage" section of README.md
+
+## v0.5.2 (2020-06-19)
+### Docs
+- Don't say in installation instructions to list gem in test section of Gemfile.
+
+## v0.5.1 (2020-06-19)
+### Docs
+- Update description(s) to reflect broadened scope of the gem
+
+## v0.5.0 (2020-06-19)
+### Added
+- Add a `Shaped::Shapes::Callable` shape, which is a shape that is defined by any object that
+  responds to `#call` (e.g. a proc or an instance of a class that defines a `#call` instance
+  method). This allows for essentially total flexibility in defining/describing the "shape" of an
+  object.
+
+## v0.4.0 (2020-06-18)
+### Added
+- Add the ability to specify ActiveModel-style validations for `Shaped::Shape::Class`es
+
+## v0.3.2 (2020-06-18)
+### Tests
+- Add tests for invalid `Array` and `Or` shape definitions
+
+## v0.3.1 (2020-06-18)
+### Maintenance
+- Added test coverage tracking via `simplecov` and `codecov`
+
+## 0.3.0 - 2020-06-18
+### Breaking changes
+- Major refactor! See details below.
+
+### Removed
+- Remove detailed descriptions of errors ("match failure reasons")
+- Remove `Array` and `Hash` refinements (`#has_shape?`)
+- Removed `Shaped::Array(...)` and `Shaped::Hash(...)` constructor methods. Now, all shapes are
+  created via a single, unified `Shaped::Shape(...)` method that determines which type of shape to
+  build based on the class of the argument.
+- Removed `Shaped.lax_mode` and `Shaped.strict_mode` settings. What was previously called `lax_mode`
+  is now the default, meaning that an empty array will always be considered to match any
+  `Shaped::Shapes::Array`.
+
+### Added
+- Added new shape/matcher types (plus preexisting but relocated `Shaped::Shapes::Array` and
+  `Shaped::Shapes::Hash`):
+  1. `Shaped::Shapes::Class`
+  2. `Shaped::Shapes::Equality`
+  3. `Shaped::Shapes::Or`
+- All hashes and arrays in shape definitions are parsed "recursively" as shape definitions. For
+  example, instead of:
+
+```rb
+Shaped::Array([
+  Shaped::Hash(
+    name: String,
+    emails: Shaped::Hash(
+      personal: Shaped::Array([String]),
+      work: Shaped::Array([String]),
+    ),
+    favorite_numbers: Shaped::Array([Numeric]),
+  ),
+])
+```
+
+...one can now simply do:
+
+```rb
+Shaped::Array([
+  {
+    name: String,
+    emails: {
+      personal: [String],
+      work: [String],
+    },
+    favorite_numbers: [Numeric],
+  }
+])
+```
+
+### Dependencies
+- Added `activesupport` as a dependency
+
+## 0.2.1 - 2020-06-16
+### Changed
+- Rename `Shaped::Array#descriptor` and `Shaped::Hash#descriptor` methods to `#to_s`
+
+## 0.2.0 - 2020-06-16
+### Added
+- Add `Shaped::Array` method and class
+- Add `Array` refinement
+- Add `Shaped::MatchFailureReason` and `Shaped::Array#match_failure_reason`
+- Add `Shaped::Hash` method and class
+- Add `Hash` refinement
+- Allow composing Hash and Array shape matchers together
+
+### Fixed
+- Fix potential memory leak in long-lived `Shaped::Array` instances
+
+### Tests
+- Move `Shaped::Array#match_failure_reason` specs to the correct file
+
+## 0.1.0 - 2020-06-16
+- Initial release of Shaped! Validate the shape of Ruby hashes and/or arrays.

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shaped.gemspec
+gemspec
+
+gem 'amazing_print'
+gem 'pry-byebug'
+gem 'rake'
+gem 'rubocop'
+
+group :test do
+  gem 'codecov', require: false
+  gem 'guard-espect', require: false, github: 'davidrunger/guard-espect'
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,132 @@
+GIT
+  remote: https://github.com/davidrunger/guard-espect.git
+  revision: 8d7f8594d120f4fa815eb20d79aeb962af8e83df
+  specs:
+    guard-espect (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+
+PATH
+  remote: .
+  specs:
+    shaped (0.6.1)
+      activemodel (~> 6.0)
+      activesupport (~> 6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    amazing_print (1.2.1)
+    ast (2.4.1)
+    byebug (11.1.3)
+    codecov (0.1.17)
+      json
+      simplecov
+      url
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    ffi (1.13.1)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    json (2.3.0)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.5)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.19.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.85.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.0.3)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    shellany (0.0.1)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    url (0.3.2)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  amazing_print
+  codecov
+  guard-espect!
+  pry-byebug
+  rake
+  rspec
+  rubocop
+  shaped!
+
+BUNDLED WITH
+   2.1.2