portrayal 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbd0b561e866c45f6e850b592620df78d4573635165807cd2284ab45baed9e0c
-  data.tar.gz: 699be912aa836a55faa10886a3a1c1bb7b17c006f1db445694660d2fbe0ec0f4
+  metadata.gz: afdba4b2e460ce31fb430639e1270683d61d2b41bcb276a056e042ac8de8c61d
+  data.tar.gz: 39f66cc7e9224d04660d3cc1e1317f9c66752e2fd739eeb9068f10751275f9f8
 SHA512:
-  metadata.gz: 58fc168ad299aee9555ec7e1a1355f533c65af5ff1620095a7e49829252b39e92f45714083cc03fd1cde2ccc027acabd98b3526618caae07fb226be7e294694b
-  data.tar.gz: 8d59938b7bdcc5b9a32683695b6146186cb12bf6132326ecfff5b01685b7740dbf78ef513a43fbf5ff58716c38848881229600e4eb2f059dc13efc530120d68d
+  metadata.gz: 894bcfa84622297c663f9fa88c4f829a8475fa092caff07d047768adef1a110e5726747f53a284e6d823c57ead388a14fc4e5d0bb68342c463a170a725fa9442
+  data.tar.gz: 19dc417df48b783a7847957fdc8899c143b0e92ac4aaef35f1b07342d7d02fbea1091d504d9d47318c7baee0cf538616209555903307f5e8aace2267fd777fce

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' ]
 
     name: Ruby ${{ matrix.ruby }}
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-ruby@v1
+      - 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,27 @@ This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
+## 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.

data/README.md

@@ -263,6 +263,50 @@ 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')`
+
 ### 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.

data/lib/portrayal/schema.rb

@@ -46,7 +46,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.7.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portrayal
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Maxim Chernyak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-13 00:00:00.000000000 Z
+date: 2021-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler