gforces-chronik 0.3.0

data/README

@@ -0,0 +1,161 @@
+Chronik
+	by Marcin Ciunelis (G-Forces Polska)
+
+== DESCRIPTION:
+
+A Polish version of the Tom Preston-Werner's Chronic (http://github.com/mojombo/chronic/tree/master) natural language date/time parser written in pure Ruby. See below for the wide variety of formats Chronik will parse.
+
+== INSTALLATION:
+
+Chronik can be installed via RubyGems:
+
+	$ gem sources -a http://gems.github.com
+  $ sudo gem install gforces-chronik
+
+== CODE:
+
+You can grab the code (and help with development) via git:
+
+  $ git clone git://github.com/gforces/chronik.git
+
+== USAGE:
+
+You can parse strings containing a natural language date using the Chronik.parse method.
+
+  require 'rubygems'
+  require 'chronik'
+
+  Time.now   #=> Sun Aug 27 23:18:25 PDT 2006
+
+  #---
+
+  Chronik.parse('jutro')       
+    #=> Mon Aug 28 12:00:00 PDT 2006
+
+  Chronik.parse('ponidziałek', :context => :past)
+    #=> Mon Aug 21 12:00:00 PDT 2006
+
+  Chronik.parse('przyszły wtorek 5:00')
+    #=> Tue Aug 29 17:00:00 PDT 2006
+
+  Chronik.parse('przyszły wtorek 5:00', :ambiguous_time_range => :none)
+    #=> Tue Aug 29 05:00:00 PDT 2006
+
+  Chronik.parse('27 maja', :now => Time.local(2000, 1, 1))
+    #=> Sat May 27 12:00:00 PDT 2000
+
+  Chronik.parse('27 maja', :guess => false)
+    #=> Sun May 27 00:00:00 PDT 2007..Mon May 28 00:00:00 PDT 2007
+
+See Chronik.parse for detailed usage instructions.
+
+== EXAMPLES:
+
+Chronik can parse a huge variety of date and time formats. Following is a small sample of strings that will be properly parsed. Parsing is case insensitive and will handle common abbreviations and misspellings.
+
+Simple
+
+  czwartek
+  listopad
+  lato
+  piątek 13:00
+  pon 2:35
+  4 po południu
+  6 rano
+  piątek 1 po południu
+  sob 7 wieczorem
+  wczoraj
+  dzisiaj
+  jutro
+  przysły wtorek
+  przysły miesiąc
+  ostatnia zima
+  dzisiaj rano
+  wczoraj w nocy
+  teraz
+  wczoraj o 4:00
+  poprzeni piątek o  20:00
+  jutro o 6:45 wieczorem
+  wczoraj po południu
+
+Complex
+
+  3 years ago
+  5 months before now
+  7 hours ago
+  7 days from now
+  1 week hence
+  in 3 hours
+  1 year ago tomorrow
+  3 months ago saturday at 5:00 pm
+  7 hours before tomorrow at noon
+  3rd wednesday in november
+  3rd month next year
+  3rd thursday this september
+  4th day last week
+
+Specific Dates
+
+  January 5
+  dec 25
+  may 27th
+  October 2006
+  oct 06
+  jan 3 2010
+  february 14, 2004
+  3 jan 2000
+  17 april 85
+  5/27/1979
+  27/5/1979
+  05/06
+  1979-05-27
+  Friday
+  5
+  4:00
+  17:00
+  0800
+
+Specific Times (many of the above with an added time)
+
+  January 5 at 7pm
+  1979-05-27 05:00:00
+  etc
+
+== TIME ZONES:
+
+Chronik allows you to set which Time class to use when constructing times.  By default, the built in Ruby time class creates times in your system's
+local time zone.  You can set this to something like ActiveSupport's TimeZone class to get full time zone support.
+
+  >> Time.zone = "UTC"
+  >> Chronik.time_class = Time.zone
+  >> Chronik.parse("June 15 2006 at 5:45 AM")
+  => Thu, 15 Jun 2006 05:45:00 UTC +00:00
+
+== LIMITATIONS:
+  
+Chronik uses Ruby's built in Time class for all time storage and computation. Because of this, only times that the Time class can handle will be properly parsed. Parsing for times outside of this range will simply return nil. Support for a wider range of times is planned for a future release.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Marcin Ciunelis (G-Forces Polska)
+
+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/lib/chronik.rb

