montrose 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98eedcb18d91e3390bc4bf1e9962e2ddd4a596a3
-  data.tar.gz: 3a43325e390bd795c81a5ee6246a413542a59509
+  metadata.gz: 72c7f27af8ab0e30ced7801cad42cf1243f9f79f
+  data.tar.gz: 228ad308e574dabefc4f5635e76dd878c8d105c9
 SHA512:
-  metadata.gz: 6983022b0d6ba0aebc265c311362a5e24f6dba4a19d7334d198b0eb49b91161ddfc92276c1edb636d7d6e03bfb0039d41a8a72805932fa22e37917ac5a57676d
-  data.tar.gz: 1264cd660fc3e6fff55485a7a273961147188935a0b22b162090ca63a9293f7a82d54459b04f7a69009aa797c9c73090ac44e7c4779c00207b3473415d52219f
+  metadata.gz: 94736a08ae987f52cd24adace44ce7414604d375a0d5281c823426cbc7f9d205fd25dccdbbacd46533cca4dc9bd424395374191ce26b75e4e8897e2ddc35ff25
+  data.tar.gz: ae7a298bc0ed9830656c85ef8cbb74faaf8eb7d22f1ecd854dde5e7ce8d1eefc5a223e27b3d2ecbe683a1113c807a29df205cfeb3ddc324832af0b251a6470b4

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+### 0.2.0 - 2016-02-03
+
+* enhancements
+  * extend `Montrose::Schedule` api for building and adding recurrences
+  * add more details to chainable docs
+  * merge default options at enumeration time for more consistent serialization
+
+### 0.1.1 - 2016-25-01
+
+* bug fixes
+  * add missing `require "forwardable"`
+* enhancements
+  * add better `#inspect` methods in `Recurrence` and `Options`
+  * use refinement to refactor Options internal arg merging
+  * support ruby 2.3.0 in travis builds
+
+### 0.1.0 - 2016-18-01
+
+* initial release

data/README.md

@@ -155,6 +155,7 @@ Montrose::Recurrence.new(every: :minute, until: "9:00 PM")
 
 # Daily
 Montrose.daily
+Montrose.every(:day)
 Montrose::Recurrence.new(every: :day)
 
 Montrose.every(9.days)
@@ -218,18 +219,15 @@ Montrose.daily(except: [Date.today, "2017-01-31"])
 # Chaining
 Montrose.weekly.starting(3.weeks.from_now).on(:friday)
 Montrose.every(:day).at("4:05pm")
+Montrose.yearly.between(Time.now..10.years.from_now)
 
 # Enumerating events
 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
+# Merging rules
 r.merge(starts: "2017-01-01").each { |time| puts time.to_s }
-r.merge(starts: "2017-01-01").each { |date| puts date.to_s }
-r.merge(until: "2017-01-10").each { |date| puts date.to_s }
-r.merge(through: "2017-01-10").each { |date| puts date.to_s }
-r.merge(starts: "2017-01-05", until: "2017-01-10").each {|date| puts date.to_s }
 
 # Using #events Enumerator
 r.events # => #<Enumerator: ...>

data/Rakefile

@@ -4,10 +4,6 @@ require "rake/testtask"
 require "rubocop/rake_task"
 require "yard"
 
-YARD::Rake::YardocTask.new do |t|
-  t.files = ["README.md", "lib/**/*.rb"]
-end
-
 Rake::TestTask.new(:spec) do |t|
   t.libs << "spec"
   t.libs << "lib"
@@ -19,3 +15,16 @@ task test: :spec
 RuboCop::RakeTask.new
 
 task default: [:spec, :rubocop]
+
+namespace :doc do
+  desc "Generate docs and publish to gh-pages"
+  task :publish do
+    require "fileutils"
+    sh "yard doc"
+    sh "git checkout gh-pages"
+    sh "cp -R doc/* ."
+    sh "git commit -vam 'Update documentation'"
+    sh "git push origin gh-pages"
+    sh "git checkout -"
+  end
+end

data/lib/montrose/chainable.rb

@@ -1,13 +1,19 @@
 require "montrose/options"
+require "montrose/refinements/array_concat"
 
 module Montrose
   module Chainable
+    using Montrose::Refinements::ArrayConcat
+
     # Create a recurrence from the given frequency
-    # @example
     #
+    # @param frequency [Symbol,String,Numeric] the recurrence frequency
+    # @param options [Hash] additional recurrence options
+    #
+    # @example
     #   Montrose.every(:hour)
