mixml 0.9.3 → 0.9.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzAyODY3MmNkMjgyNWM1ZGYzOGNkZTZjNjc3MDAyZjNiYzE0MWUxMA==
+    N2ZmMjE2Y2Q1OWE4NjA3YmM1ZjcwYWU2YTRmYzg1MDNlNjI5ZTk3MA==
   data.tar.gz: !binary |-
-    MjlhOTU2MWZjMDdlYjlkODI3ZDRiZDkwMWUyYjYyOThhMTM2YTNjNQ==
+    Y2M0NTNhOWJlYWRlN2JjNTRiNTc2MjcyMDQzMDlkM2M1YTFkZTBlNA==
 SHA512:
   metadata.gz: !binary |-
-    NTBlYThlYmM1MjVhMzFhZmI3OTRkOGVhMmE5ZTY2ZTM2YzYyOTI5YTA5YWUx
-    MTI4NDU4MDIyYjlkNDY4MTNkNTI3OTQ5YzIwZDZhYWNiMDNlNDgyMzA0ZjVi
-    ZjJmZjI5ODJiMTFlMjlmODcwN2E4YTEyNmEyZGQ1OTE5NDUzMWE=
+    ZGU2MzhhMzNlZTA3NDMwMmU3MzJkYWExNDI3MzFjMWZkYjM0Njg4MmI0YmVm
+    ZGYyM2EwNThhMGY1MWRiODk2NGI4MmVhNjNkN2Q1ZWQxNTVmYzdjN2QwNTE0
+    NWFlMjZjMjY2MWZmYWZlZWI4YTg1Mzc4ZDZiNDAxMWEwOTcxZWQ=
   data.tar.gz: !binary |-
-    NDczODMwYzhjNmVjYTYxMTdlZjA5NzhkYzA4YzhmYjg3YjVmZGRmMGZlNWJh
-    N2M5OTI0ZmFhZDQ1MTUzYTUyOGQwMDQ1ZWQ3ZjNmODdjZDFiOTNlZmI5NTFl
-    ZGUxYTc3MTIzNTIxOTExNWNlZmM1MGUxOGFjYmNlN2FhM2QyYWY=
+    YjBiMjQzMDYyMDdhOTEyYzEyMDg0MjBjOTBlMmQwM2JmYjZkMmU2N2JjZTdi
+    NGM4ZjhkMDc1MjhiMWViYzc3NDYzZWYzY2IzN2ZhN2M2ODY5NDBkOGFlNTlh
+    MTRlN2Y1YTZlOGU0ZWExZjE5MTdmMTJlOTE0MTJhYjQ5M2NmODA=

data/README.md

@@ -13,6 +13,7 @@ to spare me from having to use XSLT ever again.
 You can use mixml to change XML files in the following ways:
 
   * Pretty print
+  * Print selected nodes and attributes to the console
   * Remove nodes
   * Add nodes
   * Replace nodes
@@ -28,6 +29,10 @@ The following command will pretty print all XML files:
 
     mixml pretty --inplace *.xml
 
+The following command will print all attribute names and values:
+
+    mixml write --xpath '//@*' --template '{=node.name}={=node.value}' test.xml
+
 You can find a description of all supported commands and usage examples [here](demo/application_commands.md).
 
 ## Selection

data/demo/application_checks.md

@@ -20,8 +20,8 @@ Executing mixml to modify documents with multiple value types fails:
 
     # mixml rename --xpath '//philosopher' --string 'tiger' --template 'scholar'
 
-## Command without selector fails
+## Command without value fails
 
 Executing mixml to modify documents without a selector fails:
 
-    # mixml rename --string 'tiger'
+    # mixml rename --xpath '//philosopher'

data/demo/application_commands.md

@@ -22,6 +22,44 @@ This produces the following text output:
         <philosopher name="Rawls"/>
     </list>
 
