yaml2csv 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+*.swp
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+gemspec
+
+group :development do
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    yaml2csv (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rake (0.8.7)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ya2yaml (0.30)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.7)
+  rake (~> 0.8.7)
+  rspec
+  ya2yaml (~> 0.30)
+  yaml2csv!

data/README

@@ -0,0 +1,48 @@
+= Yaml2Csv
+
+Transform YAML file into CSV and backwards. CSV files contain
+triplets [path, key, value]. For example:
+
+    path1:
+      path11:
+        key11a: value11a
+        key11b: value11b
+      path12:
+        path121:
+          key121a: value121a
+    path2:
+      key2a: value2a
+  
+Will be converted into:
+
+    path1/path11,key11a,value11a
+    path1/path11,key11b,value11b
+    path1/path12/path121,key121a,value121a
+    path2,key2a,value2a
+
+YAML source files should contain only hashes and string values. While non-string 
+values (i.e. arrays, booleans) are allowed, they will be treated as strings 
+thus their original format will be lost.
+
+== Usage 
+
+=== As a gem
+
+In your Gemfile:
+
+    gem 'yaml2csv'
+
+In your code:
+
+    output_string = Yaml2csv::yaml2csv(input_string)
+    output_string = Yaml2csv::csv2yaml(input_string)
+
+=== rake task
+
+Convert file.yml into CSV format:
+
+    $ rake yaml2csv:yaml2csv INPUT=file.yml OUTPUT=file.csv
+
+Convert file.csv into YAML format
+
+    $ rake yaml2csv:csv2yaml INPUT=file.csv OUTPUT=file.yml

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+require 'bundler/setup'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require "rspec/core/rake_task"
+
+require File.expand_path("../lib/tasks/yaml2csv", __FILE__)
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec]

data/examples/example.csv

@@ -0,0 +1,4 @@
+path1/path11,key11a,value11a
+path1/path11,key11b,value11b
+path1/path12/path121,key121a,value121a
+path2,key2a,value2a

data/examples/example.yml

@@ -0,0 +1,10 @@
+---
+path1:
+  path11:
+    key11a: value11a
+    key11b: value11b
+  path12:
+    path121:
+      key121a: value121a
+path2:
+  key2a: value2a

data/lib/tasks/yaml2csv.rb

@@ -0,0 +1,25 @@
+require 'yaml2csv'
+
+namespace :yaml2csv do
+  desc "Convert a yaml into a csv file"
+  task :yaml2csv do
+    input = File.read(ENV['INPUT'])
+    csv_output = Yaml2csv::yaml2csv(input)
+    if !ENV['OUTPUT'].nil?
+      File.open(ENV['OUTPUT'], 'w') {|f| f.write(csv_output) }
+    else
+      puts csv_output
+    end
+  end
+
+  desc "Convert a csv into a yaml file"
+  task :csv2yaml do
+    input = File.read(ENV['INPUT'])
+    yaml_output = Yaml2csv::csv2yaml(input)
+    if !ENV['OUTPUT'].nil?
+      File.open(ENV['OUTPUT'], 'w') {|f| f.write(yaml_output) }
+    else
+      puts yaml_output
+    end
+  end
+end

data/lib/yaml2csv/hash_extensions.rb

@@ -0,0 +1,57 @@
+module Yaml2csv
+  module HashExtensions
+    # Merge a hash with a (keys_path, value)
+    #
+    #   hash = {1=>2}
+    #   hash.merge_path([3,4], 5) #=> {1=>2, 3=>{4=>5}}
+    #   
+    def merge_path(keys, value)
+       keys[0...-1].inject(self) do |result, key|
+        result[key] ||= {}
+      end[keys[-1]] = value
+      self
+    end
+
+    # Walk a hash yielding [path, key, value] triplets
+    #
+    #   hash = {
+    #     "a" => {
+    #       "b" => 3,
+    #       "c" => 5,
+    #     },
+    #     "d" => 7,
+    #   }
+    #  
+    #   hash.to_enum(:walk).to_a
+    #   # => [
+    #   #     [[["a"], "b", 3], 
+    #   #     [["a"], "c", 5], 
+    #   #     [[], "d", 7]
+    #   #   ]
+    #
+    def walk(path=[], &block)
+      self.each do |key, value|
+        if value.is_a?(Hash)
+          value.walk(path + [key], &block)
+        else
+          yield [path, key, value]
+        end
+      end
+    end
+  end  
+
+  module HashClassExtensions
+    # Reverse a Hash#walk array output
+    #
+    def unwalk_from_array(ary)
+      ary.inject({}) do |output, (path, key, value)|
+        output.merge_path(path+[key], value)
+      end 
+    end
+  end
+  
+  def self.extend_hash(obj = Hash)
+    obj.send(:include, Yaml2csv::HashExtensions)
+    obj.send(:extend, Yaml2csv::HashClassExtensions)
+  end
+end

