rrule 0.4.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '007499934626da51ca670d58c30fab5efe4f88c782979eaff317f440e8f237fc'
-  data.tar.gz: a99135de58a44d1c71a2af4fee8721475f09c44cfd40ab21410c7cb755835784
+  metadata.gz: ad88610152ac491684d813f22ced6298dd37075b43c0832bf5ddea6b722e5906
+  data.tar.gz: 8c18b1a8f5244cefe797e77a73fd6717cd0e4e754b7858045e2480c24a0d4a12
 SHA512:
-  metadata.gz: b2f9bc5d989d05bebf09aafac0ded5fd2148901481b15fce0b4ea60680cb26fefe4f6bfebe286473a02f25543e8be499b842020988da87226d6da3eaf847070f
-  data.tar.gz: 5b450cdde1f0b8c7a6c05a0520ecfdcb43e93647e2155a0fc2dc1578f7fdf4457c42a638fe31fadfd8bd31a1fc006169dab6847a03fa2552c530283c91f78870
+  metadata.gz: 97d4c45d2cc25a7624f4b237b8b309d878f27cff652e2f45b50141d57b2273da3b715f1f967e6885e2b669904e8e748bd2f09c34c9aa91d6b03ca759c567f387
+  data.tar.gz: fa4a974eb0acd3244232acafaf97a3220e2539673da54efcc116f6042272919805828a9b7aff3668675f25d22f295e21ac172764a085f4e1ea0749c35770c489

data/.github/workflows/test.yml

@@ -0,0 +1,41 @@
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby:
+          - 3.0.0
+          - 3.1.0
+          - 3.2.0
+          - 3.3.0
+        gemfile:
+          - gemfiles/activesupport_6_1.gemfile
+          - gemfiles/activesupport_7_0.gemfile
+          - gemfiles/activesupport_7_1.gemfile
+
+    name: Ruby ${{ matrix.ruby }} using Gemfile ${{ matrix.gemfile }}
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: 'Update gem command'
+        run: yes | gem update --system --force
+      - name: 'Update Bundler'
+        run: gem install bundler
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+      - run: bundle install
+      - run: bundle exec rake

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: disable
   Exclude:
     - 'gemfiles/**/*'
     - Appraisals

data/CHANGELOG.md

@@ -1,6 +1,31 @@
 Change Log
 ==========
 
+Version 0.6.0 *(2024-03-07)*
+----------------------------
+## What's Changed
+* Test support for Ruby 3.1 by @rmitchell-sq in https://github.com/square/ruby-rrule/pull/43
+* Rule#between didn't work when `limit` was provided by @edruder in https://github.com/square/ruby-rrule/pull/44
+* Added Rule#from by @edruder in https://github.com/square/ruby-rrule/pull/45
+* Added Rule#to_s by @Andy9822 in https://github.com/square/ruby-rrule/pull/50
+* Implement `RRule::Rule#humanize` by @craigmcnamara in https://github.com/square/ruby-rrule/pull/49
+* Update missing documentation for version 0.5.0 by @rmitchell-sq in https://github.com/square/ruby-rrule/pull/53
+* Pivot from Travis CI to GitHub Actions by @leoarnold in https://github.com/square/ruby-rrule/pull/48
+* Updating supported Rubies to add new versions and remove EOL ones by @rmitchell-sq in https://github.com/square/ruby-rrule/pull/56
+* Implement `RRule::Rule#is_finite?` by @bahriddin in https://github.com/square/ruby-rrule/pull/55
+
+## New Contributors
+* @edruder made their first contribution in https://github.com/square/ruby-rrule/pull/44
+* @Andy9822 made their first contribution in https://github.com/square/ruby-rrule/pull/50
+* @craigmcnamara made their first contribution in https://github.com/square/ruby-rrule/pull/49
+* @bahriddin made their first contribution in https://github.com/square/ruby-rrule/pull/55
+
+**Full Changelog**: https://github.com/square/ruby-rrule/compare/v0.4.4...v0.5.1
+
+Version 0.5.0 *(2022-03-14)*
+----------------------------
+Added `#from` method. Added test support for Ruby 3.1. Fixed bug in `#between` method when `limit` was provided.
+
 Version 0.4.4 *(2022-03-01)*
 ----------------------------
 Remove constraint on ActiveSupport version

