render_hash 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: efeeb485371194984abf2c6b934132ec65724e82
+  data.tar.gz: 4b176fba0cf6c9211162fa58dea000cb97bc56b2
+SHA512:
+  metadata.gz: 2edeefa5538cd309f0c7e0dc57b9c92ec6f00841e74679c7c301df95a0a83fa713bd9f1fc1046ebf452c23f5243deb169707b15c4bdf5d2b89ac6a628c7bb285
+  data.tar.gz: 9891db65c0a0b5f78d296f39cd59e2ff8c662fead0bb0525f00d8d776fde1b68a339c29ae58797c34fcf54cd040b35bdb6e4d6a65be7a09391b7c4b6902624e6

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in render_hash.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ducksan Cho
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# RenderHash
+
+RenderHash is an alternative to .as_json in rails providing simple syntax to
+generate nested hash from any ruby object
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'render_hash'
+```
+
+And then execute:
+
+    $ bundle
+
+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}
+
+or render directly
+
+    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"}
+
+hash expressions can be grouped together
+
+    user.render({username: :name}, {hobby: "fishing"}) ==
+    user.render({username: :name, hobby: "fishing"})
+
+render a custom key and value with lambda
+
+    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
+
+    user.render([jobs: [:title]])
+    #=> {jobs: [{title: "doctor"}, {title: "driver"}]}
+
+render with an array
+
+    RenderHash.render([user1, user2], :name) #=> [{name: "bob"}, {name: "tom"}]
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/render_hash/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/render_hash/version.rb

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

data/lib/render_hash.rb

@@ -0,0 +1,51 @@
+require 'render_hash/version'
+
+module RenderHash
+
+  # Usage
+  # User.include RenderHash
+  # user.render(
+  #   :name, :age,
+  #   {username: :name, hobby: "fishing"},
+  #   {name_with_age: -> (user) {"#{user.name}(#{user.age})"}},
+  #   [jobs:          [:title]]
+  # )
+  # => {
+  #   name:          "bob",
+  #   age:           20,
+  #   username:      "bob",
+  #   hobby:         "finishig",
+  #   name_with_age: "bob(20)",
+  #   jobs:          [{title: "doctor"}]
+  # }
+  def render(*args)
+    RenderHash.render(self, *args)
+  end
+
+  # Usage
+  # RenderHash.render(user, :name, :age)
+  def self.render(obj, *args)
+    return obj.map {|x| render(x, *args)} if obj.is_a? Array
+
+    args.inject({}) do |result, task|
+      result.merge(
+        case task
+        when Symbol
+          {task => obj.send(task)}
+        when Hash
+          task.inject({}) do |h, (k, v)|
+            h.merge(k =>
+              case v
+              when Symbol then obj.send(v)
+              when Proc   then v.call(obj)
+              else             v
+              end
+            )
+          end
+        when Array
+          {task[0] => obj.send(task[0]).map {|x| render(x, *task[1])}}
+        end
+      )
+    end
+  end
+end

data/render_hash.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'render_hash/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "render_hash"
+  spec.version       = RenderHash::VERSION
+  spec.authors       = ["Ducksan Cho"]
+  spec.email         = ["ducktyper@gmail.com"]
+  spec.summary       = %q{Build a hash from an object}
+  spec.description   = %q{render_hash is an alternative to .as_json in rails providing simple syntax to generate nested hash from any ruby object}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/test/render_hash_test.rb

@@ -0,0 +1,81 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'minitest/autorun'
+require 'render_hash'
+
+describe RenderHash do
+
+  class User
+    include RenderHash
+    attr_reader :name, :age, :jobs
+    def initialize(name, age, jobs)
+      @name = name
+      @age  = age
+      @jobs = jobs
+    end
+  end
+
+  class Job
+    attr_reader :title
+    def initialize(title)
+      @title = title
+    end
+  end
+
+  let(:bob) {User.new('bob', 20, [Job.new('doctor'), Job.new('driver')])}
+
+  it "add render method on include" do
+    assert_equal({}, bob.render)
+  end
+
+  it "render method name and return value" do
+    assert_equal({name: 'bob', age: 20}, bob.render(:name, :age))
+  end
+
+  it "raise if method is 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
+    assert_equal({username: 'bob'}, bob.render({username: :name}))
+  end
+
+  it "render custom string" 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
+    assert_equal(
+      {name_with_age: 'bob(20)'},
+      bob.render({name_with_age: ->(user){"#{user.name}(#{user.age})"}})
+    )
+  end
+
+  it "hash can be ..." do
+    assert_equal({username: 'bob', hobby: 'fishing'}, bob.render({username: :name, hobby: "fishing"}))
+  end
+
+  it "render nested hash" do
+    assert_equal(
+      {jobs: [{title: 'doctor'}, {title: 'driver'}]},
+      bob.render([:jobs, [:title]])
+    )
+  end
+
+  it "render from self" do
+    assert_equal({name: 'bob'}, RenderHash.render(bob, :name))
+  end
+
+  it "render with array" do
+    assert_equal([{name: 'bob'}], RenderHash.render([bob], :name))
+  end
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: render_hash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ducksan Cho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: render_hash is an alternative to .as_json in rails providing simple syntax
+  to generate nested hash from any ruby object
+email:
+- ducktyper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/render_hash.rb
+- lib/render_hash/version.rb
+- render_hash.gemspec
+- test/render_hash_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Build a hash from an object
+test_files:
+- test/render_hash_test.rb