palindex is a sample Ruby gem created in Learn Enough Ruby to Be Dangerous by Michael Hartl.
To install palindex, add this line to your application's Gemfile:
gem 'palindex'
Then install as follows:
$ bundle install
Or install it directly using gem:
$ gem install palindex
palindex adds a palindrome? method to the String class, and can be used as follows:
$ irb
>> require 'palindex'
>> "honey badger".palindrome?
=> false
>> "deified".palindrome?
=> true
>> "Able was I, ere I saw Elba.".palindrome?
=> true
>> phrase = "Madam, I'm Adam."
>> phrase.palindrome?
=> true
After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/cdrrazan/palindex. 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.
The gem is available as open source under the terms of the MIT License.
Everyone interacting in the Palindex project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.