render_hash 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efeeb485371194984abf2c6b934132ec65724e82
-  data.tar.gz: 4b176fba0cf6c9211162fa58dea000cb97bc56b2
+  metadata.gz: 5c4fbe95a59eab2568b0c6b4f03fefba6355a20c
+  data.tar.gz: c86de8201259ae4dfa56112cfcacbd2aeaaea3d2
 SHA512:
-  metadata.gz: 2edeefa5538cd309f0c7e0dc57b9c92ec6f00841e74679c7c301df95a0a83fa713bd9f1fc1046ebf452c23f5243deb169707b15c4bdf5d2b89ac6a628c7bb285
-  data.tar.gz: 9891db65c0a0b5f78d296f39cd59e2ff8c662fead0bb0525f00d8d776fde1b68a339c29ae58797c34fcf54cd040b35bdb6e4d6a65be7a09391b7c4b6902624e6
+  metadata.gz: 4f9dab50943c03f8a11469b57f54f6d7c4f8f91c42a94dc5881ea0424c7f52da3ff25004d0dc8524104dd0b57a0cd76e251f00ca3f1c3fa07c5600cf451ddcd2
+  data.tar.gz: 2756a3bca3a1b30cf28085b379f2dde7b179e7b05faa85265a5024e13fc8a113a0a76fe915617a7577279ba142e3ea681dc750c531abd69ea70f83b646f2ca21

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/README.md

@@ -1,7 +1,6 @@
-# RenderHash
-
+# RenderHash [![Build Status](https://travis-ci.org/ducktyper/render_hash.svg?branch=master)](https://travis-ci.org/ducktyper/render_hash)
 RenderHash is an alternative to .as_json in rails providing simple syntax to
-generate nested hash from any ruby object
+generate the hash from any ruby object.
 
 ## Installation
 
@@ -20,46 +19,106 @@ Or install it yourself as:
     $ gem install render_hash
 
 ## Usage
-RenderHash module can be included to a class
 
-    user.render(:name, :age) #=> {name: "bob", age: 20}
+* Include the module into a class
 
-or render directly
+```ruby
+class User
+  include RenderHash
+  attr_reader :name, :age
+  def initialize(name, age)
+    @name = name
+    @age = age
+  end
+end
+user = User.new("bob", 20)
+user.render(:name) #=> {name: "bob", age: 20}
+```
 
-    RenderHash.render(user, :name, :age) #=> {name: "bob", age: 20}
+* Use the module directly
+```ruby
+class User
+  attr_reader :name, :age
+  def initialize(name, age)
+    @name = name
+    @age = age
+  end
+end
+user = User.new("bob", 20)
+RenderHash.render(user, :name, :age) #=> {name: "bob", age: 20}
+```
 
 ## Syntax
 
-render from methods
-
-    user.render(:name, :age) #=> {name: "bob", age: 20}
-
-render from methods with a custom key
-
-    user.render({username: :name}, :age) #=> {username: "bob", age: 20}
-
-render a custom key and value
-
-    user.render({hobby: "fishing"}) #=> {hobby: "fishing"}
+Classes used in the examples
+```ruby
+  class User
+    include RenderHash
+    attr_reader :name, :age, :jobs
+    def initialize(name, age = nil, jobs = [])
+      @name = name
+      @age  = age
+      @jobs = jobs
+    end
+  end
+  class Job
+    attr_reader :title
+    def initialize(title)
+      @title = title
+    end
+  end
+```
 
-hash expressions can be grouped together
+Render the method
+```ruby
+user = User.new("bob")
+user.render(:name) #=> {name: "bob"}
+```
 
-    user.render({username: :name}, {hobby: "fishing"}) ==
-    user.render({username: :name, hobby: "fishing"})
+Render the method with the custom name
+```ruby
+user = User.new("bob")
+user.render({username: :name}) #=> {username: "bob"}
+```
 
-render a custom key and value with lambda
+Render the custom value
+```ruby
+user = User.new("bob")
+user.render({hobby: "fishing"}) #=> {hobby: "fishing"}
+```
 
-    name_with_age = ->(user){"#{user.name}(#{user.age})"}
-    user.render({name_with_age: name_with_age}) #=> {name_with_age: "bob(20)"}
+Render the custom function
+```ruby
+user = User.new("bob", 20)
+name_with_age = ->(user){"#{user.name}(#{user.age})"}
+user.render({name_with_age: name_with_age}) #=> {name_with_age: "bob(20)"}
+```
 
-render nested hash from a method returns an array
+Render nested methods
+```ruby
+user = User.new("bob")
+user.render([:name, :upcase]) #=> {name: {upcase: "BOB"}}
+```
 
