Module: Xqsr3::StringUtilities::QuoteIf

Included in:

String

Defined in:

lib/xqsr3/string_utilities/quote_if.rb

Overview

+include+-able module that provides ::quote_if and #quote_if methods

Class Method Summary

• .quote_if(s, **options) ⇒ Object

  Converts a string to a quoted form if necessary.

Instance Method Summary

• #quote_if(**options) ⇒ Object

  Converts the instance to a quoted form if necessary.

Class Method Details

.quote_if(s, **options) ⇒ Object

Converts a string to a quoted form if necessary

Signature

• Parameters:

  • s (+String+) The string to be evaluated;
  • options (+Hash+) Options that control the behaviour of the method;

• Options:

  • :quotes (+String+, Array) A string that is used as the opening and closing quotes, or an array whose first two elements are used as the opening and closing quotes. Defaults to '"'
  • :quotables (+String+, Array, Regexp) A string representing the quotable character, or an array containing the quotable characters, or a regular expression that determines by match whether the string should be quoted. Defaults to the regular expression /\s/

# File 'lib/xqsr3/string_utilities/quote_if.rb', line 101

def self.quote_if s, **options

  QuoteIf_Helper_.string_quote_if_array_ s, options
end

Instance Method Details

#quote_if(**options) ⇒ Object

Converts the instance to a quoted form if necessary

See Xqsr3::StringUtilities::QuoteIf::quite_if() for options

# File 'lib/xqsr3/string_utilities/quote_if.rb', line 109

def quote_if **options

  QuoteIf_Helper_.string_quote_if_array_ self, options
end