Skip to content
forked from lzell/nickel

Nickel extracts date, time, and message information from naturally worded text.

License

Notifications You must be signed in to change notification settings

wdiechmann/nickel

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nickel extracts date, time, and message information from naturally worded text.

Install

gem install nickel

Usage

A single occurrence

n = Nickel.parse("use the force on july 1st at 9am", Time.now)
n.message                       #=> "use the force"
n.occurrences.first.start_date  #=> "20110701"

A daily occurrence

n = Nickel.parse "wake up everyday at 11am"
n.message                       # => wake up
n.occurrences[0].type           # => daily
n.occurrences[0].start_time     # => 11:00:00

A weekly occurrence

n = Nickel.parse "guitar lessons every tuesday at 5pm"
n.message                       # => guitar lessons
n.occurrences[0].type           # => weekly
n.occurrences[0].day_of_week    # => tue
n.occurrences[0].interval       # => 1
n.occurrences[0].start_time     # => 17:00:00

A day monthly occurrence

n = Nickel.parse "drink specials on the second thursday of every month"
n.message                       # => drink specials
n.occurrences[0].type           # => daymonthly
n.occurrences[0].day_of_week    # => thu
n.occurrences[0].week_of_month  # => 2
n.occurrences[0].interval       # => 1

A date monthly occurrence

n = Nickel.parse "pay credit card every month on the 22nd"
n.message                       # => pay credit card
n.occurrences[0].type           # => datemonthly
n.occurrences[0].date_of_month  # => 22
n.occurrences[0].interval       # => 1

Multiple occurrences

n = Nickel.parse "band meeting every monday and wednesday at 2pm"
n.message                       # => band meeting
n.occurrences[0].type           # => weekly
n.occurrences[0].day_of_week    # => mon
n.occurrences[0].start_time     # => 14:00:00
n.occurrences[1].type           # => weekly
n.occurrences[1].day_of_week    # => wed
n.occurrences[1].start_time     # => 14:00:00

Setting current time

n = Nickel.parse "lunch 3 days from now", DateTime.new(2010,3,31)
n.message                       # => lunch
n.occurrences[0].start_date     # => 20100403

Running Tests

$ rake test

If you do not have RUBYOPT set: $ RUBYOPT=‘rubygems’ rake test

Copyright © 2008-2011 Lou Zell, released under the MIT license

About

Nickel extracts date, time, and message information from naturally worded text.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published