jsonity 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2659fcf6db5641ea0b6dbf288e14562dcd57cc6
-  data.tar.gz: 87eea35053efa6c0f1b5dc7ec4ae5a6185ff22b2
+  metadata.gz: da188047e9b7ddbaecc15901058e76a25e5b5897
+  data.tar.gz: 1f5129af89a01e9be55a1a42df32de5d9b2b32ea
 SHA512:
-  metadata.gz: 97c515d3530a9922573f0cc1902739aa5e5876f248c0b2ad3d345fb67cf9860c22a6a4100d30ebdb966626af45470ea2bf8725291c015c76ad62aa0ef4469f97
-  data.tar.gz: 8db7d2049b3996e47c7c7c57075edbb6321596f9ddef05b6a801a94eab698b3e7420bdb4895885eabeab7c01235069c4bb4e66b556a68e9844359788d43c120d
+  metadata.gz: bf9ec2f76b3d59a1e0ef274688bccee68a6682eb69ef0c28534f0fe68b81c0522d846fbb725838893671327b509882b21ee3a3cd4f224f33d737636f37f88d22
+  data.tar.gz: e80452f852e5a11ae60789405fac3160218050c680bf16ff77995de63927328df3237feae18efd889c44ef65b6ab8592cdbd2ac99fe2825decb9516e654ef838

data/README.md

@@ -7,7 +7,7 @@ I'd been writing JSON API with [Jbuilder](https://github.com/rails/jbuilder), [R
 
 - Jbuilder is very verbose in syntax, and its functonalities of partial and mixin are actually weak
 - RABL has simple syntax, but writing complex data structure with it is not very readable
-- ActiveModel::Serializer is persuasive role in Rails architecture, but can get very useless when you need to fully control from controller what attributes of nested (associated) object to be included
+- ActiveModel::Serializer is persuasive role in Rails architecture, but can get very useless when you need to fully control from controller what attributes of multi-nested (associated) object to be included
 
 So I chose to create new one -- Jsonity, which is simple and powerful JSON builder especially for JSON API representations.
 
