todo-txt 0.1.1 → 0.2

data/lib/todo-txt/task.rb

@@ -1,3 +1,5 @@
+require 'date'
+
 module Todo
   class Task
     include Comparable
@@ -17,6 +19,11 @@ module Todo
       /^\([A-Za-z]\)\s+/
     end
 
+    # The regex used to match dates.
+    def self.date_regex
+      /(?:\([A-Za-z]\)\s+|^)([0-9]{4}-[0-9]{2}-[0-9]{2})/
+    end
+
     # Creates a new task. The argument that you pass in must be a string.
     def initialize task
       @orig = task
@@ -84,6 +91,45 @@ module Todo
         strip
     end
 
+    # Returns the date present in the task.
+    #
+    # Example:
+    #
+    #   task = Todo::Task.new "(A) 2012-03-04 Task."
+    #   task.date
+    #   #=> <Date: 2012-03-04 (4911981/2,0,2299161)>
+    #
+    # Dates _must_ be in the YYYY-MM-DD format as specified in the todo.txt
+    # format. Dates in any other format will be classed as malformed and this
+    # method will return nil.
+    def date
+      begin
+        @date ||= Date.parse(orig.match(self.class.date_regex)[1])
+      rescue
+        @date = nil
+      end
+    end
+
+    # Checks whether or not this task is overdue by comparing the task date to
+    # the current date.
+    #
+    # If there is no date specified for this task, this method returns nil.
+    #
+    # Example:
+    #
+    #   task = Todo::Task.new "(A) 2012-03-04 Task."
+    #   task.overdue?
+    #   #=> true
+    def overdue?
+      if date.nil?
+        nil
+      elsif date < Date.today
+        true
+      else
+        false
+      end
+    end
+
     # Compares the priorities of two tasks.
     #
     # Example:

data/spec/data/todo.txt

@@ -3,3 +3,7 @@
 @context Give it some context.
 Just a POD: Plain old task.
 (C) +project @context This one has it all!
+(C) 2012-02-03 This one has a date!
+(B) 2012-03-04 +project @context This one has a date and a context AND a project!
+2012-04-03 This one has no priority and a date.
+03-04-2012 This one has a malformed date.

data/spec/todo-txt/task_spec.rb

@@ -1,4 +1,5 @@
 require_relative '../spec_helper'
+require 'date'
 
 describe Todo::Task do
   it 'should recognise priorities' do
@@ -64,4 +65,39 @@ describe Todo::Task do
     assertion = task1 == task2
     assertion.should == true
   end
+
+  it 'should be able to recognise dates' do
+    task = Todo::Task.new "(C) 2012-03-04 This has a date!"
+    task.date.should == Date.parse("4th March 2012")
+  end
+
+  it 'should be able to recognise dates without priority' do
+    task = Todo::Task.new "2012-03-04 This has a date!"
+    task.date.should == Date.parse("4th March 2012")
+  end
+
+  it 'should return nil if no date is present' do
+    task = Todo::Task.new "No date!"
+    task.date.should be_nil
+  end
+
+  it 'should not recognise malformed dates' do
+    task = Todo::Task.new "03-04-2012 This has a malformed date!"
+    task.date.should be_nil
+  end
+
+  it 'should be able to tell if the task is overdue' do
+    task = Todo::Task.new((Date.today - 1).to_s + " This task is overdue!")
+    task.overdue?.should be_true
+  end
+
+  it 'should return nil on overdue? if there is no date' do
+    task = Todo::Task.new "No date!"
+    task.overdue?.should be_nil
+  end
+
+  it 'should return nil on ridiculous date data' do
+    task = Todo::Task.new "2012-56-99 This has a malformed date!"
+    task.date.should be_nil
+  end
 end

data/todo-txt.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = %q{todo-txt}
-  s.version = "0.1.1"
-  s.date = %q{2011-08-19}
+  s.version = "0.2"
+  s.date = %q{2012-03-31}
   s.authors = ["Sam Rose"]
   s.email = %q{samwho@lbak.co.uk}
   s.summary = %q{A client library for parsing todo.txt files.}
@@ -13,4 +13,5 @@ Gem::Specification.new do |s|
   # Add all files to the files parameter.
   s.files = []
   Dir["**/*.*"].each { |path| s.files.push path }
+  s.files.push ".gemtest"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: todo-txt
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-19 00:00:00.000000000Z
+date: 2012-03-31 00:00:00.000000000Z
 dependencies: []
 description: Allows for simple parsing of todo.txt files, as per Gina Trapani's todo.txt
   project.
@@ -18,16 +18,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/todo-txt/list.rb
+- lib/todo-txt/task.rb
+- lib/todo-txt.rb
+- gems/todo-txt-0.1.1.gem
+- gems/todo-txt-0.1.gem
 - README.md
 - spec/todo-txt/list_spec.rb
 - spec/todo-txt/task_spec.rb
-- spec/data/todo.txt
 - spec/spec_helper.rb
-- gems/todo-txt-0.1.gem
+- spec/data/todo.txt
 - todo-txt.gemspec
-- lib/todo-txt/list.rb
-- lib/todo-txt/task.rb
-- lib/todo-txt.rb
+- .gemtest
 homepage: http://github.com/samwho/todo-txt-gem
 licenses:
 - GPL-2
@@ -49,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.8
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A client library for parsing todo.txt files.