x2cs 1.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.XML
+*.xml
+*.csv
+.redcar
+*.gem

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+group :dev do
+  gem 'rspec'
+end
+
+gem 'nokogiri'

data/README.md

@@ -0,0 +1,3 @@
+# X2C - An XML data to CSV conversion Tool.
+
+_Note that this software is in progress, and is not release mode yet. The bin/run.rb works, but tests are not done. Use at own risk._

data/bin/x2cs

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.expand_path('../..', __FILE__))
+
+require 'xmlparse.rb'
+
+include XmlParser
+
+XmlParser::init

data/spec/spec_helper.rb

@@ -0,0 +1,70 @@
+$LOAD_PATH.unshift(File.expand_path('../..', __FILE__))
+require 'xmlparse.rb'
+include XmlParser
+
+class Person
+  attr_accessor :name, :email, :phone, :address
+  
+  def initialize(args)
+    args.each do |k, v|
+      send("#{k}=".to_sym, v)
+    end
+  end
+  
+  def to_xml
+    "<Person><name>#{name}</name><email>#{email}</email><phone>#{phone}</phone><address>#{address}</address></Person>"
+  end
+end
+
+def xml_header
+  '<?xml version="1.0" encoding="utf-8" ?>'
+end
+
+def load_test_files
+  write_tests_to_file(add_people)
+end
+
+def write_tests_to_file(people)
+  File.open('test_file.xml', 'w+') do |f|
+    f.write("#{xml_header}\n")
+    f.write("<people>")
+    people.each do |p|
+      f.write("#{p.to_xml}\n")
+    end
+    f.write("</people>")
+  end
+end
+
+def load_test_files_with_extra
+  people = add_people
+  people << Person.new(name: 'Jack johnson', email: '<emails><email>1@test.com</email><email>2@test.com</email></emails>', 
+    phone: '555-233-3333', address: '444 test')
+  people
+  write_tests_to_file(people)
+end
+
+def load_test_files_with_missing
+  people = add_people
+  File.open('test_file.xml', 'w+') do |f|
+    f.write("#{xml_header}\n")
+    f.write("<people>")
+    people.each do |p|
+      f.write("#{p.to_xml}\n")
+    end
+    f.write("<Person><name>A test name</name><email>something@you.com</email><address>test address</address></Person>\n")
+    f.write("</people>")
+  end
+end
+
+def add_people
+  people = []
+  people << Person.new(name: 'A person', email: 'test@something.com', phone: '555-233-3333', address: '444 test')
+  people << Person.new(name: 'John Smith', email: 'jsmith@fake.com', phone: '555-249-8833', address: '123 fake st')
+  people << Person.new(name: 'Jane Doe', email: 'example@something.ca', phone: '232-855-3422', address: '8643 Avenue Lane')
+  people << Person.new(name: 'Willis', email: 'nonexistant@example.com', phone: '416-233-7688', address: 'a test address')
+  people
+end
+
+def remove_test_files
+  File.delete('test_file.xml')
+end

data/spec/xmlparse_spec.rb

@@ -0,0 +1,168 @@
+require 'spec_helper'
+
+describe XmlParser do
+  describe "#init" do
+    before(:each) do
+      load_test_files
+      XmlParser.stub!(:gets).and_return('test_file.xml')
+      XmlParser.stub!(:puts)
+    end
+    
+    it "should give a greeting message 'type xml file name'" do
+      XmlParser.stub!(:build_headers)
+      XmlParser.should_receive(:puts).with('type xml file name')
+      XmlParser::init
+    end
+    
+    it "should call build_headers" do
+      XmlParser.stub!(:build_headers)
+      XmlParser.should_receive(:build_headers)
+      XmlParser::init
+    end
+    
+    after(:each) do
+      remove_test_files
+    end
+  end
+  
+  describe "#build_headers" do
+    context "Load test files with 4 headers" do
+      before(:each) do
+        load_test_files
+        XmlParser.stub!(:gets).and_return('Person')
+        XmlParser.stub!(:puts)
+        f = File.open('test_file.xml')
+        @doc = Nokogiri::XML(f)
+        f.close
+        XmlParser.stub!(:traverse_through_each_row)
+      end
+      
+      it "@headers should be of size 4" do
+        XmlParser.send(:build_headers, @doc)
+        XmlParser.headers.size.should == 4
+      end
+      
+      it "@headers should contain name" do
+        XmlParser.send(:build_headers, @doc)
+        XmlParser.headers.include?('name').should be_true
+      end
+      
+      it "@headers should contain email" do
+        XmlParser.send(:build_headers, @doc)
+        XmlParser.headers.include?('email').should be_true
+      end
+      
+      it "@headers should contain address" do
+        XmlParser.send(:build_headers, @doc)
+        XmlParser.headers.include?('address').should be_true
+      end
+      
+      it "@headers should contain phone" do
+        XmlParser.send(:build_headers, @doc)
+        XmlParser.headers.include?('phone').should be_true
+      end
+      
+      after(:each) do
+        remove_test_files
+      end
+    end
+    
+    context "Traversing node is non-existant" do
+      before(:each) do
+        load_test_files
+        XmlParser.stub!(:gets).and_return('Badtagname')
+        XmlParser.stub!(:puts)
+        f = File.open('test_file.xml')
+        @doc = Nokogiri::XML(f)
+        f.close
+        XmlParser.stub!(:traverse_through_each_row)
+      end
+      
+      it "raises an exception if tag is not found" do
+        lambda { XmlParser.send(:build_headers, @doc) }.should raise_error(RuntimeError, "Tag not found")
+      end
+      
+      after(:each) do
+        remove_test_files
+      end
+    end
+  end
+  
+  describe "#traverse_through_each_row" do
+    before(:each) do
+      load_test_files_with_extra
+      f = File.open('test_file.xml')
+      @doc = Nokogiri::XML(f)
+      f.close
+      
+      XmlParser.stub!(:gets).and_return('Person')
+      @headers = XmlParser.send(:build_headers, @doc).headers
+      XmlParser.stub!(:write_to_file)
+    end
+    
+    it "should populate @rows with 5 objects" do
+      XmlParser.send(:traverse_through_each_row, @doc, 'Person')
+      XmlParser.rows.size.should == 5
+    end
+    
+    it "row[4] should contain multiple values in email field" do
+      XmlParser.send(:traverse_through_each_row, @doc, 'Person')
+      r = XmlParser.rows[4]
+      r.index("1@test.com|2@test.com").should_not be_nil
+    end
+    
+    after(:each) do
+      remove_test_files
+    end
+  end
+  
+  
+  describe "#populate_missing" do
+    
+    context "files have all headers for each record" do
+      before(:each) do
+        load_test_files
+        f = File.open('test_file.xml')
+        @doc = Nokogiri::XML(f)
+        f.close
+        
+        XmlParser.stub!(:gets).and_return('Person')
+      end
+      
+      it "first_node have a child size of 4 after the method call" do
+        first_node = @doc.css('Person').first
+        XmlParser.send(:populate_missing, first_node)
+        first_node.children.size.should == 4
+      end
+      
+      after(:each) do
+        remove_test_files
+      end
+    end
+    
+    context "One row is missing a header" do
+      before(:each) do
+        load_test_files_with_missing
+        f = File.open('test_file.xml')
+        @doc = Nokogiri::XML(f)
+        f.close
+        XmlParser.stub!(:gets).and_return('Person')
+      end
+      
+      it "last_node should have a child size of 3 before the method call" do
+        last_node = @doc.css('Person').last
+        last_node.children.size.should == 3
+      end
+      
+      it "last_node should have a child size of 4 after the method call" do
+        last_node = @doc.css('Person').last
+        XmlParser.send(:populate_missing, last_node)
+        last_node.children.size.should == 4
+      end
+      
+      after(:each) do
+        remove_test_files
+      end
+    end
+  end
+end

data/xmlparse.rb

@@ -0,0 +1,119 @@
+require 'rubygems'
+require 'nokogiri'
+
+module XmlParser
+
+  def init  
+    puts 'type xml file name'
+    @xml_name = gets.chomp
+    f = File.open(@xml_name)
+    doc = Nokogiri::XML(f)
+    f.close
+    build_headers(doc)
+  end
+  
+  def headers
+    @headers
+  end
+  
+  def rows
+    @rows
+  end
+  
+  private
+    
+  def build_headers(doc)
+    @headers = []
+    puts "Enter in node name to traverse. If it's an xml table of <Person> objects, type \"Person\" (without quotes)"
+    node_to_traverse = gets.chomp
+    nodes = doc.css(node_to_traverse)
+    if nodes.size == 0
+      raise "Tag not found"
+    else
+      nodes.each do |loc|
+        loc.children.each do |field|
+          @headers << field.name if field.name != "text" && !@headers.include?(field.name)
+        end
+      end
+      tag_found = true
+    end
+    traverse_through_each_row(doc, node_to_traverse)
+  end
+  
+  def traverse_through_each_row(doc, node_to_traverse)
+    @rows = []
+    count = 0
+    doc.css(node_to_traverse).each do |loc|
+      fields = Array.new(@headers.size)
+      loc = populate_missing(loc)
+      loc.children.each do |field|
+        idx = @headers.index(field.name)
+        if field.class == Nokogiri::XML::Element
+          f = []
+          field.children.each do |c|
+            f = recursive_iteration(c, f)
+          end
+          fields[idx] = "#{enclose(f.join('|'))}"
+        end
+      end
+      count += 1
+      @rows << fields.join(',')
+    end
+    
+    write_to_file
+  end
+  
+  def recursive_iteration(c, f)
+    if c.class == Nokogiri::XML::Element
+      if c.children.size > 0
+        c.children.each do |child|
+          f = recursive_iteration(child, f)
+        end
+      end
+    else
+      text = strip(c.text)
+      f << text unless text.empty?
+    end
+    f
+  end
+  
+  def write_to_file
+    File.open("#{@xml_name}.csv", 'w+') do |file|
+      file.write(@headers.join(',') + "\n")
+      @rows.each do |r|
+        file.write("#{r}\n")
+      end
+    end
+  end
+  
+  def enclose(str)
+    if str.index(',')
+      return "\"#{str}\""
+    else
+      return str
+    end
+  end
+  
+  def enclose_and_strip(str)
+    return enclose(strip(str))
+  end
+  
+  def strip(str)
+    return str.gsub(/\n|\t/, '').strip
+  end
+  
+  def populate_missing(location)
+    h = []
+    location.children.each do |c|
+      h << c.name if c.name != "text"
+    end
+    h.sort
+    if h != @headers
+      h = @headers - h
+      h.each { |mh| location.add_child("<#{mh} />") }
+    end
+    return location
+  end
+  
+  
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: x2cs
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Aaron McLeod
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70350295279760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70350295279760
+description: ''
+email:
+- aaron.g.mcleod@gmail.com
+executables:
+- x2cs
+extensions: []
+extra_rdoc_files: []
+files:
+- spec/spec_helper.rb
+- spec/xmlparse_spec.rb
+- bin/x2cs
+- README.md
+- .gitignore
+- Gemfile
+- xmlparse.rb
+homepage: http://github.com/agmcleod/x2c
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- .
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: A tool for converting XML data to CSV. Generally meant for entities with
+  fields, as supposed to many nodes deep.
+test_files: []