yaml_converters 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/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Tomek Wałkuski
+
+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,58 @@
+# YamlConverters
+
+Convert YAML to segments and back.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yaml_converters'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yaml_converters
+
+## Usage
+
+Use `YamlConverters::YamlToSegmentsConverter#convert` to split YAML file
+into flat key-value pairs.
+
+You can pass custom `segment_writer` to dump generated segments
+somewhere (database, for example). Custom writer should respond to
+two public methods:
+
+* `write` - performs actual key-value pair dumping
+* `result` - returns whatever you want from `convert`
+
+Default `segment_writer` is an instance of
+`YamlConverters::SegmentToHashWriter` that returns a `Hash`.
+
+Use `YamlConverters::SegmentsToYamlConverter#convert` to dump segments
+(key-value pairs) to YAML file.
+
+You can pass custom `yaml_writer` to dump generated YAML file
+somewhere (file, for example). Custom writer should respond to
+two public methods:
+
+* `write` - performs actual YAML string dumping
+* `result` - returns whatever you want from `convert`
+
+Default `yaml_writer` is an instance of
+`YamlConverters::YamlToStringWriter` that returns a `String`.
+
+## Acknowledgements
+
+Implementation of flattening a YAML file and generating a YAML file
+from key-value pairs taken (I hope, for now) from Tolk codebase.
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/yaml_converters/segment_to_hash_writer.rb

@@ -0,0 +1,13 @@
+module YamlConverters
+  class SegmentToHashWriter
+    attr_reader :result
+
+    def initialize
+      @result = {}
+    end
+
+    def write(hash)
+      @result.deep_merge!(hash)
+    end
+  end
+end

data/lib/yaml_converters/segments_to_yaml_converter.rb

@@ -0,0 +1,38 @@
+module YamlConverters
+  class SegmentsToYamlConverter
+    def initialize(segments, yaml_writer = YamlConverters::YamlToStringWriter.new)
+      @segments    = segments
+      @yaml_writer = yaml_writer
+    end
+
+    def convert
+      @yaml_writer.write(Psych.dump(raw_yaml_hash))
+
+      @yaml_writer.result
+    end
+
+    private
+
+    def raw_yaml_hash
+      @raw_yaml_hash ||= @segments.each_with_object({}) do |(key, value), raw_yaml_hash|
+        if key.include?(YamlConverters::SEGMENT_KEY_DELIMITER)
+          raw_yaml_hash.deep_merge!(unsquish(key, value))
+        else
+          raw_yaml_hash[key] = value
+        end
+      end
+    end
+
+    def unsquish(string, value)
+      if string.is_a?(String)
+        unsquish(string.split(YamlConverters::SEGMENT_KEY_DELIMITER), value)
+      elsif string.size == 1
+        { string.first => value }
+      else
+        key  = string[0]
+        rest = string[1..-1]
+        { key => unsquish(rest, value) }
+      end
+    end
+  end
+end

data/lib/yaml_converters/version.rb

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

data/lib/yaml_converters/yaml_to_segments_converter.rb

@@ -0,0 +1,40 @@
+module YamlConverters
+  class YamlToSegmentsConverter
+    def initialize(file_path, segment_writer = YamlConverters::SegmentToHashWriter.new)
+      @file_path      = file_path
+      @segment_writer = segment_writer
+    end
+
+    def convert
+      flatten_hash(raw_yaml_hash)
+
+      @segment_writer.result
+    end
+
+    private
+
+    def file_contents
+      # TODO: Allow fetching from different source
+      @file_contents ||= File.read(@file_path)
+    end
+
+    def raw_yaml_hash
+      @raw_yaml_hash ||= Psych.load(file_contents)
+    end
+
+    def flatten_hash(hash, prefix = nil, result = {})
+      hash.each do |key, value|
+        current_prefix = prefix ? "#{prefix}#{YamlConverters::SEGMENT_KEY_DELIMITER}#{key}" : String(key)
+
+        if !value.is_a?(Hash)
+          result[current_prefix] = value
+          @segment_writer.write({ current_prefix => value })
+        else
+          flatten_hash(value, current_prefix, result)
+        end
+      end
+
+      result
+    end
+  end
+end

data/lib/yaml_converters/yaml_to_string_writer.rb

@@ -0,0 +1,13 @@
+module YamlConverters
+  class YamlToStringWriter
+    attr_reader :result
+
+    def initialize
+      @result = ''
+    end
+
+    def write(yaml)
+      @result = yaml
+    end
+  end
+end

data/lib/yaml_converters.rb

@@ -0,0 +1,11 @@
+require 'active_support/core_ext/hash'
+
+require 'yaml_converters/version'
+require 'yaml_converters/yaml_to_segments_converter'
+require 'yaml_converters/segments_to_yaml_converter'
+require 'yaml_converters/segment_to_hash_writer'
+require 'yaml_converters/yaml_to_string_writer'
+
+module YamlConverters
+  SEGMENT_KEY_DELIMITER = '.'
+end

data/spec/fixtures/deeply_nested_key_value_pairs.yml

@@ -0,0 +1,6 @@
+---
+grandmother:
+  mother:
+   daughter: olga
+   sister: ania
+grandfather: eugeniusz

data/spec/fixtures/nested_key_value_pair.yml

@@ -0,0 +1,3 @@
+---
+parent:
+  child: value

data/spec/fixtures/one_key_value_pair.yml

@@ -0,0 +1,2 @@
+---
+key: value

