yaml_converters 0.0.1 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# CHANGELOG
+
+## Version 0.1 (2012-07-29)
+
+* Add CHANGELOG
+* Change API of `segment_writer` - provide key and value explicitly,
+  instead of a hash
+* Bump Psych dependency to `>= 1.3.3`
+
+## Version 0.0.1 (2012-07-28)
+
+* Initial implementation of `YamlConverters::YamlToSegmentsConverter`
+* Initial implementation of `YamlConverters::SegmentsToYamlConverter`
+* Example implementation of `segment_writer`
+* Example implementation of `yaml_writer`

data/README.md

@@ -25,12 +25,28 @@ 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
+* `write(key, value)` - 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`.
 
+``` ruby
+module YamlConverters
+  class SegmentToHashWriter
+    attr_reader :result
+
+    def initialize
+      @result = {}
+    end
+
+    def write(key, value)
+      @result.deep_merge!({ key => value })
+    end
+  end
+end
+```
+
 Use `YamlConverters::SegmentsToYamlConverter#convert` to dump segments
 (key-value pairs) to YAML file.
 
@@ -38,12 +54,28 @@ 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
+* `write(yaml_string)` - 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`.
 
+``` ruby
+module YamlConverters
+  class YamlToStringWriter
+    attr_reader :result
+
+    def initialize
+      @result = ''
+    end
+
+    def write(yaml)
+      @result = yaml
+    end
+  end
+end
+```
+
 ## Acknowledgements
 
 Implementation of flattening a YAML file and generating a YAML file

data/lib/yaml_converters/segment_to_hash_writer.rb

@@ -6,8 +6,8 @@ module YamlConverters
       @result = {}
     end
 
-    def write(hash)
-      @result.deep_merge!(hash)
+    def write(key, value)
+      @result.deep_merge!({ key => value })
     end
   end
 end

data/lib/yaml_converters/version.rb

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

data/lib/yaml_converters/yaml_to_segments_converter.rb

@@ -28,7 +28,7 @@ module YamlConverters
 
         if !value.is_a?(Hash)
           result[current_prefix] = value
-          @segment_writer.write({ current_prefix => value })
+          @segment_writer.write(current_prefix, value)
         else
           flatten_hash(value, current_prefix, result)
         end

data/spec/segment_to_hash_writer_spec.rb

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

data/yaml_converters.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   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.homepage      = 'https://github.com/tomekw/yaml_converters'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency('activesupport')
-  gem.add_dependency('psych')
+  gem.add_dependency('psych', '>= 1.3.3')
 
   gem.add_development_dependency('rake')
   gem.add_development_dependency('rspec')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaml_converters
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-28 00:00:00.000000000 Z
+date: 2012-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +100,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -120,7 +121,7 @@ files:
 - spec/yaml_to_segments_converter_spec.rb
 - spec/yaml_to_string_writer_spec.rb
 - yaml_converters.gemspec
-homepage: ''
+homepage: https://github.com/tomekw/yaml_converters
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -134,7 +135,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -872080065287608122
+      hash: 4349722421781478138
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -143,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -872080065287608122
+      hash: 4349722421781478138
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24