activesupport 4.2.0 → 5.2.0

data/lib/active_support/xml_mini/jdom.rb

@@ -1,9 +1,11 @@
-raise "JRuby is required to use the JDOM backend for XmlMini" unless RUBY_PLATFORM =~ /java/
+# frozen_string_literal: true
 
-require 'jruby'
+raise "JRuby is required to use the JDOM backend for XmlMini" unless RUBY_PLATFORM.include?("java")
+
+require "jruby"
 include Java
 
-require 'active_support/core_ext/object/blank'
+require "active_support/core_ext/object/blank"
 
 java_import javax.xml.parsers.DocumentBuilder unless defined? DocumentBuilder
 java_import javax.xml.parsers.DocumentBuilderFactory unless defined? DocumentBuilderFactory
@@ -16,7 +18,7 @@ module ActiveSupport
   module XmlMini_JDOM #:nodoc:
     extend self
 
-    CONTENT_KEY = '__content__'.freeze
+    CONTENT_KEY = "__content__".freeze
 
     NODE_TYPE_NAMES = %w{ATTRIBUTE_NODE CDATA_SECTION_NODE COMMENT_NODE DOCUMENT_FRAGMENT_NODE
     DOCUMENT_NODE DOCUMENT_TYPE_NODE ELEMENT_NODE ENTITY_NODE ENTITY_REFERENCE_NODE NOTATION_NODE
@@ -38,7 +40,7 @@ module ActiveSupport
       else
         @dbf = DocumentBuilderFactory.new_instance
         # secure processing of java xml
-        # http://www.ibm.com/developerworks/xml/library/x-tipcfsx/index.html
+        # https://archive.is/9xcQQ
         @dbf.setFeature("http://apache.org/xml/features/nonvalidating/load-external-dtd", false)
         @dbf.setFeature("http://xml.org/sax/features/external-general-entities", false)
         @dbf.setFeature("http://xml.org/sax/features/external-parameter-entities", false)
@@ -46,135 +48,136 @@ module ActiveSupport
         xml_string_reader = StringReader.new(data)
         xml_input_source = InputSource.new(xml_string_reader)
         doc = @dbf.new_document_builder.parse(xml_input_source)
-        merge_element!({CONTENT_KEY => ''}, doc.document_element)
+        merge_element!({ CONTENT_KEY => "" }, doc.document_element, XmlMini.depth)
       end
     end
 
     private
 
-    # Convert an XML element and merge into the hash
-    #
-    # hash::
-    #   Hash to merge the converted element into.
-    # element::
-    #   XML element to merge into hash
-    def merge_element!(hash, element)
-      delete_empty(hash)
-      merge!(hash, element.tag_name, collapse(element))
-    end
-
-    def delete_empty(hash)
-      hash.delete(CONTENT_KEY) if hash[CONTENT_KEY] == ''
-    end
+      # Convert an XML element and merge into the hash
+      #
+      # hash::
+      #   Hash to merge the converted element into.
+      # element::
+      #   XML element to merge into hash
+      def merge_element!(hash, element, depth)
+        raise "Document too deep!" if depth == 0
+        delete_empty(hash)
+        merge!(hash, element.tag_name, collapse(element, depth))
+      end
 
-    # Actually converts an XML document element into a data structure.
-    #
-    # element::
-    #   The document element to be collapsed.
-    def collapse(element)
-      hash = get_attributes(element)
+      def delete_empty(hash)
+        hash.delete(CONTENT_KEY) if hash[CONTENT_KEY] == ""
+      end
 
-      child_nodes = element.child_nodes
-      if child_nodes.length > 0
-        (0...child_nodes.length).each do |i|
-          child = child_nodes.item(i)
-          merge_element!(hash, child) unless child.node_type == Node.TEXT_NODE
+      # Actually converts an XML document element into a data structure.
+      #
+      # element::
+      #   The document element to be collapsed.
+      def collapse(element, depth)
+        hash = get_attributes(element)
+
+        child_nodes = element.child_nodes
+        if child_nodes.length > 0
+          (0...child_nodes.length).each do |i|
+            child = child_nodes.item(i)
+            merge_element!(hash, child, depth - 1) unless child.node_type == Node.TEXT_NODE
+          end
+          merge_texts!(hash, element) unless empty_content?(element)
+          hash
+        else
+          merge_texts!(hash, element)
         end
-        merge_texts!(hash, element) unless empty_content?(element)
-        hash
-      else
-        merge_texts!(hash, element)
       end
-    end
 
-    # Merge all the texts of an element into the hash
-    #
-    # hash::
-    #   Hash to add the converted element to.
-    # element::
-    #   XML element whose texts are to me merged into the hash
-    def merge_texts!(hash, element)
-      delete_empty(hash)
-      text_children = texts(element)
-      if text_children.join.empty?
-        hash
-      else
-        # must use value to prevent double-escaping
-        merge!(hash, CONTENT_KEY, text_children.join)
+      # Merge all the texts of an element into the hash
+      #
+      # hash::
+      #   Hash to add the converted element to.
+      # element::
+      #   XML element whose texts are to me merged into the hash
+      def merge_texts!(hash, element)
+        delete_empty(hash)
+        text_children = texts(element)
+        if text_children.join.empty?
+          hash
+        else
+          # must use value to prevent double-escaping
+          merge!(hash, CONTENT_KEY, text_children.join)
+        end
       end
-    end
 
-    # Adds a new key/value pair to an existing Hash. If the key to be added
-    # already exists and the existing value associated with key is not
-    # an Array, it will be wrapped in an Array. Then the new value is
-    # appended to that Array.
-    #
-    # hash::
-    #   Hash to add key/value pair to.
-    # key::
-    #   Key to be added.
-    # value::
-    #   Value to be associated with key.
-    def merge!(hash, key, value)
-      if hash.has_key?(key)
-        if hash[key].instance_of?(Array)
-          hash[key] << value
+      # Adds a new key/value pair to an existing Hash. If the key to be added
+      # already exists and the existing value associated with key is not
+      # an Array, it will be wrapped in an Array. Then the new value is
+      # appended to that Array.
+      #
+      # hash::
+      #   Hash to add key/value pair to.
+      # key::
+      #   Key to be added.
+      # value::
+      #   Value to be associated with key.
+      def merge!(hash, key, value)
+        if hash.has_key?(key)
+          if hash[key].instance_of?(Array)
+            hash[key] << value
+          else
+            hash[key] = [hash[key], value]
+          end
+        elsif value.instance_of?(Array)
+          hash[key] = [value]
         else
-          hash[key] = [hash[key], value]
+          hash[key] = value
         end
-      elsif value.instance_of?(Array)
-        hash[key] = [value]
-      else
-        hash[key] = value
+        hash
       end
-      hash
-    end
 
-    # Converts the attributes array of an XML element into a hash.
-    # Returns an empty Hash if node has no attributes.
-    #
-    # element::
-    #   XML element to extract attributes from.
-    def get_attributes(element)
-      attribute_hash = {}
-      attributes = element.attributes
-      (0...attributes.length).each do |i|
-         attribute_hash[CONTENT_KEY] ||= ''
-         attribute_hash[attributes.item(i).name] =  attributes.item(i).value
-       end
-      attribute_hash
-    end
+      # Converts the attributes array of an XML element into a hash.
+      # Returns an empty Hash if node has no attributes.
+      #
+      # element::
+      #   XML element to extract attributes from.
+      def get_attributes(element)
+        attribute_hash = {}
+        attributes = element.attributes
+        (0...attributes.length).each do |i|
+          attribute_hash[CONTENT_KEY] ||= ""
+          attribute_hash[attributes.item(i).name] = attributes.item(i).value
+        end
+        attribute_hash
+      end
 
-    # Determines if a document element has text content
-    #
-    # element::
-    #   XML element to be checked.
-    def texts(element)
-      texts = []
-      child_nodes = element.child_nodes
-      (0...child_nodes.length).each do |i|
-        item = child_nodes.item(i)
-        if item.node_type == Node.TEXT_NODE
-          texts << item.get_data
+      # Determines if a document element has text content
+      #
+      # element::
+      #   XML element to be checked.
+      def texts(element)
+        texts = []
+        child_nodes = element.child_nodes
+        (0...child_nodes.length).each do |i|
+          item = child_nodes.item(i)
+          if item.node_type == Node.TEXT_NODE
+            texts << item.get_data
+          end
         end
+        texts
       end
-      texts
-    end
 
-    # Determines if a document element has text content
-    #
-    # element::
-    #   XML element to be checked.
-    def empty_content?(element)
-      text = ''
-      child_nodes = element.child_nodes
-      (0...child_nodes.length).each do |i|
-        item = child_nodes.item(i)
-        if item.node_type == Node.TEXT_NODE
-          text << item.get_data.strip
+      # Determines if a document element has text content
+      #
+      # element::
+      #   XML element to be checked.
+      def empty_content?(element)
+        text = "".dup
+        child_nodes = element.child_nodes
+        (0...child_nodes.length).each do |i|
+          item = child_nodes.item(i)
+          if item.node_type == Node.TEXT_NODE
+            text << item.get_data.strip
+          end
         end
+        text.strip.length == 0
       end
-      text.strip.length == 0
-    end
   end
 end

data/lib/active_support/xml_mini/libxml.rb

@@ -1,6 +1,8 @@
-require 'libxml'
-require 'active_support/core_ext/object/blank'
-require 'stringio'
+# frozen_string_literal: true
+
+require "libxml"
+require "active_support/core_ext/object/blank"
+require "stringio"
 
 module ActiveSupport
   module XmlMini_LibXML #:nodoc:
@@ -11,18 +13,15 @@ module ActiveSupport
     #   XML Document string or IO to parse
     def parse(data)
       if !data.respond_to?(:read)
-        data = StringIO.new(data || '')
+        data = StringIO.new(data || "")
       end
 
-      char = data.getc
-      if char.nil?
+      if data.eof?
         {}
       else
-        data.ungetc(char)
         LibXML::XML::Parser.io(data).parse.to_hash
       end
     end
-
   end
 end
 
@@ -35,20 +34,20 @@ module LibXML #:nodoc:
     end
 
     module Node #:nodoc:
-      CONTENT_ROOT = '__content__'.freeze
+      CONTENT_ROOT = "__content__".freeze
 
       # Convert XML document to hash.
       #
       # hash::
       #   Hash to merge the converted element into.
-      def to_hash(hash={})
+      def to_hash(hash = {})
         node_hash = {}
 
         # 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 then hash[name] << node_hash
+        when Hash  then hash[name] = [hash[name], node_hash]
+        when nil   then hash[name] = node_hash
         end
 
         # Handle child elements
@@ -56,7 +55,7 @@ module LibXML #:nodoc:
           if c.element?
             c.to_hash(node_hash)
           elsif c.text? || c.cdata?
-            node_hash[CONTENT_ROOT] ||= ''
+            node_hash[CONTENT_ROOT] ||= "".dup
             node_hash[CONTENT_ROOT] << c.content
           end
         end
@@ -75,5 +74,7 @@ module LibXML #:nodoc:
   end
 end
 
-LibXML::XML::Document.send(:include, LibXML::Conversions::Document)
-LibXML::XML::Node.send(:include, LibXML::Conversions::Node)
+# :enddoc:
+
+LibXML::XML::Document.include(LibXML::Conversions::Document)
+LibXML::XML::Node.include(LibXML::Conversions::Node)

data/lib/active_support/xml_mini/libxmlsax.rb

@@ -1,6 +1,8 @@
-require 'libxml'
-require 'active_support/core_ext/object/blank'
-require 'stringio'
+# frozen_string_literal: true
+
+require "libxml"
+require "active_support/core_ext/object/blank"
+require "stringio"
 
 module ActiveSupport
   module XmlMini_LibXMLSAX #:nodoc:
@@ -9,11 +11,10 @@ module ActiveSupport
     # Class that will build the hash while the XML document
     # is being parsed using SAX events.
     class HashBuilder
-
       include LibXML::XML::SaxParser::Callbacks
 
-      CONTENT_KEY   = '__content__'.freeze
-      HASH_SIZE_KEY = '__hash_size__'.freeze
+      CONTENT_KEY   = "__content__".freeze
+      HASH_SIZE_KEY = "__hash_size__".freeze
 
       attr_reader :hash
 
@@ -22,7 +23,7 @@ module ActiveSupport
       end
 
       def on_start_document
-        @hash = { CONTENT_KEY => '' }
+        @hash = { CONTENT_KEY => "".dup }
         @hash_stack = [@hash]
       end
 
@@ -32,20 +33,20 @@ module ActiveSupport
       end
 
       def on_start_element(name, attrs = {})
-        new_hash = { CONTENT_KEY => '' }.merge!(attrs)
+        new_hash = { CONTENT_KEY => "".dup }.merge!(attrs)
         new_hash[HASH_SIZE_KEY] = new_hash.size + 1
 
         case current_hash[name]
-          when Array then current_hash[name] << new_hash
-          when Hash  then current_hash[name] = [current_hash[name], new_hash]
-          when nil   then current_hash[name] = new_hash
+        when Array then current_hash[name] << new_hash
+        when Hash  then current_hash[name] = [current_hash[name], new_hash]
+        when nil   then current_hash[name] = new_hash
         end
 
         @hash_stack.push(new_hash)
       end
 
       def on_end_element(name)
-        if current_hash.length > current_hash.delete(HASH_SIZE_KEY) && current_hash[CONTENT_KEY].blank? || current_hash[CONTENT_KEY] == ''
+        if current_hash.length > current_hash.delete(HASH_SIZE_KEY) && current_hash[CONTENT_KEY].blank? || current_hash[CONTENT_KEY] == ""
           current_hash.delete(CONTENT_KEY)
         end
         @hash_stack.pop
@@ -63,18 +64,15 @@ module ActiveSupport
 
     def parse(data)
       if !data.respond_to?(:read)
-        data = StringIO.new(data || '')
+        data = StringIO.new(data || "")
       end
 
-      char = data.getc
-      if char.nil?
+      if data.eof?
         {}
       else
-        data.ungetc(char)
-
         LibXML::XML::Error.set_handler(&LibXML::XML::Error::QUIET_HANDLER)
         parser = LibXML::XML::SaxParser.io(data)
-        document = self.document_class.new
+        document = document_class.new
 
         parser.callbacks = document
         parser.parse

data/lib/active_support/xml_mini/nokogiri.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 begin
-  require 'nokogiri'
+  require "nokogiri"
 rescue LoadError => e
   $stderr.puts "You don't have nokogiri installed in your application. Please add it to your Gemfile and run bundle install"
   raise e
 end
-require 'active_support/core_ext/object/blank'
-require 'stringio'
+require "active_support/core_ext/object/blank"
+require "stringio"
 
 module ActiveSupport
   module XmlMini_Nokogiri #:nodoc:
@@ -16,14 +18,12 @@ module ActiveSupport
     #   XML Document string or IO to parse
     def parse(data)
       if !data.respond_to?(:read)
-        data = StringIO.new(data || '')
+        data = StringIO.new(data || "")
       end
 
-      char = data.getc
-      if char.nil?
+      if data.eof?
         {}
       else
-        data.ungetc(char)
         doc = Nokogiri::XML(data)
         raise doc.errors.first if doc.errors.length > 0
         doc.to_hash
@@ -38,20 +38,20 @@ module ActiveSupport
       end
 
       module Node #:nodoc:
-        CONTENT_ROOT = '__content__'.freeze
+        CONTENT_ROOT = "__content__".freeze
 
         # Convert XML document to hash.
         #
         # hash::
         #   Hash to merge the converted element into.
-        def to_hash(hash={})
+        def to_hash(hash = {})
           node_hash = {}
 
           # 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 then hash[name] << node_hash
+          when Hash  then hash[name] = [hash[name], node_hash]
+          when nil   then hash[name] = node_hash
           end
 
           # Handle child elements
@@ -59,7 +59,7 @@ module ActiveSupport
             if c.element?
               c.to_hash(node_hash)
             elsif c.text? || c.cdata?
-              node_hash[CONTENT_ROOT] ||= ''
+              node_hash[CONTENT_ROOT] ||= "".dup
               node_hash[CONTENT_ROOT] << c.content
             end
           end
@@ -77,7 +77,7 @@ module ActiveSupport
       end
     end
 
-    Nokogiri::XML::Document.send(:include, Conversions::Document)
-    Nokogiri::XML::Node.send(:include, Conversions::Node)
+    Nokogiri::XML::Document.include(Conversions::Document)
+    Nokogiri::XML::Node.include(Conversions::Node)
   end
 end