mixml 0.0.1 → 0.0.2

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTM2NTgxNmFjNmU2MDFjMmZjMDU2YjZjOGMwYWQyMjFkZDc0ODIzOA==
+    OTc1ZjA5ZjljNGJjMjFiMTk3MjNmMmRiMzEwYzY4NmRlZmJhZmFjNA==
   data.tar.gz: !binary |-
-    ZTBiMzIyZjljMzlhMzk5NzlkMjcxNmRlMjkwOTlmZGZlNzEwNTY3Yw==
+    MTJkMDc3NDBhNmJhYzVmZDU1ODNmZjgzYWRmMGYyZjQ0NmFjNzU5ZA==
 SHA512:
   metadata.gz: !binary |-
-    ZjJiMzU4YWI2M2YzMmFhYmRjY2JkNmZlMTk5YTk1NzNiZjI0ZWFjOGU5ZmI4
-    ZWQxNDlmMDQ2YjFhNDIwMTgxODI0YWE5YThlODIzOTgyYWVmN2IzYmEzMjhh
-    MjFlOGQyZjBjN2MxMjExMDEyZjhkODRjODVlNjRmNmYwMzFlMDg=
+    YzA0NzY5MDBkMDM1N2NkMTAwNTM4YmM1NThjNDhiNzgzYjVhYTY1NmE0Zjhl
+    Yzg1YWRhNGI3YjI4Y2NmZjE5MzE0YTM0ODA2MDY3ZWZiNWRlZTgzNzNkOTJl
+    ZTcwOGEyYzBhNWUyYjVkNjViYWNlYmU2MDcxN2UyMjUxY2FmZjA=
   data.tar.gz: !binary |-
-    NTQxNjM5NzQyNmExOGI2ZTlhOTgwMDg2MTdmYTE2ZjM4ZGM2N2ZmNzEyMGY4
-    NmQ0OGUyN2NiODM4MGUxNDY5Mzg4ZTg2MWVlODhjYjQxZTQ4ZWY5MTdlYWQx
-    MTMyZTIxYmU0MmEzNTIzYzFiYzc2YjVkYjRkZGRiN2Y3NDQ5MGE=
+    NzYyOTc4NzQ3NTE4ZDZiOGYwZjMzMWQ3M2U3NmNkMDhjODA2ZWY2YzVkNjU1
+    MDMxZDUyMTViY2VjZGMyYjc2NjUzOWJlOWZhMTI0MGFiM2Q1MWY4NjZjZjQ4
+    NmZlYWIxYWJmZTY1ZDY4YzQ0ZDIyMzQ5ODk3OWM3ZDMwZDU4MmQ=

data/bin/mixml

@@ -16,6 +16,7 @@ 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|
@@ -38,6 +39,19 @@ command :remove do |c|
     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 :replace do |c|
     c.description = 'Replace nodes from the XML documents'
     c.option '-x', '--xpath STRING', String, 'XPath for nodes to replace'

data/lib/mixml/document.rb

@@ -1,10 +1,16 @@
 
 
 module Mixml
+    # Loaded XML document
     class Document
+        # @return [String] Document name
         attr_reader :name
+
+        # @return [String] XML document
         attr_reader :xml
 
+        # @param name [String] Document name
+        # @param name [Nokigiri::XML::Document] XML document
         def initialize(name, xml)
             @name = name
             @xml = xml

data/lib/mixml/selection.rb

@@ -1,21 +1,27 @@
-require 'mixml/template/text'
+require 'mixml'
+require 'mixml/template'
 
 module Mixml
+    # Selection of XML nodes
     class Selection
+        # @return [Nokogiri::XML::NodeSet] Selected nodes
         attr_reader :nodes
 
+        # @param nodes [Nokogiri::XML::NodeSet] Selected nodes
         def initialize(nodes)
             @nodes = nodes
         end
 
+        # Remove selected nodes from the document
         def remove
             @nodes.remove
         end
 
+        # Replace selected nodes with a template
+        #
+        # @param template [Template::Base] Template to replace nodes with
         def replace(template)
-            if template.is_a?(String) then
-                template = Template::Text.new(template)
-            end
+            template = template.to_mixml_template
 
             @nodes.each do |node|
                 value = template.evaluate(node)
