xmlcodec 0.0.3 → 0.0.4

data/Rakefile

@@ -1,5 +1,5 @@
 PKG_NAME = 'xmlcodec'
-PKG_VERSION = '0.0.3'
+PKG_VERSION = '0.0.4'
 
 require 'rake'
 require 'rake/testtask'

data/lib/XMLElement.rb

@@ -491,6 +491,11 @@ module XMLCodec
       if not already_partial_export_ended?
         @already_partial_export_ended = true
         
+        if not already_partial_exported?
+          raise "<#{self} Trying to end the export of an element that hasn't"+
+                " been started yet"
+        end
+        
         each_subelement do |e|
           e.end_partial_export(file)
         end

data/lib/XMLStreamObjectParser.rb

@@ -5,13 +5,13 @@ module XMLCodec
   # This class is used internally by the parser to store the information about
   # each of the elements that gets created.
   class XMLSOParserElement
-    attr_reader :elclass, :consumed, :id
+    attr_reader :elclass, :consumed, :id, :depth
     
     # Create a new instance with the element name, a hash of atributes, it's
     # import/export class, the parent element and it's id
     # The id is used to fill in element_id and parent_id in XMLElement so that
     # the parser's user can know what is the tree structure between objects.
-    def initialize(name, attrs, elclass, parent, id)
+    def initialize(name, attrs, elclass, parent, id, depth)
       @attrs = attrs
       @elclass = elclass
       @children = Hash.new([])
@@ -21,6 +21,7 @@ module XMLCodec
       @parent = parent
       @id = id
       @name = name
+      @depth = depth
     end
 
     # Add a child element to the object    
@@ -65,7 +66,7 @@ module XMLCodec
       @listener = listener
       @children = Hash.new([])
       @currel = 0
-      @elements = [XMLSOParserElement.new(nil, nil, nil, nil, nil)]
+      @elements = [XMLSOParserElement.new(nil, nil, nil, nil, nil, 0)]
       @id = 0
       @top_element = nil
     end
@@ -102,7 +103,8 @@ module XMLCodec
     
     def tag_start(name, attrs) #:nodoc:
       @elements << XMLSOParserElement.new(name, attrs, get_elclass(name), 
-                                          curr_element, next_id)
+                                          curr_element, next_id, 
+                                          curr_element.depth+1)
       @currel += 1
     end
 

data/lib/XMLStreamParser.rb

@@ -91,7 +91,9 @@ module XMLUtils
     
     def tag_end(name)
       @contents << "</"+name+">"
-      element(name)
+      if @listener.respond_to? 'el_'+name
+        @listener.send('el_'+name, @elements[-1])
+      end
       @elements.pop()
     end
     
@@ -99,12 +101,6 @@ module XMLUtils
       @contents.text_from(@elements[-1].elstart)
     end
     
-    def element(name)
-      if @listener
-        @listener.element(@elements[-1])
-      end
-    end
-    
     def consume
       @contents.erase_from(@elements[-1].elstart)
     end

data/lib/XMLUtils.rb

@@ -1,4 +1,5 @@
-require "rexml/document"
+require 'rexml/document'
+require 'stringio'
 
 # This module holds generic XML utilities. The module's methods are simple 
 # XML utilities. The module also contains XMLStreamParser, a Generic XML Stream 
@@ -16,7 +17,7 @@ module XMLUtils
   def self.count_elements(path, filename)
     doc = getdoc(filename)
     i = 0
-    XPath.each(doc, path) {|element| i+=1}
+    REXML::XPath.each(doc, path) {|element| i+=1}
     return i
   end
 
@@ -55,4 +56,51 @@ module XMLUtils
     t.write_with_substitution(str, string)
     str
   end
