logstash-filter-mutate 3.3.4 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10c472383e1b7198e53fce13513fa010542a198cfdaf76dd617067538f4e0a94
-  data.tar.gz: bebff8caed3fe2d7949c386730ea7392f3c56f4d27395a0eaf8fb83b9c923fc7
+  metadata.gz: d864cb702460a9b6b7ab2d3bcf7983df039730306118771e0e62e2f87754c31c
+  data.tar.gz: ee2729fb05d2a18426d8419b917df4137ca90bfd5e45fa4a99a1f32e2ebb5317
 SHA512:
-  metadata.gz: 4290aa84cce80d2b3c5f3b60fba4926d4f46db250609a3203874cfca77364d4c5979e3625ed8579294f1e75359d3e9c455e29ca76d29f4b913fa6a70bb4e7dcc
-  data.tar.gz: 6e3cb113ad72a0c0bdedcc50c6098d0fda4de7ad07fb44c55b7423f55acc1a8dcb7caf2e08d71d9b1d0cfc6150349b785599d6abbfca3a666c53ca2f3c3ba826
+  metadata.gz: 0e01156ec1b9be737f2a291a95a270a1a07e90fac8e62ffbebbc1a81db9d983bda817a7539bd9827b4d919abe4defe6cbf1d3755d51e38c76c26a520d90846ca
+  data.tar.gz: 7998a5a7475514816ab8d83f3749dcb7a54c88a2f510da66b57711c4b7282be70b4290f24b3dc2f71872fb8193824d00f02c8f99d67ed4710fc83ace5a396abf

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.4.0
+ - Added ability to directly convert from integer and float to boolean [#127](https://github.com/logstash-plugins/logstash-filter-mutate/pull/127)
+
 ## 3.3.4
  - Changed documentation to clarify execution order and to provide workaround 
  [#128](https://github.com/logstash-plugins/logstash-filter-mutate/pull/128)

data/docs/index.asciidoc

@@ -117,10 +117,15 @@ Valid conversion targets, and their expected behaviour with different inputs are
  * `string`:
    - all values are stringified and encoded with UTF-8
  * `boolean`:
-   - strings `"true"`, `"t"`, `"yes"`, `"y"`, and `"1"` are converted to boolean `true`
-   - strings `"false"`, `"f"`, `"no"`, `"n"`, and `"0"` are converted to boolean `false`
+   - integer 0 is converted to boolean `false`
+   - integer 1 is converted to boolean `true`
+   - float 0.0 is converted to boolean `false`
+   - float 1.0 is converted to boolean `true`
+   - strings `"true"`, `"t"`, `"yes"`, `"y"`, `"1"`and `"1.0"` are converted to boolean `true`
+   - strings `"false"`, `"f"`, `"no"`, `"n"`, `"0"` and `"0.0"` are converted to boolean `false`
    - empty strings are converted to boolean `false`
    - all other values pass straight through without conversion and log a warning message
+   - for arrays each value gets processed separately using rules above
 
 This plugin can convert multiple fields in the same document, see the example below.
 

data/lib/logstash/filters/mutate.rb

@@ -207,8 +207,8 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   #     }
   config :copy, :validate => :hash
 
-  TRUE_REGEX = (/^(true|t|yes|y|1)$/i).freeze
-  FALSE_REGEX = (/^(false|f|no|n|0)$/i).freeze
+  TRUE_REGEX = (/^(true|t|yes|y|1|1.0)$/i).freeze
+  FALSE_REGEX = (/^(false|f|no|n|0|0.0)$/i).freeze
   CONVERT_PREFIX = "convert_".freeze
 
   def register
@@ -327,8 +327,8 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   end
 
   def convert_boolean(value)
-    return true if value =~ TRUE_REGEX
-    return false if value.empty? || value =~ FALSE_REGEX
+    return true if value.to_s =~ TRUE_REGEX
+    return false if value.to_s.empty? || value.to_s =~ FALSE_REGEX
     @logger.warn("Failed to convert #{value} into boolean.")
     value
   end

data/logstash-filter-mutate.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-mutate'
-  s.version         = '3.3.4'
+  s.version         = '3.4.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Performs mutations on 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/mutate_spec.rb

@@ -373,45 +373,78 @@ describe LogStash::Filters::Mutate do
     config <<-CONFIG
       filter {
         mutate {
-          convert => { "true_field"  => "boolean" }
-          convert => { "false_field" => "boolean" }
-          convert => { "true_upper"  => "boolean" }
-          convert => { "false_upper" => "boolean" }
-          convert => { "true_one"    => "boolean" }
-          convert => { "false_zero"  => "boolean" }
-          convert => { "true_yes"    => "boolean" }
-          convert => { "false_no"    => "boolean" }
-          convert => { "true_y"      => "boolean" }
-          convert => { "false_n"     => "boolean" }
-          convert => { "wrong_field" => "boolean" }
+          convert => { "true_field"         => "boolean" }
+          convert => { "false_field"        => "boolean" }
+          convert => { "true_upper"         => "boolean" }
+          convert => { "false_upper"        => "boolean" }
+          convert => { "true_one"           => "boolean" }
+          convert => { "false_zero"         => "boolean" }
+          convert => { "true_yes"           => "boolean" }
+          convert => { "false_no"           => "boolean" }
+          convert => { "true_y"             => "boolean" }
+          convert => { "false_n"            => "boolean" }
+          convert => { "wrong_field"        => "boolean" }
+          convert => { "integer_false"      => "boolean" }
+          convert => { "integer_true"       => "boolean" }
+          convert => { "integer_negative"   => "boolean" }
+          convert => { "integer_wrong"      => "boolean" }
+          convert => { "float_true"         => "boolean" }
+          convert => { "float_false"        => "boolean" }
+          convert => { "float_negative"     => "boolean" }
+          convert => { "float_wrong"        => "boolean" }
+          convert => { "float_wrong2"       => "boolean" }
+          convert => { "array"              => "boolean" }
+          convert => { "hash"               => "boolean" }
         }
       }
     CONFIG
     event = {
-      "true_field"  => "true",
-      "false_field" => "false",
-      "true_upper"  => "True",
-      "false_upper" => "False",
-      "true_one"    => "1",
-      "false_zero"  => "0",
-      "true_yes"    => "yes",
-      "false_no"    => "no",
-      "true_y"      => "Y",
-      "false_n"     => "N",
-      "wrong_field" => "none of the above"
+      "true_field"      => "true",
+      "false_field"     => "false",
+      "true_upper"      => "True",
+      "false_upper"     => "False",
+      "true_one"        => "1",
+      "false_zero"      => "0",
+      "true_yes"        => "yes",
+      "false_no"        => "no",
+      "true_y"          => "Y",
+      "false_n"         => "N",
+      "wrong_field"     => "none of the above",
+      "integer_false"   => 0,
+      "integer_true"    => 1,
+      "integer_negative"=> -1,
+      "integer_wrong"   => 2,
+      "float_true"      => 1.0,
+      "float_false"     => 0.0,
+      "float_negative"  => -1.0,
+      "float_wrong"     => 1.0123,
+      "float_wrong2"    => 0.01,
+      "array"           => [ "1", "0", 0,1,2],
+      "hash"            => { "a" => 0 }
     }
     sample event do
-      expect(subject.get("true_field") ).to eq(true)
-      expect(subject.get("false_field")).to eq(false)
-      expect(subject.get("true_upper") ).to eq(true)
-      expect(subject.get("false_upper")).to eq(false)
-      expect(subject.get("true_one")   ).to eq(true)
-      expect(subject.get("false_zero") ).to eq(false)
-      expect(subject.get("true_yes")   ).to eq(true)
-      expect(subject.get("false_no")   ).to eq(false)
-      expect(subject.get("true_y")     ).to eq(true)
-      expect(subject.get("false_n")    ).to eq(false)
-      expect(subject.get("wrong_field")).to eq("none of the above")
+      expect(subject.get("true_field")      ).to eq(true)
+      expect(subject.get("false_field")     ).to eq(false)
+      expect(subject.get("true_upper")      ).to eq(true)
+      expect(subject.get("false_upper")     ).to eq(false)
+      expect(subject.get("true_one")        ).to eq(true)
+      expect(subject.get("false_zero")      ).to eq(false)
+      expect(subject.get("true_yes")        ).to eq(true)
+      expect(subject.get("false_no")        ).to eq(false)
+      expect(subject.get("true_y")          ).to eq(true)
+      expect(subject.get("false_n")         ).to eq(false)
+      expect(subject.get("wrong_field")     ).to eq("none of the above")
+      expect(subject.get("integer_false")   ).to eq(false)
+      expect(subject.get("integer_true")    ).to eq(true)
+      expect(subject.get("integer_negative")).to eq(-1)
+      expect(subject.get("integer_wrong")   ).to eq(2)
+      expect(subject.get("float_true")      ).to eq(true)
+      expect(subject.get("float_false")     ).to eq(false)
+      expect(subject.get("float_negative")  ).to eq(-1.0)
+      expect(subject.get("float_wrong")     ).to eq(1.0123)
+      expect(subject.get("float_wrong2")    ).to eq(0.01)
+      expect(subject.get("array")           ).to eq([true, false, false, true,2])
+      expect(subject.get("hash")            ).to eq({ "a" => 0 })
     end
   end
 
@@ -487,7 +520,7 @@ describe LogStash::Filters::Mutate do
       end
     end
   end
-
+  
 
   describe "convert to float_eu" do
     config <<-CONFIG

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-mutate
 version: !ruby/object:Gem::Version
-  version: 3.3.4
+  version: 3.4.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement