portrayal 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a6532caf62048d8a54a3dccfca29166c8277b47c19765d9ce8ee02b97ee709c
-  data.tar.gz: d58115282488d0c4dc22bacf65e8ea83e98986653b29798d6cade1d705e04fba
+  metadata.gz: fbd0b561e866c45f6e850b592620df78d4573635165807cd2284ab45baed9e0c
+  data.tar.gz: 699be912aa836a55faa10886a3a1c1bb7b17c006f1db445694660d2fbe0ec0f4
 SHA512:
-  metadata.gz: c177e83e03d1d80e6bcfa1970c3786a9e496f5d1e09df05d7758772be244d1c056c28971c4c4b1de6c040c8ea839b34c4e69b2cdf38bdc2bd1269133640bad1b
-  data.tar.gz: d664544c2fa4b822c8d677efe546ae13521daed0e700fd20ec72255a13595014213934154abe5ef70f7a94dce8ef5a886493c430ba41791b1a9c38b57bdae2f4
+  metadata.gz: 58fc168ad299aee9555ec7e1a1355f533c65af5ff1620095a7e49829252b39e92f45714083cc03fd1cde2ccc027acabd98b3526618caae07fb226be7e294694b
+  data.tar.gz: 8d59938b7bdcc5b9a32683695b6146186cb12bf6132326ecfff5b01685b7740dbf78ef513a43fbf5ff58716c38848881229600e4eb2f059dc13efc530120d68d

data/.github/workflows/rspec.yml

@@ -2,9 +2,9 @@ name: RSpec
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
   pull_request:
-    branches: [ master ]
+    branches: [ main ]
 
 jobs:
   test:

data/.gitignore

@@ -7,5 +7,8 @@
 /spec/reports/
 /tmp/
 
+# Recommended for gems
+/Gemfile.lock
+
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -2,6 +2,12 @@ This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
+## 0.7.0 - 2020-12-13
+
+* **Breaking change:** Remove `optional` setting. To update find all `optional: true` and change to `default: nil` instead.
+
+* **Breaking change:** Move `self` of default procs to `initialize` context. Before this change, default procs used to be executed naively in class context. Now they can access other keyword readers and instance methods since their `self` is now coming from `initialize`. To update, look through your default procs and replace any reference to current class's methods such as `method_name` with `self.class.method_name`.
+
 ## 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)

data/README.md

@@ -1,4 +1,4 @@
-![RSpec](https://github.com/scottscheapflights/portrayal/workflows/RSpec/badge.svg?branch=master)
+![RSpec](https://github.com/scottscheapflights/portrayal/workflows/RSpec/badge.svg)
 
 # Portrayal
 
@@ -15,7 +15,7 @@ class Person < MySuperClass
   extend Portrayal
 
   keyword :name
-  keyword :age, optional: true
+  keyword :age, default: nil
   keyword :favorite_fruit, default: 'feijoa'
 
   keyword :address do
@@ -172,7 +172,7 @@ class Address < ApplicationStruct
   keyword :street
   keyword :city
   keyword :postcode
-  keyword :country, optional: true
+  keyword :country, default: nil
 end
 ```
 
@@ -198,6 +198,41 @@ Any other value works as normal.
 keyword :foo, default: 4
 ```
 
+#### Default procs
+
+Default procs are executed as though they were called in your class's `initialize`, so they have access to other keywords and instance methods.
+
+```ruby
+keyword :name
+keyword :greeting, default: proc { "Hello, #{name}" }
+```
+
+Defaults can also use results of other defaults.
+
+```ruby
+keyword :four,  default: proc { 2 + 2 }
+keyword :eight, default: proc { four * 2 }
+```
+
+Or instance methods of the class.
+
+```ruby
+keyword :id, default: proc { generate_id }
+
+private
+
+def generate_id
+  SecureRandom.alphanumeric
+end
+```
+
+Note: The order in which you declare keywords matters when specifying defaults that depend on other keywords. This will not have the desired effect:
+
+```ruby
+keyword :greeting, default: proc { "Hello, #{name}" }
+keyword :name
+```
+
 ### Nested Classes
 
 When you pass a block to a keyword, it creates a nested class named after camelized keyword name.
@@ -254,7 +289,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=>[:return, nil]}}
+Address.portrayal.schema # => {:street=>nil, :city=>nil, :postcode=>nil, :country=><Portrayal::Default @value=nil @callable=false>}
 ```
 
 ## Philosophy
@@ -288,7 +323,7 @@ class Address < ApplicationStruct
   keyword :street
   keyword :city
   keyword :postcode
-  keyword :country, optional: true
+  keyword :country, default: nil
 end
 ```
 
@@ -331,7 +366,7 @@ class Address < ApplicationStruct
   keyword :street
   keyword :city
   keyword :postcode
-  keyword :country, optional: true
+  keyword :country, default: nil
 end
 ```
 
@@ -360,4 +395,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/master/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/scottscheapflights/portrayal/blob/main/CODE_OF_CONDUCT.md).

data/lib/portrayal.rb

@@ -4,7 +4,7 @@ require 'portrayal/schema'
 module Portrayal
   NULL = :_portrayal_value_not_set
 
-  def keyword(name, optional: NULL, default: NULL, define: nil, &block)
+  def keyword(name, default: NULL, define: nil, &block)
     unless respond_to?(:portrayal)
       class << self
         attr_reader :portrayal
@@ -14,13 +14,13 @@ module Portrayal
       end
 
       @portrayal = Schema.new
-      class_eval(portrayal.definition_of_object_enhancements)
+      class_eval(Schema::DEFINITION_OF_OBJECT_ENHANCEMENTS)
     end
 
     attr_accessor name
     protected "#{name}="
 
-    portrayal.add_keyword(name, optional, default)
+    portrayal.add_keyword(name, default)
     class_eval(portrayal.definition_of_initialize)
 
     if block_given?

data/lib/portrayal/default.rb

@@ -0,0 +1,13 @@
+module Portrayal
+  class Default
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+      @callable = value.is_a?(Proc) && !value.lambda?
+    end
+
+    def call?; @callable end
+    def initialize_dup(src); super; @value = src.value.dup end
+  end
+end

data/lib/portrayal/schema.rb

@@ -1,59 +1,10 @@
+require 'portrayal/default'
+
 module Portrayal
   class Schema
     attr_reader :schema
 
-    def initialize; @schema = {}  end
-    def keywords;   @schema.keys  end
-    def [](name);   @schema[name] end
-
-    def attributes(object)
-      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 =
-        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 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 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|
-        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_object_enhancements
-      <<-RUBY
+    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
 
@@ -71,18 +22,49 @@ module Portrayal
 
       def initialize_dup(source)
         self.class.portrayal.attributes(source).each do |key, value|
-          instance_variable_set('@' + key.to_s, value.dup)
+          instance_variable_set("@\#{key}", value.dup)
         end
         super
       end
 
       def initialize_clone(source)
         self.class.portrayal.attributes(source).each do |key, value|
-          instance_variable_set('@' + key.to_s, value.clone)
+          instance_variable_set("@\#{key}", value.clone)
         end
         super
       end
-      RUBY
+    RUBY
+
+    def initialize; @schema = {}  end
+    def keywords;   @schema.keys  end
+    def [](name);   @schema[name] end
+
+    def attributes(object)
+      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, default)
+      @schema[name.to_sym] = default.equal?(NULL) ? nil : Default.new(default)
+    end
+
+    def initialize_dup(other)
+      super; @schema = other.schema.transform_values(&:dup)
+    end
+
+    def definition_of_initialize
+      init_args = @schema.map { |name, default|
+        "#{name}:#{default && " self.class.portrayal[:#{name}]"}"
+      }.join(', ')
+
+      init_assigns = @schema.keys.map { |name|
+        "@#{name} = #{name}.is_a?(::Portrayal::Default) ? " \
+          "(#{name}.call? ? instance_exec(&#{name}.value) : #{name}.value) : " \
+          "#{name}"
+      }.join('; ')
+
+      "def initialize(#{init_args}); #{init_assigns} end"
     end
   end
 end

data/lib/portrayal/version.rb

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

data/portrayal.gemspec

@@ -1,6 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'portrayal/version'
+require_relative 'lib/portrayal/version'
 
 Gem::Specification.new do |spec|
   spec.name    = 'portrayal'
@@ -13,6 +11,11 @@ Gem::Specification.new do |spec|
   spec.homepage    = 'https://github.com/scottscheapflights/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.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
   spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^spec/}) }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portrayal
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Maxim Chernyak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,20 +82,23 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - 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
 licenses:
 - Apache-2.0
-metadata: {}
+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
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -104,7 +107,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,41 +0,0 @@
-PATH
-  remote: .
-  specs:
-    portrayal (0.6.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.2)
-    diff-lcs (1.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.9.0)
-    rspec-mocks (3.9.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.1)
-  portrayal!
-  pry (~> 0.13)
-  rake (~> 13.0)
-  rspec (~> 3.9)
-
-BUNDLED WITH
-   2.1.4