chronic 0.2.3 → 0.4.0

data/lib/chronic/chronic.rb

@@ -1,8 +1,18 @@
 module Chronic
+
+  DEFAULT_OPTIONS = {
+    :context => :future,
+    :now => nil,
+    :guess => true,
+    :ambiguous_time_range => 6,
+    :endian_precedence    => [:middle, :little],
+    :ambiguous_year_future_bias => 50
+  }
+
   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 Chronic::Span will be returned 
+    # can find a date or time, either a Time or Chronic::Span will be returned
     # (depending on the value of <tt>:guess</tt>). If no date or time can be found,
     # +nil+ will be returned.
     #
@@ -11,15 +21,15 @@ module Chronic
     # [<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 
+    #     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
+    #     of that time instead of Time.now. If set to nil, Chronic will use Time.now.
     #
     # [<tt>:guess</tt>]
     #     +true+ or +false+ (defaults to +true+)
@@ -27,83 +37,70 @@ module Chronic
     #     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 Chronic::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 
+    #     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 
+    #     will be made, and the first matching instance of that time will
     #     be used.
+    #
+    # [<tt>:endian_precedence</tt>]
+    #     Array (defaults to <tt>[:middle, :little]</tt>)
+    #
+    #     By default, Chronic will parse "03/04/2011" as the fourth day
+    #     of the third month. Alternatively you can tell Chronic to parse
+    #     this as the third day of the fourth month by altering the
+    #     <tt>:endian_precedence</tt> to <tt>[:little, :middle]</tt>.
     def parse(text, specified_options = {})
-      # get options and set defaults if necessary
-      default_options = {:context => :future,
-                         :now => Time.now,
-                         :guess => true,
-                         :ambiguous_time_range => 6}
-      options = default_options.merge specified_options
-            
+      @text = text
+      options = DEFAULT_OPTIONS.merge specified_options
+
       # 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
+      (specified_options.keys-DEFAULT_OPTIONS.keys).each {|key| raise(InvalidArgumentException, "#{key} is not a valid option key.")}
+
       [: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 =)
+
+      options[:now] ||= Chronic.time_class.now
       @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? }
-      
+      text = pre_normalize(text)
+
+      # tokenize words
+      @tokens = tokenize(text, options)
+
       if Chronic.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
+
+      span = tokens_to_span(@tokens, options)
+
       if options[:guess]
-        return self.guess(span)
+        guess span
       else
-        return span
+        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.gsub!(/['"\.,]/, '')
+      normalized_text.gsub!(/\bsecond (of|day|month|hour|minute|second)\b/, '2nd \1')
       normalized_text = numericize_numbers(normalized_text)
-      normalized_text.gsub!(/['"\.]/, '')
+      normalized_text.gsub!(/ \-(\d{4})\b/, ' tzminus\1')
       normalized_text.gsub!(/([\/\-\,\@])/) { ' ' + $1 + ' ' }
+      normalized_text.gsub!(/\b0(\d+:\d+\s*pm?\b)/, '\1')
       normalized_text.gsub!(/\btoday\b/, 'this day')
       normalized_text.gsub!(/\btomm?orr?ow\b/, 'next day')
       normalized_text.gsub!(/\byesterday\b/, 'last day')
@@ -117,27 +114,25 @@ module Chronic
       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!(/(?=\w)([ap]m|oclock)\b/, ' \1')
+      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)
+      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) }
+
+    def tokenize(text, options) #:nodoc:
+      tokens = text.split(' ').map { |word| Token.new(word) }
+      [Repeater, Grabber, Pointer, Scalar, Ordinal, Separator, TimeZone].each do |tok|
+        tokens = tok.scan(tokens, options)
+      end
+      tokens.delete_if { |token| !token.tagged? }
     end
-    
+
     # Guess a specific time within the given span
     def guess(span) #:nodoc:
       return nil if span.nil?
@@ -148,92 +143,15 @@ module Chronic
       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 ChronicPain < Exception #:nodoc:
-    
+
   end
-  
+
   # This exception is raised if an invalid argument is provided to
   # any of Chronic's methods
   class InvalidArgumentException < Exception
-    
+
   end
-end
+end

data/lib/chronic/grabber.rb

@@ -1,26 +1,22 @@
-#module Chronic
-
-  class Chronic::Grabber < Chronic::Tag #:nodoc:
-    def self.scan(tokens)
+module Chronic
+  class Grabber < Tag #:nodoc:
+    def self.scan(tokens, options)
       tokens.each_index do |i|
-        if t = self.scan_for_all(tokens[i]) then tokens[i].tag(t); next end
+        if t = scan_for_all(tokens[i]) then tokens[i].tag(t); next end
       end
-      tokens
     end
-    
+
     def self.scan_for_all(token)
-      scanner = {/last/ => :last,
-                 /this/ => :this,
-                 /next/ => :next}
-      scanner.keys.each do |scanner_item|
-        return self.new(scanner[scanner_item]) if scanner_item =~ token.word
-      end
-      return nil
+      scan_for token, self,
+      {
+        /last/ => :last,
+        /this/ => :this,
+        /next/ => :next
+      }
     end
-    
+
     def to_s
       'grabber-' << @type.to_s
     end
   end
-
-#end
+end