timing 0.0.2 → 0.0.3

data/lib/timing/natural_time_language.treetop

@@ -0,0 +1,227 @@
+module Timing
+  grammar NaturalTimeLanguage
+
+    rule expression
+      space* moment:moment space* zone_offset:zone_offset? space* <Expression>
+    end
+
+    rule moment
+      timestamp /
+      time_ago /
+      moment_at_time /
+      before_from_moment /
+      date_moment
+    end
+
+    rule date_moment
+      named_moment / 
+      last_next_day_name / 
+      day_month_name_year / 
+      year_month_day /
+      beginning_end_interval
+    end
+
+    rule named_moment
+      now / today / tomorrow / yesterday
+    end
+
+    rule last_next_day_name
+      direction:last_next space* day_name:day_name <LastNextDayName>
+    end
+
+    rule day_month_name_year
+      day:integer space* month:month_name space* year:integer? space* <DayMonthNameYear>
+    end
+
+    rule year_month_day
+      year:integer '-' month:integer '-' day:integer <YearMonthDay>
+    end
+
+    rule beginning_end_interval
+      direction:beginning_end space* interval_type:interval <BeginningEndInterval>
+    end
+
+    rule time_ago
+      number:integer space* interval_type:interval space* 'ago'i <TimeAgo>
+    end
+
+    rule moment_at_time
+      moment:date_moment space* 'at'i space* time:hour_minute_second <MomentAtTime>
+    end
+
+    rule before_from_moment
+      number:integer space* interval_type:interval space* direction:before_from space* moment:moment <BeforeFromMoment>
+    end
+
+    rule timestamp
+      [\d]4..4 '-' [\d]2..2 '-' [\d]2..2 space* 'T'? space* [\d]2..2 ':' [\d]2..2 ':' [\d]2..2 <Timestamp>
+    end
+
+    rule now
+      'now'i <Now>
+    end
+
+    rule today
+      'today'i <Today>
+    end
+
+    rule tomorrow
+      'tomorrow'i <Tomorrow>
+    end
+
+    rule yesterday
+      'yesterday'i <Yesterday>
+    end
+
+    rule last_next
+      last / next
+    end
+
+    rule last
+      'last'i <LastNext>
+    end
+
+    rule next
+      'next'i <LastNext>
+    end
+
+    rule beginning_end
+      beginning_of / end_of
+    end
+
+    rule beginning_of
+      direction:'beginning'i space* 'of'i <BeginningEnd>
+    end
+
+    rule end_of
+      direction:'end'i space* 'of'i <BeginningEnd>
+    end
+
+    rule before_from
+      before / from
+    end
+
+    rule before
+      'before'i <BeforeFrom>
+    end
+
+    rule from
+      'from'i <BeforeFrom>
+    end
+
+    rule interval
+      second_interval / 
+      minute_interval / 
+      hour_interval / 
+      day_interval / 
+      week_interval / 
+      month_interval / 
+      year_interval
+    end
+
+    rule second_interval
+      'second'i 's'i? <SecondInterval>
+    end
+
+    rule minute_interval
+      'minute'i 's'i? <MinuteInterval>
+    end
+
+    rule hour_interval
+      'hour'i 's'i? <HourInterval>
+    end
+
+    rule day_interval
+      'day'i 's'i? <DayInterval>
+    end
+
+    rule week_interval
+      'week'i 's'i?  <WeekInterval>
+    end
+
+    rule month_interval
+      'month'i 's'i?  <MonthInterval>
+    end
+
+    rule year_interval
+      'year'i 's'i?  <YearInterval>
+    end
+
+    rule day_name
+      long_day_name / short_day_name
+    end
+
+    rule long_day_name
+      'sunday'i    <DayName> /
+      'monday'i    <DayName> /
+      'tuesday'i   <DayName> /
+      'wednesday'i <DayName> /
+      'thursday'i  <DayName> /
+      'friday'i    <DayName> /
+      'saturday'i  <DayName>
+    end
+
+    rule short_day_name
+      'sun'i <DayName> /
+      'mon'i <DayName> /
+      'tue'i <DayName> /
+      'wed'i <DayName> /
+      'thu'i <DayName> /
+      'fri'i <DayName> /
+      'sat'i <DayName>
+    end
+
+    rule month_name
+      long_month_name / short_month_name
+    end
+
+    rule long_month_name
+      'january'i   <MonthName> /
+      'february'i  <MonthName> /
+      'march'i     <MonthName> /
+      'april'i     <MonthName> /
+      'may'i       <MonthName> /
+      'june'i      <MonthName> /
+      'july'i      <MonthName> /
+      'august'i    <MonthName> /
+      'september'i <MonthName> /
+      'october'i   <MonthName> /
+      'november'i  <MonthName> /
+      'december'i  <MonthName>
+    end
+
+    rule short_month_name
+      'jan'i <MonthName> /
+      'feb'i <MonthName> /
+      'mar'i <MonthName> /
+      'apr'i <MonthName> /
+      'may'i <MonthName> /
+      'jun'i <MonthName> /
+      'jul'i <MonthName> /
+      'aug'i <MonthName> /
+      'sep'i <MonthName> /
+      'oct'i <MonthName> /
+      'nov'i <MonthName> /
+      'dec'i <MonthName>
+    end
+
+    rule zone_offset
+      [+-] [\d]2..2 ':'? [\d]2..2 <ZoneOffset>
+    end
+
+    rule hour_minute_second
+      [\d]2..2 ':' [\d]2..2 (':' [\d]2..2)? <HourMinuteSecond> /
+      'beginning' <HourMinuteSecond> /
+      'end' <HourMinuteSecond>
+    end
+
+    rule integer
+      [\d]+ <Int>
+    end
+
+    rule space
+      [\s\t\n]
+    end
+
+  end
+end

data/lib/timing/natural_time_language_interpreters.rb

@@ -0,0 +1,326 @@
+module Timing
+  module NaturalTimeLanguage
+
+    class << self
+
+      def parse(expression)
+        parsed_expression = parser.parse expression
+        raise parser.failure_reason unless parsed_expression
+        parsed_expression.evaluate
+      end
+
+      private
+
+      def parser
+        @parser ||= NaturalTimeLanguageParser.new
+      end
+
+    end
+
+    class Expression < Treetop::Runtime::SyntaxNode
+      def evaluate
+        moment.evaluate zone_offset.empty? ? nil : zone_offset.value
+      end
+    end
+
+    class Now < Treetop::Runtime::SyntaxNode
+      def evaluate(zone_offset)
+        TimeInZone.now zone_offset
+      end
+    end
+
+    class Today < Treetop::Runtime::SyntaxNode
+      def evaluate(zone_offset)
+        TimeInZone.now(zone_offset).beginning_of_day
+      end
+    end
+
+    class Yesterday < Treetop::Runtime::SyntaxNode
+      def evaluate(zone_offset)
+        TimeInZone.now(zone_offset).beginning_of_day - Interval.days(1)
+      end
+    end
+
+    class Tomorrow < Treetop::Runtime::SyntaxNode
+      def evaluate(zone_offset)
+        TimeInZone.now(zone_offset).beginning_of_day + Interval.days(1)
+      end
+    end
+
+    class LastNextDayName < Treetop::Runtime::SyntaxNode
+      def evaluate(zone_offset)
+        today = TimeInZone.now(zone_offset).beginning_of_day
+
+        if direction.last?
+          if today.wday > day_name.value
+            today - Interval.days(today.wday - day_name.value)
+          else
+            today - Interval.weeks(1) + Interval.days(day_name.value - today.wday)
+          end
+        else
+          if today.wday < day_name.value
+            today + Interval.days(day_name.value - today.wday)
+          else
+            today + Interval.weeks(1) - Interval.days(today.wday - day_name.value)
+          end
+        end
+      end
+    end
+
+    class BeginningEndInterval < Treetop::Runtime::SyntaxNode
+      def evaluate(zone_offset)
+        now = TimeInZone.now zone_offset
+        if direction.beginning?
+          interval_type.beginning_of now
+        else
+          interval_type.end_of now
+        end
+      end
+    end
+
+    class TimeAgo < Treetop::Runtime::SyntaxNode
+      def evaluate(zone_offset)
+        now = TimeInZone.now zone_offset
+        interval_type.time_ago now, number.value
+      end
+    end
+
+    class DayMonthNameYear < Treetop::Runtime::SyntaxNode
+      def evaluate(zone_offset)
+        now = TimeInZone.now zone_offset
+        yyyy = year.empty? ? now.year : year.value
+        mm = month.value.to_s.rjust(2, '0')
+        dd = day.value.to_s.rjust(2, '0')
+        TimeInZone.parse "#{yyyy}-#{mm}-#{dd} 00:00:00 #{now.zone_offset}"
+      end
+    end
+
+    class YearMonthDay < Treetop::Runtime::SyntaxNode
+      def evaluate(zone_offset)
+        yyyy = year.value
+        mm = month.value.to_s.rjust(2, '0')
+        dd = day.value.to_s.rjust(2, '0')
+        TimeInZone.parse "#{yyyy}-#{mm}-#{dd} 00:00:00 #{zone_offset}"
+      end
+    end
+
+    class MomentAtTime < Treetop::Runtime::SyntaxNode
+      def evaluate(zone_offset)
+        date = moment.evaluate zone_offset
+        TimeInZone.parse "#{date.strftime('%F')} #{time.value} #{date.zone_offset}"
+      end
+    end
+
+    class BeforeFromMoment < Treetop::Runtime::SyntaxNode
+      def evaluate(zone_offset)
+        time = moment.evaluate zone_offset
+        if direction.before?
+          interval_type.time_ago time, number.value
+        else
+          interval_type.time_after time, number.value
+        end
+      end
+    end
+    
+    class Timestamp < Treetop::Runtime::SyntaxNode
+      def evaluate(zone_offset)
+        TimeInZone.parse "#{text_value}#{zone_offset}"
+      end
+    end
+
+    class BeginningEnd < Treetop::Runtime::SyntaxNode
+      def beginning?
+        direction.text_value.downcase == 'beginning'
+      end
+
+      def end?
+        direction.text_value.downcase == 'end'
+      end
+    end
+
+    class LastNext < Treetop::Runtime::SyntaxNode
+      def last?
+        text_value.downcase == 'last'
+      end
+
+      def next?
+        text_value.downcase == 'next'
+      end
+    end
+
+    class BeforeFrom < Treetop::Runtime::SyntaxNode
+      def before?
+        text_value.downcase == 'before'
+      end
+
+      def from?
+        text_value.downcase == 'from'
+      end
+    end
+
+    class SecondInterval < Treetop::Runtime::SyntaxNode
+      def time_ago(time, number)
+        time - Interval.seconds(number)
+      end
+
+      def time_after(time, number)
+        time + Interval.seconds(number)
+      end
+
+      def beginning_of(time)
+        raise 'Not supported'
+      end
+
+      def end_of(time)
+        raise 'Not supported'
+      end
+    end
+
+    class MinuteInterval < Treetop::Runtime::SyntaxNode
+      def time_ago(time, number)
+        time - Interval.minutes(number)
+      end
+
+      def time_after(time, number)
+        time + Interval.minutes(number)
+      end
+
+      def beginning_of(time)
+        raise 'Not supported'
+      end
+
+      def end_of(time)
+        raise 'Not supported'
+      end
+    end
+
+    class HourInterval < Treetop::Runtime::SyntaxNode
+      def time_ago(time, number)
+        time - Interval.hours(number)
+      end
+
+      def time_after(time, number)
+        time + Interval.hours(number)
+      end
+
+      def beginning_of(time)
+        time.beginning_of_hour
+      end
+
+      def end_of(time)
+        time.end_of_hour
+      end
+    end    
+
+    class DayInterval < Treetop::Runtime::SyntaxNode
+      def time_ago(time, number)
+        time - Interval.days(number)
+      end
+
+      def time_after(time, number)
+        time + Interval.days(number)
+      end
+
+      def beginning_of(time)
+        time.beginning_of_day
+      end
+
+      def end_of(time)
+        time.end_of_day
+      end
+    end
+
+    class WeekInterval < Treetop::Runtime::SyntaxNode
+      def time_ago(time, number)
+        time - Interval.weeks(number)
+      end
+
+      def time_after(time, number)
+        time + Interval.weeks(number)
+      end
+
+      def beginning_of(time)
+        time.beginning_of_week
+      end
+
+      def end_of(time)
+        time.end_of_week
+      end
+    end
+
+    class MonthInterval < Treetop::Runtime::SyntaxNode
+      def time_ago(time, number)
+        time.months_ago(number)
+      end
+
+      def time_after(time, number)
+        time.months_after(number)
+      end
+
+      def beginning_of(time)
+        time.beginning_of_month
+      end
+
+      def end_of(time)
+        time.end_of_month
+      end
+    end
+
+    class YearInterval < Treetop::Runtime::SyntaxNode
+      def time_ago(time, number)
+        time.years_ago(number)
+      end
+
+      def time_after(time, number)
+        time.years_after(number)
+      end
+
+      def beginning_of(time)
+        time.beginning_of_year
+      end
+
+      def end_of(time)
+        time.end_of_year
+      end
+    end    
+
+    class DayName < Treetop::Runtime::SyntaxNode
+      SHORT_NAMES = ['sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat']
+      def value
+        SHORT_NAMES.index text_value[0..2].downcase
+      end
+    end
+
+    class MonthName < Treetop::Runtime::SyntaxNode
+      SHORT_NAMES = ['', 'jan', 'feb', 'mar', 'apr', 'may', 'jun', 'jul', 'aug', 'sep', 'oct', 'nov', 'dec']
+      def value
+        SHORT_NAMES.index text_value[0..2].downcase
+      end
+    end
+
+    class HourMinuteSecond < Treetop::Runtime::SyntaxNode
+      def value
+        if text_value.downcase == 'beginning'
+          '00:00:00'
+        elsif text_value.downcase == 'end'
+          '23:59:59'
+        else
+          "#{text_value}:00"[0..7]
+        end
+      end
+    end
+
+    class ZoneOffset < Treetop::Runtime::SyntaxNode
+      def value
+        ::ZoneOffset.parse text_value
+      end
+    end
+
+    class Int < Treetop::Runtime::SyntaxNode
+      def value
+        text_value.to_i
+      end
+    end
+
+  end
+end