ishin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fd416241ae632c771e85f2cbb4a8ecb151b6226
+  data.tar.gz: a2c3b7dccd9496fee3e790e58684bd782644e75f
+SHA512:
+  metadata.gz: a06fd4e613aab614d59d635369ab2b4b4be16ed6aadbe9dcae441a9515ec962d93a55a16a29ce5e36c4afb52f19cae90a1da3dbce58cb1af566bbb6035fe0f54
+  data.tar.gz: 5cff38f8588ed32d1b51eccafad2a97d7196983c406a365f8d2fff5ec1995bf44959020f54512fac1473aae05e9b735c47d0ff4aedb5cedf3110062fc1448850

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--tag focus
+--tag ~skip

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Eddy Luten
+
+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,117 @@
+# Ishin
+
+Ishin converts Ruby objects into their Hash representations. It works with plain old classes, extended classes, classes with mixins, and hashes (see Usage for more on that).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ishin'
+```
+
+And then execute:
+
+    bundle
+
+Or install it manually by:
+
+    gem install ishin
+
+## Usage
+
+```ruby
+require 'ishin'
+
+hash = Ishin.to_hash(my_object)
+```
+
+### Introduction
+
+A simple example is worth a thousand words:
+
+```ruby
+class Animal
+  attr_reader :leg_count
+
+  def initialize leg_count
+    @leg_count = leg_count
+  end
+end
+
+dog = Animal.new(4)
+
+dog_hash = Ishin.to_hash(dog)
+# => {:leg_count=>4}
+```
+
+### Recursion
+
+Ishin also handles object instances nested within other object instances. By default, recursive hash conversion is turned off. To enable recursion, set the `recursive` option to `true`:
+
+```ruby
+test_struct = Struct.new(:value)
+nested_structs = test_struct.new(test_struct.new('value'))
+
+
+Ishin.to_hash(nested_structs, recursive: true)
+# => {:value=>{:value=>"value"}}
+```
+
+### Recursion Depth
+
+For deeply nested object instances, a maximum recursion depth can be provided in combination with the `recursive` option. The default recursion depth is one (initial call + 1).
+
+```ruby
+nest_me = Struct.new(:value)
+deep_nesting = nest_me.new(nest_me.new(nest_me.new(nest_me.new('such depth'))))
+
+Ishin.to_hash(deep_nesting, recursive: true, recursion_depth: 2)
+# => {:value=>{:value=>{:value=>#<struct value="such depth">}}}
+```
+
+Notice in the above example that the recursion stopped after 3 steps (initial call + 2).
+
+### Expanding Hashes using Recursion
+
+Using recursion, it is also possible to convert hashes containing object instances to a hash-only representation as well. Notice that this only works if the `recursive` option is provided.
+
+```ruby
+another_struct = Struct.new(:value)
+my_hash = {
+  my_struct: another_struct.new("yup, it's a struct")
+}
+
+Ishin.to_hash(my_hash, recursive: true)
+# => {:my_struct=>{:value=>"yup, it's a struct"}}
+```
+
+Keep in mind that the `recursive` option works in conjunction with the `recursion_depth` option.
+
+### Symbolizing Keys
+
+By default, Ishin stores key names as symbols. This behavior can be disabled by setting the `symbolize` option to `false`.
+
+```ruby
+class Dog
+  attr_reader :says
+
+  def initialize(says)
+    @says = says
+  end
+end
+
+lassie = Dog.new('Timmy is stuck in a well!')
+
+Ishin.to_hash(lassie)
+# => {:says=>"Timmy is stuck in a well!"}
+Ishin.to_hash(lassie, symbolize: false)
+# => {"says"=>"Timmy is stuck in a well!"}
+```
+When setting the `symbolize` option to `false`, the explicit conversion of strings to symbols is prevented. This, however, does *not* mean that hashes whose keys are already symbols are converted into string-based keys.
+
+## Running the Specs
+
+Once `bundle` is executed, simply run:
+
+    rake spec

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ishin"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ishin.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ishin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ishin"
+  spec.version       = Ishin::VERSION
+  spec.authors       = ["Eddy Luten"]
+  spec.email         = ["eddyluten@gmail.com"]
+
+  spec.summary       = %q{Ishin is an object to hash converter.}
+  spec.description   = %q{Ishin converts objects into their Hash representations.}
+  spec.homepage      = "https://github.com/EddyLuten/ishin"
+  spec.license       = "MIT"
+  spec.platform      = Gem::Platform::RUBY
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+end

data/lib/ishin.rb

@@ -0,0 +1,79 @@
+require 'ishin/version'
+
+module Ishin
+
+  def self.to_hash(object, options = {})
+    options = defaults.merge(options)
+    result = {}
+
+    case object
+    when Struct
+      struct_to_hash(result, object, options)
+    when Hash
+      hash_to_hash(result, object, options)
+    else
+      object_to_hash(result, object, options)
+    end
+
+    result
+  end
+
+  private
+
+  def self.decrement_recursion_depth(options)
+    options[:recursion_depth] = [0, options[:recursion_depth] - 1].max
+    options
+  end
+
+  def self.assign_value(result, key, value, options, new_options)
+    result[key] = should_recurse?(options, value) ? to_hash(value, new_options) : value
+  end
+
+  def self.hash_to_hash(result, object, options)
+    return result.replace(object) unless options[:recursive]
+
+    new_options = decrement_recursion_depth(options.clone)
+
+    object.each do |key, value|
+      key = key.to_sym if options[:symbolize] && key.is_a?(String)
+      assign_value(result, key, value, options, new_options)
+    end
+  end
+
+  def self.struct_to_hash result, object, options
+    new_options = decrement_recursion_depth options.clone
+
+    object.members.each do |member|
+      key = options[:symbolize] ? member : member.to_s
+      value = object[member]
+      assign_value(result, key, value, options, new_options)
+    end
+  end
+
+  def self.object_to_hash(result, object, options)
+    new_options = decrement_recursion_depth(options.clone)
+
+    object.instance_variables.each do |var|
+      value = object.instance_variable_get(var)
+      key = var.to_s.delete('@')
+      key = key.to_sym if options[:symbolize]
+      assign_value(result, key, value, options, new_options)
+    end
+  end
+
+  def self.should_recurse? options, value
+    options[:recursive] && options[:recursion_depth] > 0 && !is_native_type?(value)
+  end
+
+  def self.is_native_type? value
+    [ String, Numeric, TrueClass, FalseClass ].any? { |i| value.is_a?(i) }
+  end
+
+  def self.defaults
+    {
+      recursive: false,
+      recursion_depth: 1,
+      symbolize: true
+    }
+  end
+end

data/lib/ishin/version.rb

@@ -0,0 +1,3 @@
+module Ishin
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: ishin
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eddy Luten
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ishin converts objects into their Hash representations.
+email:
+- eddyluten@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ishin.gemspec
+- lib/ishin.rb
+- lib/ishin/version.rb
+homepage: https://github.com/EddyLuten/ishin
+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: Ishin is an object to hash converter.
+test_files: []