medjool 0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 andygeers
+
+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,24 @@
+medjool
+=======
+Date parsing with context.
+
+The Date.parse in ActiveSupport method is awesome. The only thing it lacks is the ability to provide a bit more context to override what 'now' is considered to be. By default, Medjool defers date parsing directly to Date.parse, but on subsequent calls it will make sure that the result is after the previously parsed date.
+
+Usage
+=====
+
+  parser = Medjool::Parser.new({:now => "2013-08-26".to_date})
+  parser.parse("Tuesday") => "2013-08-27"
+  parser.parse("Wednesday") => "2013-08-28"
+  parser.parse("Tuesday") => "2013-09-03"
+
+
+Tests
+=====
+To run the tests, type:
+
+  rake test
+
+License
+=======
+Medjool is licensed under an MIT license.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'date'
+
+def version
+  contents = File.read File.expand_path('../lib/medjool.rb', __FILE__)
+  contents[/VERSION = "([^"]+)"/, 1]
+end
+
+task :test do
+  $:.unshift './test'
+  Dir.glob('test/test_*.rb').each { |t| require File.basename(t) }
+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
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -Ilib -rchronic"
+end
+
+desc "Release Chronic version #{version}"
+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/chronic-#{version}.gem"
+end
+
+desc "Build a gem from the gemspec"
+task :build do
+  sh "mkdir -p pkg"
+  sh "gem build chronic.gemspec"
+  sh "mv chronic-#{version}.gem pkg"
+end
+
+task :default => :test

data/lib/medjool.rb

@@ -0,0 +1,14 @@
+module Medjool
+  VERSION = 0.1
+
+  require 'medjool/parser'
+  require 'medjool/regexs'
+
+  class << self
+
+  end
+
+  def self.parse(t, context = {})
+    Medjool::Parser.new(context).parse(t)
+  end
+end

data/lib/medjool/parser.rb

@@ -0,0 +1,102 @@
+require 'active_support/core_ext'
+
+class Medjool::Parser
+
+  attr_reader :context
+
+  def initialize(context = {})
+    @context = context
+  end
+
+  def parse(text)
+    if Medjool::DATE_MATCHER.match(text)
+      base_date = Date.parse(text)
+
+      unless @context[:now]
+        # In the absence of context, always fall back on the default guess
+        guess_date = base_date
+      else
+        # Determine the ambiguity level for this data
+        ambiguity = determine_ambiguity(text)
+
+        now = @context[:now].to_date
+
+        case ambiguity
+          when :none
+            return base_date
+
+          when :weekly
+            # Pick the nearest week that meets the context
+            guess_date = now + (base_date.wday - now.wday).days - 1.week
+
+            while guess_date < now
+              guess_date += 1.week
+            end
+          when :monthly
+            # Pick the nearest month where the provided day of the month meets the context
+            y = now.year
+            m = now.month - 1
+            guess_date = nil
+
+            while guess_date.nil? || guess_date < now
+              m += 1
+              if m > 12
+                m = 1
+                y += 1
+              end
+              begin
+                guess_date = Date.new(y, m, base_date.day)
+              rescue ArgumentError
+                # This might happen e.g. 31st Feb,
+                # so just carry on to the next month
+                next
+              end
+            end
+
+          when :yearly
+            # Skip ahead a year at a time unless we meet the context
+            guess_date = Date.new(now.year, base_date.month, base_date.day)
+            while guess_date < now
+              guess_date += 1.year
+            end
+
+        end
+      end
+
+      @context[:now] = guess_date
+      return guess_date
+    else
+      return nil
+    end
+  end
+
+  protected
+
+  def determine_ambiguity(text)
+    if /#{Medjool::DM_DM_YYYY_MATCHER}|#{Medjool::YYYY_MM_DD_MATCHER}/.match(text)
+      # Plain as day
+      return :none
+    end
+
+    # Work out how much detail we have
+    data_present = {
+      :day_name => Medjool::DAYNAME_MATCHER.match(text),
+      :month => Medjool::MONTH_MATCHER.match(text),
+      :ordinal => Medjool::ORDINAL_MATCHER.match(text)
+    }
+
+    if data_present[:month] && data_present[:ordinal]
+      # 1st December
+      return :yearly
+    elsif data_present[:ordinal]
+      # Monday 1 or just 1st
+      return :monthly
+    elsif data_present[:day_name] && !data_present[:month]
+      # Tuesday
+      return :weekly
+    else
+      # Unknown
+      return nil
+    end
+  end
+end

data/lib/medjool/regexs.rb

@@ -0,0 +1,10 @@
+module Medjool
+  DAYNAME_MATCHER = /(\s*Mon(day)?,?\s*|\s*Tue(s(day)?)?,?\s*|\s*Wed(nesday)?,?\s*|\s*Thur(s(day)?)?,?\s*|\s*Fri(day)?,?\s*|\s*Sat(urday)?,?\s*|\s*Sun(day)?,?\s*)/
+  MONTH_MATCHER = /\s*(Jan(uary)?|Feb(ruary)?|Mar(ch)?|Apr(il)?|May|June?|July?|Aug(ust)?|Sept(ember)?|Oct(ober)?|Nov(ember)?|Dec(ember)?),?\s*/
+  YYYY_MM_DD_MATCHER = /(\s*[0-9]{4}-[0-9]{2}-[0-9]{2}\s*)/
+  DM_DM_YYYY_MATCHER = /(\s*[0-9]{2}[-\/][0-9]{2}[-\/][0-9]{2,4}\s*)/
+  ORDINAL_MATCHER = /(\s*([0-9]{1,2}(st|rd|nd|th)?),?\s*)/
+  YEAR_MATCHER = /(\s*([0-9]{4}\s*|\s*'?[0-9]{2}),?\s*)/
+  TEXT_DATE_MATCHER = /(#{DAYNAME_MATCHER}|#{ORDINAL_MATCHER}|#{YEAR_MATCHER}|#{MONTH_MATCHER})/
+  DATE_MATCHER = /^(#{TEXT_DATE_MATCHER}+|#{DM_DM_YYYY_MATCHER}|#{YYYY_MM_DD_MATCHER})/
+end

data/medjool.gemspec

@@ -0,0 +1,21 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'medjool'
+
+Gem::Specification.new do |s|
+  s.name = 'medjool'
+  s.version = Medjool::VERSION
+  #s.rubyforge_project = 'medjool'
+  s.summary     = 'Date parsing with context'
+  s.description = 'Medjool is a date parser written in pure Ruby, which processes dates within a context.'
+  s.authors  = ['Andy Geers']
+  s.email    = ['andy@geero.net']
+  s.homepage = 'http://github.com/andygeers/medjool'
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = %w[README.md LICENSE]
+  s.files = `git ls-files`.split("\n")
+  s.test_files = `git ls-files -- test`.split("\n")
+
+  s.add_dependency 'activesupport', '~> 3.2.12'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'minitest', '~> 5.0'
+end

data/test/helper.rb

@@ -0,0 +1,15 @@
+unless defined? Medjool
+  $:.unshift File.expand_path('../../lib', __FILE__)
+  require 'medjool'
+end
+
+require 'minitest'
+require 'minitest/autorun'
+require 'active_support/core_ext/string'
+require 'timecop'
+
+class TestCase < MiniTest::Test
+  def self.test(name, &block)
+    define_method("test_#{name.gsub(/\W/, '_')}", &block) if block
+  end
+end

data/test/test_medjool.rb

@@ -0,0 +1,53 @@
+require 'helper'
+
+class TestMedjool < TestCase
+
+  def setup
+    # Friday 23rd August 2013
+    Timecop.freeze("2013-08-23".to_date)
+  end
+
+  def teardown
+    Timecop.return
+  end
+
+  def test_parse_without_context
+    @variations = ["Monday", "1st July", "2nd July 2010", "1 July 2009", "Monday 2nd July 2009", "Monday 2nd", "Monday 2", "Monday 2 July"]
+    @variations.each do |t|
+      assert_equal Date.parse(t), Medjool.parse(t)
+    end
+  end
+
+  def test_parse_with_context
+    assert_equal Date.parse("Monday") + 1.week, Medjool.parse("Monday", { :now => 1.week.from_now })
+
+    assert_equal "2014-03-31".to_date, Medjool.parse("31st", { :now => "2014-02-01" })
+
+    assert_equal "2014-03-31".to_date, Medjool.parse("31st", { :now => "2014-02-01" })
+  end
+
+  def test_day_month_and_ordinal
+    assert_equal "2013-10-01".to_date, Medjool.parse("Monday 1st October", {:now => "2013-08-23".to_date})
+    assert_equal "2014-10-01".to_date, Medjool.parse("Monday 1st October", {:now => "2013-10-02".to_date})
+
+    assert_equal "2013-10-01".to_date, Medjool.parse("1st October", {:now => "2013-08-23".to_date})
+    assert_equal "2014-10-01".to_date, Medjool.parse("1st October", {:now => "2013-10-02".to_date})
+  end
+
+  def test_ordinal_only
+    assert_equal "2013-09-01".to_date, Medjool.parse("1st", {:now => "2013-08-23".to_date})
+    assert_equal "2013-08-01".to_date, Medjool.parse("1st", {:now => "2013-08-01".to_date})
+  end
+
+  def test_day_only
+    assert_equal "2013-08-27".to_date, Medjool.parse("Tuesday", {:now => "2013-08-26".to_date})
+    assert_equal "2013-08-27".to_date, Medjool.parse("Tuesday", {:now => "2013-08-27".to_date})
+    assert_equal "2013-09-03".to_date, Medjool.parse("Tuesday", {:now => "2013-08-28".to_date})
+  end
+
+  def test_absolute_dates
+    parser = Medjool::Parser.new
+    assert_equal "2013-07-06".to_date, parser.parse("06/07/2013")
+    assert_equal "2013-07-06".to_date, parser.parse("06/07/2013")
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: medjool
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Andy Geers
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-08-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 3
+        - 2
+        - 12
+        version: 3.2.12
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 5
+        - 0
+        version: "5.0"
+  type: :development
+  version_requirements: *id003
+description: Medjool is a date parser written in pure Ruby, which processes dates within a context.
+email: 
+- andy@geero.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- LICENSE
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- lib/medjool.rb
+- lib/medjool/parser.rb
+- lib/medjool/regexs.rb
+- medjool.gemspec
+- test/helper.rb
+- test/test_medjool.rb
+homepage: http://github.com/andygeers/medjool
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Date parsing with context
+test_files: 
+- test/helper.rb
+- test/test_medjool.rb