@@ -23,15 +29,28 @@ module Mixml
             end
         end
 
+        # Set the value selected nodes with a template
+        #
+        # @param template [Template::Base] Template to set the value
         def value(template)
-            if template.is_a?(String) then
-                template = Template::Text.new(template)
-            end
+            template = template.to_mixml_template
 
             @nodes.each do |node|
                 value = template.evaluate(node)
                 node.value = value
             end
         end
+
+        # Rename selected nodes with a template
+        #
+        # @param template [Template::Base] Template for new name
+        def rename(template)
+            template = template.to_mixml_template
+
+            @nodes.each do |node|
+                value = template.evaluate(node)
+                node.name = value
+            end
+        end
     end
 end

data/lib/mixml/template.rb

@@ -0,0 +1,11 @@
+require 'mixml/template/text'
+
+# Extend String
+class String
+    # Convert a string into a template
+    #
+    # @return [Mixml::Template::Text] String as template
+    def to_mixml_template
+        ::Mixml::Template::Text.new(self)
+    end
+end

data/lib/mixml/template/base.rb

@@ -0,0 +1,15 @@
+module Mixml
+    module Template
+        # Base class for templates
+        class Base
+            # Convert into a template
+            #
+            # This is done by the complex and intricate process of returning `self`.
+            #
+            # @return [Mixml::Template::Base] Return self
+            def to_mixml_template
+                self
+            end
+        end
+    end
+end

data/lib/mixml/template/template.rb

@@ -1,18 +1,28 @@
+require 'mixml/template/base'
 require 'erubis'
 
 module Mixml
+    # Module for template classes
     module Template
-        class Template
-            attr_reader :text
+        # Eruby based template
+        class Expression < Base
+            # @return [Erubis::Eruby] Template expression
+            attr_reader :expression
 
+            # Initialize a new template
+            #
+            # @param [String] text Template text
             def initialize(text)
-                @text = text
+                @expression = Erubis::Eruby.new(text, :pattern => '{ }')
             end
 
+            # Evaluate the template
+            #
+            # @param [Nokogiri::XML::Node] node Current node
+            # @return [String] Template result
             def evaluate(node)
-                template = Erubis::Eruby.new(@text, :pattern => '{ }')
                 context = {:node => node}
-                template.result(context)
+                @expression.result(context)
             end
         end
     end

data/lib/mixml/template/text.rb

@@ -1,14 +1,24 @@
+require 'mixml/template/base'
+
 module Mixml
     module Template
-        class Text
+        # Ruby string template
+        class Text < Base
+            # @return [String] Template text
             attr_reader :text
 
+            # Initialize a new template
+            #
+            # @param text [String] Template text
             def initialize(text)
-                @text = text
+                @text = '"' << text.gsub('"', '\"') << '"'
             end
 
+            # Evaulate the template using Ruby string interpolation
+            #
+            # @param node [Nokogiri::XML::Node] Current node
             def evaluate(node)
-                @text
+                eval(@text, binding)
             end
         end
     end

data/lib/mixml/tool.rb

@@ -4,20 +4,44 @@ require 'mixml/template/template'
 require 'docile'
 require 'nokogiri'
 
+# Mixml main module
 module Mixml
+    # Mixml tool
+    #
+    # This is the main class for using mixml.
     class Tool
+        # @return [Array<Document>] loaded XML Documents
         attr_reader :documents
+
+        # @return [Boolean] pretty print XML during output
         attr_accessor :pretty
+
+        # @return [Boolean] save processed XML documents, defaults to false
         attr_accessor :save
+
+        # @return [Boolean] print processed XML documents, defaults to true
+        attr_accessor :print
+
+        # @return [Integer] indent width, defaults to 4
         attr_accessor :indent
 
-        def initialize
+        # Intialize a new mixml tool
+        def initialize(&block)
             @indent = 4
             @pretty = false
             @save = false
+            @print = true
             @documents = []
+
+            if block_given? then
+                yield self
+            end
         end
 
+        # Load XML files
+        #
+        # @param file_names [Array] Names of the XML files to load
+        # @return [void]
         def load(*file_names)
             file_names.flatten.each do |file_name|
                 xml = File.open(file_name, 'r') do |file|
