portrayal 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44f125ec13de164e28a515a3a4cbdfa98047d645aae03bf818cc184983ecb679
-  data.tar.gz: fab0eb7aa3fad16c833d547a2d405fdcbc34aa2160633e60ff4ad43420135c49
+  metadata.gz: 9ad16f90c209c12d143b4705a6e076cd62b7a5e691f464434489ab58d3efec9c
+  data.tar.gz: 575380d993804fac6bca6deb407f5acd92b890304b4729058cd9c9e80c89752a
 SHA512:
-  metadata.gz: 46af6c3b3918144effcdf07bd6a15bb1dac898a99569183cc2129310e75bd38f035432f7ced725d2ad583d1a09b65f26ad304c08fcf29f46800a086b09aef44f
-  data.tar.gz: b5564653b81c34921d10f62979c38c8dbc1f6e06ad4c396c20aaa0e3a1f09f28b738425ac508c1d9556a4b2b77e0c83dcb0a39b3bc91102ec59b87cd09bf420f
+  metadata.gz: f4c8a0bdb896dad477aff92b718d0401240497dd1ec0fd5d992a41206026ab213149206b1b9707c1943fb2dc313a0864bcaf285553e6fb6ed4d026cf18099d8d
+  data.tar.gz: 4f07e7614d06f50f2a053d8ba0b73f5a32061d5fc9e75c878d84441fc16a30a68747b229eb06c9cc0130d8a7c08d20268b438654823ced77ed9e3375f2644362

data/CHANGELOG.md

@@ -2,6 +2,10 @@ This project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
+## 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)

data/README.md

@@ -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 (~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.
+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.
 
 ```ruby
 class Person < MySuperClass
@@ -198,6 +198,36 @@ Any other value works as normal.
 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.

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, &block)
+  def keyword(name, optional: NULL, default: NULL, define: nil, &block)
     unless respond_to?(:portrayal)
       class << self
         attr_reader :portrayal
@@ -24,9 +24,8 @@ module Portrayal
     class_eval(portrayal.definition_of_initialize)
 
     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
   end
 end

data/lib/portrayal/schema.rb

@@ -10,6 +10,8 @@ module Portrayal
       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]
@@ -22,10 +24,6 @@ module Portrayal
       @schema[name.to_sym] = { optional: optional, default: default }
     end
 
-    def camelcase(string)
-      string.to_s.gsub(/(?:^|_+)([^_])/) { $1.upcase }
-    end
-
     def get_default(name)
       action, value = @schema[name][:default]
       action == :call ? value.call : value

data/lib/portrayal/version.rb

@@ -1,3 +1,3 @@
 module Portrayal
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: portrayal
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Maxim Chernyak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-17 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler