mirror of
https://github.com/TracksApp/tracks.git
synced 2026-02-04 06:51:48 +01:00
4c2742f6f3
What doesn't work yet: * If you delete all characters in the date box, you'll get an error message. This will go away if you type more characters * You'll get an error as above when the form is cleared and redisplayed after submission. Again, it will go away if you type anything in the box. * Validation doesn't work, but the preview will display "Invalid date" if Chronic can't parse your phrase * This isn't added to the edit form for actions yet. Also partially fixed #394: the mobile interface works again, but you might get an error visiting the subsequent pages of a filtered view (i.e. viewing a single context or project). I'm not sure what's causing this, but it's on my list to fix. git-svn-id: http://www.rousette.org.uk/svn/tracks-repos/trunk@332 a4c988fc-2ded-0310-b66e-134b36920a42
119 lines
No EOL
2.6 KiB
Text
119 lines
No EOL
2.6 KiB
Text
=Chronic
|
|
|
|
Chronic is a natural language date/time parser written in pure Ruby. See below for the wide variety of formats Chronic will parse.
|
|
|
|
==Installation
|
|
|
|
Chronic can be installed via RubyGems:
|
|
|
|
$ sudo gem install chronic
|
|
|
|
==Usage
|
|
|
|
You can parse strings containing a natural language date using the Chronic.parse method.
|
|
|
|
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
|
|
|
|
thursday
|
|
november
|
|
summer
|
|
friday 13:00
|
|
mon 2:35
|
|
4pm
|
|
6 in the morning
|
|
friday 1pm
|
|
sat 7 in the evening
|
|
yesterday
|
|
today
|
|
tomorrow
|
|
this tuesday
|
|
next month
|
|
last winter
|
|
this morning
|
|
last night
|
|
this second
|
|
yesterday at 4:00
|
|
last friday at 20:00
|
|
last week tuesday
|
|
tomorrow at 6:45pm
|
|
afternoon yesterday
|
|
thursday last week
|
|
|
|
Complex
|
|
|
|
3 years ago
|
|
5 months before now
|
|
7 hours ago
|
|
7 days from now
|
|
1 week hence
|
|
in 3 hours
|
|
1 year ago tomorrow
|
|
3 months ago saturday at 5:00 pm
|
|
7 hours before tomorrow at noon
|
|
3rd wednesday in november
|
|
3rd month next year
|
|
3rd thursday this september
|
|
4th day last week
|
|
|
|
Specific Dates
|
|
|
|
January 5
|
|
dec 25
|
|
may 27th
|
|
October 2006
|
|
oct 06
|
|
jan 3 2010
|
|
february 14, 2004
|
|
3 jan 2000
|
|
17 april 85
|
|
5/27/1979
|
|
27/5/1979
|
|
05/06
|
|
1979-05-27
|
|
Friday
|
|
5
|
|
4:00
|
|
17:00
|
|
0800
|
|
|
|
Specific Times (many of the above with an added time)
|
|
|
|
January 5 at 7pm
|
|
1979-05-27 05:00
|
|
etc
|
|
|
|
==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.
|
|
|
|
Time zones other than the local one are not currently supported. Support for other time zones is planned for a future release. |