value_semantics 3.0.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b538b4f5ab14c310ffdbc26ccb92cb9b47806126d0bc77ef466e2d9e7d64fcb
-  data.tar.gz: 85a0542f08c4a832b21acf75a697f999b7eae42f6a8989ae8c1d17838b76fd8a
+  metadata.gz: 9917cde0bb66e10e931d39308a1d968973e10f5de4b60b15898cb3d390f77fb9
+  data.tar.gz: b9ab7670cc254252d357a8276c1fb98305e9c3e60634354883e078179bad7b03
 SHA512:
-  metadata.gz: 3f869be70a14418aa6247cca5222e53aed3bc7d4b506f1231e4f010b382cd962d08558a92506b47817600acca04d0f5cad1c4f9375ca6c249042ada9ea709fb3
-  data.tar.gz: 3c26016b77c88eb8ae851dadaf2853eb0792beb68a8dfb2961dca77d2b98414e6ba4f31ba0141a23544fb18dfcc73425cc9f1737df6539933e1b815a6037f564
+  metadata.gz: 40c1a0ef2a51f2e18465013660a71ca3dbd50fd615dd1e0e7dd4e6e0a65ba3fc5f742132b62467178dad75f5e14452d8ebc38742fa8928254baad8709e89dfd6
+  data.tar.gz: 9d1eebc8605d6aed14be4eb0fec9fb78f7eca69894e3ee3d79c34a8c41763542b4a8ffc8fd57eba2848735b0732286d8cacbb46a64d509c5fe89a519c06afbe3

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+Notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [3.3.0] - 2020-07-17
+### Added
+- Added support for pattern matching in Ruby 2.7
+
+## [3.2.1] - 2020-07-11
+### Fixed
+- Fix warnings new to Ruby 2.7 about keyword arguments
+
+## [3.2.0] - 2019-09-30
+### Added
+- `ValueSemantics::Struct`, a convenience for creating a new class and mixing
+  in ValueSemantics in a single step.
+
+## [3.1.0] - 2019-06-30
+### Added
+- Built-in PP support for value classes
+
+## [3.0.0] - 2019-01-27
+
+First public release

data/README.md

