montrose 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba11d2966c5dc7197138ee39c5fdcfc1466196f1
-  data.tar.gz: 3a41d2be8cfd2a9b5a38f1ae06432be7b6345c30
+  metadata.gz: 98eedcb18d91e3390bc4bf1e9962e2ddd4a596a3
+  data.tar.gz: 3a43325e390bd795c81a5ee6246a413542a59509
 SHA512:
-  metadata.gz: cd28c825b715713b722c41ae2402235fe8c9aa1b251448c941864e360d6898d8456f97a8a5d8a254cbabc4cd1172dc9147075b3591142fd5a1c1ea6589adb15c
-  data.tar.gz: 612673faf64c6800d5c6915b57af335171557dd9e066569c4750d7926e975123c304f80e1968660b048c328dfeeb751a9afd08cef79ddea8f32247fd7b867448
+  metadata.gz: 6983022b0d6ba0aebc265c311362a5e24f6dba4a19d7334d198b0eb49b91161ddfc92276c1edb636d7d6e03bfb0039d41a8a72805932fa22e37917ac5a57676d
+  data.tar.gz: 1264cd660fc3e6fff55485a7a273961147188935a0b22b162090ca63a9293f7a82d54459b04f7a69009aa797c9c73090ac44e7c4779c00207b3473415d52219f

data/.travis.yml

@@ -2,4 +2,5 @@ language: ruby
 rvm:
   - 2.1
   - 2.2
-before_install: gem install bundler -v 1.10.6
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem "pry-byebug", platforms: :ruby_22
+  gem "pry-byebug", platforms: [:ruby_21, :ruby_22, :ruby_23]
   gem "guard"
   gem "guard-minitest"
   gem "guard-rubocop"

data/README.md

