tickle 0.1.7 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c9f24bf840e38c2196e61c1428caa9d84eeb7b5
+  data.tar.gz: 6e8111fb7b6098f3c285d537b2adb529ede9ad36
+SHA512:
+  metadata.gz: 84a13f5b64bd9e49327bca5456bbcb197b7d66b90b0f349ea035f842ffe8aa440a263aefc690d163c5023ac24e13b398b395da9e6d7240e9a89220c7c4ca9433
+  data.tar.gz: 2514f63b04e43ec3610932dc115ad127b29b9a384e9b99fe6c52606982ebb2537cb20ac06beccf2cfcc25630a5c2f7c5021870119ab39395b7fe9f4361af5a1b

data/.gitignore

@@ -1,21 +1,21 @@
-## MAC OS
 .DS_Store
 
-## TEXTMATE
 *.tmproj
 tmtags
 
-## EMACS
 *~
 \#*
 .\#*
 
-## VIM
 *.swp
-
-## PROJECT::GENERAL
+doc/
 coverage
 rdoc
 pkg
-
-## PROJECT::SPECIFIC
+bin/
+vendor/
+Gemfile.lock
+spec/
+.yardoc/
+.bundle/
+.rspec

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 2.7
+  - jruby
+  - truffleruby
+
+# whitelist
+branches:
+  only:
+    - master
+    - develop
+    - v1-branch

data/CHANGES.md