-    user.render([jobs: [:title]])
-    #=> {jobs: [{title: "doctor"}, {title: "driver"}]}
+Render the method from the array
+```ruby
+jobs = [Job.new("doctor"), Job.new("driver")]
+user = User.new("bob", 20, jobs)
+user.render([jobs: [:title]]) #=> {jobs: [{title: "doctor"}, {title: "driver"}]}
+```
 
-render with an array
+You can merge multiple hashes
+```ruby
+user = User.new("bob")
+user.render({username: :name}, {hobby: "fishing"}) ==
+user.render({username: :name, hobby: "fishing"})
+```
 
-    RenderHash.render([user1, user2], :name) #=> [{name: "bob"}, {name: "tom"}]
+Render from arrays using the module
+```ruby
+users = [User.new("bob"), User.new("tom")]
+RenderHash.render(users, :name) #=> [{name: "bob"}, {name: "tom"}]
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,9 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
+Rake::TestTask.new(:all) do |t|
+  t.name = 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task default: ["test"]

data/lib/render_hash.rb

@@ -7,6 +7,7 @@ module RenderHash
   # user.render(
   #   :name, :age,
   #   {username: :name, hobby: "fishing"},
+  #   [:name, :upcase],
   #   {name_with_age: -> (user) {"#{user.name}(#{user.age})"}},
   #   [jobs:          [:title]]
   # )
@@ -15,6 +16,7 @@ module RenderHash
   #   age:           20,
   #   username:      "bob",
   #   hobby:         "finishig",
+  #   name:          {upcase: "BOB"},
   #   name_with_age: "bob(20)",
   #   jobs:          [{title: "doctor"}]
   # }
@@ -43,7 +45,12 @@ module RenderHash
             )
           end
         when Array
-          {task[0] => obj.send(task[0]).map {|x| render(x, *task[1])}}
+          val = obj.send(task[0])
+          if val.respond_to? :map
+            {task[0] => val.map {|x| render(x, *task[1])}}
+          else
+            {task[0] => render(val, *task[1])}
+          end
         end
       )
     end

data/lib/render_hash/version.rb

@@ -1,3 +1,3 @@
 module RenderHash
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/render_hash_test.rb

@@ -23,58 +23,57 @@ describe RenderHash do
 
   let(:bob) {User.new('bob', 20, [Job.new('doctor'), Job.new('driver')])}
 
-  it "add render method on include" do
+  it "should add render method on include" do
     assert_equal({}, bob.render)
   end
 
-  it "render method name and return value" do
+  it "should render the method" do
     assert_equal({name: 'bob', age: 20}, bob.render(:name, :age))
   end
 
-  it "raise if method is not found" do
+  it "should raise if the method not found" do
     assert_raises(NoMethodError) {bob.render(:method_not_exist)}
   end
 
-  it "raise if nested hash method does not return array" do
-    assert_raises(NoMethodError) {bob.render(:age, [:name])}
-  end
-
-  it "rename method" do
+  it "should render the method with the custom name" do
     assert_equal({username: 'bob'}, bob.render({username: :name}))
   end
 
-  it "render custom string" do
+  it "should render the custom value" do
     assert_equal({name: 'tom'}, bob.render({name: 'tom'}))
   end
 
-  it "render custom object" do
-    hobby = 'fishing'
-    assert_equal({hobby: 'fishing'}, bob.render({hobby: hobby}))
-  end
-
-  it "render custom with object" do
+  it "should render the custom function" do
     assert_equal(
       {name_with_age: 'bob(20)'},
       bob.render({name_with_age: ->(user){"#{user.name}(#{user.age})"}})
     )
   end
 
-  it "hash can be ..." do
+  it "should render nested methods" do
+    assert_equal({:age=>20, :name=>{:upcase=>"BOB"}},
+                 bob.render(:age, [:name, :upcase]))
+  end
+
+
+  it "should be able to merge multiple hashes" do
     assert_equal({username: 'bob', hobby: 'fishing'}, bob.render({username: :name, hobby: "fishing"}))
+    assert_equal(bob.render({username: :name}, {hobby: "fishing"}),
+                 bob.render({username: :name, hobby: "fishing"}))
   end
 
-  it "render nested hash" do
+  it "should render methods from the array" do
     assert_equal(
       {jobs: [{title: 'doctor'}, {title: 'driver'}]},
       bob.render([:jobs, [:title]])
     )
   end
 
-  it "render from self" do
+  it "should render directly from the module" do
     assert_equal({name: 'bob'}, RenderHash.render(bob, :name))
   end
 
-  it "render with array" do
+  it "should render from arrays using the module" do
     assert_equal([{name: 'bob'}], RenderHash.render([bob], :name))
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_hash
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ducksan Cho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-18 00:00:00.000000000 Z
+date: 2016-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -47,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -75,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Build a hash from an object