Skip to content

Added the regexpescape function. #624

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.

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

Merged
merged 1 commit into from
Jul 26, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions lib/puppet/parser/functions/regexpescape.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
#
# regexpescape.rb
#
module Puppet::Parser::Functions
newfunction(:regexpescape, :type => :rvalue, :doc => <<-EOS
Regexp escape a string or array of strings.
Requires either a single string or an array as an input.
EOS
) do |arguments| # rubocop:disable Style/ClosingParenthesisIndentation
raise(Puppet::ParseError, 'regexpescape(): Wrong number of arguments ' \
"given (#{arguments.size} for 1)") if arguments.empty?

value = arguments[0]

unless value.is_a?(Array) || value.is_a?(String)
raise(Puppet::ParseError, 'regexpescape(): Requires either ' \
'array or string to work with')
end

result = if value.is_a?(Array)
# Numbers in Puppet are often string-encoded which is troublesome ...
value.collect { |i| i.is_a?(String) ? Regexp.escape(i) : i }
else
Regexp.escape(value)
end

return result
end
end

# vim: set ts=2 sw=2 et :
36 changes: 36 additions & 0 deletions spec/functions/regexpescape_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
require 'spec_helper'

describe 'regexpescape' do
describe 'signature validation' do
it { is_expected.not_to eq(nil) }
it { is_expected.to run.with_params().and_raise_error(Puppet::ParseError, /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, /wrong number of arguments/i)
}
it { is_expected.to run.with_params(1).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) }
it { is_expected.to run.with_params({}).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) }
it { is_expected.to run.with_params(true).and_raise_error(Puppet::ParseError, /Requires either array or string to work/) }
end

describe 'handling normal strings' do
it 'should call ruby\'s Regexp.escape function' do
Regexp.expects(:escape).with('regexp_string').returns('escaped_regexp_string').once
is_expected.to run.with_params('regexp_string').and_return('escaped_regexp_string')
end
end

describe 'handling classes derived from String' do
it 'should call ruby\'s Regexp.escape function' do
regexp_string = AlsoString.new('regexp_string')
Regexp.expects(:escape).with(regexp_string).returns('escaped_regexp_string').once
is_expected.to run.with_params(regexp_string).and_return("escaped_regexp_string")
end
end

describe 'strings in arrays handling' do
it { is_expected.to run.with_params([]).and_return([]) }
it { is_expected.to run.with_params(['one*', "two"]).and_return(['one\*', "two"]) }
it { is_expected.to run.with_params(['one*', 1, true, {}, "two"]).and_return(['one\*', 1, true, {}, "two"]) }
end
end