psychoslave / englishest

A Ruby gem which allows a more literate coding style
MIT License
0 stars 0 forks source link

Englishest

In a nutshell, with this gem enabled you can now spell <=> as trichotomize, and so on.

This gem aims to provides alternative ways to utter Ruby code, simply defining synonyms for miscellaneous terms, especially offering full word counterpart to ideograms/logograms such as the so called spaceship operator.

The name of the gem is of course a pun: a library which provides ability to utter code which is closer to a voiceable English obviously ought to do it so through an obvious transgression of this language usual rules on superlatives.

Installation

Add this line to your application's Gemfile:

gem 'englishest'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install englishest

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at [https://github.com/psychoslave/englishest].

License

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

References

Resources consulted while hacking this gem: