(PUP-11552) Pass ERB arguments as keywords

[ekohl]

On Ruby 3.1 passing the arguments as positional arguments raises warnings:

warning: Passing safe_level with the 2nd argument of ERB.new is deprecated. Do not use it, and specify other arguments as keyword arguments.
warning: Passing trim_mode with the 3rd argument of ERB.new is deprecated. Use keyword argument like ERB.new(str, trim_mode: ...) instead.

However, on Ruby < 2.7 passing as keyword arguments is not allowed. This is why a conditional with RUBY_VERSION is used.

I must admit I have not tested my changes yet and am relying on CI to tell me now.

[puppetlabs-jenkins]

Can one of the admins verify this patch?

[ekohl]

I was unsure about a convention for ' vs " in the codebase. It looks like it's often " but not always.

[ekohl]

This is now green. It avoids warnings on Ruby 3.1, which in itself isn't in CI, but since Ruby 2.5 - 3.0 is tested all branches should be covered.

[joshcooper]

Thanks @ekohl!

My only concern is whether we're calling RUBY_VERSION >= "2.7" in a file that doesn't have the frozen string literal pragma and creating lots of temporary objects? One thought is to define a create_erb method in Puppet::Util

if RUBY_VERSION >= "2.7"
  def create_erb(content)
    ERB.new(content, trim_mode: '-')
  end
else
  def self.create_erb(content)
    ERB.new(content, 0, "-")
  end
end
module_function :create_erb

And then just call that method, passing in the ERB content:

Puppet::Util.create_erb(Puppet::FileSystem.read(@file, :encoding => 'utf-8'))

[ekohl]

Oh, that's more elegant. Until now I've often modified scripts rather than long running daemons. I also discovered the trim_mode keyword was introduced in Ruby 2.6, not 2.7. I'll also modify that.

[ekohl]

And it's green now.

[ekohl]

@joshcooper mind taking another look?

[joshcooper]

Thanks for your contribution @ekohl! I verified this fixes all of the ERB keyword test failures on Ruby 3.1. There are a few unrelated failures that should be resolved once we start on this epic https://tickets.puppetlabs.com/browse/PUP-11544

[ekohl]

There are a few unrelated failures

Which ones? I run Puppet on Ruby 3.1 and haven't seen them. On the Facter side I opened puppetlabs/facter#2496 but didn't see any on the Puppet side.

[joshcooper]

There are a few unrelated failures

Ah sorry I mean there are still some failures when running puppet rspec tests, which should get fixed in https://tickets.puppetlabs.com/browse/PUP-11406

[ekohl]

Ah, sounds like errors in the test suite which you don't notice at runtime. Still, looking forward to official Ruby 3.1 support.