mixml 0.9.1 → 0.9.3

data/lib/mixml/application.rb

@@ -0,0 +1,162 @@
+#!/usr/bin/env ruby
+require 'commander'
+require 'mixml'
+
+module Mixml
+    # Mixml application class
+    class Application
+        include Commander::Methods
+
+        # Command that selects nodes
+        class SelectCommand < Commander::Command
+            # Initialize a new command
+            #
+            # @param method [Symbol] Command method
+            # @param args [Array<String>] Command arguments
+            def initialize(method, args = ARGV)
+                super(method)
+
+                @method = method
+                @selectors = []
+
+                option '-x', '--xpath STRING', String, 'XPath expression to select nodes' do |value|
+                    @selectors << ->(tool) {
+                        xpath value
+                    }
+                end
+
+                option '-c', '--css STRING', String, 'CSS rule to select nodes' do |value|
+                    @selectors << ->(tool) {
+                        css value
+                    }
+                end
+
+                when_called self, :perform
+            end
+
+            # Run the command
+            #
+            # @param args [Array<String>] Arguments from the command line
+            # @param options [Commander::Command::Options] Options from the command line
+            def perform(args, options)
+                $tool.work(args) do
+                    @selectors.each do |selector|
+                        selection = instance_eval(&selector)
+                        selection.send name
+                    end
+                end
+            end
+        end
+
+        # Command that selects and modifies nodes
+        class ModifyCommand < SelectCommand
+            # Initialize a new command
+            #
+            # @param method [Symbol] Command method
+            # @param args [Array<String>] Command arguments
+            def initialize(method, args = ARGV)
+                super(method, args)
+
+                @template = nil
+
+                option '-s', '--string STRING', String, 'String value' do |value|
+                    raise SystemExit, 'Value already specified. Please use --string or --template only once.' unless @template.nil?
+                    @template = Mixml::Template::Text.new(value)
+                end
+
+                option '-t', '--template STRING', String, 'Template expression value' do |value|
+                    raise SystemExit, 'Value already specified. Please use --string or --template only once.' unless @template.nil?
+                    @template = Mixml::Template::Expression.new(value)
+                end
+            end
+
+            def perform(args, options)
+                raise SystemExit, 'Please specify a value with --string or --template.' if @template.nil?
+
+                $tool.work(args) do
+                    @selectors.each do |selector|
+                        selection = instance_eval(&selector)
+                        selection.send name, @template
+                    end
+                end
+            end
+        end
+
+        # Create a new selection command
+        #
+        # @param name [Symbol] command name
+        def select_command(name)
+            c = add_command SelectCommand.new(name)
+            yield c if block_given?
+        end
+
+        # Create a new modification command
+        #
+        # @param name [Symbol] command name
+        def modify_command(name)
+            c = add_command ModifyCommand.new(name)
+            yield c if block_given?
+        end
+
+        # Run the mixml command
+        def run
+            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
+
+            select_command :remove do |c|
+                c.description = 'Remove nodes from the XML documents'
+            end
+
+            modify_command :replace do |c|
+                c.description = 'Replace nodes in the XML documents'
+            end
+
+            modify_command :append do |c|
+                c.description = 'Append child nodes in the XML documents'
+            end
+
+            modify_command :rename do |c|
+                c.description = 'Rename nodes in the XML documents'
+            end
+
+            modify_command :value do |c|
+                c.description = 'Set node values'
+            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!
+        end
+    end
+end

data/lib/mixml/document.rb

@@ -9,6 +9,8 @@ module Mixml
         # @return [String] XML document
         attr_reader :xml
 
+        # Initialize a new document
+        #
         # @param name [String] Document name
         # @param xml [Nokigiri::XML::Document] XML document
         def initialize(name, xml)

data/lib/mixml/selection.rb

@@ -7,6 +7,8 @@ module Mixml
         # @return [Nokogiri::XML::NodeSet] Selected nodes
         attr_reader :nodesets
 
+        # Initialize a new selection
+        #
         # @param nodesets [Array<Nokogiri::XML::NodeSet>] Selected nodes
         def initialize(nodesets)
             @nodesets = nodesets

data/lib/mixml/template/text.rb

@@ -11,6 +11,8 @@ module Mixml
             #
             # @param text [String] Template text
             def initialize(text)
+                raise(ArgumentError, 'Text must not be nil.') if text.nil?
+
                 @text = '"' << text.gsub('"', '\"') << '"'
             end
 

data/lib/mixml/tool.rb

@@ -2,6 +2,7 @@ require 'mixml/selection'
 require 'mixml/document'
 require 'mixml/template/expression'
 require 'mixml/template/xml'
+require 'mixml/template/text'
 require 'docile'
 require 'nokogiri'
 
@@ -27,16 +28,12 @@ module Mixml
         attr_accessor :indent
 
         # Intialize a new mixml tool
-        def initialize(&block)
+        def initialize
             @indent = 4
             @pretty = false
             @save = false
             @print = true
             @documents = []
-
-            if block_given? then
-                yield self
-            end
         end
 
         # Load XML files
@@ -56,12 +53,11 @@ module Mixml
             end
         end
 
-        # Save all loaded XML files
-        #
-        # Pretty prints the XML if {#pretty} is enabled.
+        # Output all loaded XML files
         #
-        # @return [void]
-        def save_all
+        # @yield Block to write each document
+        # @yieldparam document [Document] Document to write
+        def output_all
             options = {}
 
             if @pretty then
@@ -69,6 +65,17 @@ module Mixml
             end
 
             @documents.each do |document|
+                yield document, options
+            end
+        end
+
+        # Save all loaded XML files
+        #
+        # Pretty prints the XML if {#pretty} is enabled.
+        #
+        # @return [void]
+        def save_all
+            output_all do |document, options|
                 File.open(document.name, 'w') do |file|
                     document.xml.write_xml_to(file, options)
                 end
@@ -82,13 +89,7 @@ module Mixml
         #
         # @return [void]
         def print_all
-            options = {}
-
-            if @pretty then
-                options[:indent] = @indent
-            end
-
-            @documents.each do |document|
+            output_all do |document, options|
                 if @documents.size > 1 then
                     puts '-' * document.name.length
                     puts document.name
@@ -235,7 +236,7 @@ module Mixml
         # @param selection [Selection] Selected nodes
         # @yield Block to execute for each node
         # @yieldparam node [Nokogiri::XML::Node] Current node
-        def node(selection)
+        def with_nodes(selection)
             selection.nodesets.each do |nodeset|
                 nodeset.each do |node|
                     yield node
@@ -248,7 +249,7 @@ module Mixml
         # @param selection [Selection] Selected nodes
         # @yield Block to execute for each node set
         # @yieldparam node [Nokogiri::XML::NodeSet] Current node set
-        def nodes(selection, &block)
+        def with_nodesets(selection, &block)
             selection.nodesets.each do |nodeset|
                 yield nodeset
             end

data/lib/mixml/version.rb

@@ -1,4 +1,4 @@
 module Mixml
     # Current version
-    VERSION = '0.9.1'
+    VERSION = '0.9.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixml
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.3
 platform: ruby
 authors:
 - Jochen Seeber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2014-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -109,33 +109,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.9'
 - !ruby/object:Gem::Dependency
-  name: rspec-expectations
+  name: ae
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-collection_matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
@@ -190,9 +176,15 @@ files:
 - LICENSE.txt
 - README.md
 - bin/mixml
+- demo/application_checks.md
+- demo/application_commands.md
+- demo/application_invocation.md
+- demo/application_output.md
+- demo/application_selection.md
+- demo/application_values.md
 - demo/applique/test.rb
-- demo/tool.md
 - lib/mixml.rb
+- lib/mixml/application.rb
 - lib/mixml/document.rb
 - lib/mixml/selection.rb
 - lib/mixml/template.rb

data/demo/tool.md

