Fix merge issue

Author: Alexander Salmin

lib/puppet/functions/to_json_pretty.rb

@@ -7,15 +7,32 @@
 #       content => to_json_pretty($myhash),
 #     }
 #
+# @example how to output pretty JSON skipping over keys with undef values
+#   # output pretty JSON to a file skipping over undef values
+#     file { '/tmp/my.json':
+#       ensure  => file,
+#       content => to_json_pretty({
+#         param_one => 'value',
+#         param_two => undef,
+#       }),
+#     }
 #
 require 'json'
 
 Puppet::Functions.create_function(:to_json_pretty) do
   dispatch :to_json_pretty do
     param 'Variant[Hash, Array]', :data
+    optional_param 'Boolean', :skip_undef
   end
 
-  def to_json_pretty(data)
-    JSON.pretty_generate(data)
+  def to_json_pretty(data, skip_undef = false)
+    if skip_undef
+      if data.is_a? Array
+        data = data.reject { |value| value.nil? }
+      elsif data.is_a? Hash
+        data = data.reject { |_, value| value.nil? }
+      end
+    end
+    JSON.pretty_generate(data) << "\n"
   end
 end

spec/fixtures/test/manifests/absolute_path.pp

@@ -1,4 +1,4 @@
 # Class to test deftype
-define test::deftype($param = 'foo') {
+define test::deftype( $param = 'foo' ) {
   notify { "deftype: ${title}": }
 }

spec/fixtures/test/manifests/absolutepath.pp

@@ -1,4 +1,4 @@
 # A helper class to test the ensure_resources function
-class test::ensure_resources($resource_type, $title_hash, $attributes_hash) {
+class test::ensure_resources( $resource_type, $title_hash, $attributes_hash ) {
   ensure_resources($resource_type, $title_hash, $attributes_hash)
 }

spec/fixtures/test/manifests/array.pp

@@ -2,13 +2,15 @@
 
 describe 'to_json_pretty' do
   it { is_expected.not_to eq(nil) }
-  it { is_expected.to run.with_params([]).and_return("[\n\n]") }
-  it { is_expected.to run.with_params(['one']).and_return("[\n  \"one\"\n]") }
-  it { is_expected.to run.with_params(%w[one two]).and_return("[\n  \"one\",\n  \"two\"\n]") }
-  it { is_expected.to run.with_params({}).and_return("{\n}") }
-  it { is_expected.to run.with_params('key' => 'value').and_return("{\n  \"key\": \"value\"\n}") }
+  it { is_expected.to run.with_params([]).and_return("[\n\n]\n") }
+  it { is_expected.to run.with_params(['one']).and_return("[\n  \"one\"\n]\n") }
+  it { is_expected.to run.with_params(%w[one two]).and_return("[\n  \"one\",\n  \"two\"\n]\n") }
+  it { is_expected.to run.with_params({}).and_return("{\n}\n") }
+  it { is_expected.to run.with_params('key' => 'value').and_return("{\n  \"key\": \"value\"\n}\n") }
   it {
     is_expected.to run.with_params('one' => { 'oneA' => 'A', 'oneB' => { 'oneB1' => '1', 'oneB2' => '2' } }, 'two' => %w[twoA twoB])
-                      .and_return("{\n  \"one\": {\n    \"oneA\": \"A\",\n    \"oneB\": {\n      \"oneB1\": \"1\",\n      \"oneB2\": \"2\"\n    }\n  },\n  \"two\": [\n    \"twoA\",\n    \"twoB\"\n  ]\n}") # rubocop:disable Metrics/LineLength : Unable to reduce line to required length
+                      .and_return("{\n  \"one\": {\n    \"oneA\": \"A\",\n    \"oneB\": {\n      \"oneB1\": \"1\",\n      \"oneB2\": \"2\"\n    }\n  },\n  \"two\": [\n    \"twoA\",\n    \"twoB\"\n  ]\n}\n") # rubocop:disable Metrics/LineLength : Unable to reduce line to required length
   }
+  it { is_expected.to run.with_params({ 'one' => '1', 'two' => nil }, true).and_return("{\n  \"one\": \"1\"\n}\n") }
+  it { is_expected.to run.with_params(['one', 'two', nil, 'three'], true).and_return("[\n  \"one\",\n  \"two\",\n  \"three\"\n]\n") }
 end

spec/fixtures/test/manifests/bool.pp

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
-  describe 'test::absolute_path', type: :class do
+  describe 'Stdlib::Compat::Absolute_path' do
     describe 'valid paths handling' do
       %w[
         C:/
@@ -20,9 +20,7 @@
         /var/ネット
       ].each do |value|
         describe value.inspect do
-          let(:params) { { value: value } }
-
-          it { is_expected.to compile }
+          it { is_expected.to allow_value(value) }
         end
       end
     end
@@ -38,9 +36,7 @@
           '',
         ].each do |value|
           describe value.inspect do
-            let(:params) { { value: value } }
-
-            it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Compat::Absolute_path}) }
+            it { is_expected.not_to allow_value(value) }
           end
         end
       end
