montrose 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01fee4660a2a1e95d60de269d491675460289ae52f6c582aee5ea6be39a883cc
-  data.tar.gz: ece2fbd3f36909337abd6712025053385f6ceedf95695a7852b6e05b6c804906
+  metadata.gz: c4b7914b70270912f8acf6757a8f130112d9137c50c34b933714f0edf97ac3c1
+  data.tar.gz: d70713d758bf62b45a7a74196f3d2c5bcc0a4bcf48b899164d7b5d4e2afe6b4a
 SHA512:
-  metadata.gz: bb823d11097cd9228ec7631809bece2b1028adf728c7a4919284dfc7a6fcafa3d65c9d1ed446f60f1a16335143830ae36b4725c6d980b5cb6a152b80961f4e0b
-  data.tar.gz: deb0db72983faf47192095aef16e7512f928c4ff4f1f6fd20f913394850b354fc2e004dcda70455d08abe4471a2647d8b3a31832814f737cf68a09d6d9ffbaa8
+  metadata.gz: 5ea9a0877d09b1d360c3de7dc9b68a4fd9b6f64047728991d0398333777c18afa06f12fba1b2e178f53bd412f054314b125a174099a896c554cc53a337672fb5
+  data.tar.gz: f0b7431307846f0fa969352cfb98101ae2542ad37dd443e8324dd1480b01edfa81f8c06f92b6dc96f4278410f7cb221b7a1c1a487241a0faf8f5ee07fd763db3

data/.circleci/config.yml

@@ -0,0 +1,66 @@
+version: 2.1
+orbs:
+  ruby: circleci/ruby@1.3.0
+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: 'cimg/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.6', '2.7', '3.0', '3.1']
+              gemfile:
+                [
+                  'gemfiles/activesupport_5.2.gemfile',
+                  'gemfiles/activesupport_6.0.gemfile',
+                  'gemfiles/activesupport_6.1.gemfile',
+                  'gemfiles/activesupport_7.0.gemfile',
+                ]
+            exclude:
+              - ruby_version: '2.6'
+                gemfile: gemfiles/activesupport_7.0.gemfile

data/Appraisals

@@ -1,21 +1,17 @@
 # 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-7.0" do
+  gem "activesupport", "~> 7.0"
 end
 
-appraise "activesupport-5.0" do
-  gem "activesupport", "~> 5.0.0"
+appraise "activesupport-6.1" do
+  gem "activesupport", "~> 6.1"
 end
 
-appraise "activesupport-4.2" do
-  gem "activesupport", "~> 4.2.0"
+appraise "activesupport-6.0" do
+  gem "activesupport", "~> 6.0"
 end
 
-appraise "activesupport-4.1" do
-  gem "activesupport", "~> 4.1.0"
+appraise "activesupport-5.2" do
+  gem "activesupport", "~> 5.2"
 end

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+### 0.12.0 - (2021-02-02)
+
+* enhancements
+  * Adds `Montrose.covering` to disambiguate `Montrose.between` behavior
+  `#covering` provides recurrence masking behavior, i.e., only recurrences
+  within the given range will be emitted
+  * Added support for ActiveSupport 6 and Ruby 2.7
+  * Adds `Montrose#infinite?` and ensures `Montrose.finite?` returns a boolean
+
+* bug fixes
+  * Fixes `Recurrence#include?` behavior for infinite recurrences with
+  intervals > 1
+
+* breaking changes
+  * `Montrose.between` no longer provides masking behavior, which is now
+  provided by `Montrose.covering`. A global option can be used
+  `Montrose.enable_deprecated_between_masking = true` to retain the legacy
+  behavior for `Montrose.between`. This option will be removed in v1.0.
+  * Dropped official support for EOL'd rubies and ActiveSupport < 5.2
+
+* miscellaneous
+  * switched from Travis to CircleCi for builds
+  * switched default branch to `main`
+#
 ### 0.11.0 - (2019-08-16)
 
 * enhancements

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

