Deprecating functions that have been ported to Puppet 5.5.0.

Author: pmcmaw

README.md

@@ -1163,6 +1163,8 @@ Converts the case of a string or of all strings in an array to lowercase.
 
 #### `empty`
 
+**Deprecated. Puppet 5.5.0 has introduced a built in `empty` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).**
+
 Returns `true` if the argument is an array or hash that contains no elements, or an empty string. Returns `false` when the argument is a numerical value.
 
 *Type*: rvalue.
@@ -1274,6 +1276,8 @@ fact('vmware."VRA.version"')
 
 #### `flatten`
 
+**Deprecated. Puppet 5.5.0 has introduced a built in `flatten` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).**
+
 Flattens deeply nested arrays and returns a single flat array as a result.
 
 For example, `flatten(['a', ['b', ['c']]])` returns ['a','b','c'].
@@ -1631,6 +1635,8 @@ Returns `true` if the variable passed to this function is a string.
 
 #### `join`
 
+**Deprecated. Puppet 5.5.0 has introduced a built in `join` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).**
+
 Joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c".
 
 *Type*: rvalue.
@@ -1647,12 +1653,16 @@ For example, `join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")` results in ["a i
 
 #### `keys`
 
+**Deprecated. Puppet 5.5.0 has introduced a built in `keys` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).**
+
 Returns the keys of a hash as an array.
 
 *Type*: rvalue.
 
 #### `length`
 
+**Deprecated. Puppet 5.5.0 has introduced a built in `length` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).**
+
 Returns the length of a given string, array or hash. Replaces the deprecated `size()` function.
 
 *Type*: rvalue.
@@ -2774,6 +2784,8 @@ validate_x509_rsa_key_pair($cert, $key)
 
 #### `values`
 
+**Deprecated. Puppet 5.5.0 has introduced a built in `values` function, which will take precedence over the stdlib function. See [Puppet 5.5.0 Release Notes](https://puppet.com/docs/puppet/5.5/release_notes.html#new-features).**
+
 Returns the values of a given hash.
 
 For example, given `$hash = {'a'=1, 'b'=2, 'c'=3} values($hash)` returns [1,2,3].

lib/puppet/parser/functions/empty.rb

@@ -7,6 +7,8 @@ module Puppet::Parser::Functions
   DOC
              ) do |arguments|
 
+    function_deprecation([:empty, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.'])
+
     raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
     value = arguments[0]
 

lib/puppet/parser/functions/flatten.rb

@@ -14,6 +14,8 @@ module Puppet::Parser::Functions
   DOC
              ) do |arguments|
 
+    function_deprecation([:flatten, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes'])
+
     raise(Puppet::ParseError, "flatten(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1
 
     array = arguments[0]

lib/puppet/parser/functions/join.rb

@@ -13,6 +13,8 @@ module Puppet::Parser::Functions
     DOC
              ) do |arguments|
 
+    function_deprecation([:join, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes'])
+
     # Technically we support two arguments but only first is mandatory ...
     raise(Puppet::ParseError, "join(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 

lib/puppet/parser/functions/keys.rb

@@ -7,6 +7,8 @@ module Puppet::Parser::Functions
     DOC
              ) do |arguments|
 
+    function_deprecation([:keys, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.'])
+
     raise(Puppet::ParseError, "keys(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     hash = arguments[0]

lib/puppet/parser/functions/values.rb

@@ -20,6 +20,8 @@ module Puppet::Parser::Functions
     DOC
              ) do |arguments|
 
+    function_deprecation([:values, 'This method is deprecated, this function is now shipped with Puppet in versions 5.5.0 and later. For more information please see Puppet 5.5.0 Release Notes.'])
+
     raise(Puppet::ParseError, "values(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     hash = arguments[0]

spec/acceptance/values_spec.rb

@@ -23,7 +23,8 @@
       notice(inline_template('<%= @output.inspect %>'))
     DOC
     it 'handles non-hash arguments' do
-      expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{Requires hash})
+      expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{Requires hash}) if return_puppet_version < '5.5.0'
+      expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{expects a Hash value}) if return_puppet_version >= '5.5.0'
     end
   end
 end

spec/functions/empty_spec.rb

@@ -2,7 +2,7 @@
 
 describe 'empty' do
   it { is_expected.not_to eq(nil) }
-  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) }
+  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0'
   it {
     pending('Current implementation ignores parameters after the first.')
     is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError)

spec/functions/flatten_spec.rb

@@ -2,10 +2,10 @@
 
 describe 'flatten' do
   it { is_expected.not_to eq(nil) }
-  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) }
-  it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError) }
-  it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) }
-  it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) }
+  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params([], []).and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError) } if Puppet.version < '5.5.0'
   it { is_expected.to run.with_params([]).and_return([]) }
   it { is_expected.to run.with_params(['one']).and_return(['one']) }
   it { is_expected.to run.with_params([['one']]).and_return(['one']) }

spec/functions/join_spec.rb

@@ -2,13 +2,13 @@
 
 describe 'join' do
   it { is_expected.not_to eq(nil) }
-  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) }
+  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) } if Puppet.version < '5.5.0'
   it {
     pending('Current implementation ignores parameters after the second.')
     is_expected.to run.with_params([], '', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i)
   }
-  it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Requires array to work with}) }
-  it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{Requires string to work with}) }
+  it { is_expected.to run.with_params('one').and_raise_error(Puppet::ParseError, %r{Requires array to work with}) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params([], 2).and_raise_error(Puppet::ParseError, %r{Requires string to work with}) } if Puppet.version < '5.5.0'
 
   it { is_expected.to run.with_params([]).and_return('') }
   it { is_expected.to run.with_params([], ':').and_return('') }