chronic-mmlac 0.6.4.2

data/lib/chronic/handlers.rb

@@ -0,0 +1,465 @@
+module Chronic
+  module Handlers
+    module_function
+
+    # Handle month/day
+    def handle_m_d(month, day, time_tokens, options)
+      month.start = Chronic.now
+      span = month.this(options[:context])
+      year, month = span.begin.year, span.begin.month
+      day_start = Chronic.time_class.local(year, month, day)
+
+      day_or_time(day_start, time_tokens, options)
+    end
+
+    # Handle repeater-month-name/scalar-day
+    def handle_rmn_sd(tokens, options)
+      month = tokens[0].get_tag(RepeaterMonthName)
+      day = tokens[1].get_tag(ScalarDay).type
+
+      return if month_overflow?(Chronic.now.year, month.index, day)
+
+      handle_m_d(month, day, tokens[2..tokens.size], options)
+    end
+
+    # Handle repeater-month-name/scalar-day with separator-on
+    def handle_rmn_sd_on(tokens, options)
+      if tokens.size > 3
+        month = tokens[2].get_tag(RepeaterMonthName)
+        day = tokens[3].get_tag(ScalarDay).type
+        token_range = 0..1
+      else
+        month = tokens[1].get_tag(RepeaterMonthName)
+        day = tokens[2].get_tag(ScalarDay).type
+        token_range = 0..0
+      end
+
+      return if month_overflow?(Chronic.now.year, month.index, day)
+
+      handle_m_d(month, day, tokens[token_range], options)
+    end
+
+    # Handle repeater-month-name/ordinal-day
+    def handle_rmn_od(tokens, options)
+      month = tokens[0].get_tag(RepeaterMonthName)
+      day = tokens[1].get_tag(OrdinalDay).type
+
+      return if month_overflow?(Chronic.now.year, month.index, day)
+
+      handle_m_d(month, day, tokens[2..tokens.size], options)
+    end
+
+    # Handle ordinal-day/repeater-month-name
+    def handle_od_rmn(tokens, options)
+      month = tokens[1].get_tag(RepeaterMonthName)
+      day = tokens[0].get_tag(OrdinalDay).type
+
+      return if month_overflow?(Chronic.now.year, month.index, day)
+
+      handle_m_d(month, day, tokens[2..tokens.size], options)
+    end
+
+    def handle_sy_rmn_od(tokens, options)
+      year = tokens[0].get_tag(ScalarYear).type
+      month = tokens[1].get_tag(RepeaterMonthName).index
+      day = tokens[2].get_tag(OrdinalDay).type
+      time_tokens = tokens.last(tokens.size - 3)
+
+      return if month_overflow?(year, month, day)
+
+      begin
+        day_start = Chronic.time_class.local(year, month, day)
+        day_or_time(day_start, time_tokens, options)
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    # Handle scalar-day/repeater-month-name
+    def handle_sd_rmn(tokens, options)
+      month = tokens[1].get_tag(RepeaterMonthName)
+      day = tokens[0].get_tag(ScalarDay).type
+
+      return if month_overflow?(Chronic.now.year, month.index, day)
+
+      handle_m_d(month, day, tokens[2..tokens.size], options)
+    end
+
+    # Handle repeater-month-name/ordinal-day with separator-on
+    def handle_rmn_od_on(tokens, options)
+      if tokens.size > 3
+        month = tokens[2].get_tag(RepeaterMonthName)
+        day = tokens[3].get_tag(OrdinalDay).type
+        token_range = 0..1
+      else
+        month = tokens[1].get_tag(RepeaterMonthName)
+        day = tokens[2].get_tag(OrdinalDay).type
+        token_range = 0..0
+      end
+
+      return if month_overflow?(Chronic.now.year, month.index, day)
+
+      handle_m_d(month, day, tokens[token_range], options)
+    end
+
+    # Handle repeater-month-name/scalar-year
+    def handle_rmn_sy(tokens, options)
+      month = tokens[0].get_tag(RepeaterMonthName).index
+      year = tokens[1].get_tag(ScalarYear).type
+
+      if month == 12
+        next_month_year = year + 1
+        next_month_month = 1
+      else
+        next_month_year = year
+        next_month_month = month + 1
+      end
+
+      begin
+        end_time = Chronic.time_class.local(next_month_year, next_month_month)
+        Span.new(Chronic.time_class.local(year, month), end_time)
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    # Handle generic timestamp (ruby 1.8)
+    def handle_rdn_rmn_sd_t_tz_sy(tokens, options)
+      t = Chronic.time_class.parse(options[:text])
+      Span.new(t, t + 1)
+    end
+
+    # Handle generic timestamp (ruby 1.9)
+    def handle_sy_sm_sd_t_tz(tokens, options)
+      t = Chronic.time_class.parse(options[:text])
+      Span.new(t, t + 1)
+    end
+
+    # Handle repeater-month-name/scalar-day/scalar-year
+    def handle_rmn_sd_sy(tokens, options)
+      month = tokens[0].get_tag(RepeaterMonthName).index
+      day = tokens[1].get_tag(ScalarDay).type
+      year = tokens[2].get_tag(ScalarYear).type
+      time_tokens = tokens.last(tokens.size - 3)
+
+      return if month_overflow?(year, month, day)
+
+      begin
+        day_start = Chronic.time_class.local(year, month, day)
+        day_or_time(day_start, time_tokens, options)
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    # Handle repeater-month-name/ordinal-day/scalar-year
+    def handle_rmn_od_sy(tokens, options)
+      month = tokens[0].get_tag(RepeaterMonthName).index
+      day = tokens[1].get_tag(OrdinalDay).type
+      year = tokens[2].get_tag(ScalarYear).type
+      time_tokens = tokens.last(tokens.size - 3)
+
+      return if month_overflow?(year, month, day)
+
+      begin
+        day_start = Chronic.time_class.local(year, month, day)
+        day_or_time(day_start, time_tokens, options)
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    # Handle oridinal-day/repeater-month-name/scalar-year
+    def handle_od_rmn_sy(tokens, options)
+      day = tokens[0].get_tag(OrdinalDay).type
+      month = tokens[1].get_tag(RepeaterMonthName).index
+      year = tokens[2].get_tag(ScalarYear).type
+      time_tokens = tokens.last(tokens.size - 3)
+
+      return if month_overflow?(year, month, day)
+
+      begin
+        day_start = Chronic.time_class.local(year, month, day)
+        day_or_time(day_start, time_tokens, options)
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    # Handle scalar-day/repeater-month-name/scalar-year
+    def handle_sd_rmn_sy(tokens, options)
+      new_tokens = [tokens[1], tokens[0], tokens[2]]
+      time_tokens = tokens.last(tokens.size - 3)
+      handle_rmn_sd_sy(new_tokens + time_tokens, options)
+    end
+
+    # Handle scalar-month/scalar-day/scalar-year (endian middle)
+    def handle_sm_sd_sy(tokens, options)
+      month = tokens[0].get_tag(ScalarMonth).type
+      day = tokens[1].get_tag(ScalarDay).type
+      year = tokens[2].get_tag(ScalarYear).type
+      time_tokens = tokens.last(tokens.size - 3)
+
+      return if month_overflow?(year, month, day)
+
+      begin
+        day_start = Chronic.time_class.local(year, month, day)
+        day_or_time(day_start, time_tokens, options)
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    # Handle scalar-day/scalar-month/scalar-year (endian little)
+    def handle_sd_sm_sy(tokens, options)
+      new_tokens = [tokens[1], tokens[0], tokens[2]]
+      time_tokens = tokens.last(tokens.size - 3)
+      handle_sm_sd_sy(new_tokens + time_tokens, options)
+    end
+
+    # Handle scalar-year/scalar-month/scalar-day
+    def handle_sy_sm_sd(tokens, options)
+      new_tokens = [tokens[1], tokens[2], tokens[0]]
+      time_tokens = tokens.last(tokens.size - 3)
+      handle_sm_sd_sy(new_tokens + time_tokens, options)
+    end
+
+    # Handle scalar-month/scalar-year
+    def handle_sm_sy(tokens, options)
+      month = tokens[0].get_tag(ScalarMonth).type
+      year = tokens[1].get_tag(ScalarYear).type
+
+      if month == 12
+        next_month_year = year + 1
+        next_month_month = 1
+      else
+        next_month_year = year
+        next_month_month = month + 1
+      end
+
+      begin
+        end_time = Chronic.time_class.local(next_month_year, next_month_month)
+        Span.new(Chronic.time_class.local(year, month), end_time)
+      rescue ArgumentError
+        nil
+      end
+    end
+
+    # anchors
+
+    # Handle repeaters
+    def handle_r(tokens, options)
+      dd_tokens = dealias_and_disambiguate_times(tokens, options)
+      get_anchor(dd_tokens, options)
+    end
+
+    # Handle repeater/grabber/repeater
+    def handle_r_g_r(tokens, options)
+      new_tokens = [tokens[1], tokens[0], tokens[2]]
+      handle_r(new_tokens, options)
+    end
+
+    # arrows
+
+    # Handle scalar/repeater/pointer helper
+    def handle_srp(tokens, span, options)
+      distance = tokens[0].get_tag(Scalar).type
+      repeater = tokens[1].get_tag(Repeater)
+      pointer = tokens[2].get_tag(Pointer).type
+
+      repeater.offset(span, distance, pointer)
+    end
+
+    # Handle scalar/repeater/pointer
+    def handle_s_r_p(tokens, options)
+      repeater = tokens[1].get_tag(Repeater)
+      span = Span.new(Chronic.now, Chronic.now + 1)
+
+      handle_srp(tokens, span, options)
+    end
+
+    # Handle pointer/scalar/repeater
+    def handle_p_s_r(tokens, options)
+      new_tokens = [tokens[1], tokens[2], tokens[0]]
+      handle_s_r_p(new_tokens, options)
+    end
+
+    # Handle scalar/repeater/pointer/anchor
+    def handle_s_r_p_a(tokens, options)
+      anchor_span = get_anchor(tokens[3..tokens.size - 1], options)
+      handle_srp(tokens, anchor_span, options)
+    end
+
+    # narrows
+
+    # Handle oridinal repeaters
+    def handle_orr(tokens, outer_span, options)
+      repeater = tokens[1].get_tag(Repeater)
+      repeater.start = outer_span.begin - 1
+      ordinal = tokens[0].get_tag(Ordinal).type
+      span = nil
+
+      ordinal.times do
+        span = repeater.next(:future)
+
+        if span.begin > outer_span.end
+          span = nil
+          break
+        end
+      end
+
+      span
+    end
+
+    # Handle ordinal/repeater/separator/repeater
+    def handle_o_r_s_r(tokens, options)
+      outer_span = get_anchor([tokens[3]], options)
+      handle_orr(tokens[0..1], outer_span, options)
+    end
+
+    # Handle ordinal/repeater/grabber/repeater
+    def handle_o_r_g_r(tokens, options)
+      outer_span = get_anchor(tokens[2..3], options)
+      handle_orr(tokens[0..1], outer_span, options)
+    end
+
+    # support methods
+
+    def day_or_time(day_start, time_tokens, options)
+      outer_span = Span.new(day_start, day_start + (24 * 60 * 60))
+
+      if !time_tokens.empty?
+        Chronic.now = outer_span.begin
+        get_anchor(dealias_and_disambiguate_times(time_tokens, options), options)
+      else
+        outer_span
+      end
+    end
+
+    def get_anchor(tokens, options)
+      grabber = Grabber.new(:this)
+      pointer = :future
+
+      repeaters = get_repeaters(tokens)
+      repeaters.size.times { tokens.pop }
+
+      if tokens.first && tokens.first.get_tag(Grabber)
+        grabber = tokens.shift.get_tag(Grabber)
+      end
+
+      head = repeaters.shift
+      head.start = Chronic.now
+
+      case grabber.type
+      when :last
+        outer_span = head.next(:past)
+      when :this
+        if options[:context] != :past and repeaters.size > 0
+          outer_span = head.this(:none)
+        else
+          outer_span = head.this(options[:context])
+        end
+      when :next
+        outer_span = head.next(:future)
+      else
+        raise ChronicPain, "Invalid grabber"
+      end
+
+      if Chronic.debug
+        puts "Handler-class: #{head.class}"
+        puts "--#{outer_span}"
+      end
+
+      find_within(repeaters, outer_span, pointer)
+    end
+
+    def get_repeaters(tokens)
+      tokens.map { |token| token.get_tag(Repeater) }.compact.sort.reverse
+    end
+
+    def month_overflow?(year, month, day)
+      if Date.leap?(year)
+        day > RepeaterMonth::MONTH_DAYS_LEAP[month - 1]
+      else
+        day > RepeaterMonth::MONTH_DAYS[month - 1]
+      end
+    end
+
+    # Recursively finds repeaters within other repeaters.
+    # Returns a Span representing the innermost time span
+    # or nil if no repeater union could be found
+    def find_within(tags, span, pointer)
+      puts "--#{span}" if Chronic.debug
+      return span if tags.empty?
+
+      head = tags.shift
+      head.start = (pointer == :future ? span.begin : span.end)
+      h = head.this(:none)
+
+      if span.cover?(h.begin) || span.cover?(h.end)
+        find_within(tags, h, pointer)
+      end
+    end
+
+    def dealias_and_disambiguate_times(tokens, options)
+      # handle aliases of am/pm
+      # 5:00 in the morning -> 5:00 am
+      # 7:00 in the evening -> 7:00 pm
+
+      day_portion_index = nil
+      tokens.each_with_index do |t, i|
+        if t.get_tag(RepeaterDayPortion)
+          day_portion_index = i
+          break
+        end
+      end
+
+      time_index = nil
+      tokens.each_with_index do |t, i|
+        if t.get_tag(RepeaterTime)
+          time_index = i
+          break
+        end
+      end
+
+      if day_portion_index && time_index
+        t1 = tokens[day_portion_index]
+        t1tag = t1.get_tag(RepeaterDayPortion)
+
+        case t1tag.type
+        when :morning
+          puts '--morning->am' if Chronic.debug
+          t1.untag(RepeaterDayPortion)
+          t1.tag(RepeaterDayPortion.new(:am))
+        when :afternoon, :evening, :night
+          puts "--#{t1tag.type}->pm" if Chronic.debug
+          t1.untag(RepeaterDayPortion)
+          t1.tag(RepeaterDayPortion.new(:pm))
+        end
+      end
+
+      # handle ambiguous times if :ambiguous_time_range is specified
+      if options[:ambiguous_time_range] != :none
+        ambiguous_tokens = []
+
+        tokens.each_with_index do |token, i|
+          ambiguous_tokens << token
+          next_token = tokens[i + 1]
+
+          if token.get_tag(RepeaterTime) && token.get_tag(RepeaterTime).type.ambiguous? && (!next_token || !next_token.get_tag(RepeaterDayPortion))
+            distoken = Token.new('disambiguator')
+
+            distoken.tag(RepeaterDayPortion.new(options[:ambiguous_time_range]))
+            ambiguous_tokens << distoken
+          end
+        end
+
+        tokens = ambiguous_tokens
+      end
+
+      tokens
+    end
+
+  end
+
+end

data/lib/chronic/mini_date.rb

@@ -0,0 +1,38 @@
+module Chronic
+  class MiniDate
+    attr_accessor :month, :day
+
+    def self.from_time(time)
+      new(time.month, time.day)
+    end
+
+    def initialize(month, day)
+      unless (1..12).include?(month)
+        raise ArgumentError, "1..12 are valid months"
+      end
+
+      @month = month
+      @day = day
+    end
+
+    def is_between?(md_start, md_end)
+      return false if (@month == md_start.month && @month == md_end.month) &&
+                      (@day < md_start.day || @day > md_end.day)
+      return true if (@month == md_start.month && @day >= md_start.day) ||
+                     (@month == md_end.month && @day <= md_end.day)
+
+      i = (md_start.month % 12) + 1
+
+      until i == md_end.month
+        return true if @month == i
+        i = (i % 12) + 1
+      end
+
+      return false
+    end
+
+    def equals?(other)
+      @month == other.month and @day == other.day
+    end
+  end
+end

data/lib/chronic/numerizer.rb

@@ -0,0 +1,121 @@
+require 'strscan'
+
+module Chronic
+  class Numerizer
+
+    DIRECT_NUMS = [
+      ['eleven', '11'],
+      ['twelve', '12'],
+      ['thirteen', '13'],
+      ['fourteen', '14'],
+      ['fifteen', '15'],
+      ['sixteen', '16'],
+      ['seventeen', '17'],
+      ['eighteen', '18'],
+      ['nineteen', '19'],
+      ['ninteen', '19'], # Common mis-spelling
+      ['zero', '0'],
+      ['one', '1'],
+      ['two', '2'],
+      ['three', '3'],
+      ['four(\W|$)', '4\1'],  # The weird regex is so that it matches four but not fourty
+      ['five', '5'],
+      ['six(\W|$)', '6\1'],
+      ['seven(\W|$)', '7\1'],
+      ['eight(\W|$)', '8\1'],
+      ['nine(\W|$)', '9\1'],
+      ['ten', '10'],
+      ['\ba[\b^$]', '1'] # doesn't make sense for an 'a' at the end to be a 1
+    ]
+
+    ORDINALS = [
+      ['first', '1'],
+      ['third', '3'],
+      ['fourth', '4'],
+      ['fifth', '5'],
+      ['sixth', '6'],
+      ['seventh', '7'],
+      ['eighth', '8'],
+      ['ninth', '9'],
+      ['tenth', '10']
+    ]
+
+    TEN_PREFIXES = [
+      ['twenty', 20],
+      ['thirty', 30],
+      ['forty', 40],
+      ['fourty', 40], # Common mis-spelling
+      ['fifty', 50],
+      ['sixty', 60],
+      ['seventy', 70],
+      ['eighty', 80],
+      ['ninety', 90]
+    ]
+
+    BIG_PREFIXES = [
+      ['hundred', 100],
+      ['thousand', 1000],
+      ['million', 1_000_000],
+      ['billion', 1_000_000_000],
+      ['trillion', 1_000_000_000_000],
+    ]
+
+    def self.numerize(string)
+      string = string.dup
+
+      # preprocess
+      string.gsub!(/ +|([^\d])-([^\d])/, '\1 \2') # will mutilate hyphenated-words but shouldn't matter for date extraction
+      string.gsub!(/a half/, 'haAlf') # take the 'a' out so it doesn't turn into a 1, save the half for the end
+
+      # easy/direct replacements
+
+      DIRECT_NUMS.each do |dn|
+        string.gsub!(/#{dn[0]}/i, '<num>' + dn[1])
+      end
+
+      ORDINALS.each do |on|
+        string.gsub!(/#{on[0]}/i, '<num>' + on[1] + on[0][-2, 2])
+      end
+
+      # ten, twenty, etc.
+
+      TEN_PREFIXES.each do |tp|
+        string.gsub!(/(?:#{tp[0]}) *<num>(\d(?=[^\d]|$))*/i) { '<num>' + (tp[1] + $1.to_i).to_s }
+      end
+
+      TEN_PREFIXES.each do |tp|
+        string.gsub!(/#{tp[0]}/i) { '<num>' + tp[1].to_s }
+      end
+
+      # hundreds, thousands, millions, etc.
+
+      BIG_PREFIXES.each do |bp|
+        string.gsub!(/(?:<num>)?(\d*) *#{bp[0]}/i) { '<num>' + (bp[1] * $1.to_i).to_s}
+        andition(string)
+      end
+
+      # fractional addition
+      # I'm not combining this with the previous block as using float addition complicates the strings
+      # (with extraneous .0's and such )
+      string.gsub!(/(\d+)(?: | and |-)*haAlf/i) { ($1.to_f + 0.5).to_s }
+
+      string.gsub(/<num>/, '')
+    end
+
+    class << self
+      private
+
+      def andition(string)
+        sc = StringScanner.new(string)
+
+        while sc.scan_until(/<num>(\d+)( | and )<num>(\d+)(?=[^\w]|$)/i)
+          if sc[2] =~ /and/ || sc[1].size > sc[3].size
+            string[(sc.pos - sc.matched_size)..(sc.pos-1)] = '<num>' + (sc[1].to_i + sc[3].to_i).to_s
+            sc.reset
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/chronic/ordinal.rb

@@ -0,0 +1,44 @@
+module Chronic
+  class Ordinal < Tag
+
+    # Scan an Array of {Token}s and apply any necessary Ordinal tags to
+    # each token
+    #
+    # @param [Array<Token>] tokens Array of tokens to scan
+    # @param [Hash] options Options specified in {Chronic.parse}
+    # @return [Array] list of tokens
+    def self.scan(tokens, options)
+      tokens.each do |token|
+        if t = scan_for_ordinals(token) then token.tag(t) end
+        if t = scan_for_days(token) then token.tag(t) end
+      end
+    end
+
+    # @param [Token] token
+    # @return [Ordinal, nil]
+    def self.scan_for_ordinals(token)
+      Ordinal.new($1.to_i) if token.word =~ /^(\d*)(st|nd|rd|th)$/
+    end
+
+    # @param [Token] token
+    # @return [OrdinalDay, nil]
+    def self.scan_for_days(token)
+      if token.word =~ /^(\d*)(st|nd|rd|th)$/
+        unless $1.to_i > 31 || $1.to_i < 1
+          OrdinalDay.new(token.word.to_i)
+        end
+      end
+    end
+
+    def to_s
+      'ordinal'
+    end
+  end
+
+  class OrdinalDay < Ordinal #:nodoc:
+    def to_s
+      super << '-day-' << @type.to_s
+    end
+  end
+
+end

data/lib/chronic/pointer.rb

@@ -0,0 +1,30 @@
+module Chronic
+  class Pointer < Tag
+
+    # Scan an Array of {Token}s and apply any necessary Pointer tags to
+    # each token
+    #
+    # @param [Array<Token>] tokens Array of tokens to scan
+    # @param [Hash] options Options specified in {Chronic.parse}
+    # @return [Array] list of tokens
+    def self.scan(tokens, options)
+      tokens.each do |token|
+        if t = scan_for_all(token) then token.tag(t) end
+      end
+    end
+
+    # @param [Token] token
+    # @return [Pointer, nil]
+    def self.scan_for_all(token)
+      scan_for token, self,
+      {
+        /\bpast\b/ => :past,
+        /\b(?:future|in)\b/ => :future,
+      }
+    end
+
+    def to_s
+      'pointer-' << @type.to_s
+    end
+  end
+end