data/Gemfile

@@ -2,13 +2,13 @@
 
 source 'https://rubygems.org'
 
-gem 'pry', '~> 0.12.2'
+gem 'pry', '~> 0.14.1'
 gem 'rake'
 gem 'rspec', '~> 3.8'
 gem 'rubocop', '0.63.1'
 
 platform :mri do
-  gem 'pry-byebug'
+  gem 'pry-byebug', '~> 3.10.1'
 end
 
 gemspec

data/README.md

@@ -30,6 +30,16 @@ rrule.between(Time.new(2016, 6, 23), Time.new(2016, 6, 24))
 => [2016-06-23 16:45:32 -0700]
 ```
 
+You can generate all instances starting from a specified date with the `#from` method:
+
+```ruby
+rrule = RRule::Rule.new('FREQ=DAILY;COUNT=3', dtstart: Time.new(2016, 1, 1))
+rrule.all
+=> [2016-01-01 16:45:32 -0700, 2016-01-02 16:45:32 -0700, 2016-01-03 16:45:32 -0700]
+rrule.from(Time.new(2016, 1, 2))
+=> [2016-01-02 16:45:32 -0700, 2016-01-03 16:45:32 -0700]
+```
+
 You can limit the number of instances that are returned with the `limit` option:
 
 ```ruby

data/gemfiles/{activesupport_5.gemfile → activesupport_6_1.gemfile}

@@ -2,11 +2,11 @@
 
 source "https://rubygems.org"
 
-gem "pry", "~> 0.12.2"
+gem "pry", "~> 0.14.1"
 gem "rake"
 gem "rspec", "~> 3.8"
 gem "rubocop", "0.63.1"
-gem "activesupport", "~> 5"
+gem "activesupport", "~> 6.1"
 
 platforms :mri do
   gem "pry-byebug"

data/gemfiles/{activesupport_6.gemfile → activesupport_7_0.gemfile}

@@ -2,11 +2,11 @@
 
 source "https://rubygems.org"
 
-gem "pry", "~> 0.12.2"
+gem "pry", "~> 0.14.1"
 gem "rake"
 gem "rspec", "~> 3.8"
 gem "rubocop", "0.63.1"
-gem "activesupport", "~> 6"
+gem "activesupport", "~> 7.0"
 
 platforms :mri do
   gem "pry-byebug"

data/gemfiles/{activesupport_7.gemfile → activesupport_7_1.gemfile}

@@ -2,11 +2,11 @@
 
 source "https://rubygems.org"
 
-gem "pry", "~> 0.12.2"
+gem "pry", "~> 0.14.1"
 gem "rake"
 gem "rspec", "~> 3.8"
 gem "rubocop", "0.63.1"
-gem "activesupport", "~> 7"
+gem "activesupport", "~> 7.1"
 
 platforms :mri do
   gem "pry-byebug"

data/lib/rrule/context.rb

@@ -17,7 +17,9 @@ module RRule
 
       if options[:bynweekday] && !options[:bynweekday].empty? && (month != last_month || year != last_year)
         possible_date_ranges = []
-        if options[:freq] == 'YEARLY'
+
+        case options[:freq]
+        when 'YEARLY'
           if options[:bymonth]
             options[:bymonth].each do |mon|
               possible_date_ranges.push(elapsed_days_in_year_by_month[(mon - 1)..mon])
@@ -25,7 +27,7 @@ module RRule
           else
             possible_date_ranges = [[0, year_length_in_days]]
           end
-        elsif options[:freq] == 'MONTHLY'
+        when 'MONTHLY'
           possible_date_ranges = [elapsed_days_in_year_by_month[(month - 1)..month]]
         end
 

data/lib/rrule/humanizer.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module RRule
+  # Based off https://github.com/jakubroztocil/rrule/blob/master/src/nlp/totext.ts
+  #
+  class Humanizer
+    attr_reader :rrule, :options
+
+    OPTION_ATTRIBUTE_RE = /_option/.freeze
+
+    DAY_NAMES = %w[
+      Sunday
+      Monday
+      Tuesday
+      Wednesday
+      Thursday
+      Friday
+      Saturday
+    ].freeze
+
+    def initialize(rrule, options)
+      @rrule = rrule
+      @options = options
+
+      # Define instance method for each of the options.
+      options.each { |name, value| define_singleton_method("#{name}_option") { value } }
+    end
+
+    def to_s
+      @buffer = 'every'
+
+      send freq_option.downcase
+
+      raise 'Implement Until' if until_option
+      if count_option
+        add 'for'
+        add count_option
+        add plural?(count_option) ? 'times' : 'time'
+      end
+
+      @buffer
+    end
+
+    # Return nil if we're trying to access an option that isn't present.
+    def method_missing(method_name, *args)
+      if method_name.to_s.match?(OPTION_ATTRIBUTE_RE)
+        nil
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name)
+      super || method_name.to_s.match?(OPTION_ATTRIBUTE_RE)
+    end
+
+    protected
+
+      def list(arr, formatter, final_delimiter = nil, delimiter: ',')
+        *rest, middle, tail = arr.map(&formatter)
+
+        if final_delimiter
+          [*rest, [middle, tail].compact.join(" #{final_delimiter} ")].join("#{delimiter} ")
+        else
+          [*rest, middle, tail].compact.join("#{delimiter} ")
+        end
+      end
+
+      def add(string)
+        @buffer += " #{string}"
+      end
+
+      def plural?(num)
+        num.to_i % 100 != 1
+      end
+
+      def daily
+        add interval_option if interval_option != 1
+
+        if byweekday_option && weekdays?
+          add plural?(interval_option) ? 'weekdays' : 'weekday'
+        else
+          add plural?(interval_option) ? 'days' : 'day'
+        end
+
+        if bymonth_option
+          add 'in'
+          _bymonth
+        end
+
+        if bymonthday_option
+          _bymonthday
+        elsif byweekday_option
+          _byweekday
+        elsif byhour_option
+          _byhour
+        end
+      end
+
+      def weekly
+        if interval_option != 1
+          add interval_option
+          add plural?(interval_option) ? 'weeks' : 'week'
+        end
+
+        if byweekday_option && weekdays?
+          if interval_option == 1
+            add plural?(interval_option) ? 'weekdays' : 'weekday'
+          else
+            add 'on'
+            add 'weekdays'
+          end
+        elsif byweekday_option && every_day?
+          add plural?(interval_option) ? 'days' : 'day'
+        else
+          add 'week' if interval_option == 1
+
+          if bymonth_option
+            add 'in'
+            _bymonth
+          end
+
+          if bymonthday_option
+            _bymonthday
+          elsif byweekday_option
+            _byweekday
+          end
+        end
+      end
+
+      def monthly
+        if bymonth_option
+          if interval_option != 1
+            add interval_option
+            add 'months'
+            add 'in' if plural?(interval_option)
+          end
+
+          _bymonth
+        else
+          add interval_option if interval_option != 1
+
+          add plural?(interval_option) ? 'months' : 'month'
+        end
+
+        if bymonthday_option
+          _bymonthday
+        elsif byweekday_option && weekdays?
+          add 'on'
+          add 'weekdays'
+        elsif byweekday_option || bynweekday_option
+          _byweekday
+        end
+      end
+
+      def weekdaytext(day)
+        [day.ordinal && nth(day.ordinal), DAY_NAMES[day.index]].compact.join(' ')
+      end
+
+      def all_weeks?
+        bynweekday_option.all? { |option| option.ordinal.nil? }
+      end
+
+      def every_day?
+        byweekday_option.sort_by(&:index).map { |day| WEEKDAYS[day.index]} == RRule::WEEKDAYS
+      end
+
+      def weekdays?
+        return false if byweekday_option.none?
+
+        byweekday_option.sort_by(&:index).map { |day| WEEKDAYS[day.index]} == RRule::WEEKDAYS - %w[SA SU]
+      end
+
+      def _bymonth
+        add list(this.options.bymonth, method(:monthtext), 'and')
+      end
+
+      def _byweekday
+        if byweekday_option.any?
+          add 'on'
+          add list(byweekday_option, method(:weekdaytext))
+        end
+
+        return unless bynweekday_option.any?
+
+        add 'and' if all_weeks?
+        add 'on the'
+        add list(bynweekday_option, method(:weekdaytext), 'and')
+      end
+
+      def _byhour
+        add 'at'
+        add list byhour_option, :to_s, 'and'
+      end
+
+      def nth(ordinal)
+        return 'last' if ordinal == -1
+
+        nth =
+          case npos = ordinal.abs
+          when 1, 21, 31
+            "#{npos}st"
+          when 2, 22
+            "#{npos}nd"
+          when 3, 23
+            "#{npos}rd"
+          else
+            "#{npos}th"
+          end
+
+        ordinal < 0 ? "#{nth} last" : nth
+      end
+  end
+end

data/lib/rrule/rule.rb

@@ -8,6 +8,7 @@ module RRule
 
     def initialize(rrule, dtstart: Time.now, tzid: 'UTC', exdate: [], max_year: nil)
       @tz = tzid
+      @rrule = rrule
       @dtstart = dtstart.is_a?(Date) ? dtstart : floor_to_seconds_in_timezone(dtstart)
       @exdate = exdate
       @options = parse_options(rrule)
@@ -16,6 +17,10 @@ module RRule
       @max_date = DateTime.new(@max_year)
     end
 
+    def to_s
+      @rrule
+    end
+
     def all(limit: nil)
       all_until(limit: limit)
     end
@@ -26,6 +31,11 @@ module RRule
       all_until(start_date: floored_start_date, end_date: floored_end_date, limit: limit).reject { |instance| instance < floored_start_date }
     end
 
+    def from(start_date, limit:)
+      floored_start_date = floor_to_seconds_in_timezone(start_date)
+      all_until(start_date: floored_start_date, limit: limit).reject { |instance| instance < floored_start_date }
+    end
+
     def each(floor_date: nil)
       # If we have a COUNT or INTERVAL option, we have to start at dtstart, because those are relative to dtstart
       floor_date = dtstart if count_or_interval_present? || floor_date.nil? || dtstart > floor_date
@@ -73,6 +83,15 @@ module RRule
       enumerator.next
     end
 
+    def humanize
+      Humanizer.new(self, options).to_s
+    end
+
+    def is_finite?
+      keys = %i[count until] & options.keys
+      !keys.empty?
+    end
+
     private
 
     attr_reader :options, :max_year, :max_date, :frequency_type
@@ -89,7 +108,14 @@ module RRule
     end
 
     def all_until(start_date: nil, end_date: max_date, limit: nil)
-      limit ? take(limit) : each(floor_date: start_date).take_while { |date| date <= end_date }
+      count = 0
+      each(floor_date: start_date).take_while do |date|
+        if limit
+          date <= end_date && (count += 1) <= limit
+        else
+          date <= end_date
+        end
+      end
     end
 
     def parse_options(rule)

data/lib/rrule/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RRule
-  VERSION = '0.4.4'
+  VERSION = '0.6.0'
 end

data/lib/rrule/weekday.rb

@@ -12,7 +12,7 @@ module RRule
     def self.parse(weekday)
       match = /([+-]?\d+)?([A-Z]{2})/.match(weekday)
       index = RRule::WEEKDAYS.index(match[2])
-      ordinal = match[1] ? match[1].to_i : nil
+      ordinal = match[1]&.to_i
       new(index, ordinal)
     end
   end

data/lib/rrule.rb

@@ -6,6 +6,7 @@ module RRule
   autoload :Rule, 'rrule/rule'
   autoload :Context, 'rrule/context'
   autoload :Weekday, 'rrule/weekday'
+  autoload :Humanizer, 'rrule/humanizer'
 
   autoload :Frequency, 'rrule/frequencies/frequency'
   autoload :Daily, 'rrule/frequencies/daily'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rrule
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Ryan Mitchell
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,9 +44,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -54,12 +54,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/activesupport_2.3_LTS.gemfile
-- gemfiles/activesupport_3.gemfile
-- gemfiles/activesupport_4.gemfile
-- gemfiles/activesupport_5.gemfile
-- gemfiles/activesupport_6.gemfile
-- gemfiles/activesupport_7.gemfile
+- gemfiles/activesupport_6_1.gemfile
+- gemfiles/activesupport_7_0.gemfile
+- gemfiles/activesupport_7_1.gemfile
 - lib/rrule.rb
 - lib/rrule/context.rb
 - lib/rrule/filters/by_month.rb
@@ -76,6 +73,7 @@ files:
 - lib/rrule/generators/all_occurrences.rb
 - lib/rrule/generators/by_set_position.rb
 - lib/rrule/generators/generator.rb
+- lib/rrule/humanizer.rb
 - lib/rrule/rule.rb
 - lib/rrule/version.rb
 - lib/rrule/weekday.rb
@@ -104,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: RRule expansion

data/.travis.yml

@@ -1,29 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 2.6.5
-  - 2.7.0
-  - 3.0.0
-
-gemfile:
-  - gemfiles/activesupport_2.3_LTS.gemfile
-  - gemfiles/activesupport_3.gemfile
-  - gemfiles/activesupport_4.gemfile
-  - gemfiles/activesupport_5.gemfile
-  - gemfiles/activesupport_6.gemfile
-  - gemfiles/activesupport_7.gemfile
-
-jobs:
-  exclude:
-  - rvm: 2.7.0
-    gemfile: gemfiles/activesupport_3.gemfile
-  - rvm: 2.7.0
-    gemfile: gemfiles/activesupport_4.gemfile
-  - rvm: 3.0.0
-    gemfile: gemfiles/activesupport_3.gemfile
-  - rvm: 3.0.0
-    gemfile: gemfiles/activesupport_4.gemfile
-
-before_install:
-  - yes | gem update --system --force
-  - gem install bundler

data/gemfiles/activesupport_2.3_LTS.gemfile

@@ -1,16 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pry", "~> 0.12.2"
-gem "rake"
-gem "rspec", "~> 3.8"
-gem "rubocop", "0.63.1"
-gem "rexml"
-gem "activesupport", ">= 2", git: "https://github.com/makandra/rails.git", branch: "2-3-lts"
-
-platforms :mri do
-  gem "pry-byebug"
-end
-
-gemspec path: "../"

data/gemfiles/activesupport_3.gemfile

@@ -1,16 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pry", "~> 0.12.2"
-gem "rake"
-gem "rspec", "~> 3.8"
-gem "rubocop", "0.63.1"
-gem "activesupport", "~> 3"
-gem "tzinfo", "~> 1.2"
-
-platforms :mri do
-  gem "pry-byebug"
-end
-
-gemspec path: "../"

data/gemfiles/activesupport_4.gemfile

@@ -1,15 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pry", "~> 0.12.2"
-gem "rake"
-gem "rspec", "~> 3.8"
-gem "rubocop", "0.63.1"
-gem "activesupport", "~> 4"
-
-platforms :mri do
-  gem "pry-byebug"
-end
-
-gemspec path: "../"