xmlcodec 0.1.3 → 0.3.0

data/lib/stream_object_parser.rb

@@ -32,6 +32,7 @@ module XMLCodec
     # passed to the constructor. This is cached so the object will only be 
     # created once. All subsequent calls will return the same object.
     def get_object
+      return nil if not @elclass
       if not @object
         @object = @elclass.new_with_content(@attrs, @children)
         if @parent
@@ -59,7 +60,7 @@ module XMLCodec
   # The listener will be passed XMLSOParserElement objects. The two relevant
   # methods for it's use are XMLSOParserElement#get_object and 
   # XMLSOParserElement#consume.
-  class XMLStreamObjectParser
+  class XMLStreamObjectParser < Nokogiri::XML::SAX::Document
     # Create a new parser with a listener.
     def initialize(base_element, listener=nil)
       @base_element = base_element
@@ -92,7 +93,8 @@ module XMLCodec
     # Parse the text with the stream parser calling the listener on any events
     # that it listens to.
     def parse(text)
-      REXML::Document.parse_stream(text, self)
+      parser = Nokogiri::XML::SAX::Parser.new(self)
+      parser.parse(text)
     end
   
     # Get the current top element of the parse. This is usually used to get the
@@ -101,18 +103,18 @@ module XMLCodec
       @top_element.get_object if @top_element
     end
     
-    def tag_start(name, attrs) #:nodoc:
+    def start_element(name, attrs) #:nodoc:
       @elements << XMLSOParserElement.new(name, attrs, get_elclass(name), 
                                           curr_element, next_id, 
                                           curr_element.depth+1)
       @currel += 1
     end
 
-    def text(text) #:nodoc:
+    def characters(text) #:nodoc:
       curr_element.add_child(text)
     end
     
-    def tag_end(name) #:nodoc:
+    def end_element(name) #:nodoc:
       obj = curr_element
       
       if @listener.respond_to?("el_"+name)
@@ -120,8 +122,10 @@ module XMLCodec
       end
       
       if not obj.consumed
-        if prev_element
-          prev_element.add_child(obj.get_object)
+        real_obj = obj.get_object
+
+        if prev_element && real_obj
+          prev_element.add_child(real_obj)
         end
         
         @top_element = obj
@@ -130,9 +134,5 @@ module XMLCodec
       @elements.pop
       @currel -= 1
     end
-    
-    # Ignore everything except tags and text for now
-    def method_missing(methId, *args) #:nodoc:
-    end
   end
 end

data/lib/stream_parser.rb

@@ -55,7 +55,7 @@ module XMLUtils
     end
   end
 
-  class XMLStreamParser
+  class XMLStreamParser < Nokogiri::XML::SAX::Document
     attr_reader :contents
     
     def initialize(listener=nil)
@@ -72,20 +72,21 @@ module XMLUtils
     end
 
     def parse(text)
-      REXML::Document.parse_stream(text, self)
+      parser = Nokogiri::XML::SAX::Parser.new(self)
+      parser.parse(text)
     end
     
-    def tag_start(name, attrs)
+    def start_element(name, attrs)
       @elements << XMLSParserElement.new(name, @contents.size, 
                                               self, @elements[-1])
-      @contents << XMLUtils.create_open_tag(name, attrs)
+      @contents << XMLCodec::XMLUtils.create_open_tag(name, attrs)
     end
     
-    def text(text)
-      @contents << XMLUtils.escape_xml(text)
+    def characters(text)
+      @contents << XMLCodec::XMLUtils.escape_xml(text)
     end
     
-    def tag_end(name)
+    def end_element(name)
       @contents << "</"+name+">"
       if @listener.respond_to? 'el_'+name
         @listener.send('el_'+name, @elements[-1])
@@ -100,9 +101,5 @@ module XMLUtils
     def consume
       @contents.erase_from(@elements[-1].elstart)
     end
-    
-    # Ignore everything except tags and text for now
-    def method_missing(methId, *args)
-    end
   end
 end

