tickle 1.2.0 → 2.0.0.rc1

checksums.yaml

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

data/.gitignore

@@ -14,8 +14,9 @@ rdoc
 pkg
 bin/
 vendor/
+vendor.noindex/
 Gemfile.lock
-spec/
 .yardoc/
 .bundle/
 .rspec
+*.gem

data/.travis.yml

@@ -1,12 +1,14 @@
 language: ruby
 rvm:
-  - 2.7
-  - jruby
-  - truffleruby
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - ruby-head
+  - jruby-19mode
+#  - rbx-2.1.1  # not working right now, will look at later
 
 # whitelist
 branches:
   only:
     - master
     - develop
-    - v1-branch

data/CHANGES.md

@@ -1,39 +1,21 @@
 # CH CH CH CH CHANGES! #
 
-## Friday the 18th of September 2020, v1.2.0
+## Saturday the 7th of November 2015, 2.0.0.rc1 ##
 
-- 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!
+- Rewrite of the internals.
+- API should be pretty much the same from the outside, but enough things on the inside change to warrant the major version bump.
+- Chronic updated to 0.10.2.
 
 ----
 
-## 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 ##
+## Monday the 11th of November 2013, 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 ##
+## Monday the 11th of November 2013, v1.0.1 ##
 
 * Moved library to new maintainer [https://github.com/yb66/tickle](@yb66)
 * Moved library to [http://semver.org/](semver).

data/Gemfile

@@ -2,9 +2,18 @@ source "https://rubygems.org"
 
 gemspec
 
-group :test do
-  gem "rspec"
+group :development do
+  gem "wirble"
+  gem "maruku"
+  gem "yard"
+  gem "pry-byebug"
+  gem "activesupport"
 end
 
-gem "pry-byebug"
-gem "pry-state"
+group :test do
+  gem "rspec"
+  gem "rspec-its"
+  gem "timecop"
+  gem "simplecov"
+  gem "rake"
+end

data/LICENCE

@@ -1,5 +1,5 @@
 Copyright (c) 2010 Joshua Lippiner
-Copyright (c) 2013 Iain Barnett
+Copyright (c) 2015 Iain Barnett
 
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -11,7 +11,7 @@ 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 complement to [Chronic](https://rubygems.org/gems/chronic) and can interpret things such as "every 2 days, every Sunday, Sundays, Weekly, etc."
+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.
 
 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.   
 
@@ -407,7 +407,7 @@ or if you're using Bundler, add this to the Gemfile:
 
 Chronic gem:
 
-`gem install gitlab-chronic`
+`gem install chronic`
 
 thoughtbot's [shoulda](https://rubygems.org/gems/shoulda):
 

data/Rakefile

@@ -1,11 +1,8 @@
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec
 
 
 desc "(Re-) generate documentation and place it in the docs/ dir. Open the index.html file in there to read it."

data/benchmarks/main.rb

@@ -0,0 +1,71 @@
+require 'benchmark'
+require_relative "../lib/tickle.rb"
+warn Benchmark.measure {
+  Tickle.parse('day')
+#   Tickle.parse('week')
+  Tickle.parse('month')
+  Tickle.parse('year')
+  Tickle.parse('daily')
+#   Tickle.parse('weekly')
+  Tickle.parse('monthly')
+  Tickle.parse('yearly')
+  Tickle.parse('3 days')
+#   Tickle.parse('3 weeks')
+  Tickle.parse('3 months')
+  Tickle.parse('3 years')
+  Tickle.parse('other day')
+#   Tickle.parse('other week')
+  Tickle.parse('other month')
+  Tickle.parse('other year')
+  Tickle.parse('Monday')
+  Tickle.parse('Wednesday')
+  Tickle.parse('Friday')
+  Tickle.parse('February', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('May', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('june', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('beginning of the week')
+  Tickle.parse('middle of the week')
+  Tickle.parse('end of the week')
+  Tickle.parse('beginning of the month', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('middle of the month', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('end of the month', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('beginning of the year', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('middle of the year', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('end of the year', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the 3rd of May', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the 3rd of February', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the 3rd of February 2022', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the 3rd of Feb 2022', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the 4th of the month', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the 10th of the month', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the tenth of the month', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('first', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the first of the month', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the thirtieth', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the fifth', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the 1st Wednesday of the month', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the 3rd Sunday of May', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the 3rd Sunday of the month', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the 23rd of June', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the twenty third of June', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the thirty first of July', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the twenty first', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('the twenty first of the month', {:start=>Time.parse("2020-04-01 00:00:00 +0000"), :now=>Time.parse("2020-04-01 00:00:00 +0000")})
+  Tickle.parse('starting today and ending one week from now')
+  Tickle.parse('starting tomorrow and ending one week from now')
+  Tickle.parse('starting Monday repeat every month')
+  Tickle.parse('starting May 13th repeat every week')
+  Tickle.parse('starting May 13th repeat every other day')
+  Tickle.parse('every other day starts May 13th')
+  Tickle.parse('every other day starts May 13')
+  Tickle.parse('every other day starting May 13th')
+  Tickle.parse('every other day starting May 13')
+  Tickle.parse('every week starts this wednesday')
+  Tickle.parse('every week starting this wednesday')
+  Tickle.parse('every other day starting May 1st 2021')
+  Tickle.parse('every other day starting May 1 2021')
+  Tickle.parse('every other week starting this Sunday')
+  Tickle.parse('every week starting this wednesday until May 13th')
+  Tickle.parse('every week starting this wednesday ends May 13th')
+  Tickle.parse('every week starting this wednesday ending May 13th')
+}

data/lib/ext/array.rb

@@ -0,0 +1,6 @@
+class Array
+  # compares two arrays to determine if they both contain the same elements
+  def same?(y)
+    self.sort == y.sort
+  end
+end

data/lib/ext/date_and_time.rb

@@ -0,0 +1,64 @@
+class Date
+  # returns the days in the sending month
+  def days_in_month
+    d,m,y = mday,month,year
+    d += 1 while Date.valid_civil?(y,m,d)
+    d - 1
+  end
+
+
+  # no idea what this is for
+  def bump(attr, amount=nil)
+    amount ||= 1
+    case attr
+    when :day then
+      Date.civil(self.year, self.month, self.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)
+    when :week then
+      Date.civil(self.year, self.month, self.day + (7*amount))
+    when :month then
+      Date.civil(self.year, self.month+amount, self.day)
+    when :year then
+      Date.civil(self.year + amount, self.month, self.day)
+    when :sec then
+      Date.civil(self.year, self.month, self.day, self.hour, self.minute, self.sec + amount)
+    else
+      raise Exception, "type \"#{attr}\" not supported."
+    end
+  end
+end
+
+class Time
+
+  # same again, no idea what this is for
+  def bump(attr, amount=nil)
+    amount ||= 1
+    case attr
+    when :sec then
+      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)
+    when :hour then
+      Time.local(self.year, self.month, self.day, self.hour + amount, self.min, self.sec)
+    when :day then
+      Time.local(self.year, self.month, self.day + amount, self.hour, self.min, self.sec)
+    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)
+    when :week then
+      Time.local(self.year, self.month, self.day + (amount * 7), self.hour, self.min, self.sec)
+    when :month then
+      Time.local(self.year, self.month + amount, self.day, self.hour, self.min, self.sec)
+    when :year then
+      Time.local(self.year + amount, self.month, self.day, self.hour, self.min, self.sec)
+    else
+      raise Exception, "type \"#{attr}\" not supported."
+    end
+  end
+end

data/lib/ext/string.rb

@@ -0,0 +1,39 @@
+module Tickle
+  class Ordinal < ::String
+    # returns true if the sending string is a text or numeric ordinal (e.g. first or 1st)
+    def is_ordinal?
+      scanner = %w{first second third fourth fifth sixth seventh eighth ninth tenth eleventh twelfth thirteenth fourteenth fifteenth sixteenth seventeenth eighteenth nineteenth twenty thirty thirtieth}
+      regex = /\b(\d*)(st|nd|rd|th)\b/
+      !(self =~ regex).nil? || scanner.include?(self.downcase)
+    end
+
+    def ordinal_as_number
+      return self unless self.is_ordinal?
+      scanner = {/first/ => '1st',
+        /second/ => '2nd',
+        /third/ => '3rd',
+        /fourth/ => '4th',
+        /fifth/ => '5th',
+        /sixth/ => '6th',
+        /seventh/ => '7th',
+        /eighth/ => '8th',
+        /ninth/ => '9th',
+        /tenth/ => '10th',
+        /eleventh/ => '11th',
+        /twelfth/ => '12th',
+        /thirteenth/ => '13th',
+        /fourteenth/ => '14th',
+        /fifteenth/ => '15th',
+        /sixteenth/ => '16th',
+        /seventeenth/ => '17th',
+        /eighteenth/ => '18th',
+        /nineteenth/ => '19th',
+        /twentieth/ => '20th',
+        /thirtieth/ => '30th',
+      }
+      result = self
+      scanner.keys.each {|scanner_item| result = scanner[scanner_item] if scanner_item =~ self}
+      return result.gsub(/\b(\d*)(st|nd|rd|th)\b/, '\1')
+    end
+  end
+end

data/lib/tickle.rb

@@ -9,29 +9,40 @@
 
 $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 'gitlab-chronic'
+require 'chronic'
 
 require 'tickle/tickle'
 require 'tickle/handler'
 require 'tickle/repeater'
+require_relative "tickle/tickled.rb"
+require_relative "ext/array.rb"
+require_relative "ext/date_and_time.rb"
+require_relative "ext/string.rb"
+
+# these are required not because they're used by the library
+# but because they clobber so much that testing
+# without them will miss possible problems
+require 'active_support/core_ext/string/conversions'
+require 'active_support/core_ext/date/calculations'
+require 'active_support/core_ext/date_time/calculations'
+require 'active_support/core_ext/time/calculations'
 
-module Tickle #:nodoc:
+# Tickle is a natural language parser for recurring events.
+module Tickle
 
-  def self.debug=(val); @debug = val; end
+  def self.parse(asked, options = {})
+    # check to see if a datetime was passed
+    # if so, give it back
+    # TODO Consider converting to a Tickled
+    return asked if asked.respond_to? :day
 
-  def self.dwrite(msg, line_feed=nil)
-    (line_feed ? p(">> #{msg}") : puts(">> #{msg}")) if @debug
+    tickled = Tickled.new asked.dup, options
+    _parse tickled
   end
 
+
   def self.is_date(str)
     begin
       Date.parse(str.to_s)
@@ -40,108 +51,4 @@ module Tickle #:nodoc:
       return false
     end
   end
-end
-
-class Date #:nodoc:
-  # returns the days in the sending month
-  def days_in_month
-    d,m,y = mday,month,year
-    d += 1 while Date.valid_civil?(y,m,d)
-    d - 1
-  end
-
-  def bump(attr, amount=nil)
-    amount ||= 1
-    case attr
-    when :day then
-      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).next_day(diff)
-    when :week then
-      Date.civil(self.year, self.month, self.day).next_day(7*amount)
-    when :month then
-      Date.civil(self.year, self.month, self.day).next_month(amount)
-    when :year then
-      Date.civil(self.year, self.month, self.day).next_year(amount)
-    else
-      raise Exception, "type \"#{attr}\" not supported."
-    end
-  end
-end
-
-class Time #:nodoc:
-  def bump(attr, amount=nil)
-    amount ||= 1
-    case attr
-    when :sec then
-      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, self.sec) + (amount * 60)
-    when :hour then
-      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, 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))
-      DateTime.civil(self.year, self.month, self.day, self.hour, self.min, self.sec, self.zone).next_day(diff)
-    when :week then
-      DateTime.civil(self.year, self.month, self.day, self.hour, self.min, self.sec, self.zone).next_day(amount * 7)
-    when :month then
-      DateTime.civil(self.year, self.month, self.day, self.hour, self.min, self.sec, self.zone).next_month(amount)
-    when :year then
-      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.to_time.localtime
-  end
-end
-
-class String #:nodoc:
-  # returns true if the sending string is a text or numeric ordinal (e.g. first or 1st)
-  def is_ordinal?
-    scanner = %w{first second third fourth fifth sixth seventh eighth ninth tenth eleventh twelfth thirteenth fourteenth fifteenth sixteenth seventeenth eighteenth nineteenth twenty thirty thirtieth}
-    regex = /\b(\d*)(st|nd|rd|th)\b/
-    !(self =~ regex).nil? || scanner.include?(self.downcase)
-  end
-
-  def ordinal_as_number
-    return self unless self.is_ordinal?
-    scanner = {/first/ => '1st',
-      /second/ => '2nd',
-      /third/ => '3rd',
-      /fourth/ => '4th',
-      /fifth/ => '5th',
-      /sixth/ => '6th',
-      /seventh/ => '7th',
-      /eighth/ => '8th',
-      /ninth/ => '9th',
-      /tenth/ => '10th',
-      /eleventh/ => '11th',
-      /twelfth/ => '12th',
-      /thirteenth/ => '13th',
-      /fourteenth/ => '14th',
-      /fifteenth/ => '15th',
-      /sixteenth/ => '16th',
-      /seventeenth/ => '17th',
-      /eighteenth/ => '18th',
-      /nineteenth/ => '19th',
-      /twentieth/ => '20th',
-      /thirtieth/ => '30th',
-    }
-    result = self
-    scanner.keys.each {|scanner_item| result = scanner[scanner_item] if scanner_item =~ self}
-    return result.gsub(/\b(\d*)(st|nd|rd|th)\b/, '\1')
-  end
-end
-
-class Array #:nodoc:
-  # compares two arrays to determine if they both contain the same elements
-  def same?(y)
-    self.sort == y.sort
-  end
-end
+end