@@ -0,0 +1,100 @@
+#=============================================================================
+#
+#  Name:       Chronik
+#  Author:     Tom Preston-Werner
+#  Purpose:    Parse natural language dates and times into Time or
+#              Chronik::Span objects
+#
+#=============================================================================
+
+$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+
+require 'time'
+
+require 'chronik/chronik'
+require 'chronik/handlers'
+
+require 'chronik/repeater'
+require 'chronik/repeaters/repeater_year'
+require 'chronik/repeaters/repeater_season'
+require 'chronik/repeaters/repeater_season_name'
+require 'chronik/repeaters/repeater_month'
+require 'chronik/repeaters/repeater_month_name'
+require 'chronik/repeaters/repeater_fortnight'
+require 'chronik/repeaters/repeater_week'
+require 'chronik/repeaters/repeater_weekend'
+require 'chronik/repeaters/repeater_weekday'
+require 'chronik/repeaters/repeater_day'
+require 'chronik/repeaters/repeater_day_name'
+require 'chronik/repeaters/repeater_day_portion'
+require 'chronik/repeaters/repeater_hour'
+require 'chronik/repeaters/repeater_minute'
+require 'chronik/repeaters/repeater_second'
+require 'chronik/repeaters/repeater_time'
+
+require 'chronik/grabber'
+require 'chronik/pointer'
+require 'chronik/scalar'
+require 'chronik/ordinal'
+require 'chronik/separator'
+require 'chronik/time_zone'
+
+require 'numerizer/numerizer'
+
+module Chronik
+  VERSION = "0.3.0"
+  
+  class << self
+    attr_accessor :debug
+    attr_accessor :time_class
+  end
+
+  self.debug = false
+  self.time_class = Time
+end
+
+class Time
+  def self.construct(year, month = 1, day = 1, hour = 0, minute = 0, second = 0)
+    if second >= 60
+      minute += second / 60
+      second = second % 60
+    end
+    
+    if minute >= 60
+      hour += minute / 60
+      minute = minute % 60
+    end
+    
+    if hour >= 24
+      day += hour / 24
+      hour = hour % 24
+    end
+    
+    # determine if there is a day overflow. this is complicated by our crappy calendar
+    # system (non-constant number of days per month)
+    day <= 56 || raise("day must be no more than 56 (makes month resolution easier)")
+    if day > 28
+      # no month ever has fewer than 28 days, so only do this if necessary
+      leap_year = (year % 4 == 0) && !(year % 100 == 0)
+      leap_year_month_days = [31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+      common_year_month_days = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+      days_this_month = leap_year ? leap_year_month_days[month - 1] : common_year_month_days[month - 1]
+      if day > days_this_month
+        month += day / days_this_month
+        day = day % days_this_month
+      end
+    end
+    
+    if month > 12
+      if month % 12 == 0
+        year += (month - 12) / 12
+        month = 12
+      else
+        year += month / 12
+        month = month % 12
+      end
+    end
+    
+    Chronik.time_class.local(year, month, day, hour, minute, second)
+  end
+end

data/lib/chronik/chronik.rb

@@ -0,0 +1,249 @@
+module Chronik
+  class << self
+    
+    # Parses a string containing a natural language date or time. If the parser
+    # can find a date or time, either a Time or Chronik::Span will be returned 
+    # (depending on the value of <tt>:guess</tt>). If no date or time can be found,
+    # +nil+ will be returned.
+    #
+    # Options are:
+    #
+    # [<tt>:context</tt>]
+    #     <tt>:past</tt> or <tt>:future</tt> (defaults to <tt>:future</tt>)
+    #
+    #     If your string represents a birthday, you can set <tt>:context</tt> to <tt>:past</tt> 
+    #     and if an ambiguous string is given, it will assume it is in the 
+    #     past. Specify <tt>:future</tt> or omit to set a future context.
+    #
+    # [<tt>:now</tt>]
+    #     Time (defaults to Time.now)
+    #
+    #     By setting <tt>:now</tt> to a Time, all computations will be based off
+    #     of that time instead of Time.now. If set to nil, Chronik will use Time.now.
+    #
+    # [<tt>:guess</tt>]
+    #     +true+ or +false+ (defaults to +true+)
+    #
+    #     By default, the parser will guess a single point in time for the
+    #     given date or time. If you'd rather have the entire time span returned,
+    #     set <tt>:guess</tt> to +false+ and a Chronik::Span will be returned.
+    #     
+    # [<tt>:ambiguous_time_range</tt>]
+    #     Integer or <tt>:none</tt> (defaults to <tt>6</tt> (6am-6pm))
+    #
+    #     If an Integer is given, ambiguous times (like 5:00) will be 
+    #     assumed to be within the range of that time in the AM to that time
+    #     in the PM. For example, if you set it to <tt>7</tt>, then the parser will
+    #     look for the time between 7am and 7pm. In the case of 5:00, it would
+    #     assume that means 5:00pm. If <tt>:none</tt> is given, no assumption
+    #     will be made, and the first matching instance of that time will 
+    #     be used.
+    def parse(text, specified_options = {})
+      @text = text
+      
+      # get options and set defaults if necessary
+      default_options = {:context => :future,
+                         :now => Chronik.time_class.now,
+                         :guess => true,
+                         :ambiguous_time_range => 6,
+                         :endian_precedence => nil}
+      options = default_options.merge specified_options
+      
+      # handle options that were set to nil
+      options[:context] = :future unless options[:context]
+      options[:now] = Chronik.time_class.now unless options[:context]
+      options[:ambiguous_time_range] = 6 unless options[:ambiguous_time_range]
+            
+      # ensure the specified options are valid
+      specified_options.keys.each do |key|
+        default_options.keys.include?(key) || raise(InvalidArgumentException, "#{key} is not a valid option key.")
+      end
+      [:past, :future, :none].include?(options[:context]) || raise(InvalidArgumentException, "Invalid value ':#{options[:context]}' for :context specified. Valid values are :past and :future.")
+      
+      # store now for later =)
+      @now = options[:now]
+      
+      # put the text into a normal format to ease scanning
+      text = self.pre_normalize(text)
+          
+      # get base tokens for each word
+      @tokens = self.base_tokenize(text)
+    
+      # scan the tokens with each token scanner
+      [Repeater].each do |tokenizer|
+        @tokens = tokenizer.scan(@tokens, options)
+      end
+      
+      [Grabber, Pointer, Scalar, Ordinal, Separator, TimeZone].each do |tokenizer|
+        @tokens = tokenizer.scan(@tokens)
+      end
+      
+      # strip any non-tagged tokens
+      @tokens = @tokens.select { |token| token.tagged? }
+      
+      if Chronik.debug
+        puts "+---------------------------------------------------"
+        puts "| " + @tokens.to_s
+        puts "+---------------------------------------------------"
+      end
+      
+      # do the heavy lifting
+      begin
+        span = self.tokens_to_span(@tokens, options)
+      rescue
+        raise
+        return nil
+      end
+      
+      # guess a time within a span if required
+      if options[:guess]
+        return self.guess(span)
+      else
+        return span
+      end
+    end
+    
+    # Clean up the specified input text by stripping unwanted characters,
+    # converting idioms to their canonical form, converting number words
+    # to numbers (three => 3), and converting ordinal words to numeric
+    # ordinals (third => 3rd)
+    def pre_normalize(text) #:nodoc:
+      normalized_text = text.to_s.downcase
+      normalized_text = numericize_numbers(normalized_text)
+      normalized_text.gsub!(/['"\.,]/, '')
+      normalized_text.gsub!(/ \-(\d{4})\b/, ' tzminus\1')
+      normalized_text.gsub!(/([\/\-\,\@])/) { ' ' + $1 + ' ' }
+      normalized_text.gsub!(/\btoday\b/, 'this day')
+      normalized_text.gsub!(/\btomm?orr?ow\b/, 'next day')
+      normalized_text.gsub!(/\byesterday\b/, 'last day')
+      normalized_text.gsub!(/\bnoon\b/, '12:00')
+      normalized_text.gsub!(/\bmidnight\b/, '24:00')
+      normalized_text.gsub!(/\bbefore now\b/, 'past')
+      normalized_text.gsub!(/\bnow\b/, 'this second')
+      normalized_text.gsub!(/\b(ago|before)\b/, 'past')
+      normalized_text.gsub!(/\bthis past\b/, 'last')
+      normalized_text.gsub!(/\bthis last\b/, 'last')
+      normalized_text.gsub!(/\b(?:in|during) the (morning)\b/, '\1')
+      normalized_text.gsub!(/\b(?:in the|during the|at) (afternoon|evening|night)\b/, '\1')
+      normalized_text.gsub!(/\btonight\b/, 'this night')
+      normalized_text.gsub!(/\b\d+:?\d*[ap]\b/,'\0m')
+      normalized_text.gsub!(/(\d)([ap]m|oclock)\b/, '\1 \2')
+      normalized_text.gsub!(/\b(hence|after|from)\b/, 'future')
+      normalized_text = numericize_ordinals(normalized_text)
+    end
+  
+    # Convert number words to numbers (three => 3)
+    def numericize_numbers(text) #:nodoc:
+      Numerizer.numerize(text)
+    end
+  
+    # Convert ordinal words to numeric ordinals (third => 3rd)
+    def numericize_ordinals(text) #:nodoc:
+      text
+    end
+  
+    # Split the text on spaces and convert each word into
+    # a Token
+    def base_tokenize(text) #:nodoc:
+      text.split(' ').map { |word| Token.new(word) }
+    end
+    
+    # Guess a specific time within the given span
+    def guess(span) #:nodoc:
+      return nil if span.nil?
+      if span.width > 1
+        span.begin + (span.width / 2)
+      else
+        span.begin
+      end
+    end
+  end
+  
+  class Token #:nodoc:
+    attr_accessor :word, :tags
+    
+    def initialize(word)
+      @word = word
+      @tags = []
+    end
+    
+    # Tag this token with the specified tag
+    def tag(new_tag)
+      @tags << new_tag
+    end
+    
+    # Remove all tags of the given class
+    def untag(tag_class)
+      @tags = @tags.select { |m| !m.kind_of? tag_class }
+    end
+    
+    # Return true if this token has any tags
+    def tagged?
+      @tags.size > 0
+    end
+    
+    # Return the Tag that matches the given class
+    def get_tag(tag_class)
+      matches = @tags.select { |m| m.kind_of? tag_class }
+      #matches.size < 2 || raise("Multiple identical tags found")
+      return matches.first
+    end
+    
+    # Print this Token in a pretty way
+    def to_s
+      @word << '(' << @tags.join(', ') << ') '
+    end
+  end
+  
+  # A Span represents a range of time. Since this class extends
+  # Range, you can use #begin and #end to get the beginning and
+  # ending times of the span (they will be of class Time)
+  class Span < Range   
+    # Returns the width of this span in seconds   
+    def width
+      (self.end - self.begin).to_i
+    end
+    
+    # Add a number of seconds to this span, returning the 
+    # resulting Span
+    def +(seconds)
+      Span.new(self.begin + seconds, self.end + seconds)
+    end
+    
+    # Subtract a number of seconds to this span, returning the 
+    # resulting Span
+    def -(seconds)
+      self + -seconds
+    end
+    
+    # Prints this span in a nice fashion
+    def to_s
+      '(' << self.begin.to_s << '..' << self.end.to_s << ')'
+    end
+  end
+
+  # Tokens are tagged with subclassed instances of this class when
+  # they match specific criteria
+  class Tag #:nodoc:
+    attr_accessor :type
+    
+    def initialize(type)
+      @type = type
+    end
+    
+    def start=(s)
+      @now = s
+    end
+  end
+  
+  # Internal exception
+  class ChronikPain < Exception #:nodoc:
+    
+  end
+  
+  # This exception is raised if an invalid argument is provided to
+  # any of Chronik's methods
+  class InvalidArgumentException < Exception
+    
+  end
+end