data/lib/yaml2csv.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby
+require 'rubygems'
+require 'yaml'
+require 'csv'
+require 'ya2yaml'
+
+require 'yaml2csv/hash_extensions'
+Yaml2csv.extend_hash
+
+module Yaml2csv
+  # Convert a string containing YAML data to a CSV string
+  def self.yaml2csv(yamldata, options = {})
+    hash = YAML::load(yamldata)
+
+    CSV.generate do |csv_writer|
+      hash.to_enum(:walk).each do |path, key, value|
+        strvalue = value.is_a?(String) ? value : value.inspect
+        csv_writer << [path.join("/"), key, strvalue]
+      end
+    end
+  end
+  
+  # Convert a string containing CSV values to a YAML string
+  def self.csv2yaml(csvdata, options = {})
+    walk_array = []
+
+    CSV.parse(csvdata) do |row|
+      walk_array << [row[0].split("/").map(&:to_s), row[1].to_s, row[2].to_s]
+    end
+
+    hash = Hash.unwalk_from_array(walk_array)
+    hash.ya2yaml.gsub(/\s+$/, '') + "\n"
+  end  
+end

data/spec/hash_extensions_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+EXAMPLE_HASH = {
+  "a" => {
+    "b" => 3,
+    "c" => 5,
+  },
+  "d" => 7,
+}
+    
+EXAMPLE_ARY = [
+  [["a"], "b", 3], 
+  [["a"], "c", 5], 
+  [[], "d", 7],
+]
+
+describe Hash do
+  it "should store paths" do
+    {1 => 2, 3 => {4 => 5}}.should == {1 => 2}.merge_path([3, 4], 5)
+
+    {1 => 2, 3 => {4 => 5, 5 => 50}}.should == {1 => 2, 3 => {5 => 50}}.merge_path([3, 4], 5)
+  end
+
+  it "should walk" do
+    EXAMPLE_ARY.should == EXAMPLE_HASH.to_enum(:walk).to_a
+  end
+
+  it "should unwalk" do
+    EXAMPLE_HASH.should == Hash.unwalk_from_array(EXAMPLE_ARY)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'yaml2csv'

data/spec/yaml2csv_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+YAML_EXAMPLE =<<-EOF
+---
+path1:
+  path11:
+    key11a: value11a
+    key11b: value11b
+  path12:
+    path121:
+      key121a: value121a
+path2:
+  key2a: value2a
+EOF
+
+CSV_EXAMPLE = <<-EOF
+path1/path11,key11a,value11a
+path1/path11,key11b,value11b
+path1/path12/path121,key121a,value121a
+path2,key2a,value2a
+EOF
+
+describe Yaml2csv do
+
+  it "should convert yaml to csv" do
+    Yaml2csv::yaml2csv(YAML_EXAMPLE).should == CSV_EXAMPLE
+  end
+
+  it "should convert csv to yaml" do
+    Yaml2csv::csv2yaml(CSV_EXAMPLE).should == YAML_EXAMPLE
+  end
+
+end

data/yaml2csv.gemspec

@@ -0,0 +1,26 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = "yaml2csv"
+  s.homepage = "http://github.com/benhutton/yaml2csv"
+  s.authors = ["Ben Hutton", "Arnau Sanchez"]
+  s.summary = "Convert YAML to CSV (and backward)"
+  s.description = "yaml2csv converts between YAML and CSV files"
+  s.email = "benhutton@gmail.com"
+  s.require_path = "lib"
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+
+  s.version = '0.0.1'
+  s.platform = Gem::Platform::RUBY
+  s.required_ruby_version = '>= 1.8.6'
+  s.required_rubygems_version = '>= 1.3.5'
+
+  {
+    'bundler'         => '~> 1.0.7',
+    'rake'            => '~> 0.8.7',
+    'ya2yaml'            => '~> 0.30',
+  }.each do |lib, version|
+    s.add_development_dependency lib, version
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: yaml2csv
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Hutton
+- Arnau Sanchez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 7
+        version: 1.0.7
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ya2yaml
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 30
+        version: "0.30"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+description: yaml2csv converts between YAML and CSV files
+email: benhutton@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- examples/example.csv
+- examples/example.yml
+- lib/tasks/yaml2csv.rb
+- lib/yaml2csv.rb
+- lib/yaml2csv/hash_extensions.rb
+- spec/hash_extensions_spec.rb
+- spec/spec_helper.rb
+- spec/yaml2csv_spec.rb
+- yaml2csv.gemspec
+has_rdoc: true
+homepage: http://github.com/benhutton/yaml2csv
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 6
+      version: 1.8.6
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 5
+      version: 1.3.5
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Convert YAML to CSV (and backward)
+test_files: 
+- spec/hash_extensions_spec.rb
+- spec/spec_helper.rb
+- spec/yaml2csv_spec.rb