Awesome
NOTICE: This project is dead, feel free to take the name on rubygems.
time-lord
time-lord
is a gem that gives you more human like expressions for time and space math.
Underneath the covers time-lord
gives you single purpose objects for handling the more complex parts of Time & Space.
Specifically conversion, periods between two points, and scaling.
Examples
In time-lord
you have Period objects:
1.hour.ago.class #=> <TimeLord::Period @beginning=2013-03-03 23:44:59 -0800, @ending=2013-03-04 00:44:59 -0800>
Periods, if forced into strings or integers, represent the number of seconds between the two points
1.hour.ago.to_i #=> -3600
You can also specify periods from other periods:
1.hour.from(1.day.ago) #=>
1.hour.till(100.years.from_now) #=>
Obviously Periods act a lot like a Range and can be coerced into one:
1.hour.ago.to_range #=> 1362383339..1362386939
You may have noticed the negative integer from Period#to_i
.
This represents the period beginning before the ending.
The reverse comes from using Period#from_now
:
1.hour.from_now.to_i #=> 3600
Periods also have a special Period#to_words
method:
1.hour.ago.to_words #=> "1 hour ago"
200.minutes.ago.to_words #=> "3 hours ago"
Of course you can also do fun Time math:
Time.now #=> 2013-03-04 00:55:49 -0800
Time.now - 2.hours #=> 2013-03-03 22:55:50 -0800
Time is fun.
Installing
Requirements
- A blue telephone box (optional)
Like any other gem you can install it via the gem
command:
$ gem install time-lord
Although I suggest using bundler
:
gem 'time-lord', '~> 1.0'
Testing
To make sure you did everything right, just do the following:
$ ruby -e "1.hour.ago.to_words"
> 1 hour ago
Issues & Documentation
Absolutely feel free to contribute, please!
Changelog
1.1.0
- Adding
Integer#from()
andInteger#till()
to calculate both points in a period easily. - The Coverall guys fixed up my setup.
- Cleaned up the readme
- Added and fixed a bug that dealt with month exactness
- Documented a whole hell of a lot
1.0.0
- Initial release
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Credits
- Simon Hørup Eskildsen for the original work on time-ago-in-words gem
- Henrik Enggaard for very useful commits pre-1.0
- James Larkby-Lahet for very useful commits pre-1.0
- Nick Merwin for unfucking the coveralls setup
- Christian Tietze for pointing out a mistake in the readme
- Blaž Hrastnik for noticing and contributing tests for a bug in the timing logic past a month
License
Copyright (c) 2013 Kurtis Rainbolt-Greene
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.