rizwanreza-chronic 0.0.1

data/README.rdoc

@@ -0,0 +1,188 @@
+= Chronic
+
+http://chronic.rubyforge.org/
+
+by Tom Preston-Werner
+
+= WARNING:
+
+If you haven't noticed already, this is a fork of evaryont's (Colin's) fork of 
+mojombo's (Tom's) stable chronic. I decided on my own volition that the 40-some 
+(as reported by Github) network should be merged together. I got it to run, but 
+quite haphazardly. There are a lot of new features (mostly undocumented except the 
+git logs) so be a little flexible in your language passed to Chronic.
+
+Given that, if there is a bug, more than likely it's my own fault, not
+mojombo's or evaryont's and therefore bug reports should be sent to my fork, not his.
+
+Enjoy Chronic!
+
+= ADDITIONS:
+
+There are some notes in the history file to show what I have worked on, but primarily I have
+worked on fixing a few bugs that I found and adding some functionality around the strip_tags method
+and the new date_string method.
+
+== DESCRIPTION:
+
+Chronic is a natural language date/time parser written in pure Ruby. See below for the wide variety of formats Chronic will parse.
+
+== INSTALLATION:
+
+Chronic can be installed via RubyGems:
+
+  $ sudo gem install evaryont-chronic
+
+== CODE:
+
+Browse the code and get an RSS feed of the commit log at:
+
+  http://github.com/evaryont/chronic.git
+
+You can grab the code (and help with development) via git:
+
+  $ git clone git://github.com/evaryont/chronic.git
+
+== USAGE:
+
+You can parse strings containing a natural language date using the Chronic.parse method.
+
+  require 'rubygems'
+  require 'chronic'
+
+  Time.now   #=> Sun Aug 27 23:18:25 PDT 2006
+
+  #---
+
+  Chronic.parse('tomorrow')
+    #=> Mon Aug 28 12:00:00 PDT 2006
+
+  Chronic.parse('monday', :context => :past)
+    #=> Mon Aug 21 12:00:00 PDT 2006
+
+  Chronic.parse('this tuesday 5:00')
+    #=> Tue Aug 29 17:00:00 PDT 2006
+
+  Chronic.parse('this tuesday 5:00', :ambiguous_time_range => :none)
+    #=> Tue Aug 29 05:00:00 PDT 2006
+
+  Chronic.parse('may 27th', :now => Time.local(2000, 1, 1))
+    #=> Sat May 27 12:00:00 PDT 2000
+
+  Chronic.parse('may 27th', :guess => false)
+    #=> Sun May 27 00:00:00 PDT 2007..Mon May 28 00:00:00 PDT 2007
+
+See Chronic.parse for detailed usage instructions.
+
+== EXAMPLES:
+
+Chronic 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
+
+  thursday
+  november
+  summer
+  friday 13:00
+  mon 2:35
+  4pm
+  6 in the morning
+  friday 1pm
+  sat 7 in the evening
+  yesterday
+  today
+  tomorrow
+  this tuesday
+  next month
+  last winter
+  this morning
+  last night
+  this second
+  yesterday at 4:00
+  last friday at 20:00
+  last week tuesday
+  tomorrow at 6:45pm
+  afternoon yesterday
+  thursday last week
+
+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:
+
+Chronic 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"
+  >> Chronic.time_class = Time.zone
+  >> Chronic.parse("June 15 2006 at 5:45 AM")
+  => Thu, 15 Jun 2006 05:45:00 UTC +00:00
+
+== LIMITATIONS:
+
+Chronic 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) 2008 Tom Preston-Werner
+
+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/chronic.rb

