nth v1.0.4

nth

Indexing arrays is a touchy subject. Some morons think it should be done based on offset like in that outdated language from nearly 50 years ago (C). The rest of us understand that it should really be based on ordinal numbers. This library adds the capability to use ordinal numbers for extra readability. Don't worry, 0-indexers, you can keep believing the earth is flat, this library won't force you to use ordinal numbers.

Check out the following examples of the increase in readability!

my_array = [:first, :second, :third]
my_array[1]

The above example read aloud says "the second element of my_array", but it's using the numeral 1, but it's written right to left.

my_array = [:first, :second, :third]
my_array[2.nd]

The above example read aloud says "the second element of my_array", and it's using the numeral 2, but it's written right to left. This way is clearly better.

my_array = [:first, :second, :third]
2.nd.element_of my_array

The above example read aloud says "the second element of my_array", and it's written left to right. This way is obviously the most superior.

Installation

Add this to your application's shard.yml:

dependencies:
  nth:
    github: willamin/nth

Usage

require "nth"

Integers get a few new methods added: .st, .nd, .rd, .th. Exceptions are raised when the methods are used on the wrong numbers, because I'm a bit of stickler Meeseeks. Integers also get the methods .element_of(Array), and in(Array) which returns — drumroll please — the element of the array corresponding with the integer. Big surprise there.

Development

Make a failing test that shows the feature you'd like the library to have. Fix the test.

Contributing

  1. Fork it ( https://github.com/willamin/nth/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

Repository

nth

Owner
Statistic
  • 1
  • 0
  • 4
  • 1
  • 0
  • about 7 years ago
  • September 26, 2017
License

MIT License

Links
Synced at

Sat, 21 Dec 2024 19:51:55 GMT

Languages