@@ -59,9 +55,7 @@
           \var\ネット
         ].each do |value|
           describe value.inspect do
-            let(:params) { { value: value } }
-
-            it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Compat::Absolute_path}) }
+            it { is_expected.not_to allow_value(value) }
           end
         end
       end

spec/fixtures/test/manifests/deftype.pp

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
-  describe 'test::array', type: :class do
+  describe 'Stdlib::Compat::Array' do
     describe 'accepts arrays' do
       [
         [],
@@ -11,9 +11,7 @@
         [[]],
       ].each do |value|
         describe value.inspect do
-          let(:params) { { value: value } }
-
-          it { is_expected.to compile }
+          it { is_expected.to allow_value(value) }
         end
       end
     end
@@ -26,9 +24,7 @@
         {},
       ].each do |value|
         describe value.inspect do
-          let(:params) { { value: value } }
-
-          it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a Stdlib::Compat::Array}) }
+          it { is_expected.not_to allow_value(value) }
         end
       end
     end

spec/fixtures/test/manifests/ensure_resources.pp

@@ -1,16 +1,14 @@
 require 'spec_helper'
 
 if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
-  describe 'test::bool', type: :class do
+  describe 'Stdlib::Compat::Bool' do
     describe 'accepts booleans' do
       [
         true,
         false,
       ].each do |value|
         describe value.inspect do
-          let(:params) { { value: value } }
-
-          it { is_expected.to compile }
+          it { is_expected.to allow_value(value) }
         end
       end
     end
@@ -24,9 +22,7 @@
         'false',
       ].each do |value|
         describe value.inspect do
-          let(:params) { { value: value } }
-
-          it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a Stdlib::Compat::Bool}) }
+          it { is_expected.not_to allow_value(value) }
         end
       end
     end

spec/fixtures/test/manifests/filemode.pp

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
-  describe 'test::filemode', type: :class do
+  describe 'Stdlib::Filemode' do
     describe 'valid modes' do
       %w[
         0644
@@ -12,9 +12,7 @@
         0777
       ].each do |value|
         describe value.inspect do
-          let(:params) { { value: value } }
-
-          it { is_expected.to compile }
+          it { is_expected.to allow_value(value) }
         end
       end
     end
@@ -39,9 +37,7 @@
           '0649',
         ].each do |value|
           describe value.inspect do
-            let(:params) { { value: value } }
-
-            it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a match for Stdlib::Filemode}) }
+            it { is_expected.not_to allow_value(value) }
           end
         end
       end

spec/fixtures/test/manifests/float.pp

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
-  describe 'test::float', type: :class do
+  describe 'Stdlib::Compat::Float' do
     describe 'accepts floats' do
       [
         3.7,
@@ -10,19 +10,15 @@
         '-342.2315e-12',
       ].each do |value|
         describe value.inspect do
-          let(:params) { { value: value } }
-
-          it { is_expected.to compile }
+          it { is_expected.to allow_value(value) }
         end
       end
     end
 
     describe 'rejects other values' do
       [true, 'true', false, 'false', 'iAmAString', '1test', '1 test', 'test 1', 'test 1 test', {}, { 'key' => 'value' }, { 1 => 2 }, '', :undef, 'x', 3, '3', -3, '-3'].each do |value|
         describe value.inspect do
-          let(:params) { { value: value } }
-
-          it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects.*Float.*Pattern}) }
+          it { is_expected.not_to allow_value(value) }
         end
       end
     end

spec/fixtures/test/manifests/hash.pp

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 if Puppet::Util::Package.versioncmp(Puppet.version, '4.5.0') >= 0
-  describe 'test::hash', type: :class do
+  describe 'Stdlib::Compat::Hash' do
     describe 'accepts hashes' do
       [
         {},
@@ -10,9 +10,7 @@
         { '001' => 'helly' },
       ].each do |value|
         describe value.inspect do
-          let(:params) { { value: value } }
-
-          it { is_expected.to compile }
+          it { is_expected.to allow_value(value) }
         end
       end
     end
@@ -24,9 +22,7 @@
         [],
       ].each do |value|
         describe value.inspect do
-          let(:params) { { value: value } }
-
-          it { is_expected.to compile.and_raise_error(%r{parameter 'value' expects a Stdlib::Compat::Hash}) }
+          it { is_expected.not_to allow_value(value) }
         end
       end
     end