jordi-xml-object 0.9.6 → 0.9.7

data/README.rdoc

@@ -11,6 +11,13 @@ is using XML for its intended purpose, but cumbersome when one always sends
 the same XML structure, and always process all of it in the same way. This
 one aims to be a bit different.
 
+At the moment, I aim for compatibility with Ruby 1.8, 1.9, and JRuby 1.1.
+
+== Dependencies
+
+None outside of Ruby, though some optional gems add additional features. See
+below on "Adapters" and "Collection pluralization".
+
 == Installation instructions
 
   gem install xml-object
@@ -86,6 +93,19 @@ ambiguity.
 
 == Features & Problems
 
+=== Adapters
+
+XMLObject supports different adapters to do the actual XML parsing. It ships
+with +REXML+, +Hpricot+, +JREXML+, and +LibXML+ adapters. By default, the
++REXML+ adapter is used.
+
+To use a different adapter than the +REXML+ default:
+
+  require 'xml-object'                  # Require XMLObject first
+  require 'xml-object/adapters/hpricot' # (Under MRI or JRuby)
+  require 'xml-object/adapters/libxml'  # (Under MRI only)
+  require 'xml-object/adapters/jrexml'  # (Under Jruby only)
+
 === Collection auto-folding
 
 Similar to XmlSimple, XMLObject folds same named elements at the same level.
@@ -138,14 +158,6 @@ methods it doesn't contain to the collection below, so you get:
 Strings that look like booleans are "booleanized" if called by their question
 mark names (such as +enabled?+)
 
-=== Adapters
-
-XMLObject supports different adapters to do the actual XML parsing. It ships
-with +REXML+ and +Hpricot+ adapters. By default, the +REXML+ adapter is used.
-To use the +Hpricot+ adapter:
-
-  require 'xml-object/adapters/hpricot'
-
 === Recursive
 
 The design of the adapters assumes parsing of the objects recursively. Deep

data/TODO

@@ -1,2 +1 @@
 * Refactor so as to not do things recursively
-* Write LibXML2 adapter

data/WHATSNEW

@@ -1,4 +1,12 @@
-* 0.9.6 (2008-10-??):
+* 0.9.7 (2008-10-20):
+  - LibXML adapter added
+  - JREXML "adapter" added, as well as JREXML support during tests and
+    benchmark tasks, but only when running under JRuby
+  - Backwards incompatible change: Elements with no text and multiple CDATA
+    values no longer report their value as their first CDATA element. They
+    report all of their CDATA nodes joined together, a-la LibXML
+
+* 0.9.6 (2008-10-19):
   - Ruby 1.9 compatibility
   - XMLObject no longer requires ActiveSupport. Note that proper array
     pluralization still depends on ActiveSupport's Inflector, so if it's not
@@ -6,7 +14,7 @@
   - XMLObject no longer tries to load Hpricot by default (too cumbersome
     to test). Use "require 'xml-object/adapters/hpricot'" to enable the
     Hpricot adapter.
-  - Backwards compatible change. For the following XML:
+  - Backwards incompatible change. For the following XML:
 
       <foo>
         <bar>

data/lib/xml-object/adapters/hpricot.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'hpricot'
 
 module XMLObject::Adapters::Hpricot
@@ -18,30 +19,19 @@ module XMLObject::Adapters::Hpricot
 
   class Element < XMLObject::Adapters::Base::Element # :nodoc:
     def initialize(xml)
-      self.raw, self.name, self.attributes = xml, xml.name, xml.attributes
-      self.children = xml.children.select { |e| e.elem? }.map do |raw_xml|
-        self.class.new(raw_xml)
-      end
-
-      self.value = case
-        when (not text_value(xml).blank?)  then text_value(xml)
-        when (not cdata_value(xml).blank?) then cdata_value(xml)
-        else ''
-      end
-    end
+      @raw, @name, @attributes = xml, xml.name, xml.attributes
 
-    private ################################################################
+      @element_nodes = xml.children.select { |c| c.elem? }
 
-    def text_value(xml)
-      xml.children.select do |e|
-        (e.class == ::Hpricot::Text) && !e.to_s.blank?
-      end.join.to_s
-    end
+      @text_nodes = xml.children.select do |c|
+        c.text? && !c.is_a?(::Hpricot::CData)
+      end.map { |c| c.to_s }
+
+      @cdata_nodes = xml.children.select do |c|
+        c.is_a? ::Hpricot::CData
+      end.map { |c| c.to_s }
 
-    def cdata_value(xml)
-      xml.children.select do |e|
-        (e.class == ::Hpricot::CData) && !e.to_s.blank?
-      end.first.to_s
+      super
     end
   end
 end

data/lib/xml-object/adapters/jrexml.rb

@@ -0,0 +1,10 @@
+require 'jrexml'
+require File.join(File.dirname(__FILE__), 'rexml')
+
+module XMLObject::Adapters
+  JREXML = REXML
+end
+
+def XMLObject.adapter # :nodoc:
+  XMLObject::Adapters::JREXML
+end

data/lib/xml-object/adapters/libxml.rb

