portrayal 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d9235eae25e3e88f554e43a68d163d24e7213bfb8830b256ffd6a12968ca7e2
-  data.tar.gz: 930a8eeaa04ce976cf1b387abf9b3c6775af9abf90b7b59ec8ff74af68fe7ff2
+  metadata.gz: eeb24e8ffff128d18963b1b9b35b542b260a2ec3b0e298064201c108a58c0c6c
+  data.tar.gz: 36adc49da54f8a4756d08dd0f33fbff9b6b5366115082682ff9b9fd46bd26687
 SHA512:
-  metadata.gz: e5ef351e415ba810039a9f4cb2a77f29dd088a8bd98322123fc3f534d16004faf2c9fbefd51fe8799949c91045fd3494c7dccf64c0e90f4b9cf617fb1e9e2f90
-  data.tar.gz: 36583d990b87b84d5fc8b2f7f149f047a7f1c2b1e11c9b651a91ca240266a9af11c3c36331d9eaebd9a4f2acbd0800f77a478d729275d62b585c09cd3211eca7
+  metadata.gz: 992c3b99a75e3b0226d55cc6429072be5abac8248aab9e43903352a2aeb50b0ad29acdb3dd28993ae7ddabc46b3784440d5048afef958d1ffdae1bc9e6f4738c
+  data.tar.gz: 4bc0a1cec3d59ae6db9e22e60504accc420e036ab197313e1c0b9f71219e3aae341acf82de1faa2f88984e6af79d19f1c4f825ad1fc5594b12db3497dcdc168c

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2019-07-03
+
+### Changed
+
+* 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.
+
+## [0.1.0]
+
+First version.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    portrayal (0.1.0)
+    portrayal (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -14,7 +14,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
@@ -41,7 +41,7 @@ The code above produces almost exactly the following ruby. There's a lot of boil
 class Person < MySuperClass
   attr_reader :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
@@ -123,6 +123,21 @@ 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
+```
+
 ### 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 +164,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,7 +2,9 @@ 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, &block)
     unless respond_to?(:portrayal)
       class << self; attr_reader :portrayal end
       @portrayal = Schema.new

data/lib/portrayal/schema.rb

@@ -1,7 +1,5 @@
 module Portrayal
   class Schema
-    NULL = :_portrayal_value_not_set
-
     attr_reader :schema
 
     def initialize
@@ -28,11 +26,11 @@ module Portrayal
         if optional == NULL && default == NULL
           [false, nil]
         elsif optional != NULL && default == NULL
-          [optional, optional ? -> { nil } : nil]
+          [optional, optional ? [:return, nil] : nil]
         elsif optional == NULL && default != NULL
-          [true, default]
+          [true, [default_strategy(default), default]]
         else
-          [optional, optional ? default : nil]
+          [optional, optional ? [default_strategy(default), default] : nil]
         end
 
       @schema[name.to_sym] = { optional: optional, default: default }
@@ -42,8 +40,13 @@ module Portrayal
       string.to_s.gsub(/(?:^|_+)([^_])/) { $1.upcase }
     end
 
-    def call_default(name)
-      @schema[name][:default].call
+    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 definition_of_initialize
@@ -51,7 +54,7 @@ module Portrayal
         @schema
         .map { |name, config|
           if config[:optional]
-            "#{name}: self.class.portrayal.call_default(:#{name})"
+            "#{name}: self.class.portrayal.get_default(:#{name})"
           else
             "#{name}:"
           end

data/lib/portrayal/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portrayal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Maxim Chernyak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-08 00:00:00.000000000 Z
+date: 2019-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock