Module: Yn

Defined in:
lib/yn.rb,
lib/yn/lenient.rb,
lib/yn/version.rb

Overview

Encapsulates all the code of the gem in a meaningful namespace.

Constant Summary collapse

VERSION = 
'1.0.0'.freeze

Class Method Summary collapse

Class Method Details

.parse(input, lenient: false, default: nil) ⇒ Boolean|nil

Parses yes/no like values

and nil or default otherwise.

Examples:

Parsing yes-like values

Yn.parse('y') # => true
Yn.parse('yes') # => true
Yn.parse('Yes') # => true
Yn.parse('YES') # => true
Yn.parse('1') # => true
Yn.parse(1) # => true
Yn.parse('on') # => true
Yn.parse('true') # => true
Yn.parse(true) # => true

Parsing no-like values

Yn.parse('n') # => false
Yn.parse('no') # => false
Yn.parse('No') # => false
Yn.parse('NO') # => false
Yn.parse('0') # => false
Yn.parse(0) # => false
Yn.parse('off') # => false
Yn.parse('false') # => false
Yn.parse(false) # => false

Allowing typos in the words yes or no

Yn.parse('y7s', lenient: true) # => true
Yn.parse('tes', lenient: true) # => true
Yn.parse('yes', lenient: true) # => true
Yn.parse('mo', lenient: true) # => false
Yn.parse('nl', lenient: true) # => false
Yn.parse('no', lenient: true) # => false
Yn.parse('something-else', lenient: true) # => nil

Using a default value

Yn.parse('falso', default: false) # => false
Yn.parse('verdadeiro', default: true) # => true

Parameters:

  • input (Object) —

    The input object or string to be converted

  • lenient (Object) (defaults to: false) —

    Whether typos in words yes and no are allowed or not

  • default (Object) (defaults to: nil) —

    Value returned when the input isn’t considered yes or no

Returns:

  • (Boolean|nil) —

    true if the input is a yes-like value, false if the input is a no-like value



52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/yn.rb', line 52

def self.parse(input, lenient: false, default: nil)
  input = input.to_s.strip

  unless [NilClass, TrueClass, FalseClass].include?(default.class)
    raise ArgumentError, "Expected the 'default' option to be nil or a boolean, got #{default.class}"
  end

  return true if /^(?:y|yes|true|1|on)$/i.match?(input)
  return false if /^(?:n|no|false|0|off)$/i.match?(input)

  return Lenient.new.call(input, default) if lenient == true

  default
end