deprecate join()

Author: pmcmaw

README.md

@@ -1635,6 +1635,8 @@ Returns `true` if the variable passed to this function is a string.
 
 #### `join`
 
+**Deprecated. Puppet 5.5.0 has introduced an inbuilt `join` function, that 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.

lib/puppet/parser/functions/join.rb

@@ -13,6 +13,9 @@ module Puppet::Parser::Functions
     DOC
              ) do |arguments|
 
+    function_deprecation([:join, 'This method is deprecated, this function is now shipped in puppet in versions 5.5.0 and later.
+                           For more information please see [puppet 5.5.0 release notes|https://puppet.com/docs/puppet/5.5/release_notes.html#new-features].'])
+
     # 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?
 

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('') }