chronic-davispuh 0.10.2.v0.1da32066b3f46f2506b3471e39557497e34afa27

data/lib/chronic/date.rb

@@ -0,0 +1,272 @@
+module Chronic
+  class Date
+    YEAR_QUARTERS     = 4
+    YEAR_MONTHS       = 12
+    SEASON_MONTHS     = 3
+    QUARTER_MONTHS    = 3
+    MONTH_DAYS        = [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+    MONTH_DAYS_LEAP   = [nil, 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+    FORTNIGHT_DAYS    = 14
+    WEEK_DAYS         =  7
+    DAY_HOURS         = 24
+    YEAR_SECONDS      = 31_536_000 # 365 * 24 * 60 * 60
+    SEASON_SECONDS    =  7_862_400 #  91 * 24 * 60 * 60
+    QUARTER_SECONDS   =  7_776_000 #  90 * 24 * 60 * 60
+    MONTH_SECONDS     =  2_592_000 #  30 * 24 * 60 * 60
+    FORTNIGHT_SECONDS =  1_209_600 #  14 * 24 * 60 * 60
+    WEEK_SECONDS      =    604_800 #   7 * 24 * 60 * 60
+    WEEKEND_SECONDS   =    172_800 #   2 * 24 * 60 * 60
+    DAY_SECONDS       =     86_400 #       24 * 60 * 60
+    SEASONS = [
+      :spring,
+      :summer,
+      :autumn,
+      :winter
+    ]
+    SEASON_DATES = {
+      :spring => [3, 20],
+      :summer => [6, 21],
+      :autumn => [9, 23],
+      :winter => [12, 22]
+    }
+    QUARTERS = [nil, 1, 4, 7, 10]
+    MONTHS = {
+      :january => 1,
+      :february => 2,
+      :march => 3,
+      :april => 4,
+      :may => 5,
+      :june => 6,
+      :july => 7,
+      :august => 8,
+      :september => 9,
+      :october => 10,
+      :november => 11,
+      :december => 12
+    }
+    DAYS = {
+      :sunday => 0,
+      :monday => 1,
+      :tuesday => 2,
+      :wednesday => 3,
+      :thursday => 4,
+      :friday => 5,
+      :saturday => 6
+    }
+
+    # Checks if given number could be day
+    def self.could_be_day?(day, width = nil)
+      day >= 1 && day <= 31 && (width.nil? || width <= 2)
+    end
+
+    # Checks if given number could be month
+    def self.could_be_month?(month, width = nil)
+      month >= 1 && month <= 12 && (width.nil? || width <= 2)
+    end
+
+    # Checks if given number could be year
+    def self.could_be_year?(year, width = nil)
+      year >= 0 && year <= 9999 && (width.nil? || width == 2 || width == 4)
+    end
+    # Build a year from a 2 digit suffix.
+    #
+    # year - The two digit Integer year to build from.
+    # bias - The Integer amount of future years to bias.
+    #
+    # Examples:
+    #
+    #   make_year(96, 50) #=> 1996
+    #   make_year(79, 20) #=> 2079
+    #   make_year(00, 50) #=> 2000
+    #
+    # Returns The Integer 4 digit year.
+    def self.make_year(year, bias)
+      return year if year.to_s.size > 2
+      start_year = Chronic.time_class.now.year - bias
+      century = (start_year / 100) * 100
+      full_year = century + year
+      full_year += 100 if full_year < start_year
+      full_year
+    end
+
+    def self.days_month(year, month)
+      days_month = ::Date.leap?(year) ? Date::MONTH_DAYS_LEAP[month] : Date::MONTH_DAYS[month]
+    end
+
+    def self.month_overflow?(year, month, day)
+      day > days_month(year, month)
+    end
+
+    def self.add_season(year, season, modifier = 1)
+      index = SEASONS.index(season) + modifier
+      year += index / SEASONS.count
+      season = SEASONS[index % SEASONS.count]
+      [year, season]
+    end
+
+    def self.add_quarter(year, quarter, amount = 1)
+      quarter += amount
+      if quarter > YEAR_QUARTERS or quarter < 1
+        year += (quarter - 1) / YEAR_QUARTERS
+        quarter = (quarter - 1) % YEAR_QUARTERS + 1
+      end
+      [year, quarter]
+    end
+
+    def self.add_month(year, month, amount = 1)
+      month += amount
+      if month > YEAR_MONTHS or month < 1
+        year += (month - 1) / YEAR_MONTHS
+        month = (month - 1) % YEAR_MONTHS + 1
+      end
+      [year, month]
+    end
+
+    def self.add_day(year, month, day, amount = 1)
+      day += amount
+      days_month = self.days_month(year, month)
+      while day > days_month
+        day -= days_month
+        year, month = add_month(year, month, 1)
+        days_month = self.days_month(year, month)
+      end
+      days_prev_month = self.days_month(year, (month - 2) % YEAR_MONTHS + 1)
+      while day < 1
+        day += days_prev_month
+        year, month = add_month(year, month, -1)
+        days_prev_month = self.days_month(year, month)
+      end
+      [year, month, day]
+    end
+
+    def self.get_quarter_index(month)
+      (month - 1) / QUARTER_MONTHS + 1
+    end
+
+    def self.get_quarter_month(month)
+      (get_quarter_index(month) - 1) * QUARTER_MONTHS + 1
+    end
+
+    def self.get_quarter_end(quarter)
+      QUARTERS[(quarter - 1) % YEAR_QUARTERS + 1]
+    end
+
+    def self.normalize(year, month, day)
+      year, month = add_month(year, month, 0)
+      year, month, day = add_day(year, month, day, 0)
+      [year, month, day]
+    end
+
+    def self.split(date)
+      [date.year, date.month, date.day]
+    end
+
+    def self.calculate_difference(diff, limit, modifier = 1, context = 0)
+      state = diff <=> 0
+      unless modifier.zero?
+        skew = modifier
+        skew += (modifier <=> 0) * -1 if diff * modifier > 0
+        diff += limit * skew
+      end
+      unless context.zero?
+        if modifier.zero?
+          diff += limit * context if state * context <= 0
+        elsif state.zero?
+          diff += limit * context if modifier * context < 0
+        end
+      end
+      diff
+    end
+
+    # Calculate difference in days between given week day and date day
+    def self.wday_diff(date, wday, modifier = 1, context = 0)
+      self.calculate_difference(wday - date.wday, WEEK_DAYS, modifier, context)
+    end
+
+    # Get day difference for weekday
+    def self.wd_diff(date, modifier = 1)
+      diff = modifier
+      wday = date.wday
+      if modifier == 0 and wday == DAYS[:sunday]
+        diff = 1
+      elsif modifier == 0 and wday == DAYS[:saturday]
+        diff = 2
+      elsif modifier == 1 and wday == DAYS[:friday]
+        diff = 3
+      elsif modifier == 1 and wday == DAYS[:saturday]
+        diff = 2
+      elsif modifier == -1 and wday == DAYS[:sunday]
+        diff = -2
+      elsif modifier == -1 and wday == DAYS[:monday]
+        diff = -3
+      end
+      diff
+    end
+
+    # Calculate difference in months between given month and date month
+    def self.month_diff(date_month, month, modifier = 1, context = 0)
+      self.calculate_difference(month - date_month, YEAR_MONTHS, modifier, context)
+    end
+
+    # Calculate difference in quarters between given quarter and date quarter
+    def self.quarter_diff(date_quarter, quarter, modifier = 1, context = 0)
+      self.calculate_difference(quarter - date_quarter, YEAR_QUARTERS, modifier, context)
+    end
+
+  end
+
+  module DateStructure
+    attr_accessor :year
+    attr_accessor :month
+    attr_accessor :day
+    attr_accessor :have_year
+    attr_accessor :have_month
+    attr_accessor :have_day
+    attr_reader :precision
+    def update(date)
+      @year = date.year
+      @month = date.month
+      @day = date.day
+      self
+    end
+
+    def is_equal?(date)
+      @year == date.year &&
+      @month == date.month &&
+      @day == date.day
+    end
+
+    def add_day(amount = 1)
+      @year, @month, @day = Date::add_day(@year, @month, @day, amount)
+    end
+
+    def to_a
+      [@year, @month, @day]
+    end
+
+    def get_end
+      [@year, @month, @day]
+    end
+
+    def to_span(time = nil, timezone = nil)
+      hour = minute = second = 0
+      hour, minute, second = time.to_a if time
+      span_start = Chronic.construct(@year, @month, @day, hour, minute, second, timezone)
+      end_year, end_month, end_day = get_end
+      span_end = Chronic.construct(end_year, end_month, end_day, 0, 0, 0, timezone)
+      span = Span.new(span_start, span_end, true)
+      span.precision = @precision
+      span.precision = time.precision if time and time.precision
+      span
+    end
+  end
+
+  class DateInfo
+    include DateStructure
+    def initialize(now = nil)
+      @now = now ? now : Chronic.time_class.now
+      update(@now)
+    end
+  end
+
+end

data/lib/chronic/definition.rb

@@ -0,0 +1,208 @@
+module Chronic
+  # SpanDefinitions subclasses return definitions constructed by Handler instances (see handler.rb)
+  # SpanDefinitions subclasses follow a <Type> + Definitions naming pattern
+  # Types of Definitions are collected in Dictionaries (see dictionary.rb)
+  class Definitions
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def definitions
+      raise "definitions are set in subclasses of #{self.class}"
+    end
+  end
+
+  class SpanDefinitions < Definitions
+  end
+
+  # Match only Time
+  class TimeDefinitions < SpanDefinitions
+    def definitions
+      [
+        [[SeparatorSpace, TimeSpecial, SeparatorSpace, [KeywordAt, :optional], [SeparatorSpace, :optional], ScalarHour, SeparatorColon, ScalarMinute], :handle_ts_h_m],
+        [[SeparatorSpace, TimeSpecial, SeparatorSpace, [KeywordAt, :optional], [SeparatorSpace, :optional], ScalarHour], :handle_ts_h],
+        [[[KeywordAt, :optional], SeparatorSpace, ScalarHour,  SeparatorColon, ScalarMinute, SeparatorColon, ScalarSecond, [SeparatorDot, SeparatorColon], ScalarSubsecond], :handle_h_m_s_ss],
+        [[[KeywordAt, :optional], SeparatorSpace, ScalarHour,  SeparatorColon, ScalarMinute, [SeparatorColon, SeparatorDot], ScalarSecond, [SeparatorSpace, :optional], DayPortion], :handle_h_m_s_dp],
+        [[[KeywordAt, :optional], SeparatorSpace, ScalarHour,  SeparatorColon, ScalarMinute, [SeparatorColon, SeparatorDot], ScalarSecond], :handle_h_m_s],
+        [[[KeywordAt, :optional], SeparatorSpace, ScalarHour, [SeparatorColon, SeparatorDot], ScalarMinute, SeparatorSpace, [KeywordIn, KeywordAt], SeparatorSpace, TimeSpecial], :handle_h_m_ts],
+        [[[KeywordAt, :optional], SeparatorSpace, ScalarHour, [SeparatorColon, SeparatorDot], ScalarMinute, [SeparatorSpace, :optional], DayPortion], :handle_h_m_dp],
+        [[[KeywordAt, :optional], SeparatorSpace, ScalarHour, [SeparatorColon, SeparatorDot], ScalarMinute], :handle_h_m],
+        [[[KeywordAt, :optional], SeparatorSpace, ScalarWide, [SeparatorSpace, :optional], DayPortion], :handle_hhmm_dp],
+        [[[KeywordAt, :optional], SeparatorSpace, ScalarHour,  SeparatorSpace, KeywordIn, SeparatorSpace, TimeSpecial], :handle_h_ts],
+        [[[KeywordAt, :optional], SeparatorSpace, ScalarHour,  SeparatorSpace, [KeywordAt, :optional], [SeparatorSpace, :optional], TimeSpecial], :handle_h_ts],
+        [[[KeywordAt, :optional], SeparatorSpace, ScalarHour, [SeparatorSpace, :optional], DayPortion], :handle_h_dp],
+        [[[KeywordAt, :optional], SeparatorSpace, ScalarWide,  SeparatorSpace], :handle_hhmm],
+        [[[KeywordAt, :optional], SeparatorSpace, TimeSpecial], :handle_ts],
+        [[[KeywordAt, :optional], SeparatorSpace, ScalarHour,  SeparatorSpace], :handle_h]
+      ]
+    end
+  end
+
+  # Match only Date
+  class DateDefinitions < SpanDefinitions
+    def definitions
+      [
+        [[DayName,    SeparatorSpace, MonthName,   SeparatorSpace, OrdinalDay, SeparatorSpace, ScalarYear], :handle_dn_mn_od_sy],
+        [[DayName,    SeparatorSpace, MonthName,   SeparatorSpace, ScalarDay, SeparatorSpace, ScalarYear], :handle_dn_mn_sd_sy],
+        [[DayName,    SeparatorSpace, MonthName,   SeparatorSpace, OrdinalDay], :handle_dn_mn_od],
+        [[DayName,    SeparatorSpace, MonthName,   SeparatorSpace, ScalarDay], :handle_dn_mn_sd],
+        [[MonthName,  SeparatorSpace, OrdinalDay, [SeparatorComma, SeparatorSpace], [SeparatorSpace, :optional], ScalarYear], :handle_mn_od_sy],
+        [[MonthName,  SeparatorSpace, ScalarDay,  [SeparatorComma, :optional], [SeparatorSpace, :optional], ScalarYear], :handle_mn_sd_sy],
+        [[ScalarYear, SeparatorSpace, MonthName,   SeparatorSpace, OrdinalDay], :handle_sy_mn_od],
+        [[ScalarYear, SeparatorSpace, MonthName,   SeparatorSpace, ScalarDay], :handle_sy_mn_sd],
+        [[ScalarYear, SeparatorSlash, ScalarMonth, SeparatorSlash, ScalarDay], :handle_sy_sm_sd],
+        [[ScalarYear, SeparatorDash,  ScalarMonth, SeparatorDash,  ScalarDay], :handle_sy_sm_sd],
+        [[ScalarYear, SeparatorDot,   ScalarMonth, SeparatorDot,   ScalarDay], :handle_sy_sm_sd],
+        [[ScalarYear, SeparatorColon, ScalarMonth, SeparatorColon, ScalarDay], :handle_sy_sm_sd],
+        [[OrdinalDay, SeparatorSpace, MonthName,   SeparatorSpace, ScalarYear], :handle_od_mn_sy],
+        [[ScalarDay,  SeparatorDash,  MonthName,   SeparatorDash,  ScalarYear], :handle_sd_mn_sy],
+        [[ScalarDay,  SeparatorSpace, MonthName,   SeparatorSpace, ScalarYear], :handle_sd_mn_sy],
+        [[ScalarDay,  SeparatorDot,   ScalarMonth, SeparatorDot,   ScalarYear], :handle_sd_sm_sy]
+      ]
+    end
+  end
+
+  # Match only Date in short form
+  class ShortDateDefinitions < SpanDefinitions
+    def definitions
+      [
+        [[DayName,    SeparatorSpace, OrdinalDay], :handle_dn_od],
+        [[MonthName,  SeparatorSpace, OrdinalDay], :handle_mn_od],
+        [[MonthName, [SeparatorSpace, SeparatorDash], ScalarDay, [SeparatorSpace, Unit, :none]], :handle_mn_sd],
+        [[MonthName,  SeparatorSpace, SeparatorApostrophe, ScalarYear], :handle_mn_sy],
+        [[MonthName,  SeparatorSpace, ScalarYear], :handle_mn_sy],
+        [[ScalarFullYear, [SeparatorDash, SeparatorSlash],   ScalarMonth], :handle_sy_sm],
+        [[ScalarFullYear, SeparatorSpace, MonthName], :handle_sy_mn],
+        [[OrdinalDay, SeparatorSpace, MonthName], :handle_od_mn],
+        [[ScalarDay, [SeparatorSpace, SeparatorDash, :optional], MonthName], :handle_sd_mn],
+        [[KeywordIn,  SeparatorSpace, MonthName], :handle_mn],
+        [[DaySpecial], :handle_ds],
+        [[MonthName],  :handle_mn],
+        [[DayName],    :handle_dn],
+        [[SeparatorSpace, ScalarYear, SeparatorSpace], :handle_sy],
+        [[OrdinalDay],     :handle_od],
+        [[ScalarFullYear], :handle_sy]
+      ]
+    end
+  end
+
+  # Match only TimeZone
+  class TimezoneDefinitions < SpanDefinitions
+    def definitions
+      [
+        [[[Sign, :optional], ScalarHour, SeparatorColon, ScalarMinute], :handle_hh_mm],
+        [[Sign, ScalarWide], :handle_hhmm],
+        [[TimeZoneAbbreviation], :handle_abbr],
+        [[TimeZoneGeneric], :handle_generic]
+      ]
+    end
+  end
+
+  # Match full Date+Time, can be with TimeZone
+  class DateTimeDefinitions < SpanDefinitions
+    def definitions
+      [
+        [[DayName, SeparatorSpace, MonthName, SeparatorSpace, ScalarDay, SeparatorSpace, ScalarHour, SeparatorColon, ScalarMinute, SeparatorColon, ScalarSecond, SeparatorSpace, TimeZoneAbbreviation, SeparatorSpace, ScalarYear], :handle_dn_mn_sd_h_m_s_abbr_sy],
+        [[ScalarYear, SeparatorDash,  ScalarMonth, SeparatorDash,  ScalarDay, SeparatorT, ScalarHour, SeparatorColon, ScalarMinute, SeparatorColon, ScalarSecond, [SeparatorDot, SeparatorColon], ScalarSubsecond, Sign, ScalarHour, SeparatorColon, ScalarMinute], :handle_sy_sm_sd_h_m_s_ss_hh_mm],
+        [[ScalarYear, SeparatorDash,  ScalarMonth, SeparatorDash,  ScalarDay, SeparatorT, ScalarHour, SeparatorColon, ScalarMinute, SeparatorColon, ScalarSecond, Sign, ScalarHour, SeparatorColon, ScalarMinute], :handle_sy_sm_sd_h_m_s_hh_mm],
+        [[ScalarYear, SeparatorDash,  ScalarMonth, SeparatorDash,  ScalarDay, SeparatorT, ScalarHour, SeparatorColon, ScalarMinute, SeparatorColon, ScalarSecond, [SeparatorDot, SeparatorColon], ScalarSubsecond, TimeZoneGeneric], :handle_sy_sm_sd_h_m_s_ss_tz],
+        [[ScalarYear, SeparatorDash,  ScalarMonth, SeparatorDash,  ScalarDay, SeparatorT, ScalarHour, SeparatorColon, ScalarMinute, SeparatorColon, ScalarSecond, [SeparatorDot, SeparatorColon], ScalarSubsecond], :handle_sy_sm_sd_h_m_s_ss],
+        [[ScalarYear, SeparatorDash,  ScalarMonth, SeparatorDash,  ScalarDay, SeparatorT, ScalarHour, SeparatorColon, ScalarMinute, SeparatorColon, ScalarSecond, TimeZoneGeneric], :handle_sy_sm_sd_h_m_s_tz],
+        [[ScalarYear, SeparatorDash,  ScalarMonth, SeparatorDash,  ScalarDay, SeparatorT, ScalarHour, SeparatorColon, ScalarMinute, SeparatorColon, ScalarSecond], :handle_sy_sm_sd_h_m_s]
+      ]
+    end
+  end
+
+  class AnchorDefinitions < SpanDefinitions
+    def definitions
+      [
+        [[Grabber, SeparatorSpace, DayName],     :handle_gr_dn],
+        [[Grabber, SeparatorSpace, MonthName],   :handle_gr_mn],
+        [[Grabber, SeparatorSpace, SeasonName],  :handle_gr_sn],
+        [[Grabber, SeparatorSpace, TimeSpecial], :handle_gr_ts],
+        [[Grabber, SeparatorSpace, KeywordQ, Scalar], :handle_gr_q_s],
+        [[Grabber, SeparatorSpace, Unit],        :handle_gr_u],
+        [[KeywordIn, SeparatorSpace, Scalar, SeparatorSpace, Unit], :handle_in_s_u],
+        [[DaySpecial], :handle_ds],
+        [[KeywordQ, Scalar], :handle_q_s],
+        [[Unit],       :handle_u]
+      ]
+    end
+  end
+
+  class ArrowDefinitions < SpanDefinitions
+    def definitions
+      [
+        [[Pointer, [SeparatorSpace, :optional], Scalar, [SeparatorSpace, :optional], Unit], :handle_p_s_u],
+        [[Scalar,  [SeparatorSpace, :optional], Unit,    SeparatorSpace, Pointer], :handle_s_u_p],
+        [[Scalar,  [SeparatorSpace, :optional], DayName, SeparatorSpace, Pointer], :handle_s_dn_p],
+        [[Rational, SeparatorSpace, Pointer], :handle_r_p],
+        [[Unit,     SeparatorSpace, Pointer], :handle_u_p],
+        [[Scalar,  [SeparatorSpace, :optional], Unit], :handle_s_u],
+        [[Scalar,  [SeparatorSpace, :optional], Pointer], :handle_s_p],
+      ]
+    end
+  end
+
+  class NarrowDefinitions < SpanDefinitions
+    def definitions
+      [
+        [[Grabber,  SeparatorSpace, Ordinal, SeparatorSpace, Unit], :handle_gr_o_u],
+        [[Ordinal,  SeparatorSpace, Unit], :handle_o_u],
+        [[Ordinal,  SeparatorSpace, DayName], :handle_o_dn],
+        [[KeywordQ, Scalar], :handle_q_s]
+      ]
+    end
+  end
+
+  # Date depending on endianess
+  class EndianDefinitions < SpanDefinitions
+    def definitions
+      prefered_endian
+    end
+
+    def self.middle
+      [
+        [[ScalarMonth,  SeparatorSlash, ScalarDay,    SeparatorSlash, ScalarYear, [SeparatorDot, Scalar, :none]],  :handle_sm_sd_sy],
+        [[ScalarMonth,  SeparatorDash,  ScalarDay,    SeparatorDash,  ScalarYear, [SeparatorDot, Scalar, :none]],  :handle_sm_sd_sy],
+        [[ScalarMonth, [SeparatorSlash, SeparatorDash, SeparatorDot],  ScalarDay, [SeparatorSlash, :none]],  :handle_sm_sd]
+      ]
+    end
+
+    def self.little
+      [
+        [[ScalarDay,   SeparatorDash,  ScalarMonth,   SeparatorDash,  ScalarYear, [SeparatorDot, Scalar, :none]],  :handle_sd_sm_sy],
+        [[ScalarDay,   SeparatorSlash, ScalarMonth,   SeparatorSlash, ScalarYear, [SeparatorDot, Scalar, :none]],  :handle_sd_sm_sy],
+        [[ScalarDay,  [SeparatorSlash, SeparatorDash, SeparatorDot],  ScalarMonth, [SeparatorSlash, :none]], :handle_sd_sm]
+      ]
+    end
+
+    def self.month_year
+      [
+        [[ScalarMonth, SeparatorSlash, ScalarYear], :handle_sm_sy]
+      ]
+    end
+
+    def prefered_endian
+      options[:endian_precedence] ||= [:middle, :little]
+      options[:endian_precedence] = [options[:endian_precedence]] unless options[:endian_precedence].is_a?(Array)
+      definition_list = []
+      options[:endian_precedence].each do |endian|
+        case endian
+        when :little
+          definition_list += self.class.little
+        when :middle
+          definition_list += self.class.middle
+        when :month_year
+          definition_list += self.class.month_year
+        else
+          raise ArgumentError, "Unknown endian option '#{endian}'"
+        end
+      end
+      definition_list
+    end
+  end
+
+end