-    #   Montrose.every(:hour, interval: 2) #=> every 2 hours
-    #   Montrose.every(3.days, starts: 2.days.from_now) #=> every 3 days
+    #   Montrose.every(:hour, interval: 2)
+    #   Montrose.every(3.days, starts: 2.days.from_now)
     #   Montrose.every(1.year, until: 10.days.from_now)
     #
     def every(frequency, options = {})
@@ -16,8 +22,9 @@ module Montrose
 
     # Create a minutely recurrence.
     #
-    # @example
+    # @param options [Hash] additional recurrence options
     #
+    # @example
     #   Montrose.minutely
     #   Montrose.minutely(interval: 2) #=> every 2 minutes
     #   Montrose.minutely(starts: 3.days.from_now)
@@ -31,8 +38,9 @@ module Montrose
 
     # Create a hourly recurrence.
     #
-    # @example
+    # @param options [Hash] additional recurrence options
     #
+    # @example
     #   Montrose.hourly
     #   Montrose.hourly(interval: 2) #=> every 2 hours
     #   Montrose.hourly(starts: 3.days.from_now)
@@ -46,8 +54,9 @@ module Montrose
 
     # Create a daily recurrence.
     #
-    # @example
+    # @param options [Hash] additional recurrence options
     #
+    # @example
     #   Montrose.daily
     #   Montrose.daily(interval: 2) #=> every 2 days
     #   Montrose.daily(starts: 3.days.from_now)
@@ -61,6 +70,8 @@ module Montrose
 
     # Create a weekly recurrence.
     #
+    # @param options [Hash] additional recurrence options
+    #
     # @example
     #   Montrose.weekly(on: 5) #=> 0 = sunday, 1 = monday, ...
     #   Montrose.weekly(on: :saturday)
@@ -74,14 +85,12 @@ module Montrose
 
     # Create a monthly recurrence.
     #
-    # @example
-    # 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:
+    # @param options [Hash] additional recurrence options
     #
-    #   * :sunday, :monday, :tuesday, :wednesday, :thursday, :friday, :saturday
+    # @example
+    #   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
     #
     def monthly(options = {})
       branch options.merge(every: :month)
@@ -89,8 +98,9 @@ module Montrose
 
     # Create a yearly recurrence.
     #
-    # @example
+    # @param options [Hash] additional recurrence options
     #
+    # @example
     #   Montrose.yearly(on: [7, 14]) #=> every Jul 14
     #   Montrose.yearly(on: [7, 14], interval: 2) #=> every 2 years on Jul 14
     #   Montrose.yearly(on: [:jan, 14], interval: 2)
@@ -103,7 +113,10 @@ module Montrose
 
     # Create a recurrence starting at given timestamp.
     #
-    # @param [Time, Date] starts_at
+    # @param starts_at [Time, Date] start time of recurrence
+    #
+    # @example
+    #   Montrose.daily.starting(Date.tomorrow)
     #
     def starting(starts_at)
       merge(starts: starts_at)
@@ -111,7 +124,10 @@ module Montrose
 
     # Create a recurrence ending at given timestamp.
     #
-    # @param [Time, Date] ends_at
+    # @param ends_at [Time, Date] end time of recurrence
+    #
+    # @example
+    #   Montrose.daily.ending(1.year.from_now)
     #
     def ending(ends_at)
       merge(until: ends_at)
@@ -121,13 +137,20 @@ module Montrose
     #
     # @param [Range<Date>] date_range
     #
+    # @example
+    #   Montrose.weekly.between(Date.today..Date.new(2016, 3, 15))
+    #
     def between(date_range)
       merge(between: date_range)
     end
 
     # Create a recurrence through :on option
     #
-    # @param [Hash,Symbol] on { friday: 13 }
+    # @param day [Hash,Symbol] weekday or day of month as hash, e.g. { friday: 13 }
+    #
+    # @example
+    #   Montrose.weekly.on(:friday)
+    #   Montrose.monthly.on(friday: 13)
     #
     def on(day)
       merge(on: day)
@@ -135,7 +158,11 @@ module Montrose
 
     # Create a recurrence at given time
     #
-    # @param [String,Time] at
+    # @param time [String,Time] represents time of day
+    #
+    # @example
+    #   Montrose.daily.at("12pm")
+    #   Montrose.daily.at("9:37am")
     #
     def at(time)
       merge(at: time)
@@ -143,69 +170,110 @@ module Montrose
 
     # Create a recurrence for given days of month
     #
-    # @param [Fixnum] days (1, 2, -1, ...)
+    # @param days [Fixnum] days of month, e.g. 1, 2, -1, ...
     #
-    def day_of_month(*days)
-      merge(mday: days)
+    # @example
+    #   Montrose.daily.day_of_month(1, -1)
+    #   Montrose.daily.day_of_month([1, -1])
+    #   Montrose.daily.day_of_month(2..8)
+    #
+    def day_of_month(days, *extras)
+      merge(mday: days.array_concat(extras))
     end
     alias mday day_of_month
 
     # Create a recurrence for given days of week
     #
-    # @param [Symbol] weekdays (:sunday, :monday, ...)
+    # @param weekdays [Symbol] days of week, e.g. :sunday, :monday, ...
+    #
+    # @example
+    #   Montrose.daily.day_of_week(:saturday)
+    #   Montrose.daily.day_of_week(:monday, :tuesday)
+    #   Montrose.daily.day_of_week(2..5)
     #
-    def day_of_week(*weekdays)
-      merge(day: weekdays)
+    def day_of_week(weekdays, *extras)
+      merge(day: weekdays.array_concat(extras))
     end
     alias day day_of_week
 
     # Create a recurrence for given days of year
     #
-    # @param [Fixnum] days (1, 10, 100, ...)
+    # @param days [Fixnum, Range, Array<Integer>] days of year, e.g., 1, 10, 100, ...
     #
-    def day_of_year(*days)
-      merge(yday: days)
+    # @example
+    #   Montrose.daily.day_of_year(1, 10, 100)
+    #   Montrose.daily.day_of_year([1, 10, 100])
+    #   Montrose.daily.day_of_year(20..50)
+    #
+    def day_of_year(days, *extras)
+      merge(yday: days.array_concat(extras))
     end
     alias yday day_of_year
 
     # Create a recurrence for given hours of day
     #
-    # @param [Fixnum, Range] days (1, 10, 100, ...)
+    # @param hours [Fixnum, Range, Array<Integer>] hours of day, e.g. 1, 10, 100, ...
     #
-    def hour_of_day(*hours)
-      merge(hour: hours)
+    # @example
+    #   Montrose.hourly.hour_of_day(9)
+    #   Montrose.hourly.hour_of_day(15)
+    #   Montrose.hourly.hour_of_day(6..10)
+    #
+    def hour_of_day(hours, *extras)
+      merge(hour: hours.array_concat(extras))
     end
     alias hour hour_of_day
 
     # Create a recurrence for given months of year
     #
-    # @param [Fixnum, Symbol] months (:january, :april, ...)
+    # @param months [Fixnum, Symbol] months of year, e.g., :january, :april, ...
+    #
+    # @example
+    #   Montrose.monthly.month_of_year(9)
+    #   Montrose.monthly.month_of_year([2, 5])
+    #   Montrose.monthly.month_of_year(2..5)
     #
-    def month_of_year(*months)
-      merge(month: months)
+    def month_of_year(months, *extras)
+      merge(month: months.array_concat(extras))
     end
     alias month month_of_year
 
+    # Create a recurrence for given weeks of year
+    #
+    # @param weeks [Fixnum] weeks of year, e.g., 1, 20, 50
+    #
+    # @example
+    #   Montrose.weekly.week_of_year(9)
+    #   Montrose.weekly.week_of_year([2, 5])
+    #   Montrose.weekly.week_of_year(2..5)
+    #
+    def week_of_year(weeks, *extras)
+      merge(week: weeks.array_concat(extras))
+    end
+
     # Create a recurrence that ends after given number
     # of occurrences
     #
-    # @param [Fixnum] total
+    # @param total [Fixnum] repeat count
+    #
+    # @example
+    #   Montrose.daily.total(10)
     #
     def total(total)
       merge(total: total)
     end
 
-    # Create a recurrence for given weeks of year
+    # Create a new recurrence combining options of self
+    # and other. The value of entries with duplicate
+    # keys will be those of other
     #
-    # @param [Fixnum] weeks (1, 20, 50)
+    # @param opts [Hash,Montrose::Recurrence] other options or recurrence
     #
-    def week_of_year(*weeks)
-      merge(week: weeks)
-    end
-
-    # @private
-    def merge(opts = {})
-      branch default_options.merge(opts)
+    # @example
+    #   Montrose.daily.total(10)
+    #
+    def merge(other = {})
+      branch default_options.merge(other)
     end
 
     # @private

data/lib/montrose/clock.rb

@@ -3,7 +3,7 @@ require "montrose/errors"
 module Montrose
   class Clock
     def initialize(opts = {})
-      @options = Montrose::Options.new(opts)
+      @options = Montrose::Options.merge(opts)
       @time = nil
       @every = @options.fetch(:every) { fail ConfigurationError, "Required option :every not provided" }
       @starts = @options.fetch(:starts)
@@ -44,13 +44,13 @@ module Montrose
     # when options contain given unit as a key or as a value of
     # the key :every in options
     #
-    # @options = { every: :day, hour: 8.12 }
+    # options = { every: :day, hour: 8.12 }
     # unit_step(:minute)
     # => nil
     # unit_step(:hour)
     # => { hour: 1 }
     #
-    # @options = { every: :hour, interval: 6 }
+    # options = { every: :hour, interval: 6 }
     # unit_step(:minute)
     # => nil
     # unit_step(:hour)

data/lib/montrose/frequency.rb

@@ -43,7 +43,7 @@ module Montrose
     end
 
     def initialize(opts = {})
-      opts = Montrose::Options.new(opts)
+      opts = Montrose::Options.merge(opts)
       @time = nil
       @starts = opts.fetch(:starts)
       @interval = opts.fetch(:interval)

data/lib/montrose/options.rb

@@ -58,6 +58,18 @@ module Montrose
           @default_starts
         end
       end
+
+      def merge(opts = {})
+        new(default_options).merge(opts)
+      end
+
+      def default_options
+        {
+          starts: default_starts,
+          until: default_until,
+          interval: 1
+        }
+      end
     end
 
     def_option :every
@@ -78,9 +90,9 @@ module Montrose
     def initialize(opts = {})
       defaults = {
         every: self.class.default_every,
-        starts: self.class.default_starts,
-        until: self.class.default_until,
-        interval: 1,
+        interval: nil,
+        starts: nil,
+        until: nil,
         day: nil,
         mday: nil,
         yday: nil,
@@ -272,7 +284,7 @@ module Montrose
 
     def assert_range_includes(range, item, absolute = false)
       test = absolute ? item.abs : item
-      fail ConfigurationError, "Out of range" unless range.include?(test)
+      fail ConfigurationError, "Out of range: #{range.inspect} does not include #{test}" unless range.include?(test)
 
       item
     end

data/lib/montrose/recurrence.rb

@@ -56,7 +56,7 @@ module Montrose
     private
 
     def event_enum
-      opts = @default_options
+      opts = Options.merge(@default_options)
       stack = Stack.new(opts)
       clock = Clock.new(opts)
 

data/lib/montrose/refinements/array_concat.rb

@@ -0,0 +1,11 @@
+module Montrose
+  module Refinements
+    module ArrayConcat
+      refine Object do
+        def array_concat(other)
+          Array(self) + other
+        end
+      end
+    end
+  end
+end

data/lib/montrose/rule/hour_of_day.rb

@@ -9,7 +9,7 @@ module Montrose
 
       # Initializes rule
       #
-      # @param [Array<Fixnum>] hour - valid hours of days, e.g. [1, 2, 24]
+      # @param hours [Array<Fixnum>] valid hours of days, e.g. [1, 2, 24]
       #
       def initialize(hours)
         @hours = hours

data/lib/montrose/schedule.rb

@@ -2,6 +2,12 @@ module Montrose
   class Schedule
     attr_accessor :rules
 
+    def self.build
+      schedule = new
+      yield schedule if block_given?
+      schedule
+    end
+
     def initialize
       @rules = []
     end
@@ -21,8 +27,7 @@ module Montrose
       enums = @rules.map { |r| r.merge(opts).events }
       Enumerator.new do |y|
         loop do
-          enums = active_enums(enums)
-          enum = enums.min_by(&:peek) or break
+          enum = active_enums(enums).min_by(&:peek) or break
           y << enum.next
         end
       end
@@ -31,10 +36,11 @@ module Montrose
     private
 
     def active_enums(enums)
-      enums.each_with_object([]) do |enum, actives|
+      enums.select do |e|
         begin
-          actives << enum if enum.peek
+          e.peek
         rescue StopIteration
+          false
         end
       end
     end

data/lib/montrose/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: montrose
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ross Kaffenberger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-25 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -119,6 +119,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -145,6 +146,7 @@ files:
 - lib/montrose/frequency/yearly.rb
 - lib/montrose/options.rb
 - lib/montrose/recurrence.rb
+- lib/montrose/refinements/array_concat.rb
 - lib/montrose/rule.rb
 - lib/montrose/rule/after.rb
 - lib/montrose/rule/before.rb
@@ -184,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Recurring events in Ruby