MergeAsXML 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  metadata.gz: 9a7d718bf390dd637775aa9e006bacc4e7961d3dbe79bb73bdf1e051121b34694d299d7343a9359b215533a33435b47583abcca6a6be938164fe4b448c815be8
+  data.tar.gz: 4174ac6dbe6a2c963629efc077a11abe00497bc17f6de431861a93b73d082d0f6677d56bef71c2f9ac699b0e41d4efdee27a27dbe4ba8a3fb14500b3077153a8
+SHA1: 
+  metadata.gz: fc7c6b73892db829f0863d77fa83871fc2aadb08
+  data.tar.gz: 488371d5bd78fe88a3b16d7847bc5353824e6edd

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem "nokogiri"
+gem "rainbow"
+gem "erubis"

data/MergeAsXML.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name        = 'MergeAsXML'
+  s.version     = '0.0.4'
+  s.date        = '2013-05-16'
+  s.homepage    = 'https://github.com/dmison/MergeAsXML'
+  s.summary     = "CLI to takes data from a delimited text file and merges into XML"
+  s.description = "Takes data from a delimited text file and merges into XML"
+  s.authors     = ["Darrin Mison"]
+  s.email       = 'dmison@me.com'
+  s.executables << 'MergeAsXML'
+  s.files       = [
+    "Gemfile", 
+    "readme.md", 
+    "MergeAsXML.gemspec", 
+    "bin/MergeAsXML", 
+    "lib/MergeAsXML.rb",
+    "lib/marker.xml.erb"
+  ]
+
+  s.add_runtime_dependency("rainbow", [">= 1.1.4"])
+  s.add_runtime_dependency("erubis", [">= 2.7.0"])
+
+  
+end
+

data/bin/MergeAsXML

@@ -0,0 +1,133 @@
+#!/usr/bin/env ruby -W0
+ 
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'optparse'
+require 'MergeAsXML.rb'
+
+#process command line arguments and return options hash
+def processCommandLine
+   options = {}
+
+   optparse = OptionParser.new do |opts|
+      opts.banner = "MergeAsXML v0.0.4".color("#800040").bright
+
+      options[:datafile] = ""
+      opts.on( '-i filename', '--input filename', 'File containing input data' ) do | datafile |
+         options[:datafile] = datafile
+      end
+
+      options[:delim] = "\t"
+      opts.on( '-s separator', 'The delimiter of each field in the input file (default: tab ''\\t'')') do | delim |
+         options[:delim] = "#{delim}"
+      end
+
+      options[:xmlfile] = ""
+      opts.on( '-X file', 'The XML file to merge the data into' ) do | xmlfile |
+         options[:xmlfile] = "#{xmlfile}"
+      end
+
+      options[:parentpath] = ""
+      opts.on( '-p parent path', 'The path of the parent node to insert at' ) do | parentpath |
+         options[:parentpath] = "#{parentpath}"
+      end
+      options[:prevsiblingpath] = ""
+      opts.on( '-b previous sibling path', 'The path of the sibling node to insert after' ) do | prevsiblingpath |
+         options[:prevsiblingpath] = "#{prevsiblingpath}"
+      end
+      options[:nextsiblingpath] = ""
+      opts.on( '-c next sibling path', 'The path of the sibling node to insert before' ) do | nextsiblingpath |
+         options[:nextsiblingpath] = "#{nextsiblingpath}"
+      end
+
+
+      options[:template] = ""
+      opts.on( '-t template', 'ERB template to populate (defaults to inbuilt default template)' ) do | template |
+         options[:template] = template
+      end      
+
+      # options[:followXIInclude] = false
+      #    opts.on( '-x', '--xiinclude', 'Follow' ) do
+      #    options[:getSecurityLevels] = true
+      # end
+
+      opts.on( '-d', 'Dump default template to default.xml.erb' ) do
+         print "Saving built in template to "
+         print "default.xml.erb".bright.underline
+         puts "."
+
+         filename = File.expand_path "../../lib/marker.xml.erb", __FILE__
+
+         FileUtils.cp(filename, "default.xml.erb")
+         exit
+      end
+
+      opts.on( '-h', 'Display this screen' ) do
+         puts opts
+         exit
+      end
+
+      if (ARGV.size == 0) then
+         puts opts
+         exit
+      end
+
+  end
+
+  begin
+    optparse.parse!
+  rescue => error
+    puts "ERROR PARSING COMMANDLINE:".color("#ff0000")
+    puts "\t"+error.to_s
+    puts
+    puts optparse
+    exit
+  end
+
+  #check for other weirdness here
+  return options
+end
+
+options = processCommandLine
+
+lines = fileToArray(options[:datafile])
+data = stringsToArray(lines, options[:delim])
+
+if options[:template] == "" 
+  template_fn = File.expand_path "../../lib/marker.xml.erb", __FILE__
+else
+  template_fn = "#{Dir.getwd}/#{options[:template]}"
+end
+
+puts template_fn
+
+template = ERB.new File.new(template_fn).read, nil, "%"
+output = template.result(binding)
+
+if (options[:xmlfile] == "") 
+  puts output
+  exit
+end
+
+if options[:prevsiblingpath] != ""
+  action = "after"
+  xpath = options[:prevsiblingpath]
+end
+if options[:nextsiblingpath] != ""
+  action = "before"
+  xpath = options[:nextsiblingpath]
+end
+if options[:parentpath] != ""
+  action = "as child of"
+  xpath = options[:parentpath]
+end
+
+puts "Merging data #{action.bright} #{xpath.underline} in #{options[:xmlfile]}"
+
+
+outputstring = mergeOutputIntoXML(output, options[:xmlfile], xpath, action)
+
+saveNewFileWithBackup(outputstring, options[:xmlfile])
+
+puts "Done"

data/lib/MergeAsXML.rb

@@ -0,0 +1,67 @@
+require 'rainbow'
+require 'erb'
+require 'FileUtils'
+require 'rexml/document'
+require 'rexml/XPath'
+
+# takes a filename and returns an array of strings
+def fileToArray (filename)
+   lines = Array.new
+   File.open(filename) do |fp|
+      fp.each do | line |
+         lines << line.strip
+      end
+   end
+   return lines
+end
+
+# takes an array of strings and a delimiter
+# returns a two-dimensional array based on the delimiter
+def stringsToArray(strings, delim)
+   lines = Array.new
+   
+   strings.each do | string |
+      line = string.split(delim)
+      lines << line
+   end
+   return lines
+end
+
+def saveNewFileWithBackup(outputstring, filename)
+  #make backup, filename.backup
+  FileUtils.cp(filename, "#{filename}.backup")
+  # write output
+  File.open(filename, 'w') {|f| f.write(outputstring) }
+end
+
+#output is required to be a string containing valid XML
+def mergeOutputIntoXML(output, xmlfilename, xpath, action)
+
+  #load XML doc from xmlfilename
+  doc = REXML::Document.new ( File.new(xmlfilename) ) #getSourceXMLDoc(xmlfilename)
+  fragment = REXML::Document.new("<wrapper>#{output}</wrapper>")
+
+  #insertpoint = doc.at_xpath(xpath)
+  insertpoint = REXML::XPath.first(doc, xpath)
+
+  fragment.root.elements.each do | child |
+    case action
+      when "after"
+        # insert as next siblings of specified xpath
+        insertpoint.insert_after(xpath, child) 
+      
+      when "before"
+        # insert as prev siblings of specified xpath
+        insertpoint.insert_before(xpath, child)
+      when "as child of"
+        # insert as child of specified xpath
+        insertpoint.add(child)    
+    end
+  end
+
+  # return string
+  return doc.to_s
+
+end
+
+

data/lib/marker.xml.erb

@@ -0,0 +1,17 @@
+
+<!-- generated data begins -->
+<% data.each_index do | index | %>
+<marker>
+   <name>Marker #<%= index %></name>
+   <comment><%= data[index][1] %></comment>
+   <color>
+      <alpha>0</alpha>
+      <red>255</red>
+      <green>0</green>
+      <blue>0</blue>
+   </color>
+   <in><%= data[index][0] %></in>
+   <out>-1</out>
+</marker>
+<% end %>
+<!-- generated data ends -->

data/readme.md

@@ -0,0 +1,79 @@
+## MergeAsXML
+
+This is a simple Ruby based command line tool that takes a delimited data file (like a CSV file) and merges it into a already existing XML file.  
+
+      MergeAsXML v1.0.0
+          -i, --input filename             File containing input data
+          -s separator                     The delimiter of each field in the input file (default: tab \t)
+          -X file                          The XML file to merge the data into
+          -p parent path                   The path of the parent node to insert at
+          -b previous sibling path         The path of the sibling node to insert after
+          -c next sibling path             The path of the sibling node to insert before
+          -t template                      ERB template to populate (defaults to inbuilt default template)
+          -d                               Dump default template to default.xml.erb
+          -h                               Display this screen
+
+The basic use case involves you having :
+
+1. A delimited datafile, like a CSV file
+2. An XML file
+
+And you need to get the data from the datafile formatting and inserted into the right place in the XML file.
+
+To do this you specify:
+
+1. The datafile to use
+2. The delimiter for the file.  Default is tab.
+3. An ERB template to control how the data is turned into XML.
+4. The XML file to insert the output into.
+5. An xpath expression to indicate where to insert the new XML. Only the first match is used.
+6. Whether the xpath expression indicates the parent node for the new data (`-p`), or a sibling node to insert before (`-c`)or after (`-b`).
+
+Here's an example of the command-line inserting CSV data as Markers into a Final Cut Pro XML export.
+
+      MergeAsXML -i timecode-data.csv -s , -X FC_XML_EXPORT.XML -b /xmeml/sequence/ismasterclip -t markers.xml.erb
+
+A backup copy of the XML file is made with the suffix `.backup`.
+
+### Installing
+
+It's available as a Ruby Gem.
+
+      sudo gem install MergeAsXML
+
+### Making templates
+
+MergeAsXML uses ERB templates.  You can read about ERB [here][1].
+
+You can get a copy of the default template using the -d parameter.  It saves a copy of the default template in your current directory.
+
+      MergeAsXML -d
+
+The default template looks like this:
+
+      <!-- generated data begins -->
+      <% data.each_index do | index | %>
+      <marker>
+         <name>Marker #<%= index %></name>
+         <comment><%= data[index][1] %></comment>
+         <color>
+            <alpha>0</alpha>
+            <red>255</red>
+            <green>0</green>
+            <blue>0</blue>
+         </color>
+         <in><%= data[index][0] %></in>
+         <out>-1</out>
+      </marker>
+      <% end %>
+      <!-- generated data ends -->
+
+The data from the input file goes into a simple 2D array called `data`.  So each specific item can be accessed as such:
+
+      data[row][col]
+
+And you can step through each item using the `.each_index` operation. 
+
+
+
+[1]: http://en.wikipedia.org/wiki/ERuby

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: MergeAsXML
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Darrin Mison
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-05-16 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rainbow
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: erubis
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.7.0
+  type: :runtime
+  version_requirements: *id002
+description: Takes data from a delimited text file and merges into XML
+email: dmison@me.com
+executables: 
+- MergeAsXML
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- readme.md
+- MergeAsXML.gemspec
+- bin/MergeAsXML
+- lib/MergeAsXML.rb
+- lib/marker.xml.erb
+homepage: https://github.com/dmison/MergeAsXML
+licenses: []
+
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id003 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id003
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: CLI to takes data from a delimited text file and merges into XML
+test_files: []
+