multi_xml 0.5.5 → 0.6.0

data/lib/multi_xml/parsers/nokogiri.rb

@@ -5,17 +5,20 @@ module MultiXml
   module Parsers
     module Nokogiri #:nodoc:
       include Libxml2Parser
-
       extend self
 
-      def parse_error() ::Nokogiri::XML::SyntaxError end
+      def parse_error
+        ::Nokogiri::XML::SyntaxError
+      end
 
       def parse(xml)
         doc = ::Nokogiri::XML(xml)
-        raise doc.errors.first if doc.errors.length > 0
+        raise(doc.errors.first) unless doc.errors.empty?
         node_to_hash(doc.root)
       end
 
+    private
+
       def each_child(node, &block)
         node.children.each(&block)
       end

data/lib/multi_xml/parsers/oga.rb

@@ -0,0 +1,73 @@
+require 'oga' unless defined?(Oga)
+require 'multi_xml/parsers/libxml2_parser'
+
+module MultiXml
+  module Parsers
+    module Oga #:nodoc:
+      include Libxml2Parser
+      extend self
+
+      def parse_error
+        LL::ParserError
+      end
+
+      def parse(io)
+        document = ::Oga.parse_xml(io)
+        node_to_hash(document.children[0])
+      end
+
+      def node_to_hash(node, hash = {}) # rubocop:disable AbcSize, CyclomaticComplexity, MethodLength, PerceivedComplexity
+        node_hash = {MultiXml::CONTENT_ROOT => ''}
+
+        name = node_name(node)
+
+        # Insert node hash into parent hash correctly.
+        case hash[name]
+        when Array
+          hash[name] << node_hash
+        when Hash
+          hash[name] = [hash[name], node_hash]
+        when NilClass
+          hash[name] = node_hash
+        end
+
+        # Handle child elements
+        each_child(node) do |c|
+          if c.is_a?(::Oga::XML::Element)
+            node_to_hash(c, node_hash)
+          elsif c.is_a?(::Oga::XML::Text) || c.is_a?(::Oga::XML::Cdata)
+            node_hash[MultiXml::CONTENT_ROOT] << c.text
+          end
+        end
+
+        # Remove content node if it is empty
+        if node_hash[MultiXml::CONTENT_ROOT].strip.empty?
+          node_hash.delete(MultiXml::CONTENT_ROOT)
+        end
+
+        # Handle attributes
+        each_attr(node) do |a|
+          key = node_name(a)
+          v = node_hash[key]
+          node_hash[key] = (v ? [a.value, v] : a.value)
+        end
+
+        hash
+      end
+
+    private
+
+      def each_child(node, &block)
+        node.children.each(&block)
+      end
+
+      def each_attr(node, &block)
+        node.attributes.each(&block)
+      end
+
+      def node_name(node)
+        node.name
+      end
+    end # Oga
+  end # Parsers
+end # MultiXml

data/lib/multi_xml/parsers/ox.rb

@@ -21,7 +21,6 @@ require 'ox' unless defined?(Ox)
 module MultiXml
   module Parsers
     module Ox #:nodoc:
-
       extend self
 
       def parse_error
@@ -37,7 +36,7 @@ module MultiXml
       class Handler
         attr_accessor :stack
 
-        def initialize()
+        def initialize
           @stack = []
         end
 
@@ -46,9 +45,7 @@ module MultiXml
         end
 
         def attr(name, value)
-          unless @stack.empty?
-            append(name, value)
-          end
+          append(name, value) unless @stack.empty?
         end
 
         def text(value)
@@ -60,26 +57,24 @@ module MultiXml
         end
 
         def start_element(name)
-          if @stack.empty?
-            @stack.push(Hash.new)
-          end
-          h = Hash.new
+          @stack.push({}) if @stack.empty?
+          h = {}
           append(name, h)
           @stack.push(h)
         end
 
-        def end_element(name)
-          @stack.pop()
+        def end_element(_)
+          @stack.pop
         end
 
         def error(message, line, column)