data/spec/fixtures/two_key_value_pairs.yml

@@ -0,0 +1,3 @@
+---
+key1: value1
+key2: value2

data/spec/segment_to_hash_writer_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe YamlConverters::SegmentToHashWriter do
+  subject { described_class.new }
+  let(:hash) { { 'key' => 'value' } }
+
+  it 'should return the same hash' do
+    expect do
+      subject.write(hash)
+    end.to change { subject.result }.from({}).to(hash)
+  end
+end

data/spec/segments_to_yaml_converter_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe YamlConverters::SegmentsToYamlConverter do
+  subject { described_class.new(segments) }
+
+  context 'simple one key-value pair segment' do
+    let(:segments) { { 'key' => 'value' } }
+
+    its(:convert) { should eq("---\nkey: value\n") }
+  end
+
+  context 'simple two key-value pairs segments' do
+    let(:segments) { { 'key1' => 'value1', 'key2' => 'value2' } }
+
+    its(:convert) { should eq("---\nkey1: value1\nkey2: value2\n") }
+  end
+
+  context 'nested key-value pair segments' do
+    let(:segments) { { 'parent.child' => 'value' } }
+
+    its(:convert) { should eq("---\nparent:\n  child: value\n") }
+  end
+
+  context 'deeply nested key-value pairs segments' do
+    let(:segments) do
+      {
+        'grandmother.mother.daughter' => 'olga',
+        'grandmother.mother.sister' => 'ania',
+        'grandfather' => 'eugeniusz'
+      }
+    end
+
+    its(:convert) { should eq(
+      "---\ngrandmother:\n  mother:\n    daughter: olga\n    sister: ania\ngrandfather: eugeniusz\n"
+    ) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+
+SimpleCov.start
+
+require 'yaml_converters'

data/spec/yaml_to_segments_converter_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe YamlConverters::YamlToSegmentsConverter do
+  subject { described_class.new(file_path) }
+
+  context 'simple one key-value pair file' do
+    let(:file_path) { 'spec/fixtures/one_key_value_pair.yml' }
+
+    its(:convert) { should eq({ 'key' => 'value' }) }
+  end
+
+  context 'simple two key-value pairs file' do
+    let(:file_path) { 'spec/fixtures/two_key_value_pairs.yml' }
+
+    its(:convert) { should eq({ 'key1' => 'value1', 'key2' => 'value2' }) }
+  end
+
+  context 'nested key-value pair file' do
+    let(:file_path) { 'spec/fixtures/nested_key_value_pair.yml' }
+
+    its(:convert) { should eq({ 'parent.child' => 'value' }) }
+  end
+
+  context 'deeply ested key-value pairs file' do
+    let(:file_path) { 'spec/fixtures/deeply_nested_key_value_pairs.yml' }
+
+    its(:convert) do
+      should eq({
+        'grandmother.mother.daughter' => 'olga',
+        'grandmother.mother.sister' => 'ania',
+        'grandfather' => 'eugeniusz'
+      })
+    end
+  end
+end

data/spec/yaml_to_string_writer_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe YamlConverters::YamlToStringWriter do
+  subject { described_class.new }
+  let(:yaml) { "---\nparent:\n  child: value\n" }
+
+  it 'should return the same yaml' do
+    expect do
+      subject.write(yaml)
+    end.to change { subject.result }.from('').to(yaml)
+  end
+end

data/yaml_converters.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yaml_converters/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'yaml_converters'
+  gem.version       = YamlConverters::VERSION
+  gem.authors       = ['Tomek Wałkuski']
+  gem.email         = ['ja@jestem.tw']
+  gem.description   = %q{Convert YAML to segments and back}
+  gem.summary       = %q{Convert YAML to segments and back}
+  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_dependency('activesupport')
+  gem.add_dependency('psych')
+
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('simplecov')
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: yaml_converters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tomek Wałkuski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rspec
+  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: simplecov
+  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: Convert YAML to segments and back
+email:
+- ja@jestem.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yaml_converters.rb
+- lib/yaml_converters/segment_to_hash_writer.rb
+- lib/yaml_converters/segments_to_yaml_converter.rb
+- lib/yaml_converters/version.rb
+- lib/yaml_converters/yaml_to_segments_converter.rb
+- lib/yaml_converters/yaml_to_string_writer.rb
+- spec/fixtures/deeply_nested_key_value_pairs.yml
+- spec/fixtures/nested_key_value_pair.yml
+- spec/fixtures/one_key_value_pair.yml
+- spec/fixtures/two_key_value_pairs.yml
+- spec/segment_to_hash_writer_spec.rb
+- spec/segments_to_yaml_converter_spec.rb
+- spec/spec_helper.rb
+- spec/yaml_to_segments_converter_spec.rb
+- spec/yaml_to_string_writer_spec.rb
+- yaml_converters.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: -872080065287608122
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -872080065287608122
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Convert YAML to segments and back
+test_files:
+- spec/fixtures/deeply_nested_key_value_pairs.yml
+- spec/fixtures/nested_key_value_pair.yml
+- spec/fixtures/one_key_value_pair.yml
+- spec/fixtures/two_key_value_pairs.yml
+- spec/segment_to_hash_writer_spec.rb
+- spec/segments_to_yaml_converter_spec.rb
+- spec/spec_helper.rb
+- spec/yaml_to_segments_converter_spec.rb
+- spec/yaml_to_string_writer_spec.rb