whoopee-cushion 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ccc95428b5dc5b3bd5d1ed724eab8fff67072006
+  data.tar.gz: 7ca139a81753a6c12336ed13b7619d97db4a667d
+SHA512:
+  metadata.gz: c5ad18495ba334ab02ea35604191154533cc4bf625e6908eacaf85776fc03a40368572172288718959c567ce2d4ad998b4a496b94c57c139363084c87b75fd5b
+  data.tar.gz: 131aa58433d4280588ffc140844d1d460f981455bdc653a64a9e4d23691e6dbf121de03149dca16a46e58f22f71c40f985293aa4ce919f8fb02f5439058db9b7

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+.idea
+.rvmrc

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gem 'byebug'
+gem 'recursive-open-struct'
+# Specify your gem's dependencies in whoopee_cushion.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    whoopee-cushion (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (2.6.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
+    columnize (0.3.6)
+    debugger-linecache (1.2.0)
+    minitest (4.7.5)
+    rake (10.1.1)
+    recursive-open-struct (0.4.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  byebug
+  minitest (~> 4.7.3)
+  rake
+  recursive-open-struct
+  whoopee-cushion!

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 chemica
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ben Dunkley
+
+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,15 @@
+whoopee-cushion
+===============
+
+Imagine the scene. You're accessing a nice JSON API, but the data you get back is difficult to work with. There are a
+number of reasons why this is, but mainly it's because you're dealing with a giant hash, using camel case for keys.
+
+It all leads to ugly, unreadable Ruby code like this:
+
+`obj['Products'].first['Customer']['CustomerId']`
+
+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 a fast and

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/*_test.rb"
+end

data/lib/whoopee_cushion/version.rb

@@ -0,0 +1,3 @@
+module WhoopeeCushion
+  VERSION = "0.0.1"
+end

data/lib/whoopee_cushion.rb

@@ -0,0 +1,67 @@
+require 'whoopee_cushion/version'
+require 'json'
+
+module WhoopeeCushion
+
+  class Inflate
+
+    def self.from_json(string, options = {})
+      value = JSON.parse string
+      from_object value, options
+    end
+
+    def self.from_object(value, options = {})
+      case value
+      when Array
+        from_array value, options
+      when Hash
+        from_hash value, options
+      else
+        value
+      end
+    end
+
+    def self.from_array(value, options = {})
+      value.map {|v| from_object v, options}
+    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
+    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]
+      end
+      Hash[remap]
+    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(string)
+      string.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+          gsub(/([a-z\d])([A-Z])/,'\1_\2').
+          tr("-", "_").
+          downcase
+    end
+  end
+end

data/test/inflate_test.rb

@@ -0,0 +1,120 @@
+require 'test_helper'
+
+describe 'Inflating complex JSON' do
+  before do
+    @json = '{"one": 1, "two": "2", "three": "three", "recurse": {"z":1000, "y": "999"}, "array": [1,2,{"foo": "bar"}]}'
+  end
+
+  it 'should generate objects' do
+    obj = WhoopeeCushion::Inflate.from_json @json
+    assert_equal 1, obj.one
+    assert_equal 'three', obj.three
+    assert obj.recurse.is_a?(Struct), 'Hash not available'
+    assert obj.array.is_a?(Array), 'Array not available'
+    assert_equal 1000, obj.recurse.z
+    assert_equal 1, obj.array[0]
+    assert_equal "bar", obj.array[2].foo
+  end
+end
+
+describe 'converting keys to snake case' do
+  before do
+    @json = { 'CaseOne' => 'FirstCase', 'caseTwo' => 'secondCase', 'case_three' => 'third_case' }
+  end
+
+  it 'should convert CamelCase' do
+    obj = WhoopeeCushion::Inflate.from_hash @json
+    assert_equal 'FirstCase', obj.case_one
+  end
+
+  it 'should convert camelBack' do
+    obj = WhoopeeCushion::Inflate.from_hash @json
+    assert_equal 'secondCase', obj.case_two
+  end
+
+  it 'should not convert camel case with snake keys option false' do
+    obj = WhoopeeCushion::Inflate.from_hash @json, :to_snake_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
+    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
+    assert_equal 'third_case', obj.case_three
+  end
+
+  it 'should leave snake case alone without snake keys option false' do
+    obj = WhoopeeCushion::Inflate.from_hash @json
+    assert_equal 'third_case', obj.case_three
+  end
+end
+
+describe 'converting recursive hashes' do
+  before do
+    @json = { 'CaseOne' => {'caseTwo' => { 'ThisIsCaseThree' => 'value' } } }
+  end
+
+  it 'should convert keys to snake case and get the value' do
+    obj = WhoopeeCushion::Inflate.from_hash @json
+    assert_equal 'value', obj.case_one.case_two.this_is_case_three
+  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
+    assert_equal 'value', obj.CaseOne.caseTwo.ThisIsCaseThree
+  end
+end
+
+describe 'converting deep arrays' do
+  before do
+    @json = { 'CaseOne' => [ { 'caseTwo' => 2, 'CaseThree' => [ { 'CaseFour' => 'four'}, 5 ] } ] }
+  end
+
+  it 'should get deep array values correctly' do
+    obj = WhoopeeCushion::Inflate.from_hash @json
+    assert_equal 2, obj.case_one[0].case_two
+    assert_equal 'four', obj.case_one[0].case_three[0].case_four
+    assert_equal 5, obj.case_one[0].case_three[1]
+  end
+
+  it 'should get deep array values correctly with snake keys option false' do
+    obj = WhoopeeCushion::Inflate.from_hash @json, :to_snake_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]
+  end
+end
+
+describe 'converting from array' do
+  it "should return plain values unchanged" do
+    obj = WhoopeeCushion::Inflate.from_array [1, 2, 3, 'four', 'FiveFive', 'sixSix']
+    assert_equal 1, obj[0]
+    assert_equal 2, obj[1]
+    assert_equal 3, obj[2]
+    assert_equal 'four', obj[3]
+    assert_equal 'FiveFive', obj[4]
+    assert_equal 'sixSix', obj[5]
+  end
+
+  describe 'with an embedded hash' do
+    before do
+      @array = [1,2,3,'four',{'power' => 'to', 'ThePeople' => 'now'}]
+    end
+
+    it 'should convert an embedded hash' do
+      obj = WhoopeeCushion::Inflate.from_array @array
+      assert_equal 1, obj[0]
+      assert_equal 'to', obj[4].power
+      assert_equal 'now', obj[4].the_people
+    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
+      assert_equal 'now', obj[4].ThePeople
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,54 @@
+require 'whoopee_cushion'
+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

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'whoopee_cushion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "whoopee-cushion"
+  spec.version       = WhoopeeCushion::VERSION
+  spec.authors       = ["Ben Dunkley"]
+  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.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.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 4.7.3"
+end
+

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: whoopee-cushion
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Dunkley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+description: Inflates JSON data recursively into structs to allow use of dot notation
+  for data access.
+email:
+- ben@chemica.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/whoopee_cushion.rb
+- lib/whoopee_cushion/version.rb
+- test/inflate_test.rb
+- test/test_helper.rb
+- whoopee_cushion.gemspec
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Allow recursive inflation of JSON data into structs.
+test_files:
+- test/inflate_test.rb
+- test/test_helper.rb