@@ -1,19 +1,24 @@
 [![Gem Version](https://badge.fury.io/rb/value_semantics.svg)](https://badge.fury.io/rb/value_semantics)
 [![Build Status](https://travis-ci.org/tomdalling/value_semantics.svg?branch=master)](https://travis-ci.org/tomdalling/value_semantics)
-![Mutation Coverage](https://img.shields.io/badge/mutation%20coverage-100%25-brightgreen.svg)
+![Mutation Coverage](https://img.shields.io/badge/mutation%20coverage-to%20the%20MAX-brightgreen.svg)
 
 ValueSemantics
 ==============
 
-Create value classes quickly, with all the [conventions of a good value object](https://github.com/zverok/good-value-object).
+A gem for making value classes.
 
-Generates modules that provide value semantics for a given set of attributes.
-Provides the behaviour of an immutable struct-like value class,
-with light-weight validation and coercion.
+Generates modules that provide [conventional value semantics](https://github.com/zverok/good-value-object) for a given set of attributes.
+The behaviour is similar to an immutable `Struct` class,
+plus extensible, lightweight validation and coercion.
 
 These are intended for internal use, as opposed to validating user input like ActiveRecord.
-Invalid or missing attributes cause an exception intended for developers,
-not an error message intended for the user.
+Invalid or missing attributes cause an exception for developers,
+not an error message intended for application users.
+
+See the [announcement blog post][] for some of the rationale behind the gem, and some [discussion on Reddit].
+
+[announcement blog post]: https://www.rubypigeon.com/posts/value-semantics-gem-for-making-value-classes/
+[discussion on Reddit]: https://www.reddit.com/r/ruby/comments/akz4fs/valuesemanticsa_gem_for_making_value_classes/
 
 
 Defining and Creating Value Objects
@@ -96,6 +101,15 @@ other_tom = Person.new(name: 'Tom', age: 31)
 tom == other_tom  #=> true
 tom.eql?(other_tom)  #=> true
 tom.hash == other_tom.hash  #=> true
+
+
+#
+# Ruby 2.7+ pattern matching
+#
+case tom
+in { name: "Tom", age: }
+  puts age  # outputs: 31
+end
 ```
 
 
@@ -299,6 +313,21 @@ For example, the default value could be a string,
 which would then be coerced into an `IPAddr` object.
 
 
+## ValueSemantics::Struct
+
+This is a convenience for making a new class and including ValueSemantics in
+one step, similar to how `Struct` works from the Ruby standard library. For
+example:
+
+```ruby
+Cat = ValueSemantics::Struct.new do
+  name String, default: "Mittens"
+end
+
+Cat.new.name #=> "Mittens"
+```
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -321,6 +350,7 @@ Or install it yourself as:
 Bug reports and pull requests are welcome on GitHub at:
 https://github.com/tomdalling/value_semantics
 
+Keep in mind that this gem aims to be as close to 100% backwards compatible as possible.
 
 ## License
 

data/lib/value_semantics.rb

@@ -139,6 +139,20 @@ module ValueSemantics
 
       "#<#{self.class} #{attrs}>"
     end
+
+    def pretty_print(pp)
+      pp.object_group(self) do
+        to_h.each do |attr, value|
+          pp.breakable
+          pp.text("#{attr}=")
+          pp.pp(value)
+        end
+      end
+    end
+
+    def deconstruct_keys(_)
+      to_h
+    end
   end
 
   #
@@ -284,13 +298,13 @@ module ValueSemantics
       ArrayOf.new(element_validator)
     end
 
-    def def_attr(*args)
-      __attributes << Attribute.define(*args)
+    def def_attr(*args, **kwargs)
+      __attributes << Attribute.define(*args, **kwargs)
     end
 
-    def method_missing(name, *args)
+    def method_missing(name, *args, **kwargs)
       if respond_to_missing?(name)
-        def_attr(name, *args)
+        def_attr(name, *args, **kwargs)
       else
         super
       end
@@ -356,4 +370,22 @@ module ValueSemantics
     end
   end
 
+  #
+  # ValueSemantics equivalent of the Struct class from the Ruby standard
+  # library
+  #
+  class Struct
+    #
+    # Creates a new Class with ValueSemantics mixed in
+    #
+    # @yield a block containing ValueSemantics DSL
+    # @return [Class] the newly created class
+    #
+    def self.new(&block)
+      klass = Class.new
+      klass.include(ValueSemantics.for_attributes(&block))
+      klass
+    end
+  end
+
 end

data/lib/value_semantics/version.rb

@@ -1,3 +1,3 @@
 module ValueSemantics
-  VERSION = "3.0.0"
+  VERSION = "3.3.0"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: value_semantics
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Tom Dalling
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2019-01-27 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.15'
 - !ruby/object:Gem::Dependency
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: mutant-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,32 +94,28 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: "\n    Create value classes quickly, with all the proper conventions.\n\n
-  \   Generates modules that provide value semantics for a given set of attributes.\n
-  \   Provides the behaviour of an immutable struct-like value class,\n    with light-weight
-  validation and coercion.\n  "
+description: "\n    Generates modules that provide conventional value semantics for
+  a given set of attributes.\n    The behaviour is similar to an immutable `Struct`
+  class,\n    plus extensible, lightweight validation and coercion.\n  "
 email:
 - tom@tomdalling.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
-- bin/console
-- bin/setup
-- bin/test
 - lib/value_semantics.rb
 - lib/value_semantics/version.rb
-- value_semantics.gemspec
 homepage: https://github.com/tomdalling/value_semantics
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/tomdalling/value_semantics/issues
+  changelog_uri: https://github.com/tomdalling/value_semantics/blob/master/CHANGELOG.md
+  documentation_uri: https://github.com/tomdalling/value_semantics/blob/v3.3.0/README.md
+  source_code_uri: https://github.com/tomdalling/value_semantics
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -135,8 +131,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
-summary: Create value classes quickly, with all the proper conventions.
+summary: Makes value classes, with lightweight validation and coercion.
 test_files: []

data/.gitignore

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

data/.rspec

@@ -1,2 +0,0 @@
---format documentation
---color

data/.travis.yml

@@ -1,24 +0,0 @@
-language: ruby
-script: bin/test
-
-# test old Ruby versions WITHOUT mutation testing
-rvm:
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-env: MUTATION_TEST=false
-
-# test the latest Ruby version WITH mutation testing
-matrix:
-  include:
-  - rvm: 2.6.0
-    env: MUTATION_TEST=true
-
-# deploy gem on tagged commits, on the latest Ruby version only
-deploy:
-  provider: rubygems
-  on:
-    tags: true
-    env: MUTATION_TEST=true
-  api_key:
-    secure: nL74QuUczEpA0qbhSBN2zjGdviWgKB3wR6vFvwervv1MZNWmwOQUYe99Oq9kPeyc8/x2MR/H6PQm5qbrk/WAfRede01WxlZ/EBUW+9CYGrxcBsGONx9IULO8A0I8/yN/YJHW2vjo3dfR66EwVsXTVWq8U63PRRcwJIyTqnIiUm2sxauMQoPRBbXG+pD9v/EJSn3ugpdtxp0lVYDn8LDKk5Ho4/wbpY4ML11XUJa9mz9CyR/GsAzdy5FTXaDMOwuWOVEx9cab7m4qPOBhmlJY4TrmooFpxTxRwChcvByjq1IboEd2M3RT5on7Q/xDTlHSOuT0OS8mnS2AocGT4a1gC+W/xOlghgEcN+xs2V5mfucR6+iUYlCy32uz1w3ey7T2X5xN4ubut09r1xLi7eu1NisAoAc+GOJ4TIxQNqkeRhY4X/fs8j7SMfOEMDr6pPxSLKZxgSvExt+IbdcZD/uQ7rTBQkadYCbc9MX5dHazBievmar3ZsFffbIf+n13FVDXsaPgRt7DlFM5dqGrEwVwt1jFRhdFuDCjkj4QWOLn7E1uY3XqgrqGvgUBlF8Znwc6qicW8zxV4SIWhqIzCOH6L9WIZGLHNq0remoCd9sq9Ter9av3jL+6UmZRRAr+JceeZfZmsYIXKomECzleM9FXMx7FXlpjJKOlf3JnrfeCTwI=

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in the gemspec
-gemspec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "value_semantics"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/bin/test

@@ -1,19 +0,0 @@
-#!/bin/bash
-set -ue
-
-MUTANT_PATTERN=${1:-ValueSemantics*}
-
-# if $MUTATION_TEST is false, just run RSpec
-if [[ "${MUTATION_TEST:-true}" == "false" ]] ; then
-    bundle exec rspec
-else
-    bundle exec mutant \
-        --include lib \
-        --require value_semantics \
-        --use rspec "$MUTANT_PATTERN" \
-        # Mutant 0.8.24 introduces new mutations that cause infinite recursion inside
-        # #method_missing. These --ignore-subject lines prevent that from happening
-        #--ignore-subject "ValueSemantics::DSL#method_missing" \
-        #--ignore-subject "ValueSemantics::DSL#respond_to_missing?" \
-        #--ignore-subject "ValueSemantics::DSL#def_attr" \
-fi

data/value_semantics.gemspec

@@ -1,36 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "value_semantics/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "value_semantics"
-  spec.version       = ValueSemantics::VERSION
-  spec.authors       = ["Tom Dalling"]
-  spec.email         = [["tom", "@", "tomdalling.com"].join]
-
-  spec.summary       = %q{Create value classes quickly, with all the proper conventions.}
-  spec.description   = %q{
-    Create value classes quickly, with all the proper conventions.
-
-    Generates modules that provide value semantics for a given set of attributes.
-    Provides the behaviour of an immutable struct-like value class,
-    with light-weight validation and coercion.
-  }
-  spec.homepage      = "https://github.com/tomdalling/value_semantics"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rspec", "~> 3.7.0"
-  spec.add_development_dependency "mutant-rspec"
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "byebug"
-  spec.add_development_dependency "gem-release"
-end