whoopee-cushion 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ada589c5e9a9f9ff5bca6dbed49f5e8f217bb47
-  data.tar.gz: 80775f1deabb6de9a20c62c2030e12c12ea86921
+  metadata.gz: 511989dd2912ff76496a7633ed8b3879d25550f9
+  data.tar.gz: 48e85a251bd17590807ec59f986da00507d70eef
 SHA512:
-  metadata.gz: e41b72652029b3f0268331977f4f7fa21f27e51163d7246dfa46bbcbc00293378d9f46675d3d522316566f07a5e65e98b46250be230f833a974acc85130117b9
-  data.tar.gz: 96694182f4b57a80e7bae615b5ebb23e098e3633d3dada28b0dce765259c5c459fef9c2acfabaf64f4eabd2a4a47d40ae3e185f9849626d1c6bec127e68be2ef
+  metadata.gz: 8b0501be20f64d23f1ad6e0e3580f8230f9ca4af9b33acfddbdf55f5e63ed341d1e0b1598b0d638e6c6933d07be46244ef80d20b13bd7009cb7e45b7872d910c
+  data.tar.gz: 2f87403c437fc9d363b1a4bc7c3e4bc4505dadcf3e4f3195322f6a1f5eea20ea89336dd5321e984e70d71a256e79b4f4d75391f8d8c33cf61385fdfcffa789ff

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whoopee-cushion (0.1.0)
+    whoopee-cushion (1.0.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -12,40 +12,70 @@ Wouldn't it be nice if you could access all your API response data like this?
 
 `obj.products.first.customer.customer_id`
 
-whoopee-cushion will let you do just that. It's faster than using OpenStructs or any recursive algorithms based on them
+whoopee-cushion will let you do just that. It's faster than using OpenStructs and any recursive algorithms based on them
 because it uses Ruby's faster Struct objects under the hood.
 
 Setup
 =====
 
-`gem install whoopee-cushion`
+`
+gem install whoopee-cushion
+`
 
 or
 
-`gem "whoopee-cushion"`
+`
+gem "whoopee-cushion"
+`
 
 in your Gemfile.
 
 In your Ruby code:
 
-`require 'whoopee_cushion'`
+`
+require 'whoopee_cushion'
+`
 
 then
 
-`hash = {:a => 1, :CamelCase => 2, :c => 3, :d => { :e => 4, :f => [1,2,3,4,5]}}`
+`
+hash = {:a => 1, :CamelCase => 2, :c => 3, :d => { :e => 4, :f => [1,2,3,4,5]}}
 
-`obj = WhoopeeCushion::Inflate.from_hash(hash)`
+obj = WhoopeeCushion::Inflate.from_hash(hash)
 
-`puts obj.a`
-`puts obj.camel_case`
-`puts obj.d.f.first`
-
-`json = '{"CamelCase": "no", "json": "yes"}'`
+puts obj.a
+puts obj.camel_case
+puts obj.d.f.first
+`
 
 You can also go straight from JSON, or turn off the automatic camel case conversion:
 
-`obj = WhoopeeCushion::Inflate.from_json(json, :to_snake_keys => false)`
+`
+json = '{"CamelCase": "no", "json": "yes"}'
+
+obj = WhoopeeCushion::Inflate.from_json(json, :convert_keys => false)
+
+puts obj.CamelCase
+`
+
+If you want to carry out your own string conversion, use a lambda:
+
+`
+hash = {:a => 1, :CamelCase => 2, :c => 3, :d => { :e => 4, :f => [1,2,3,4,5]}}
+
+obj = WhoopeeCushion::Inflate.from_hash(hash, :convert_keys => lambda {|s| '#{s}_foo'})
+
+puts obj.a_foo
+puts obj.CamelCase_foo
+puts obj.d_foo.f_foo.first
+`
+
+Performance
+===========
 
-`puts obj.CamelCase`
+Check the project out, bundle it and run the simple `rake benchmark` suite to see some figures. Comparisons are made
+against the recursive-open-struct gem and simple OpenStruct creates. The whoopee-cushion gem performs very well against
+both when not converting strings to snake case (quite an expensive operation, using a stripped-down version of the
+Rails 'underscore' method.) When converting strings the performance increase is diminished, but it still comes out well.
 
-Have fun.
+If you can increase performance (or otherwise improve the gem in any way) please fork it and issue a pull request.

data/Rakefile

@@ -1,8 +1,16 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+currdir = File.dirname(__FILE__)
+require currdir+ '/test/benchmarks'
 
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.pattern = "test/*_test.rb"
+end
+
+
+desc 'Run the benchmarks'
+task :benchmark do
+  benchmarks
 end

data/lib/whoopee_cushion.rb

@@ -26,42 +26,31 @@ module WhoopeeCushion
     end
 
     def self.from_hash(hash, options = {})
-      hash = process_hash hash, options
-      keys = hash.keys
-      model = Struct.new(*keys)
-      out = model.new
-      hash.each do |key, value|
-        out.send("#{key}=", self.from_object(value, options))
-      end
-      out
+      @iter ||= 1
+      keys, values = process_hash hash, options
+      Struct.new(*keys).new(*values)
     end
 
     private
 
     def self.process_hash hash, options
-      remap = hash.map do |key, value|
-        key = underscore_key key unless options[:to_snake_keys] == false
-        [key.to_sym, value]
+      keys = []
+      values = []
+      hash.each do |k,v|
+        keys << (options[:convert_keys] == false ? k : underscore_key(k, options)).to_sym
+        values << from_object(v, options)
       end
-      Hash[remap]
+      # Split the keys and values to arrays for 1: speed and 2: backwards compatibility with Ruby < 1.9
+      # where hashes are unordered
+      [keys, values]
     end
 
-    def self.underscore_key(key)
-      if key.is_a? Symbol
-        underscore(key.to_s)
-      elsif key.is_a? String
-        underscore(key)
-      else
-        key
-      end
-    end
+    def self.underscore_key(string, options)
+      return options[:convert_keys].call(string) if options[:convert_keys]
 
-    def self.underscore(string)
-      string.gsub(/::/, '/').
-          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-          gsub(/([a-z\d])([A-Z])/,'\1_\2').
-          tr("-", "_").
-          downcase
+      string.to_s.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+                  gsub(/([a-z\d])([A-Z])/,'\1_\2').
+                  downcase
     end
   end
 end

data/lib/whoopee_cushion/version.rb

@@ -1,3 +1,3 @@
 module WhoopeeCushion
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/test/benchmarks.rb

@@ -0,0 +1,72 @@
+require 'whoopee_cushion'
+require 'byebug'
+require 'benchmark'
+require 'recursive-open-struct'
+
+def benchmarks
+  puts "Benchmarking 10000 operations on deep hash:"
+
+  hash = {:aaaaBbbb => 'ccccDDDD',
+          :a => 2, :b => 2, :c => 2, :d => 2, :e => 2,
+          :f => 2, :g => 2, :h => 2, :i => 2, :j => 2,
+          :k => 2, :l => 2, :m => 2, :n => 2, :o => 2,
+          :p => 2, :q => 2, :r => 2, :s => 2, :t => 2,
+          'eeeeEeee' =>[{"NameThe1" => {"CamelName" => 4444},
+                         "NameThe3" => [4,5,6]}, "3", "4"]}
+  puts "whoopee-cushion"
+  puts Benchmark.measure {
+    10000.times do
+      a = WhoopeeCushion::Inflate.from_hash hash, :convert_keys => false
+      raise 'Incorrect value found' if a.eeeeEeee.first.NameThe3[0] != 4
+    end
+  }
+
+  puts "whoopee-cushion with camel to snake case conversion"
+  puts Benchmark.measure {
+    10000.times do
+      a = WhoopeeCushion::Inflate.from_hash hash
+      raise 'Incorrect value found' if a.eeee_eeee.first.name_the3[0] != 4
+    end
+  }
+
+  puts 'recursive-open-struct gem for comparison'
+  puts Benchmark.measure {
+    10000.times do
+      a = RecursiveOpenStruct.new hash, :recurse_over_arrays => true
+      raise 'Incorrect value found' if a.eeeeEeee.first.NameThe3[0] != 4
+    end
+  }
+
+
+
+  puts "Benchmarking 10000 operations on light hash:"
+
+  hash = {:a => 2, :b => 2, :c => 2, :d => 2, :e => 2,
+          :f => 2, :g => 2, :h => 2, :i => 2, :j => 2,
+          :k => 2, :l => 2, :m => 2, :n => 2, :c1 => "Lorem Ipsum"}
+
+
+  puts Benchmark.measure {
+    10000.times do
+      x = WhoopeeCushion::Inflate.from_hash hash, :convert_keys => false
+      x.c1
+    end
+  }
+
+  puts "Benchmarking 10000 operations on light hash with camel case conversion:"
+  puts Benchmark.measure {
+    10000.times do
+      x = WhoopeeCushion::Inflate.from_hash hash
+      x.c1
+    end
+  }
+
+  puts "Benchmarking 10000 OpenStruct creates"
+
+  puts Benchmark.measure {
+    10000.times do
+      x = OpenStruct.new(hash)
+      x.c1
+    end
+  }
+end

data/test/inflate_test.rb

@@ -19,7 +19,7 @@ end
 
 describe 'converting keys to snake case' do
   before do
-    @json = { 'CaseOne' => 'FirstCase', 'caseTwo' => 'secondCase', 'case_three' => 'third_case' }
+    @json = { 'CaseOne' => 'FirstCase', 'caseTwo' => 'secondCase', 'case_three' => 'third_case', 'CASEFour' => '4' }
   end
 
   it 'should convert CamelCase' do
@@ -32,18 +32,23 @@ describe 'converting keys to snake case' do
     assert_equal 'secondCase', obj.case_two
   end
 
+  it 'should convert CAMELCase with acronyms' do
+    obj = WhoopeeCushion::Inflate.from_hash @json
+    assert_equal '4', obj.case_four, "Could not find case_four: #{obj.inspect}"
+  end
+
   it 'should not convert camel case with snake keys option false' do
-    obj = WhoopeeCushion::Inflate.from_hash @json, :to_snake_keys => false
+    obj = WhoopeeCushion::Inflate.from_hash @json, :convert_keys => false
     assert_equal 'FirstCase', obj.CaseOne
   end
 
   it 'should not convert camel back with snake keys option false' do
-    obj = WhoopeeCushion::Inflate.from_hash @json, :to_snake_keys => false
+    obj = WhoopeeCushion::Inflate.from_hash @json, :convert_keys => false
     assert_equal 'secondCase', obj.caseTwo
   end
 
   it 'should leave snake case alone with snake keys option false' do
-    obj = WhoopeeCushion::Inflate.from_hash @json, :to_snake_keys => false
+    obj = WhoopeeCushion::Inflate.from_hash @json, :convert_keys => false
     assert_equal 'third_case', obj.case_three
   end
 
@@ -64,7 +69,7 @@ describe 'converting recursive hashes' do
   end
 
   it 'should not convert keys to snake case with snake keys option false' do
-    obj = WhoopeeCushion::Inflate.from_hash @json, :to_snake_keys => false
+    obj = WhoopeeCushion::Inflate.from_hash @json, :convert_keys => false
     assert_equal 'value', obj.CaseOne.caseTwo.ThisIsCaseThree
   end
 end
@@ -82,7 +87,7 @@ describe 'converting deep arrays' do
   end
 
   it 'should get deep array values correctly with snake keys option false' do
-    obj = WhoopeeCushion::Inflate.from_hash @json, :to_snake_keys => false
+    obj = WhoopeeCushion::Inflate.from_hash @json, :convert_keys => false
     assert_equal 2, obj.CaseOne[0].caseTwo
     assert_equal 'four', obj.CaseOne[0].CaseThree[0].CaseFour
     assert_equal 5, obj.CaseOne[0].CaseThree[1]
@@ -113,8 +118,17 @@ describe 'converting from array' do
     end
 
     it 'should convert an embedded hash without changing keys with snake keys option false' do
-      obj = WhoopeeCushion::Inflate.from_array @array, :to_snake_keys => false
+      obj = WhoopeeCushion::Inflate.from_array @array, :convert_keys => false
       assert_equal 'now', obj[4].ThePeople
     end
   end
+end
+
+describe 'converting keys' do
+  it 'should use the lambda if possible' do
+    hash = {'power' => 'to', 'the_people' => 'now', 'bar' => {'interesting' => 'times'}}
+    obj = WhoopeeCushion::Inflate.from_hash hash, :convert_keys => lambda {|s| "#{s}_foo"}
+    assert_equal 'to', obj.power_foo
+    assert_equal 'times', obj.bar_foo.interesting_foo
+  end
 end

data/test/test_helper.rb

@@ -3,52 +3,3 @@ require 'minitest/unit'
 require 'minitest/autorun'
 require 'minitest/pride'
 require 'byebug'
-require 'benchmark'
-require 'recursive-open-struct'
-
-puts "Benchmarking 10000 operations on deep hash:"
-
-hash = {:aaaaBbbb => 'ccccDDDD',
-        :a => 2, :b => 2, :c => 2, :d => 2, :e => 2,
-        :f => 2, :g => 2, :h => 2, :i => 2, :j => 2,
-        :k => 2, :l => 2, :m => 2, :n => 2,
-        'eeeeEeee' =>[{"splandact" => {"Griffin" => 4444},
-                       "splortitude" => [4,5,6]}, "3", "4"]}
-puts "whoopee-cushion"
-puts Benchmark.measure {
-  10000.times do
-    a = WhoopeeCushion::Inflate.from_hash hash, :to_snake_keys => false
-    raise 'Incorrect value found' if a.eeeeEeee.first.splortitude[0] != 4
-  end
-}
-puts 'recursive-open-struct'
-
-puts Benchmark.measure {
-  10000.times do
-    a = RecursiveOpenStruct.new hash, :recurse_over_arrays => true
-    raise 'Incorrect value found' if a.eeeeEeee.first.splortitude[0] != 4
-  end
-}
-
-
-
-puts "Benchmarking 10000 operations on light hash:"
-
-hash = {:a => 2, :b => 2, :c => 2, :d => 2, :e => 2,
-        :f => 2, :g => 2, :h => 2, :i => 2, :j => 2,
-        :k => 2, :l => 2, :m => 2, :n => 2, :c => "Lorem Ipsum"}
-
-
-puts Benchmark.measure {
-  10000.times do
-    WhoopeeCushion::Inflate.from_hash hash, :to_snake_keys => false
-  end
-}
-
-puts "Benchmarking 10000 OpenStruct creates"
-
-puts Benchmark.measure {
-  10000.times do
-    x = OpenStruct.new(hash)
-  end
-}

data/whoopee_cushion.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["ben@chemica.co.uk"]
   spec.summary       = %q{Allow recursive inflation of JSON data into structs.}
   spec.description   = %q{Inflates JSON data recursively into structs to allow use of dot notation for data access.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/chemica/whoopee-cushion?source=c"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whoopee-cushion
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ben Dunkley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,10 +97,11 @@ files:
 - Rakefile
 - lib/whoopee_cushion.rb
 - lib/whoopee_cushion/version.rb
+- test/benchmarks.rb
 - test/inflate_test.rb
 - test/test_helper.rb
 - whoopee_cushion.gemspec
-homepage: ''
+homepage: https://github.com/chemica/whoopee-cushion?source=c
 licenses:
 - MIT
 metadata: {}
@@ -125,5 +126,6 @@ signing_key:
 specification_version: 4
 summary: Allow recursive inflation of JSON data into structs.
 test_files:
+- test/benchmarks.rb
 - test/inflate_test.rb
 - test/test_helper.rb