@@ -31,6 +55,11 @@ module Mixml
             end
         end
 
+        # Save all loaded XML files
+        #
+        # Pretty prints the XML if {#pretty} is enabled.
+        #
+        # @return [void]
         def save_all
             options = {}
 
@@ -45,6 +74,12 @@ module Mixml
             end
         end
 
+        # Print all loaded XML files
+        #
+        # Pretty prints the XML if {#pretty} is enabled. If more than one file is loaded, a header with the file's name
+        # is printed before each file.
+        #
+        # @return [void]
         def print_all
             options = {}
 
@@ -62,20 +97,43 @@ module Mixml
             end
         end
 
+        # Remove all loaded XML files
+        #
+        # Files are not saved before removing them.
+        #
+        # @return [void]
         def remove_all
             @documents = []
         end
 
+        # Print/save all loaded XML files and then remove them
+        #
+        # Files are saved if {#save} is enabled, and they are printed to the console if {#print} is enabled.
+        #
+        # @return [void]
         def flush
+            if @print then
+                print_all
+            end
+
             if @save then
                 save_all
-            else
-                print_all
             end
 
             remove_all
         end
 
+        # Perform work on a list of XML files
+        #
+        # Perform the following steps:
+        # #. Remove all loaded XML files without saving them
+        # #. Load the supplied XML files
+        # #. Execute the supplied block
+        # #. Flush all XML files
+        #
+        # @param file_names [Array] Names of the XML files to load
+        # @yield Block to execute with loaded XML files
+        # @return [void]
         def work(*file_names, &block)
             remove_all
 
@@ -90,12 +148,23 @@ module Mixml
             flush
         end
 
+        # Execute a block for each loaded XML document
+        #
+        # @yield Block to execute for each XML document
+        # @yieldparam xml {Nokogiri::XML::Document} XML document
+        # @return [void]
         def process
             @documents.each do |document|
                 yield document.xml
             end
         end
 
+        # Select nodes using an XPath expression and execute DSL commands for these nodes
+        #
+        # @param query [String] XPath expression
+        # @yield Block to execute for each nodeset
+        # @yieldparam nodes {Nokogiri::XML::NodeSet} XML nodes to process
+        # @return [void]
         def xpath(query, &block)
             process do |xml|
                 nodes = xml.xpath(query)
@@ -107,10 +176,19 @@ module Mixml
             end
         end
 
+        # Create a DSL replacement template
+        #
+        # @param text [String] Template text
+        # @return [Template] Replacement template
         def template(text)
-            Template::Template.new(text)
+            Template::Expression.new(text)
         end
 
+        # Execute a script or a block
+        #
+        # @param program [String] DSL script to execute
+        # @yield Block to execute
+        # @return [void]
         def execute(program = nil, &block)
             if not program.nil? then
                 instance_eval(program)

data/lib/mixml/version.rb

@@ -1,3 +1,4 @@
 module Mixml
-    VERSION = '0.0.1'
+    # Current version
+    VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mixml
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jochen Seeber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-14 00:00:00.000000000 Z
+date: 2014-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -108,7 +108,49 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.9'
-description: XML tool to easily manipulate multiple XML files at once
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Easily manipulate multiple XML files at once
 email:
 - jochen@seeber.me
 executables:
@@ -120,14 +162,20 @@ files:
 - lib/mixml.rb
 - lib/mixml/document.rb
 - lib/mixml/selection.rb
+- lib/mixml/template.rb
+- lib/mixml/template/base.rb
 - lib/mixml/template/template.rb
 - lib/mixml/template/text.rb
 - lib/mixml/tool.rb
 - lib/mixml/version.rb
-homepage: http://www.noussommesdesoles.net
+homepage: https://github.com/jochenseeber/mixml
 licenses:
 - AGPL-3.0
-metadata: {}
+metadata:
+  issue_tracker: https://github.com/jochenseeber/mixml/issues
+  source_code: https://github.com/jochenseeber/mixml
+  documentation: http://rubydoc.info/gems/mixml/frames
+  wiki: https://github.com/jochenseeber/mixml/wiki
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -147,6 +195,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: XML tool to easily manipulate multiple XML files at once
+summary: Easily manipulate multiple XML files at once
 test_files: []
 has_rdoc: