mixml 0.9.1 → 0.9.3

data/demo/application_invocation.md

@@ -0,0 +1,107 @@
+# mixml Invocation
+
+This document demonstrates the different methods to use mixml.
+
+## Command Line
+
+For simple tasks, you can specify the mixml command in the command line.
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+Now execute the following command to select some nodes and replace them:
+
+    # mixml replace --xpath '//philosopher[@name="Hobbes"]' --string '<tiger name="Hobbes"/>' test.xml
+
+This produces the following XML output:
+
+    <list>
+        <tiger name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+## Script files
+
+In addition to specifying what to do in the command line, you can also run scripts written in a simple DSL.
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+You can then use the following mixml script in `test.mixml` to select all philosopher nodes with name 'Hobbes' and replace
+them, and to delete all remaining philosopher nodes:
+
+    xpath '//philosopher[@name="Hobbes"]' do
+        replace template '<tiger-and-{=node.name} name="Hobbes"/>'
+    end
+    css 'philosopher' do
+        remove
+    end
+
+Now execute the following command to execute the script:
+
+    # mixml execute --script test.mixml test.xml
+
+This produces the following XML output:
+
+    <list>
+        <tiger-and-philosopher name="Hobbes"/>
+    </list>
+
+## Script commands
+
+You can also specify mixml script expressions directly on the command line without using a script file.
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+Now execute the following command to select some nodes and replace them:
+
+    # mixml execute --expression "xpath('//philosopher[@name=\"Hobbes\"]') { replace '<tiger name=\"Hobbes\"/>' }" test.xml
+
+This produces the following XML output:
+
+    <list>
+        <tiger name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+## Ruby Code
+
+You can also use mixml directly from your Ruby code.
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+Just create a tool object, and let it execute a mixml script.
+
+    tool = Mixml::Tool.new
+    tool.pretty = true
+
+    tool.work('test.xml') do
+        xpath '//philosopher[@name="Hobbes"]' do
+            rename 'tiger'
+        end
+    end
+
+This produces the following XML output:
+
+    <list>
+        <tiger name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>

data/demo/application_output.md

@@ -0,0 +1,107 @@
+# mixml Output
+
+This document demonstrates the different output options when using mixml.
+
+## Print Modified Documents
+
+Mixml prints the modified documents to the console per default.
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+Now execute the following command to replace some nodes:
+
+    # mixml rename --xpath '//philosopher[@name="Hobbes"]' --string 'tiger' test.xml
+
+This produces the following XML output:
+
+    <list>
+        <tiger name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+## Print Headers When Processing Multiple Documents
+
+Mixml also prints the file names of the documents if multiple documents are processed.
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+Let's use the following XML in file `more.xml`:
+
+    <list>
+        <philosopher name="Kant"/>
+        <philosopher name="Platon"/>
+    </list>
+
+Now execute the following command to remove some nodes:
+
+    # mixml remove --xpath '//philosopher[@name="Kant"]' test.xml more.xml
+
+This produces the following text output:
+
+    --------
+    test.xml
+    --------
+    <?xml version="1.0"?>
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+    --------
+    more.xml
+    --------
+    <?xml version="1.0"?>
+    <list>
+        <philosopher name="Platon"/>
+    </list>
+
+## Save Modified Documents
+
+We can also save the modified files after changing them.
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+Now execute the following command to rename some nodes:
+
+    # mixml rename --inplace --xpath '//philosopher[@name="Hobbes"]' --string 'tiger' test.xml
+
+This produces the following XML in file `test.xml`:
+
+    <list>
+        <tiger name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+## Pretty Print Output
+
+You can also pretty print the output.
+
+Let's use the following XML in file `test.xml`:
+
+    <list><philosopher name="Hobbes"/><philosopher name="Rawls"/></list>
+
+Now execute the following command to rename some nodes:
+
+    # mixml rename --pretty --xpath '//philosopher[@name="Hobbes"]' --string 'tiger' test.xml
+
+This produces the following text output:
+
+    <?xml version="1.0"?>
+    <list>
+        <tiger name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>

data/demo/application_selection.md

@@ -0,0 +1,47 @@
+# mixml Selection
+
+This document demonstrates the different methods to select XML nodes when using mixml.
+
+## Select nodes using XPath expressions
+
+You can use standard XPath expressions to select the nodes to process.
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+Now execute the following command to rename some nodes:
+
+    # mixml rename --xpath '//philosopher[@name="Hobbes"]' --string 'tiger' test.xml
+
+This produces the following XML output:
+
+    <list>
+        <tiger name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+### Select nodes using CSS rules
+
+You can also use CSS rules instead of XPath expressions to select the nodes to process.
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+Now execute the following command to rename some nodes:
+
+    # mixml rename --css 'philosopher:first-child' --string 'tiger' test.xml
+
+This produces the following XML output:
+
+    <list>
+        <tiger name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>

data/demo/application_values.md

@@ -0,0 +1,167 @@
+# mixml Values
+
+This document demonstrates the different methods to specify values when using mixml.
+
+## Strings
+
+You can specify values with a string, e.g. the new node when replacing content. Ruby
+[string interpolation][string interpolation] is performed on string values, so you can also use Ruby expressions
+in string values.
+
+[string interpolation]: http://en.wikibooks.org/wiki/Ruby_Programming/Syntax/Literals#Interpolation
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+You can then use the following mixml script in `test.mixml` to replace some nodes:
+
+    xpath '//philosopher[@name="Hobbes"]' do
+        replace '<tiger-and-#{node.name} name="Hobbes"/>'
+    end
+
+Now execute the following command to run the script:
+
+    # mixml execute --script test.mixml test.xml
+
+This produces the following XML output:
+
+    <list>
+        <tiger-and-philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+## Templates
+
+You can also use a template to specify complex replacement. Mixml uses [Erubis][Erubis] as templating engine, and `{`
+and `}` as delimiters.
+
+[Erubis]: http://www.kuwata-lab.com/erubis
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+You can then use the following mixml script in `test.mixml` to replace some nodes:
+
+    xpath '//philosopher' do
+        replace template %{
+            <{=node.name} name="{=node['name']}">
+                {if node['name'] == "Hobbes"}
+                    <hobby name="Space Travel"/>
+                {else}
+                    <hobby name="Philosophy"/>
+                {end}
+            </{=node.name}>
+        }
+    end
+
+Now execute the following command to run the script:
+
+    # mixml execute --script test.mixml test.xml
+
+This produces the following XML output:
+
+    <list>
+        <philosopher name="Hobbes">
+            <hobby name="Space Travel"/>
+        </philosopher>
+        <philosopher name="Rawls">
+            <hobby name="Philosophy"/>
+        </philosopher>
+    </list>
+
+### XML Builder
+
+You can also use an XML builder to create values using the simple DSL provided by [Nokogiri][Nokogiri builder].
+
+[Nokogiri builder]: http://nokogiri.org/Nokogiri/XML/Builder.html
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+You can then use the following mixml script in `test.mixml` to replace some nodes:
+
+    xpath '//philosopher[@name="Hobbes"]' do
+        replace xml ->(node, xml) {
+            xml.tiger(:name => node['name']) {
+                xml.hobby(:name => 'Space Travel')
+            }
+        }
+    end
+
+Now execute the following command to run the script:
+
+    # mixml execute --script test.mixml test.xml
+
+This produces the following XML output:
+
+    <list>
+        <tiger name="Hobbes">
+            <hobby name="Space Travel"/>
+        </tiger>
+        <philosopher name="Rawls"/>
+    </list>
+
+### Plain Ruby
+
+If you prefer, you can also use plain Ruby code to modify nodes.
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+You can then use the following mixml script in `test.mixml` to rename some nodes:
+
+    with_nodes xpath '//philosopher[@name="Hobbes"]' do |node|
+        node.name = 'tiger'
+    end
+
+Now execute the following command to run the script:
+
+    # mixml execute --script test.mixml test.xml
+
+This produces the following XML output:
+
+    <list>
+        <tiger name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+Instead of processing each node individually, you can also process the selected node sets.
+
+Let's use the following XML in file `test.xml`:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+You can then use the following mixml script in `test.mixml` to replace some nodes:
+
+    with_nodesets xpath '//philosopher[@name="Hobbes"]' do |nodeset|
+        nodeset.remove
+    end
+
+Now execute the following command to run the script:
+
+    # mixml execute --script test.mixml test.xml
+
+This produces the following XML output:
+
+    <list>
+        <philosopher name="Rawls"/>
+    </list>

data/demo/applique/test.rb

@@ -1,57 +1,12 @@
 require 'fileutils'
-require 'rspec/expectations'
-require 'rspec/collection_matchers'
 require 'equivalent-xml'
 require 'nokogiri'
+require 'ae'
+require 'mixml'
+require 'mixml/application'
 
-include RSpec::Matchers
-
-# File with test content
-class TestFile
-    include RSpec::Matchers
-
-    # @return [String] File name
-    attr_reader :file_name
-
-    # @param file_name [String] File name
-    def initialize(file_name)
-        @file_name = file_name
-    end
-
-    # Write text into file
-    #
-    # @param text [String] Text to write
-    # @return [void]
-    def <<(text)
-        File.open(@file_name, 'w') do |f|
-            f.write text
-        end
-    end
-
-    # Expect file to match content
-    #
-    # @param object [String, Nokogiri::XML::Document] Text or XML to match
-    # @return [void]
-    def matches(object)
-        content = File.read(@file_name)
-        if object.is_a?(Nokogiri::XML::Document) then
-            expect(content).to be_equivalent_to(object).respecting_element_order
-        else
-            expect(content).to be(object)
-        end
-    end
-end
-
-# Create a new test file
-def file(name)
-    FileUtils.mkpath(File.dirname(name))
-    TestFile.new(name)
-end
-
-# Create a new XML document
-def xml(text)
-    Nokogiri::XML(text)
-end
+# Add bin directory to path
+ENV['PATH'] = File.join(QED::Utils.root, 'bin') + ":" + ENV['PATH']
 
 # Redirect stdout and return output
 #
@@ -60,25 +15,104 @@ end
 def redirect
     begin
         old_stdout = $stdout
+        old_stderr = $stderr
         $stdout = StringIO.new('', 'w')
+        $stderr = $stdout
         yield
         $stdout.string
     ensure
         $stdout = old_stdout
+        $stderr = old_stderr
     end
 end
 
-# Define a new matcher to compare text files ignoring empty lines as well as leading and trailing spaces.
-RSpec::Matchers.define :match_text do |expected|
-    # Remove empty lines and leading and trailing spaces from text
-    #
-    # @param text [String] Text to clean
-    # @return [String] cleaned text
-    def clean(text)
-        text.gsub(/\n+/, "\n").gsub(/^\s+|\s+$/, '')
+# Remove empty lines and leading and trailing spaces from text
+#
+# @param text [String] Text to clean
+# @return [String] cleaned text
+def clean(text)
+    raise(ArgumentError, 'Text must not be nil.') if text.nil?
+
+    text.gsub(/\n+/, "\n").gsub(/^\s+|\s+$/, '')
+end
+
+When /\buse\b[^.]+\bXML in (?:file )?`([a-z]+\.xml)`/i do |file_name, xml|
+    raise(ArgumentError, 'Please supply a block with the XML document') if xml.nil?
+
+    doc = Nokogiri::XML(xml) do |config|
+        config.default_xml.noblanks
+    end
+
+    File.open(file_name, 'w') do |f|
+        doc.write_xml_to(f, :indent => 4)
     end
+end
+
+When /\buse\b[^.]+\bscript in (?:file )?`([a-z]+\.mixml)`/i do |file_name, text|
+    raise(ArgumentError, 'Please supply a block with the mixml script') if text.nil?
 
-    match do |actual|
-        clean(actual) == clean(expected)
+    File.open(file_name, 'w') do |f|
+        f.write(text)
+    end
+end
+
+When /\bproduces\b[^.]+\bXML in (?:file )?`([a-z]+\.xml)`/i do |file_name, xml|
+    raise(ArgumentError, 'Please supply a block with the XML document') if xml.nil?
+
+    actual = Nokogiri::XML(File.read('test.xml')) do |config|
+        config.default_xml.noblanks
+    end
+
+    expected = Nokogiri::XML(xml) do |config|
+        config.default_xml.noblanks
+    end
+
+    EquivalentXml.assert.equivalent?(actual, expected, :element_order => true)
+end
+
+When /\bproduces\b[^.]+\bXML output\b/i do |xml|
+    raise(ArgumentError, 'Please supply a block with the XML document') if xml.nil?
+
+    actual = Nokogiri::XML(@output) do |config|
+        config.default_xml.noblanks
+    end
+
+    expected = Nokogiri::XML(xml) do |config|
+        config.default_xml.noblanks
+    end
+
+    options = {:element_order => true}
+    EquivalentXml.assert.equivalent?(actual, expected, options)
+end
+
+When /\bproduces\b[^.]+\btext output\b/i do |text|
+    raise(ArgumentError, 'Please supply a block with the text') if text.nil?
+    clean(@output).assert == clean(text)
+end
+
+When /\bexecute\b[^.]+\bcommand\b/i do |command|
+    raise(ArgumentError, 'Please supply a block with the command to run') if command.nil?
+    command.gsub!(/^#\s*/, '')
+    arguments = Shellwords.shellsplit(command)
+    Commander::Runner.instance_variable_set :"@singleton", Commander::Runner.new(arguments[1..-1])
+    app = Mixml::Application.new
+
+    @output = redirect do
+        app.run
+    end
+end
+
+When /\bexecuting\b[^.]+\bfails\b/i do |command|
+    raise(ArgumentError, 'Please supply a block with the command to run') if command.nil?
+    command.gsub!(/^#\s*/, '')
+    arguments = Shellwords.shellsplit(command)
+    Commander::Runner.instance_variable_set :"@singleton", Commander::Runner.new(arguments[1..-1])
+    app = Mixml::Application.new
+    app.run
+
+    SystemExit.expect do
+        @output = redirect do
+            app.run
+        end
     end
 end