@@ -1,334 +0,0 @@
-# Usage examples
-
-## Setup
-
-First we need to create a new Tool object and load an XML file. We create a Mixml tool object and use a
-[helper](applique/test.rb) to load the following XML for each example.
-
-    require 'mixml'
-
-    Before do
-        @tool = Mixml::Tool.new do |t|
-            # Pretty print output
-            t.pretty = true
-
-            # Save output after processing
-            t.save = true
-
-            # Don't print documents after processing
-            t.print = false
-        end
-
-        # Save test.xml
-        file('test.xml') << %{
-            <list>
-                <philosopher name="Hobbes"/>
-                <philosopher name="Rawls"/>
-            </list>
-        }
-
-        @tool.load('test.xml')
-    end
-
-## Remove nodes
-
-Select some nodes with an XPath expression and then remove them
-
-    @tool.execute do
-        xpath '//philosopher' do
-            remove
-        end
-    end
-    @tool.flush
-
-    file('test.xml').matches xml %{
-        <list/>
-    }
-
-## Replace nodes
-
-Select some elements with an XPath expression and then change the element name.
-
-    @tool.execute do
-        xpath '//*[@name = "Hobbes"]' do
-            replace '<tiger name="Hobbes"/>'
-        end
-    end
-    @tool.flush
-
-    file('test.xml').matches xml %{
-        <list>
-            <tiger name="Hobbes"/>
-            <philosopher name="Rawls"/>
-        </list>
-    }
-
-## Replace nodes with string interpolation
-
-Ruby [string interpolation](http://en.wikibooks.org/wiki/Ruby_Programming/Syntax/Literals#Interpolation) is performed on
-string parameters, so you can also select some elements with an XPath expression and then change each element using a
-Ruby expression.
-
-    @tool.execute do
-        xpath '//*[@name = "Hobbes"]' do
-            replace '<tiger-and-#{node.name} name="Hobbes"/>'
-        end
-    end
-    @tool.flush
-
-    file('test.xml').matches xml %{
-        <list>
-            <tiger-and-philosopher name="Hobbes"/>
-            <philosopher name="Rawls"/>
-        </list>
-    }
-
-This works for all commands that take a string parameter.
-
-## Replace nodes with a template
-
-If you prefer, you can also use template expressions instead of string parameters. Mixml uses
-[Erubis](http://www.kuwata-lab.com/erubis) as templating engine, and `{` and `}` as delimiters. With this, you can
-select some elements with an XPath expression and then replace each element.
-
-    @tool.execute do
-        xpath '//*[@name = "Hobbes"]' do
-            replace template '<tiger-and-{=node.name} name="{=node["name"]}"/>'
-        end
-    end
-    @tool.flush
-
-    file('test.xml').matches xml %{
-        <list>
-            <tiger-and-philosopher name="Hobbes"/>
-            <philosopher name="Rawls"/>
-        </list>
-    }
-
-This works for all commands that take a string parameter.
-
-## Replace nodes with XML
-
-If you prefer, you can also use an XML builder to create values using the simple DSL provided by
-[Nokogiri](http://nokogiri.org/Nokogiri/XML/Builder.html). Using this, you can select some elements with an XPath
-expression and then replace each element.
-
-    @tool.execute do
-        xpath '//*[@name = "Hobbes"]' do
-            replace xml ->(node, xml) {
-                xml.send(:"tiger-and-philosopher", :name => node['name'])
-            }
-        end
-    end
-    @tool.flush
-
-    file('test.xml').matches xml %{
-        <list>
-            <tiger-and-philosopher name="Hobbes"/>
-            <philosopher name="Rawls"/>
-        </list>
-    }
-
-This works for all commands that take XML text as parameter (e.g. replace and append).
-
-## Replace nodes with Ruby
-
-If you prefer, you can also use plain Ruby code to create values. with this, you can select some elements with an XPath
-expression and then replace each element.
-
-    @tool.execute do
-        node xpath '//*[@name = "Hobbes"]' do |node|
-            node.name = "tiger-and-#{node.name}"
-        end
-    end
-    @tool.flush
-
-    file('test.xml').matches xml %{
-        <list>
-            <tiger-and-philosopher name="Hobbes"/>
-            <philosopher name="Rawls"/>
-        </list>
-    }
-
-Instead of processing each node individually, you can also process the selected node sets.
-
-    @tool.execute do
-        nodes xpath('//*[@name = "Hobbes"]') do |nodeset|
-            nodeset.each do |node|
-                node.name = "tiger-and-#{node.name}"
-            end
-        end
-    end
-    @tool.flush
-
-    file('test.xml').matches xml %{
-        <list>
-            <tiger-and-philosopher name="Hobbes"/>
-            <philosopher name="Rawls"/>
-        </list>
-    }
-
-This works for all commands that take XML text as parameter (e.g. replace and append).
-
-## Append nodes
-
-Select some elements with an XPath expression and then append children to them.
-
-    @tool.execute do
-        xpath '/list' do
-            append '<tiger name="Hobbes"/>'
-        end
-    end
-    @tool.flush
-
-    file('test.xml').matches xml %{
-        <list>
-            <philosopher name="Hobbes"/>
-            <philosopher name="Rawls"/>
-            <tiger name="Hobbes"/>
-        </list>
-    }
-
-## Replace attribute values
-
-Select some attributes with an XPath expression and change their value.
-
-    @tool.execute do
-        xpath '//philosopher[1]/@name' do
-            value 'Thomas Hobbes'
-        end
-    end
-    @tool.flush
-
-    file('test.xml').matches xml %{
-        <list>
-            <philosopher name="Thomas Hobbes"/>
-            <philosopher name="Rawls"/>
-        </list>
-    }
-
-## Rename nodes
-
-Select some nodes with an XPath expression and change their name.
-
-    @tool.execute do
-        xpath '//philosopher[@name = "Hobbes"]' do
-            rename 'tiger-and-#{node.name}'
-        end
-    end
-    @tool.flush
-
-    file('test.xml').matches xml %{
-        <list>
-            <tiger-and-philosopher name="Hobbes"/>
-            <philosopher name="Rawls"/>
-        </list>
-    }
-
-## Evaluate a command string
-
-Evaluate a command string with mixml commands
-
-    @tool.execute("xpath('//philosopher') { remove }")
-    @tool.flush
-
-    file('test.xml').matches xml %{
-        <list/>
-    }
-
-## Select nodes using CSS rules
-
-You can also use CSS rules to select the nodes to process
-
-    @tool.execute("css('philosopher:first-child') { remove }")
-    @tool.flush
-
-    file('test.xml').matches xml %{
-        <list>
-            <philosopher name="Rawls"/>
-        </list>
-    }
-
-## Do everything in one step
-
-Load files, modify them and optionally save them again in one step using the `work` method.
-
-    tool = Mixml::Tool.new do |t|
-        t.pretty = true
-    end
-
-    @tool.work('test.xml') do
-        xpath '//philosopher' do
-            remove
-        end
-    end
-
-    expect(@tool.documents).to have(0).items
-
-    file('test.xml').matches xml %{
-        <list/>
-    }
-
-## Print modified documents without saving
-
-Print files whithout saving them.
-
-    @tool.save = false
-    @tool.print = true
-
-    text = redirect do
-        @tool.execute do
-            xpath '//philosopher' do
-                remove
-            end
-        end
-
-        @tool.flush
-    end
-
-    # Check output
-    expect(text).to match_text(%{
-        <?xml version="1.0"?>
-        <list/>
-    })
-
-    # Check if file still is unmodified
-    file('test.xml').matches xml %{
-        <list>
-            <philosopher name="Hobbes"/>
-            <philosopher name="Rawls"/>
-        </list>
-    }
-
-## Print headers when processing multiple documents
-
-    text = redirect do
-        file('more.xml') << %{
-            <list>
-                <philosopher name="Kant"/>
-                <philosopher name="Platon"/>
-            </list>
-        }
-
-        @tool.load('more.xml')
-        @tool.print_all
-    end
-
-    expect(text).to match_text(%{
-        --------
-        test.xml
-        --------
-        <?xml version="1.0"?>
-        <list>
-            <philosopher name="Hobbes"/>
-            <philosopher name="Rawls"/>
-        </list>
-        --------
-        more.xml
-        --------
-        <?xml version="1.0"?>
-        <list>
-            <philosopher name="Kant"/>
-            <philosopher name="Platon"/>
-        </list>
-    })