Conditionalize specs, make readme deprecations consistent

The dig() deprecation message is clear and applies to these functions as
well. Also linked to the documentation instead of the release notes.

Author: hunner

README.md

@@ -1163,7 +1163,7 @@ 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).**
+**Deprecated:** This function has been replaced with a built-in [`empty`](https://docs.puppet.com/puppet/latest/function.html#empty) function as of Puppet 5.5.0.
 
 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.
 
@@ -1276,7 +1276,7 @@ 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).**
+**Deprecated:** This function has been replaced with a built-in [`flatten`](https://docs.puppet.com/puppet/latest/function.html#flatten) function as of Puppet 5.5.0.
 
 Flattens deeply nested arrays and returns a single flat array as a result.
 
@@ -1635,7 +1635,7 @@ 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).**
+**Deprecated:** This function has been replaced with a built-in [`join`](https://docs.puppet.com/puppet/latest/function.html#join) function as of Puppet 5.5.0.
 
 Joins an array into a string using a separator. For example, `join(['a','b','c'], ",")` results in: "a,b,c".
 
@@ -1653,15 +1653,15 @@ 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).**
+**Deprecated:** This function has been replaced with a built-in [`keys`](https://docs.puppet.com/puppet/latest/function.html#keys) function as of Puppet 5.5.0.
 
 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).**
+**Deprecated:** This function has been replaced with a built-in [`length`](https://docs.puppet.com/puppet/latest/function.html#length) function as of Puppet 5.5.0.
 
 Returns the length of a given string, array or hash. Replaces the deprecated `size()` function.
 
@@ -2784,7 +2784,7 @@ 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).**
+**Deprecated:** This function has been replaced with a built-in [`values`](https://docs.puppet.com/puppet/latest/function.html#values) function as of Puppet 5.5.0.
 
 Returns the values of a given hash.
 

lib/puppet/functions/length.rb

@@ -11,5 +11,4 @@ def length(value)
     end
     result
   end
-  Puppet.deprecation_warning('The length function 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.')
 end

lib/puppet/parser/functions/empty.rb

@@ -7,8 +7,6 @@ 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,8 +14,6 @@ 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,8 +13,6 @@ 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,8 +7,6 @@ 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,8 +20,6 @@ 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/empty_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper_acceptance'
 
-describe 'empty function' do
+describe 'empty function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do
   describe 'success' do
     pp1 = <<-DOC
       $a = ''

spec/acceptance/flatten_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper_acceptance'
 
-describe 'flatten function' do
+describe 'flatten function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do
   describe 'success' do
     pp1 = <<-DOC
       $a = ["a","b",["c",["d","e"],"f","g"]]

spec/acceptance/join_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper_acceptance'
 
-describe 'join function' do
+describe 'join function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do
   describe 'success' do
     pp = <<-DOC
       $a = ['aaa','bbb','ccc']

spec/acceptance/keys_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper_acceptance'
 
-describe 'keys function' do
+describe 'keys function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do
   describe 'success' do
     pp = <<-DOC
       $a = {'aaa'=>'bbb','ccc'=>'ddd'}

spec/acceptance/values_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper_acceptance'
 
-describe 'values function' do
+describe 'values function', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do
   describe 'success' do
     pp1 = <<-DOC
       $arg = {
@@ -23,8 +23,7 @@
       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}) 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'
+      expect(apply_manifest(pp2, :expect_failures => true).stderr).to match(%r{Requires hash})
     end
   end
 end

spec/functions/empty_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe 'empty' do
+describe 'empty', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do
   it { is_expected.not_to eq(nil) }
-  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) }
   it {
     pending('Current implementation ignores parameters after the first.')
     is_expected.to run.with_params('one', 'two').and_raise_error(Puppet::ParseError)
@@ -19,21 +19,4 @@
 
   it { is_expected.to run.with_params({}).and_return(true) }
   it { is_expected.to run.with_params('key' => 'value').and_return(false) }
-
-  context 'with deprecation warning' do
-    after(:each) do
-      ENV.delete('STDLIB_LOG_DEPRECATIONS')
-    end
-    # Checking for deprecation warning, which should only be provoked when the env variable for it is set.
-    it 'displays a single deprecation' do
-      ENV['STDLIB_LOG_DEPRECATIONS'] = 'true'
-      scope.expects(:warning).with(includes('This method is deprecated'))
-      is_expected.to run.with_params(0).and_return(false)
-    end
-    it 'displays no warning for deprecation' do
-      ENV['STDLIB_LOG_DEPRECATIONS'] = 'false'
-      scope.expects(:warning).with(includes('This method is deprecated')).never
-      is_expected.to run.with_params(0).and_return(false)
-    end
-  end
 end

spec/functions/flatten_spec.rb

@@ -1,33 +1,15 @@
 require 'spec_helper'
 
-# rubocop:disable Style/WordArray, Layout/SpaceAfterComma
-describe 'flatten' do
+describe 'flatten', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do
   it { is_expected.not_to eq(nil) }
-  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_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_return([]) }
   it { is_expected.to run.with_params(['one']).and_return(['one']) }
   it { is_expected.to run.with_params([['one']]).and_return(['one']) }
   it { is_expected.to run.with_params(%w[a b c d e f g]).and_return(%w[a b c d e f g]) }
   it { is_expected.to run.with_params([['a', 'b', ['c', %w[d e], 'f', 'g']]]).and_return(%w[a b c d e f g]) }
   it { is_expected.to run.with_params(['ã', 'β', ['ĉ', %w[đ ẽ ƒ ġ]]]).and_return(%w[ã β ĉ đ ẽ ƒ ġ]) }
-
-  context 'with deprecation warning' do
-    after(:each) do
-      ENV.delete('STDLIB_LOG_DEPRECATIONS')
-    end
-    # Checking for deprecation warning, which should only be provoked when the env variable for it is set.
-    it 'displays a single deprecation' do
-      ENV['STDLIB_LOG_DEPRECATIONS'] = 'true'
-      scope.expects(:warning).with(includes('This method is deprecated'))
-      is_expected.to run.with_params(['a', ['b', ['c']]]).and_return(['a','b','c'])
-    end
-    it 'displays no warning for deprecation' do
-      ENV['STDLIB_LOG_DEPRECATIONS'] = 'false'
-      scope.expects(:warning).with(includes('This method is deprecated')).never
-      is_expected.to run.with_params(['a', ['b', ['c']]]).and_return(['a','b','c'])
-    end
-  end
 end

spec/functions/join_spec.rb

@@ -1,14 +1,14 @@
 require 'spec_helper'
 
-describe 'join' do
+describe 'join', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 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) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) }
   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}) } 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('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([]).and_return('') }
   it { is_expected.to run.with_params([], ':').and_return('') }
@@ -17,21 +17,4 @@
   it { is_expected.to run.with_params(%w[one two three]).and_return('onetwothree') }
   it { is_expected.to run.with_params(%w[one two three], ':').and_return('one:two:three') }
   it { is_expected.to run.with_params(%w[ōŋể ŧשợ ţђŕẽё], ':').and_return('ōŋể:ŧשợ:ţђŕẽё') }
-
-  context 'with deprecation warning' do
-    after(:each) do
-      ENV.delete('STDLIB_LOG_DEPRECATIONS')
-    end
-    # Checking for deprecation warning, which should only be provoked when the env variable for it is set.
-    it 'displays a single deprecation' do
-      ENV['STDLIB_LOG_DEPRECATIONS'] = 'true'
-      scope.expects(:warning).with(includes('This method is deprecated'))
-      is_expected.to run.with_params([]).and_return('')
-    end
-    it 'displays no warning for deprecation' do
-      ENV['STDLIB_LOG_DEPRECATIONS'] = 'false'
-      scope.expects(:warning).with(includes('This method is deprecated')).never
-      is_expected.to run.with_params([]).and_return('')
-    end
-  end
 end

spec/functions/keys_spec.rb

@@ -1,44 +1,24 @@
 require 'spec_helper'
 
-describe 'keys' do
+describe 'keys', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 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) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) }
   it {
     pending('Current implementation ignores parameters after the first.')
     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{Requires hash to work with}) } if Puppet.version < '5.5.0'
-  it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0'
-  it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params('').and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) }
+  it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) }
+  it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{Requires hash to work with}) }
   it { is_expected.to run.with_params({}).and_return([]) }
   it { is_expected.to run.with_params('key' => 'value').and_return(['key']) }
-
-  if Puppet.version < '5.5.0'
-    it 'returns the array of keys' do
-      result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }])
-      expect(result).to match_array(%w[key1 key2])
-    end
-
-    it 'runs with UTF8 and double byte characters', :if => Puppet.version < '5.5.0' do
-      result = subject.call([{ 'ҝểү' => '√ẳŀμệ', 'キー' => '値' }])
-      expect(result).to match_array(%w[ҝểү キー])
-    end
+  it 'returns the array of keys' do
+    result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }])
+    expect(result).to match_array(%w[key1 key2])
   end
 
-  context 'with deprecation warning' do
-    after(:each) do
-      ENV.delete('STDLIB_LOG_DEPRECATIONS')
-    end
-    # Checking for deprecation warning, which should only be provoked when the env variable for it is set.
-    it 'displays a single deprecation' do
-      ENV['STDLIB_LOG_DEPRECATIONS'] = 'true'
-      scope.expects(:warning).with(includes('This method is deprecated'))
-      is_expected.to run.with_params({}).and_return([])
-    end
-    it 'displays no warning for deprecation' do
-      ENV['STDLIB_LOG_DEPRECATIONS'] = 'false'
-      scope.expects(:warning).with(includes('This method is deprecated')).never
-      is_expected.to run.with_params({}).and_return([])
-    end
+  it 'runs with UTF8 and double byte characters' do
+    result = subject.call([{ 'ҝểү' => '√ẳŀμệ', 'キー' => '値' }])
+    expect(result).to match_array(%w[ҝểү キー])
   end
 end

spec/functions/length_spec.rb

@@ -1,11 +1,11 @@
 require 'spec_helper'
 
-describe 'length' do
+describe 'length', :if => Puppet::Util::Package.versioncmp(Puppet.version, '5.5.0') < 0 do
   it { is_expected.not_to eq(nil) }
   it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'length' expects 1 argument, got none}) }
   it { is_expected.to run.with_params([], 'extra').and_raise_error(ArgumentError, %r{'length' expects 1 argument, got 2}) }
-  it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Integer}) } if Puppet.version < '5.5.0'
-  it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Boolean}) } if Puppet.version < '5.5.0'
+  it { is_expected.to run.with_params(1).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Integer}) }
+  it { is_expected.to run.with_params(true).and_raise_error(ArgumentError, %r{expects a value of type String, Array, or Hash, got Boolean}) }
   it { is_expected.to run.with_params('1').and_return(1) }
   it { is_expected.to run.with_params('1.0').and_return(3) }
   it { is_expected.to run.with_params([]).and_return(0) }