+  
+  # Gets the xpath inside a given document that can either be a string or a 
+  # REXML::Document
+  #
+  # opts can have:
+  #   :multiple: fetch all the occurences of the xpath
+  #   :with_attrs: include the attribute contents in the result
+  #   :recursive: recursively include all the subelements of the matches
+  def self.get_xpath(path, doc, opts={})
+    if doc.is_a? REXML::Document
+      doc = doc
+    else
+      doc = REXML::Document.new(doc)
+    end
+    
+    if opts[:multiple]
+      strs = []
+      REXML::XPath.each(doc.root, path) do |e|
+        t = get_rexml_content(e, opts)
+        strs << t if t != ''
+      end
+      return strs.join(' ')
+    else
+      return get_rexml_content(REXML::XPath.first(doc, path), opts)
+    end
+  end
+  
+  def self.get_rexml_content(element, opts={})
+    return '' if not element
+    strs = []
+    if element.respond_to?('value')
+      return element.value || ''
+    else
+      if opts[:with_attrs]
+        element.attributes.each {|name, value| strs << value if value != ''}
+      end
+      if not opts[:recursive]
+        element.texts.each {|t| strs << t if t != ''}
+      else  
+        element.to_a.each do |e|
+          t = get_rexml_content(e, opts)
+          strs << t if t != ''
+        end
+      end
+    end
+    strs.join(' ')
+  end
 end

data/test/TestPartialExport.rb

@@ -142,4 +142,31 @@ class TestPartialExport < Test::Unit::TestCase
     compare_xpath(value1, filename, "/subels/abc[1]")
     compare_xpath(value2, filename, "/subels/abc[2]")
   end
+  
+  def test_recursive
+    filename = 'test_partial_export_recursive.xml'
+    file = File.open(filename, "w")
+    
+    value = 'somevalue'
+  
+    rec1 = Recursive.new
+    rec1.start_partial_export(file)
+    
+    rec2 = Recursive.new
+    rec1.recursive << rec2
+    rec2.start_partial_export(file)
+    
+    rec3 = Recursive.new
+    rec2.recursive << rec3
+    rec3.start_partial_export(file)
+    
+    sel = SimpleElement.new(value)
+    sel.start_partial_export(file)
+    rec3.abc = sel
+    
+    rec1.end_partial_export(file)
+    
+    file.close
+    validate_well_formed(filename)
+  end
 end

data/test/TestXMLStreamObjectParser.rb

@@ -7,19 +7,19 @@ include XMLCodec
 class MyStreamListener
   attr_reader :abc, :subels, :mult, :subel
   def el_abc(el)
-    @abc = el.get_object
+    @abc = el
   end
   
   def el_subels(el)
-    @subels = el.get_object
+    @subels = el
   end
   
   def el_mult(el)
-    @mult = el.get_object
+    @mult = el
   end
   
   def el_subel(el)
-    @subel = el.get_object
+    @subel = el
   end
 end
 
@@ -28,7 +28,7 @@ class MyConsumingStreamListener
 
   def el_abc(el)
     el.consume
-    @abc = el.get_object
+    @abc = el
   end
 end
 
@@ -46,7 +46,7 @@ class TestXMLStreamObjectParser < Test::Unit::TestCase
     listener = MyStreamListener.new
     parser = XMLStreamObjectParser.new(listener)
     parser.parse(file)
-    el = listener.abc
+    el = listener.abc.get_object
     assert_equal el.value, value
   end
   
@@ -59,7 +59,7 @@ class TestXMLStreamObjectParser < Test::Unit::TestCase
     parser = XMLStreamObjectParser.new(listener)
     parser.parse(file)
     
-    el = listener.abc
+    el = listener.abc.get_object
     assert_equal el.value, value
     
     subel = parser.top_element
@@ -67,10 +67,6 @@ class TestXMLStreamObjectParser < Test::Unit::TestCase
     assert_equal attrvalue, subel.someattr
   end
   
-  def test_multiple_names
-    
-  end
-  
   def test_mult
     value = 'somevalue'
     file = '<mult><abc>'+value+'</abc></mult>'
@@ -79,7 +75,7 @@ class TestXMLStreamObjectParser < Test::Unit::TestCase
     parser = XMLStreamObjectParser.new(listener)
     parser.parse(file)
     
-    el = listener.abc
+    el = listener.abc.get_object
     assert_equal el.value, value
     assert_equal el, parser.top_element.abc[0]
   end
@@ -92,7 +88,7 @@ class TestXMLStreamObjectParser < Test::Unit::TestCase
     parser = XMLStreamObjectParser.new(listener)
     parser.parse(file)
     
-    el = listener.abc
+    el = listener.abc.get_object
     assert_equal el.value, value
     assert_equal el, parser.top_element.subelements[0]
   end
@@ -105,7 +101,7 @@ class TestXMLStreamObjectParser < Test::Unit::TestCase
     parser = XMLStreamObjectParser.new(listener)
     parser.parse(file)
     
