todoist_date_time 0.2.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+nbproject
+coverage
+rdoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kazuhiro Hiramatsu
+
+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 @@
+= todoist_date_time
+
+String class extension which parses date and time literals into DateTime instances using same syntax as http://todoist.com.
+
+
+== Examples:
+
+  "today @12".to_tddatetime
+  => Mon, 25 Jan 2010 12:00:00 +0000
+
+  "april/4 at 9:34".to_tddatetime
+  => Sun, 04 Apr 2010 09:34:00 +0000
+
+  "monday".to_tddatetime
+  => Mon, 25 Jan 2010 00:00:00 +0000
+
+
+== TODO
+
+- write full documentation of acceptable input syntax and expected results
+
+
+
+== Copyright
+
+Copyright (c) 2009 Kazuhiro Hiramatsu. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "todoist_date_time"
+    gem.summary = %Q{Parser of Todoist (http://todoist.com) datetime syntax}
+    gem.description = %Q{Add into String class method which converts string value written in Todoist (http://todoist.com) datetime syntax into valid DateTime instance}
+    gem.email = "kaz_u@wp.pl"
+    gem.homepage = "http://github.com/kazuhiro/todoist_date_time"
+    gem.authors = ["Kazuhiro Hiramatsu"]
+    gem.add_dependency "activesupport", ">= 2.1.2"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "todoist_date_time #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/lib/todoist_date_time.rb

@@ -0,0 +1,128 @@
+require 'rubygems'
+require 'active_support'
+
+
+module TodoistDateTime
+  DATE_PARTS_SEPARATORS = [".", "-", " ", "/"]
+  DATE_PARTS_SEPARATORS_REGEXP = Regexp.new(
+    "(" + 
+    self::DATE_PARTS_SEPARATORS.map{ |elem| Regexp.escape(elem)}.join("|") + 
+    ")")
+
+  TIME_FROM_DATE_SEPARATORS = ["@", " @ ", "@ ", " @" , " at ", " at"]
+  TIME_FROM_DATE_SEPARATORS_REGEXP = Regexp.new(
+    "(" + 
+    self::TIME_FROM_DATE_SEPARATORS.map{ |elem| Regexp.escape(elem)}.join("|") + 
+    ")")
+
+
+  class InvalidInput < ArgumentError
+    # Creates an instance of InvalidInput
+    def initialize(input)
+      super('unparsable datetime string given: ' + input)
+    end
+  end
+
+
+  module String
+    # Cast given date and time string into DateTime instance
+    # ===== Example
+    #  "monday".to_tddatetime
+    #   # => Mon, 25 Jan 2010 00:00:00 +0000
+    def to_datetime_like_todoist
+      parse_date(to_s)
+    end
+
+    alias :to_tddatetime :to_datetime_like_todoist
+
+
+    private
+
+      def parse_date(datetime_string)
+        date_string, _, time_string = datetime_string.split(
+          TodoistDateTime::TIME_FROM_DATE_SEPARATORS_REGEXP).map{ |element| element.strip.downcase }
+
+
+        datetime_object = case(date_string)
+
+        when /^tod/:
+          Date.today.to_datetime
+
+        when /^tom/:
+          DateTime.tomorrow
+
+        when /^yes/:
+          DateTime.yesterday
+
+        # example: +5, -3
+        when /^(\+|\-){1}[0-9]+$/
+          Date.today.to_datetime + date_string.to_i.days
+
+        when /^[a-z]+$/
+          day_idx = Date::DAYNAMES.index(
+            Date::DAYNAMES.find{ |month| month =~ Regexp.new("^" + date_string, Regexp::IGNORECASE) })
+
+          unless day_idx.nil?
+            datetime_object = Date.today.to_datetime
+            datetime_object += 1.day until datetime_object.wday == day_idx or datetime_object.wday == day_idx
+            datetime_object
+          else
+            raise InvalidInput.new(datetime_string)
+          end
+
+        # example: 4/1, 5/5, 2/5 YYYY
+        # or
+        # example: december, december.5, december.5 2009, 12.december, 12.december.2009, 1.12.2009, 1.12
+        when Regexp.new(
+          "^([0-9]{1,2}){1}" + 
+          TodoistDateTime::DATE_PARTS_SEPARATORS_REGEXP.source + 
+          "*([0-9]{1,2})?" + 
+          TodoistDateTime::DATE_PARTS_SEPARATORS_REGEXP.source + 
+          "*([0-9]{4})?$", Regexp::IGNORECASE),
+          # or
+          Regexp.new(
+          "^([0-9]{1,2}|[a-z]{1,9})" +
+          TodoistDateTime::DATE_PARTS_SEPARATORS_REGEXP.source +
+          "+([0-9]{1,2}|[a-z]{1,9})" +
+          TodoistDateTime::DATE_PARTS_SEPARATORS_REGEXP.source +
+          "*([0-9]{4})?$", Regexp::IGNORECASE)
+
+          parts = date_string.split(
+            TodoistDateTime::DATE_PARTS_SEPARATORS_REGEXP
+          ).map { |elem| 
+            elem.strip 
+          }.reject { |elem| 
+            elem.strip.length == 0 or TodoistDateTime::DATE_PARTS_SEPARATORS.include?(elem) 
+          }
+
+          unless Date::MONTHNAMES.include?(parts[0]) or Date::ABBR_MONTHNAMES.include?(parts[0]) or parts[0] =~ /([0-9]{1,2})/
+            parts[0] = Date::MONTHNAMES.find{ |month| month =~ Regexp.new("^" + parts[0], Regexp::IGNORECASE) unless month.nil? }
+          end
+
+          DateTime.parse( parts[1].to_s + "." + parts[0].to_s + "." + (parts.count == 3 ? parts[2].to_s : Date.today.year).to_s )
+
+        else
+          begin            
+            DateTime.parse(date_string)
+          rescue
+            raise InvalidInput.new(datetime_string)
+          end
+        end
+
+        case(time_string)
+        when Regexp.new("^([0-9]{1,2}):?([0-9]{1,2})$")
+          tmp_hours, tmp_minutes = time_string.split(":")
+          datetime_object += tmp_hours.to_i.hours
+          datetime_object += tmp_minutes.to_i.minutes unless tmp_minutes.nil?
+        end
+
+        datetime_object
+      end
+
+  end
+end
+
+
+class String
+  include TodoistDateTime::String
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'todoist_date_time'
+require 'rubygems'
+require 'active_support'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/todoist_date_time_spec.rb

@@ -0,0 +1,169 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+describe "TodoistDateTime" do
+  before(:all) do
+    @monthnames = Date::MONTHNAMES.map{ |month| month.downcase unless month.nil? }
+    @abbr_monthnames = Date::ABBR_MONTHNAMES.map{ |month| month.downcase unless month.nil? }
+    @daynames = Date::DAYNAMES.map{ |month| month.downcase }
+    @abbr_daynames = Date::ABBR_DAYNAMES.map{ |month| month.downcase}
+
+    @date_parts_separators = TodoistDateTime::DATE_PARTS_SEPARATORS
+    @time_from_date_separators = TodoistDateTime::TIME_FROM_DATE_SEPARATORS
+  end
+
+
+  describe "pointers of date" do
+    before(:all) do
+      @yesterday = Date.yesterday
+      @today = Date.today
+      @tomorrow = Date.tomorrow
+    end
+
+    it "should parse each week day name as nearly date which it will be" do
+      @daynames.each_with_index do |month, day_idx|
+        expected_date = @today
+        expected_date += 1.day until expected_date.wday == day_idx
+
+        #day.to_tddatetime.should == expected_date
+        @daynames[day_idx].to_tddatetime.should == expected_date
+        @abbr_daynames[day_idx].to_tddatetime == expected_date
+      end
+    end
+
+    it "should parse begining letters of each week day name as nearly date which it will be" do
+      @daynames.each do |month|
+        month.chars.to_a.each_with_index do |char, char_idx| # build dayname char by char and test each one
+          month = @daynames.find{ |month| month =~ Regexp.new("^" + month[0..char_idx], Regexp::IGNORECASE) }
+
+          expected_date = @today
+          expected_date += 1.day until expected_date.wday == @daynames.index(month)
+          month[0..char_idx].to_tddatetime.should == expected_date
+        end
+      end
+    end
+
+    it "should throw parse error when no date expression string is given" do
+      lambda{ "lorem ipsum".to_tddatetime }.should raise_error
+      lambda{ "lorem".to_tddatetime }.should raise_error
+    end
+
+    it "should parse positive number as date which will come after given number of days" do
+      num = rand(10)
+      "+#{num}".to_tddatetime.should == @today + num.days
+    end
+
+    it "should parse negative number as date which will was given number of days ago" do
+      num = rand(10)
+      "-#{num}".to_tddatetime.should == @today - num.days
+    end
+
+    it "should parse 'tod*' as current date" do
+      expected_day = @today
+
+      "tod".to_tddatetime.should == expected_day
+      "toda".to_tddatetime.should == expected_day
+      "today".to_tddatetime.should == expected_day
+    end
+
+    it "should parse 'tom*' as following day's date" do
+      expected_day = @today + 1.day
+
+      "tom".to_tddatetime.should == expected_day
+      "tom".to_tddatetime.should == expected_day
+      "tomo".to_tddatetime.should == expected_day
+      "tomor".to_tddatetime.should == expected_day
+      "tomorr".to_tddatetime.should == expected_day
+      "tomorro".to_tddatetime.should == expected_day
+      "tomorrow".to_tddatetime.should == expected_day
+    end
+
+    it "should parse 'yes*' as previous day's date" do
+      expected_day = @today - 1.day
+
+      "yes".to_tddatetime.should == expected_day
+      "yest".to_tddatetime.should == expected_day
+      "yester".to_tddatetime.should == expected_day
+      "yesterd".to_tddatetime.should == expected_day
+      "yesterda".to_tddatetime.should == expected_day
+      "yesterday".to_tddatetime.should == expected_day
+    end
+
+    it "should expand date with month abbreviation to full date in upcoming (given) month" do
+      @monthnames.each do |month|
+        next if month.nil?
+
+        month.chars.to_a.each_with_index do |char, char_idx| # build dayname char by char and test each one
+          month = @monthnames.find{ |month| month =~ Regexp.new("^" + month[0..char_idx], Regexp::IGNORECASE) unless month.nil? }
+          expected_date = @today
+          expected_date += 1.month until expected_date.month == @monthnames.index(month)         
+          (month[0..char_idx] + "/" + expected_date.day.to_s + "/" + expected_date.year.to_s).to_tddatetime.should == expected_date
+        end
+      end
+    end
+
+    it "should parse 'april/1', 'april/1/2009', '4/1', 4/1/2009', '1/april', '1/april/2009' as 01.04 in YYYY or 2009" do
+      @date_parts_separators.each do |date_separator|
+        @monthnames.each_index do |month_idx|
+          next if month_idx == 0 # first month in Date::MONTHNAMES is a nil
+
+          current_year = @today.year
+          expected_date = DateTime.parse("01.#{month_idx}.#{current_year}")
+
+          month = @monthnames[month_idx]
+          short_month = @abbr_monthnames[month_idx]
+
+          Array.new([
+            # month name first: april/1, april/1/2009
+            [month, 1], [month, 1, current_year],
+
+            # short month name first: apr/1, apr/1/2009
+            [short_month, 1], [short_month, 1, current_year],
+
+            # month name second: 1/april, 1/april/2009
+            [1, month], [1, month, current_year], 
+
+            # short month name second: 1/apr, 1/apr/2009
+            [1, short_month], [1, short_month, current_year],
+
+            # month index first: 4/1, 4/1/2009
+            [month_idx, 1], [month_idx, 1, current_year]
+          ]).each do |date_array|
+            # build a date string from array using given separator and compare it with expectation
+            date_array.join(date_separator).to_tddatetime.should == expected_date
+          end
+        end
+      end
+    end
+  end
+
+  describe "pointers of time" do
+    it "should parse 'friday @12:10', 'fri at 12:10' as next friday at 12 hours and 10 minutes" do
+      expected_date = DateTime.parse(Date.today.to_s + " 12:10")
+      expected_date += 1.day until expected_date.wday == @daynames.find_index("friday")
+
+      @time_from_date_separators.each do |time_separator|
+        ("friday" + time_separator + "12:10").to_tddatetime.should == expected_date
+      end
+    end
+
+    it "should raise an exception when only time given" do
+      lambda { "@12:10".to_tddatetime }.should raise_exception ArgumentError
+    end
+  end
+
+  describe "pointers of date and time" do
+    before(:all) do
+      @expected_date = DateTime.parse("01.04.2009 12:10")
+    end
+
+    it "should parse '1. april 2009 at 12:10' as 01.04.2009 at 12 hours and 10 minutes" do
+      "1. april 2009 at 12:10".to_tddatetime.should == @expected_date
+    end
+
+    it "should parse '4/1/2009 at 12:10' as 01.04.2009 at 12 hours and 10 minutes" do
+      "4/1/2009 at 12:10".to_tddatetime.should == @expected_date
+    end
+  end
+
+end

data/todoist_date_time.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{todoist_date_time}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kazuhiro Hiramatsu"]
+  s.date = %q{2010-02-01}
+  s.description = %q{Add into String class method which converts string value written in Todoist (http://todoist.com) datetime syntax into valid DateTime instance}
+  s.email = %q{kaz_u@wp.pl}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/todoist_date_time.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/todoist_date_time_spec.rb",
+     "todoist_date_time.gemspec"
+  ]
+  s.homepage = %q{http://github.com/kazuhiro/todoist_date_time}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Parser of Todoist (http://todoist.com) datetime syntax}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/todoist_date_time_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.1.2"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.1.2"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.1.2"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: todoist_date_time
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Kazuhiro Hiramatsu
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-01 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Add into String class method which converts string value written in Todoist (http://todoist.com) datetime syntax into valid DateTime instance
+email: kaz_u@wp.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/todoist_date_time.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/todoist_date_time_spec.rb
+- todoist_date_time.gemspec
+has_rdoc: true
+homepage: http://github.com/kazuhiro/todoist_date_time
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Parser of Todoist (http://todoist.com) datetime syntax
+test_files: 
+- spec/spec_helper.rb
+- spec/todoist_date_time_spec.rb