multi_xml 0.5.5 → 0.7.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7bebe7a08139024835279d7ffc78a7d86d0cb9a5ff59787068e044f7c75dc6f9
+  data.tar.gz: a2f579d2e18a266fe9573174de87ac960fcf867081705a2a6feb458bfa573225
+SHA512:
+  metadata.gz: be4ffea0dd836f1d1d1baf73ffded7de5a79fdc53a5b039b5e7fd0a615a786ca08dc0a7bbf5561266cdade44a9cb3c2382fe6e35a54599876f77ec74ec937d42
+  data.tar.gz: d579ab46f0122a1011704e397062b5d9e648eeaae85a8baa30ac8eda7f3d1cdaa9e57fe1922e6e3e7ac608ef9607033c1547773dbb2eb1fe6785176a3471764d

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,54 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+  - standard
+  - standard-performance
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+  IndentationWidth: 2
+
+Layout/CaseIndentation:
+  EnforcedStyle: end
+
+Layout/EndAlignment:
+  EnforcedStyleAlignWith: start_of_line
+
+Layout/LineLength:
+  Max: 140
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+  IndentationWidth: 2
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: never
+
+Style/OpenStructUse:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TernaryParentheses:
+  EnforcedStyle: require_parentheses

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+0.7.0
+-----
+* [Add support for Ruby 3.3](https://github.com/sferik/multi_xml/pull/67)
+* [Drop support for Ruby 3.0](https://github.com/sferik/multi_xml/commit/eec72c56307fede3a93f1a61553587cb278b0c8a) [and](https://github.com/sferik/multi_xml/commit/6a6dec80a36c30774a5525b45f71d346fb561e69) [earlier](https://github.com/sferik/multi_xml/commit/e7dad37a0a0be8383a26ffe515c575b5b4d04588)
+* [Don't mutate strings](https://github.com/sferik/multi_xml/commit/71be3fff4afb0277a7e1c47c5f1f4b6106a8eb45)
+
+0.6.0
+-----
+* [Duplexed Streams](https://github.com/sferik/multi_xml/pull/45)
+* [Support for Oga](https://github.com/sferik/multi_xml/pull/47)
+* [Integer unification for Ruby 2.4](https://github.com/sferik/multi_xml/pull/54)
+
 0.5.5
 -----
 * [Fix symbolize_keys function](https://github.com/sferik/multi_xml/commit/a4cae3aeb690999287cd30206399abaa5ce1ae81)

data/CONTRIBUTING.md

@@ -16,8 +16,10 @@ Here are some ways *you* can contribute:
 * by refactoring code
 * by resolving [issues][]
 * by reviewing patches
+* [financially][gittip]
 
 [issues]: https://github.com/sferik/multi_xml/issues
+[gittip]: https://www.gittip.com/sferik/
 
 ## Submitting an Issue
 We use the [GitHub issue tracker][issues] to track bugs and features. Before
@@ -35,12 +37,12 @@ Ideally, a bug report should include a pull request with failing specs.
 3. Add specs for your unimplemented feature or bug fix.
 4. Run `bundle exec rake spec`. If your specs pass, return to step 3.
 5. Implement your feature or bug fix.
-6. Run `bundle exec rake spec`. If your specs fail, return to step 5.
+6. Run `bundle exec rake`. If your specs fail, return to step 5.
 7. Run `open coverage/index.html`. If your changes are not completely covered
    by your tests, return to step 3.
 8. Add documentation for your feature or bug fix.
-9. Run `bundle exec rake doc:yard`. If your changes are not 100% documented, go
-   back to step 8.
+9. Run `bundle exec rake verify_measurements`. If your changes are not 100%
+   documented, go back to step 8.
 10. Add, commit, and push your changes.
 11. [Submit a pull request.][pr]
 

data/Gemfile

@@ -0,0 +1,21 @@
+source "https://rubygems.org"
+
+gem "libxml-ruby", require: nil, platforms: :ruby
+gem "nokogiri", require: nil
+gem "oga", ">= 2.3", require: nil
+gem "ox", require: nil, platforms: :ruby
+gem "rexml", require: nil
+
+gem "rake", ">= 13.2.1"
+gem "rspec", ">= 3.12"
+gem "rubocop", ">= 1.62.1"
+gem "rubocop-performance", ">= 1.20.2"
+gem "rubocop-rake", ">= 0.6"
+gem "rubocop-rspec", ">= 2.24"
+gem "simplecov", ">= 0.22"
+gem "standard", ">= 1.35.1"
+gem "standard-performance", ">= 1.3.1"
+gem "yard", ">= 0.9.36"
+gem "yardstick", ">= 0.9.9"
+
+gemspec

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2013 Erik Michaels-Ober
+Copyright (c) 2010-2024 Erik Berlin
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,42 +1,16 @@
 # MultiXML
 
-[![Gem Version](https://badge.fury.io/rb/multi_xml.png)][gem]
-[![Build Status](https://secure.travis-ci.org/sferik/multi_xml.png?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/sferik/multi_xml.png?travis)][gemnasium]
-[![Code Climate](https://codeclimate.com/github/sferik/multi_xml.png)][codeclimate]
-[![Coverage Status](https://coveralls.io/repos/sferik/multi_xml/badge.png?branch=master)][coveralls]
-
-[gem]: https://rubygems.org/gems/multi_xml
-[travis]: http://travis-ci.org/sferik/multi_xml
-[gemnasium]: https://gemnasium.com/sferik/multi_xml
-[codeclimate]: https://codeclimate.com/github/sferik/multi_xml
-[coveralls]: https://coveralls.io/r/sferik/multi_xml
-
 A generic swappable back-end for XML parsing
 
 ## Installation
     gem install multi_xml
 
-To ensure the code you're installing hasn't been tampered with, it's
-recommended that you verify the signature. To do this, you need to add my
-public key as a trusted certificate (you only need to do this once):
-
-    gem cert --add <(curl -Ls https://raw.github.com/sferik/multi_xml/master/certs/sferik.pem)
-
-Then, install the gem with the high security trust policy:
-
-    gem install multi_xml -P HighSecurity
-
 ## Documentation
 [http://rdoc.info/gems/multi_xml][documentation]
 
 [documentation]: http://rdoc.info/gems/multi_xml
 
 ## Usage Examples
-Lots of Ruby libraries utilize XML parsing in some form, and everyone has their
-favorite XML library. In order to best support multiple XML parsers and
-libraries, `multi_xml` is a general-purpose swappable XML backend library. You
-use it like so:
 ```ruby
 require 'multi_xml'
 
@@ -55,25 +29,28 @@ MultiXml.parse('<tag>This is the contents</tag>') # Parsed using Nokogiri
 MultiXml.parser = :rexml
 MultiXml.parser = MultiXml::Parsers::Rexml # Same as above
 MultiXml.parse('<tag>This is the contents</tag>') # Parsed using REXML
+
+MultiXml.parser = :oga
+MultiXml.parser = MultiXml::Parsers::Oga # Same as above
+MultiXml.parse('<tag>This is the contents</tag>') # Parsed using Oga
 ```
 The `parser` setter takes either a symbol or a class (to allow for custom XML
 parsers) that responds to `.parse` 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 Ox, then LibXML,
+supported parsers already loaded, it will use them before attempting to load
+a new one. When loading, libraries are ordered by speed: first Ox, then LibXML,
 then Nokogiri, and finally REXML.
 
 ## Supported Ruby Versions
-This library aims to support and is [tested against][travis] the following Ruby
+This library aims to support and is tested against the following Ruby
 implementations:
 
-* Ruby 1.8.7
-* Ruby 1.9.2
-* Ruby 1.9.3
-* Ruby 2.0.0
+* 3.1
+* 3.2
+* 3.3
 
-If something doesn't work on one of these interpreters, it's a bug.
+If something doesn't work on one of these versions, it's a bug.
 
 This library may inadvertently work (or seem to work) on other Ruby
 implementations, however support will only be provided for the versions listed
@@ -92,6 +69,6 @@ MultiXML was inspired by [MultiJSON][].
 [multijson]: https://github.com/intridea/multi_json/
 
 ## Copyright
-Copyright (c) 2010-2013 Erik Michaels-Ober. See [LICENSE][] for details.
+Copyright (c) 2010-2024 Erik Berlin. See [LICENSE][] for details.
 
 [license]: LICENSE.md

data/Rakefile

@@ -1,21 +1,33 @@
-require 'bundler'
+require "bundler"
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)
 
-task :test => :spec
-task :default => :spec
+task test: :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
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+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
+
+require "yardstick/rake/measurement"
+Yardstick::Rake::Measurement.new do |measurement|
+  measurement.output = "measurement/report.txt"
 end
+
+require "yardstick/rake/verify"
+Yardstick::Rake::Verify.new do |verify|
+  verify.threshold = 48.8
+end
+
+task default: %i[spec rubocop verify_measurements]

data/lib/multi_xml/parsers/libxml.rb

@@ -1,25 +1,28 @@
-require 'libxml' unless defined?(LibXML)
-require 'multi_xml/parsers/libxml2_parser'
+require "libxml" unless defined?(LibXML)
+require "multi_xml/parsers/libxml2_parser"
 
 module MultiXml
   module Parsers
-    module Libxml #:nodoc:
+    module Libxml # :nodoc:
       include Libxml2Parser
-
       extend self
 
-      def parse_error() ::LibXML::XML::Error end
+      def parse_error
+        ::LibXML::XML::Error
+      end
 
       def parse(xml)
         node_to_hash(LibXML::XML::Parser.io(xml).parse.root)
       end
 
-      def each_child(node, &block)
-        node.each_child(&block)
+      private
+
+      def each_child(node, &)
+        node.each_child(&)
       end
 
-      def each_attr(node, &block)
-        node.each_attr(&block)
+      def each_attr(node, &)
+        node.each_attr(&)
       end
 
       def node_name(node)

data/lib/multi_xml/parsers/libxml2_parser.rb

@@ -1,6 +1,6 @@
 module MultiXml
   module Parsers
-    module Libxml2Parser #:nodoc:
+    module Libxml2Parser # :nodoc:
       # Convert XML document to hash
       #
       # node::
@@ -8,16 +8,19 @@ module MultiXml
       #
       # hash::
       #   Hash to merge the converted element into.
-      def node_to_hash(node, hash={})
-        node_hash = {MultiXml::CONTENT_ROOT => ''}
+      def node_to_hash(node, hash = {}) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        node_hash = {MultiXml::CONTENT_ROOT => ""}
 
         name = node_name(node)
 
         # Insert node hash into parent hash correctly.
         case hash[name]
-          when Array then hash[name] << node_hash
-          when Hash  then hash[name] = [hash[name], node_hash]
-          when nil   then hash[name] = node_hash
+        when Array
+          hash[name] << node_hash
+        when Hash
+          hash[name] = [hash[name], node_hash]
+        when NilClass
+          hash[name] = node_hash
         end
 
         # Handle child elements
@@ -25,24 +28,18 @@ module MultiXml
           if c.element?
             node_to_hash(c, node_hash)
           elsif c.text? || c.cdata?
-            node_hash[MultiXml::CONTENT_ROOT] << c.content
+            node_hash[MultiXml::CONTENT_ROOT] += c.content
           end
         end
 
         # Remove content node if it is empty
-        if node_hash[MultiXml::CONTENT_ROOT].strip.empty?
-          node_hash.delete(MultiXml::CONTENT_ROOT)
-        end
+        node_hash.delete(MultiXml::CONTENT_ROOT) if node_hash[MultiXml::CONTENT_ROOT].strip.empty?
 
         # Handle attributes
         each_attr(node) do |a|
           key = node_name(a)
-
-          node_hash[key] = if v = node_hash[key]
-                             [a.value, v]
-                           else
-                             a.value
-                           end
+          v = node_hash[key]
+          node_hash[key] = ((v) ? [a.value, v] : a.value)
         end
 
         hash
@@ -51,23 +48,22 @@ module MultiXml
       # Parse an XML Document IO into a simple hash.
       # xml::
       #   XML Document IO to parse
-      def parse(xml)
-        raise NotImplementedError, "inheritor should define #{__method__}"
+      def parse(_)
+        raise(NotImplementedError, "inheritor should define #{__method__}")
       end
 
-      # :stopdoc:
       private
 
-      def each_child(*args)
-        raise NotImplementedError, "inheritor should define #{__method__}"
+      def each_child(*)
+        raise(NotImplementedError, "inheritor should define #{__method__}")
       end
 
-      def each_attr(*args)
-        raise NotImplementedError, "inheritor should define #{__method__}"
+      def each_attr(*)
+        raise(NotImplementedError, "inheritor should define #{__method__}")
       end
 
-      def node_name(*args)
-        raise NotImplementedError, "inheritor should define #{__method__}"
+      def node_name(*)
+        raise(NotImplementedError, "inheritor should define #{__method__}")
       end
     end
   end

data/lib/multi_xml/parsers/nokogiri.rb

@@ -1,27 +1,31 @@
-require 'nokogiri' unless defined?(Nokogiri)
-require 'multi_xml/parsers/libxml2_parser'
+require "nokogiri" unless defined?(Nokogiri)
+require "multi_xml/parsers/libxml2_parser"
 
 module MultiXml
   module Parsers
-    module Nokogiri #:nodoc:
+    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
 
-      def each_child(node, &block)
-        node.children.each(&block)
+      private
+
+      def each_child(node, &)
+        node.children.each(&)
       end
 
-      def each_attr(node, &block)
-        node.attribute_nodes.each(&block)
+      def each_attr(node, &)
+        node.attribute_nodes.each(&)
       end
 
       def node_name(node)

data/lib/multi_xml/parsers/oga.rb

@@ -0,0 +1,71 @@
+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 Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        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
+        node_hash.delete(MultiXml::CONTENT_ROOT) if node_hash[MultiXml::CONTENT_ROOT].strip.empty?
+
+        # 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, &)
+        node.children.each(&)
+      end
+
+      def each_attr(node, &)
+        node.attributes.each(&)
+      end
+
+      def node_name(node)
+        node.name
+      end
+    end
+  end
+end

data/lib/multi_xml/parsers/ox.rb

@@ -1,4 +1,4 @@
-require 'ox' unless defined?(Ox)
+require "ox" unless defined?(Ox)
 
 # Each MultiXml parser is expected to parse an XML document into a Hash. The
 # conversion rules are:
@@ -20,9 +20,8 @@ require 'ox' unless defined?(Ox)
 
 module MultiXml
   module Parsers
-    module Ox #:nodoc:
-
-      extend self
+    module Ox # :nodoc:
+      module_function
 
       def parse_error
         Exception
@@ -30,14 +29,14 @@ module MultiXml
 
       def parse(io)
         handler = Handler.new
-        ::Ox.sax_parse(handler, io, :convert_special => true)
+        ::Ox.sax_parse(handler, io, convert_special: true, skip: :skip_return)
         handler.doc
       end
 
       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(StandardError, "#{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,8 +85,7 @@ module MultiXml
             h[key] = value
           end
         end
-
-      end # Handler
-    end # Ox
-  end # Parsers
-end # MultiXml
+      end
+    end
+  end
+end