data/lib/subelements.rb

@@ -7,7 +7,7 @@ module XMLCodec
   
     # Create a new element for the given string.
     def initialize(string)
-      @value = XMLUtils::escape_xml(string)
+      @value = XMLCodec::XMLUtils::escape_xml(string)
     end
     
     # Simple to_s method that just returns the included string
@@ -17,7 +17,7 @@ module XMLCodec
     
     # Creates the XML for the element by using add_text on the value.
     def create_xml(parent)
-      parent.add_text(@value)
+      parent << Nokogiri::XML::Text.new(@value, parent)
     end
     
     # The XML text of the element is simply it's string value.

data/lib/xmlcodec.rb

@@ -1,3 +1,9 @@
+require 'nokogiri'
+
+module XMLCodec
+    VERSION = '0.3.0'
+end
+
 require File.dirname(__FILE__) + '/XMLUtils'
 require File.dirname(__FILE__) + '/element'
 require File.dirname(__FILE__) + '/subelements'

data/test/element_test.rb

@@ -1,5 +1,5 @@
 require File.dirname(__FILE__) + '/test_helper'
-require 'rexml/document'
+require 'nokogiri'
 
 class TestXMLElement < Test::Unit::TestCase
   def test_xmlsubel
@@ -16,15 +16,15 @@ class TestXMLElement < Test::Unit::TestCase
     assert_equal('<abc>'+value+'</abc>', sel.xml_text)
     assert_equal('<subel><abc>'+value+'</abc></subel>', el.xml_text)
 
-    dom = REXML::Document.new
+    dom = Nokogiri::XML::Document.new
     el.create_xml(dom)
     
     assert_equal 1, dom.elements.size
-    eldom = dom.elements['subel']
+    eldom = dom.search('subel')
     assert_not_nil eldom
-    assert_equal 1, eldom.elements.size
+    assert_equal 1, eldom.size
     
-    seldom = eldom.elements['abc']
+    seldom = eldom.search('abc')
     assert_not_nil seldom
     assert_equal value, seldom.text
     
@@ -37,20 +37,22 @@ class TestXMLElement < Test::Unit::TestCase
     el = TestElement.new
     
     el.someattr = value
+    el.anotherattr = value
     assert_equal(value, el.someattr) 
     
-    assert_equal("<subel someattr='"+value+"'></subel>", el.xml_text)
+    assert_equal("<subel someattr='#{value}' anotherattr='#{value}'></subel>", el.xml_text)
     
-    dom = REXML::Document.new
+    dom = Nokogiri::XML::Document.new
     el.create_xml(dom)
     
     assert_equal 1, dom.elements.size
-    eldom = dom.elements['subel']
+    eldom = dom.search('subel')
     assert_not_nil eldom
-    assert_equal value, eldom.attributes['someattr']
+    assert_equal value, eldom[0].get_attribute('someattr')
     
     el = TestElement.import_xml(dom)
     assert_equal value, el.someattr
+    assert_equal value, el.anotherattr
   end
   
   def test_xmlsubelements
@@ -64,15 +66,15 @@ class TestXMLElement < Test::Unit::TestCase
     
     assert_equal('<subels><abc>'+value+'</abc></subels>', el.xml_text)
     
-    dom = REXML::Document.new
+    dom = Nokogiri::XML::Document.new
     el.create_xml(dom)
     
     assert_equal 1, dom.elements.size
-    eldom = dom.elements['subels']
+    eldom = dom.search('subels')
     assert_not_nil eldom
-    assert_equal 1, eldom.elements.size
+    assert_equal 1, eldom.size
     
-    seldom = eldom.elements['abc']
+    seldom = eldom.search('abc')
     assert_not_nil seldom
     assert_equal value, seldom.text
     
@@ -141,16 +143,16 @@ class TestXMLElement < Test::Unit::TestCase
     
     assert_equal('<mult><abc>'+value1+'</abc><abc>'+value2+'</abc></mult>', el.xml_text)
     
