portrayal 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d9235eae25e3e88f554e43a68d163d24e7213bfb8830b256ffd6a12968ca7e2
-  data.tar.gz: 930a8eeaa04ce976cf1b387abf9b3c6775af9abf90b7b59ec8ff74af68fe7ff2
+  metadata.gz: 8a6532caf62048d8a54a3dccfca29166c8277b47c19765d9ce8ee02b97ee709c
+  data.tar.gz: d58115282488d0c4dc22bacf65e8ea83e98986653b29798d6cade1d705e04fba
 SHA512:
-  metadata.gz: e5ef351e415ba810039a9f4cb2a77f29dd088a8bd98322123fc3f534d16004faf2c9fbefd51fe8799949c91045fd3494c7dccf64c0e90f4b9cf617fb1e9e2f90
-  data.tar.gz: 36583d990b87b84d5fc8b2f7f149f047a7f1c2b1e11c9b651a91ca240266a9af11c3c36331d9eaebd9a4f2acbd0800f77a478d729275d62b585c09cd3211eca7
+  metadata.gz: c177e83e03d1d80e6bcfa1970c3786a9e496f5d1e09df05d7758772be244d1c056c28971c4c4b1de6c040c8ea839b34c4e69b2cdf38bdc2bd1269133640bad1b
+  data.tar.gz: d664544c2fa4b822c8d677efe546ae13521daed0e700fd20ec72255a13595014213934154abe5ef70f7a94dce8ef5a886493c430ba41791b1a9c38b57bdae2f4

data/.github/workflows/rspec.yml

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

data/CHANGELOG.md

@@ -0,0 +1,35 @@
+This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+
+## 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)
+
+## 0.5.0 - 2020-05-28
+
+* Add option `define` for overriding nested class name. [[commit]](https://github.com/scottscheapflights/portrayal/commit/665ad297fb71fcdf5f641c672a457ccbe29e4a49)
+
+## 0.4.0 - 2020-05-16
+
+* Portrayal schema is deep-duped to subclasses. [[commit]](https://github.com/scottscheapflights/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)
+
+## 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)
+
+## 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)
+
+## 0.1.0
+
+First version.

data/Gemfile.lock

@@ -1,41 +1,41 @@
 PATH
   remote: .
   specs:
-    portrayal (0.1.0)
+    portrayal (0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.2)
     diff-lcs (1.3)
-    method_source (0.9.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.3)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.1)
+    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.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.0)
+  bundler (~> 2.1)
   portrayal!
