Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revert "(CONT-801) Deprecate uriescape.rb" #1402

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Revert "(CONT-801) Deprecate uriescape.rb" #1402

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6da5a2f
Revert "(CONT-801) Deprecate uriescape.rb"
traylenator Oct 17, 2023
35c325d
drop redundant comments
traylenator Oct 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 0 additions & 7 deletions lib/puppet/parser/functions/uriescape.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
require 'uri'
#
# uriescape.rb
# Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085.
# URI.escape has been fully removed as of Ruby 3. Therefore, it will not work as it stand on Puppet 8. Consider deprecating or updating this function.
#
module Puppet::Parser::Functions
newfunction(:uriescape, type: :rvalue, doc: <<-DOC
Expand All @@ -15,13 +13,8 @@ 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]
Expand Down
4 changes: 0 additions & 4 deletions spec/functions/uriescape_spec.rb
View file
Open in desktop
traylenator marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
it { is_expected.not_to be_nil }
it { is_expected.to run.with_params.and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i) }

it {

Check warning on line 12 in spec/functions/uriescape_spec.rb

View workflow job for this annotation

GitHub Actions / Spec / Spec tests (Puppet: ~> 7.24, Ruby Ver: 2.7) 

uriescape signature validation is expected to run uriescape("", "") and raise an Puppet::ParseError with the message matching /wrong number of arguments/i

Failure/Error: expect(subject).to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i)
  expected uriescape("", "") to have raised Puppet::ParseError matching /wrong number of arguments/i instead of returning ""
pending('Current implementation ignores parameters after the first.')
expect(subject).to run.with_params('', '').and_raise_error(Puppet::ParseError, %r{wrong number of arguments}i)
}
Expand Down Expand Up @@ -39,9 +39,5 @@
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
Loading