+## Write nodes
+
+You can use mixml to print selected 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 write --quiet --xpath '//philosopher/@name' test.xml
+
+This produces the following text output:
+
+    name="Hobbes"
+    name="Rawls"
+
+You can also supply an expression that used to create 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 select some nodes and remove them:
+
+    # mixml write --quiet --xpath '//philosopher/@name' --template '{=node.name}={=node.value}' test.xml
+
+This produces the following text output:
+
+    name=Hobbes
+    name=Rawls
+
 ## Remove nodes
 
 You can use mixml to remove nodes from your XML documents.

data/lib/mixml/application.rb

@@ -9,6 +9,9 @@ module Mixml
 
         # Command that selects nodes
         class SelectCommand < Commander::Command
+            # @return [Boolean] Suppress automatic output of result
+            attr_accessor :suppress_output
+
             # Initialize a new command
             #
             # @param method [Symbol] Command method
@@ -31,25 +34,49 @@ module Mixml
                     }
                 end
 
-                when_called self, :perform
+                when_called self, :execute
             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)
+            def execute(args, options)
+                before args, options
+
+                if @suppress_output then
+                    $tool.print = false
+                    $tool.save = false
+                end
+
                 $tool.work(args) do
                     @selectors.each do |selector|
                         selection = instance_eval(&selector)
-                        selection.send name
+                        selection.send name, *parameters
                     end
                 end
             end
+
+            # Parameters for command execution
+            #
+            # @return [Array] Parameters
+            def parameters
+                []
+            end
+
+            # Invoked before the command is executed
+            #
+            # @param args [Array<String>] Arguments from the command line
+            # @param options [Commander::Command::Options] Options from the command line
+            def before(args, options)
+            end
         end
 
         # Command that selects and modifies nodes
         class ModifyCommand < SelectCommand
+            # @return [Boolean] Supplying an expression is optional
+            attr_accessor :optional_expression
+
             # Initialize a new command
             #
             # @param method [Symbol] Command method
@@ -58,6 +85,7 @@ module Mixml
                 super(method, args)
 
                 @template = nil
+                @optional_expression = false
 
                 option '-s', '--string STRING', String, 'String value' do |value|
                     raise SystemExit, 'Value already specified. Please use --string or --template only once.' unless @template.nil?
@@ -70,16 +98,17 @@ module Mixml
                 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
+            # Check if an expression is set
+            def before(args, options)
+                if not @optional_expression and @template.nil? then
+                    raise SystemExit, 'Please specify a value with --string or --template.'
                 end
             end
+
+            # Return the template as parameter
+            def parameters
+                [@template]
+            end
         end
 
         # Create a new selection command
@@ -115,6 +144,10 @@ module Mixml
                 $tool.print = !value
             end
 
+            global_option('-q', '--quiet', 'Do not print nodes') do |value|
+                $tool.print = !value
+            end
+
             command :pretty do |c|
                 c.description = 'Pretty print XML files'
                 c.action do |args, options|
@@ -123,6 +156,12 @@ module Mixml
                 end
             end
 
+            modify_command :write do |c|
+                c.description = 'Write selected nodes to the console'
+                c.suppress_output = true
+                c.optional_expression = true
+            end
+
             select_command :remove do |c|
                 c.description = 'Remove nodes from the XML documents'
             end

data/lib/mixml/selection.rb

@@ -16,8 +16,26 @@ module Mixml
 
         # Remove selected nodes from the document
         def remove
-            each_node do |nodeset|
-                nodeset.remove
+            each_node do |node|
+                node.remove
+            end
+        end
+
+        # Print selected nodes to stdout
+        #
+        # @param template [Template::Base] Template to evaluate and print
+        def write(template = nil)
+            if not template.nil? then
+                template = template.to_mixml_template
+            end
+
+            each_node do |node|
+                if template.nil? then
+                    node.write_xml_to($stdout)
+                    puts
+                else
+                    puts template.evaluate(node)
+                end
             end
         end
 

data/lib/mixml/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixml
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Jochen Seeber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-21 00:00:00.000000000 Z
+date: 2014-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander