xml-simple 1.1.4 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 068e3be25c5a9565cee2d420a9c396c851fb66e4
-  data.tar.gz: 21523e733014986f92569c8a2e0e32e0617945c1
+SHA256:
+  metadata.gz: 83fdfe764b21f66e184a245f9f908d2ed9678edd6d0734a33cac93030449c324
+  data.tar.gz: ecd9ac1ed12a0fb03f2b8fee924db65ec844dffda64f9553b76a626b2532635a
 SHA512:
-  metadata.gz: e4fd65ac9b33e3723968f59030366b0400ff14c61c290eecc6cd7d24e06a6768279a64ff514c3f4111c8cd89a06d8a5373e976c7e97fce2eba03d5631527d4bb
-  data.tar.gz: 9fede257f59b389c890003c9995762c1714f6e70d6c9e0067f200c4dfb7d90fe3a69f068f24229265c8f483d274393f123a89ff7fda9117cf41c824d0c86acb3
+  metadata.gz: 652f1cbb3ef139e5450cdd2ad01fc4a22e23ec3174bd3d88c58b973f1c5c955673a365bbaa3e3c910ad60c190994e3e0e88fd4678af69d5981aadd2b0ecb019d
+  data.tar.gz: 40e7a0e3e6b0a42d178e8f6b782aca2e8a6d65ce87ab8aa06953d7dfe41b4ce115793018df2bab0b6238298d1c35ccdaa2fee9a0ea46ac927f2d2238d2f0146d

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-2021 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.4'
+  @@VERSION = '1.1.9'
 
   # 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.
@@ -264,15 +264,15 @@ 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
       xmldeclaration outputfile noescape suppressempty
-      anonymoustag indent grouptags noindent attrprefix
+      anonymoustag indent grouptags noindent attrprefix selfclose
     )
   }
 
@@ -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
 
@@ -820,7 +835,7 @@ class XmlSimple
             end
           end
         }
-      else
+      elsif !@options['selfclose']
         text_content = ''
       end
 
@@ -1028,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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: xml-simple
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.9
 platform: ruby
 authors:
 - Maik Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
-dependencies: []
+date: 2021-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: contact@maik-schmidt.de
 executables: []
@@ -19,7 +33,7 @@ files:
 - lib/xmlsimple.rb
 homepage: https://github.com/maik/xml-simple
 licenses:
-- Ruby
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -27,17 +41,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: xml-simple
-rubygems_version: 2.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A simple API for XML processing.