Skip to content

Latest commit

 

History

History
210 lines (165 loc) · 5.67 KB

CHANGELOG.md

File metadata and controls

210 lines (165 loc) · 5.67 KB
Raw

Unreleased

[no unreleased changes yet]

v0.14.0 (2024-11-08)

  • Remove upper bounds on versions for all dependencies

v0.13.0 (2024-06-28)

  • Enforce only major and minor parts of required Ruby version (loosening the required Ruby version from 3.3.3 to 3.3.0)

v0.12.0 (2024-06-15)

  • Rename primary branch from master to main

v0.11.0 (2024-03-08)

[no unreleased changes yet]

v0.10.0 (2023-05-04)

[no unreleased changes yet]

v0.9.0 (2022-06-13)

[no unreleased changes yet]

v0.8.2 (2021-02-01)

Internal

  • Update release_assistant

v0.8.1 (2021-02-01)

Internal

  • Use release_assistant gem to manage the release process

v0.8.0 (2021-01-31)

Added

  • Accept Method as a Callable shape definition

Internal

  • Bump Ruby version from 2.7.0 to 2.7.2
  • Move from Travis to GitHub Actions

v0.7.3 (2021-01-07)

Removed

  • Removed ::name method for anonymous validator class in Shaped::Shapes::Class

v0.7.2 (2020-07-13)

Dependencies

  • Bump rubocop to 0.88.0 and runger_style to 0.2.3

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

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::Classes

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::Any
  • All hashes and arrays in shape definitions are parsed "recursively" as shape definitions. For example, instead of:
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:

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.