yaml_converters 0.1.0 → 0.2.0

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+script: bundle exec rspec spec
+notifications:
+  email:
+    - ja@jestem.tw

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Version 0.2 (2012-07-29)
+
+* Allow to read YAML file contents from a different source (file, AWS)
+
 ## Version 0.1 (2012-07-29)
 
 * Add CHANGELOG

data/README.md

@@ -1,4 +1,4 @@
-# YamlConverters
+# YamlConverters  [![Build Status](https://secure.travis-ci.org/tomekw/yaml_converters.png)](http://travis-ci.org/tomekw/yaml_converters)
 
 Convert YAML to segments and back.
 
@@ -16,11 +16,26 @@ Or install it yourself as:
 
     $ gem install yaml_converters
 
+Supported Ruby versions:
+
+* `1.9.3`
+* `1.9.2`
+
 ## Usage
 
+### Converting YAML into segments
+
 Use `YamlConverters::YamlToSegmentsConverter#convert` to split YAML file
 into flat key-value pairs.
 
+``` ruby
+yaml_reader = YamlConverters::YamlFileReader.new('path/to/file.yml')
+converter = YamlConverters::YamlToSegmentsConverter.new(
+  yaml_reader, YamlConverters::SegmentToHashWriter.new
+)
+converter.convert # => { 'key' => 'value', ... }
+```
+
 You can pass custom `segment_writer` to dump generated segments
 somewhere (database, for example). Custom writer should respond to
 two public methods:
@@ -47,9 +62,40 @@ module YamlConverters
 end
 ```
 
+You can pass custom `yaml_reader` to read YAML file from
+a different source (AWS, for example). Custom reader should respond to
+one public method:
+
+* `read` - returns string containing YAML file contents
+
+Example `yaml_reader`:
+
+``` ruby
+module YamlConverters
+  class YamlFileReader
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def read
+      File.read(@file_path)
+    end
+  end
+end
+```
+
+### Converting segments into YAML
+
 Use `YamlConverters::SegmentsToYamlConverter#convert` to dump segments
 (key-value pairs) to YAML file.
 
+``` ruby
+converter = YamlConverters::SegmentsToYamlConverter(
+  { 'key' => 'value' }, YamlConverters::YamlToStringWriter.new
+)
+converter.convert # => "---\nkey: value\n"
+```
+
 You can pass custom `yaml_writer` to dump generated YAML file
 somewhere (file, for example). Custom writer should respond to
 two public methods:
@@ -81,6 +127,10 @@ end
 Implementation of flattening a YAML file and generating a YAML file
 from key-value pairs taken (I hope, for now) from Tolk codebase.
 
+## Warning
+
+Until version `1.0.0` is reached API may be changed without any notice!
+
 ## Contributing
 
 1. Fork it

data/lib/yaml_converters/version.rb

@@ -1,3 +1,3 @@
 module YamlConverters
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/yaml_converters/yaml_file_reader.rb

@@ -0,0 +1,11 @@
+module YamlConverters
+  class YamlFileReader
+    def initialize(file_path)
+      @file_path = file_path
+    end
+
+    def read
+      File.read(@file_path)
+    end
+  end
+end

data/lib/yaml_converters/yaml_to_segments_converter.rb

@@ -1,7 +1,7 @@
 module YamlConverters
   class YamlToSegmentsConverter
-    def initialize(file_path, segment_writer = YamlConverters::SegmentToHashWriter.new)
-      @file_path      = file_path
+    def initialize(yaml_reader, segment_writer = YamlConverters::SegmentToHashWriter.new)
+      @yaml_reader    = yaml_reader
       @segment_writer = segment_writer
     end
 
@@ -14,8 +14,7 @@ module YamlConverters
     private
 
     def file_contents
-      # TODO: Allow fetching from different source
-      @file_contents ||= File.read(@file_path)
+      @file_contents ||= @yaml_reader.read
     end
 
     def raw_yaml_hash

data/lib/yaml_converters.rb

@@ -5,6 +5,7 @@ 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'
+require 'yaml_converters/yaml_file_reader'
 
 module YamlConverters
   SEGMENT_KEY_DELIMITER = '.'

data/spec/integration/yaml_to_segments_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'YAML to segments conversion' do
+  subject           { YamlConverters::YamlToSegmentsConverter.new(yaml_reader) }
+  let(:yaml_reader) { YamlConverters::YamlFileReader.new(file_path) }
+  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

data/spec/unit/yaml_file_reader_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe YamlConverters::YamlFileReader do
+  subject { described_class.new(file_path) }
+  let(:file_path) { 'spec/fixtures/one_key_value_pair.yml' }
+  let(:expected_yaml_string) { "---\nparent:\n  child: value\n" }
+
+  before do
+    File.stub(:read).with(file_path).and_return(expected_yaml_string)
+  end
+
+  its(:read) { should eq(expected_yaml_string) }
+end

data/spec/{yaml_to_segments_converter_spec.rb → unit/yaml_to_segments_converter_spec.rb}

@@ -1,28 +1,31 @@
 require 'spec_helper'
 
 describe YamlConverters::YamlToSegmentsConverter do
-  subject { described_class.new(file_path) }
+  subject { described_class.new(yaml_reader) }
+  let(:yaml_reader) { stub(read: file_contents) }
 
   context 'simple one key-value pair file' do
-    let(:file_path) { 'spec/fixtures/one_key_value_pair.yml' }
+    let(:file_contents) { "---\nkey: value\n" }
 
     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' }
+    let(:file_contents) { "---\nkey1: value1\nkey2: value2\n" }
 
     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' }
+    let(:file_contents) { "---\nparent:\n  child: value\n" }
 
     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' }
+    let(:file_contents) do
+      "---\ngrandmother:\n  mother:\n    daughter: olga\n    sister: ania\ngrandfather: eugeniusz\n"
+    end
 
     its(:convert) do
       should eq({

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaml_converters
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -100,6 +100,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -109,17 +110,20 @@ files:
 - 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_file_reader.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/integration/yaml_to_segments_spec.rb
 - spec/spec_helper.rb
-- spec/yaml_to_segments_converter_spec.rb
-- spec/yaml_to_string_writer_spec.rb
+- spec/unit/segment_to_hash_writer_spec.rb
+- spec/unit/segments_to_yaml_converter_spec.rb
+- spec/unit/yaml_file_reader_spec.rb
+- spec/unit/yaml_to_segments_converter_spec.rb
+- spec/unit/yaml_to_string_writer_spec.rb
 - yaml_converters.gemspec
 homepage: https://github.com/tomekw/yaml_converters
 licenses: []
@@ -135,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4349722421781478138
+      hash: -1522767103268194722
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -144,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4349722421781478138
+      hash: -1522767103268194722
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -156,8 +160,10 @@ test_files:
 - 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/integration/yaml_to_segments_spec.rb
 - spec/spec_helper.rb
-- spec/yaml_to_segments_converter_spec.rb
-- spec/yaml_to_string_writer_spec.rb
+- spec/unit/segment_to_hash_writer_spec.rb
+- spec/unit/segments_to_yaml_converter_spec.rb
+- spec/unit/yaml_file_reader_spec.rb
+- spec/unit/yaml_to_segments_converter_spec.rb
+- spec/unit/yaml_to_string_writer_spec.rb