xml-simple 1.1.1 → 1.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8d54a316b20f0075b1149d1c48da6ff082e704f7b558f9df5dfbe351a26ceb93
+  data.tar.gz: d4fdc1258f927a4cb18df7858119f2994987fad621a7f66ebc6631481fc4fae9
+SHA512:
+  metadata.gz: 0230ead9d34832d84f83a65e695e1aa610531764fb64481f257efa143e5f9c69ab5449d20f91b92fc79d963da655154395dc630db1349010fdd06c706006bc54
+  data.tar.gz: 1aa57e8b58ac8e43aee7c7bc95985eca193dd0fa7e3af1a006583e33c064be3babebb4ac0d216b35cc892fb5904661bd560d8958a0dae78c3f965ae3dda84606

data/lib/xmlsimple.rb

@@ -1,7 +1,7 @@
 # = XmlSimple
 #
 # Author::    Maik Schmidt <contact@maik-schmidt.de>
-# Copyright:: Copyright (c) 2003-2011 Maik Schmidt
+# Copyright:: Copyright (c) 2003-2020 Maik Schmidt
 # License::   Distributes under the same terms as Ruby.
 #
 require 'rexml/document'
@@ -11,7 +11,7 @@ require 'stringio'
 class XmlSimple
   include REXML
 
-  @@VERSION = '1.1.0'
+  @@VERSION = '1.1.7'
 
   # A simple cache for XML documents that were already transformed
   # by xml_in.
@@ -121,7 +121,7 @@ class XmlSimple
   # Create a "global" cache.
   @@cache = Cache.new
 
-  # Creates and intializes a new XmlSimple object.
+  # Creates and initializes a new XmlSimple object.
   #
   # defaults::
   #   Default values for options.
@@ -185,10 +185,10 @@ class XmlSimple
 
         @doc = load_xml_file(filename)
       end
-    elsif string.kind_of?(IO) || string.kind_of?(StringIO) || string.kind_of?(Zlib::GzipReader)
+    elsif string.respond_to?(:read)
       @doc = parse(string.read)
     else
-      raise ArgumentError, "Could not parse object of type: <#{string.type}>."
+      raise ArgumentError, "Could not parse object of type: <#{string.class}>."
     end
 
     result = collapse(@doc.root)