-    dom = REXML::Document.new
+    dom = Nokogiri::XML::Document.new
     el.create_xml(dom)
     
     assert_equal 1, dom.elements.size
-    eldom = dom.elements['mult']
+    eldom = dom.search('abc')
     assert_not_nil eldom
-    assert_equal 2, eldom.elements.size
+    assert_equal 2, eldom.size
     
     [value1, value2].each_with_index do |value, index|
-      seldom = eldom.elements[index+1]
+      seldom = eldom[index]
       assert_not_nil seldom
       assert_equal value, seldom.text
       assert_equal 'abc', seldom.name
@@ -240,7 +242,7 @@ class TestXMLElement < Test::Unit::TestCase
     assert_equal SimpleElement, BaseFormat.get_element_class('abc')
     assert_equal SimpleElement, BaseFormat.get_element_class(:abc)
     assert_raise ElementClassNotFound do 
-      BaseFormat.get_element_class(:nosuchclass)
+      StrictBaseFormat.get_element_class(:nosuchclass)
     end
   end
   

data/test/multi_format_test.rb

@@ -41,7 +41,7 @@ class TestMultiFormat < Test::Unit::TestCase
   def test_import_first
     value = 'somevalue'
     text = '<root><child value="'+value+'"></child></root>'
-    root = FirstFormat.import_xml_text(text)
+    root = FirstFormat.import_xml(text)
     assert_kind_of(FirstRoot, root)
     assert_kind_of(FirstChild, root.child)
     assert_equal value, root.child.value
@@ -50,7 +50,7 @@ class TestMultiFormat < Test::Unit::TestCase
   def test_import_second
     value = 'somevalue'
     text = '<root><child>'+value+'</child></root>'
-    root = SecondFormat.import_xml_text(text)
+    root = SecondFormat.import_xml(text)
     assert_kind_of(SecondRoot, root)
     assert_kind_of(SecondChild, root.child)
     assert_equal value, root.child.value
@@ -59,7 +59,7 @@ class TestMultiFormat < Test::Unit::TestCase
   def test_double_inheritance
     value = 'somevalue'
     text = '<root><child2 value2="'+value+'">'+value+'</child2></root>'
-    root = SecondFormat.import_xml_text(text)
+    root = SecondFormat.import_xml(text)
     assert_kind_of(SecondRoot, root)
     assert_kind_of(SecondChild2, root.child2)
     assert_equal value, root.child2.value

data/test/partial_import_test.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require 'nokogiri'
+
+class PartialBaseFormat < XMLElement
+  xmlformat 'Base Format'
+end
+
+class PartialSimpleElement < PartialBaseFormat
+  elwithvalue
+  elname 'abc'
+  xmlattr :myattr
+end
+
+class TestPartialImport < Test::Unit::TestCase
+  def test_partial_elements_in_text
+    sel = PartialBaseFormat.import_xml "<abc><otherel></otherel>text</abc>"
+    assert_equal "text", sel.value
+  end
+
+  def test_partial_elements_in_dom
+    xml_text = "<abc><otherel></otherel>text</abc>"
+    sel = PartialBaseFormat.import_xml Nokogiri::XML::Document.parse(xml_text)
+    assert_equal "text", sel.value
+  end
+
+  def test_partial_attributes_in_text
+    sel = PartialBaseFormat.import_xml "<abc myattr='real' someattr='xpto'>text</abc>"
+    assert_equal "text", sel.value
+    assert_equal "real", sel.myattr
+  end
+
+  def test_partial_attributes_in_dom
+    xml_text = "<abc myattr='real' someattr='xpto'>text</abc>"
+    sel = PartialBaseFormat.import_xml Nokogiri::XML::Document.parse(xml_text)
+    assert_equal "text", sel.value
+    assert_equal "real", sel.myattr
+  end
+end

data/test/simple_objects.rb

@@ -1,5 +1,10 @@
 include XMLCodec
 