-    el = listener.abc
+    el = listener.abc.get_object
     assert_equal el.value, value
     assert_nil parser.top_element.abc
   end
@@ -119,7 +115,7 @@ class TestXMLStreamObjectParser < Test::Unit::TestCase
     parser = XMLStreamObjectParser.new(listener)
     parser.parse(file)
     
-    el = listener.subels
+    el = listener.subels.get_object
     assert_equal 2, el.subelements.size
     [value1, value2].each_with_index do |value, index|
       assert_kind_of SimpleElementMultName, el.subelements[index]
@@ -136,7 +132,7 @@ class TestXMLStreamObjectParser < Test::Unit::TestCase
     parser = XMLStreamObjectParser.new(listener)
     parser.parse(file)
     
-    el = listener.mult
+    el = listener.mult.get_object
     assert_equal 2, el.abc2.size
     [value1, value2].each_with_index do |value, index|
       assert_kind_of SimpleElementMultName, el.abc2[index]
@@ -152,9 +148,23 @@ class TestXMLStreamObjectParser < Test::Unit::TestCase
     parser = XMLStreamObjectParser.new(listener)
     parser.parse(file)
     
-    el = listener.subel
+    el = listener.subel.get_object
     assert_not_nil el.abc2
     assert_kind_of SimpleElementMultName, el.abc2
     assert_equal value, el.abc2.value
   end
+  
+  def test_depth
+    value = 'somevalue'
+    file = '<subel><abc>'+value+'</abc></subel>'
+    
+    listener = MyStreamListener.new
+    parser = XMLStreamObjectParser.new(listener)
+    parser.parse(file)
+    
+    el1 = listener.subel
+    el2 = listener.abc
+    
+    assert el1.depth < el2.depth
+  end
 end

data/test/TestXMLStreamParser.rb

@@ -4,44 +4,44 @@ $-w = true
 require 'test/unit'
 require 'XMLStreamParser'
 
-class MyStreamListener
-	attr_reader :def_id, :def_parent_id
-	attr_reader :abc_id, :abc_parent_id
-	def element(el)
-		case el.name
-		when "def"
-			@def_id, = el.element_id
-			@def_parent_id = el.parent_id
-			el.consume
-		when "abc"
-			@abc_id, = el.element_id
-			@abc_parent_id = el.parent_id
-			el.consume
-		end
-	end
+class MyXMLStreamListener
+  attr_reader :def_id, :def_parent_id
+  attr_reader :abc_id, :abc_parent_id
+  
+  def el_def(el)
+    @def_id, = el.element_id
+    @def_parent_id = el.parent_id
+    el.consume
+  end
+  
+  def el_abc(el)
+    @abc_id, = el.element_id
+    @abc_parent_id = el.parent_id
+    el.consume
+  end
 end
 
 class TestXMLStreamParser < Test::Unit::TestCase
-	def initialize(*args)
-		super(*args)
-		@doc = "<abc attr1='1' attr2='2'>abc<xpto attr1='a'></xpto><def><x></x></def></abc>"
-		@doc_no_def = "<abc attr1='1' attr2='2'>abc<xpto attr1='a'></xpto></abc>"
-	end
+  def initialize(*args)
+    super(*args)
+    @doc = "<abc attr1='1' attr2='2'>abc<xpto attr1='a'></xpto><def><x></x></def></abc>"
+    @doc_no_def = "<abc attr1='1' attr2='2'>abc<xpto attr1='a'></xpto></abc>"
+  end
 
-	def test_total_parse
-		parser = XMLUtils::XMLStreamParser.new
-		parser.parse(@doc)
-		assert_equal(@doc, parser.content)
-	end
-	
-	def test_consumed_parse
-		listener = MyStreamListener.new
-		parser = XMLUtils::XMLStreamParser.new(listener)
-		parser.parse(@doc)
-		assert_equal(@doc_no_def, parser.content)
-		assert_equal(listener.abc_id, listener.def_parent_id)
-		assert_equal(0, listener.abc_parent_id)
-		assert_equal(1, listener.abc_id)
-		assert(listener.def_id > listener.def_parent_id)
-	end
+  def test_total_parse
+    parser = XMLUtils::XMLStreamParser.new
+    parser.parse(@doc)
+    assert_equal(@doc, parser.content)
+  end
+  
+  def test_consumed_parse
+    listener = MyXMLStreamListener.new
+    parser = XMLUtils::XMLStreamParser.new(listener)
+    parser.parse(@doc)
+    assert_equal(@doc_no_def, parser.content)
+    assert_equal(listener.abc_id, listener.def_parent_id)
+    assert_equal(0, listener.abc_parent_id)
+    assert_equal(1, listener.abc_id)
+    assert(listener.def_id > listener.def_parent_id)
+  end
 end