@@ -0,0 +1,57 @@
+#=============================================================================
+#
+#  Name:       Chronic
+#  Author:     Tom Preston-Werner
+#  Purpose:    Parse natural language dates and times into Time or
+#              Chronic::Span objects
+#
+#=============================================================================
+
+$:.unshift File.dirname(__FILE__)     # For use/testing when no gem is installed
+
+require 'core_ext/object'
+require 'core_ext/time'
+
+require 'chronic/chronic'
+require 'chronic/handlers'
+
+require 'chronic/repeater'
+require 'chronic/repeaters/repeater_year'
+require 'chronic/repeaters/repeater_season'
+require 'chronic/repeaters/repeater_season_name'
+require 'chronic/repeaters/repeater_month'
+require 'chronic/repeaters/repeater_month_name'
+require 'chronic/repeaters/repeater_fortnight'
+require 'chronic/repeaters/repeater_week'
+require 'chronic/repeaters/repeater_weekend'
+require 'chronic/repeaters/repeater_weekday'
+require 'chronic/repeaters/repeater_day'
+require 'chronic/repeaters/repeater_day_name'
+require 'chronic/repeaters/repeater_day_portion'
+require 'chronic/repeaters/repeater_decade'
+require 'chronic/repeaters/repeater_hour'
+require 'chronic/repeaters/repeater_minute'
+require 'chronic/repeaters/repeater_second'
+require 'chronic/repeaters/repeater_time'
+
+require 'chronic/grabber'
+require 'chronic/pointer'
+require 'chronic/scalar'
+require 'chronic/ordinal'
+require 'chronic/separator'
+require 'chronic/time_zone'
+require 'chronic/blunt.rb'
+
+require 'numerizer/numerizer'
+
+module Chronic
+	VERSION = "0.3.0.2"
+
+	class << self
+		attr_accessor :debug
+		attr_accessor :time_class
+	end
+
+	self.debug = false
+	self.time_class = Time
+end

data/lib/chronic/blunt.rb

