xml-simple 1.1.5 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b2673ebe343b5f04ba6870687867461f21ade3b9
-  data.tar.gz: 1e0f37f2fc6d72365f9b0b36a18849cb17eba27e
+SHA256:
+  metadata.gz: 0740fe90e1641ef7fbbbbf60cb1c1e6ae5795f1be7460d957de7d47bdbd20bfc
+  data.tar.gz: 9c5f0471d8cd779ed728827493cff987b9a878afb9fc6182e36cafe67541285f
 SHA512:
-  metadata.gz: 5ac3b4367a95d29ccecad806a0484658cdb36a87edc71bb2dec1ca90c0f29ae63f0fcac1cb6f3c87d5503b50224728e2a2506d0d516ddda46b639091a5d37180
-  data.tar.gz: ed5a721d68e38fb6551d1a1c99c3c66c8094b37752f7cfe371a1b92867dcb37f309dc7a7fa3d2e985f03dd5583869bb3d36b27c42b45eca04c66b3251c62b19a
+  metadata.gz: 225b8fbe390650a575c1bbae0e14ba66b08aeaf07cd50547e5950b875e66773df31f9747981625cfdf12dce8b74f403aae2a112dab03d5d33bca73ca18feb2c4
+  data.tar.gz: fb90812c2c2a455920dbb85adb555ec95f3c1dcfb7221d7fbc6288064658e20d5c43d9dda0c9c17e88813943837033fd085e928f94bca57668e2e7e9651535a6

data/lib/xmlsimple.rb

@@ -1,7 +1,7 @@
 # = XmlSimple
 #
 # Author::    Maik Schmidt <contact@maik-schmidt.de>
-# Copyright:: Copyright (c) 2003-2014 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.5'
+  @@VERSION = '1.1.8'
 
   # A simple cache for XML documents that were already transformed
   # by xml_in.
@@ -267,12 +267,12 @@ class XmlSimple
       keyattr keeproot forcecontent contentkey noattr searchpath
       forcearray suppressempty anonymoustag cache grouptags
       normalisespace normalizespace variables varattr keytosymbol
-      attrtosymbol attrprefix conversions
+      attrtosymbol attrprefix conversions kebabtosnakecase
     ),
     'out' => %w(
       keyattr keeproot contentkey noattr rootname
       xmldeclaration outputfile noescape suppressempty
-      anonymoustag indent grouptags noindent attrprefix
+      anonymoustag indent grouptags noindent attrprefix selfclose
     )
   }
 
@@ -286,6 +286,7 @@ class XmlSimple
   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.
@@ -454,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.
@@ -482,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.
@@ -491,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
@@ -548,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)
@@ -644,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
 
@@ -658,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
@@ -712,12 +720,12 @@ 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[n.to_sym] = v }
+      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
@@ -827,7 +835,7 @@ class XmlSimple
             end
           end
         }
-      else
+      elsif !@options['selfclose']
         text_content = ''
       end
 
@@ -1035,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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xml-simple
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.8
 platform: ruby
 authors:
 - Maik Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2020-12-22 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: contact@maik-schmidt.de
@@ -19,7 +19,7 @@ files:
 - lib/xmlsimple.rb
 homepage: https://github.com/maik/xml-simple
 licenses:
-- Ruby
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -36,8 +36,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: xml-simple
-rubygems_version: 2.4.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A simple API for XML processing.