data/test/TestXMLUtils.rb

@@ -4,14 +4,47 @@ require 'test/unit'
 require 'XMLUtils'
 
 class TestXMLUtils < Test::Unit::TestCase
-	def test_create_open_tag
-		tag = XMLUtils::create_open_tag("name", {"arg1" => "val1", "arg2" => "val2"})
-		assert_equal("<name arg1='val1' arg2='val2'>", tag)	
-	end
-	
-	def test_escape_xml
-	  assert_equal '&lt; abc', XMLUtils::escape_xml('< abc')
-	  assert_equal '&gt; abc', XMLUtils::escape_xml('> abc')
-	  assert_equal '&amp; abc', XMLUtils::escape_xml('& abc')
-	end
+  def test_create_open_tag
+    tag = XMLUtils::create_open_tag("name", {"arg1" => "val1", "arg2" => "val2"})
+    assert_equal("<name arg1='val1' arg2='val2'>", tag)  
+  end
+  
+  def test_escape_xml
+    assert_equal '&lt; abc', XMLUtils::escape_xml('< abc')
+    assert_equal '&gt; abc', XMLUtils::escape_xml('> abc')
+    assert_equal '&amp; abc', XMLUtils::escape_xml('& abc')
+  end
+  
+  def test_get_xpath
+    opts = {}
+    assert_xpath_equal('abc', '//xpto', '<xpto>abc<xpto>')
+    
+    assert_xpath_equal('abc', '//xpto', '<xpto>abc<xpto2>foo</xpto2><xpto>')
+    
+    opts[:with_attrs] = true
+    opts[:recursive] = false
+    opts[:multiple] = false
+    assert_xpath_equal('attr1 abc', '//xpto', '<xpto attr1="attr1">abc<xpto2>foo</xpto2><xpto>', opts)
+    
+    opts[:with_attrs] = false
+    opts[:recursive] = true
+    opts[:multiple] = false
+    assert_xpath_equal('abc foo', '//xpto', '<xpto>abc<xpto2 attr1="attr1">foo</xpto2><xpto>', opts)
+    
+    opts[:with_attrs] = true
+    opts[:recursive] = true
+    opts[:multiple] = false
+    assert_xpath_equal('abc attr1 foo', '//xpto', '<xpto>abc<xpto2 attr1="attr1">foo</xpto2><xpto>', opts)
+    
+    opts[:with_attrs] = false
+    opts[:recursive] = false
+    opts[:multiple] = true
+    assert_xpath_equal('abc foo', '//xpto', '<xpto>abc<xpto attr1="attr1">foo</xpto><xpto>', opts)
+  end
+  
+  def assert_xpath_equal(result, path, xml, opts={})
+    assert_equal result, XMLUtils::get_xpath(path, xml, opts)
+    assert_equal result, XMLUtils::get_xpath(path, StringIO.new(xml), opts)
+    assert_equal result, XMLUtils::get_xpath(path, REXML::Document.new(xml), opts)
+  end
 end

data/test/simple_objects.rb

@@ -45,3 +45,9 @@ class SubelMultElement < XMLElement
   xmlsubel_mult :abc
   xmlsubel_mult :abc2
 end
+
+class Recursive < XMLElement
+  elname 'recursive'
+  xmlsubel :abc
+  xmlsubel_mult :recursive
+end

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.8.11
+rubygems_version: 0.9.0
 specification_version: 1
 name: xmlcodec
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2006-05-29 00:00:00 +01:00
+  version: 0.0.4
+date: 2006-07-06 00:00:00 +01:00
 summary: Generic Importer/Exporter of XML formats
 require_paths: 
 - lib
@@ -25,6 +25,7 @@ required_ruby_version: !ruby/object:Gem::Version::Requirement
 platform: ruby
 signing_key: 
 cert_chain: 
+post_install_message: 
 authors: 
 - "Pedro C\xC3\xB4rte-Real"
 files: