montrose 0.1.0

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "montrose"
+
+require "pry"
+Pry.start

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/m

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'm' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('m', 'm')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rubocop

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/montrose.rb

@@ -0,0 +1,20 @@
+require "active_support"
+require "active_support/core_ext/object"
+require "active_support/core_ext/numeric"
+require "active_support/core_ext/date"
+require "active_support/core_ext/time"
+require "active_support/core_ext/date_time"
+
+require "montrose/utils"
+require "montrose/rule"
+require "montrose/clock"
+require "montrose/chainable"
+require "montrose/recurrence"
+require "montrose/frequency"
+require "montrose/schedule"
+require "montrose/stack"
+require "montrose/version"
+
+module Montrose
+  extend Chainable
+end

data/lib/montrose/chainable.rb

@@ -0,0 +1,210 @@
+require "montrose/options"
+
+module Montrose
+  module Chainable
+    # Create a recurrence from the given frequency
+    # @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(1.year, until: 10.days.from_now)
+    #
+    def every(frequency, options = {})
+      branch options.merge(every: frequency)
+    end
+
+    # Create a minutely recurrence.
+    #
+    # @example
+    #
+    #   Montrose.minutely
+    #   Montrose.minutely(interval: 2) #=> every 2 minutes
+    #   Montrose.minutely(starts: 3.days.from_now)
+    #   Montrose.minutely(until: 10.days.from_now)
+    #   Montrose.minutely(total: 5)
+    #   Montrose.minutely(except: Date.tomorrow)
+    #
+    def minutely(options = {})
+      branch options.merge(every: :minute)
+    end
+
+    # Create a hourly recurrence.
+    #
+    # @example
+    #
+    #   Montrose.hourly
+    #   Montrose.hourly(interval: 2) #=> every 2 hours
+    #   Montrose.hourly(starts: 3.days.from_now)
+    #   Montrose.hourly(until: 10.days.from_now)
+    #   Montrose.hourly(total: 5)
+    #   Montrose.hourly(except: Date.tomorrow)
+    #
+    def hourly(options = {})
+      branch options.merge(every: :hour)
+    end
+
+    # Create a daily recurrence.
+    #
+    # @example
+    #
+    #   Montrose.daily
+    #   Montrose.daily(interval: 2) #=> every 2 days
+    #   Montrose.daily(starts: 3.days.from_now)
+    #   Montrose.daily(until: 10.days.from_now)
+    #   Montrose.daily(total: 5)
+    #   Montrose.daily(except: Date.tomorrow)
+    #
+    def daily(options = {})
+      branch options.merge(every: :day)
+    end
+
+    # Create a weekly recurrence.
+    #
+    # @example
+    #   Montrose.weekly(on: 5) #=> 0 = sunday, 1 = monday, ...
+    #   Montrose.weekly(on: :saturday)
+    #   Montrose.weekly(on: [sunday, :saturday])
+    #   Montrose.weekly(on: :saturday, interval: 2)
+    #   Montrose.weekly(on: :saturday, total: 5)
+    #
+    def weekly(options = {})
+      branch options.merge(every: :week)
+    end
+
+    # 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)
+    #
+    # The <tt>:on</tt> option can be one of the following:
+    #
+    #   * :sunday, :monday, :tuesday, :wednesday, :thursday, :friday, :saturday
+    #
+    def monthly(options = {})
+      branch options.merge(every: :month)
+    end
+
+    # Create a yearly recurrence.
+    #
+    # @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)
+    #   Montrose.yearly(on: [:january, 14], interval: 2)
+    #   Montrose.yearly(on: [:january, 14], total: 5)
+    #
+    def yearly(options = {})
+      branch options.merge(every: :year)
+    end
+
+    # Create a recurrence starting at given timestamp.
+    #
+    # @param [Time, Date] starts_at
+    #
+    def starting(starts_at)
+      merge(starts: starts_at)
+    end
+
+    # Create a recurrence ending at given timestamp.
+    #
+    # @param [Time, Date] ends_at
+    #
+    def ending(ends_at)
+      merge(until: ends_at)
+    end
+
+    # Create a recurrence occurring during date range.
+    #
+    # @param [Range<Date>] date_range
+    #
+    def between(date_range)
+      merge(between: date_range)
+    end
+
+    # Create a recurrence for given days of month
+    #
+    # @param [Fixnum] days (1, 2, -1, ...)
+    #
+    def day_of_month(*days)
+      merge(mday: days)
+    end
+
+    # Create a recurrence for given days of week
+    #
+    # @param [Symbol] weekdays (:sunday, :monday, ...)
+    #
+    def day_of_week(*weekdays)
+      merge(day: weekdays)
+    end
+
+    # Create a recurrence for given days of year
+    #
+    # @param [Fixnum] days (1, 10, 100, ...)
+    #
+    def day_of_year(*days)
+      merge(yday: days)
+    end
+
+    # Create a recurrence for given hours of day
+    #
+    # @param [Fixnum, Range] days (1, 10, 100, ...)
+    #
+    def hour_of_day(*hours)
+      merge(hour: hours)
+    end
+
+    # Create a recurrence for given months of year
+    #
+    # @param [Fixnum, Symbol] months (:january, :april, ...)
+    #
+    def month_of_year(*months)
+      merge(month: months)
+    end
+
+    # Create a recurrence that ends after given number
+    # of occurrences
+    #
+    # @param [Fixnum] total
+    #
+    def total(total)
+      merge(total: total)
+    end
+
+    # Create a recurrence for given weeks of year
+    #
+    # @param [Fixnum] weeks (1, 20, 50)
+    #
+    def week_of_year(*weeks)
+      merge(week: weeks)
+    end
+
+    # @private
+    def merge(opts = {})
+      branch default_options.merge(opts)
+    end
+
+    # @private
+    def default_options
+      @default_options ||= Montrose::Options.new
+    end
+
+    # @private
+    def branch(options)
+      Montrose::Recurrence.new(options)
+    end
+  end
+end

data/lib/montrose/clock.rb

@@ -0,0 +1,77 @@
+require "montrose/errors"
+
+module Montrose
+  class Clock
+    def initialize(opts = {})
+      @options = Montrose::Options.new(opts)
+      @time = nil
+      @every = @options.fetch(:every) { fail ConfigurationError, "Required option :every not provided" }
+      @starts = @options.fetch(:starts)
+      @interval = @options.fetch(:interval)
+    end
+
+    # Advances time to new unit by increment and sets
+    # new time as "current" time for next tick
+    #
+    def tick
+      @time = peek
+    end
+
+    def peek
+      return @starts if @time.nil?
+
+      @time.advance(step)
+    end
+
+    private
+
+    def step
+      @step ||= smallest_step or fail ConfigurationError, "No step for #{@options.inspect}"
+    end
+
+    def smallest_step
+      unit_step(:minute) ||
+        unit_step(:hour) ||
+        unit_step(:day, :mday, :yday) ||
+        unit_step(:week) ||
+        unit_step(:month) ||
+        unit_step(:year)
+    end
+
+    # @private
+    #
+    # Returns hash representing unit and amount to advance time
+    # when options contain given unit as a key or as a value of
+    # the key :every in options
+    #
+    # @options = { every: :day, hour: 8.12 }
+    # unit_step(:minute)
+    # => nil
+    # unit_step(:hour)
+    # => { hour: 1 }
+    #
+    # @options = { every: :hour, interval: 6 }
+    # unit_step(:minute)
+    # => nil
+    # unit_step(:hour)
+    # => { hour: 6 }
+    #
+    def unit_step(unit, *alternates)
+      is_frequency = @every == unit
+      if ([unit] + alternates).any? { |u| @options.key?(u) } && !is_frequency
+        # smallest unit, increment by 1
+        { step_key(unit) => 1 }
+      elsif is_frequency
+        { step_key(unit) => @interval }
+      end
+    end
+
+    # @private
+    #
+    # Change 'unit' to :units
+    #
+    def step_key(unit)
+      "#{unit}s".to_sym
+    end
+  end
+end

data/lib/montrose/errors.rb

@@ -0,0 +1,5 @@
+module Montrose
+  Error = Class.new(StandardError)
+  ConfigurationError = Class.new(Error)
+  SerializationError = Class.new(Error)
+end

data/lib/montrose/frequency.rb

@@ -0,0 +1,63 @@
+require "montrose/errors"
+require "montrose/options"
+
+module Montrose
+  # Abstract class for special recurrence rule required
+  # in all instances of Recurrence. Frequency describes
+  # the base recurrence interval.
+  #
+  class Frequency
+    include Montrose::Rule
+
+    FREQUENCY_TERMS = {
+      "minute" => "Minutely",
+      "hour" => "Hourly",
+      "day" => "Daily",
+      "week" => "Weekly",
+      "month" => "Monthly",
+      "year" => "Yearly"
+    }.freeze
+
+    FREQUENCY_KEYS = FREQUENCY_TERMS.keys.freeze
+
+    attr_reader :time, :starts
+
+    # Factory method for instantiating the appropriate Frequency
+    # subclass.
+    #
+    def self.from_options(opts)
+      frequency = opts.fetch(:every) { fail ConfigurationError, "Please specify the :every option" }
+      class_name = FREQUENCY_TERMS.fetch(frequency.to_s) do
+        fail "Don't know how to enumerate every: #{frequency}"
+      end
+
+      Montrose::Frequency.const_get(class_name).new(opts)
+    end
+
+    # @private
+    def self.assert(frequency)
+      FREQUENCY_TERMS.key?(frequency.to_s) or fail ConfigurationError,
+        "Don't know how to enumerate every: #{frequency}"
+
+      frequency.to_sym
+    end
+
+    def initialize(opts = {})
+      opts = Montrose::Options.new(opts)
+      @time = nil
+      @starts = opts.fetch(:starts)
+      @interval = opts.fetch(:interval)
+    end
+
+    def matches_interval?(time_diff)
+      (time_diff % @interval).zero?
+    end
+  end
+end
+
+require "montrose/frequency/daily"
+require "montrose/frequency/hourly"
+require "montrose/frequency/minutely"
+require "montrose/frequency/monthly"
+require "montrose/frequency/weekly"
+require "montrose/frequency/yearly"