chronic 0.2.3 → 0.3.0

data/HISTORY.md

@@ -0,0 +1,76 @@
+# 0.3.0 / 2010-10-22
+
+* Fix numerizer number combination bug (27 Oct 2006 7:30pm works now)
+* Allow numeric timezone offset (e.g -0500)
+* Disregard commas (so as to not return nil)
+* Fix parse of (am|pm|oclock) separation to handle "Ham sandwich" properly
+* Handle 'on' e.g. 5pm on Monday
+* Support seasons
+* Support weekend/weekday
+* Add endianness option
+* Update version number in the module
+* Fix/improve logic checks in Ordinal, and Scalar
+* Parse 'a' or 'p' as 'am' and 'pm' google-calendar style
+* Dates < 1 are not valid
+* Fix bugs related to timezone offset
+* Use RakeGem for build management
+* Reformat README and HISTORY to use Markdown
+* Global whitespace removal
+
+# 0.2.3
+
+* Fix 12am/12pm
+
+# 0.2.2
+
+* Add missing files (damn you manifest)
+
+# 0.2.1
+
+* Fix time overflow issue
+* Implement "next" for minute repeater
+* Generalize time dealiasing to dealias regardless of day portion and
+  time position
+* Add additional token match for cases like "friday evening at 7" and
+  "tomorrow evening at 7"
+* Add support for Time#to_s output format: "Mon Apr 02 17:00:00 PDT 2007"
+
+# 0.2.0 2007-03-20
+
+* Implement numerizer, allowing the use of number words (e.g. five weeks ago)
+
+# 0.1.6 2006-01-15
+
+* Add 'weekend' support
+
+# 0.1.5 2006-12-20
+
+* Fix 'aug 20' returning next year if current month is august
+* Modify behavior of 'from now'
+* Add support for seconds on times, and thus db timestamp format:
+  "2006-12-20 18:04:23"
+* Make Hoe compliant
+
+# 0.1.4
+
+* Remove verbose error checking code. oops. :-/
+
+# 0.1.3
+
+* improved regexes for word variations
+* Fix a bug that caused "today at 3am" to return nil if current time is
+  after 3am
+
+# 0.1.2
+
+* Remove Date dependency (now works on windows properly without fiddling)
+
+# 0.1.1
+
+* Run to_s on incoming object
+* Fix loop loading of repeaters files (out of order on some machines)
+* Fix find_within to use this instead of next (was breaking "today at 6pm")
+
+# 0.1.0
+
+* Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 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/README.md

@@ -0,0 +1,165 @@
+Chronic
+=======
+
+## 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
+
+The best way to install Gollum is with RubyGems:
+
+    $ [sudo] gem install chronic
+
+
+## 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.
+
+
+## CONTRIBUTE
+
+If you'd like to hack on Chronic, start by forking the repo on GitHub:
+
+http://github.com/github/chronic
+
+To get all of the dependencies, install the gem first. The best way to get
+your changes merged back into core is as follows:
+
+1. Clone down your fork
+1. Create a thoughtfully named topic branch to contain your change
+1. Hack away
+1. Add tests and make sure everything still passes by running `rake`
+1. If you are adding new functionality, document it in the README
+1. Do not change the version number, we will do that on our end
+1. If necessary, rebase your commits into logical chunks, without errors
+1. Push the branch up to GitHub
+1. Send a pull request for your branch

data/Rakefile

@@ -1,19 +1,146 @@
-# -*- ruby -*-
-
 require 'rubygems'
-require 'hoe'
-require './lib/chronic.rb'
-
-Hoe.new('chronic', Chronic::VERSION) do |p|
-  p.rubyforge_name = 'chronic'
-  p.summary = 'A natural language date parser'
-  p.author = 'Tom Preston-Werner'
-  p.email = 'tom@rubyisawesome.com'
-  p.description = p.paragraphs_of('README.txt', 2).join("\n\n")
-  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
-  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-  p.need_tar = false
-  p.extra_deps = []
-end
-
-# vim: syntax=Ruby
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/benchmark/benchmark.rb

@@ -0,0 +1,13 @@
+require 'chronic'
+require 'benchmark'
+
+print "jan 3 2010:                          "
+puts Benchmark.measure { Chronic.parse("jan 3 2010") }
+
+print "7 hours before tomorrow at midnight: "
+puts Benchmark.measure { Chronic.parse("7 hours before tomorrow at midnight") }
+
+# n = 100
+# Benchmark.bm(14) do |x|
+#   x.report("jan 3 2010:")   { for i in 1..n; Chronic.parse("jan 3 2010"); end }
+# end

data/chronic.gemspec

@@ -0,0 +1,85 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  s.name              = 'chronic'
+  s.version           = '0.3.0'
+  s.date              = '2010-10-22'
+  s.rubyforge_project = 'chronic'
+
+  s.summary     = "Natural language date/time parsing."
+  s.description = "Chronic is a natural language date/time parser written in pure Ruby."
+
+  s.authors  = ["Tom Preston-Werner"]
+  s.email    = 'tom@mojombo.com'
+  s.homepage = 'http://github.com/mojombo/chronic'
+
+  s.require_paths = %w[lib]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md HISTORY.md LICENSE]
+
+  # = MANIFEST =
+  s.files = %w[
+    HISTORY.md
+    LICENSE
+    Manifest.txt
+    README.md
+    Rakefile
+    benchmark/benchmark.rb
+    chronic.gemspec
+    lib/chronic.rb
+    lib/chronic/chronic.rb
+    lib/chronic/grabber.rb
+    lib/chronic/handlers.rb
+    lib/chronic/numerizer/numerizer.rb
+    lib/chronic/ordinal.rb
+    lib/chronic/pointer.rb
+    lib/chronic/repeater.rb
+    lib/chronic/repeaters/repeater_day.rb
+    lib/chronic/repeaters/repeater_day_name.rb
+    lib/chronic/repeaters/repeater_day_portion.rb
+    lib/chronic/repeaters/repeater_fortnight.rb
+    lib/chronic/repeaters/repeater_hour.rb
+    lib/chronic/repeaters/repeater_minute.rb
+    lib/chronic/repeaters/repeater_month.rb
+    lib/chronic/repeaters/repeater_month_name.rb
+    lib/chronic/repeaters/repeater_season.rb
+    lib/chronic/repeaters/repeater_season_name.rb
+    lib/chronic/repeaters/repeater_second.rb
+    lib/chronic/repeaters/repeater_time.rb
+    lib/chronic/repeaters/repeater_week.rb
+    lib/chronic/repeaters/repeater_weekday.rb
+    lib/chronic/repeaters/repeater_weekend.rb
+    lib/chronic/repeaters/repeater_year.rb
+    lib/chronic/scalar.rb
+    lib/chronic/separator.rb
+    lib/chronic/time_zone.rb
+    test/helper.rb
+    test/test_Chronic.rb
+    test/test_DaylightSavings.rb
+    test/test_Handler.rb
+    test/test_Numerizer.rb
+    test/test_RepeaterDayName.rb
+    test/test_RepeaterFortnight.rb
+    test/test_RepeaterHour.rb
+    test/test_RepeaterMinute.rb
+    test/test_RepeaterMonth.rb
+    test/test_RepeaterMonthName.rb
+    test/test_RepeaterTime.rb
+    test/test_RepeaterWeek.rb
+    test/test_RepeaterWeekday.rb
+    test/test_RepeaterWeekend.rb
+    test/test_RepeaterYear.rb
+    test/test_Span.rb
+    test/test_Time.rb
+    test/test_Token.rb
+    test/test_parsing.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end