-          raise Exception.new("#{message} at #{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)
+          if h.key?(key)
             v = h[key]
             if v.is_a?(Array)
               v << value
@@ -90,7 +85,6 @@ module MultiXml
             h[key] = value
           end
         end
-
       end # Handler
     end # Ox
   end # Parsers

data/lib/multi_xml/parsers/rexml.rb

@@ -4,7 +4,10 @@ module MultiXml
   module Parsers
     module Rexml #:nodoc:
       extend self
-      def parse_error; ::REXML::ParseException; end
+
+      def parse_error
+        ::REXML::ParseException
+      end
 
       # Parse an XML Document IO into a simple hash using REXML
       #
@@ -12,14 +15,11 @@ module MultiXml
       #   XML Document IO to parse
       def parse(xml)
         doc = REXML::Document.new(xml)
-        if doc.root
-          merge_element!({}, doc.root)
-        else
-          raise REXML::ParseException, "The document #{doc.to_s.inspect} does not have a valid root"
-        end
+        raise(REXML::ParseException.new("The document #{doc.to_s.inspect} does not have a valid root")) unless doc.root
+        merge_element!({}, doc.root)
       end
 
-      private
+    private
 
       # Convert an XML element and merge into the hash
       #
@@ -39,7 +39,7 @@ module MultiXml
         hash = get_attributes(element)
 
         if element.has_elements?
-          element.each_element {|child| merge_element!(hash, child) }
+          element.each_element { |child| merge_element!(hash, child) }
           merge_texts!(hash, element) unless empty_content?(element)
           hash
         else
@@ -54,13 +54,13 @@ module MultiXml
       # element::
       #   XML element whose texts are to me merged into the hash
       def merge_texts!(hash, element)
-        unless element.has_text?
-          hash
-        else
+        if element.has_text?
           # must use value to prevent double-escaping
           texts = ''
           element.texts.each { |t| texts << t.value }
           merge!(hash, MultiXml::CONTENT_ROOT, texts)
+        else
+          hash
         end
       end
 
@@ -76,7 +76,7 @@ module MultiXml
       # value::
       #   Value to be associated with key.
       def merge!(hash, key, value)
-        if hash.has_key?(key)
+        if hash.key?(key)
           if hash[key].instance_of?(Array)
             hash[key] << value
           else
@@ -97,7 +97,7 @@ module MultiXml
       #   XML element to extract attributes from.
       def get_attributes(element)
         attributes = {}
-        element.attributes.each { |n,v| attributes[n] = v }
+        element.attributes.each { |n, v| attributes[n] = v }
         attributes
       end
 

data/lib/multi_xml/version.rb

@@ -1,3 +1,45 @@
 module MultiXml
-  VERSION = "0.5.5" unless defined?(MultiXML::VERSION)
+  module Version
+  module_function
+
+    # @return [Integer]
+    def major
+      0
+    end
+
+    # @return [Integer]
+    def minor
+      6
+    end
+
+    # @return [Integer]
+    def patch
+      0
+    end
+
+    # @return [Integer, NilClass]
+    def pre
+      nil
+    end
+
+    # @return [Hash]
+    def to_h
+      {
+        :major => major,
+        :minor => minor,
+        :patch => patch,
+        :pre => pre,
+      }
+    end
+
+    # @return [Array]
+    def to_a
+      [major, minor, patch, pre].compact
+    end
+
+    # @return [String]
+    def to_s
+      to_a.join('.')
+    end
+  end
 end

data/multi_xml.gemspec

@@ -5,20 +5,15 @@ require 'multi_xml/version'
 
 Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.0'
-  spec.author = "Erik Michaels-Ober"
-  spec.cert_chain = ['certs/sferik.pem']
-  spec.description = %q{Provides swappable XML backends utilizing LibXML, Nokogiri, Ox, or REXML.}
+  spec.author = 'Erik Michaels-Ober'
+  spec.description = 'Provides swappable XML backends utilizing LibXML, Nokogiri, Ox, or REXML.'
   spec.email = 'sferik@gmail.com'
-  spec.files = %w(.yardopts CHANGELOG.md CONTRIBUTING.md LICENSE.md README.md Rakefile multi_xml.gemspec)
-  spec.files += Dir.glob("lib/**/*.rb")
-  spec.files += Dir.glob("spec/**/*")
+  spec.files = %w(.yardopts CHANGELOG.md CONTRIBUTING.md LICENSE.md README.md multi_xml.gemspec) + Dir['lib/**/*.rb']
   spec.homepage = 'https://github.com/sferik/multi_xml'
   spec.licenses = ['MIT']
   spec.name = 'multi_xml'
   spec.require_paths = ['lib']
   spec.required_rubygems_version = '>= 1.3.5'
-  spec.signing_key = File.expand_path("~/.gem/private_key.pem") if $0 =~ /gem\z/
-  spec.summary = %q{A generic swappable back-end for XML parsing}
-  spec.test_files = Dir.glob("spec/**/*")
-  spec.version = MultiXml::VERSION
+  spec.summary = 'A generic swappable back-end for XML parsing'
+  spec.version = MultiXml::Version
 end

metadata

@@ -1,57 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: multi_xml
 version: !ruby/object:Gem::Version
-  version: 0.5.5
-  prerelease: 
+  version: 0.6.0
 platform: ruby
 authors:
 - Erik Michaels-Ober
 autorequire: 
 bindir: bin
-cert_chain:
-- !binary |-
-  LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURMakNDQWhhZ0F3SUJB
-  Z0lCQURBTkJna3Foa2lHOXcwQkFRVUZBREE5TVE4d0RRWURWUVFEREFaelpt
-  VnkKYVdzeEZUQVRCZ29Ka2lhSmsvSXNaQUVaRmdWbmJXRnBiREVUTUJFR0Nn
-  bVNKb21UOGl4a0FSa1dBMk52YlRBZQpGdzB4TXpBeU1ETXhNREF5TWpkYUZ3
-  MHhOREF5TURNeE1EQXlNamRhTUQweER6QU5CZ05WQkFNTUJuTm1aWEpwCmF6
-  RVZNQk1HQ2dtU0pvbVQ4aXhrQVJrV0JXZHRZV2xzTVJNd0VRWUtDWkltaVpQ
-  eUxHUUJHUllEWTI5dE1JSUIKSWpBTkJna3Foa2lHOXcwQkFRRUZBQU9DQVE4
-  QU1JSUJDZ0tDQVFFQWwweDVkeDh1S3hpN1Rrckl1eUJVVEpWQgp2MW85M25V
-  QjlqL3k0TTk2Z1Yycll3QWNpMUpQQnNlTmQ2RnliempvM1lHdUhsN0VRSHVT
-  SE5hZjFwMmx4ZXcvCnk2MEpYSUpCQmdQY0RLL0tDUDROVUhvZm0wamZvWUQr
-  SDV1TkpmSENOcTcvWnNUeE90RTNSYTkyczBCQ01UcG0Kd0JNTWxXUjVNdGRF
-  aElZdUJPNFhobmVqWWdIMEwvN0JMMmx5bW50Vm5zci9hZ2RRb29qUUNOMUlR
-  bXNSSnZyUgpkdVpSTzN0WnZvSW8xcEJjNEpFZWhEdXFDZXlCZ1BMT3FNb0t0
-  UWxvbGQxVFFzMWtXVUJLN0tXTUZFaEtDL0tnCnp5ektSSFFvOXlEWXdPdllu
-  Z29CTFkrVC9sd0NUNGR5c3NkaHpSYmZueEFoYUt1NFNBc3NJd2FDMDF5Vm93
-  SUQKQVFBQm96a3dOekFKQmdOVkhSTUVBakFBTUIwR0ExVWREZ1FXQkJTMHJ1
-  RGZSYWs1Y2kxT3BETlgvWmRERWtJcwppVEFMQmdOVkhROEVCQU1DQkxBd0RR
-  WUpLb1pJaHZjTkFRRUZCUUFEZ2dFQkFISFNNcy9NUDBzT2FMa0V2NEpvCnp2
-  a20zcW41QTZ0MHZhSHg3NzRjbWVqeU1VKzV3eVN4UmV6c3BMN1VMaDlOZXVL
-  Mk9oVStPZTNUcHFyQWc1VEsKUjhHUUlMblZ1MkZlbUdBNnNBa1BEbGNQdGdB
-  NmllSTE5UFpPRjZIVkxtYy9JRC9kUC9OZ1pXV3pFZXFRS21jSwoyK0hNK1NF
-  RURoWmtTY1lla3c0Wk9lMTY0WnRaRzgxNm9BdjV4MHBHaXRTSWt1bVVwN1Y4
-  aUVaLzZlaHI3WTllClhPZzRlZXVuNUwvSmptakFSb1cya05kdmtSRDNjMkVl
-  U0xxV3ZRUnNCbHlwSGZoczZKSnVMbHlaUEdoVTNSL3YKU2YzbFZLcEJDV2dS
-  cEdUdnk0NVhWcEIrNTl5MzNQSm1FdVExUFRFT1l2UXlhbzlVS01BQWFBTi83
-  cVdRdGpsMApobHc9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
-date: 2013-08-06 00:00:00.000000000 Z
+cert_chain: []
+date: 2016-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Provides swappable XML backends utilizing LibXML, Nokogiri, Ox, or REXML.
@@ -60,52 +30,42 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .yardopts
+- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - LICENSE.md
 - README.md
-- Rakefile
-- multi_xml.gemspec
+- lib/multi_xml.rb
 - lib/multi_xml/parsers/libxml.rb
 - lib/multi_xml/parsers/libxml2_parser.rb
 - lib/multi_xml/parsers/nokogiri.rb
+- lib/multi_xml/parsers/oga.rb
 - lib/multi_xml/parsers/ox.rb
 - lib/multi_xml/parsers/rexml.rb
 - lib/multi_xml/version.rb
-- lib/multi_xml.rb
-- spec/helper.rb
-- spec/multi_xml_spec.rb
-- spec/parser_shared_example.rb
-- spec/speed.rb
+- multi_xml.gemspec
 homepage: https://github.com/sferik/multi_xml
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.5.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A generic swappable back-end for XML parsing
-test_files:
-- spec/helper.rb
-- spec/multi_xml_spec.rb
-- spec/parser_shared_example.rb
-- spec/speed.rb
-has_rdoc: 
+test_files: []

data/Rakefile

@@ -1,21 +0,0 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
-
-task :test => :spec
-task :default => :spec
-
-namespace :doc do
-  require 'yard'
-  YARD::Rake::YardocTask.new do |task|
-    task.files   = ['lib/**/*.rb', '-', 'LICENSE.md']
-    task.options = [
-      '--no-private',
-      '--protected',
-      '--output-dir', 'doc/yard',
-      '--markup', 'markdown',
-    ]
-  end
-end