ishin 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 916893740198856f3e8461ad709f9764bf1d286e
-  data.tar.gz: 6fdf9f93f7300115d3f6423e5784a48a39e3a366
+  metadata.gz: aed7e81440ced692b2e59a4b78c09953ca67c087
+  data.tar.gz: 97aa7d2105d7cf9288c655f32ff7595812b60ee5
 SHA512:
-  metadata.gz: bad9f801b6189842d1a1bc57627de382d3fe22ed5847230e082d4a12ff40a289b72198ac0f8fdb59b079fbe9caef3cf5aa6b89819b0695149a08adc247d43184
-  data.tar.gz: a4412fccee7db64485611fca3ef02182985101ca635ec935bab2af393972e78e0ac8624bf0732184d05948280380e3d3b55f96d866dac7c7f510f1de0ede2fcf
+  metadata.gz: e2b8de58b950995ca73c59fc4238a017346280f47ae84ee2e8c645b7b6d5ee9c49dd628d70f099bc7a385add3fe2d079bea692ab5c9afa596410bb037883a94f
+  data.tar.gz: 125a4421ca4a9c4102f0a50ad2ec00e4c2398534500af87a6a89b3b2ee463e0f459962584db9efd62d1ab6f5a88aacc6d0ff88ebff4167f9b1ee3314a9430424

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - 'spec/**/*'
+Style/ClassVars:
+  Exclude:
+    - 'spec/spec_helper.rb'

data/README.md

@@ -5,7 +5,9 @@
 
 # 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).
+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 information).
 
 ## Installation
 
@@ -23,6 +25,12 @@ Or install it manually by:
 
     gem install ishin
 
+## Requirements
+
+Ishin does not require any other gems to run. There are a few gems used during
+development only, but don't affect runtime performance. For details, see
+`ishin.gemspec` in the root directory of the project.
+
 ## Example
 
 As a class method callable on any object:
@@ -66,7 +74,9 @@ dog_hash = Ishin.to_hash(dog)
 
 ### 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`:
+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)
@@ -79,7 +89,9 @@ Ishin.to_hash(nested_structs, recursive: true)
 
 ### 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).
+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)
@@ -89,11 +101,18 @@ 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).
+Notice in the above example that the recursion stopped after 3 steps (initial
+call + 2).
+
+**Warning:** Increasing the recursion depth will affect the runtime of the
+conversion process significantly. To see how drastic increased recursion levels
+affect performance, run `ruby benchmarks/recursive_bench.rb`
 
 ### 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.
+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)
@@ -105,11 +124,13 @@ 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.
+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`.
+By default, Ishin stores key names as symbols. This behavior can be disabled by
+setting the `symbolize` option to `false`.
 
 ```ruby
 class Dog
@@ -127,11 +148,14 @@ Ishin.to_hash(lassie)
 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.
+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.
 
 ### Evaluating Methods
 
-Normally, Ishin does not evaluate methods, but is possible to do so through the optional `evaluate` option by passing it an array of method names to evaluate.
+Normally, Ishin does not evaluate methods, but is possible to do so through the
+optional `evaluate` option by passing it an array of method names to evaluate.
 
 ```ruby
 class Speaker
@@ -159,7 +183,15 @@ class MyObject
 end
 ```
 
-Your object now exposes a method named `to_hash` taking the same options at the `Ishin::to_hash` class method documented above.
+Your object now exposes a method named `to_hash` taking the same options at the
+`Ishin::to_hash` class method documented above.
+
+## Running Code Quality Tools
+
+To run the code quality tools Rubocop, Reek, and RSpec, run the following
+command:
+
+    rake
 
 ## Running the Specs
 
@@ -167,6 +199,14 @@ Once `bundle` is executed, simply run:
 
     rake spec
 
+## Running the Benchmarks
+
+To give an idea on what kind of performance can be expected from Ishin, there
+are a few IPS (iterations per second) benchmarks located in the `benchmarks`
+directory. These can all be executed in series by running:
+
+    rake bench
+
 ## Changelog
 
 * 0.1.0
@@ -175,3 +215,7 @@ Once `bundle` is executed, simply run:
   * Added `Ishin::Mixin`.
 * 0.2.1
   * Now using `Struct.to_h` when converting a `Struct` instance.
+* 0.3.0
+  * Added support for evaluating object methods.
+* 0.4.0
+  * Cleanup: preparing an overhaul

data/Rakefile

