logstash-filter-xml 4.0.5 → 4.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a7f6f6bc4d939e900e8f5979658c9456d00f4bb6b5ad463c1068637aeb308f1
-  data.tar.gz: 5055ebdb1c13c410f1802f77b6681a7055b6c85a69b31b2561985673830b1f7d
+  metadata.gz: b00b3a1873a98c6e633b1b35bcd64a21eefe8f57fe3c28efcf4103c5a3855685
+  data.tar.gz: a363f65d3e9f2206221d076b8bfc6c2a4f560e952cb0415c4cea6eb5ab1762b6
 SHA512:
-  metadata.gz: 7cd0c80bd580a55afa5edf461890b1cc6ba0f0747cfe7da4050a2237d562a2b4240286da3536d963fd10b57d28d59acf8edb498a59e09d745fd551c5bde6d478
-  data.tar.gz: b965d484c29e2bd85aa7b27a07ed4469fc443737a1974126e1556931ac9f91860c5b1e5d9d671fcb039a6088ef497fa473b24a4a896241638996c9f565d2ae4e
+  metadata.gz: '099b6efdb5ad0ea40d18fa91c08a961e8a736cd12df8ee1a07e993c10f8e61dcd3227b7ceb274dc569f24a7417d905f08d607849bcee5005e54c17829d4ed123'
+  data.tar.gz: e8cede0fb4dc11a5b31aa4bc079ae4ab7b75f112b8acda4be47a582db0cf80120c84d62a40ee856c5264c50cb2bb46e55a0892b3d11e3c2eec97efa0572471a8

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 4.0.6
+  - Fixed force_array behavior with nested elements [#57](https://github.com/logstash-plugins/logstash-filter-xml/pull/57)
+
 ## 4.0.5
   - Update gemspec summary
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
+Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/logstash/filters/xml.rb

@@ -156,21 +156,24 @@ class LogStash::Filters::Xml < LogStash::Filters::Base
         # String instead of a NodeSet.  We normalize that here.
         normalized_nodeset = nodeset.kind_of?(Nokogiri::XML::NodeSet) ? nodeset : [nodeset]
 
+        # Initialize empty resultset
+        data = []
+
         normalized_nodeset.each do |value|
           # some XPath functions return empty arrays as string
-          # TODO: (colin) the return statement here feels like a bug and should probably be a next ?
-          return if value.is_a?(Array) && value.length == 0
+          next if value.is_a?(Array) && value.length == 0
 
           if value
             matched = true
-            # TODO: (colin) this can probably be optimized to avoid the Event get/set at every loop iteration anf
-            # the array should probably be created once, filled in the loop and set at after the loop but the return
-            # statement above screws this strategy and is likely a bug anyway so I will not touch this until I can
-            # deep a big deeper and verify there is a sufficient test harness to refactor this.
-            data = event.get(xpath_dest) || []
             data << value.to_s
-            event.set(xpath_dest, data)
           end
+
+        end
+        # set the destination attribute, if it's an array with a bigger size than one, leave as is. otherwise make it a string. added force_array param to provide same functionality as writing it in an xml target
+        if data.size == 1 && !@force_array
+          event.set(xpath_dest, data[0])
+        else
+          event.set(xpath_dest, data)
         end
       end
     end

data/logstash-filter-xml.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-xml'
-  s.version         = '4.0.5'
+  s.version         = '4.0.6'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Parses XML into fields"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

data/spec/filters/xml_spec.rb

@@ -310,6 +310,26 @@ describe LogStash::Filters::Xml do
     end
   end
 
+  describe "parse disabling forcing with nested elements" do
+    config <<-CONFIG
+    filter {
+      xml {
+        source => "xmldata"
+        store_xml => "false"
+        force_array => "false"
+        xpath => [
+          "/element/field1/text()", "field1"
+        ]
+      }
+    }
+    CONFIG
+
+    # Single value
+    sample("xmldata" => '<element><field1>bbb</field1><field2>789</field2><field3>e3f<field3></element>') do
+      insist { subject.get("field1") } == "bbb"
+    end
+  end
+
   context "Using suppress_empty option" do
     describe "suppress_empty => false" do
       config <<-CONFIG

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-xml
 version: !ruby/object:Gem::Version
-  version: 4.0.5
+  version: 4.0.6
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2018-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key:
 specification_version: 4
 summary: Parses XML into fields