montrose 0.10.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0db24b32e84647b7cbcc6ef866ae5e4b281586988c204db9121aa7e34b3bc00b
-  data.tar.gz: de8cd6aff8fed30f62691433931fb20dab2f7d759f985969753f2615687f073d
+  metadata.gz: d44082eaa05a068714f05fe6116f8442b0507b3c7612174d93716ce6fd4af4ba
+  data.tar.gz: 691d88452db689b1555772b6749ae12e72bf675fbc55d4082b2d7f4cd41dd795
 SHA512:
-  metadata.gz: a17683c42b4660c9c4b10c22566d33043b1fbf2e38ada33966520b69ff5ce64f7f420e992379b3db2f0d301d467afa69ff965bec42c184a09b466b686db5749e
-  data.tar.gz: 4d5c02063938b9573efccfabf454ac733f6fbbcd916722ef6b923d8a9c70bb466d85c2dc2a9d3216fdc3a1e6c7463ada8cdf2b8740e82a5f967c1bae64039fcc
+  metadata.gz: 389adad3b13244fdb642204fa158bde6a204de4c752cab7a11dc1fe2a237a98f7b73c905477fd335d47164b795921a92090b68a528327b115ff2721b8c2945f7
+  data.tar.gz: 9ce4b11ae2d6c0fd06b06ca9fe56aa05767bca879be8c5cd3a24dae1c7fed442ca50d4195cf5225ff42f1bb2f2704a9ab8fb308b0a9167865317a245dd782441

data/.circleci/config.yml

@@ -0,0 +1,65 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@1.1.2
+commands:
+  run-tests:
+    description: Run tests
+    steps:
+      - run: bundle exec rake test
+  restore:
+    description: Restore cache
+    steps:
+      - restore_cache:
+          keys:
+            - v1_bundler_deps-
+  save:
+    description: Save cache
+    steps:
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-bundler-deps-{{ .Environment.CIRCLE_JOB }}
+  bundle:
+    description: Install dependencies
+    steps:
+      - run:
+          echo "export BUNDLE_JOBS=4" >> $BASH_ENV
+          echo "export BUNDLE_RETRY=3" >> $BASH_ENV
+          echo "export BUNDLE_PATH=$(pwd)/vendor/bundle" >> $BASH_ENV
+          echo "export BUNDLE_GEMFILE=$(pwd)/${GEMFILE_NAME}" >> $BASH_ENV
+      - run: bundle install
+
+jobs:
+  test:
+    parameters:
+      ruby_version:
+        type: string
+      gemfile:
+        type: string
+    docker:
+      - image: 'circleci/ruby:<< parameters.ruby_version >>'
+    environment:
+      GEMFILE_NAME: <<parameters.gemfile>>
+    steps:
+      - checkout
+      - restore
+      - bundle
+      - save
+      - run-tests
+
+workflows:
+  all-tests:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              ruby_version: ['2.5', '2.6', '2.7']
+              gemfile:
+                [
+                  'gemfiles/activesupport_5.2.gemfile',
+                  'gemfiles/activesupport_6.0.gemfile',
+                  'gemfiles/activesupport_6.1.gemfile',
+                ]
+            # exclude:
+            #   - ruby_version: '3.0'
+            #   - gemfile: rails_5_2.gemfile

data/Appraisals

@@ -1,21 +1,13 @@
 # frozen_string_literal: true
 
-appraise "activesupport-5.2" do
-  gem "activesupport", "~> 5.2.0"
-end
-
-appraise "activesupport-5.1" do
-  gem "activesupport", "~> 5.1.0"
+appraise "activesupport-6.1" do
+  gem "activesupport", "~> 6.1.0"
 end
 
-appraise "activesupport-5.0" do
-  gem "activesupport", "~> 5.0.0"
+appraise "activesupport-6.0" do
+  gem "activesupport", "~> 6.0.0"
 end
 
-appraise "activesupport-4.2" do
-  gem "activesupport", "~> 4.2.0"
-end
-
-appraise "activesupport-4.1" do
-  gem "activesupport", "~> 4.1.0"
+appraise "activesupport-5.2" do
+  gem "activesupport", "~> 5.2.0"
 end

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 0.11.0 - (2019-08-16)
+
+* enhancements
+  * Adds `Recurrence#during` to support recurrences within time-of-day ranges,
+    e.g. `Montrose.every(20.minutes).during("9am-5pm")`
+
+### 0.10.1 - (2019-07-22)
+
+* enhancements
+  * Adds `Schedule.dump` and `Schedule.load` to support ActiveRecord column
+    serialization
+
 ### 0.10.0 - (2019-07-17)
 
 * enhancements
@@ -61,7 +73,7 @@
   * Previously, the :between option served as a shorthand for :starts to :until.
     Now, when both :starts and :between are provided, the recurrence will behave
 as if anchored by the given :starts option, but filtered through the given
-:betweeen option.
+:between option.
   * The :exclude_end option changes the default behavior of :until--when the
     timestamp of the interval matches the :until timestamp, it will be included
 by default unless the :exclude_end option is set to true.

data/Guardfile

@@ -25,8 +25,8 @@ guard :minitest do
 
   # with Minitest::Spec
   watch(%r{^spec/(.*)_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^lib/(.+)\.rb$})         { "spec/rfc_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$}) { "spec/rfc_spec.rb" }
   watch(%r{^spec/spec_helper\.rb$}) { "spec" }
 end
 

data/README.md

@@ -277,6 +277,15 @@ 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)
 
+# every 20 minutes from 9:00 AM to 4:40 PM every day with time-of-day precision
+r = Montrose.every(20.minutes)
+r.during("9am-4:40pm")                                        # as semantic time-of-day range OR
+r.during(time.change(hour: 9)..time.change(hour: 4: min: 40)) # as ruby time range OR
+r.during([9, 0, 0], [16, 40, 0])                              # as hour, min, sec tuple pairs for start, end
+
+# every 20 minutes during multiple time-of-day ranges
+Montrose.every(20.minutes).during("9am-12pm", "1pm-5pm")
+
 # Minutely
 Montrose.minutely
 Montrose.r(every: :minute)
@@ -366,6 +375,40 @@ r.events.take(10).each { |date| puts date.to_s }
 r.events.lazy.select { |time| time > 1.month.from_now }.take(3).each { |date| puts date.to_s }
 ```
 
+### Combining recurrences
+
+It may be necessary to combine several recurrence rules into a single
+enumeration of events. For this purpose, there is `Montrose::Schedule`. To create a schedule of multiple recurrences:
+
+```ruby
+recurrence_1 = Montrose.monthly(day: { friday: [1] })
+recurrence_2 = Montrose.weekly(on: :tuesday)
+
+schedule = Montrose::Schedule.build do |s|
+  s << recurrence_1
+  s << recurrence_2
+end
+
+# add after building
+s << Montrose.yearly
+```
+The `Schedule#<<` method also accepts valid recurrence options as hashes:
+```ruby
+schedule = Montrose::Schedule.build do |s|
+  s << { day: { friday: [1] } }
+  s << { on: :tuesday }
+end
+```
+A schedule acts like a collection of recurrence rules that also behaves as a single
+stream of events:
+
+```ruby
+schedule.events # => #<Enumerator: ...>
+schedule.each do |event|
+  puts event
+end
+```
+
 ### Ruby on Rails
 
 Instances of `Montrose::Recurrence` support the ActiveRecord serialization API so recurrence objects can be marshalled to and from a single database column:
@@ -374,6 +417,13 @@ Instances of `Montrose::Recurrence` support the ActiveRecord serialization API s
 class RecurringEvent < ApplicationRecord
   serialize :recurrence, Montrose::Recurrence
 
+end
+```
+`Montrose::Schedule` can also be serialized:
+```ruby
+class RecurringEvent < ApplicationRecord
+  serialize :recurrence, Montrose::Schedule
+
 end
 ```
 
@@ -396,6 +446,13 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+To run tests against multiple versions of activesupport, use the Appraisals:
+
+```sh
+bin/appraisal install
+bin/appraisal rake test
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/rossta/montrose. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

data/Rakefile

@@ -3,7 +3,7 @@
 require "bundler/setup"
 require "bundler/gem_tasks"
 require "rake/testtask"
-require "rubocop/rake_task"
+require "standard/rake"
 require "yard"
 
 Rake::TestTask.new(:spec) do |t|
@@ -15,9 +15,7 @@ end
 
 task test: :spec
 
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
+task default: %i[spec standard]
 
 namespace :doc do
   desc "Generate docs and publish to gh-pages"

data/bin/setup

@@ -3,5 +3,6 @@ set -euo pipefail
 IFS=$'\n\t'
 
 bundle install
+bundle update
 
 # Do any other automated setup that you need to do here

data/bin/standardrb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'standardrb' 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)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("standard", "standardrb")

data/gemfiles/activesupport_5.2.gemfile

@@ -7,6 +7,10 @@ gem "activesupport", "~> 5.2.0"
 group :development do
   gem "coveralls"
   gem "yard"
+  gem "guard"
+  gem "guard-minitest"
+  gem "guard-rubocop"
+  gem "pry-byebug"
 end
 
 gemspec path: "../"

data/gemfiles/activesupport_6.0.gemfile

@@ -2,11 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "activesupport", "~> 6.0.0.beta2"
+gem "activesupport", "~> 6.0.0"
 
 group :development do
   gem "coveralls"
   gem "yard"
+  gem "guard"
+  gem "guard-minitest"
+  gem "guard-rubocop"
+  gem "pry-byebug"
 end
 
 gemspec path: "../"

data/gemfiles/{activesupport_4.2.gemfile → activesupport_6.1.gemfile}

@@ -2,11 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "activesupport", "~> 4.2.0"
+gem "activesupport", "~> 6.1.0"
 
 group :development do
   gem "coveralls"
   gem "yard"
+  gem "guard"
+  gem "guard-minitest"
+  gem "guard-rubocop"
+  gem "pry-byebug"
 end
 
 gemspec path: "../"

data/lib/montrose.rb

@@ -2,10 +2,13 @@
 
 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 "active_support/core_ext/integer"
+require "active_support/core_ext/numeric"
+require "active_support/core_ext/string"
+require "active_support/core_ext/time"
 
 require "montrose/utils"
 require "montrose/rule"
@@ -35,6 +38,23 @@ module Montrose
     def recurrence(options = {})
       branch(options)
     end
-    alias r recurrence
+    alias_method :r, :recurrence
+
+    # Create a new recurrence from given options
+    # An alias to {Montrose::Recurrence.new}
+    attr_reader :enable_deprecated_between_masking
+
+    def enable_deprecated_between_masking=(value)
+      warn "[DEPRECATION] Montrose.enable_deprecated_between_masking is deprecated and will be removed in a future version."
+      @enable_deprecated_between_masking = value
+    end
+
+    def enable_deprecated_between_masking?
+      result = !!enable_deprecated_between_masking
+      if result
+        warn "[DEPRECATION] Legacy Montrose.between masking behavior is deprecated. Please use Montrose.covering instead to retain this behavior."
+      end
+      result
+    end
   end
 end

data/lib/montrose/chainable.rb

@@ -139,7 +139,7 @@ module Montrose
     def starts(starts_at)
       merge(starts: starts_at)
     end
-    alias starting starts
+    alias_method :starting, :starts
 
     # Create a recurrence ending at given timestamp.
     #
@@ -153,9 +153,12 @@ module Montrose
     def until(ends_at)
       merge(until: ends_at)
     end
-    alias ending until
+    alias_method :ending, :until
 
-    # Create a recurrence occurring during date range.
+    # Create a recurrence occurring between the start and end
+    # of a given date range; :between is shorthand for separate
+    # :starts and :until options. When used with explicit :start
+    # and/or :until options, those will take precedence.
     #
     # @param [Range<Date>] date_range
     #
@@ -168,6 +171,37 @@ module Montrose
       merge(between: date_range)
     end
 
+    # Create a recurrence which will only emit values within the
+    # date range, also called "masking."
+    #
+    # @param [Range<Date>] date_range
+    #
+    # @example
+    #   Montrose.weekly.covering(Date.tomorrow..Date.new(2016, 3, 15))
+    #
+    # @return [Montrose::Recurrence]
+    #
+    def covering(date_range)
+      merge(covering: date_range)
+    end
+
+    # Create a recurrence occurring within a time-of-day range or ranges.
+    # Given time ranges will parse as times-of-day and ignore given dates.
+    #
+    # @param [Range<Time>,String,Array<Array>] time-of-day range(s)
+    #
+    # @example
+    #   Montrose.every(20.minutes).during("9am-5pm")
+    #   Montrose.every(20.minutes).during(time.change(hour: 9)..time.change(hour: 5))
+    #   Montrose.every(20.minutes).during([9, 0, 0], [17, 0, 0])
+    #   Montrose.every(20.minutes).during("9am-12pm", "1pm-5pm")
+    #
+    # @return [Montrose::Recurrence]
+    #
+    def during(time_of_day, *extras)
+      merge(during: time_of_day.array_concat(extras))
+    end
+
     # Create a recurrence through :on option
     #
     # @param day [Hash,Symbol] weekday or day of month as hash, e.g. { friday: 13 }
@@ -224,7 +258,7 @@ module Montrose
     def day_of_month(days, *extras)
       merge(mday: days.array_concat(extras))
     end
-    alias mday day_of_month
+    alias_method :mday, :day_of_month
 
     # Create a recurrence for given days of week
     #
@@ -240,7 +274,7 @@ module Montrose
     def day_of_week(weekdays, *extras)
       merge(day: weekdays.array_concat(extras))
     end
-    alias day day_of_week
+    alias_method :day, :day_of_week
 
     # Create a recurrence for given days of year
     #
@@ -256,7 +290,7 @@ module Montrose
     def day_of_year(days, *extras)
       merge(yday: days.array_concat(extras))
     end
-    alias yday day_of_year
+    alias_method :yday, :day_of_year
 
     # Create a recurrence for given hours of day
     #
@@ -272,7 +306,7 @@ module Montrose
     def hour_of_day(hours, *extras)
       merge(hour: hours.array_concat(extras))
     end
-    alias hour hour_of_day
+    alias_method :hour, :hour_of_day
 
     # Create a recurrence for given months of year
     #
@@ -288,7 +322,7 @@ module Montrose
     def month_of_year(months, *extras)
       merge(month: months.array_concat(extras))
     end
-    alias month month_of_year
+    alias_method :month, :month_of_year
 
     # Create a recurrence for given weeks of year
     #
@@ -318,7 +352,7 @@ module Montrose
     def total(total)
       merge(total: total)
     end
-    alias repeat total
+    alias_method :repeat, :total
 
     # Create a new recurrence combining options of self
     # and other. The value of entries with duplicate