@@ -0,0 +1,47 @@
+# CH CH CH CH CHANGES! #
+
+## Friday the 18th of September 2020, v1.2.0
+
+- Changed the dependency from chronic to gitlab-chronic
+- Required numerizer explicitly to stop a bug
+- Formatted the regex for legibility
+- Fixed bug with "today and" in the tests
+- Fixed a bug previously fixed on the v2 branch in 2f2a32ce9 with @start
+- Added Timecop because we're beyond the date chosen in the tests. Tempus fugit!
+
+----
+
+## Wednesday the 15th of March 2017, v1.1.1 ##
+
+* Bit of easier debugging added in.
+* Bug fixes, thanks to https://github.com/dodomarocgenex for finding and helping with them.
+
+----
+
+## Wednesday the 22nd of February 2017, v1.1.0 ##
+
+* Numerizer duplication removed. Thanks to https://github.com/bjonord.
+* Some very minor changes to the project, no other code changes.
+
+----
+
+
+## Monday the 11th of November 2015, v1.0.2 ##
+
+* Shoulda and simplecov aren't runtime dependencies, fixed that in the gemfile.
+* Got the version number right this time ;-)
+
+----
+
+## Monday the 11th of November 2015, v1.0.1 ##
+
+* Moved library to new maintainer [https://github.com/yb66/tickle](@yb66)
+* Moved library to [http://semver.org/](semver).
+* Merged in some changes from @dan335 and @JesseAldridge, thanks to them.
+* Moved rdocs to markdown for niceness.
+* Updated licences with dates and correct spelling ;)
+* Fix incorporated for "NameError: uninitialized constant Module::Numerizer"
+* Moved library to Bundler to make it easier to set up and develop against.
+* Started using Yardoc for more niceness with documentation.
+
+----

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "rspec"
+end
+
+gem "pry-byebug"
+gem "pry-state"

data/{LICENSE → LICENCE}

@@ -1,4 +1,6 @@
 Copyright (c) 2010 Joshua Lippiner
+Copyright (c) 2013 Iain Barnett
+
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/{README.rdoc → README.md}

@@ -1,82 +1,71 @@
-= tickle
-  http://github.com/noctivityinc/tickle
-  by Joshua Lippiner, Noctivity
+## Tickle ##
 
-== *LEGACY WARNING*
+This is now the home of ***Tickle***, previously found at [github.com/noctivityinc/tickle](https://github.com/noctivityinc/tickle)
 
-If you starting using Tickle pre version 0.1.X, you will need to update your code to either include the :next_only => true option or read correctly from the options hash.  Sorry.
+If you wish to contribute then please take a look at the Contribution section further down the page, but I'd be really, *really* grateful if anyone wishes to contribute specs. Not unit tests, but specs. This library's internals will be changing a lot over the coming months, and it would be good to have integration tests - a black-box spec of the library - to work against. Even if you've never contributed to a library before, now is your chance! I'll help anyone through with what they may need, and I promise not to be the standard snarky Open Source dictator that a lot of projects have. We'll try and improve this library together.
 
-== DESCRIPTION
+Take a look at the `develop` branch where all this stuff will be happening.
 
-Tickle is a natural language parser for recurring events.
- 
-Tickle is designed to be a compliment of Chronic and can interpret things such as "every 2 days, every Sunday, Sundays, Weekly, etc."
-
-In a lot of ways Tickle is actually an enhancement of Chronic, handling a lot of things that Chronic can't, such as commas and US Holidays (yup - you can do Tickle.parse('Christmas Eve'))
 
-Tickle has one main method, "Tickle.parse," which returns the next time the event should occur, at which point you simply call Tickle.parse again.   
+### DESCRIPTION ###
 
-== INSTALLATION
-
-Tickle can be installed via RubyGems:
-
-$ gem install tickle
-
-== TINKERING
+Tickle is a natural language parser for recurring events.
+ 
+Tickle is designed to be a complement to [Chronic](https://rubygems.org/gems/chronic) and can interpret things such as "every 2 days, every Sunday, Sundays, Weekly, etc."
 
-Everything's at Github - http://github.com/noctivityinc/tickle
+Tickle has one main method, `Tickle.parse`, which returns the next time the event should occur, at which point you simply call `Tickle.parse` again.   
 
-== DEPENDENCIES
+### *LEGACY WARNING* ###
 
-chronic gem (gem install chronic)
+If you starting using Tickle pre version 0.1.X, you will need to update your code to either include the `:next_only => true` option or read correctly from the options hash.  Sorry.
 
-thoughtbot's shoulda (gem install shoulda)
 
-== USAGE
+### USAGE ###
 
-You can parse strings containing a natural language interval using the Tickle.parse method.
+You can parse strings containing a natural language interval using the `Tickle.parse` method.
 
-You can either pass a string prefixed with the word "every, each or 'on the'" or simply the time frame.   
+You can either pass a string prefixed with the word "every", "each" or "on the" or simply the timeframe.
 
 Tickle.parse returns a hash containing the following keys:
-* next = the next occurrence of the event.  This is NEVER today as its always the next date in the future.
-* starting = the date all calculations as based on.  If not passed as an option, the start date is right now.
-* until = the last date you want this event to run until.
-* expression = this is the natural language expression to store to run through tickle later to get the next occurrence.
+* `next` the next occurrence of the event.  This is NEVER today as its always the next date in the future.
+* `starting` the date all calculations as based on.  If not passed as an option, the start date is right now.
+* `until` the last date you want this event to run until.
+* `expression` this is the natural language expression to store to run through tickle later to get the next occurrence.
 
-Tickle returns nil if it cannot parse the string cannot be parsed.
+Tickle returns `nil` if it cannot parse the string.
 
-Tickle HEAVILY uses chronic for parsing but mostly the start and until phrases.
+Tickle ***heavily*** uses Chronic for parsing both the event and the start date.
 
-=== OPTIONS
+### OPTIONS ###
 
 There are two ways to pass options: natural language or an options hash.
 
 NATURAL LANGUAGE:
-* Pass a start date with the word "starting, start, stars" (e.g. Tickle.parse('every 3 days starting next friday'))
-* Pass an end date with the word "until, end, ends, ending" (e.g. Tickle.parse('every 3 days until next friday'))
-* Pass both at the same time (e.g. "starting May 5th repeat every other week until December 1")
+* Pass a start date with the word "starting", "start", or "stars" e.g. `Tickle.parse('every 3 days starting next friday')`
+* Pass an end date with the word "until", "end", "ends", or "ending" e.g. `Tickle.parse('every 3 days until next friday')`
+* Pass both at the same time e.g. `"starting May 5th repeat every other week until December 1"`
 
 OPTIONS HASH
 Valid options are:
-* start - must be a valid date or Chronic date expression. (e.g. Tickle.parse('every other day', {:start => Date.new(2010,8,1) }))
-* until - must be a valid date or Chronic date expression. (e.g. Tickle.parse('every other day', {:until => Date.new(2010,10,1) }))
-* next_only - legacy switch to ONLY return the next occurrence as a date and not return a hash
+* `start` - must be a valid date or Chronic date expression. e.g. `Tickle.parse('every other day', {:start => Date.new(2010,8,1) })`
+* `until` - must be a valid date or Chronic date expression. e.g. `Tickle.parse('every other day', {:until => Date.new(2010,10,1) })`
+* `next_only` - legacy switch to *only* return the next occurrence as a date and not return a hash
 
-=== SUPER IMPORTANT NOTE ABOUT NEXT OCCURRENCE & START DATE
+### SUPER IMPORTANT NOTE ABOUT NEXT OCCURRENCE & START DATE ###
 
-You may notice when parsing an expression with a start date that the next occurrence IS the start date passed.  This is DESIGNED BEHAVIOR.  
+You may notice when parsing an expression with a start date that the next occurrence **is** the start date passed.  This is **designed behaviour**.  
 
 Here's why - assume your user says "remind me every 3 weeks starting Dec 1" and today is May 8th.  Well the first reminder needs to be sent on Dec 1, not Dec 21 (three weeks later). 
 
-If you don't like that, fork and have fun but don't say I didn't warn ya.
+If you don't like that, fork and have fun but don't say you weren't warned.
 
-=== EXAMPLES
 
-  require 'rubygems'
-  require 'tickle'
+### EXAMPLES ###
+
+    require 'tickle'
+    
+#### SIMPLE ####
 
-SIMPLE
     Tickle.parse('day')
       #=> {:next=>2010-05-10 20:57:36 -0400, :expression=>"day", :starting=>2010-05-09 20:57:36 -0400, :until=>nil}
 
@@ -230,7 +219,8 @@ SIMPLE
     Tickle.parse('the twenty first of the month', {:start=>#<Date: 2020-04-01 (4917881/2,0,2299161)>, :now=>#<Date: 2020-04-01 (4917881/2,0,2299161)>})
       #=> {:next=>2020-04-21 00:00:00 -0400, :expression=>"the twenty first of the month", :starting=>2020-04-01 00:00:00 -0400, :until=>nil}
 
-COMPLEX
+#### COMPLEX ####
+
     Tickle.parse('starting today and ending one week from now')
       #=> {:next=>2010-05-10 22:30:00 -0400, :expression=>"day", :starting=>2010-05-09 22:30:00 -0400, :until=>2010-05-16 20:57:35 -0400}
 
@@ -283,7 +273,8 @@ COMPLEX
       #=> {:next=>2010-05-12 12:00:00 -0400, :expression=>"week", :starting=>2010-05-12 12:00:00 -0400, :until=>2010-05-13 12:00:00 -0400}
 
 
-OPTIONS HASH
+#### OPTIONS HASH ####
+
     Tickle.parse('May 1st 2020', {:next_only=>true})
       #=> 2020-05-01 00:00:00 -0400
 
@@ -308,7 +299,7 @@ OPTIONS HASH
     Tickle.parse('3 months', {:until=>2010-10-09 00:00:00 -0400})
       #=> {:next=>2010-08-09 20:57:36 -0400, :expression=>"3 months", :starting=>2010-05-09 20:57:36 -0400, :until=>2010-10-09 00:00:00 -0400}
 
-US HOLIDAYS
+#### US HOLIDAYS ####
 
     Tickle.parse('New Years Day', {:start=>#<Date: 2020-01-01 (4917699/2,0,2299161)>, :now=>#<Date: 2020-01-01 (4917699/2,0,2299161)>})
       #=> {:next=>2021-01-01 12:00:00 -0500, :expression=>"january 1, 2021", :starting=>2020-01-01 00:00:00 -0500, :until=>nil}
@@ -389,48 +380,73 @@ US HOLIDAYS
       #=> {:next=>2021-01-01 12:00:00 -0500, :expression=>"january 1, 2021", :starting=>2020-01-01 00:00:00 -0500, :until=>nil}
 
 
-== USING IN APP
+### USING IN APP ###
 
 To use in your app, we recommend adding two attributes to your database model:
-* next_occurrence
-* tickle_expression
 
-Then call Tickle.parse(date expression) when you need to and save the results accordingly.  In your 
-code, each day, simply check to see if today is >= next_occurrence and, if so, run your block.
+* `next_occurrence`
+* `tickle_expression`
 
-After it completes, call Tickle.parse(tickle_expression) again to update the next occurrence of the event.
+Then call `Tickle.parse("date expression goes here")` when you need to and save the results accordingly.  In your 
+code, each day, simply check to see if today is `>= next_occurrence` and, if so, run your block.
 
+After it completes, call `next_occurrence = Tickle.parse(tickle_expression)` again to update the next occurrence of the event.
 
-== TESTING
 
-Tickle comes with a full testing suite for simple, complex, options hash and invalid arguments.
+### INSTALLATION ###
 
-You also have some command line options:
-    --v     verbose output like the examples above
-    --d     debug output showing the guts of a date expression
+Tickle can be installed via RubyGems:
+
+    gem install tickle
 
-== LIMITATIONS
+or if you're using Bundler, add this to the Gemfile:
+
+    gem "tickle"
+
+### DEPENDENCIES ###
+
+Chronic gem:
+
+`gem install gitlab-chronic`
+
+thoughtbot's [shoulda](https://rubygems.org/gems/shoulda):
+
+`gem install shoulda`
+
+or just run `bundle install`.
+
+
+### LIMITATIONS ###
 
 Currently, Tickle only works for day intervals but feel free to fork and add time-based interval support or send me a note if you really want me to add it.
 
-== CREDIT
 
-HUGE shout-out to both the creator of Chronic, Tom Preston-Werner (http://chronic.rubyforge.org/) as well as Brian Brownling who maintains a github version at http://github.com/mojombo/chronic.
+### CONTRIBUTING ###
+
+Fork it, create a new branch for your changes, and send in a pull request.
+
+* Only tested code gets in.
+* Document it.
+* If you want to work on something but aren't sure whether it'll get in, create a new branch and open a pull request before you've done any code. That will open an issue and we can discuss it.
+* Do not mess with the Rakefile, version, or history (if you want to have your own version, that is fine but do it on a separate branch from the one I'm going to merge.)
+
+### TESTING ###
+
+Tickle comes with a full testing suite for simple, complex, options hash and invalid arguments.
+
+You also have some command line options:
+
+* --v     verbose output like the examples above
+* --d     debug output showing the guts of a date expression
 
-Without their work and code structure I'd be lost.
+### CREDIT ###
 
-As always, BIG shout-out to the RVM Master himself, Wayne Seguin, for putting up with me and Ruby from day one.  Ask Wayne to make you some Ciabatta bread next time you see him
+The original work on the library was done by *Joshua Lippiner* a.k.a. [Noctivity](https://github.com/noctivityinc).
 
+***HUGE*** shout-out to both the creator of Chronic, *Tom Preston-Werner* as well as *Brian Brownling* who maintains a Github version at [github.com/mojombo/chronic](https://github.com/mojombo/chronic).
 
-== Note on Patches/Pull Requests
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for time-based branches.
+As always, ***BIG*** shout-out to the RVM Master himself, *Wayne Seguin*, for putting up with me and Ruby from day one.  Ask Wayne to make you some ciabatta bread next time you see him.
 
-== Copyright
+### LICENCE ###
 
-Copyright (c) 2010 Joshua Lippiner. See LICENSE for details.
+See the LICENCE file.

data/Rakefile

@@ -1,25 +1,3 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "tickle"
-    gem.summary = 'natural language parser for recurring events'
-    gem.description = 'Tickle is a date/time helper gem to help parse natural language into a recurring pattern.  Tickle is designed to be a compliment of Chronic and can interpret things such as "every 2 days, every Sunday, Sundays, Weekly, etc.'
-    gem.email = "jlippiner@noctivity.com"
-    gem.homepage = "http://github.com/noctivityinc/tickle"
-    gem.authors = ["Joshua Lippiner"]
-    gem.add_dependency('chronic', '>= 0.2.3')
-    gem.add_development_dependency "shoulda", ">= 2.10.3"
-    
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -27,29 +5,22 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
+task :default => :test
 
-task :test => :check_dependencies
 
-task :default => :test
+desc "(Re-) generate documentation and place it in the docs/ dir. Open the index.html file in there to read it."
+task :docs => [:"docs:environment", :"docs:yard"]
+namespace :docs do
+
+  task :environment do
+    ENV["RACK_ENV"] = "documentation"
+  end
+
+  require 'yard'
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  YARD::Rake::YardocTask.new :yard do |t|
+    t.files   = ['lib/**/*.rb']
+    t.options = ['-odoc/'] # optional
+  end
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "tickle #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/examples.rb

@@ -0,0 +1,29 @@
+
+require File.join(File.dirname(__FILE__), 'lib', 'tickle')
+
+=begin
+
+Tickle creates standard Ruby Time objects.
+
+Time is ignored if there's also a date, unless the date is 'tomorrow'(?)
+
+Tickle creates times in the servers local time zone.
+To go from server time to user's local time...
+  user_time = server_time + (user_time_offset - server_time_offset)
+  eg (5:00PM Central) = (6:00PM Eastern + (-6 - -5))
+
+Tickle makes 'May 30th' at 0:00, but 'June 18, 2011' and 'Christmas' at 12:00.
+=end
+
+
+server_offset = Time.now.utc_offset / 60 / 60
+
+['May 30th', '6:30 PM', 
+ 'tomorrow at 6:00', 'June 18, 2011', 'Christmas'].each {|s|
+  time = Tickle.parse(s)[:next]
+  if s == 'Christmas'
+    time -= 12 * 60 * 60
+  end
+  print s, " --> server date: ", time
+  puts
+}

data/lib/tickle.rb

@@ -9,16 +9,22 @@
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))     # For use/testing when no gem is installed
 
+if ENV["DEBUG"]
+  warn "DEBUG MODE ON" 
+  require 'pry-byebug' 
+  require 'pry-state'
+  binding.pry
+end
+
 require 'date'
 require 'time'
-require 'chronic'
+require 'gitlab-chronic'
 
 require 'tickle/tickle'
 require 'tickle/handler'
 require 'tickle/repeater'
 
 module Tickle #:nodoc:
-  VERSION = "0.1.7"
 
   def self.debug=(val); @debug = val; end
 
@@ -48,20 +54,20 @@ class Date #:nodoc:
     amount ||= 1
     case attr
     when :day then
-      Date.civil(self.year, self.month, self.day + amount)
+      Date.civil(self.year, self.month, self.day).next_day(amount)
     when :wday then
       amount = Date::ABBR_DAYNAMES.index(amount) if amount.is_a?(String)
       raise Exception, "specified day of week invalid.  Use #{Date::ABBR_DAYNAMES}" unless amount
       diff = (amount > self.wday) ? (amount - self.wday) : (7 - (self.wday - amount))
-      Date.civil(self.year, self.month, self.day + diff)
+      Date.civil(self.year, self.month, self.day).next_day(diff)
     when :week then
-      Date.civil(self.year, self.month, self.day + (7*amount))
+      Date.civil(self.year, self.month, self.day).next_day(7*amount)
     when :month then
-      Date.civil(self.year, self.month+amount, self.day)
+      Date.civil(self.year, self.month, self.day).next_month(amount)
     when :year then
-      Date.civil(self.year + amount, self.month, self.day)
+      Date.civil(self.year, self.month, self.day).next_year(amount)
     else
-            raise Exception, "type \"#{attr}\" not supported."
+      raise Exception, "type \"#{attr}\" not supported."
     end
   end
 end
@@ -71,27 +77,27 @@ class Time #:nodoc:
     amount ||= 1
     case attr
     when :sec then
-      Time.local(self.year, self.month, self.day, self.hour, self.min, self.sec + amount)
+      Time.local(self.year, self.month, self.day, self.hour, self.min, self.sec) + amount
     when :min then
-      Time.local(self.year, self.month, self.day, self.hour, self.min + amount, self.sec)
+      Time.local(self.year, self.month, self.day, self.hour, self.min, self.sec) + (amount * 60)
     when :hour then
-      Time.local(self.year, self.month, self.day, self.hour + amount, self.min, self.sec)
+      Time.local(self.year, self.month, self.day, self.hour, self.min, self.sec) + (amount * 60 * 60)
     when :day then
-      Time.local(self.year, self.month, self.day + amount, self.hour, self.min, self.sec)
+      Time.local(self.year, self.month, self.day, self.hour, self.min, self.sec) + (amount * 60 * 60 * 24)
     when :wday then
       amount = Time::RFC2822_DAY_NAME.index(amount) if amount.is_a?(String)
       raise Exception, "specified day of week invalid.  Use #{Time::RFC2822_DAY_NAME}" unless amount
       diff = (amount > self.wday) ? (amount - self.wday) : (7 - (self.wday - amount))
-      Time.local(self.year, self.month, self.day + diff, self.hour, self.min, self.sec)
+      DateTime.civil(self.year, self.month, self.day, self.hour, self.min, self.sec, self.zone).next_day(diff)
     when :week then
-      Time.local(self.year, self.month, self.day + (amount * 7), self.hour, self.min, self.sec)
+      DateTime.civil(self.year, self.month, self.day, self.hour, self.min, self.sec, self.zone).next_day(amount * 7)
     when :month then
-      Time.local(self.year, self.month + amount, self.day, self.hour, self.min, self.sec)
+      DateTime.civil(self.year, self.month, self.day, self.hour, self.min, self.sec, self.zone).next_month(amount)
     when :year then
-      Time.local(self.year + amount, self.month, self.day, self.hour, self.min, self.sec)
+      DateTime.civil(self.year, self.month, self.day, self.hour, self.min, self.sec, self.zone).next_year(amount)
     else
       raise Exception, "type \"#{attr}\" not supported."
-    end
+    end.to_time.localtime
   end
 end
 

data/lib/tickle/tickle.rb

@@ -19,8 +19,10 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-module Tickle  #:nodoc:
-  class << self #:nodoc:
+require 'numerizer'
+
+module Tickle
+  class << self
     # == Configuration options
     #
     # * +start+ - start date for future occurrences.  Must be in valid date format.
@@ -105,9 +107,25 @@ module Tickle  #:nodoc:
     def scan_expression(text, options)
       starting = ending = nil
 
-      start_every_regex = /^(start(?:s|ing)?)\s(.*)(\s(?:every|each|\bon\b|repeat)(?:s|ing)?)(.*)/i
+      start_every_regex = /^
+        (start(?:s|ing)?)                 # 0
+        \s
+        (.*)
+        (\s(?:every|each|\bon\b|repeat)   # 1
+        (?:s|ing)?)                       # 2
+        (.*)                              # 3
+      /ix
       every_start_regex = /^(every|each|\bon\b|repeat(?:the)?)\s(.*)(\s(?:start)(?:s|ing)?)(.*)/i
-      start_ending_regex = /^(start(?:s|ing)?)\s(.*)(\s(?:\bend|until)(?:s|ing)?)(.*)/i
+      start_ending_regex = /^
+        (start(?:s|ing)?)   # 0
+        \s+
+        (.*?)(?:\s+and)?      # 1
+        (\s
+          (?:\bend|until)
+          (?:s|ing)?
+        )                   # 2
+        (.*)                # 3
+      /ix
       if text =~ start_every_regex
         starting = text.match(start_every_regex)[2].strip
         text = text.match(start_every_regex)[4].strip
@@ -117,8 +135,9 @@ module Tickle  #:nodoc:
         text = text.match(every_start_regex)[4].strip
         starting, ending = process_for_ending(text)
       elsif text =~ start_ending_regex
-        starting = text.match(start_ending_regex)[2].strip
-        ending = text.match(start_ending_regex)[4].strip
+        md = text.match start_ending_regex
+        starting = md.captures[1]
+        ending = md.captures.last.strip
         event = 'day'
       else
         event, ending = process_for_ending(text)
@@ -127,6 +146,7 @@ module Tickle  #:nodoc:
       # they gave a phrase so if we can't interpret then we need to raise an error
       if starting
         Tickle.dwrite("starting: #{starting}")
+        @start ||= nil # initialize the variable to quell warnings
         @start = chronic_parse(pre_filter(starting))
         if @start
           @start.to_time
@@ -172,8 +192,7 @@ module Tickle  #:nodoc:
       text.gsub!(/repeat(s|ing)?(\s)?/, '')
       text.gsub!(/on the(\s)?/, '')
       text.gsub!(/([^\w\d\s])+/, '')
-      text.downcase.strip
-      text = normalize_us_holidays(text)
+      normalize_us_holidays(text.downcase.strip)
     end
 
     # Split the text on spaces and convert each word into
@@ -254,8 +273,6 @@ module Tickle  #:nodoc:
       @tokens.map(&:type)
     end
 
-    protected
-
     # Returns the next available month based on the current day of the month.
     # For example, if get_next_month(15) is called and the start date is the 10th, then it will return the 15th of this month.
     # However, if get_next_month(15) is called and the start date is the 18th, it will return the 15th of next month.
@@ -264,7 +281,8 @@ module Tickle  #:nodoc:
     end
 
     def next_appropriate_year(month, day)
-      year = (Date.new(@start.year.to_i, month.to_i, day.to_i) == @start.to_date) ? @start.year + 1 : @start.year
+      start = @start || Date.today
+      year = (Date.new(start.year.to_i, month.to_i, day.to_i) == start.to_date) ? start.year + 1 : start.year
       return year
     end
 

data/lib/tickle/version.rb

@@ -0,0 +1,5 @@
+module Tickle
+
+  # This library's current version.
+  VERSION = "1.2.0"
+end

data/test/helper.rb

@@ -1,6 +1,13 @@
-require 'rubygems'
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/vendor/"
+  add_filter "/bin/"
+end
+
 require 'test/unit'
 require 'shoulda'
+require 'timecop'
+
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_parsing.rb

@@ -1,19 +1,25 @@
-require File.expand_path(File.dirname(__FILE__) + '/helper')
+require_relative './helper.rb'
 require 'time'
 require 'test/unit'
 
 class TestParsing < Test::Unit::TestCase
 
+	Time_now = Time.parse "2010-05-09 20:57:36 +0000"
   def setup
     Tickle.debug = (ARGV.detect {|a| a == '--d'})
     @verbose = (ARGV.detect {|a| a == '--v'})
-
-    puts "Time.now"
-    p Time.now
+		Timecop.freeze Time_now
+		ENV["TZ"] = "UTC"
 
     @date = Date.today
+    @tz = ENV["TZ"]
   end
 
+	def teardown
+		Timecop.return
+		ENV["TZ"] = @tz
+	end
+
   def test_parse_best_guess_simple
     start = Date.new(2020, 04, 01)
 
@@ -85,11 +91,14 @@ class TestParsing < Test::Unit::TestCase
     assert_date_match(Date.new(2020, 04, 21), 'the twenty first of the month', {:start => start, :now => start})
   end
 
-  def test_parse_best_guess_complex
-    start = Date.new(2020, 04, 01)
-
+  def test_parse_best_guess_complex_and
     assert_tickle_match(@date.bump(:day, 1), @date, @date.bump(:week, 1), 'day', 'starting today and ending one week from now') if Time.now.hour < 21 # => demonstrates leaving out the actual time period and implying it as daily
     assert_tickle_match(@date.bump(:day, 1), @date.bump(:day, 1), @date.bump(:week, 1), 'day','starting tomorrow and ending one week from now') # => demonstrates leaving out the actual time period and implying it as daily.
+	end
+
+
+  def test_parse_best_guess_complex
+    start = Date.new(2020, 04, 01)
 
     assert_tickle_match(@date.bump(:wday, 'Mon'), @date.bump(:wday, 'Mon'), nil, 'month', 'starting Monday repeat every month')
 
@@ -165,30 +174,30 @@ class TestParsing < Test::Unit::TestCase
 
   def test_argument_validation
     assert_raise(Tickle::InvalidArgumentException) do
-      time = Tickle.parse("may 27", :today => 'something odd')
+      Tickle.parse("may 27", :today => 'something odd')
     end
 
     assert_raise(Tickle::InvalidArgumentException) do
-      time = Tickle.parse("may 27", :foo => :bar)
+      Tickle.parse("may 27", :foo => :bar)
     end
 
     assert_raise(Tickle::InvalidArgumentException) do
-      time = Tickle.parse(nil)
+      Tickle.parse(nil)
     end
 
     assert_raise(Tickle::InvalidDateExpression) do
       past_date = Date.civil(Date.today.year, Date.today.month, Date.today.day - 1)
-      time = Tickle.parse("every other day", {:start => past_date})
+      Tickle.parse("every other day", {:start => past_date})
     end
 
     assert_raise(Tickle::InvalidDateExpression) do
-      start_date = Date.civil(Date.today.year, Date.today.month, Date.today.day + 10)
-      end_date = Date.civil(Date.today.year, Date.today.month, Date.today.day + 5)
-      time = Tickle.parse("every other day", :start => start_date, :until => end_date)
+      start_date = Date.civil(Date.today.year, Date.today.month).next_day(10)
+      end_date = Date.civil(Date.today.year, Date.today.month).next_day(5)
+      Tickle.parse("every other day", :start => start_date, :until => end_date)
     end
 
     assert_raise(Tickle::InvalidDateExpression) do
-      end_date = Date.civil(Date.today.year, Date.today.month+2, Date.today.day)
+      end_date = Date.civil(Date.today.year, Date.today.month, Date.today.day).next_month(2)
       parse_now('every 3 months', {:until => end_date})
     end
   end

data/tickle.gemspec

@@ -1,65 +1,34 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tickle/version'
 
 Gem::Specification.new do |s|
   s.name = %q{tickle}
-  s.version = "0.1.7"
+  s.version = Tickle::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Joshua Lippiner"]
-  s.date = %q{2010-05-10}
+  s.authors = ["Joshua Lippiner", "Iain Barnett"]
+  s.email = %q{iainspeed@gmail.com}
   s.description = %q{Tickle is a date/time helper gem to help parse natural language into a recurring pattern.  Tickle is designed to be a compliment of Chronic and can interpret things such as "every 2 days, every Sunday, Sundays, Weekly, etc.}
-  s.email = %q{jlippiner@noctivity.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     ".rvmrc",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "SCENARIOS.rdoc",
-     "VERSION",
-     "git-flow-version",
-     "lib/numerizer/numerizer.rb",
-     "lib/tickle.rb",
-     "lib/tickle/handler.rb",
-     "lib/tickle/repeater.rb",
-     "lib/tickle/tickle.rb",
-     "test/git-flow-version",
-     "test/helper.rb",
-     "test/test_parsing.rb",
-     "tickle.gemspec"
-  ]
-  s.homepage = %q{http://github.com/noctivityinc/tickle}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
   s.summary = %q{natural language parser for recurring events}
-  s.test_files = [
-    "test/helper.rb",
-     "test/test_parsing.rb"
-  ]
+  s.homepage = %q{http://github.com/yb66/tickle}
+  s.license       = "MIT"
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  
+  s.require_paths = ["lib"]
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<chronic>, [">= 0.2.3"])
-      s.add_development_dependency(%q<shoulda>, [">= 2.10.3"])
-    else
-      s.add_dependency(%q<chronic>, [">= 0.2.3"])
-      s.add_dependency(%q<shoulda>, [">= 2.10.3"])
-    end
-  else
-    s.add_dependency(%q<chronic>, [">= 0.2.3"])
-    s.add_dependency(%q<shoulda>, [">= 2.10.3"])
-  end
+  s.add_dependency "gitlab-chronic", "~> 0.10.6"
+  s.add_dependency "numerizer", "~> 0.2.0"
+  s.add_development_dependency "shoulda", "~> 2.10.3"
+  s.add_development_dependency "simplecov"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "maruku"
+  s.add_development_dependency "timecop"
 end
 

metadata

@@ -1,108 +1,211 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tickle
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 7
-  version: 0.1.7
+version: !ruby/object:Gem::Version
+  version: 1.2.0
 platform: ruby
-authors: 
+authors:
 - Joshua Lippiner
+- Iain Barnett
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-05-10 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: chronic
+date: 2020-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gitlab-chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 2
-        - 3
-        version: 0.2.3
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.6
+- !ruby/object:Gem::Dependency
+  name: numerizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
   name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.10.3
+  type: :development
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 10
-        - 3
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
         version: 2.10.3
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: Tickle is a date/time helper gem to help parse natural language into a recurring pattern.  Tickle is designed to be a compliment of Chronic and can interpret things such as "every 2 days, every Sunday, Sundays, Weekly, etc.
-email: jlippiner@noctivity.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: maruku
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Tickle is a date/time helper gem to help parse natural language into
+  a recurring pattern.  Tickle is designed to be a compliment of Chronic and can interpret
+  things such as "every 2 days, every Sunday, Sundays, Weekly, etc.
+email: iainspeed@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
-files: 
-- .document
-- .gitignore
-- .rvmrc
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".travis.yml"
+- CHANGES.md
+- Gemfile
+- LICENCE
+- README.md
 - Rakefile
 - SCENARIOS.rdoc
-- VERSION
+- examples.rb
 - git-flow-version
-- lib/numerizer/numerizer.rb
 - lib/tickle.rb
 - lib/tickle/handler.rb
 - lib/tickle/repeater.rb
 - lib/tickle/tickle.rb
+- lib/tickle/version.rb
+- spec/spec_helper.rb
 - test/git-flow-version
 - test/helper.rb
 - test/test_parsing.rb
 - tickle.gemspec
-has_rdoc: true
-homepage: http://github.com/noctivityinc/tickle
-licenses: []
-
+homepage: http://github.com/yb66/tickle
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 2.5.2.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: natural language parser for recurring events
-test_files: 
+test_files:
+- spec/spec_helper.rb
+- test/git-flow-version
 - test/helper.rb
 - test/test_parsing.rb

data/.rvmrc

@@ -1,9 +0,0 @@
-#!/usr/bin/env bash
-
-# .rvmrc file for tdt application
-
-if [[ "Darwin" = "$(uname)" ]] ; then
-  rvm ruby-1.9.1@tickle --symlink textmate
-else
-  rvm ruby-1.9.1@tickle
-fi

data/VERSION

@@ -1 +0,0 @@
-0.1.7

data/lib/numerizer/numerizer.rb

@@ -1,103 +0,0 @@
-require 'strscan'
-
-class Numerizer
-
-  DIRECT_NUMS = [
-                  ['eleven', '11'],
-                  ['twelve', '12'],
-                  ['thirteen', '13'],
-                  ['fourteen', '14'],
-                  ['fifteen', '15'],
-                  ['sixteen', '16'],
-                  ['seventeen', '17'],
-                  ['eighteen', '18'],
-                  ['nineteen', '19'],
-                  ['ninteen', '19'], # Common mis-spelling
-                  ['zero', '0'],
-                  ['one', '1'],
-                  ['two', '2'],
-                  ['three', '3'],
-                  ['four(\W|$)', '4\1'],  # The weird regex is so that it matches four but not fourty
-                  ['five', '5'],
-                  ['six(\W|$)', '6\1'],
-                  ['seven(\W|$)', '7\1'],
-                  ['eight(\W|$)', '8\1'],
-                  ['nine(\W|$)', '9\1'],
-                  ['ten', '10'],
-                  ['\ba[\b^$]', '1'] # doesn't make sense for an 'a' at the end to be a 1
-                ]
-
-  TEN_PREFIXES = [ ['twenty', 20],
-                    ['thirty', 30],
-                    ['fourty', 40],
-                    ['fifty', 50],
-                    ['sixty', 60],
-                    ['seventy', 70],
-                    ['eighty', 80],
-                    ['ninety', 90]
-                  ]
-
-  BIG_PREFIXES = [ ['hundred', 100],
-                    ['thousand', 1000],
-                    ['million', 1_000_000],
-                    ['billion', 1_000_000_000],
-                    ['trillion', 1_000_000_000_000],
-                  ]
-
-class << self
-  def numerize(string)
-    string = string.dup
-  
-    # preprocess
-    string.gsub!(/ +|([^\d])-([^d])/, '\1 \2') # will mutilate hyphenated-words but shouldn't matter for date extraction
-    string.gsub!(/a half/, 'haAlf') # take the 'a' out so it doesn't turn into a 1, save the half for the end
-
-    # easy/direct replacements
-  
-    DIRECT_NUMS.each do |dn|
-      string.gsub!(/#{dn[0]}/i, dn[1])
-    end
-
-    # ten, twenty, etc.
-
-    TEN_PREFIXES.each do |tp|
-      string.gsub!(/(?:#{tp[0]})( *\d(?=[^\d]|$))*/i) { (tp[1] + $1.to_i).to_s }
-    end
-
-    # hundreds, thousands, millions, etc.
-
-    BIG_PREFIXES.each do |bp|
-      string.gsub!(/(\d*) *#{bp[0]}/i) { (bp[1] * $1.to_i).to_s}
-      andition(string)
-      #combine_numbers(string) # Should to be more efficient way to do this
-    end
-
-    # fractional addition
-    # I'm not combining this with the previous block as using float addition complicates the strings
-    # (with extraneous .0's and such )
-    string.gsub!(/(\d+)(?: | and |-)*haAlf/i) { ($1.to_f + 0.5).to_s }
-
-    string
-  end
-
-private
-  def andition(string)
-    sc = StringScanner.new(string)
-    while(sc.scan_until(/(\d+)( | and )(\d+)(?=[^\w]|$)/i))
-      if sc[2] =~ /and/ || sc[1].size > sc[3].size
-        string[(sc.pos - sc.matched_size)..(sc.pos-1)] = (sc[1].to_i + sc[3].to_i).to_s
-        sc.reset
-      end
-    end
-  end
-
-#  def combine_numbers(string)
-#    sc = StringScanner.new(string)
-#    while(sc.scan_until(/(\d+)(?: | and |-)(\d+)(?=[^\w]|$)/i))
-#      string[(sc.pos - sc.matched_size)..(sc.pos-1)] = (sc[1].to_i + sc[2].to_i).to_s
-#      sc.reset
-#    end
-#  end
-
-end
-end