@@ -5,10 +5,7 @@
 [![Code Climate](https://codeclimate.com/github/rossta/montrose/badges/gpa.svg)](https://codeclimate.com/github/rossta/montrose)
 [![Dependency Status](https://gemnasium.com/rossta/montrose.svg)](https://gemnasium.com/rossta/montrose)
 
-Recurring events in Ruby.
-
-This library is currently under development. Most of the functionality does not
-exist yet.
+Recurring events in Ruby. This library is still a work-in-progress.
 
 ## Installation
 
@@ -31,6 +28,120 @@ Or install it yourself as:
 ```ruby
 require "montrose"
 
+# daily for 10 occurrences
+Montrose.daily(total: 10)
+
+# daily until December 23, 2015
+starts = Date.new(2015, 1, 1)
+ends = Date.new(2015, 12, 23)
+Montrose.daily(starts: starts, until: ends)
+
+# every other day forever
+Montrose.daily(interval: 2)
+
+# every 10 days 5 occurrences
+Montrose.every(10.days, total: 5)
+
+# everyday in January for 3 years
+starts = Time.now.beginning_of_year
+ends = Time.now.end_of_year + 2.years
+Montrose.daily(month: :january, between: starts...ends)
+
+# weekly for 10 occurrences
+Montrose.weekly(total: 10)
+
+# weekly until December 23, 2015
+ends_on = Date.new(2015, 12, 23)
+starts_on = ends_on - 15.weeks
+Montrose.every(:week, until: ends_on, starts: starts_on
+
+# every other week forever
+Montrose.every(2.weeks)
+
+# weekly on Tuesday and Thursday for five weeks
+# from September 1, 2015 until October 5, 2015
+Montrose.weekly(on: [:tuesday, :thursday],
+  between: Date.new(2015, 9, 1)..Date.new(2015, 10, 5))
+
+# every other week on Monday, Wednesday and Friday until December 23 2015,
+# but starting on Tuesday, September 1, 2015
+Montrose.every(2.weeks,
+  on: [:monday, :wednesday, :friday],
+  starts: Date.new(2015, 9, 1))
+
+# every other week on Tuesday and Thursday, for 8 occurrences
+Montrose.weekly(on: [:tuesday, :thursday], total: 8, interval: 2)
+
+# monthly on the first Friday for ten occurrences
+Montrose.monthly(day: { friday: [1] }, total: 10)
+
+# monthly on the first Friday until December 23, 2015
+Montrose.every(:month, day: { friday: [1] }, until: Date.new(2016, 12, 23))
+
+# every other month on the first and last Sunday of the month for 10 occurrences
+Montrose.every(:month, day: { sunday: [1, -1] }, interval: 2, total: 10)
+
+# monthly on the second-to-last Monday of the month for 6 months
+Montrose.every(:month, day: { monday: [-2] }, total: 6)
+
+# monthly on the third-to-the-last day of the month, forever
+Montrose.every(:month, mday: [-3])
+
+# monthly on the 2nd and 15th of the month for 10 occurrences
+Montrose.every(:month, on: [2, 15], total: 10)
+
+# monthly on the first and last day of the month for 10 occurrences
+Montrose.monthly(mday: [1, -1], total: 10)
+
+# every 18 months on the 10th thru 15th of the month for 10 occurrences
+Montrose.every(18.months, total: 10, mday: 10..15)
+
+# every Tuesday, every other month
+Montrose.every(2.months, on: :tuesday)
+
+# yearly in June and July for 10 occurrences
+Montrose.yearly(month: [:june, :july], total: 10)
+
+# every other year on January, February, and March for 10 occurrences
+Montrose.every(2.years, month: [:january, :february, :march], total: 10)
+
+# every third year on the 1st, 100th and 200th day for 10 occurrences
+Montrose.yearly(yday: [1, 100, 200], total: 10)
+
+# every 20th Monday of the year, forever
+Montrose.yearly(day: { monday: [20] })
+
+# Monday of week number 20 forever
+Montrose.yearly(week: [20], on: :monday)
+
+# every Thursday in March, forever
+Montrose.monthly(month: :march, on: :thursday, at: "12 pm")
+
+# every Thursday, but only during June, July, and August, forever" do
+Montrose.monthly(month: 6..8, on: :thursday)
+
+# every Friday 13th, forever
+Montrose.monthly(on: { friday: 13 })
+
+# first Saturday that follows the first Sunday of the month, forever
+Montrose.monthly(on: { saturday: 7..13 })
+
+# every four years, the first Tuesday after a Monday in November, forever (U.S. Presidential Election day)
+Montrose.every(4.years, month: :november, on: { tuesday: 2..8 })
+
+# every 3 hours from 9:00 AM to 5:00 PM on a specific day
+date = Date.new(2016, 9, 1)
+Montrose.hourly(between: date..(date+1), hour: 9..17, interval: 3)
+
+# every 15 minutes for 6 occurrences
+Montrose.every(90.minutes, total: 6)
+
+# every hour and a half for four occurrences
+Montrose.every(90.minutes, total: 4)
+
+# every 20 minutes from 9:00 AM to 4:40 PM every day
+Montrose.every(20.minutes, hour: 9..16)
+
 # Minutely
 Montrose.minutely
 Montrose::Recurrence.new(every: :minute)
@@ -63,15 +174,11 @@ Montrose.weekly
 Montrose.every(:week)
 Montrose::Recurrence.new(every: :week)
 
-# TODO: :on option not yet supported
-Montrose::Recurrence.new(every: :week, on: 5)
-Montrose::Recurrence.new(every: :week, on: :monday)
-Montrose::Recurrence.new(every: :week, on: [:monday, :wednesday, :friday])
-Montrose::Recurrence.new(every: :week, on: :friday, interval: 2)
-Montrose::Recurrence.new(every: :week, on: :friday, repeat: 4)
-Montrose::Recurrence.new(every: :week, on: :friday, at: "3:41 PM")
-Montrose::Recurrence.new(every: :week, on: [:monday, :wednesday, :friday], at: "12:00 PM")
-Montrose::Recurrence.weekly(on: :thursday)
+Montrose.every(:week, on: :monday)
+Montrose.every(:week, on: [:monday, :wednesday, :friday])
+Montrose.every(2.weeks, on: :friday)
+Montrose.every(:week, on: :friday, at: "3:41 PM")
+Montrose.weekly(on: :thursday)
 
 # Monthly by month day
 Montrose.monthly(mday: 1) # first of the month
@@ -82,34 +189,15 @@ Montrose.monthly(mday: [2, 15]) # 2nd and 15th of the month
 Montrose.monthly(mday: -3) # third-to-last day of the month
 Montrose.monthly(mday: 10..15) # 10th through the 15th day of the month
 
-# TODO: :on option not yet supported
-Montrose::Recurrence.new(every: :month, on: 15)
-Montrose::Recurrence.new(every: :month, on: 31)
-Montrose::Recurrence.new(every: :month, on: 7, interval: 2)
-Montrose::Recurrence.new(every: :month, on: 7, interval: :monthly)
-Montrose::Recurrence.new(every: :month, on: 7, interval: :bimonthly)
-Montrose::Recurrence.new(every: :month, on: 7, repeat: 6)
-Montrose::Recurrence.monthly(on: 31)
-
 # Monthly by week day
 Montrose.monthly(day: :friday, interval: 2) # every Friday every other month
 Montrose.every(:month, day: :friday, interval: 2)
 Montrose::Recurrence.new(every: :month, day: :friday, interval: 2)
 
 Montrose.monthly(day: { friday: [1] }) # 1st Friday of the month
-Montrose.monthly(day: { Sunday: [1, =1] }) # first and last Sunday of the month
-
-Montrose.monthly(mday: 7..13, day: :saturday) # first Saturday that follow the
-first Sunday of the month
+Montrose.monthly(day: { Sunday: [1, -1] }) # first and last Sunday of the month
 
-# TODO: :on option not yet supported
-Montrose::Recurrence.new(every: :month, on: :first, weekday: :sunday)
-Montrose::Recurrence.new(every: :month, on: :third, weekday: :monday)
-Montrose::Recurrence.new(every: :month, on: :last,  weekday: :friday)
-Montrose::Recurrence.new(every: :month, on: :last,  weekday: :friday, interval: 2)
-Montrose::Recurrence.new(every: :month, on: :last,  weekday: :friday, interval: :quarterly)
-Montrose::Recurrence.new(every: :month, on: :last,  weekday: :friday, interval: :semesterly)
-Montrose::Recurrence.new(every: :month, on: :last,  weekday: :friday, repeat: 3)
+Montrose.monthly(mday: 7..13, day: :saturday) # first Saturday that follow the first Sunday of the month
 
 # Yearly
 Montrose.yearly
@@ -117,28 +205,24 @@ Montrose.every(:year)
 Montrose::Recurrence.new(every: :year)
 
 Montrose.yearly(month: [:june, :july]) # yearly in June and July
-Montrose.yearly(month: 6..8, day: :thursday) # yearly in June, July, August on
-Thursday
+Montrose.yearly(month: 6..8, day: :thursday) # yearly in June, July, August on Thursday
 Montrose.yearly(yday: [1, 100]) # yearly on the 1st and 100th day of year
-Montrose.yearly(month: :november, day: :tuesday, mday: 2..8) # every four years,
-the first Tuesday after a Monday in November, i.e., Election Day
-
-# TODO: :on option not yet supported
-Montrose::Recurrence.new(every: :year, on: [7, 4]) # => [month, day]
-Montrose::Recurrence.new(every: :year, on: [10, 31], interval: 3)
-Montrose::Recurrence.new(every: :year, on: [:jan, 31])
-Montrose::Recurrence.new(every: :year, on: [:january, 31])
-Montrose::Recurrence.new(every: :year, on: [10, 31], repeat: 3)
-Montrose::Recurrence.yearly(on: [:january, 31])
-
-# TODO: Remove a date in the series on the given except date(s)
-# :except defaults to being unset
-Montrose::Recurrence.new(every: :day, except: "2017-01-31")
-Montrose::Recurrence.new(every: :day, except: [Date.today, "2017-01-31"])
+
+Montrose::Recurrence.yearly(on: { january: 31 })
+Montrose::Recurrence.new(every: :year, on: { 10 => 31 }, interval: 3)
+
+# TODO: Remove a date in the series with :except date(s)
+Montrose.daily(:day, except: "2017-01-31")
+Montrose.daily(except: [Date.today, "2017-01-31"])
+
+# Chaining
+Montrose.weekly.starting(3.weeks.from_now).on(:friday)
+Montrose.every(:day).at("4:05pm")
 
 # Enumerating events
-r = Montrose::Recurrence.new(every: :month, mday: 31, until: "January 1, 2017")
+r = Montrose.every(:month, mday: 31, until: "January 1, 2017")
 r.each { |time| puts time.to_s }
+r.take(10).to_a
 
 # Merging rules and enumerating
 r.merge(starts: "2017-01-01").each { |time| puts time.to_s }
@@ -155,11 +239,10 @@ r.events.lazy.select { |time| time > 1.month.from_now }.take(3).each { |date| pu
 
 ## Goals
 
-`Montrose` intends to:
+`Montrose` aims to provide a simple interface for specifying and enumerating recurring events as Time objects. To that end, the project intends to:
 
 * embrace Ruby idioms
 * support Ruby 2.1+
-* provide a simple-to-use interface
 * be reasonably performant
 * serialize to yaml, hash, and [ical](http://www.kanzaki.com/docs/ical/rrule.html#basic) formats
 * be suitable for integration with persistence libraries
@@ -168,7 +251,11 @@ What `Montrose` isn't:
 
 * support all calendaring use cases under the sun
 
-## Related Projects
+## Inspiration
+
+Montrose is named after the beautifully diverse and artistic [neighborhood in Houston, Texas](https://en.wikipedia.org/wiki/Montrose,_Houston).
+
+### Related Projects
 
 Check out following related projects, all of which have provided inspiration for `Montrose`.
 

data/lib/montrose/chainable.rb

@@ -75,19 +75,9 @@ module Montrose
     # Create a monthly recurrence.
     #
     # @example
-    #   Montrose.monthly(on: 15) #=> every 15th day
-    #   Montrose.monthly(on: :first, weekday: :sunday)
-    #   Montrose.monthly(on: :second, weekday: :sunday)
-    #   Montrose.monthly(on: :third, weekday: :sunday)
-    #   Montrose.monthly(on: :fourth, weekday: :sunday)
-    #   Montrose.monthly(on: :fifth, weekday: :sunday)
-    #   Montrose.monthly(on: :last, weekday: :sunday)
-    #   Montrose.monthly(on: 15, interval: 2)
-    #   Montrose.monthly(on: 15, interval: :monthly)
-    #   Montrose.monthly(on: 15, interval: :bimonthly)
-    #   Montrose.monthly(on: 15, interval: :quarterly)
-    #   Montrose.monthly(on: 15, interval: :semesterly)
-    #   Montrose.monthly(on: 15, total: 5)
+    # Montrose.monthly(mday: [2, 15]) # 2nd and 15th of the month
+    # Montrose.monthly(mday: -3) # third-to-last day of the month
+    # Montrose.monthly(mday: 10..15) # 10th through the 15th day of the month
     #
     # The <tt>:on</tt> option can be one of the following:
     #
@@ -135,6 +125,22 @@ module Montrose
       merge(between: date_range)
     end
 
+    # Create a recurrence through :on option
+    #
+    # @param [Hash,Symbol] on { friday: 13 }
+    #
+    def on(day)
+      merge(on: day)
+    end
+
+    # Create a recurrence at given time
+    #
+    # @param [String,Time] at
+    #
+    def at(time)
+      merge(at: time)
+    end
+
     # Create a recurrence for given days of month
     #
     # @param [Fixnum] days (1, 2, -1, ...)
@@ -142,6 +148,7 @@ module Montrose
     def day_of_month(*days)
       merge(mday: days)
     end
+    alias mday day_of_month
 
     # Create a recurrence for given days of week
     #
@@ -150,6 +157,7 @@ module Montrose
     def day_of_week(*weekdays)
       merge(day: weekdays)
     end
+    alias day day_of_week
 
     # Create a recurrence for given days of year
     #
@@ -158,6 +166,7 @@ module Montrose
     def day_of_year(*days)
       merge(yday: days)
     end
+    alias yday day_of_year
 
     # Create a recurrence for given hours of day
     #
@@ -166,6 +175,7 @@ module Montrose
     def hour_of_day(*hours)
       merge(hour: hours)
     end
+    alias hour hour_of_day
 
     # Create a recurrence for given months of year
     #
@@ -174,6 +184,7 @@ module Montrose
     def month_of_year(*months)
       merge(month: months)
     end
+    alias month month_of_year
 
     # Create a recurrence that ends after given number
     # of occurrences

data/lib/montrose/options.rb

@@ -99,6 +99,7 @@ module Montrose
       end
       Hash[*hash_pairs].reject { |_k, v| v.nil? }
     end
+    alias to_h to_hash
 
     def []=(option, val)
       send(:"#{option}=", val)
@@ -150,7 +151,7 @@ module Montrose
     end
 
     def day=(days)
-      @day = nested_map_arg(days) { |d| Montrose::Utils.day_number(d) }
+      @day = nested_map_arg(days) { |d| Montrose::Utils.day_number!(d) }
     end
 
     def mday=(mdays)
@@ -166,7 +167,7 @@ module Montrose
     end
 
     def month=(months)
-      @month = map_arg(months) { |d| Montrose::Utils.month_number(d) }
+      @month = map_arg(months) { |d| Montrose::Utils.month_number!(d) }
     end
 
     def between=(range)
@@ -189,12 +190,17 @@ module Montrose
     end
 
     def on=(arg)
-      wday, mday = assert_wday_mday(arg)
-      self[:day] = wday
-      self[:mday] = mday if mday
+      result = decompose_on_arg(arg)
+      self[:day] = result[:day] if result[:day]
+      self[:month] = result[:month] if result[:month]
+      self[:mday] = result[:mday] if result[:mday]
       @on = arg
     end
 
+    def inspect
+      "#<#{self.class} #{to_h.inspect}>"
+    end
+
     private
 
     def nested_map_arg(arg, &block)
@@ -215,7 +221,7 @@ module Montrose
     end
 
     def map_days(arg)
-      map_arg(arg) { |d| Montrose::Utils.day_number(d) }
+      map_arg(arg) { |d| Montrose::Utils.day_number!(d) }
     end
 
     def map_mdays(arg)
@@ -242,15 +248,28 @@ module Montrose
       assert_range_includes(1..MAX_WEEKS_IN_YEAR, week, :absolute)
     end
 
-    def assert_wday_mday(arg)
+    def decompose_on_arg(arg)
       case arg
       when Hash
-        [map_days(arg.keys), map_mdays(*arg.values)]
+        arg.each_with_object({}) do |(k, v), result|
+          key, val = month_or_day(k)
+          result[key] = val
+          result[:mday] ||= []
+          result[:mday] += map_mdays(v)
+        end
       else
-        map_days(arg)
+        { day: map_days(arg) }
       end
     end
 
+    def month_or_day(key)
+      month = Montrose::Utils.month_number(key)
+      return [:month, month] if month
+      day = Montrose::Utils.day_number(key)
+      return [:day, day] if day
+      fail ConfigurationError, "Did not recognize #{key} as a month or day"
+    end
+
     def assert_range_includes(range, item, absolute = false)
       test = absolute ? item.abs : item
       fail ConfigurationError, "Out of range" unless range.include?(test)

data/lib/montrose/recurrence.rb

@@ -47,6 +47,11 @@ module Montrose
     def to_hash
       default_options.to_hash
     end
+    alias to_h to_hash
+
+    def inspect
+      "#<#{self.class}:#{object_id.to_s(16)} #{to_h.inspect}>"
+    end
 
     private
 

data/lib/montrose/rule/nth_day_matcher.rb

@@ -1,3 +1,5 @@
+require "forwardable"
+
 module Montrose
   module Rule
     class NthDayMatcher

data/lib/montrose/utils.rb

@@ -6,27 +6,33 @@ module Montrose
     DAYS = Date::DAYNAMES
 
     def month_number(name)
-      index = case name
-              when Symbol, String
-                MONTHS.index(name.to_s.titleize)
-              when 1..12
-                name
-              end
+      case name
+      when Symbol, String
+        MONTHS.index(name.to_s.titleize)
+      when 1..12
+        name
+      end
+    end
 
-      index or fail ConfigurationError, "Did not recognize month #{name}, must be one of #{MONTHS.inspect}"
+    def month_number!(name)
+      month_number(name) or fail ConfigurationError,
+        "Did not recognize month #{name}, must be one of #{MONTHS.inspect}"
     end
 
     def day_number(name)
-      index = case name
-              when 0..6
-                name
-              when Symbol, String
-                DAYS.index(name.to_s.titleize)
-              when Array
-                day_number name.first
-              end
+      case name
+      when 0..6
+        name
+      when Symbol, String
+        DAYS.index(name.to_s.titleize)
+      when Array
+        day_number name.first
+      end
+    end
 
-      index or fail ConfigurationError, "Did not recognize day #{name}, must be one of #{DAYS.inspect}"
+    def day_number!(name)
+      day_number(name) or fail ConfigurationError,
+        "Did not recognize day #{name}, must be one of #{DAYS.inspect}"
     end
   end
 end

data/lib/montrose/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Montrose
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: montrose
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ross Kaffenberger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-18 00:00:00.000000000 Z
+date: 2016-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Recurring events in Ruby