+class StrictBaseFormat < XMLElement
+  xmlformat 'Base Format'
+  xml_strict_parsing
+end
+
 class BaseFormat < XMLElement
   xmlformat 'Base Format'
 end
@@ -36,6 +41,7 @@ class TestElement < BaseFormat
   xmlsubel :abc2
   xmlsubel :subel
   xmlattr :someattr
+  xmlattr 'anotherattr'
 end
 
 class SubelElement < BaseFormat

data/test/subelements_test.rb

@@ -24,10 +24,20 @@ class TestXMLTextElement < Test::Unit::TestCase
   end
   
   def test_create_xml
-    xmlel = REXML::Element.new 'abc'
+    xmlel = Nokogiri::XML::Element.new('abc',Nokogiri::XML::Document.new)
     value = 'Some Value'
     el = XMLTextElement.new value
     el.create_xml(xmlel)
     assert_equal '<abc>'+value+'</abc>', xmlel.to_s
   end
+  def test_create_xml_multiple
+    xmlel = Nokogiri::XML::Element.new('abc',Nokogiri::XML::Document.new)
+    value1 = 'Some Value'
+    el1 = XMLTextElement.new value1
+    value2 = 'Some Other Value'
+    el2 = XMLTextElement.new value2
+    el1.create_xml(xmlel)
+    el2.create_xml(xmlel)
+    assert_equal '<abc>'+value1+value2+'</abc>', xmlel.to_s
+  end
 end

data/test/test_helper.rb

@@ -1,3 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
 require 'test/unit'
 require 'tmpdir'
 require File.dirname(__FILE__) + '/../lib/xmlcodec'
@@ -22,6 +25,6 @@ class Test::Unit::TestCase
 	end
 
   def compare_xpath(value, path)
-		assert_equal(value.strip, XMLUtils::select_path(path, @temp_path).strip)
+		assert_equal(value.strip, XMLCodec::XMLUtils::select_path(path, @temp_path).strip)
 	end
 end

data/test/utils_test.rb

@@ -3,48 +3,15 @@ require 'tmpdir'
 
 class TestXMLUtils < Test::Unit::TestCase
   def test_create_open_tag
-    tag = XMLUtils::create_open_tag("name", {"arg1" => "val1", "arg2" => "val2"})
+    tag = XMLCodec::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')
-    assert_equal '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)
+    assert_equal '&lt; abc', XMLCodec::XMLUtils::escape_xml('< abc')
+    assert_equal '&gt; abc', XMLCodec::XMLUtils::escape_xml('> abc')
+    assert_equal '&amp; abc', XMLCodec::XMLUtils::escape_xml('& abc')
+    assert_equal 'abc', XMLCodec::XMLUtils::escape_xml('abc')
   end
   
   def test_count_elements
@@ -53,7 +20,7 @@ class TestXMLUtils < Test::Unit::TestCase
     f = File.open(filename, 'w')
     f << text
     f.close
-    assert_equal 2, XMLUtils::count_elements('//abc', filename)
+    assert_equal 2, XMLCodec::XMLUtils::count_elements('//abc', filename)
   end
   
   def test_element_exists
@@ -62,6 +29,6 @@ class TestXMLUtils < Test::Unit::TestCase
     f = File.open(filename, 'w')
     f << text
     f.close
-    assert XMLUtils::element_exists('//abc', filename)
+    assert XMLCodec::XMLUtils::element_exists('//abc', filename)
   end
 end

data/xmlcodec.gemspec

