mixml 0.9.1 → 0.9.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWIzODcxYzM4YTQzNWQ5MTBkMDZmODAwYmNjYTRjMmFlMjZiNTUwMQ==
+    YzAyODY3MmNkMjgyNWM1ZGYzOGNkZTZjNjc3MDAyZjNiYzE0MWUxMA==
   data.tar.gz: !binary |-
-    NzJmMTMzYjJhN2ExZTE4MjYxNzQ3OTdjYTI5YjY4ZWFmYzRkN2NiNA==
+    MjlhOTU2MWZjMDdlYjlkODI3ZDRiZDkwMWUyYjYyOThhMTM2YTNjNQ==
 SHA512:
   metadata.gz: !binary |-
-    MjY1N2JlY2RiOWNhZTQyMGNhZmRiN2U4M2Y1MDU2ODg3YWQ1ZTg4YjMzNjYy
-    NzhmNzVkYzk3N2FhY2YwNThmNjFlMTM1MzlkNjUwMmE3OTEzOWY3Y2I0ZGQ1
-    NWE0MzM3MWU0OTE0YTRkZGI0MGJiMGM0ZGZhN2QxNmI1NTlhMWQ=
+    NTBlYThlYmM1MjVhMzFhZmI3OTRkOGVhMmE5ZTY2ZTM2YzYyOTI5YTA5YWUx
+    MTI4NDU4MDIyYjlkNDY4MTNkNTI3OTQ5YzIwZDZhYWNiMDNlNDgyMzA0ZjVi
+    ZjJmZjI5ODJiMTFlMjlmODcwN2E4YTEyNmEyZGQ1OTE5NDUzMWE=
   data.tar.gz: !binary |-
-    YTc3ZjA3YzM4YjViNTRkYTg1MzgwMzljZmMwZWU2ODEzOWIyNjZhNTVhM2Mx
-    YWYwNjBkNmYxM2M3MGIzMGQ3NDRjZjE4YWI5OTNhNjZlYjA2NTM0N2NiZmZi
-    NzBhODAwNGJmZTBjYWM3Y2ZiMWQ4YmMzODQ3ZTBmZWJiMGY3ODE=
+    NDczODMwYzhjNmVjYTYxMTdlZjA5NzhkYzA4YzhmYjg3YjVmZGRmMGZlNWJh
+    N2M5OTI0ZmFhZDQ1MTUzYTUyOGQwMDQ1ZWQ3ZjNmODdjZDFiOTNlZmI5NTFl
+    ZGUxYTc3MTIzNTIxOTExNWNlZmM1MGUxOGFjYmNlN2FhM2QyYWY=

data/README.md

