multi_xml 0.4.0 → 0.4.1

data/.travis.yml

@@ -1,6 +1,5 @@
 rvm:
   - 1.8.7
-  - 1.9.1
   - 1.9.2
   - jruby
   - rbx

data/Gemfile

@@ -1,9 +1,9 @@
 source 'http://rubygems.org'
 
 group :development, :test do
-  gem 'libxml-ruby', "~> 2.0", :require => nil, :platforms => :mri
-  gem 'nokogiri', "~> 1.4", :require => nil
-  gem 'ox', ["~> 1.2", ">= 1.2.15"], :require => nil
+  gem 'libxml-ruby', '~> 2.0', :require => nil, :platforms => :mri
+  gem 'nokogiri', '~> 1.4', :require => nil
+  gem 'ox', '~> 1.3', :require => nil
 end
 
 gemspec

data/README.md

@@ -8,7 +8,7 @@ A generic swappable back-end for XML parsing
 [http://rdoc.info/gems/multi_xml](http://rdoc.info/gems/multi_xml)
 
 ## <a name="ci">Continuous Integration</a>
-[![Build Status](https://travis-ci.org/sferik/multi_xml.png)](http://travis-ci.org/sferik/multi_xml)
+[![Build Status](https://secure.travis-ci.org/sferik/multi_xml.png)](http://travis-ci.org/sferik/multi_xml)
 
 ## <a name="examples">Usage Examples</a>
 Lots of Ruby libraries utilize XML parsing in some form, and everyone has their
@@ -26,6 +26,10 @@ library. You use it like so:
     MultiXml.parser = MultiXml::Parsers::Nokogiri # Same as above
     MultiXml.parse('<tag>This is the contents</tag>') # Parsed using Nokogiri
 
+    MultiXml.parser = :ox
+    MultiXml.parser = MultiXml::Parsers::Ox # Same as above
+    MultiXml.parse('<tag>This is the contents</tag>') # Parsed using Ox
+
     MultiXml.parser = :rexml
     MultiXml.parser = MultiXml::Parsers::Rexml # Same as above
     MultiXml.parse('<tag>This is the contents</tag>') # Parsed using REXML
@@ -35,7 +39,7 @@ responds to <tt>.parse</tt> at the class level.
 
 MultiXML tries to have intelligent defaulting. That is, if you have any of the supported parsers
 already loaded, it will utilize them before attempting to load any. When loading, libraries are
-ordered by speed: first LibXML, then Nokogiri, then REXML.
+ordered by speed: first LibXML, then Nokogiri, then Ox, then REXML.
 
 ## <a name="contributing">Contributing</a>
 In the spirit of [free

data/lib/multi_xml.rb

@@ -56,6 +56,7 @@ module MultiXml
     def default_parser
       return :libxml if defined?(::LibXML)
       return :nokogiri if defined?(::Nokogiri)
+      return :ox if defined?(::Ox)
 
       REQUIREMENT_MAP.each do |(library, parser)|
         begin
@@ -95,20 +96,14 @@ module MultiXml
       xml ||= ''
 
       xml.strip! if xml.respond_to?(:strip!)
-
       begin
-        if parser.respond_to?(:string_parser?) and parser.string_parser?
-          raw_hash = parser.parse(xml)
-        else
-          xml = StringIO.new(xml) unless xml.respond_to?(:read)
+        xml = StringIO.new(xml) unless xml.respond_to?(:read)
 
-          char = xml.getc
-          return {} if char.nil?
-          xml.ungetc(char)
+        char = xml.getc
+        return {} if char.nil?
+        xml.ungetc(char)
 
-          raw_hash = parser.parse(xml)
-        end
-        hash = typecast_xml_value(undasherize_keys(raw_hash)) || {}
+        hash = typecast_xml_value(undasherize_keys(parser.parse(xml))) || {}
       rescue parser.parse_error => error
         raise ParseError, error.to_s, error.backtrace
       end

data/lib/multi_xml/parsers/ox.rb

@@ -1,5 +1,23 @@
 require 'ox' unless defined?(Ox)
 
+# Each MultiXml parser is expected to parse an XML document into a Hash. The
+# conversion rules are:
+#
+# - Each document starts out as an empty Hash.
+#
+# - Reading an element created an entry in the parent Hash that has a key of
+#   the element name and a value of a Hash with attributes as key value
+#   pairs. Children are added as described by this rule.
+#
+# - Text and CDATE is stored in the parent element Hash with a key of
+#   '__content__' and a value of the text itself.
+#
+# - If a key already exists in the Hash then the value associated with the key
+#   is converted to an Array with the old and new value in it.
+#
+# - Other elements such as the xml prolog, doctype, and comments are ignored.
+#
+
 module MultiXml
   module Parsers
     module Ox #:nodoc:
@@ -10,40 +28,70 @@ module MultiXml
         Exception
       end
 
-      def parse(xml)
-        doc = ::Ox.parse(xml)
-        h = { }
-        element_to_hash(doc, h) unless doc.nil?
-        h
+      def parse(io)
+        handler = Handler.new
+        ::Ox.sax_parse(handler, io, :convert_special => true)
+        handler.doc
       end
 
-      def element_to_hash(e, h)
-        content = { }
-        e.attributes.each do |k,v|
-          content[k.to_s] = v
-        end
-        e.nodes.each do |n|
-          if n.is_a?(::Ox::Element)
-            element_to_hash(n, content)
-          elsif n.is_a?(String)
-            content['__content__'] = n
-          elsif n.is_a?(::Ox::Node)
-            content['__content__'] = n.value
+      class Handler
+        attr_accessor :stack
+
+        def initialize()
+          @stack = []
+        end
+        
+        def doc
+          @stack[0]
+        end
+
+        def attr(name, value)
+          unless @stack.empty?
+            append(name, value)
           end
         end
-        if (ex = h[e.name]).nil?
-          h[e.name] = content
-        elsif ex.is_a?(Array)
-          ex << content
-        else
-          h[e.name] = [ex, content]
+
+        def text(value)
+          append('__content__', value)
+        end
+
+        def cdata(value)
+          append('__content__', value)
+        end
+
+        def start_element(name)
+          if @stack.empty?
+            @stack.push(Hash.new)
+          end
+          h = Hash.new
+          append(name, h)
+          @stack.push(h)
+        end
+
+        def end_element(name)
+          @stack.pop()
+        end
+
+        def error(message, line, column)
+          raise Exception.new("#{message} at #{line}:#{column}")
+        end
+
+        def append(key, value)
+          key = key.to_s
+          h = @stack.last
+          if h.has_key?(key)
+            v = h[key]
+            if v.is_a?(Array)
+              v << value
+            else
+              h[key] = [v, value]
+            end
+          else
+            h[key] = value
+          end
         end
-      end
-      
-      def string_parser?
-        true
-      end
 
-    end
-  end
-end
+      end # Handler
+    end # Ox
+  end # Parsers
+end # MultiXml

data/lib/multi_xml/version.rb

@@ -1,3 +1,3 @@
 module MultiXml
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/multi_xml.gemspec

@@ -2,14 +2,16 @@
 require File.expand_path('../lib/multi_xml/version', __FILE__)
 
 Gem::Specification.new do |gem|
+  gem.add_development_dependency 'libxml-ruby', '~> 2.0' unless RUBY_PLATFORM == 'java'
   gem.add_development_dependency 'nokogiri', '~> 1.4'
+  gem.add_development_dependency 'ox', '~> 1.3'
   gem.add_development_dependency 'rake', '~> 0.9'
   gem.add_development_dependency 'rdiscount', '~> 1.6'
   gem.add_development_dependency 'rspec', '~> 2.6'
   gem.add_development_dependency 'simplecov', '~> 0.4'
   gem.add_development_dependency 'yard', '~> 0.7'
   gem.author = "Erik Michaels-Ober"
-  gem.description = %q{A gem to provide swappable XML backends utilizing LibXML, Nokogiri, or REXML.}
+  gem.description = %q{A gem to provide swappable XML backends utilizing LibXML, Nokogiri, Ox, or REXML.}
   gem.email = 'sferik@gmail.com'
   gem.files = `git ls-files`.split("\n")
   gem.homepage = 'https://github.com/sferik/multi_xml'

data/spec/speed.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby -wW1
+
+$: << '.'
+$: << '../lib'
+
+if __FILE__ == $0
+  while (i = ARGV.index('-I'))
+    x,path = ARGV.slice!(i, 2)
+    $: << path
+  end
+end
+
+require 'optparse'
+require 'stringio'
+require 'multi_xml'
+
+begin
+  require 'libxml'
+rescue Exception => e
+end
+begin
+  require 'nokogiri'
+rescue Exception => e
+end
+begin
+  require 'ox'
+rescue Exception => e
+end
+
+$verbose = 0
+$parsers = []
+$iter = 10
+
+opts = OptionParser.new
+opts.on("-v", "increase verbosity")                            { $verbose += 1 }
+opts.on("-p", "--parser [String]", String, "parser to test")   { |p| $parsers = [p] }
+opts.on("-i", "--iterations [Int]", Integer, "iterations")     { |i| $iter = i }
+opts.on("-h", "--help", "Show this display")                   { puts opts; Process.exit!(0) }
+files = opts.parse(ARGV)
+
+if $parsers.empty?
+  $parsers << 'libxml' if defined?(::LibXML)
+  $parsers << 'nokogiri' if defined?(::Nokogiri)
+  $parsers << 'ox' if defined?(::Ox)
+end
+
+files.each do |filename|
+  times = { }
+  xml = File.read(filename)
+  $parsers.each do |p|
+    MultiXml.parser = p
+    start = Time.now
+    $iter.times do |i|
+      io = StringIO.new(xml)
+      MultiXml.parse(io)
+    end
+    dt = Time.now - start
+    times[p] = Time.now - start
+  end
+  times.each do |p,t|
+    puts "%8s took %0.3f seconds to parse %s %d times." % [p, t, filename, $iter]
+  end
+end

metadata

@@ -1,89 +1,151 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: multi_xml
-version: !ruby/object:Gem::Version
-  version: 0.4.0
+version: !ruby/object:Gem::Version 
+  hash: 13
   prerelease: 
+  segments: 
+  - 0
+  - 4
+  - 1
+  version: 0.4.1
 platform: ruby
-authors:
+authors: 
 - Erik Michaels-Ober
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-06 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-09-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: nokogiri
-  requirement: &70174632551180 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.4'
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 4
+        version: "1.4"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ox
   prerelease: false
-  version_requirements: *70174632551180
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70174632547160 !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.9'
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: *70174632547160
-- !ruby/object:Gem::Dependency
-  name: rdiscount
-  requirement: &70174632529880 !ruby/object:Gem::Requirement
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.6'
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rdiscount
   prerelease: false
-  version_requirements: *70174632529880
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70174632527760 !ruby/object:Gem::Requirement
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.6'
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
   type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  version_requirements: *70174632527760
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: &70174632526060 !ruby/object:Gem::Requirement
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.4'
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
   type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: simplecov
   prerelease: false
-  version_requirements: *70174632526060
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &70174632525380 !ruby/object:Gem::Requirement
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.7'
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
   type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: yard
   prerelease: false
-  version_requirements: *70174632525380
-description: A gem to provide swappable XML backends utilizing LibXML, Nokogiri, or
-  REXML.
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :development
+  version_requirements: *id008
+description: A gem to provide swappable XML backends utilizing LibXML, Nokogiri, Ox, or REXML.
 email: sferik@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gemtest
 - .gitignore
 - .rspec
@@ -104,31 +166,42 @@ files:
 - spec/helper.rb
 - spec/multi_xml_spec.rb
 - spec/parser_shared_example.rb
+- spec/speed.rb
 homepage: https://github.com/sferik/multi_xml
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A generic swappable back-end for XML parsing
-test_files:
+test_files: 
 - spec/helper.rb
 - spec/multi_xml_spec.rb
 - spec/parser_shared_example.rb
+- spec/speed.rb