Project

yn

0.0
No release in over a year
Parse yes/no like values. Port of https://github.com/sindresorhus/yn.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 2.0
~> 2.16
~> 0.51
~> 0.12
~> 10.0
~> 3.0
~> 0.77
~> 0.17
~> 0.9
~> 0.0.7
~> 0.9
 Project Readme

Yn

Gem Version Build Status Maintainability Test Coverage Security Inline docs

Parse yes/no like values

Useful for validating answers of a CLI prompt.


The following case-insensitive values are recognized:

'y', 'yes', 'true', true, '1', 1, 'n', 'no', 'false', false, '0', 0, 'on', 'off'

Enable lenient mode to gracefully handle typos.

Installation

Add this line to your application's Gemfile:

gem 'yn'

And then execute:

$ bundle

Or install it yourself as:

$ gem install yn

Usage

require 'yn'

Yn.parse('y')
# => true

Yn.parse('NO')
# => false

Yn.parse(true)
# => true

Yn.parse('abomasum')
# => nil

Yn.parse('abomasum', default: false)
# => false

Yn.parse('mo', lenient: true)
# => false

Unrecognized values return nil.

API

Yn.parse(input, options?)

input

Type: unknown

Value that should be converted.

options

Type: hash

lenient

Type: boolean
Default: false

Use a key distance-based score to leniently accept typos of yes and no.

default

Type: boolean
Default: nil

Default value if no match was found.

Development

After checking out the repo, run bin/setup to install dependencies, configure git hooks and create support files.

You can also run bin/console for an interactive prompt that will allow you to experiment.

The health and maintainability of the codebase is ensured through a set of Rake tasks to test, lint and audit the gem for security vulnerabilities and documentation:

rake bundle:audit          # Checks for vulnerable versions of gems 
rake qa                    # Test, lint and perform security and documentation audits
rake rubocop               # Lint the codebase with RuboCop
rake rubocop:auto_correct  # Auto-correct RuboCop offenses
rake spec                  # Run RSpec code examples
rake verify_measurements   # Verify that yardstick coverage is at least 100%
rake yard                  # Generate YARD Documentation
rake yard:junk             # Check the junk in your YARD Documentation
rake yardstick_measure     # Measure docs in lib/**/*.rb with yardstick

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/wilsonsilva/yn. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Credits

This is a port of Sindre Sorhus JavaScript's yn. I'm a big fan of his work!

Code of Conduct

Everyone interacting in the Yn project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.