repeatable 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f6976240c976a027e08e04dc46dff2a7a420894f089ae7fa8c9fded126bafc6
-  data.tar.gz: 4e0e0e4d45d72b543549904a9a6f4b041430b9808075ccb64a81583366a4e414
+  metadata.gz: 4b0b02925c282f8d672cff3b6c4683939d5c734f0e682b1a4ea8e5feb931a765
+  data.tar.gz: 4446324d2c752fd1f33ef15545f58de7680ae48743d4f9343062c9151569abbc
 SHA512:
-  metadata.gz: 2698038cb582f612642c1b2f9c595e3830ff42556fb89eef56d4bbf5e3c34396d318175699ecb74a2c589aefe861cc5c7e17a6bde0b4950b6939421fedcb1260
-  data.tar.gz: 6a98285ed9058b186651055e5afecae2b2abcb64ca0dbc488b92b76ff6a20da02d4ab1d96f204bd864b210a5d183fdff34db31b82d4b06595e0b7c16f2dc3dcf
+  metadata.gz: daa01ada7a7d30730829bcf01ba053c4dd325923a574cf78af0b8a5531b543752392f239d96f3658f8a2045313e5df50cca92c75d91fc29aa5484e7e16224ccd
+  data.tar.gz: '080a67d068f2b4663d0ed106d78371f10c47b576b65a52fb5d43fc19b78b0fc1a3449cb288899b089c1b26b77a039cf29cb9fc5b0e828fdd1b7a9a3154aecebb'

data/.github/workflows/ci.yml

@@ -0,0 +1,77 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - 'ml/**'
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  RSpec:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - '2.5' # deprecated
+          - '2.6'
+          - '2.7'
+          - '3.0'
+          - '3.1'
+        include:
+          - ruby-version: '3.1'
+            coverage: 'true'
+    steps:
+      - uses: actions/checkout@v2
+      - name: Remove Gemfile.lock for older Ruby versions
+        if: ${{ fromJSON(matrix.ruby-version) < 3.1 }}
+        run: rm Gemfile.lock
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - uses: amancevice/setup-code-climate@v0
+        name: CodeClimate setup
+        if: ${{ matrix.coverage == 'true' }}
+        with:
+          cc_test_reporter_id: ${{ secrets.CC_TEST_REPORTER_ID }}
+      - name: CodeClimate before-build
+        run: cc-test-reporter before-build
+        if: ${{ matrix.coverage == 'true' }}
+        continue-on-error: true
+      - name: Run tests
+        env:
+          COVERAGE: ${{ matrix.coverage }}
+        run: bundle exec rake spec
+      - name: CodeClimate after-build
+        run: cc-test-reporter after-build
+        if: ${{ matrix.coverage == 'true' }}
+        continue-on-error: true
+  Standard:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+      - name: Run Standard
+        run: bundle exec rake standard
+  Sorbet:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+      - name: Check gem RBI files
+        run: bin/tapioca gems --verify
+      - name: Run Sorbet
+        run: bundle exec rake sorbet

data/CHANGELOG.md

@@ -2,7 +2,33 @@
 
 ### Unreleased
 
-[Commits](https://github.com/molawson/repeatable/compare/v1.0.0...main)
+[Commits](https://github.com/molawson/repeatable/compare/v1.2.0...main)
+
+### 1.2.0 (2024-04-25)
+
+Changes:
+
+* Support pattern matching for `Expression` and `Schedule`
+* Support more recent versions of sorbet
+
+[Commits](https://github.com/molawson/repeatable/compare/v1.1.0...v1.2.0)
+
+### 1.1.0 (2022-02-25)
+
+Changes:
+
+* Add [sorbet](https://sorbet.org) for type checking
+
+Bug Fixes:
+
+* Ensure `first_occurrence` is never part of `#to_h` output for `Expression::Biweekly`
+
+Chores:
+
+* Add support for Ruby 3.1
+* Deprecate support for Ruby 2.5
+
+[Commits](https://github.com/molawson/repeatable/compare/v1.0.0...v1.1.0)
 
 ### 1.0.0 (2021-03-25)
 

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+mo@molawson.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -3,9 +3,12 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in repeatable.gemspec
 gemspec
 
+gem "parlour"
 gem "pry", "~> 0.13"
 gem "rake", ">= 12.3.3"
+gem "sorbet-static-and-runtime"
 gem "standard", "~> 1.0"
+gem "tapioca"
 
 group :test do
   gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -1,26 +1,46 @@
 PATH
   remote: .
   specs:
-    repeatable (1.0.0)
+    repeatable (1.2.0)
+      sorbet-runtime
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     coderay (1.1.3)
+    commander (4.6.0)
+      highline (~> 2.0.0)
     diff-lcs (1.4.4)
-    docile (1.3.5)
+    docile (1.4.0)
+    erubi (1.12.0)
+    highline (2.0.3)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
     method_source (1.0.0)
-    parallel (1.20.1)
-    parser (3.0.0.0)
+    netrc (0.11.0)
+    parallel (1.24.0)
+    parlour (8.1.0)
+      commander (~> 4.5)
+      parser
+      rainbow (~> 3.0)
+      sorbet-runtime (>= 0.5)
+    parser (3.3.1.0)
       ast (~> 2.4.1)
+      racc
+    prism (0.28.0)
     pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rainbow (3.0.0)
+    racc (1.7.3)
+    rainbow (3.1.1)
     rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rbi (0.1.13)
+      prism (>= 0.18.0, < 1.0.0)
+      sorbet-runtime (>= 0.5.9204)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -34,43 +54,88 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.11.0)
+    rubocop (1.62.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
-    rubocop-performance (1.10.1)
-      rubocop (>= 0.90.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
-    standard (1.0.4)
-      rubocop (= 1.11.0)
-      rubocop-performance (= 1.10.1)
-    unicode-display_width (2.0.0)
+    simplecov_json_formatter (0.1.4)
+    sorbet (0.5.11370)
+      sorbet-static (= 0.5.11370)
+    sorbet-runtime (0.5.11370)
+    sorbet-static (0.5.11370-aarch64-linux)
+    sorbet-static (0.5.11370-universal-darwin)
+    sorbet-static (0.5.11370-x86_64-linux)
+    sorbet-static-and-runtime (0.5.11370)
+      sorbet (= 0.5.11370)
+      sorbet-runtime (= 0.5.11370)
+    spoom (1.3.2)
+      erubi (>= 1.10.0)
+      prism (>= 0.19.0)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      thor (>= 0.19.2)
+    standard (1.35.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.62.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
+    tapioca (0.13.3)
+      bundler (>= 2.2.25)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (>= 0.1.4, < 0.2)
+      sorbet-static-and-runtime (>= 0.5.11087)
+      spoom (>= 1.2.0)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.3.1)
+    unicode-display_width (2.5.0)
+    yard (0.9.36)
+    yard-sorbet (0.8.1)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
 
 PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-23
+  linux
   x86_64-darwin-19
   x86_64-linux
 
 DEPENDENCIES
+  parlour
   pry (~> 0.13)
   rake (>= 12.3.3)
   repeatable!
   rspec (~> 3.0)
   simplecov (~> 0.18)
+  sorbet-static-and-runtime
   standard (~> 1.0)
+  tapioca
 
 BUNDLED WITH
-   2.2.14
+   2.3.6

data/README.md

@@ -1,6 +1,6 @@
 # Repeatable
 
-[![Build Status](https://travis-ci.org/molawson/repeatable.svg?branch=main)](https://travis-ci.org/molawson/repeatable)
+[![CI](https://github.com/molawson/repeatable/actions/workflows/ci.yml/badge.svg)](https://github.com/molawson/repeatable/actions/workflows/ci.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/73707efd5eeffd364c0d/maintainability)](https://codeclimate.com/github/molawson/repeatable/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/73707efd5eeffd364c0d/test_coverage)](https://codeclimate.com/github/molawson/repeatable/test_coverage)
 
@@ -22,10 +22,6 @@ Or install it yourself as:
 
     $ gem install repeatable
 
-## Requirements
-
-Because this gem relies heavily on required keyword arguments, especially to make dumping and parsing of schedules simpler, this code will only work on **Ruby 2.2** and higher.
-
 ## Usage
 
 ### Building a Schedule
@@ -98,8 +94,8 @@ Repeatable::Expression::WeekdayInMonth.new(weekday: 1, count: 3)
 Repeatable::Expression::WeekdayInMonth.new(weekday: 4, count: -1)
 
 # Every other Monday, starting from December 1, 2015
-{ biweekly: { weekday: 1, start_date: '2015-12-01' } }
-Repeatable::Expression::Biweekly.new(weekday: 1, start_date: Date.new(2015, 12, 1))
+{ biweekly: { weekday: 1, start_after: '2015-12-01' } }
+Repeatable::Expression::Biweekly.new(weekday: 1, start_after: Date.new(2015, 12, 1))
 
 # The 13th of every month
 { day_in_month: { day: 13 } }
@@ -163,6 +159,21 @@ schedule.to_h
   #    can be used to recreate an identical Schedule object at a later time
 ```
 
+#### Pattern Matching
+
+Both `Repeatable::Schedule` and all `Repeatable::Expression` classes support Ruby 2.7+ [pattern matching][ruby-pattern-matching] which is particularly useful for parsing or presenting an existing schedule.
+
+```ruby
+case schedule
+in weekday: { weekday: }
+  "Weekly on #{Date::DAYNAMES[weekday]}"
+in day_in_month: { day: }
+  "Every month on the #{day.ordinalize}"
+in weekday_in_month: { weekday:, count: }
+  "Every month on the #{count.ordinalize} #{Date::DAYNAMES[weekday]}"
+end
+```
+
 #### Equivalence
 
 Both `Repeatable::Schedule` and all `Repeatable::Expression` classes have equivalence `#==` defined according to what's appropriate for each class, so regardless of the order of arguments passed to each, you can tell whether one object is equivalent to the other in terms of whether or not, when asked the same questions, you'd receive the same results from each.
@@ -186,16 +197,41 @@ Repeatable::Schedule.new(union) == Repeatable::Schedule.new(another_union)
 
 ```
 
+## Ruby version support
+
+Currently tested and supported: 
+- 2.6
+- 2.7
+- 3.0
+- 3.1
+
+Deprecated (currently tested but has reached EOL and will be unsupported in the next major version):
+- 2.5
+
+The supported versions will roughly track with versions that are currently maintained by the Ruby core team.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+You can run the tests with `bundle exec rake`.
 
 ## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/molawson/repeatable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
 1. Fork it ( https://github.com/molawson/repeatable/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Repeatable project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/molawson/repeatable/blob/main/CODE_OF_CONDUCT.md).
+
+[ruby-pattern-matching]: https://docs.ruby-lang.org/en/3.0/syntax/pattern_matching_rdoc.html

data/Rakefile

@@ -5,4 +5,8 @@ RSpec::Core::RakeTask.new(:spec)
 
 require "standard/rake"
 
-task default: %i[spec standard]
+task :sorbet do
+  sh %(bundle exec srb tc)
+end
+
+task default: %i[spec sorbet standard]

data/bin/tapioca

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'tapioca' 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("tapioca", "tapioca")

data/lib/repeatable/conversions.rb

@@ -1,16 +1,21 @@
+# typed: strict
+
 module Repeatable
   module Conversions
+    extend T::Sig
+
     module_function
 
+    sig { params(arg: Object).returns(::Date) }
     def Date(arg)
       case arg
       when Date, Time
         arg.to_date
       else
-        Date.parse(arg)
+        Date.parse(T.let(arg, T.untyped))
       end
     rescue ArgumentError
-      raise TypeError, "Cannot convert #{arg.inspect} to Date"
+      Kernel.raise TypeError, "Cannot convert #{arg.inspect} to Date"
     end
   end
 end

data/lib/repeatable/expression/base.rb

@@ -1,6 +1,14 @@
+# typed: strict
+
 module Repeatable
   module Expression
     class Base
+      extend T::Sig
+      extend T::Helpers
+
+      abstract!
+
+      sig { params(other: Object).returns(T::Boolean) }
       def self.===(other)
         case other
         when Class
@@ -10,31 +18,34 @@ module Repeatable
         end
       end
 
-      def include?(_date)
-        fail(
-          NotImplementedError,
-          "Don't use Expression::Base directly. Subclasses must implement `#include?`"
-        )
+      sig { abstract.params(date: ::Date).returns(T::Boolean) }
+      def include?(date)
       end
 
+      sig { returns(T::Hash[Symbol, T.any(Types::SymbolHash, T::Array[Types::SymbolHash])]) }
       def to_h
-        fail(
-          NotImplementedError,
-          "Don't use Expression::Base directly. Subclasses must implement `#to_h`"
-        )
+        {hash_key => hash_value}
       end
 
+      sig { params(_keys: T.nilable(T::Array[Symbol])).returns(T::Hash[Symbol, T.any(Types::SymbolHash, T::Array[Types::SymbolHash])]) }
+      def deconstruct_keys(_keys)
+        to_h
+      end
+
+      sig { params(other: Expression::Base).returns(Expression::Union) }
       def union(other)
         Union.new(self, other)
       end
       alias_method :+, :union
       alias_method :|, :union
 
+      sig { params(other: Expression::Base).returns(Expression::Intersection) }
       def intersection(other)
         Intersection.new(self, other)
       end
       alias_method :&, :intersection
 
+      sig { params(other: T.untyped).returns(Expression::Difference) }
       def difference(other)
         Difference.new(included: self, excluded: other)
       end
@@ -42,12 +53,17 @@ module Repeatable
 
       private
 
+      sig { returns(Symbol) }
       def hash_key
-        self.class.name.split("::").last
-          .gsub(/(?<!\b)[A-Z]/) { "_#{Regexp.last_match[0]}" }
+        T.must(T.must(self.class.name).split("::").last)
+          .gsub(/(?<!\b)[A-Z]/) { "_#{T.must(Regexp.last_match)[0]}" }
           .downcase
           .to_sym
       end
+
+      sig { abstract.returns(T.any(Types::SymbolHash, T::Array[Types::SymbolHash])) }
+      def hash_value
+      end
     end
   end
 end