Update stdlib and concat to 6.1.0 both

[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / functions / deprecation.rb

diff --git a/3rdparty/modules/stdlib/lib/puppet/functions/deprecation.rb b/3rdparty/modules/stdlib/lib/puppet/functions/deprecation.rb
index 39d9bc7..2f6b0c0 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/functions/deprecation.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/functions/deprecation.rb
@@ -1,14 +1,23 @@
-# Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method  It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning)  *Type*: String, String.
+#   Function to print deprecation warnings, Logs a warning once for a given key.
+#
+# The uniqueness key - can appear once.
+# The msg is the message text including any positional information that is formatted by the
+# user/caller of the method.
+# It is affected by the puppet setting 'strict', which can be set to :error
+# (outputs as an error message), :off (no message / error is displayed) and :warning
+# (default, outputs a warning)  *Type*: String, String.
 #
-
 Puppet::Functions.create_function(:deprecation) do
+  # @param key
+  # @param  message
+  # @return deprecated warnings
   dispatch :deprecation do
     param 'String', :key
     param 'String', :message
   end
 
   def deprecation(key, message)
-    if defined? Puppet::Pops::PuppetStack.stacktrace()
+    if defined? Puppet::Pops::PuppetStack.stacktrace
       stacktrace = Puppet::Pops::PuppetStack.stacktrace()
       file = stacktrace[0]
       line = stacktrace[1]
@@ -16,10 +25,10 @@ Puppet::Functions.create_function(:deprecation) do
     end
     # depending on configuration setting of strict
     case Puppet.settings[:strict]
-    when :off
+    when :off # rubocop:disable Lint/EmptyWhen : Is required to prevent false errors
       # do nothing
     when :error
-      fail("deprecation. #{key}. #{message}")
+      raise("deprecation. #{key}. #{message}")
     else
       unless ENV['STDLIB_LOG_DEPRECATIONS'] == 'false'
         Puppet.deprecation_warning(message, key)