xml2csv 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8298b0192e7c8d66809ddc3967c37f99ca21e0fb
+  data.tar.gz: f443ddcb8f6ea40cc08834778acc3fd564f6dbcd
+SHA512:
+  metadata.gz: 20759360cac3a063fd5cbf955ef5624b21338cf67ac3304314f9ad4ddddfd877f1909791c86786810ada285098bf0f6d1c252ac19c49b826f945ad7bebc4603d
+  data.tar.gz: ebeca5de978ace25b946fd1e6435a4b9ab05bf9f13b8df727f71a7cbc8cad34dd7ab1933229c6b94a9de2c90b1bba991ba6eeb3e2296b3ee3e4b187dd3bebcd3

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/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xml2csv.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Akira Ohnishi
+
+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,89 @@
+# xml2csv
+
+  xml2csv - Convert XML to CSV
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'xml2csv'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xml2csv
+
+## Usage
+
+### Synopsis
+  $ xml2csv [-F sep] [--no-hedaer] [xml_file] [root_node] [params...]
+
+### Options
+    -F _sep_
+      set _sep_ as a field delimiter (default ",")
+  
+    --no-header
+      Do not print header.
+      Default header is generated from params.
+  
+    xml_file
+      path to XML file.
+  
+    root_node
+      Set XML node name.
+      Expression's path are written relative to the _root_node_(see below.)
+  
+    params
+      type:Expression[,...]
+  
+      Describe node name, attribute, xpath, etc...
+      Expression can be written with delimiter ",".
+  
+      _type_ are any of the following.
+  
+      node
+        Describe node name.
+  
+      xpath
+        Same with _node_.
+        Describe explicitly that it is a XPath.
+  
+      attr
+        Describe attribute.
+  
+      tag
+        Describe any characters.
+        You can use this when you add output CSV column that is not exist in XML.
+  
+      join
+        Describe Expressions.
+        Join Expressions with "_".
+  
+      pair
+        Describe Expressions.
+        Expressions arranged in pairs.
+  
+      with
+        with:base_node:Expression[,...]
+        You can short cut long Expression.
+  
+      with_order
+        with:Expression[,...]
+        Add Expression's order from parent element as output CSV's first column.
+
+## Todo
+- Improve poor English.
+- Refactoring.
+- Should reconsider the raison d'etre of join, pair, with.
+  (They are still exist for historical reasons.)
+
+## Contributing
+
+1. Fork it ( http://github.com/ohnishiakira/xml2csv/fork )
+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/bin/xml2csv

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'xml2csv'
+
+XML2CSV.xml2csv

data/lib/xml2csv.rb

@@ -0,0 +1,127 @@
+require "xml2csv/version"
+
+require "csv"
+require "digest"
+
+require "nokogiri"
+require "slop"
+require "active_support/core_ext"
+
+module XML2CSV
+  module_function
+  def get_content(node, param)
+    key, values = param.to_a.first
+
+    case key
+    when "join"
+      values.split(/,/).map{|value|
+        node.xpath(value).map{|v| v.content.chomp}.join("-")
+      }.join("_")
+    when "pair"
+      values.split(/,/).map{|value|
+        node.xpath(value).map{|v| v.content.chomp}
+      }
+    when "with"
+      wkey, wvalues = values.split(/:/, 2)
+
+      wvalues.split(/,/).map{|value|
+        node.xpath([wkey, value].join("/")).map{|v| v.content.chomp}.join("-")
+      }
+    when "digest"
+      keys = values.split(/,/).map{|value|
+        node.xpath(value).map{|v| v.content.chomp}
+      }
+
+      Digest::MD5.hexdigest keys.join
+    when "with_order"
+      ret = values.split(/,/).map{|value|
+        if v = node.at_xpath(value)
+          v.content.chomp
+        else
+          ""
+        end
+      }
+
+      ret.empty? ? nil : ret.unshift(node.parent.children.index(node))
+    else
+      values.split(/,/).map{|value|
+        case key
+        when "tag"
+          value
+        when "node", "xpath" then
+          ret = node.xpath(value).map{|v| v.content.chomp}
+          ret.empty? ? nil : ret
+        when "attr" then
+          ret = node[value]
+          ret.nil? ? nil : ret.chomp
+        end
+      }
+    end
+  end
+
+  def parse_xml(xml_io, root_node, parameters)
+    Nokogiri::XML(xml_io).xpath("//#{root_node}").map do |node|
+      parameters.flat_map{|param|
+        get_content(node, param)
+      }
+    end
+  end
+
+  def parse_params(argv)
+    Hash[*argv.split(/:/, 2)]
+  end
+
+  def xml2csv
+    Signal.trap("PIPE", "EXIT")
+
+    args = Slop.parse{
+      on :h, :help
+      on :F=, '[field separater]'
+      on :"no-header"
+    }.to_hash
+
+    if args.delete(:help)
+      puts HELP
+      exit
+    end
+
+    if col_sep = args.delete(:F)
+      ["-F", col_sep].each{|s| ARGV.delete s}
+      col_sep = eval %Q{"#{col_sep}"}
+    end
+
+    if no_header = args.delete(:"no-header")
+      ARGV.delete "--no-header"
+    end
+
+    xml_io     = $stdin.tty? ? File.read(ARGV.shift) : $stdin.read
+    root_node  = ARGV.shift
+    parameters = ARGV.map{|argv| parse_params(argv)}
+
+    header = parameters.map{|h|
+      h.each_pair.map{|k,v|
+        v.split(/,/).map{|_v| File.basename _v}
+      }
+    }.flatten
+
+    csv_options = {force_quotes: true, headers: header, write_headers: true}
+
+    if col_sep
+      csv_options.merge! col_sep: col_sep
+      csv_options.delete :force_quotes
+    end
+
+    if no_header
+      [:headers, :write_headers].each{|key|
+        csv_options.delete key
+      }
+    end
+
+    print CSV.generate("", csv_options){|csv|
+      parse_xml(xml_io, root_node, parameters).each{|row|
+        row = row.flatten
+        csv << row unless row.blank?
+      }
+    }
+  end
+end

data/lib/xml2csv/version.rb

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

data/xml2csv.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xml2csv/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xml2csv"
+  spec.version       = XML2CSV::VERSION
+  spec.authors       = ["Akira Ohnishi"]
+  spec.email         = ["s06206ao@gmail.com"]
+  spec.summary       = %q{Convert XML to CSV.}
+  spec.description   = %q{Convert XML to CSV. Written in Ruby.}
+  spec.homepage      = "https://github.com/ohnishiakira/xml2csv"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", "~> 4.0"
+  spec.add_runtime_dependency "nokogiri", "~> 1.6"
+  spec.add_runtime_dependency "slop", "~> 3.4"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 0"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: xml2csv
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Akira Ohnishi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Convert XML to CSV. Written in Ruby.
+email:
+- s06206ao@gmail.com
+executables:
+- xml2csv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/xml2csv
+- lib/xml2csv.rb
+- lib/xml2csv/version.rb
+- xml2csv.gemspec
+homepage: https://github.com/ohnishiakira/xml2csv
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Convert XML to CSV.
+test_files: []
+has_rdoc: