plissken 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "debugger"
+  gem "minitest", ">= 0", :require => 'minitest/spec'
+  gem "rdoc", "~> 3.12"
+  gem "bundler"
+  gem "jeweler", "~> 1.8.4"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    columnize (0.3.6)
+    debugger (1.2.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.4)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.4)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    minitest (4.6.1)
+    rake (10.0.3)
+    rdoc (3.12.1)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  debugger
+  jeweler (~> 1.8.4)
+  minitest
+  rdoc (~> 3.12)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Dave Hrycyszyn
+
+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,40 @@
+=======
+plissken
+========
+
+Have you ever needed to automatically convert JSON-style `camelBack` or `CamelCase` hash keys into more Rubyish `snake_case`?
+
+Plissken to the rescue.
+
+This gem recursively converts all camelBack or CamelCase keys in a hash structure to snake_case.
+
+## Usage
+
+```ruby
+my_hash = {"firstKey" => 1, "fooBars" => [{"bazBaz" => "value"}, {"blahBlah" => "value"}]}
+snaked_hash = my_hash.to_snake_keys
+# => {"first_key" => 1, "foo_bars" => [{"baz_baz" => "value"}, {"blah_blah" => "value"}]}
+```
+
+Plissken works on either string keys or symbolized keys. It has no dependencies, as has its own `underscore` method lifted out of ActiveSupport.
+
+## Limitations
+
+* Your keys must be camelBack or CamelCase. The key "Foo Bar" will output as "foo bar".
+* Unlike the original Snake Plissken in the seminal film [Escape from New York](http://en.wikipedia.org/wiki/Escape_from_New_York), the plissken gem is non-destructive. There is no Hash#to_snake_keys! form.
+
+## Contributing to plissken
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Dave Hrycyszyn. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "plissken"
+  gem.homepage = "http://github.com/futurechimp/plissken"
+  gem.license = "MIT"
+  gem.summary = %Q{Snakify your camel keys when working with JSON APIs}
+  gem.description = %Q{
+    Have you ever needed to automatically convert JSON-style camelBack or
+    CamelCase hash keys into more Rubyish snake_case?
+
+    Plissken to the rescue.
+
+    This gem recursively converts all camelBack or CamelCase keys in a hash
+    structure to snake_case.
+  }
+  gem.email = "dave.hrycyszyn@headlondon.com"
+  gem.authors = ["Dave Hrycyszyn"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "plissken #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/plissken.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/plissken/ext/hash/to_snake_keys'

data/lib/plissken/ext/hash/to_snake_keys.rb

@@ -0,0 +1,38 @@
+class Hash
+
+  # Recursively converts CamelCase and camelBack JSON-style hash keys to
+  # Rubyish snake_case, suitable for use during instantiation of Ruby
+  # model attributes.
+  #
+  def to_snake_keys(value = self)
+    case value
+      when Array
+        value.map { |v| to_snake_keys(v) }
+      when Hash
+        Hash[value.map { |k, v| [underscore_key(k), to_snake_keys(v)] }]
+      else
+        value
+    end
+  end
+
+  private
+
+  def underscore_key(k)
+    if k.is_a? Symbol
+      underscore(k.to_s).to_sym
+    elsif k.is_a? String
+      underscore(k)
+    else
+      k # Plissken can't snakify anything except strings and symbols
+    end
+  end
+
+  def 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

data/plissken.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "plissken"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dave Hrycyszyn"]
+  s.date = "2013-02-19"
+  s.description = "\n    Have you ever needed to automatically convert JSON-style camelBack or\n    CamelCase hash keys into more Rubyish snake_case?\n\n    Plissken to the rescue.\n\n    This gem recursively converts all camelBack or CamelCase keys in a hash\n    structure to snake_case.\n  "
+  s.email = "dave.hrycyszyn@headlondon.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/plissken.rb",
+    "lib/plissken/ext/hash/to_snake_keys.rb",
+    "plissken.gemspec",
+    "test/helper.rb",
+    "test/plissken/ext/hash/to_snake_keys_test.rb",
+    "test/test_plissken.rb"
+  ]
+  s.homepage = "http://github.com/futurechimp/plissken"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Snakify your camel keys when working with JSON APIs"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<debugger>, [">= 0"])
+      s.add_development_dependency(%q<minitest>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<debugger>, [">= 0"])
+      s.add_dependency(%q<minitest>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<debugger>, [">= 0"])
+    s.add_dependency(%q<minitest>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/spec'
+require 'debugger'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'plissken'
+
+class MiniTest::Unit::TestCase
+end
+
+MiniTest::Unit.autorun

data/test/plissken/ext/hash/to_snake_keys_test.rb

@@ -0,0 +1,170 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_plissken.rb')
+
+describe "A Hash" do
+  describe "with camelBack keys" do
+    describe "which are JSON-style strings" do
+      describe "in the simplest case" do
+        before do
+          @hash = { "firstKey" => "fooBar" }
+        end
+
+        describe "non-destructive snakification" do
+          before do
+            @snaked = @hash.to_snake_keys
+          end
+
+          it "snakifies the key" do
+            assert_equal(@snaked.keys.first, "first_key")
+          end
+
+          it "leaves the key as a string" do
+            assert_equal("first_key", @snaked.keys.first)
+          end
+
+          it "leaves the value untouched" do
+            assert_equal(@snaked.values.first, "fooBar")
+          end
+
+          it "leaves the original hash untouched" do
+            assert_equal(@hash.keys.first, "firstKey")
+          end
+        end
+      end
+
+      describe "containing an array of other hashes" do
+        before do
+          @hash = {
+            "appleType" => "Granny Smith",
+            "vegetableTypes" => [
+              {"potatoType" => "Golden delicious"},
+              {"otherTuberType" => "peanut"},
+                  {"peanutNamesAndSpouses" => [
+                    {"billThePeanut" => "sallyPeanut"}, {"sammyThePeanut" => "jillPeanut"}
+                  ]}
+              ]}
+        end
+
+        describe "non-destructive snakification" do
+          before do
+            @snaked = @hash.to_snake_keys
+          end
+
+          it "recursively snakifies the keys on the top level of the hash" do
+            assert @snaked.keys.include?("apple_type")
+            assert @snaked.keys.include?("vegetable_types")
+          end
+
+          it "leaves the values on the top level alone" do
+            assert_equal(@snaked["apple_type"], "Granny Smith")
+          end
+
+          it "converts second-level keys" do
+            assert @snaked["vegetable_types"].first.has_key? "potato_type"
+          end
+
+          it "leaves second-level values alone" do
+            assert @snaked["vegetable_types"].first.has_value? "Golden delicious"
+          end
+
+          it "converts third-level keys" do
+            assert @snaked["vegetable_types"].last["peanut_names_and_spouses"].first.has_key?("bill_the_peanut")
+            assert @snaked["vegetable_types"].last["peanut_names_and_spouses"].last.has_key?("sammy_the_peanut")
+          end
+
+          it "leaves third-level values alone" do
+            assert_equal "sallyPeanut", @snaked["vegetable_types"].last["peanut_names_and_spouses"].first["bill_the_peanut"]
+            assert_equal "jillPeanut", @snaked["vegetable_types"].last["peanut_names_and_spouses"].last["sammy_the_peanut"]
+          end
+        end
+      end
+    end
+
+    describe "which are symbols" do
+      describe "in the simplest case" do
+        before do
+          @hash = { :firstKey => "fooBar" }
+        end
+
+        describe "non-destructive snakification" do
+          before do
+            @snaked = @hash.to_snake_keys
+          end
+
+          it "snakifies the key" do
+            assert_equal(@snaked.keys.first, :first_key)
+          end
+
+          it "leaves the key as a symbol" do
+            assert_equal(:first_key, @snaked.keys.first)
+          end
+
+          it "leaves the value untouched" do
+            assert_equal(@snaked.values.first, "fooBar")
+          end
+
+          it "leaves the original hash untouched" do
+            assert_equal(@hash.keys.first, :firstKey)
+          end
+        end
+      end
+
+      describe "containing an array of other hashes" do
+        before do
+          @hash = {
+            :appleType => "Granny Smith",
+            :vegetableTypes => [
+              {:potatoType => "Golden delicious"},
+              {:otherTuberType => "peanut"},
+                  {:peanutNamesAndSpouses => [
+                    {:billThePeanut => "sallyPeanut"}, {:sammyThePeanut => "jillPeanut"}
+                  ]}
+              ]}
+        end
+
+        describe "non-destructive snakification" do
+          before do
+            @snaked = @hash.to_snake_keys
+          end
+
+          it "recursively snakifies the keys on the top level of the hash" do
+            assert @snaked.keys.include?(:apple_type)
+            assert @snaked.keys.include?(:vegetable_types)
+          end
+
+          it "leaves the values on the top level alone" do
+            assert_equal(@snaked[:apple_type], "Granny Smith")
+          end
+
+          it "converts second-level keys" do
+            assert @snaked[:vegetable_types].first.has_key? :potato_type
+          end
+
+          it "leaves second-level values alone" do
+            assert @snaked[:vegetable_types].first.has_value? "Golden delicious"
+          end
+
+          it "converts third-level keys" do
+            assert @snaked[:vegetable_types].last[:peanut_names_and_spouses].first.has_key?(:bill_the_peanut)
+            assert @snaked[:vegetable_types].last[:peanut_names_and_spouses].last.has_key?(:sammy_the_peanut)
+          end
+
+          it "leaves third-level values alone" do
+            assert_equal "sallyPeanut", @snaked[:vegetable_types].last[:peanut_names_and_spouses].first[:bill_the_peanut]
+            assert_equal "jillPeanut", @snaked[:vegetable_types].last[:peanut_names_and_spouses].last[:sammy_the_peanut]
+          end
+        end
+      end
+    end
+  end
+
+  describe "strings with spaces in them" do
+    before do
+      @hash = { "With Spaces" => "FooBar"}
+      @snaked = @hash.to_snake_keys
+    end
+
+    it "doesn't get snaked, although it does get downcased" do
+      assert @snaked.keys.include? "with spaces"
+    end
+  end
+end

data/test/test_plissken.rb

@@ -0,0 +1,2 @@
+require 'helper'
+require File.dirname(__FILE__) + '/../lib/plissken/ext/hash/to_snake_keys'

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: plissken
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Dave Hrycyszyn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+description: ! "\n    Have you ever needed to automatically convert JSON-style camelBack
+  or\n    CamelCase hash keys into more Rubyish snake_case?\n\n    Plissken to the
+  rescue.\n\n    This gem recursively converts all camelBack or CamelCase keys in
+  a hash\n    structure to snake_case.\n  "
+email: dave.hrycyszyn@headlondon.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/plissken.rb
+- lib/plissken/ext/hash/to_snake_keys.rb
+- plissken.gemspec
+- test/helper.rb
+- test/plissken/ext/hash/to_snake_keys_test.rb
+- test/test_plissken.rb
+homepage: http://github.com/futurechimp/plissken
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4152380818208412704
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Snakify your camel keys when working with JSON APIs
+test_files: []