@@ -0,0 +1,57 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  s.platform = Gem::Platform::RUBY
+
+  s.name              = 'xmlcodec'
+  s.version           = '0.3.0'
+  s.date              = '2013-08-30'
+
+  s.summary     = "Generic Importer/Exporter of XML formats"
+  s.description = <<EOF
+A framework to write object to XML mappers in Ruby that can then function both in whole-document manipulation as well as constant memory unlimited size importing and exporting of XML.
+EOF
+
+  s.authors  = ["Pedro Côrte-Real"]
+  s.email    = 'pedro@pedrocr.net'
+  s.homepage = 'https://github.com/pedrocr/xmlcodec'
+
+  s.require_paths = %w[lib]
+
+  s.has_rdoc = true
+  s.rdoc_options = ['-S', '-w 2', '-N', '-c utf8']
+  s.extra_rdoc_files = %w[README.rdoc LICENSE]
+
+  s.executables = Dir.glob("bin/*").map{|f| f.gsub('bin/','')}
+
+  s.add_dependency('nokogiri')
+
+  # = MANIFEST =
+  s.files = %w[
+    LICENSE
+    README.rdoc
+    Rakefile
+    lib/XMLUtils.rb
+    lib/element.rb
+    lib/stream_object_parser.rb
+    lib/stream_parser.rb
+    lib/subelements.rb
+    lib/xmlcodec.rb
+    test/element_test.rb
+    test/multi_format_test.rb
+    test/partial_export_test.rb
+    test/partial_import_test.rb
+    test/simple_objects.rb
+    test/stream_object_parser_test.rb
+    test/stream_parser_test.rb
+    test/subelements_test.rb
+    test/test_helper.rb
+    test/utils_test.rb
+    xmlcodec.gemspec
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^test\/.*\.rb/ }
+end

metadata

@@ -1,88 +1,95 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: xmlcodec
-version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 3
-  version: 0.1.3
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease: 
 platform: ruby
-authors: 
-- "Pedro C\xC3\xB4rte-Real"
+authors:
+- Pedro Côrte-Real
 autorequire: 
 bindir: bin
 cert_chain: []
+date: 2013-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &79189020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *79189020
+description: ! 'A framework to write object to XML mappers in Ruby that can then function
+  both in whole-document manipulation as well as constant memory unlimited size importing
+  and exporting of XML.
 
-date: 2010-09-14 00:00:00 +01:00
-default_executable: 
-dependencies: []
-
-description: |
-  A library that eases the creation of XML importers and exporters for ruby.
-
+'
 email: pedro@pedrocr.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
-- test/partial_export_test.rb
-- test/subelements_test.rb
-- test/utils_test.rb
-- test/test_helper.rb
-- test/multi_format_test.rb
-- test/stream_parser_test.rb
-- test/element_test.rb
-- test/simple_objects.rb
-- test/stream_object_parser_test.rb
-- lib/element.rb
-- lib/subelements.rb
+- LICENSE
+files:
+- LICENSE
+- README.rdoc
+- Rakefile
 - lib/XMLUtils.rb
-- lib/xmlcodec.rb
+- lib/element.rb
 - lib/stream_object_parser.rb
 - lib/stream_parser.rb
-- README.rdoc
-- LICENSE
-- Rakefile
-has_rdoc: true
-homepage: http://github.com/pedrocr/xmlcodec
+- lib/subelements.rb
+- lib/xmlcodec.rb
+- test/element_test.rb
+- test/multi_format_test.rb
+- test/partial_export_test.rb
+- test/partial_import_test.rb
+- test/simple_objects.rb
+- test/stream_object_parser_test.rb
+- test/stream_parser_test.rb
+- test/subelements_test.rb
+- test/test_helper.rb
+- test/utils_test.rb
+- xmlcodec.gemspec
+homepage: https://github.com/pedrocr/xmlcodec
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - -S
 - -w 2
 - -N
-require_paths: 
+- -c utf8
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-requirements: 
-- none
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.11
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: Generic Importer/Exporter of XML formats
-test_files: []
-
+test_files:
+- test/element_test.rb
+- test/multi_format_test.rb
+- test/partial_export_test.rb
+- test/partial_import_test.rb
+- test/simple_objects.rb
+- test/stream_object_parser_test.rb
+- test/stream_parser_test.rb
+- test/subelements_test.rb
+- test/test_helper.rb
+- test/utils_test.rb