@@ -3,9 +3,14 @@
 [![Gem Version](https://badge.fury.io/rb/mixml.png)](http://badge.fury.io/rb/mixml)
 [![Build Status](https://travis-ci.org/jochenseeber/mixml.png?branch=master)](https://travis-ci.org/jochenseeber/mixml)
 [![Coverage Status](https://coveralls.io/repos/jochenseeber/mixml/badge.png?branch=master)](https://coveralls.io/r/jochenseeber/mixml?branch=master)
+[![Inline docs](http://inch-ci.org/github/jochenseeber/mixml.png?branch=master)](http://inch-ci.org/github/jochenseeber/mixml)
 
-Mixml is a small tool to greatly simplify the tedious task of changing multiple multiple XML files at once. Its main
-purpose is to spare me from having to use XSLT ever again. You can use mixml to change XML files in the following ways:
+Mixml is a small tool to greatly simplify the tedious task of changing multiple XML files at once. Its main purpose is
+to spare me from having to use XSLT ever again.
+
+## Usage
+
+You can use mixml to change XML files in the following ways:
 
   * Pretty print
   * Remove nodes
@@ -14,151 +19,62 @@ purpose is to spare me from having to use XSLT ever again. You can use mixml to
   * Rename nodes
   * Change node values
 
-For example, the following command will remove all attributes named `id` from the supplied XML files:
+For example, the following command will remove all attributes named `id` from the all XML files in the current
+directory.
 
     mixml remove --inplace --xpath '//@id' *.xml
 
-Mixml also supports a simple DSL to perform scripted changes. To perform the same as above using a script, save the
-following in `test.mixml`:
-
-    xpath '//@id' do
-        remove
-    end
-
-and then call:
-
-    mixml execute --script test.mixml *.xml
-
-You can also use mixml directly in your Ruby code:
-
-    require 'mixml'
-
-    tool = Mixml::Tool.new do |t|
-        t.save = true
-    end
-
-    tool.work('one.xml', 'two.xml') do
-        xpath '//@id' do
-            remove
-        end
-    end
-
-Mixml supports building replacement values using
-
-  * [Ruby string interpolation](http://en.wikibooks.org/wiki/Ruby_Programming/Syntax/Literals#Interpolation)
-  * [Erubis templates](http://www.kuwata-lab.com/erubis/)
-  * [Nokogiri's XML DSL](http://nokogiri.org/Nokogiri/XML/Builder.html)
-  * Plain Ruby
-
-You can find more usage examples [here](demo/tool.md).
-
-## Installation
-
-Install mixml:
-
-    $ gem install mixml
-
-## Usage
-
-Use the following command to get help:
+The following command will pretty print all XML files:
 
-    mixml --help
+    mixml pretty --inplace *.xml
 
-### Pretty print XML
+You can find a description of all supported commands and usage examples [here](demo/application_commands.md).
 
-    mixml pretty *.xml
+## Selection
 
-### Remove nodes
+In addition to using XPath expressions, you can also use CSS rules to select the nodes you want to process. For
+example, the following command will remove the first child of each element:
 
-    mixml remove --xpath '//addresses' *.xml
+    mixml remove --inplace --css '*:first-child' *.xml
 
-### Rename nodes
+You can find a detailed description and usage examples [here](demo/application_selection.md).
 
-    mixml rename --xpath '//addresses' --template 'addressbook' *.xml
+## Scripts
 
-### Replace nodes
+In addition to the command line, mixml also supports a simple simple DSL to perform scripted changes. For example, to
+perform the same as above using a script, save the following in `test.mixml`:
 
-    mixml replace --xpath '//addresses' --template '<addressbook/>' *.xml
-
-### Append nodes
-
-    mixml append --xpath '/list' --template '<addressbook/>' *.xml
-
-### Set node value
-
-    mixml value --xpath '//addresses/@name' --template 'default' *.xml
-
-### Execute a script
-
-Example script in `test.mixml`
-
-    xpath '//addresses[name="default"]' do
+    xpath '//@id' do
         remove
     end
-    xpath '//addresses' do
-        replace template '<addressbook/>'
-    end
 
-Use the following command to run the script
+and then call:
 
     mixml execute --script test.mixml *.xml
 
-Script commands:
-
-    xpath 'xpath-expression' do
-        remove # Remove node
-        replace 'xml' # Replace node
-        append 'xml'
-        value 'text' # Set node value
-        rename 'text' # Rename node
-    end
-
-Instead of using strings for parameters, you can also use a template expression:
-
-    xpath 'xpath-expression' do
-        replace template 'special-{=node.name}' # Prefix nodes with 'special-''
-    end
-
-This works for all commands that take a string parameter. We use [Erubis](http://www.kuwata-lab.com/erubis) as
-templating engine, and `{` and `}` as delimiters.
+You can also use mixml directly in your Ruby code. See [here](demo/application_invocation.md) for usage examples.
 
-In addition, you can also use [Nokogiri](http://http://nokogiri.org/)'s
-[builder component](http://nokogiri.org/Nokogiri/XML/Builder.html) to create the XML that replaces an element:
+## Values
 
-    xpath '//addresses' do
-        replace xml ->(node, xml) {
-            xml.addressbook(:name => node['name'])
-        }
-    end
-
-### Use CSS rules to select nodes
-
-You can also use CSS rules instead of XPath expressions to select the nodes to process:
-
-    css 'addresses:first-child', 'addresses:last-child' do
-        remove
-    end
-
-### Evaluate an expression
-
-You can also pass the script to execute directly to mixml:
+Mixml supports specifying XML fragments that are to be inserted using
 
-    mixml execute --expression 'xpath("//addresses") { remove }' *.xml
-
-### Write results
+  * [Ruby string interpolation](http://en.wikibooks.org/wiki/Ruby_Programming/Syntax/Literals#Interpolation)
+  * [Erubis templates](http://www.kuwata-lab.com/erubis/)
+  * [Nokogiri's XML DSL](http://nokogiri.org/Nokogiri/XML/Builder.html)
+  * Plain Ruby
 
-The standard setting is to leave the input files unchanged and print the resulting files. You can replace the input
-files with the changed XML by using the `inplace` option:
+See [here](demo/application_values.md) for a description of all methods and detailed usage examples.
 
-    mixml remove --inplace --xpath '//addresses' test.xml
+## Output
 
-This will remove all elements named `group` from `test.xml`.
+XML output can be printed to the console or written back to the file it was read from. Mixml also supports pretty
+printing all output. See [here](demo/application_output.md) for a detailed description and usage examples.
 
-### Pretty print results
+## Installation
 
-To pretty print the output, use the `pretty` option:
+Install mixml:
 
-    mixml remove --inplace --xpath '//addresses' --pretty test.xml
+    $ gem install mixml
 
 ## Contributing
 

data/bin/mixml

@@ -1,105 +1,7 @@
 #!/usr/bin/env ruby
 require 'rubygems'
 require 'bundler/setup'
-require 'commander/import'
-require 'mixml'
+require 'mixml/application'
 
-program :name, 'mixml'
-program :version, Mixml::VERSION
-program :description, 'XML helper tool'
-
-$tool = Mixml::Tool.new
-
-global_option('-p', '--pretty', 'Pretty print output') do |value|
-    $tool.pretty = value
-end
-
-global_option('-i', '--inplace', 'Replace the processed files with the new files') do |value|
-    $tool.save = value
-    $tool.print = !value
-end
-
-command :pretty do |c|
-    c.description = 'Pretty print XML files'
-    c.action do |args, options|
-        $tool.pretty = true
-        $tool.work(args)
-    end
-end
-
-command :remove do |c|
-    c.description = 'Remove nodes from the XML documents'
-    c.option '-x', '--xpath STRING', String, 'XPath for nodes to delete'
-    c.action do |args, options|
-        $tool.work(args) do
-            xpath options.xpath do
-                remove
-            end
-        end
-    end
-end
-
-command :replace do |c|
-    c.description = 'Rename nodes in the XML documents'
-    c.option '-x', '--xpath STRING', String, 'XPath for nodes to replace'
-    c.option '-t', '--template STRING', String, 'Template to generate the replacement value'
-    c.action do |args, options|
-        $tool.work(args) do
-            xpath options.xpath do
-                rename template options.template
-            end
-        end
-    end
-end
-
-command :append do |c|
-    c.description = 'Append child nodes in the XML documents'
-    c.option '-x', '--xpath STRING', String, 'XPath for nodes to append to'
-    c.option '-t', '--template STRING', String, 'Template to generate the nodes to append'
-    c.action do |args, options|
-        $tool.work(args) do
-            xpath options.xpath do
-                append template options.template
-            end
-        end
-    end
-end
-
-command :replace do |c|
-    c.description = 'Replace nodes from the XML documents'
-    c.option '-x', '--xpath STRING', String, 'XPath for nodes to replace'
-    c.option '-t', '--template STRING', String, 'Template to generate the replacement value'
-    c.action do |args, options|
-        $tool.work(args) do
-            xpath options.xpath do
-                replace template options.template
-            end
-        end
-    end
-end
-
-command :value do |c|
-    c.description = 'Set node values'
-    c.option '-x', '--xpath STRING', String, 'XPath for nodes to change'
-    c.option '-t', '--template STRING', String, 'Template to generate the replacement value'
-    c.action do |args, options|
-        $tool.work(args) do
-            xpath options.xpath do
-                value template options.template
-            end
-        end
-    end
-end
-
-command :execute do |c|
-    c.description = 'Execute script on the XML documents'
-    c.option '-s', '--script STRING', String, 'Script file to execute'
-    c.option '-e', '--expression STRING', String, 'Command to execute'
-    c.action do |args, options|
-        script = options.expression || File.read(options.script)
-
-        $tool.work(args) do
-            execute(script)
-        end
-    end
-end
+# Run application if we're the main file
+Mixml::Application.new.run if $0 == __FILE__

data/demo/application_checks.md

@@ -0,0 +1,27 @@
+# Error checking
+
+The following demonstrations test mixml's error checking. All examples on this page are designed to fail.
+
+## Command without selector fails
+
+Executing mixml to modify documents without a selector fails:
+
+    # mixml rename --string 'tiger'
+
+## Command with multiple values fails
+
+Executing mixml to modify documents with multiple values fails:
+
+    # mixml rename --xpath '//philosopher' --string 'tiger' --string 'scholar'
+
+## Command with multiple value types fails
+
+Executing mixml to modify documents with multiple value types fails:
+
+    # mixml rename --xpath '//philosopher' --string 'tiger' --template 'scholar'
+
+## Command without selector fails
+
+Executing mixml to modify documents without a selector fails:
+
+    # mixml rename --string 'tiger'

data/demo/application_commands.md

@@ -0,0 +1,133 @@
+# mixml Commands
+
+This document demonstrates the different mixml commands to modify XML documents.
+
+## Pretty print
+
+You can use mixml to pretty print your XML documents.
+
+Let's use the following XML in file `test.xml`:
+
+    <list><philosopher name="Hobbes"/><philosopher name="Rawls"/></list>
+
+Now execute the following command to pretty print this file:
+
+    # mixml pretty test.xml
+
+This produces the following text output:
+
+    <?xml version="1.0"?>
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+## Remove nodes
+
+You can use mixml to remove nodes from your XML documents.
+
+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 remove them:
+
+    # mixml remove --xpath '//philosopher[@name="Hobbes"]' test.xml
+
+This produces the following XML output:
+
+    <list>
+        <philosopher name="Rawls"/>
+    </list>
+
+## Replace nodes
+
+You can use mixml to replace nodes in your XML documents.
+
+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>
+
+## Append nodes
+
+You can use mixml to append nodes to your XML documents.
+
+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 append a child node to them:
+
+    # mixml append --xpath '/list' --string '<tiger name="Hobbes"/>' test.xml
+
+This produces the following XML output:
+
+    <list>
+        <philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+        <tiger name="Hobbes"/>
+    </list>
+
+## Replace attribute values
+
+You can use mixml to replace attribute values in your XML documents.
+
+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 attributes and change their value:
+
+    # mixml value --xpath '//philosopher[1]/@name' --string 'Platon' test.xml
+
+This produces the following XML output:
+
+    <list>
+        <philosopher name="Platon"/>
+        <philosopher name="Rawls"/>
+    </list>
+
+## Rename nodes
+
+You can use mixml to rename nodes values in your XML documents.
+
+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 attributes and rename them:
+
+    # mixml rename --xpath '//philosopher[@name="Hobbes"]' --template 'tiger-and-{=node.name}' test.xml
+
+This produces the following XML output:
+
+    <list>
+        <tiger-and-philosopher name="Hobbes"/>
+        <philosopher name="Rawls"/>
+    </list>