@@ -4,10 +4,10 @@
 [![Code Climate](https://codeclimate.com/github/rossta/montrose/badges/gpa.svg)](https://codeclimate.com/github/rossta/montrose)
 [![Coverage Status](https://coveralls.io/repos/rossta/montrose/badge.svg?branch=master&service=github)](https://coveralls.io/github/rossta/montrose?branch=master)
 
-Montrose is an easy-to-use library for defining recurring events in Ruby. It uses a simple chaining system for building recurrences, inspired heavily by the design principles of [HTTP.rb](https://github.com/httprb/http) and rule definitions available in [Recurrence](https://github.com/fnando/recurrence).
+Montrose is an easy-to-use library for defining recurring events in Ruby. It uses a simple chaining system for building enumerable recurrences, inspired heavily by the design principles of [HTTP.rb](https://github.com/httprb/http) and rule definitions available in [Recurrence](https://github.com/fnando/recurrence).
 
-* [Introductory blog post](http://bit.ly/1PA68Zb)
-* [NYC.rb
+- [Introductory blog post](http://bit.ly/1PA68Zb)
+- [NYC.rb
   presentation](https://speakerdeck.com/rossta/recurring-events-with-montrose)
 
 ## Installation
@@ -32,17 +32,17 @@ Dealing with recurring events is hard. `Montrose` provides a simple interface fo
 
 More specifically, this project intends to:
 
-* model recurring events in Ruby
-* embrace Ruby idioms
-* support recent Rubies
-* 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
+- model recurring events in Ruby
+- embrace Ruby idioms
+- support recent Rubies
+- 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
 
 What `Montrose` doesn't do:
 
-* support all calendaring use cases under the sun
-* schedule recurring jobs for your Rails app. Use one of these instead: [cron](https://en.wikipedia.org/wiki/Cron), [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler), [sidekiq-cron](https://github.com/ondrejbartas/sidekiq-cron), [sidetiq](https://github.com/tobiassvn/sidetiq), [whenever](https://github.com/javan/whenever)
+- support all calendaring use cases under the sun
+- schedule recurring jobs for your Rails app. Use one of these instead: [cron](https://en.wikipedia.org/wiki/Cron), [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler), [sidekiq-cron](https://github.com/ondrejbartas/sidekiq-cron), [sidetiq](https://github.com/tobiassvn/sidetiq), [whenever](https://github.com/javan/whenever)
 
 ## Concepts
 
@@ -392,13 +392,16 @@ 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:
 
@@ -419,7 +422,9 @@ class RecurringEvent < ApplicationRecord
 
 end
 ```
+
 `Montrose::Schedule` can also be serialized:
+
 ```ruby
 class RecurringEvent < ApplicationRecord
   serialize :recurrence, Montrose::Schedule
@@ -435,10 +440,10 @@ Montrose is named after the beautifully diverse and artistic [neighborhood in Ho
 
 Check out following related projects, all of which have provided inspiration for `Montrose`.
 
-* [ice_cube](https://github.com/seejohnrun/ice_cube)
-* [recurrence](https://github.com/fnando/recurrence)
-* [runt](https://github.com/mlipper/runt)
-* [http.rb](https://github.com/httprb/http) - not a recurrence project, but inspirational to design, implementation, and interface of `Montrose`
+- [ice_cube](https://github.com/seejohnrun/ice_cube)
+- [recurrence](https://github.com/fnando/recurrence)
+- [runt](https://github.com/mlipper/runt)
+- [http.rb](https://github.com/httprb/http) - not a recurrence project, but inspirational to design, implementation, and interface of `Montrose`
 
 ## Development
 
@@ -446,6 +451,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

@@ -2,11 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "activesupport", "~> 5.2.0"
+gem "activesupport", "~> 5.2"
 
 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"
 
 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"
 
 group :development do
   gem "coveralls"
   gem "yard"
+  gem "guard"
+  gem "guard-minitest"
+  gem "guard-rubocop"
+  gem "pry-byebug"
 end
 
 gemspec path: "../"

data/gemfiles/{activesupport_5.0.gemfile → activesupport_7.0.gemfile}

@@ -2,11 +2,15 @@
 
 source "https://rubygems.org"
 
-gem "activesupport", "~> 5.0.0"
+gem "activesupport", "~> 7.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/chainable.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "montrose/options"
 require "montrose/refinements/array_concat"
 
 module Montrose
@@ -139,7 +138,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 +152,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 +170,20 @@ 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.
     #
@@ -241,7 +257,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
     #
@@ -257,7 +273,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
     #
@@ -273,7 +289,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
     #
@@ -289,7 +305,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
     #
@@ -305,7 +321,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
     #
@@ -335,7 +351,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

data/lib/montrose/clock.rb

@@ -26,7 +26,7 @@ module Montrose
       if @at
         times = @at.map { |hour, min, sec = 0| @time.change(hour: hour, min: min, sec: sec) }
 
-        min_next = times.select { |t| t > @time }.min and return min_next
+        (min_next = times.select { |t| t > @time }.min) && (return min_next)
 
         advance_step(times.min || @time)
       else
@@ -41,7 +41,7 @@ module Montrose
     end
 
     def step
-      @step ||= smallest_step or fail ConfigurationError, "No step for #{@options.inspect}"
+      (@step ||= smallest_step) || fail(ConfigurationError, "No step for #{@options.inspect}")
     end
 
     def smallest_step
@@ -76,9 +76,9 @@ module Montrose
       is_frequency = @every == unit
       if ([unit] + alternates).any? { |u| @options.key?(u) } && !is_frequency
         # smallest unit, increment by 1
-        { step_key(unit) => 1 }
+        {step_key(unit) => 1}
       elsif is_frequency
-        { step_key(unit) => @interval }
+        {step_key(unit) => @interval}
       end
     end
 

data/lib/montrose/day.rb

@@ -0,0 +1,83 @@
+module Montrose
+  class Day
+    extend Montrose::Utils
+
+    NAMES = ::Date::DAYNAMES
+    TWO_LETTER_ABBREVIATIONS = %w[SU MO TU WE TH FR SA].freeze
+    THREE_LETTER_ABBREVIATIONS = %w[SUN MON TUE WED THU FRI SAT]
+    NUMBERS = NAMES.map.with_index { |_n, i| i.to_s }
+
+    ICAL_MATCH = /(?<ordinal>[+-]?\d+)?(?<day>[A-Z]{2})/ # e.g. 1FR
+
+    class << self
+      def parse(arg)
+        case arg
+        when Hash
+          parse_entries(arg.entries)
+        when String
+          parse(arg.split(","))
+        else
+          parse_entries(map_arg(arg) { |value| parse_value(value) })
+        end
+      end
+
+      def parse_entries(entries)
+        hash = Hash.new { |h, k| h[k] = [] }
+        result = entries.each_with_object(hash) { |(k, v), hash|
+          index = number!(k)
+          hash[index] = hash[index] + [*v]
+        }
+        result.values.all?(&:empty?) ? result.keys : result
+      end
+
+      def parse_value(value)
+        parse_ical(value) || [number!(value), nil]
+      end
+
+      def parse_ical(value)
+        (match = ICAL_MATCH.match(value.to_s)) || (return nil)
+        index = number!(match[:day])
+        ordinal = match[:ordinal]&.to_i
+        [index, ordinal]
+      end
+
+      def map_arg(arg, &block)
+        return nil unless arg.present?
+
+        Array(arg).map(&block)
+      end
+
+      def names
+        NAMES
+      end
+
+      def number(name)
+        case name
+        when 0..6
+          name
+        when Symbol, String
+          string = name.to_s.downcase
+          NAMES.index(string.titleize) ||
+            TWO_LETTER_ABBREVIATIONS.index(string.upcase) ||
+            THREE_LETTER_ABBREVIATIONS.index(string.upcase) ||
+            number(to_index(string))
+        when Array
+          number name.first
+        end
+      end
+
+      def number!(name)
+        number(name) || raise(ConfigurationError,
+          "Did not recognize day #{name}, must be one of #{(names + abbreviations + numbers).inspect}")
+      end
+
+      def numbers
+        NUMBERS
+      end
+
+      def abbreviations
+        TWO_LETTER_ABBREVIATIONS + THREE_LETTER_ABBREVIATIONS
+      end
+    end
+  end
+end