flat_keys 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Firebase.co
+
+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,51 @@
+# flat_keys
+
+Encodes and Decodes key-value hashes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flat_keys'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flat_keys
+
+## Usage
+
+```ruby
+    
+    require 'flat_keys'
+    
+    {'name'=>{'fname'=>'John', 'lname'=>'Doe'}}.flat_keys
+    #=> {'name.fname'=>'John', 'name.lname'=>'Doe'}
+    
+    {'name.fname'=>'John', 'name.lname'=>'Doe'}.unflat_keys
+    #=> {'name'=>{'fname'=>'John', 'lname'=>'Doe'}}
+```
+
+Both `flat_keys` and `unflat_keys` can be used with custom separators.
+
+```ruby
+
+    {'name'=>{'fname'=>'John', 'lname'=>'Doe'}}.flat_keys('$')
+    #=> {'name$fname'=>'John', 'name$lname'=>'Doe'}
+
+```
+
+## Tests
+
+    rake
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'lib/flatinize'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+task :default => :test

data/flat_keys.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flat_keys/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "flat_keys"
+  gem.version       = FlatKeys::VERSION
+  gem.authors       = ["Firebaseco"]
+  gem.email         = ["hello@firebase.co"]
+  gem.description   = %q{Encodes and Decodes key-value hashes.}
+  gem.summary       = %q{Encodes and Decodes key-value hashes.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency 'rake'
+end

data/lib/flat_keys/version.rb

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

data/lib/flat_keys.rb

@@ -0,0 +1,41 @@
+require_relative "flat_keys/version"
+
+class Hash
+
+  def visit_flat_keys(hash, prefix, separator)
+    self.each do |k, v|
+      key = "#{prefix}#{k}"
+      if v.is_a?(Hash)
+        v.visit_flat_keys(hash, "#{key}#{separator}", separator)
+      else
+        hash[key] = v
+      end
+    end
+  end
+
+  def flat_keys(separator = ".")
+    hash = {}
+    visit_flat_keys(hash, "", separator)
+    return hash
+  end
+
+  def unflat_keys(separator)
+    hash = {}
+    self.each do |k, v|
+      names = k.split(separator)
+      last_index = names.count - 1
+      local_hash = hash
+      names.each_with_index do |name, index|
+        last = index == last_index
+        if last
+          local_hash[name] = v
+        else
+          local_hash = local_hash[name] || (local_hash[name] = Hash.new)
+        end
+      end
+    end
+    hash
+  end
+
+end
+

data/test/flat_keys_test.rb

@@ -0,0 +1,33 @@
+require_relative 'test_helper'
+
+describe "flat_keys" do
+
+  it "should return an empty hash when an empty hash is given" do
+     Hash.new.flat_keys.must_be_empty
+  end
+
+  it "should flat_keys all root keys" do
+    {'a'=>'Letter A', 'b'=>'Letter B'}.flat_keys.must_equal({'a'=>'Letter A', 'b'=>'Letter B'})
+  end
+
+  it "should flat_keys all nested keys" do
+    {'a'=>'Letter A', 'name'=>{'fname'=>'John', 'lname'=>'Doe'}}.flat_keys('$').must_equal({'a'=>'Letter A', 'name$fname'=>'John', 'name$lname'=>'Doe'})
+  end
+
+  it "should flat_keys with default separator " do
+    {'a'=>'Letter A', 'name'=>{'fname'=>'John'}}.flat_keys('.').must_equal({'a'=>'Letter A', 'name.fname'=>'John'})
+  end
+
+end
+
+describe "unflat_keys" do
+
+  it "should unflat all nested keys" do
+    {'a'=>'Letter A', 'name$fname'=>'John', 'name$lname'=>'Doe'}.unflat_keys('$').must_equal({'a'=>'Letter A', 'name'=>{'fname'=>'John', 'lname'=>'Doe'}})
+  end
+
+  it "should unflat with default separator " do
+    {'a'=>'Letter A', 'name.fname'=>'John'}.unflat_keys('.').must_equal({'a'=>'Letter A', 'name'=>{'fname'=>'John'}} )
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/flat_keys.rb', __FILE__)

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: flat_keys
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Firebaseco
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Encodes and Decodes key-value hashes.
+email:
+- hello@firebase.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- flat_keys.gemspec
+- lib/flat_keys.rb
+- lib/flat_keys/version.rb
+- test/flat_keys_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: Encodes and Decodes key-value hashes.
+test_files:
+- test/flat_keys_test.rb
+- test/test_helper.rb
+has_rdoc: