Path: | README.md |
Last Update: | Fri Feb 11 23:23:32 +0000 2011 |
## DESCRIPTION
Chronic is a natural language date/time parser written in pure Ruby. See below for the wide variety of formats Chronic will parse.
## INSTALLATION
The best way to install Gollum is with RubyGems:
$ [sudo] gem install chronic
## USAGE
You can parse strings containing a natural language date using the Chronic.parse method.
require 'rubygems' require 'chronic' Time.now #=> Sun Aug 27 23:18:25 PDT 2006 #--- Chronic.parse('tomorrow') #=> Mon Aug 28 12:00:00 PDT 2006 Chronic.parse('monday', :context => :past) #=> Mon Aug 21 12:00:00 PDT 2006 Chronic.parse('this tuesday 5:00') #=> Tue Aug 29 17:00:00 PDT 2006 Chronic.parse('this tuesday 5:00', :ambiguous_time_range => :none) #=> Tue Aug 29 05:00:00 PDT 2006 Chronic.parse('may 27th', :now => Time.local(2000, 1, 1)) #=> Sat May 27 12:00:00 PDT 2000 Chronic.parse('may 27th', :guess => false) #=> Sun May 27 00:00:00 PDT 2007..Mon May 28 00:00:00 PDT 2007
See Chronic.parse for detailed usage instructions.
## EXAMPLES
Chronic can parse a huge variety of date and time formats. Following is a small sample of strings that will be properly parsed. Parsing is case insensitive and will handle common abbreviations and misspellings.
Simple
Complex
Specific Dates
Specific Times (many of the above with an added time)
## TIME ZONES
Chronic allows you to set which Time class to use when constructing times. By default, the built in Ruby time class creates times in your system‘s local time zone. You can set this to something like ActiveSupport‘s TimeZone class to get full time zone support.
>> Time.zone = "UTC" >> Chronic.time_class = Time.zone >> Chronic.parse("June 15 2006 at 5:45 AM") => Thu, 15 Jun 2006 05:45:00 UTC +00:00
## LIMITATIONS
Chronic uses Ruby‘s built in Time class for all time storage and computation. Because of this, only times that the Time class can handle will be properly parsed. Parsing for times outside of this range will simply return nil. Support for a wider range of times is planned for a future release.
## CONTRIBUTE
If you‘d like to hack on Chronic, start by forking the repo on GitHub:
To get all of the dependencies, install the gem first. The best way to get your changes merged back into core is as follows: