timelord 0.0.3 → 0.0.4

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 halogenandtoast
+
+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.

data/README.rdoc

@@ -0,0 +1,26 @@
+=Timelord
+
+Timelord parses dates out of strings. The string itself can contain non-date text - for instance: "Call Matt on Tuesday"
+will return a date object for the upcoming Tuesday.
+
+==Usage
+
+  require 'timelord'
+  Timelord.parse("Tuesday").to_s # "2011-01-04"
+  Timelord.parse("On Tuesday go for a walk").to_s # "2011-01-04"
+
+For more examples, check out the spec[https://github.com/halogenandtoast/timelord/blob/master/spec/timelord_spec.rb]
+
+==Date format
+
+The default date format is the international format. 11/01 is January 11th.
+
+To use the american date format pass in :american as the second parameter
+
+  Timelord.parse("11/01").to_s # "2011-01-11"
+  Timelord.parse("11/01", :american) # "2011-11-01"
+
+==In the future
+
+As of version 0.0.1 all dates without a year automatically choose the next occurrence of that date. If there is demand
+for the ability to retrieve previous dates, then the functionality will be added.

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rake'
 require 'spec/rake/spectask'
 require 'rake/rdoctask'
-require 'yaml'
+require 'rake/gempackagetask'
 
 Spec::Rake::SpecTask.new do |t|
   t.spec_files = FileList['spec/**/*_spec.rb']
@@ -10,24 +10,11 @@ end
 task :default => [:test]
 task :test => [:spec]
 
-PKG_FILES = %w(Rakefile) + Dir.glob("{lib}/**/*")
-
-gem_spec = Gem::Specification.new do |spec|
-  spec.name = 'timelord'
-  spec.version = '0.0.3'
-  spec.summary = 'Pull dates out of strings'
-  spec.description = 'Pull dates out of strings.'
-  spec.email = 'halogenandtoast@gmail.com'
-  spec.homepage = 'http://github.com/halogenandtoast/timelord'
-  spec.authors = ['Matthew Mongeau']
-  spec.files = PKG_FILES
-end
-
-desc "Generate a gemspec file"
-task :gemspec do
-  File.open("#{gem_spec.name}.gemspec", "w") do |f|
-    f.write gem_spec.to_yaml
-  end
+specification = Gem::Specification.load("timelord.gemspec")
+desc 'Package gem'
+Rake::GemPackageTask.new(specification) do |package|
+  package.need_zip = true
+  package.need_tar = true
 end
 
 desc 'Generate documentation'

data/lib/timelord.rb

@@ -6,7 +6,8 @@ class Timelord
   SHORT_MATCHER = SHORT_MONTHS.join('|').freeze
   ORDINAL_MATCHER = "st|nd|rd|th".freeze
   DAY_NAMES = %w(monday tuesday wednesday thursday friday saturday sunday).freeze
-  DAY_MATCHER = DAY_NAMES.join('|').freeze
+  SHORT_DAY_NAMES = %w(mon tue wed thu fri sat sun).freeze
+  DAY_MATCHER = (DAY_NAMES + SHORT_DAY_NAMES).join('|').freeze
 
   # Parses a date str. Second parameter switches between international and american date formats.
   #
@@ -44,34 +45,54 @@ class Timelord
       date = Date.civil(today.year, today.month, $1.to_i)
       set_to_future(date)
     elsif str =~/next (#{DAY_MATCHER})/i
-      current_date = today.strftime("%A").downcase
-      current_index = DAY_NAMES.index(current_date)
-      expected_index = DAY_NAMES.index($1.downcase)
-      if expected_index <= current_index
-        today + (7 - current_index + expected_index) + 7
-      else
-        diff = expected_index - current_index
-        today + diff + 7
-      end
+      expected_index = DAY_NAMES.index($1.downcase) || SHORT_DAY_NAMES.index($1.downcase)
+      next_weekday(expected_index)
+    elsif str =~/next tues/
+      next_weekday(DAY_NAMES.index("tue"))
+    elsif str =~/next (thur|thurs)/
+      next_weekday(DAY_NAMES.index("tue"))
     elsif str =~/(#{DAY_MATCHER})/i
-      current_date = today.strftime("%A").downcase
-      current_index = DAY_NAMES.index(current_date)
-      expected_index = DAY_NAMES.index($1.downcase)
-      if expected_index <= current_index
-        today + (7 - current_index + expected_index)
-      else
-        diff = expected_index - current_index
-        today + diff
-      end
-    elsif str =~ /today/i
+      expected_index = DAY_NAMES.index($1.downcase) || SHORT_DAY_NAMES.index($1.downcase)
+      current_weekday(expected_index)
+    elsif str =~/tues/
+      current_weekday(DAY_NAMES.index("tue"))
+    elsif str =~/(thur|thurs)/
+      current_weekday(DAY_NAMES.index("tue"))
+    elsif str =~ /(today|tod)/i
       today
-    elsif str =~ /tomorrow/i
+    elsif str =~ /(tomorrow|tom)/i
       today + 1
     end
   end
 
   private
 
+  def self.today
+    Date.today
+  end
+
+  def self.next_weekday(date_index)
+    current_date = today.strftime("%A").downcase
+    current_index = DAY_NAMES.index(current_date)
+    if date_index <= current_index
+      today + (7 - current_index + date_index) + 7
+    else
+      diff = date_index - current_index
+      today + diff + 7
+    end
+  end
+
+  def self.current_weekday(date_index)
+    current_date = today.strftime("%A").downcase
+    current_index = DAY_NAMES.index(current_date)
+    if date_index <= current_index
+      today + (7 - current_index + date_index)
+    else
+      diff = date_index - current_index
+      today + diff
+    end
+  end
+
   def self.set_to_future(date)
     today = Date.today
     if date && date < today

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'timelord'
+require 'rubygems'
+require 'bundler/setup'
+require 'timecop'

data/spec/timelord_spec.rb

@@ -0,0 +1,121 @@
+require 'spec_helper'
+
+describe Timelord, 'parse' do
+  before do
+    local_time = Time.local(2010,12,1,10,5,0)
+    Timecop.freeze(local_time)
+  end
+
+  it "returns nil when no time is present" do
+    Timelord.parse("No time here").should == nil
+  end
+
+  it "parses 'today'" do
+    Timelord.parse("I need to do something today.").should == Date.today
+  end
+
+  it "parses 'tod'" do
+    Timelord.parse("I need to do something tod.").should == Date.today
+  end
+
+  it "parses 'tomorrow'" do
+    tomorrow = Date.today + 1
+    Timelord.parse("I need to do something tomorrow.").should == tomorrow
+  end
+
+  it "parses 'tom'" do
+    tomorrow = Date.today + 1
+    Timelord.parse("I need to do something tom.").should == tomorrow
+  end
+
+  it "parses '12 Dec'" do
+    twelth_of_december = Date.civil(2010,12,12)
+    Timelord.parse("On 12 Dec I need to do something.").should == twelth_of_december
+  end
+
+  it "parses 'Dec 12'" do
+    twelth_of_december = Date.civil(2010,12,12)
+    Timelord.parse("On Dec 12 I need to do something.").should == twelth_of_december
+  end
+
+  it "parses American style dates" do
+    first_of_december = Date.today
+    Timelord.parse("On 12/1/2010 I need to do something.", :american).should == first_of_december
+  end
+
+  it "parses Internation style dates by default" do
+    first_of_december = Date.today
+    Timelord.parse("On 1/12/2010 I need to do something.", :international).should == first_of_december
+  end
+
+  it "parses yyyy/mm/dd" do
+    first_of_december = Date.today
+    Timelord.parse("On 2010/12/01 I need to do something.").should == first_of_december
+  end
+
+  it "parses yyyy/mm/d" do
+    first_of_december = Date.today
+    Timelord.parse("On 2010/12/1 I need to do something.").should == first_of_december
+  end
+
+  it "parses yyyy/m/d" do
+    first_of_january = Date.civil(2010, 1, 1)
+    Timelord.parse("On 2010/1/1 I need to do something.").should == first_of_january
+  end
+
+  it "parses yyyy-mm-dd" do
+    first_of_december = Date.today
+    Timelord.parse("On 2010-12-01 I need to do something.").should == first_of_december
+  end
+
+  it "parses mm/dd" do
+    first_of_december = Date.today
+    Timelord.parse("On 12/1 I need to do something.", :american).should == first_of_december
+    Timelord.parse("On 12/01 I need to do something.", :american).should == first_of_december
+    Timelord.parse("On 1/12 I need to do something.", :international).should == first_of_december
+    Timelord.parse("On 01/12 I need to do something.", :international).should == first_of_december
+  end
+
+  it "parses formats like 1st,2nd,3rd,4th,25th" do
+    first_of_december = Date.today
+    second_of_december = Date.today + 1
+    third_of_december = Date.today + 2
+    forth_of_december = Date.today + 3
+    twenty_fifth_of_december = Date.civil(2010,12,25)
+    Timelord.parse("On the 1st").should == first_of_december
+    Timelord.parse("On the 2nd").should == second_of_december
+    Timelord.parse("On the 3rd").should == third_of_december
+    Timelord.parse("On the 4th").should == forth_of_december
+    Timelord.parse("On the 25th").should == twenty_fifth_of_december
+  end
+
+  it "parses the day of the week" do
+    friday = Date.today + 2
+    monday = Date.today + 5
+    tuesday = Date.today + 6
+    thursday = Date.today + 1
+    Timelord.parse("On friday do something").should == friday
+    Timelord.parse("On Monday do something").should == monday
+    Timelord.parse("On fri do something").should == friday
+    Timelord.parse("On mon do something").should == monday
+    Timelord.parse("On tues do something").should == tuesday
+    Timelord.parse("On thurs do something").should == thursday
+  end
+
+  it "parses the next weekday" do
+    friday = Date.today + 9
+    monday = Date.today + 12
+    Timelord.parse("On next friday do something").should == friday
+    Timelord.parse("On next Monday do something").should == monday
+  end
+
+  it 'returns a date in the future' do
+    first_of_january = Date.civil(2011,1,1)
+    Timelord.parse("On 1 Jan I need to do something.").should == first_of_january
+  end
+
+  after do
+    Timecop.return
+  end
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: timelord
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Matthew Mongeau
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-03 00:00:00 -05:00
+date: 2011-02-16 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
-description: Pull dates out of strings.
+description: 
 email: halogenandtoast@gmail.com
 executables: []
 
@@ -28,8 +28,12 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.rdoc
+- LICENSE
 - Rakefile
 - lib/timelord.rb
+- spec/spec_helper.rb
+- spec/timelord_spec.rb
 has_rdoc: true
 homepage: http://github.com/halogenandtoast/timelord
 licenses: []