@@ -81,7 +81,7 @@ Jsonity.build { |t|
 Usage
 -----
 
-### Object assignment
+### Data object assignment
 
 To declare the data object for use:
 
@@ -92,7 +92,7 @@ Jsonity.build { |t|
 }
 ```
 
-Or pass as an argument:
+Or passing as an argument:
 
 ```ruby
 Jsonity.build(@user) { |user|
@@ -128,8 +128,8 @@ Jsonity.build(@user) { |user|
   # block parameter isn't required
   user.russian_roulette { rand(1..10) }
 
-  # or with specified object
-  user.feature_time(Time.now) { |now| now + 1.years }
+  # or with specified the data object
+  user.hello('world') { |w| w.upcase }
 
   # block can be omitted if the value is constant
   user.seventeen 17
@@ -138,7 +138,7 @@ Jsonity.build(@user) { |user|
 {
   "full_name": "John Smith",
   "russian_roulette": 4,
-  "feature_time": "2015-09-13 12:32:39 +0900",
+  "hello": "WORLD",
   "seventeen": 17
 }
 =end
@@ -148,7 +148,6 @@ Aliased attributes works well as you expected:
  
 ```ruby
 Jsonity.build(@user) { |user|
-  # show `id` as `my_id`
   user.my_id &:id
 }
 =begin
@@ -173,8 +172,21 @@ Jsonity.build(@user) { |user|
   }
 }
 =begin
-Assume that `@user.avatar` is `nil`,
+{
+  "name": "John Smith",
+  "avatar": {
+    "image_url": "http://www.example.com/avatar.png",
+    "width": 512,
+    "height": 512
+  }
+}
+=end
+```
 
+Assume that `@user.avatar` is `nil`, the output will be:
+
+```ruby
+=begin
 {
   "name": "John Smith",
   "avatar": {
@@ -208,7 +220,7 @@ Assume that `@user.avatar` is `nil`,
 =end
 ```
 
-Explicitly specify an object to use inside a block:
+To specify the data object to use inside a block:
 
 ```ruby
 Jsonity.build { |t|
@@ -231,12 +243,12 @@ Jsonity.build { |t|
 =end
 ```
 
-Or a block can inherit the parent object:
+Or a block can inherit the parent data object:
 
 ```ruby
 Jsonity.build { |t|
   t.user!(@user) { |user|
-    t.profile!(inherit: true) { |profile|
+    user.profile!(inherit: true) { |profile|
       profile.name  # @user.name
     }
   }
@@ -252,6 +264,31 @@ Jsonity.build { |t|
 =end
 ```
 
+### Array nodes
+
+Including a collection of objects, just use `[]` and write the same syntax of hash node:
+
+```ruby
+Jsonity.build(@user) { |user|
+  user[].friends! { |friend|
+    friend.name  # @user.friends[i].name
+  }
+}
+=begin
+{
+  "friends": [
+    { "name": "John Smith" },
+    { "name": "William Northington" }
+  ]
+}
+=end
+```
+
+Similar to hash nodes in naming convention,  
+if `@user.friends = nil` nodes suffix with `!` will be an empty array `[]`, in contrast, some with `?` will be `null`.
+
+Also passing the data object or inheritance can be done in the same way as hash nodes.
+
 ### Automatic attributes inclusion
 
 If you set `attr_json` in any class, **the specified attributes will automatically be included**:
@@ -299,33 +336,6 @@ Jsonity.build { |t|
 =end
 ```
 
-
-### Array nodes
-
-Including a collection of objects, just use `[]` and write the same syntax of hash node:
-
-```ruby
-Jsonity.build(@user) { |user|
-  user[].friends! { |friend|
-    friend.name  # @user.friends[i].name
-  }
-}
-=begin
-{
-  "friends": [
-    { "name": "John Smith" },
-    { "name": "William Northington" }
-  ]
-}
-=end
-```
-
-Similar to hash nodes in naming convention,  
-if `@user.friends = nil` nodes suffix with `!` will be an empty array `[]`, in contrast, some with `?` will be `null`.
-
-Also passing the object or inheritance can be done in the same way as hash nodes.
-
-
 ### Mixin / Scope
 
 Since Jsonity aim to be simple and light, **use plain `Proc`** to fullfill functonality of mixin.
@@ -355,7 +365,7 @@ Jsonity.build { |t|
 =end
 ```
 
-In case you might explicitly **specify an object to use** in mixin, you can do by passing it in the first argument:
+To explicitly **specify the data object to use** in mixin, you can do by passing it in the first argument:
 
 ```ruby
 Jsonity.build { |t|
@@ -369,7 +379,7 @@ Jsonity.build { |t|
 =end
 ```
 
-So you take this functonality for **scope**:
+So you can take this functonality for **scope**:
 
 ```ruby
 Jsonity.build { |t|
@@ -419,9 +429,9 @@ Notice that two objects `meta!` got merged.
 ```
 
 
-### Using object
+### Using data object
 
-You can get the current object as a second block parameter.
+You can get the data object as a second block parameter.
 
 ```ruby
 Jsonity.build { |t|

data/lib/jsonity/builder.rb

@@ -157,17 +157,15 @@ module Jsonity
 
       obj = get_object_for name, options
 
-      is_array = obj && obj.class < ::Enumerable
-
-      if !is_array && options[:_nullable]
+      if !obj && options[:_nullable]
         @content[name] ||= nil
       else
         @content[name] = [] unless @content[name].is_a?(::Array)
       end
 
-      if is_array
+      if obj
         @deferred_array_blocks[name] = {
-          obj: obj,
+          obj:    obj.to_a,
           blocks: [block],
         }
       end

data/lib/jsonity/version.rb

@@ -1,3 +1,3 @@
 module Jsonity
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonity
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Yuki Iwanaga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-13 00:00:00.000000000 Z
+date: 2014-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler