portrayal 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbd0b561e866c45f6e850b592620df78d4573635165807cd2284ab45baed9e0c
-  data.tar.gz: 699be912aa836a55faa10886a3a1c1bb7b17c006f1db445694660d2fbe0ec0f4
+  metadata.gz: 6e6b15fe5bee4f60e8369a839ecad908c35bdbba34559e324f71c3a8404586ad
+  data.tar.gz: 279dc9030eea091d806fa9e02178783d02063c6efc731bc601a48a68e50f8281
 SHA512:
-  metadata.gz: 58fc168ad299aee9555ec7e1a1355f533c65af5ff1620095a7e49829252b39e92f45714083cc03fd1cde2ccc027acabd98b3526618caae07fb226be7e294694b
-  data.tar.gz: 8d59938b7bdcc5b9a32683695b6146186cb12bf6132326ecfff5b01685b7740dbf78ef513a43fbf5ff58716c38848881229600e4eb2f059dc13efc530120d68d
+  metadata.gz: a3c414e415b48127c4f86ee41b7b5d0eed7730ea7316c356afa533f539acd42bdf70c08e1c64f78ddd7ba444da47f4069dbdf8716d42592a8d1b15ec38ca7ff4
+  data.tar.gz: 2fdab00d88f76ae116af03e14d883346797cf60c21ab0569823f6dd869f3efe368db1b9b2d1e41548619e1666de8acf38d555647a2e29270f0c35e6e512d7aa8

data/.github/workflows/rspec.yml

@@ -1,24 +1,18 @@
 name: RSpec
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
+on: [push, pull_request]
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        ruby: [ '2.4', '2.5', '2.6', '2.7' ]
+        ruby: [ '2.4', '2.5', '2.6', '2.7', '3.0', '3.2' ]
 
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-      - run: gem install bundler
-      - run: bundle install
+          bundler-cache: true
       - run: bundle exec rake

data/CHANGELOG.md

@@ -2,6 +2,31 @@ This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
+## 0.8.0 - 2023-01-27
+
+* Add pattern matching support (`#deconstruct` and `#deconstruct_keys`).
+
+## 0.7.1 - 2021-03-22
+
+* Fix default procs' behavior when overriding keywords in subclasses. Portrayal relies on an ordered ruby hash to initialize keywords in the correct order. However, if overriding the same keyword in a subclass (by declaring it again), it didn't move keyword to the bottom of the hash, so this would happen:
+
+    ```ruby
+    class Person
+      extend Portrayal
+      keyword :email, default: nil
+    end
+
+    class Employee < Person
+      keyword :employee_id
+      keyword :email, default: proc { "#{employee_id}@example.com" }
+    end
+
+    employee = Employee.new(employee_id: '1234')
+    employee.email # => "@example.com"
+    ```
+
+    The email is broken because it relies on having employee_id declared before email, but email was already declared first in the superclass. This change fixes situations like this by re-adding the keyword to the bottom of the hash on every re-declaration.
+
 ## 0.7.0 - 2020-12-13
 
 * **Breaking change:** Remove `optional` setting. To update find all `optional: true` and change to `default: nil` instead.
@@ -10,31 +35,31 @@ This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## 0.6.0 - 2020-08-10
 
-* Return keyword name from `keyword`, allowing usage such as `private keyword :foo`. [[commit]](https://github.com/scottscheapflights/portrayal/commit/9e9db2cafc7eae14789c5b84f70efd18898ace76)
+* Return keyword name from `keyword`, allowing usage such as `private keyword :foo`. [[commit]](https://github.com/maxim/portrayal/commit/9e9db2cafc7eae14789c5b84f70efd18898ace76)
 
 ## 0.5.0 - 2020-05-28
 
-* Add option `define` for overriding nested class name. [[commit]](https://github.com/scottscheapflights/portrayal/commit/665ad297fb71fcdf5f641c672a457ccbe29e4a49)
+* Add option `define` for overriding nested class name. [[commit]](https://github.com/maxim/portrayal/commit/665ad297fb71fcdf5f641c672a457ccbe29e4a49)
 
 ## 0.4.0 - 2020-05-16
 
-* Portrayal schema is deep-duped to subclasses. [[commit]](https://github.com/scottscheapflights/portrayal/commit/f346483a379ce9fbdece72cde8b0844f2d22b1cd)
+* Portrayal schema is deep-duped to subclasses. [[commit]](https://github.com/maxim/portrayal/commit/f346483a379ce9fbdece72cde8b0844f2d22b1cd)
 
 ## 0.3.1 - 2020-05-11
 
-* Fix the issue introduced in 0.3.0 where `==` and `eql?` were always treating rhs as another portrayal class. [[commit]](https://github.com/scottscheapflights/portrayal/commit/f6ec8f373c6582f7e8d8f872d289222e4a58f8f6)
+* Fix the issue introduced in 0.3.0 where `==` and `eql?` were always treating rhs as another portrayal class. [[commit]](https://github.com/maxim/portrayal/commit/f6ec8f373c6582f7e8d8f872d289222e4a58f8f6)
 
 ## 0.3.0 - 2020-05-09 (yanked)
 
-* No longer compare classes in `==`, use `eql?` for that. [[commit]](https://github.com/scottscheapflights/portrayal/commit/9c5a37e4fb91e35d23b22e208344452930452af7)
-* Define a protected writer for every keyword - useful when applying changes after `dup`/`clone`. [[commit]](https://github.com/scottscheapflights/portrayal/commit/1c0fa6c6357a09760dae39165e864238d231a08e)
-* Add definition of `#hash` to fix hash equality. Now `hash[object]` will match if `object` is of the same class with the same keywords and values. [[commit]](https://github.com/scottscheapflights/portrayal/commit/ba9e390ab4aea4733ba084ac273da448e313ea53)
-* Make `#freeze` propagate to all keyword values. [[commit]](https://github.com/scottscheapflights/portrayal/commit/0a734411a6eac08e2355c4277e09a2a70800d032)
-* Make `#dup` and `#clone` propagate to all keyword values. [[commit]](https://github.com/scottscheapflights/portrayal/commit/010632d87d81a8d5b5ea5ff27d3d209cc667b0a5)
+* No longer compare classes in `==`, use `eql?` for that. [[commit]](https://github.com/maxim/portrayal/commit/9c5a37e4fb91e35d23b22e208344452930452af7)
+* Define a protected writer for every keyword - useful when applying changes after `dup`/`clone`. [[commit]](https://github.com/maxim/portrayal/commit/1c0fa6c6357a09760dae39165e864238d231a08e)
+* Add definition of `#hash` to fix hash equality. Now `hash[object]` will match if `object` is of the same class with the same keywords and values. [[commit]](https://github.com/maxim/portrayal/commit/ba9e390ab4aea4733ba084ac273da448e313ea53)
+* Make `#freeze` propagate to all keyword values. [[commit]](https://github.com/maxim/portrayal/commit/0a734411a6eac08e2355c4277e09a2a70800d032)
+* Make `#dup` and `#clone` propagate to all keyword values. [[commit]](https://github.com/maxim/portrayal/commit/010632d87d81a8d5b5ea5ff27d3d209cc667b0a5)
 
 ## 0.2.0 - 2019-07-03
 
-* It's now possible to specify non-lambda default values, like `default: "foo"`. There is now also a distinction between a proc and a lambda default. Procs are `call`-ed, while lambdas or any other types are returned as-is. In the majority of cases defaults are static values, and there is no need for the performance overhead of making all defaults into anonymous functions. [[commit]](https://github.com/scottscheapflights/portrayal/commit/a1cc9d0fd40e413210f61b945d37b81c87280fee)
+* It's now possible to specify non-lambda default values, like `default: "foo"`. There is now also a distinction between a proc and a lambda default. Procs are `call`-ed, while lambdas or any other types are returned as-is. In the majority of cases defaults are static values, and there is no need for the performance overhead of making all defaults into anonymous functions. [[commit]](https://github.com/maxim/portrayal/commit/a1cc9d0fd40e413210f61b945d37b81c87280fee)
 
 ## 0.1.0
 

data/README.md

@@ -1,4 +1,4 @@
-![RSpec](https://github.com/scottscheapflights/portrayal/workflows/RSpec/badge.svg)
+![RSpec](https://github.com/maxim/portrayal/workflows/RSpec/badge.svg)
 
 # Portrayal
 
@@ -8,7 +8,7 @@ Inspired by:
   - Piotr Solnica's [virtus](https://github.com/solnic/virtus)
   - Everything [Michel Martens](https://github.com/soveran)
 
-Portrayal is a minimalist gem (~120 loc, no dependencies) for building struct-like classes. It provides a small yet powerful step up from plain ruby with its one and only `keyword` method.
+Portrayal is a minimalist gem (~130 loc, no dependencies) for building struct-like classes. It provides a small yet powerful step up from plain ruby with its one and only `keyword` method.
 
 ```ruby
 class Person < MySuperClass
@@ -263,6 +263,79 @@ end
 
 This defines `Person::Country`, while the accessor remains `visited_countries`.
 
+### Subclassing
+
+Portrayal supports subclassing.
+
+```ruby
+class Person
+  extend Portrayal
+  
+  class << self
+    def from_contact(contact)
+      new name:    contact.full_name,
+          address: contact.address.to_s,
+          email:   contact.email
+    end
+  end
+  
+  keyword :name
+  keyword :address
+  keyword :email, default: nil
+end
+```
+
+```ruby
+class Employee < Person
+  keyword :employee_id
+  keyword :email, default: proc { "#{employee_id}@example.com" }
+end
+```
+
+Now when you call `Employee.new` it will accept keywords of both superclass and subclass. You can also see how `email`'s default is overridden in the subclass.
+
+However, if you try calling `Employee.from_contact(contact)` it will error out, because that constructor doesn't set an `employee_id` required in the subclass. You can remedy that with a small change.
+
+```ruby
+    def from_contact(contact, **kwargs)
+      new name:    contact.full_name,
+          address: contact.address.to_s,
+          email:   contact.email,
+          **kwargs
+    end
+```
+
+If you add `**kwargs` to `Person.from_contact` and pass them through to new, then you are now able to call `Employee.from_contact(contact, employee_id: 'some_id')`
+
+### Pattern Matching
+
+If your Ruby has pattern matching, you can pattern match portrayal objects. Both array- and hash-style matching are supported.
+
+```ruby
+class Point
+  extend Portrayal
+
+  keyword :x
+  keyword :y
+end
+
+point = Point.new(x: 5, y: 10)
+
+case point
+in 5, 10
+  'matched'
+else
+  'did not match'
+end # => "matched"
+
+case point
+in x:, y: 10
+  'matched'
+else
+  'did not match'
+end # => "matched"
+```
+
 ### Schema
 
 Every class that has at least one keyword defined in it automatically receives a class method called `portrayal`. This method is a schema of your object with some additional helpers.
@@ -387,7 +460,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/scottscheapflights/portrayal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/maxim/portrayal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -395,4 +468,4 @@ The gem is available as open source under the terms of the [Apache License Versi
 
 ## Code of Conduct
 
-Everyone interacting in the Portrayal project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/scottscheapflights/portrayal/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Portrayal project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/maxim/portrayal/blob/main/CODE_OF_CONDUCT.md).

data/bin/loc

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+find lib -name '*.rb' | xargs wc -l

data/lib/portrayal/schema.rb

@@ -7,6 +7,13 @@ module Portrayal
     DEFINITION_OF_OBJECT_ENHANCEMENTS = <<~RUBY.freeze
       def eql?(other); self.class == other.class && self == other end
       def hash; [self.class, self.class.portrayal.attributes(self)].hash end
+      def deconstruct; self.class.portrayal.attributes(self).values end
+
+      def deconstruct_keys(keys)
+        keys ||= self.class.portrayal.keywords
+        keys &= self.class.portrayal.keywords
+        Hash[keys.map { |k| [k, send(k)] }]
+      end
 
       def ==(other)
         return super unless other.class.is_a?(Portrayal)
@@ -46,7 +53,9 @@ module Portrayal
     def camelize(string); string.to_s.gsub(/(?:^|_+)([^_])/) { $1.upcase } end
 
     def add_keyword(name, default)
-      @schema[name.to_sym] = default.equal?(NULL) ? nil : Default.new(default)
+      name = name.to_sym
+      @schema.delete(name) # Forcing keyword to be added at the end of the hash.
+      @schema[name] = default.equal?(NULL) ? nil : Default.new(default)
     end
 
     def initialize_dup(other)

data/lib/portrayal/version.rb

@@ -1,3 +1,3 @@
 module Portrayal
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/portrayal.gemspec

@@ -3,17 +3,17 @@ require_relative 'lib/portrayal/version'
 Gem::Specification.new do |spec|
   spec.name    = 'portrayal'
   spec.version = Portrayal::VERSION
-  spec.authors = ['Maxim Chernyak']
-  spec.email   = ['madfancier@gmail.com']
+  spec.authors = ['Max Chernyak']
+  spec.email   = ['hello@max.engineer']
 
   spec.summary     = 'A minimal builder for struct-like classes'
   spec.description = 'Inspired by dry-initializer and virtus, portrayal is a minimalist gem that takes a somewhat different approach to building struct-like classes. It steps away from types, coersion, and writer methods in favor of encouraging well-designed constructors. Read more in the Philosophy section of the README.'
-  spec.homepage    = 'https://github.com/scottscheapflights/portrayal'
+  spec.homepage    = 'https://github.com/maxim/portrayal'
   spec.license     = 'Apache-2.0'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = 'https://github.com/scottscheapflights/portrayal/blob/main/CHANGELOG.md'
+  spec.metadata['changelog_uri'] = 'https://github.com/maxim/portrayal/blob/main/CHANGELOG.md'
 
   spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
   spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
@@ -21,8 +21,7 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.1'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'pry', '~> 0.13'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'pry', '~> 0.14'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: portrayal
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
-- Maxim Chernyak
+- Max Chernyak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-13 00:00:00.000000000 Z
+date: 2023-01-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,34 +30,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.13'
+        version: '0.14'
 description: Inspired by dry-initializer and virtus, portrayal is a minimalist gem
   that takes a somewhat different approach to building struct-like classes. It steps
   away from types, coersion, and writer methods in favor of encouraging well-designed
   constructors. Read more in the Philosophy section of the README.
 email:
-- madfancier@gmail.com
+- hello@max.engineer
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -86,19 +72,20 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/loc
 - bin/setup
 - lib/portrayal.rb
 - lib/portrayal/default.rb
 - lib/portrayal/schema.rb
 - lib/portrayal/version.rb
 - portrayal.gemspec
-homepage: https://github.com/scottscheapflights/portrayal
+homepage: https://github.com/maxim/portrayal
 licenses:
 - Apache-2.0
 metadata:
-  homepage_uri: https://github.com/scottscheapflights/portrayal
-  source_code_uri: https://github.com/scottscheapflights/portrayal
-  changelog_uri: https://github.com/scottscheapflights/portrayal/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/maxim/portrayal
+  source_code_uri: https://github.com/maxim/portrayal
+  changelog_uri: https://github.com/maxim/portrayal/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -114,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.2
 signing_key:
 specification_version: 4
 summary: A minimal builder for struct-like classes