(CONT-801) Deprecate uriescape.rb

traylenator · May 23, 2023 · 799d608 · 799d608
1 parent c0c7ccb
commit 799d608
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb
@@ -15,8 +15,13 @@ module Puppet::Parser::Functions
     @return [String]
       a string that contains the converted value
 
+    > **Note:**  **Deprecated:** Starting Puppet 8, our Ruby version has upgraded to 3.2.
+    Therefore, its no longer possible to call URI.escape as it was deprecated by 2.7 and removed completely by 3+.
+    This function should be removed once Puppet 7 is no longer supported.
   DOC
   ) do |arguments|
+    raise(Puppet::ParseError, 'Puppet: This function is not available in Puppet 8. URI.escape no longer exists as of Ruby 3+.') if Puppet::Util::Package.versioncmp(Puppet.version, '8').positive?
+
     raise(Puppet::ParseError, "uriescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     value = arguments[0]

diff --git a/spec/functions/uriescape_spec.rb b/spec/functions/uriescape_spec.rb
@@ -39,5 +39,9 @@
       it { is_expected.to run.with_params(['one}', 'two']).and_return(['one%7D', 'two']) }
       it { is_expected.to run.with_params(['one}', 1, true, {}, 'two']).and_return(['one%7D', 1, true, {}, 'two']) }
     end
+  else
+    describe 'raising errors in Puppet 8' do
+      it { is_expected.to run.with_params([]).and_raise_error(Puppet::ParseError, %r{This function is not available in Puppet 8. URI.escape no longer exists as of Ruby 3+.}) }
+    end
   end
 end