@@ -264,10 +264,10 @@ class XmlSimple
   # Declare options that are valid for xml_in and xml_out.
   KNOWN_OPTIONS = {
     'in'  => %w(
-      keyattr keeproot forcecontent contentkey noattr
-      searchpath forcearray suppressempty anonymoustag
-      cache grouptags normalisespace normalizespace
-      variables varattr keytosymbol attrprefix conversions
+      keyattr keeproot forcecontent contentkey noattr searchpath
+      forcearray suppressempty anonymoustag cache grouptags
+      normalisespace normalizespace variables varattr keytosymbol
+      attrtosymbol attrprefix conversions kebabtosnakecase
     ),
     'out' => %w(
       keyattr keeproot contentkey noattr rootname
@@ -285,11 +285,13 @@ class XmlSimple
   DEF_FORCE_ARRAY     = true
   DEF_INDENTATION     = '  '
   DEF_KEY_TO_SYMBOL   = false
+  DEF_ATTR_TO_SYMBOL  = false
+  DEF_KEBAB_TO_SNAKE  = false
 
   # Normalizes option names in a hash, i.e., turns all
   # characters to lower case and removes all underscores.
-  # Additionally, this method checks, if an unknown option
-  # was used and raises an according exception.
+  # Additionally, this method checks if an unknown option
+  # was used, and raises an according exception.
   #
   # options::
   #   Hash to be normalized.
@@ -301,7 +303,7 @@ class XmlSimple
     options.each { |key, value|
       lkey = key.to_s.downcase.gsub(/_/, '')
       if !known_options.member?(lkey)
-        raise ArgumentError, "Unrecognised option: #{lkey}."
+        raise ArgumentError, "Unrecognized option: #{lkey}."
       end
       result[lkey] = value
     }
@@ -353,6 +355,8 @@ class XmlSimple
 
     @options['keytosymbol'] = DEF_KEY_TO_SYMBOL unless @options.has_key?('keytosymbol')
 
+    @options['attrtosymbol'] = DEF_ATTR_TO_SYMBOL unless @options.has_key?('attrtosymbol')
+
     if @options.has_key?('contentkey')
       if @options['contentkey'] =~ /^-(.*)$/
         @options['contentkey']    = $1
@@ -451,6 +455,8 @@ class XmlSimple
     elsif @options.has_key?('varattr')
       @_var_values = {}
     end
+
+    @options['kebabtosnakecase'] = DEF_KEBAB_TO_SNAKE unless @options.has_key?('kebabtosnakecase')
   end
 
   # Actually converts an XML document element into a data structure.
@@ -479,7 +485,7 @@ class XmlSimple
         result[@options['contentkey']] = content
       end
     elsif element.has_text? # i.e. it has only text.
-      return collapse_text_node(result, element)
+      return collapse_text_node(result, element) # calls merge, which converts
     end
 
     # Turn Arrays into Hashes if key fields present.
@@ -488,8 +494,11 @@ class XmlSimple
     # Disintermediate grouped tags.
     if @options.has_key?('grouptags')
       result.each { |key, value|
+        # In results, key should already be converted
+        raise("Unconverted key '#{key}' found. Should be '#{kebab_to_snake_case key}'.") if (key != kebab_to_snake_case(key))
         next unless (value.is_a?(Hash) && (value.size == 1))
         child_key, child_value = value.to_a[0]
+        child_key = kebab_to_snake_case child_key # todo test whether necessary
         if @options['grouptags'][key] == child_key
           result[key] = child_value
         end
@@ -545,6 +554,7 @@ class XmlSimple
     keyattr = @options['keyattr']
     if (keyattr.is_a?(Array) || keyattr.is_a?(Hash))
       hash.each { |key, value|
+        key = kebab_to_snake_case key
         if value.is_a?(Array)
           if keyattr.is_a?(Array)
             hash[key] = fold_array(value)
@@ -641,6 +651,7 @@ class XmlSimple
   # value::
   #   Value to be associated with key.
   def merge(hash, key, value)
+    key = kebab_to_snake_case key
     if value.is_a?(String)
       value = normalise_space(value) if @options['normalisespace'] == 2
 
@@ -655,7 +666,7 @@ class XmlSimple
 
       # look for variable definitions
       if @options.has_key?('varattr')
-        varattr = @options['varattr']
+        varattr = kebab_to_snake_case @options['varattr']
         if hash.has_key?(varattr)
           set_var(hash[varattr], value)
         end
@@ -709,10 +720,14 @@ class XmlSimple
   def get_attributes(node)
     attributes = {}
     if @options['attrprefix']
-      node.attributes.each { |n,v| attributes["@" + n] = v }
+      node.attributes.each { |n,v| attributes["@" + kebab_to_snake_case(n)] = v }
+    elsif @options.has_key?('attrtosymbol') and @options['attrtosymbol'] == true
+      #patch for converting attribute names to symbols
+      node.attributes.each { |n,v| attributes[kebab_to_snake_case(n).to_sym] = v }
     else
-      node.attributes.each { |n,v| attributes[n] = v }
+      node.attributes.each { |n,v| attributes[kebab_to_snake_case(n)] = v }
     end
+
     attributes
   end
 
@@ -721,10 +736,9 @@ class XmlSimple
   # element::
   #   Document element to be checked.
   def has_mixed_content?(element)
-    if element.has_text? && element.has_elements?
-      return true if element.texts.join('') !~ /^\s*$/
-    end
-    false
+    element.has_text? &&
+      element.has_elements? &&
+      !element.texts.join('').strip.empty?
   end
 
   # Called when a variable definition is encountered in the XML.
@@ -1029,6 +1043,20 @@ class XmlSimple
       }
     end
   end
+
+  # Substitutes underscores for hyphens if the KebabToSnakeCase option is selected. For when you don't
+  # want to refer to keys by hash[:'my-key'] but instead as hash[:my_key]
+  #
+  # key::
+  #   Key to be converted.
+  def kebab_to_snake_case(key)
+    return key unless (@options['kebabtosnakecase'])
+
+    is_symbol = key.is_a? Symbol
+    key = key.to_s.gsub(/-/, '_')
+    key = key.to_sym if is_symbol
+    key
+  end
 end
 
 # vim:sw=2

metadata

@@ -1,64 +1,43 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: xml-simple
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 1
-  version: 1.1.1
+version: !ruby/object:Gem::Version
+  version: 1.1.7
 platform: ruby
-authors: 
+authors:
 - Maik Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-10-11 00:00:00 +02:00
-default_executable: 
+date: 2020-12-15 00:00:00.000000000 Z
 dependencies: []
-
 description: 
 email: contact@maik-schmidt.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/xmlsimple.rb
-has_rdoc: true
-homepage: http://xml-simple.rubyforge.org
-licenses: []
-
+homepage: https://github.com/maik/xml-simple
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_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 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: xml-simple
-rubygems_version: 1.3.7
+rubygems_version: 3.1.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple API for XML processing.
 test_files: []
-