-  pry (~> 0.12)
-  rake (~> 10.0)
-  rspec (~> 3.0)
+  pry (~> 0.13)
+  rake (~> 13.0)
+  rspec (~> 3.9)
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -1,3 +1,5 @@
+![RSpec](https://github.com/scottscheapflights/portrayal/workflows/RSpec/badge.svg?branch=master)
+
 # Portrayal
 
 Inspired by:
@@ -14,7 +16,7 @@ class Person < MySuperClass
 
   keyword :name
   keyword :age, optional: true
-  keyword :favorite_fruit, default: -> { 'feijoa' }
+  keyword :favorite_fruit, default: 'feijoa'
 
   keyword :address do
     keyword :street
@@ -30,8 +32,12 @@ end
 When you call `keyword`:
 
 * It defines an `attr_reader`
+* It defines a protected `attr_writer`
 * It defines `initialize`
 * It defines `==` and `eql?`
+* It defines `#hash` for hash equality
+* It defines `#dup` and `#clone` that propagate to all keyword values
+* It defines `#freeze` that propagates to all keyword values
 * It creates a nested class when you supply a block
 * It inherits parent's superclass when creating a nested class
 
@@ -39,25 +45,56 @@ The code above produces almost exactly the following ruby. There's a lot of boil
 
 ```ruby
 class Person < MySuperClass
-  attr_reader :name, :age, :favorite_fruit, :address
+  attr_accessor :name, :age, :favorite_fruit, :address
+  protected :name=, :age=, :favorite_fruit=, :address=
 
-  def initialize(name:, age: nil, favorite_fruit: -> { 'feijoa' }.call, address:)
+  def initialize(name:, age: nil, favorite_fruit: 'feijoa', address:)
     @name = name
     @age = age
     @favorite_fruit = favorite_fruit
     @address = address
   end
 
+  def eql?(other)
+    self.class == other.class && self == other
+  end
+
   def ==(other)
-    self.class == other.class &&
-      { name: name, age: age, favorite_fruit: favorite_fruit, address: address } ==
+    { name: name, age: age, favorite_fruit: favorite_fruit, address: address } ==
       { name: other.name, age: other.age, favorite_fruit: other.favorite_fruit, address: other.address }
   end
 
-  alias eql? ==
+  def hash
+    [ self.class, { name: name, age: age, favorite_fruit: favorite_fruit, address: address } ].hash
+  end
+
+  def freeze
+    name.freeze
+    age.freeze
+    favorite_fruit.freeze
+    address.freeze
+    super
+  end
+
+  def initialize_dup(source)
+    @name = source.name.dup
+    @age = source.age.dup
+    @favorite_fruit = source.favorite_fruit.dup
+    @address = source.address.dup
+    super
+  end
+
+  def initialize_clone(source)
+    @name = source.name.clone
+    @age = source.age.clone
+    @favorite_fruit = source.favorite_fruit.clone
+    @address = source.address.clone
+    super
+  end
 
   class Address < MySuperClass
-    attr_reader :street, :city
+    attr_accessor :street, :city
+    protected :street=, :city=
 
     def initialize(street:, city:)
       @street = street
@@ -68,12 +105,35 @@ class Person < MySuperClass
       "#{street}, #{city}"
     end
 
+    def eql?(other)
+      self.class == other.class && self == other
+    end
+
     def ==(other)
-      self.class == other.class &&
-        { street: street, city: city } == { street: other.street, city: other.city }
+      { street: street, city: city } == { street: other.street, city: other.city }
     end
 
-    alias eql? ==
+    def hash
+      [ self.class, { street: street, city: city } ].hash
+    end
+
+    def freeze
+      street.freeze
+      city.freeze
+      super
+    end
+
+    def initialize_dup(source)
+      @street = source.street.dup
+      @city = source.city.dup
+      super
+    end
+
+    def initialize_clone(source)
+      @street = source.street.clone
+      @city = source.city.clone
+      super
+    end
   end
 end
 ```
@@ -123,6 +183,51 @@ Possible use cases for these objects include, but are not limited to:
 - Objects serializable for 3rd party APIs
 - Objects serializable for React components
 
+### Defaults
+
+When specifying default, there's a difference between procs and lambda.
+
+```ruby
+keyword :foo, default: proc { 2 + 2 } # => Will call this proc and return 4
+keyword :foo, default: -> { 2 + 2 }   # => Will return this lambda itself
+```
+
+Any other value works as normal.
+
+```ruby
+keyword :foo, default: 4
+```
+
+### Nested Classes
+
+When you pass a block to a keyword, it creates a nested class named after camelized keyword name.
+
+```ruby
+class Person
+  extend Portrayal
+
+  keyword :address do
+    keyword :street
+  end
+end
+```
+
+The above block created class `Person::Address`.
+
+If you want to change the name of the created class, use the option `define`.
+
+```ruby
+class Person
+  extend Portrayal
+
+  keyword :visited_countries, define: 'Country' do
+    keyword :name
+  end
+end
+```
+
+This defines `Person::Country`, while the accessor remains `visited_countries`.
+
 ### 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.
@@ -149,7 +254,7 @@ Address.portrayal.attributes(address) # => {street: '34th st', city: 'NYC', post
 Get everything portrayal knows about your keywords in one hash.
 
 ```ruby
-Address.portrayal.schema # => {:street=>{:optional=>false, :default=>nil}, :city=>{:optional=>false, :default=>nil}, :postcode=>{:optional=>false, :default=>nil}, :country=>{:optional=>true, :default=>#<Proc>}}
+Address.portrayal.schema # => {:street=>{:optional=>false, :default=>nil}, :city=>{:optional=>false, :default=>nil}, :postcode=>{:optional=>false, :default=>nil}, :country=>{:optional=>true, :default=>[:return, nil]}}
 ```
 
 ## Philosophy

data/lib/portrayal.rb

@@ -2,26 +2,32 @@ require 'portrayal/version'
 require 'portrayal/schema'
 
 module Portrayal
-  def keyword(name, optional: Schema::NULL, default: Schema::NULL, &block)
+  NULL = :_portrayal_value_not_set
+
+  def keyword(name, optional: NULL, default: NULL, define: nil, &block)
     unless respond_to?(:portrayal)
-      class << self; attr_reader :portrayal end
+      class << self
+        attr_reader :portrayal
+        def inherited(base)
+          base.instance_variable_set('@portrayal', portrayal.dup)
+        end
+      end
+
       @portrayal = Schema.new
+      class_eval(portrayal.definition_of_object_enhancements)
     end
 
-    attr_reader name
+    attr_accessor name
+    protected "#{name}="
 
     portrayal.add_keyword(name, optional, default)
     class_eval(portrayal.definition_of_initialize)
 
-    unless portrayal.equality_defined?
-      class_eval(portrayal.definition_of_equality)
-      portrayal.mark_equality_defined
-    end
-
     if block_given?
-      keyword_class = Class.new(superclass) { extend Portrayal }
-      keyword_class.class_eval(&block)
-      const_set(portrayal.camelcase(name), keyword_class)
+      kw_class = Class.new(superclass) { extend Portrayal }
+      const_set(define || portrayal.camelize(name), kw_class).class_eval(&block)
     end
+
+    name
   end
 end

data/lib/portrayal/schema.rb

@@ -1,90 +1,88 @@
 module Portrayal
   class Schema
-    NULL = :_portrayal_value_not_set
-
     attr_reader :schema
 
-    def initialize
-      @schema = {}
-      @equality_defined = false
-    end
-
-    def [](name)
-      @schema[name]
-    end
-
-    def keywords
-      @schema.keys
-    end
+    def initialize; @schema = {}  end
+    def keywords;   @schema.keys  end
+    def [](name);   @schema[name] end
 
     def attributes(object)
-      Hash[
-        object.class.portrayal.keywords.map { |key| [key, object.send(key)] }
-      ]
+      Hash[object.class.portrayal.keywords.map { |k| [k, object.send(k)] }]
     end
 
+    def camelize(string); string.to_s.gsub(/(?:^|_+)([^_])/) { $1.upcase } end
+
     def add_keyword(name, optional, default)
       optional, default =
-        if optional == NULL && default == NULL
-          [false, nil]
-        elsif optional != NULL && default == NULL
-          [optional, optional ? -> { nil } : nil]
-        elsif optional == NULL && default != NULL
-          [true, default]
-        else
-          [optional, optional ? default : nil]
+        case [optional == NULL, default == NULL]
+        when [true,  true];  [false, nil]
+        when [false, true];  [optional, optional ? [:return, nil] : nil]
+        when [true,  false]; [true, [default_strategy(default), default]]
+        else; [optional, optional ? [default_strategy(default), default] : nil]
         end
 
       @schema[name.to_sym] = { optional: optional, default: default }
     end
 
-    def camelcase(string)
-      string.to_s.gsub(/(?:^|_+)([^_])/) { $1.upcase }
+    def get_default(name)
+      action, value = @schema[name][:default]
+      action == :call ? value.call : value
+    end
+
+    def default_strategy(value)
+      (value.is_a?(Proc) && !value.lambda?) ? :call : :return
     end
 
-    def call_default(name)
-      @schema[name][:default].call
+    def initialize_dup(other)
+      super
+      @schema =
+        other.schema.map { |k, v|
+          default = v[:default] ? v[:default].map(&:dup) : v[:default]
+          [k, { optional: v[:optional], default: default }]
+        }.to_h
     end
 
     def definition_of_initialize
-      init_args =
-        @schema
-        .map { |name, config|
-          if config[:optional]
-            "#{name}: self.class.portrayal.call_default(:#{name})"
-          else
-            "#{name}:"
-          end
-        }
-        .join(',')
-
-      init_assignments =
-        @schema
-        .keys
-        .map { |name| "@#{name} = #{name}" }
-        .join('; ')
-
-      "def initialize(#{init_args}); #{init_assignments} end"
+      init_args = @schema.map { |name, config|
+        config[:optional] ?
+          "#{name}: self.class.portrayal.get_default(:#{name})" : "#{name}:"
+      }.join(',')
+
+      init_assigns = @schema.keys.map { |name| "@#{name} = #{name}" }.join('; ')
+      "def initialize(#{init_args}); #{init_assigns} end"
     end
 
-    def definition_of_equality
+    def definition_of_object_enhancements
       <<-RUBY
+      def eql?(other); self.class == other.class && self == other end
+      def hash; [self.class, self.class.portrayal.attributes(self)].hash end
+
       def ==(other)
-        self.class == other.class &&
-          self.class.portrayal.attributes(self) ==
+        return super unless other.class.is_a?(Portrayal)
+
+        self.class.portrayal.attributes(self) ==
           self.class.portrayal.attributes(other)
       end
 
-      alias eql? ==
-      RUBY
-    end
+      def freeze
+        self.class.portrayal.attributes(self).values.each(&:freeze)
+        super
+      end
 
-    def equality_defined?
-      @equality_defined
-    end
+      def initialize_dup(source)
+        self.class.portrayal.attributes(source).each do |key, value|
+          instance_variable_set('@' + key.to_s, value.dup)
+        end
+        super
+      end
 
-    def mark_equality_defined
-      @equality_defined = true
+      def initialize_clone(source)
+        self.class.portrayal.attributes(source).each do |key, value|
+          instance_variable_set('@' + key.to_s, value.clone)
+        end
+        super
+      end
+      RUBY
     end
   end
 end

data/lib/portrayal/version.rb

@@ -1,3 +1,3 @@
 module Portrayal
-  VERSION = "0.1.0"
+  VERSION = '0.6.0'
 end

data/portrayal.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email   = ['madfancier@gmail.com']
 
   spec.summary     = 'A minimal builder for struct-like classes'
-  spec.description = 'Inspired by dry-initializer and virtus, portrayal is a minimalist gem (~120 loc, no dependencies) 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.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.license     = 'Apache-2.0'
 
@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'pry', '~> 0.12'
+  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'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portrayal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Maxim Chernyak
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-08 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
 description: Inspired by dry-initializer and virtus, portrayal is a minimalist gem
-  (~120 loc, no dependencies) 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.
+  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
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -96,7 +96,7 @@ homepage: https://github.com/scottscheapflights/portrayal
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,8 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: A minimal builder for struct-like classes
 test_files: []

data/.travis.yml

@@ -1,10 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-before_install: gem install bundler -v 2.0.1