@@ -1,6 +1,20 @@
 require 'rspec/core/rake_task'
 require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'reek/rake/task'
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+Reek::Rake::Task.new
 
-task :default => :spec
+task :bench do
+  sh 'ruby ./benchmarks/simple_bench.rb'
+  sh 'ruby ./benchmarks/recursive_bench.rb'
+  sh 'ruby ./benchmarks/symbolize_bench.rb'
+end
+
+task :default do
+  Rake::Task[:rubocop].invoke
+  Rake::Task[:spec].invoke
+  Rake::Task[:reek].invoke
+end

data/benchmarks/recursive_bench.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'benchmark/ips'
+require 'ishin'
+
+# A dummy class used for simply holding some data
+class Test
+  attr_reader :value
+  def initialize(value)
+    @value = value
+  end
+end
+
+Benchmark.ips do |x|
+  x.config(time: 5, warmup: 2)
+
+  test_object = Test.new(Test.new(Test.new(Test.new('value'))))
+
+  one_level_options   = { recursive: true, recursion_depth: 2 }
+  two_level_options   = { recursive: true, recursion_depth: 3 }
+  three_level_options = { recursive: true, recursion_depth: 4 }
+
+  x.report('no recursion') do
+    Ishin.to_hash(test_object)
+  end
+
+  x.report('one level of recursion') do
+    Ishin.to_hash(test_object, one_level_options)
+  end
+
+  x.report('two levels of recursion') do
+    Ishin.to_hash(test_object, two_level_options)
+  end
+
+  x.report('three levels of recursion') do
+    Ishin.to_hash(test_object, three_level_options)
+  end
+
+  x.compare!
+end

data/benchmarks/simple_bench.rb

@@ -0,0 +1,37 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'benchmark/ips'
+require 'ishin'
+
+# Non-mixin version to be used with .to_hash
+class Simple
+  attr_reader :test
+
+  def initialize
+    @test = rand
+  end
+end
+
+# Mixed-in version
+class MixedIn
+  include Ishin::Mixin
+
+  attr_reader :test
+
+  def initialize
+    @test = rand
+  end
+end
+
+Benchmark.ips do |x|
+  x.config(time: 5, warmup: 2)
+
+  x.report('.to_hash class method') do
+    Ishin.to_hash(Simple.new)
+  end
+
+  x.report('.to_hash mixin method') do
+    MixedIn.new.to_hash
+  end
+
+  x.compare!
+end

data/benchmarks/symbolize_bench.rb

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'benchmark/ips'
+require 'ishin'
+
+# Non-mixin version to be used with .to_hash
+class Simple
+  attr_reader :test
+
+  def initialize
+    @test = rand
+  end
+end
+
+Benchmark.ips do |x|
+  x.config(time: 5, warmup: 2)
+
+  x.report('symbolize: true') do
+    Ishin.to_hash(Simple.new, symbolize: true)
+  end
+
+  x.report('symbolize: false') do
+    Ishin.to_hash(Simple.new, symbolize: false)
+  end
+
+  x.compare!
+end

data/bin/console

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "ishin"
+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"
+# require 'pry'
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/ishin.gemspec

@@ -5,22 +5,27 @@ require 'ishin/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'ishin'
-  spec.version       = Ishin::VERSION
+  spec.version       = Ishin::Version::STRING
   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.summary       = 'Ishin is an object to hash converter.'
+  spec.description   = '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.files         = `git ls-files -z`.split("\x0").reject do |file|
+    file.match(%r{^(test|spec|features)/})
+  end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'benchmark-ips',             '~> 2.3'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.4.8'
+  spec.add_development_dependency 'rake',                      '~> 10.0'
+  spec.add_development_dependency 'reek',                      '~> 3.7'
+  spec.add_development_dependency 'rspec',                     '~> 3.4'
+  spec.add_development_dependency 'rubocop',                   '~> 0.35.1'
 end

data/lib/ishin.rb

@@ -1,28 +1,29 @@
 require 'ishin/version'
+require 'ishin/mixin'
 
+# Ishin is an object to hash converter Ruby Gem
 module Ishin
-  module Mixin
-    def to_hash(options = {})
-      Ishin.to_hash(self, options)
-    end
-  end
-
+  # Converts objects into their hash representations.
+  # @param object [Object] an object to convert
+  # @param options [Hash] a hash containing conversion options
   def self.to_hash(object, options = {})
     options = defaults.merge(options)
     result = {}
+    type_to_hash(result, object, options)
+    evaluate_methods(result, object, options)
+    result
+  end
 
