yaml_convertor 1.0.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yaml_convertor.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 nour
+
+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,166 @@
+# YamlConvertor
+
+Ruby gem that converts a YAML hash structure to a simple hash consisting of key:value only, and vice versa
+
+a YAML hash structure could look like this:
+````
+{"fruit"=> {
+    "lemon"=>"yellow", 
+    "apple"=>{ "red_apples"=>"red" }
+  }
+}
+````
+The resulting simple key:value hash looks like this:
+````
+{"fruit.lemon"=>"yellow", "fruit.apple.red_apples"=>"red"}
+````
+
+This works the other way around, too: if you had the simple hash; you can reconstruct the YAML hash structure.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yaml_convertor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yaml_convertor
+
+## Usage
+
+There are two methods you can use:
+- flattener converts the structured nested YAML hash to a simple key:value
+
+````
+YamlConvertor.flattener(yml_hash)
+````
+
+- builder rebuilds the simple hash to a nested YAML structure
+
+````
+YamlConvertor.builder(flat_hash)
+````
+
+## Example
+
+Let's assume we have a YAML file called "file.yml":
+
+````
+en:
+  errors:
+    messages:
+      not_locked: "was not locked"
+      not_saved:
+        other: "other error"
+  devise:
+    failure:
+      already_authenticated: 'You are already signed in.'
+    sessions:
+      signed_in: 'Signed in successfully.'
+````
+
+We open this file using Psych (Ruby's YAML parser), and it will return a nested YAML hash structure
+
+````ruby
+yml_hash = Psych.load_file('file.yml')
+````
+
+yml_hash looks like this:
+
+````
+{"en"=>{
+  "errors"=>{
+    "messages"=>{
+      "not_locked"=>"was not locked", 
+      "not_saved"=>{"other"=>"other error"}
+    }
+  }, 
+  "devise"=>{
+    "failure"=>{"already_authenticated"=>"You are already signed in."}, 
+    "sessions"=>{"signed_in"=>"Signed in successfully."}}
+  }
+}
+````
+
+Now! If we use flattener:
+
+````
+flat_hash = YamlConvertor.flattener(yml_hash)
+````
+
+flat_hash will look like this:
+
+````
+{
+  "en.errors.messages.not_locked"=>"was not locked", 
+  "en.errors.messages.not_saved.other"=>"other error", 
+  "en.devise.failure.already_authenticated"=>"You are already signed in.", 
+  "en.devise.sessions.signed_in"=>"Signed in successfully."
+}
+````
+
+## Example 2
+
+Now let's assume we have a flat hash and we want to rebuild it to a YAML file.
+Here's our flat_hash from our example above:
+
+````ruby
+flat_hash = {"en.errors.messages.not_locked"=>"was not locked", "en.errors.messages.not_saved.other"=>"other error", "en.devise.failure.already_authenticated"=>"You are already signed in.", "en.devise.sessions.signed_in"=>"Signed in successfully."}
+
+nested_hash = YamlConvertor.builder(flat_hash)
+````
+nested_hash is now:
+
+````
+{"en"=>{
+  "errors"=>{
+    "messages"=>{
+      "not_locked"=>"was not locked", 
+      "not_saved"=>{"other"=>"other error"}
+    }
+  }, 
+  "devise"=>{
+    "failure"=>{"already_authenticated"=>"You are already signed in."}, 
+    "sessions"=>{"signed_in"=>"Signed in successfully."}}
+  }
+}
+````
+
+Dump it with Pysch..
+
+````ruby
+Psych.dump(nested_hash)
+````
+
+The output will be:
+````
+---
+en:
+  errors:
+    messages:
+      not_locked: was not locked
+      not_saved:
+        other: other error
+  devise:
+    failure:
+      already_authenticated: You are already signed in.
+    sessions:
+      signed_in: Signed in successfully.
+````
+
+## Note
+
+These methods only work properly if you have valid YAML structure. I didn't test that yet but I assume so!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/yaml_convertor/version.rb

@@ -0,0 +1,3 @@
+module YamlConvertor
+  VERSION = "1.0.0"
+end

data/lib/yaml_convertor.rb

@@ -0,0 +1,45 @@
+require 'yaml_convertor/version'
+require 'psych'
+
+module YamlConvertor
+  def self.flattener(nested_hash)
+    raise "Argument must be a Hash" unless nested_hash.is_a?(Hash)
+    Convertor.new.flatten(nested_hash)
+  end
+  def self.builder(flat_hash)
+    raise "Argument must be a Hash" unless flat_hash.is_a?(Hash)
+    Convertor.new.build(flat_hash)
+  end
+  
+  class Convertor
+    def flatten(nested_hash, keyname = '')
+      hash = {}
+      nested_hash.each_pair do |key, value|
+        if value.is_a?(Hash)
+          name = keyname.empty? ? "#{key}" : "#{keyname}.#{key}"
+          hash.merge!(flatten(value, name))
+        else
+          hash["#{keyname}.#{key}"] = value
+        end
+      end
+      hash
+    end
+    def build(flat_hash)
+      # create a hash where every key's value is an empty hash
+      # hash[key] <- creates a key and its value will be {}
+      hash = Hash.new{ |h, k| h[k] = Hash.new(&h.default_proc) }  
+      flat_hash.each_pair do |key, value|
+        tmp = hash
+        arr_keys = key.split('.')
+        arr_keys.each do |item|
+          if item.eql?(arr_keys.last)
+            tmp[item] = value
+          else
+            tmp = tmp[item] #creates key
+          end
+        end
+      end
+      hash
+    end
+  end
+end

data/test/devise.en.yml

@@ -0,0 +1,11 @@
+en:
+  errors:
+    messages:
+      not_locked: "was not locked"
+      not_saved:
+        other: "other error"
+  devise:
+    failure:
+      already_authenticated: 'You are already signed in.'
+    sessions:
+      signed_in: 'Signed in successfully.'

data/test/test_convertor.rb

@@ -0,0 +1,17 @@
+require 'test/unit'
+require 'yaml_convertor'
+
+class TestConvertor < Test::Unit::TestCase
+
+  def test_must_return_flattened_hash
+    nested_hash = {"k1"=>{"k2"=>"v", "k3"=>{"k4"=>"v", "k5"=>["v", "v"], "k6"=>{"k7"=>"v"}}, "k8"=>{"k9"=>{"k10"=>{"k11"=>"v", "k12"=>"v"}}}}}
+    flat_hash = {"k1.k2"=>"v", "k1.k3.k4"=>"v", "k1.k3.k5"=>["v", "v"], "k1.k3.k6.k7"=>"v", "k1.k8.k9.k10.k11"=>"v", "k1.k8.k9.k10.k12"=>"v"}
+    assert_equal flat_hash, YamlConvertor.flattener(nested_hash)
+  end
+
+  def test_must_return_nested_hash
+    flat_hash = {"k1.k2"=>"v", "k1.k3.k4"=>"v", "k1.k3.k5"=>["v", "v"], "k1.k3.k6.k7"=>"v", "k1.k8.k9.k10.k11"=>"v", "k1.k8.k9.k10.k12"=>"v"}
+    nested_hash = {"k1"=>{"k2"=>"v", "k3"=>{"k4"=>"v", "k5"=>["v", "v"], "k6"=>{"k7"=>"v"}}, "k8"=>{"k9"=>{"k10"=>{"k11"=>"v", "k12"=>"v"}}}}}
+    assert_equal nested_hash, YamlConvertor.builder(flat_hash)
+  end
+end

data/yaml_convertor.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yaml_convertor/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Nour"]
+  gem.email         = ["nour.fwh@gmail.com"]
+  gem.description   = %q{yaml_convertor converts YAML structure to JSON }
+  gem.summary       = %q{YAML to JSON convertor}
+  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.name          = "yaml_convertor"
+  gem.require_paths = ["lib"]
+  gem.version       = YamlConvertor::VERSION
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rb-readline'
+  gem.add_development_dependency 'test-unit'
+  gem.add_runtime_dependency 'psych', '1.3.4'
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: yaml_convertor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Nour
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-10 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'
+- !ruby/object:Gem::Dependency
+  name: rb-readline
+  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: test-unit
+  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: psych
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+description: ! 'yaml_convertor converts YAML structure to JSON '
+email:
+- nour.fwh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/yaml_convertor.rb
+- lib/yaml_convertor/version.rb
+- test/devise.en.yml
+- test/test_convertor.rb
+- yaml_convertor.gemspec
+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'
+      segments:
+      - 0
+      hash: 412658065
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 412658065
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: YAML to JSON convertor
+test_files:
+- test/devise.en.yml
+- test/test_convertor.rb