/durtool

Primary LanguageRuby

DurTool

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/DurTool. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'DurTool'

And then execute:

$ bundle

Or install it yourself as:

$ gem install DurTool

Usage

# require the library (not necessary if using bundler)
require 'DurTool'

# optional: used to parse strings such as "one week from now" into datetime objects.
require 'chronic' 

now = Chronic.parse('right now') # => 2017-10-14 18:51:12 -0700
countdown_to = Chronic.parse('Wednesday at 10pm') # => 2017-10-18 22:00:00 -0700

duration = countdown_to - now # => 356927.132388

formatted_duration = DurTool.format(duration) # => "99h 8m 47s"

Development

After checking out the repo, run bin/setup to install dependencies. 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.

Contributing

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