yaml_convertor 1.0.0 → 1.0.1

data/.gitignore

@@ -15,4 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.rvm
+.rvmrc

data/README.md

@@ -14,33 +14,32 @@ 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
+- **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
+- **builder** rebuilds the simple hash to a nested YAML structure
 
 ````
 YamlConvertor.builder(flat_hash)
@@ -48,8 +47,7 @@ YamlConvertor.builder(flat_hash)
 
 ## Example
 
-Let's assume we have a YAML file called "file.yml":
-
+Let's assume we have a YAML file called **file.yml**:
 ````
 en:
   errors:
@@ -63,15 +61,11 @@ en:
     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"=>{
@@ -86,15 +80,11 @@ yml_hash looks like this:
   }
 }
 ````
-
 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", 
@@ -108,14 +98,11 @@ flat_hash will look like this:
 
 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"=>{
@@ -130,13 +117,10 @@ nested_hash is now:
   }
 }
 ````
-
 Dump it with Pysch..
-
 ````ruby
 Psych.dump(nested_hash)
 ````
-
 The output will be:
 ````
 ---

data/lib/yaml_convertor.rb

@@ -1,5 +1,4 @@
 require 'yaml_convertor/version'
-require 'psych'
 
 module YamlConvertor
   def self.flattener(nested_hash)

data/lib/yaml_convertor/version.rb

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

data/yaml_convertor.gemspec

@@ -4,9 +4,9 @@ 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.description   = %q{yaml_convertor converts YAML hash structure to simple key:value }
+  gem.summary       = %q{YAML to simple key:value hash}
+  gem.homepage      = "https://rubygems.org/gems/yaml_convertor"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -16,7 +16,6 @@ Gem::Specification.new do |gem|
   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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaml_convertor
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -27,22 +27,6 @@ dependencies:
     - - ! '>='
       - !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
@@ -75,7 +59,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.3.4
-description: ! 'yaml_convertor converts YAML structure to JSON '
+description: ! 'yaml_convertor converts YAML hash structure to simple key:value '
 email:
 - nour.fwh@gmail.com
 executables: []
@@ -92,7 +76,7 @@ files:
 - test/devise.en.yml
 - test/test_convertor.rb
 - yaml_convertor.gemspec
-homepage: ''
+homepage: https://rubygems.org/gems/yaml_convertor
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -106,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 412658065
+      hash: 204075919
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -115,13 +99,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 412658065
+      hash: 204075919
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: YAML to JSON convertor
+summary: YAML to simple key:value hash
 test_files:
 - test/devise.en.yml
 - test/test_convertor.rb