temporal 0.4.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+vendor/*

data/Gemfile

@@ -0,0 +1,2 @@
+source :gemcutter
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    temporal (0.4.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    rake (0.8.7)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  rake (>= 0.8.7)
+  rspec (>= 1.3.0)
+  temporal!

data/README.txt

@@ -0,0 +1,6 @@
+** THIS PROJECT IS NOT YET READY FOR USE **
+
+Temporal is a natural language date and time parser.
+
+source code : http://github.com/clivecrous/temporal/
+home page   : http://clivecrous.lighthouseapp.com/projects/13349/home

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+desc "unit tests"
+task :test do
+  exec 'cd lib && bundle exec rspec ../test/*'
+end

data/lib/temporal/anomaly.rb

@@ -0,0 +1,4 @@
+module Temporal
+  class Anomaly < Exception
+  end
+end

data/lib/temporal/helpers.rb

@@ -0,0 +1,12 @@
+[Numeric,Range].each do |klass|
+  Temporal::Mathematics.units( klass )
+  Temporal::Mathematics.operators( klass )
+end
+
+[Time].each do |klass|
+  Temporal::Mathematics.operators( klass )
+end
+
+[Range].each do |klass|
+  Temporal::Mathematics.negation( klass )
+end

data/lib/temporal/mathematics.rb

@@ -0,0 +1,92 @@
+module Temporal
+  module Mathematics
+
+    def self.units klass
+      klass.class_eval do
+        Temporal::Shift.units.each do |unit|
+          if klass == Range
+            define_method unit do
+              if exclude_end?
+                return Temporal::Shift.new( first, unit )...Temporal::Shift.new( last, unit )
+              else
+                return Temporal::Shift.new( first, unit )..Temporal::Shift.new( last, unit )
+              end
+            end
+          else
+            define_method unit do
+              Temporal::Shift.new( self, unit )
+            end
+          end
+          define_method "#{unit}s" do
+            send(unit)
+          end
+        end
+      end
+    end
+
+    def self.negation klass
+      klass.class_eval do
+        begin
+          alias :temporal_negation :-@
+        rescue
+          def temporal_negation
+            raise NoMethodError.new( "undefined method `-@' for #{self.to_s}:#{self.class.to_s}" )
+          end
+        end
+        def -@
+          return temporal_negation unless self.class == Temporal::Shift or self.class == Range
+          if exclude_end?
+            -first...-last
+          else
+            -first..-last
+          end
+        end
+      end
+    end
+
+    def self.operators klass
+      klass.class_eval do
+        begin
+          alias :temporal_addition :+
+        rescue
+          def temporal_addition target
+            raise NoMethodError.new( "undefined method `+' for #{self.to_s}:#{self.class.to_s}" )
+          end
+        end
+        def + target
+          if target.class == Range
+            if self.class == Range
+              raise Temporal::Anomaly.new( "Missmatched Range end exclusions" ) if exclude_end? != target.exclude_end?
+              if target.exclude_end?
+                return (target.first + first)...(target.last + last)
+              else
+                return (target.first + first)..(target.last + last)
+              end
+            else
+              if target.exclude_end?
+                return (target.first + self)...(target.last + self)
+              else
+                return (target.first + self)..(target.last + self)
+              end
+            end
+          end
+          return temporal_addition( target ) unless target.class == Temporal::Shift
+          target + self
+        end
+
+        begin
+          alias :temporal_subtraction :-
+        rescue
+          def temporal_subtraction target
+            raise NoMethodError.new( "undefined method `-' for #{self.to_s}:#{self.class.to_s}" )
+          end
+        end
+        def - target
+          return temporal_subtraction( target ) unless target.class == Temporal::Shift or target.class == Range
+          (-target) + self
+        end
+      end
+    end
+
+  end
+end

data/lib/temporal/parser/afrikaans.rb

@@ -0,0 +1,24 @@
+module Temporal
+  class Parser
+
+    add_literal( /(^|\W)noe(\W|$)/i ) do
+      Time.now
+    end
+
+    add_literal( /(^|\W)vandag(\W|$)/i ) do
+      today_start = Time.parse(Time.now.strftime("%Y-%m-%d"))
+      today_start...today_start+1.day
+    end
+
+    add_literal( /(^|\W)gister(\W|$)/i ) do
+      yesterday_start = Time.parse((Time.now-1.day).strftime("%Y-%m-%d"))
+      yesterday_start...yesterday_start+1.day
+    end
+
+    add_literal( /(^|\W)more(\W|$)/i ) do
+      tomorrow_start = Time.parse((Time.now+1.day).strftime("%Y-%m-%d"))
+      tomorrow_start...tomorrow_start+1.day
+    end
+
+  end
+end

data/lib/temporal/parser/english.rb

@@ -0,0 +1,24 @@
+module Temporal
+  class Parser
+
+    add_literal( /(^|\W)now(\W|$)/i ) do
+      Time.now
+    end
+
+    add_literal( /(^|\W)today(\W|$)/i ) do
+      today_start = Time.parse(Time.now.strftime("%Y-%m-%d"))
+      today_start...today_start+1.day
+    end
+
+    add_literal( /(^|\W)yesterday(\W|$)/i ) do
+      yesterday_start = Time.parse((Time.now-1.day).strftime("%Y-%m-%d"))
+      yesterday_start...yesterday_start+1.day
+    end
+
+    add_literal( /(^|\W)tomorrow(\W|$)/i ) do
+      tomorrow_start = Time.parse((Time.now+1.day).strftime("%Y-%m-%d"))
+      tomorrow_start...tomorrow_start+1.day
+    end
+
+  end
+end

data/lib/temporal/parser.rb

@@ -0,0 +1,37 @@
+module Temporal
+  class Parser
+    @@literals = {}
+
+    def self.add_literal literal, &block
+      @@literals[ literal ] = block
+    end
+
+    def self.match? string
+      to_match = string.downcase.strip
+      @@literals.keys.each do |key|
+        return true if to_match =~ key
+      end
+      return false
+    end
+
+    def self.parse string
+      @@literals.keys.each do |key|
+        match = string.match(key)
+        next unless match
+        result = []
+        result << parse(match.pre_match) if match.pre_match.strip.size > 0
+        result << @@literals[key].call
+        result << parse(match.post_match) if match.post_match.strip.size > 0
+        result.flatten!
+        if result.empty?
+          result = nil
+        else
+          result = result.pop if result.size == 1
+        end
+        return result
+      end
+      string
+    end
+
+  end
+end

data/lib/temporal/shift.rb

@@ -0,0 +1,163 @@
+module Temporal
+  class Shift
+
+    include Comparable
+
+    MINUTE = 60
+    HOUR = MINUTE * 60
+    DAY = HOUR * 24
+    WEEK = DAY * 7
+
+    YEAR = 12
+
+    MAX_MONTH_DAY = %w|31 0 31 30 31 30 31 31 30 31 30 31|.map{|n|n.to_i} # Don't worry about February
+
+    attr_accessor :seconds
+    attr_accessor :months
+
+    def initialize amount, unit
+      unless self.class.unit?( unit )
+        raise Temporal::Anomaly.new( "Bad #{self.class}.unit type of `#{unit}' given" )
+      end
+
+      @seconds = 0
+      @months = 0
+
+      unit = unit.to_s.downcase
+      unit.chop! if unit[-1..-1] == 's'
+      unit = unit.to_sym
+
+      case unit
+      when :second
+        @seconds = amount
+      when :minute
+        @seconds = amount * MINUTE
+      when :hour
+        @seconds = amount * HOUR
+      when :day
+        @seconds = amount * DAY
+      when :week
+        @seconds = amount * WEEK
+      when :month
+        @months = amount
+      when :year
+        @months = amount * YEAR
+      else
+        raise Temporal::Anomaly.new( "Internal Error, failed to catch bad #{self.class}.unit type of `#{unit}' given" )
+      end
+    end
+
+    def <=> target
+      return 1 if @months > target.months
+      return -1 if @months < target.months
+      return 1 if @seconds > target.seconds
+      return -1 if @seconds < target.seconds
+      0
+    end
+
+    def self.units
+      %w|second minute hour day week month year|
+    end
+
+    def self.unit? unit
+      (unit.to_s.strip.downcase =~ /^(#{units.join('|')})s?$/) != nil
+    end
+
+    def + to_be_added
+
+      if to_be_added.class == self.class
+        result_instance = self.class.new( @seconds + to_be_added.seconds, :seconds )
+        result_instance.months = @months + to_be_added.months
+        return result_instance
+      end
+
+      if to_be_added.class == Time
+        new_time = (to_be_added + @seconds).localtime
+        new_year = new_time.year+(((new_time.month-1)+months)/12)
+        new_month = (((new_time.month-1)+months)%12)
+        new_day = new_time.day
+        if new_month == 1
+          if (new_year%4 == 0 and new_year%100 != 0) or new_year%400 == 0
+            max_mday = 29
+          else
+            max_mday = 28
+          end
+        else
+          max_mday = MAX_MONTH_DAY[ new_month ];
+        end
+        new_day = max_mday if new_day > max_mday
+        return Time.local( new_year, new_month+1 , new_day, new_time.hour, new_time.min, new_time.sec, new_time.usec )
+      end
+
+      if to_be_added.class == Range
+        new_first = self + to_be_added.first
+        new_last = self + to_be_added.last
+        if to_be_added.exclude_end?
+          return new_first...new_last
+        else
+          return new_first..new_last
+        end
+      end
+
+      raise Temporal::Anomaly.new( "Unable to add #{self.class} to instances of `#{to_be_added.class}'" )
+    end
+
+    def -@
+      negated = self.class.new( -@seconds, :seconds )
+      negated.months = -@months
+      return negated
+    end
+
+    def - to_be_subtracted
+      begin
+        self + ( -to_be_subtracted )
+      rescue Exception => e
+        raise Temporal::Anomaly.new( "Unable to subtract an instance of #{to_be_subtracted.class} from #{self.class}" )
+      end
+    end
+
+    def to_s
+      result = {}
+
+      result[:months] = @months
+
+      result[:years] = (result[:months]/12).truncate
+      result[:months] = result[:months] - ( result[:years] * 12 )
+      result[:months] = result[:months].truncate if result[:months].modulo(1) == 0
+
+      result[:seconds] = @seconds
+
+      result[:weeks] = (result[:seconds] / WEEK).truncate
+      result[:seconds] = result[:seconds] - (result[:weeks] * WEEK)
+      result[:days] = (result[:seconds] / DAY).truncate
+      result[:seconds] = result[:seconds] - (result[:days] * DAY)
+      result[:hours] = (result[:seconds] / HOUR).truncate
+      result[:seconds] = result[:seconds] - (result[:hours] * HOUR)
+      result[:minutes] = (result[:seconds] / MINUTE).truncate
+      result[:seconds] = result[:seconds] - (result[:minutes] * MINUTE)
+      result[:seconds] = result[:seconds].truncate if result[:seconds].modulo(1) == 0
+
+      result = Hash[ *result.select{|unit, amount| amount != 0 }.flatten ]
+
+      string = ""
+
+      %w|years months weeks days hours minutes seconds|.each do |unit|
+        unit = unit.to_sym
+        next unless result.has_key?( unit )
+        string += "#{result[ unit ]} #{unit}"
+        string.chop! if result[ unit ].abs == 1
+        result.delete( unit )
+        break if result.size == 0
+        if result.size == 1
+          string += " and "
+        else
+          string += ", "
+        end
+      end
+
+      string
+    end
+
+  end
+
+end

data/lib/temporal/version.rb

@@ -0,0 +1,3 @@
+module Temporal
+  VERSION = "0.4.0"
+end

data/lib/temporal.rb

@@ -0,0 +1,7 @@
+require 'time'
+require 'temporal/version'
+require 'temporal/anomaly'
+require 'temporal/shift'
+require 'temporal/mathematics'
+require 'temporal/helpers'
+require 'temporal/parser'

data/temporal.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/temporal/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "temporal"
+  s.version     = Temporal::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Clive Crous"]
+  s.email       = ["clive@crous.co.za"]
+  s.homepage    = "http://www.darkarts.co.za/temporal"
+  s.summary     = "A natural language date and time parser"
+  s.description = "This project is still in early development. Only the mathematical side is complete. eg: Time.now + 3.years + 2.months"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "temporal"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", ">= 1.3.0"
+  s.add_development_dependency "rake", ">= 0.8.7"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/test/days.rb

@@ -0,0 +1,56 @@
+require 'temporal'
+
+describe 'Temporal math with days' do
+
+  before do
+    @context = Time.local( 1975, 05, 13, 01, 23, 45)
+  end
+
+  it 'should add a day' do
+    ( @context + 1.day ).should == Time.local( 1975, 05, 14, 01, 23, 45)
+  end
+
+  it 'should subtract a day' do
+    ( @context - 1.day ).should == Time.local( 1975, 05, 12, 01, 23, 45)
+  end
+
+  it 'should add days' do
+    ( @context + 2.days ).should == Time.local( 1975, 05, 15, 01, 23, 45)
+  end
+
+  it 'should subtract days' do
+    ( @context - 2.days ).should == Time.local( 1975, 05, 11, 01, 23, 45)
+  end
+
+  it 'should wrap months while adding' do
+    ( Time.local( 1975, 05, 31, 01, 23, 45 ) + 1.day ).should == Time.local( 1975, 06, 1, 01, 23, 45 )
+  end
+
+  it 'should wrap months while subtracting' do
+    ( Time.local( 1975, 05, 1, 01, 23, 45 ) - 1.day ).should == Time.local( 1975, 04, 30, 01, 23, 45 )
+  end
+
+  it 'should wrap years while adding' do
+    ( Time.local( 1975, 12, 31, 01, 23, 45 ) + 1.day ).should == Time.local( 1976, 01, 01, 01, 23, 45 )
+  end
+
+  it 'should wrap years while subtracting' do
+    ( Time.local( 1975, 01, 01, 01, 23, 45 ) - 1.day ).should == Time.local( 1974, 12, 31, 01, 23, 45 )
+  end
+
+end
+
+describe 'One day in other units' do
+  it 'is 86400 seconds' do
+    1.day.should == 86400.seconds
+  end
+  it 'is 1440 minutes' do
+    1.day.should == 1440.minutes
+  end
+  it 'is 24 hours' do
+    1.day.should == 24.hours
+  end
+  it 'is 1/7th of a week' do
+    1.day.should == (1.0/7).weeks
+  end
+end

data/test/hours.rb

@@ -0,0 +1,17 @@
+require 'temporal'
+
+describe 'One hour in other units' do
+  it 'is 3600 seconds' do
+    1.hour.should == 3600.seconds
+  end
+  it 'is 60 minutes' do
+    1.hour.should == 60.minutes
+  end
+  it 'is 1/24th of a day' do
+    1.hour.should == (1.0/24).days
+  end
+  it 'is 1/168th of a week' do
+    1.hour.should == (1.0/168).weeks
+  end
+end
+

data/test/minutes.rb

@@ -0,0 +1,17 @@
+require 'temporal'
+
+describe 'One minute in other units' do
+  it 'is 60 seconds' do
+    1.minute.should == 60.seconds
+  end
+  it 'is 1/60th of an hour' do
+    1.minute.should == (1.0/60).hours
+  end
+  it 'is 1/1440th of a day' do
+    1.minute.should == (1.0/1440).days
+  end
+  it 'is 1/10080th of a week' do
+    1.minute.should == (1.0/10080).weeks
+  end
+end
+

data/test/months.rb

@@ -0,0 +1,19 @@
+require 'temporal'
+
+describe 'Temporal math with months' do
+
+  it 'should wrap years while adding' do
+    ( Time.local( 1975, 8, 1 ) + 5.months ).should == Time.local( 1976, 1, 1 )
+  end
+
+  it 'should not wrap years while adding 1 month to november' do
+    ( Time.local( 1975, 11, 1 ) + 1.month ).should == Time.local( 1975, 12, 1 )
+  end
+
+end
+
+describe 'One month in other units' do
+  it 'is 1/12th of a year' do
+    1.month.should == (1.0/12).years
+  end
+end

data/test/seconds.rb

@@ -0,0 +1,17 @@
+require 'temporal'
+
+describe 'One second in other units' do
+  it 'is 1/60th of a minute' do
+    1.second.should == (1.0/60).minutes
+  end
+  it 'is 1/3600th of a hour' do
+    1.second.should == (1.0/3600).hours
+  end
+  it 'is 1/86400th of a day' do
+    1.second.should == (1.0/86400).days
+  end
+  it 'is 1/604800th of a week' do
+    1.second.should == (1.0/604800).weeks
+  end
+end
+

data/test/weeks.rb

@@ -0,0 +1,16 @@
+require 'temporal'
+
+describe 'One week in other units' do
+  it 'is 604800 seconds' do
+    1.week.should == 604800.seconds
+  end
+  it 'is 10080 minutes' do
+    1.week.should == 10080.minutes
+  end
+  it 'is 168 hours' do
+    1.week.should == 168.hours
+  end
+  it 'is 7 days' do
+    1.week.should == 7.days
+  end
+end

data/test/years.rb

@@ -0,0 +1,7 @@
+require 'temporal'
+
+describe 'One year in other units' do
+  it 'is 12 months' do
+    1.year.should == 12.months
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification 
+name: temporal
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors: 
+- Clive Crous
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-18 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  type: :development
+  version_requirements: *id003
+description: "This project is still in early development. Only the mathematical side is complete. eg: Time.now + 3.years + 2.months"
+email: 
+- clive@crous.co.za
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.txt
+- Rakefile
+- lib/temporal.rb
+- lib/temporal/anomaly.rb
+- lib/temporal/helpers.rb
+- lib/temporal/mathematics.rb
+- lib/temporal/parser.rb
+- lib/temporal/parser/afrikaans.rb
+- lib/temporal/parser/english.rb
+- lib/temporal/shift.rb
+- lib/temporal/version.rb
+- temporal.gemspec
+- test/days.rb
+- test/hours.rb
+- test/minutes.rb
+- test/months.rb
+- test/seconds.rb
+- test/weeks.rb
+- test/years.rb
+has_rdoc: true
+homepage: http://www.darkarts.co.za/temporal
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: temporal
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A natural language date and time parser
+test_files: []
+