+  private
+
+  def self.type_to_hash(result, object, options)
     case object
     when Struct then struct_to_hash(result, object, options)
     when Hash   then hash_to_hash(result, object, options)
     else             object_to_hash(result, object, options)
     end
-
-    evaluate_methods(result, object, options)
-    result
   end
 
-  private
-
   def self.decrement_recursion_depth(options)
     options[:recursion_depth] = [0, options[:recursion_depth] - 1].max
     options
@@ -36,12 +37,18 @@ module Ishin
     new_options = decrement_recursion_depth(options.clone)
 
     object.each do |key, value|
-      key = key.to_sym if options[:symbolize] && key.is_a?(String)
-
-      result[key] = native_type?(value) ? value : to_hash(value, new_options)
+      result[hash_key(key, options)] = hash_value(value, new_options)
     end
   end
 
+  def self.hash_key(key, options)
+    options[:symbolize] && key.is_a?(String) ? key.to_sym : key
+  end
+
+  def self.hash_value(value, new_options)
+    native_type?(value) ? value : to_hash(value, new_options)
+  end
+
   def self.struct_to_hash(result, object, options)
     result.replace(object.to_h)
     return unless should_recurse?(options)
@@ -58,33 +65,45 @@ module Ishin
 
     object.instance_variables.each do |var|
       value = object.instance_variable_get(var)
-      key = var.to_s.delete('@')
-      key = key.to_sym if options[:symbolize]
+      key = instance_variable_to_key(var, options)
+      result[key] = object_value(value, options, new_options)
+    end
+  end
 
-      if should_recurse?(options) && !native_type?(value)
-        result[key] = to_hash(value, new_options)
-      else
-        result[key] = value
-      end
+  def self.instance_variable_to_key(instance_variable, options)
+    key = instance_variable.to_s.delete('@')
+    options[:symbolize] ? key.to_sym : key
+  end
+
+  def self.object_value(value, options, new_options)
+    if should_recurse?(options) && !native_type?(value)
+      to_hash(value, new_options)
+    else
+      value
     end
   end
 
   def self.evaluate_methods(result, object, options)
-    return if options[:evaluate].nil? || options[:evaluate].empty?
+    evaluate = options[:evaluate]
+    return if !evaluate || evaluate.empty?
 
-    options[:evaluate].each do |method|
-      next unless object.methods.include?(method)
-      key_name = options[:symbolize] ? method : method.to_s
-      result[key_name] = object.send(method)
+    evaluate.each do |method|
+      if object.methods.include?(method)
+        result[method_name_to_key(method, options)] = object.send(method)
+      end
     end
   end
 
+  def self.method_name_to_key(method, options)
+    options[:symbolize] ? method : method.to_s
+  end
+
   def self.should_recurse?(options)
     options[:recursive] && options[:recursion_depth] > 0
   end
 
   def self.native_type?(value)
-    [String, Numeric, TrueClass, FalseClass].any? { |i| value.is_a?(i) }
+    [String, Numeric, TrueClass, FalseClass].any? { |type| value.is_a?(type) }
   end
 
   def self.defaults

data/lib/ishin/mixin.rb

@@ -0,0 +1,12 @@
+module Ishin
+  # Can be used to include the Ishin functionality into your class and provides
+  # a `.to_hash` method.
+  module Mixin
+    # Calls `Ishin.to_hash` and passes the parameters on.
+    # @param options [Hash]
+    # @see Ishin.to_hash
+    def to_hash(options = {})
+      Ishin.to_hash(self, options)
+    end
+  end
+end

data/lib/ishin/version.rb

@@ -1,3 +1,10 @@
 module Ishin
-  VERSION = '0.3.0'
+  # Contains the version number for the gem.
+  module Version
+    MAJOR = '0'.freeze
+    MINOR = '4'.freeze
+    PATCH = '0'.freeze
+
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ishin
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Eddy Luten
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-14 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.8
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -24,34 +52,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.35.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.35.1
 description: Ishin converts objects into their Hash representations.
 email:
 - eddyluten@gmail.com
@@ -61,14 +103,19 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/recursive_bench.rb
+- benchmarks/simple_bench.rb
+- benchmarks/symbolize_bench.rb
 - bin/console
 - ishin.gemspec
 - lib/ishin.rb
+- lib/ishin/mixin.rb
 - lib/ishin/version.rb
 homepage: https://github.com/EddyLuten/ishin
 licenses:
@@ -90,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ishin is an object to hash converter.