@@ -0,0 +1,38 @@
+require 'libxml'
+
+module XMLObject::Adapters::LibXML
+
+  # Can take a String of XML data, or anything that responds to
+  # either +read+ or +to_s+.
+  def self.new(duck)
+    case
+      when duck.is_a?(::LibXML::XML::Node) then Element.new(duck)
+      when duck.is_a?(::String)
+        then new(::LibXML::XML::Parser.string(duck).parse.root)
+      when duck.respond_to?(:read) then new(duck.read)
+      when duck.respond_to?(:to_s) then new(duck.to_s)
+      else raise "Don't know how to deal with '#{duck.class}' object"
+    end
+  end
+
+  private ##################################################################
+
+  class Element < XMLObject::Adapters::Base::Element # :nodoc:
+    def initialize(xml)
+      @raw, @name, @attributes = xml, xml.name, xml.attributes.to_h
+
+      @element_nodes = xml.children.select { |c| c.element? }
+
+      @text_nodes  = xml.children.select { |c| c.text? }.map { |c| c.to_s }
+      @cdata_nodes = xml.children.select { |c| c.cdata? }.map do |c|
+        c.to_s.chomp(']]>').sub('<![CDATA[', '')
+      end
+
+      super
+    end
+  end
+end
+
+def XMLObject.adapter # :nodoc:
+  XMLObject::Adapters::LibXML
+end

data/lib/xml-object/adapters/rexml.rb

@@ -18,14 +18,19 @@ module XMLObject::Adapters::REXML
 
   class Element < XMLObject::Adapters::Base::Element # :nodoc:
     def initialize(xml)
-      self.raw, self.name, self.attributes = xml, xml.name, xml.attributes
-      self.children = xml.elements.map { |raw_xml| self.class.new(raw_xml) }
-
-      self.value = case
-        when (not xml.text.blank?) then xml.text.to_s
-        when (xml.cdatas.any?)     then xml.cdatas.first.to_s
-        else ''
-      end
+      @raw, @name, @attributes = xml, xml.name, xml.attributes
+
+      @element_nodes = xml.elements
+
+      @text_nodes = xml.children.select do |child|
+        child.class == ::REXML::Text
+      end.collect { |child| child.to_s }
+
+      @cdata_nodes = xml.children.select do |child|
+        child.class == ::REXML::CData
+      end.collect { |child| child.to_s }
+
+      super
     end
   end
 end

data/lib/xml-object/adapters.rb

@@ -3,6 +3,27 @@ module XMLObject # :nodoc:
     module Base # :nodoc:
       class Element # :nodoc:
         attr_accessor :raw, :name, :value, :attributes, :children # :nodoc:
+
+        def initialize(*args)
+
+          @children = @element_nodes.map { |node| self.class.new(node) }
+
+          @value = case
+            when (not text_value.blank?)  then text_value
+            when (not cdata_value.blank?) then cdata_value
+            else ''
+          end
+        end
+
+        private ###########################################################
+
+        def text_value
+          @text_nodes.reject { |n| n.blank? }.join
+        end
+
+        def cdata_value
+          @cdata_nodes.join
+        end
       end
     end
   end

data/lib/xml-object.rb

@@ -1,12 +1,9 @@
 begin; require 'rubygems';      rescue Exception, StandardError; nil; end
 begin; require 'activesupport'; rescue Exception, StandardError; nil; end
 
-module XMLObject # :nodoc:
-  VERSION = '0.9.6'
-end
+$:.unshift File.join(File.dirname(__FILE__), 'xml-object')
 
 require 'core_ext'
-
 require 'adapters'
 require 'adapters/rexml'
 require 'array_notation'

data/xml-object.gemspec

@@ -2,8 +2,8 @@ Gem::Specification.new do |gem|
   gem.rubyforge_project = 'xml-object'
 
   gem.name     = 'xml-object'
-  gem.version  = '0.9.6'
-  gem.date     = '2008-10-19'
+  gem.version  = '0.9.7'
+  gem.date     = '2008-10-20'
   gem.author   = 'Jordi Bunster'
   gem.email    = 'jordi@bunster.org'
   gem.homepage = 'http://github.com/jordi/xml-object'
@@ -24,6 +24,8 @@ Gem::Specification.new do |gem|
     lib/xml-object
     lib/xml-object/adapters
     lib/xml-object/adapters/hpricot.rb
+    lib/xml-object/adapters/jrexml.rb
+    lib/xml-object/adapters/libxml.rb
     lib/xml-object/adapters/rexml.rb
     lib/xml-object/adapters.rb
     lib/xml-object/array_notation.rb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jordi-xml-object
 version: !ruby/object:Gem::Version 
-  version: 0.9.6
+  version: 0.9.7
 platform: ruby
 authors: 
 - Jordi Bunster
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-19 00:00:00 -07:00
+date: 2008-10-20 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -31,6 +31,8 @@ files:
 - lib/xml-object
 - lib/xml-object/adapters
 - lib/xml-object/adapters/hpricot.rb
+- lib/xml-object/adapters/jrexml.rb
+- lib/xml-object/adapters/libxml.rb
 - lib/xml-object/adapters/rexml.rb
 - lib/xml-object/adapters.rb
 - lib/xml-object/array_notation.rb