@@ -0,0 +1,234 @@
+# date range support and parsing of strings calling for a sequence of dates
+# (currently only 'nth Tuesday in June [2009]' etc).
+#
+# My first take -- not stable; a lot of fat to cut out.
+#
+# Chronic::Blunt.dates(Date.today..Date.today+100, {:day => "Wednesday", :week => 0})
+# Chronic::Blunt.range(dates_array,{:csv => ','})
+# Chronic::Blunt.parse("second Saturday in April 2010")
+#
+# Blunt b/c it's err, a blunt instrument :)
+#
+# ...with the exception of brainopia's Array method (which he very
+# kindly wrote while I was troubleshooting a more verbose version
+# on #ruby-lang). (github.com/brainopia)
+#
+
+require 'rubygems'
+require 'active_support'
+
+class Object
+	def tap
+		yield self; self
+	end
+end
+
+class Array #all credit to brainopia for this
+	def group_by_range
+		uniq.sort.inject([]) do |result, it|
+			result << [] unless result.last && result.last.last.next == it
+			result.tap {|ar| ar.last << it }
+		end
+	end
+end
+
+class Date
+	def self.parse_dmy(it)
+		Date.parse(it.split(/\D/).delete_if {|i| i.size < 1}.reverse.join('-'))
+	end
+end
+
+class Chronic::Blunt
+
+	ORDINALS = %w[first second third fourth fifth]
+
+	attr_accessor :result
+
+	def initialize
+		@result = []
+	end
+
+
+	def self.compare(dates0,dates1)
+		ranges = []
+		incongruous = []
+		dates0.each {|it|
+			incongruous << it unless dates1.include?(it)
+		}
+		ranges << Chronic::Blunt.range(incongruous)
+
+		incongruous = []
+		dates1.each {|it|
+			incongruous << it unless dates0.include?(it)
+		}
+		ranges << Chronic::Blunt.range(incongruous)
+
+		@result = ranges
+	end
+
+
+	def self.dates(passed_range, specified_options={})
+		default_options = {:day => false,
+			:week => :every,
+			:hour => false}
+		options = default_options.merge specified_options
+		specified_options.keys.each do |key|
+			default_options.keys.include?(key) || raise(Chronic::InvalidArgumentException, "#{key} is not a valid option key.")
+		end
+
+		if passed_range.class == Array
+			ranges = passed_range
+		else
+			ranges = [passed_range]
+		end
+
+		@result = []
+
+		ranges.each do |range|
+			first = get_date(range.first)-1
+			last = get_date(range.last)
+			@result << (first += 1) while first < last
+		end
+		if options[:day]
+			find_dates(@result,options[:day].to_s,options[:hour],options[:week])
+			@result
+		end
+		@result
+	end
+
+	def self.parse(input)
+		string = input.dup.downcase.gsub(/\s{1,}/,' ')
+		if (string =~ /first|second|third|fourth|last|every/) == 0
+			query = string.gsub(/in/){}.downcase.split(/\s+/)
+
+			if query[0] == 'last'
+				week = -1
+			elsif query[0] == 'every'
+				week = :every
+			else
+				week = ORDINALS.index(query.first)
+			end
+			day = query[1].titleize
+			month = Date.parse("#{query[3]}/#{query[2]}")
+			dates = self.dates(month..month.end_of_month, {:day => day, :week => week})
+			if dates.size < 2
+				@result = dates.first
+			else
+				@result = date
+			end
+		elsif (string =~ /[0-9]{1,2}\s/) == 0 #&& (string =~ /am|pm|hr|/) > 3
+			@result = Chronic.parse(Date.parse(string).strftime("%Y-%m-%d"))
+		else
+			@result = Chronic.parse(string)
+		end
+		if @result.nil?
+			Chronic.parse(Date.parse(string).strftime("%Y-%m-%d"))
+		else
+			@result
+		end
+	end
+
+
+
+	def self.range(dates, specified_options={})
+		default_options = {:csv => false,
+			:start_hrs => 0,
+			:end_hrs => 0,
+			:time => false,
+			:day => false,
+			:period => false}
+		options = default_options.merge specified_options
+
+		specified_options.keys.each do |key|
+			default_options.keys.include?(key) || raise(Chronic::InvalidArgumentException, "#{key} is not a valid option key.")
+		end
+
+		ranges = dates.flatten.map! {|it| get_date it}.group_by_range.map! do |it|
+			if options[:time]
+				Time.parse(it.first.strftime("%Y-%m-%d")).advance(:hours => options[:start_hrs])..Time.parse(it.last.strftime("%Y-%m-%d")).advance(:hours => options[:end_hrs])
+			else
+				it.first..it.last
+			end
+		end
+
+		if options[:csv]
+			if options[:csv] == true
+				@result = to_csv(ranges,'|')
+			else
+				@result = to_csv(ranges,options[:csv].to_s)
+			end
+		else
+			@result = ranges
+		end
+
+		if options[:day]
+			start_dates = Chronic::Blunt.dates(@result, :day => options[:day])
+			periods =[]
+			start_dates.each do |it|
+				first = it.to_time.advance(:hours => options[:start_hrs])
+				last = it.to_time.advance(:days => options[:period], :hours => options[:end_hrs])
+				available = false
+				ranges.each {|it| available = true if it.include?(first..last)}
+				periods << (first..last) if available
+			end
+			@result = periods
+		end
+		return @result
+	end
+
+	private
+
+	def self.to_csv(ranges,delimiter)
+		d = delimiter
+		csv = []
+		ranges.each {|range| csv << "#{range.first}#{d}#{range.last}"}
+		csv
+	end
+
+
+	def self.find_dates(dates,query,hour,week)
+		if query.size == 1
+			day = query.to_i
+		else
+			day = Date::DAYNAMES.index(query)
+		end
+		results = []
+		dates.each{|d|
+			if hour
+				results << (d.to_time + hour.hours) if d.wday == day
+			else
+				results << d if d.wday == day
+			end
+		}
+		if week != :every
+			months = []
+			results.each {|day| months << Date.parse("#{day.year}/#{day.mon}")}
+			months.uniq!
+			months.sort!
+			month_days = []
+			months.each do |month|
+				days = []
+				results.each {|day| days << day if day.mon == month.mon}
+				if hour
+					month_days << days.slice(week).to_time + hour.hours
+				else
+					month_days << days.slice(week)
+				end
+			end
+			@result = month_days
+		else
+			@result = results
+		end
+	end
+
+	def self.get_date(it)
+		case it.class.to_s
+		when "Date"
+			date = it
+		when "Time"
+			date = Date.parse(it.strftime("%Y-%m-%d"))
+		else
+			date = Date.parse(Chronic.parse(it).strftime("%Y-%m-%d"))
+		end
+	end
+end