repeatable 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71a9ecf64d973e0e8298628e5ab19ab4025c9c3281a357efaae330f42c9767a0
-  data.tar.gz: 190a230b24d32f0df2f6565d35c2da1867d3ae87c82d0e00d98ab16b53baa46c
+  metadata.gz: 4b0b02925c282f8d672cff3b6c4683939d5c734f0e682b1a4ea8e5feb931a765
+  data.tar.gz: 4446324d2c752fd1f33ef15545f58de7680ae48743d4f9343062c9151569abbc
 SHA512:
-  metadata.gz: 8335d2132cd0fc2cdf5d991431bafcec688819b9b2df45090afcdb05886f74632ebb262ae6f014911aa300589a5f1a776d2a5325adb39569824af306cd94bbfc
-  data.tar.gz: 26a637424b6a64a3a1a6b6db0ed8fb6c0e1ece5040b15499182fd3e45cdb3bf7298634620d1f3284af1a47f00655f7bac7212bea369fbc5f287e154fc3ce45cf
+  metadata.gz: daa01ada7a7d30730829bcf01ba053c4dd325923a574cf78af0b8a5531b543752392f239d96f3658f8a2045313e5df50cca92c75d91fc29aa5484e7e16224ccd
+  data.tar.gz: '080a67d068f2b4663d0ed106d78371f10c47b576b65a52fb5d43fc19b78b0fc1a3449cb288899b089c1b26b77a039cf29cb9fc5b0e828fdd1b7a9a3154aecebb'

data/.github/workflows/ci.yml

@@ -22,10 +22,13 @@ jobs:
           - '3.0'
           - '3.1'
         include:
-          - ruby-version: '3.0'
+          - 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:
@@ -55,7 +58,7 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.0'
+          ruby-version: '3.1'
           bundler-cache: true
       - name: Run Standard
         run: bundle exec rake standard
@@ -66,7 +69,9 @@ jobs:
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.0'
+          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,16 @@
 
 ### Unreleased
 
-[Commits](https://github.com/molawson/repeatable/compare/v1.1.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)
 

data/Gemfile

@@ -6,8 +6,9 @@ gemspec
 gem "parlour"
 gem "pry", "~> 0.13"
 gem "rake", ">= 12.3.3"
-gem "sorbet"
+gem "sorbet-static-and-runtime"
 gem "standard", "~> 1.0"
+gem "tapioca"
 
 group :test do
   gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    repeatable (1.1.0)
+    repeatable (1.2.0)
       sorbet-runtime
 
 GEM
@@ -13,23 +13,34 @@ GEM
       highline (~> 2.0.0)
     diff-lcs (1.4.4)
     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)
-    parlour (6.0.1)
+    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.0.0.0)
+    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.5)
+    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)
@@ -43,40 +54,74 @@ 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.4)
-    sorbet (0.5.9672)
-      sorbet-static (= 0.5.9672)
-    sorbet-runtime (0.5.6357)
-    sorbet-static (0.5.9672-universal-darwin-19)
-    sorbet-static (0.5.9672-universal-darwin-21)
-    sorbet-static (0.5.9672-x86_64-linux)
-    standard (1.0.4)
-      rubocop (= 1.11.0)
-      rubocop-performance (= 1.10.1)
-    unicode-display_width (2.0.0)
+    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
@@ -88,8 +133,9 @@ DEPENDENCIES
   repeatable!
   rspec (~> 3.0)
   simplecov (~> 0.18)
-  sorbet
+  sorbet-static-and-runtime
   standard (~> 1.0)
+  tapioca
 
 BUNDLED WITH
    2.3.6

data/README.md

@@ -159,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.
@@ -218,3 +233,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## 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/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,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Conversions
     extend T::Sig
@@ -11,7 +12,7 @@ module Repeatable
       when Date, Time
         arg.to_date
       else
-        Date.parse(arg)
+        Date.parse(T.let(arg, T.untyped))
       end
     rescue ArgumentError
       Kernel.raise TypeError, "Cannot convert #{arg.inspect} to Date"

data/lib/repeatable/expression/base.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Expression
     class Base
@@ -26,6 +27,11 @@ module Repeatable
         {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)

data/lib/repeatable/expression/biweekly.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Expression
     class Biweekly < Date

data/lib/repeatable/expression/date.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Expression
     class Date < Base

data/lib/repeatable/expression/day_in_month.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Expression
     class DayInMonth < Date

data/lib/repeatable/expression/difference.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Expression
     class Difference < Base

data/lib/repeatable/expression/exact_date.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Expression
     class ExactDate < Date

data/lib/repeatable/expression/intersection.rb

@@ -1,9 +1,11 @@
 # typed: strict
+
 module Repeatable
   module Expression
     class Intersection < Set
       sig { params(elements: T.any(Expression::Base, T::Array[Expression::Base])).void }
       def initialize(*elements)
+        elements = Array(elements).flatten
         other_intersections, not_intersections = elements.partition { |e| e.is_a?(self.class) }
         other_intersections = T.cast(other_intersections, T::Array[Expression::Intersection])
         super(other_intersections.flat_map(&:elements).concat(not_intersections))

data/lib/repeatable/expression/range_in_year.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Expression
     class RangeInYear < Date

data/lib/repeatable/expression/set.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Expression
     class Set < Base
@@ -7,8 +8,8 @@ module Repeatable
       sig { returns(T::Array[Expression::Base]) }
       attr_reader :elements
 
-      sig { params(elements: T.any(Expression::Base, T::Array[Expression::Base])).void }
-      def initialize(*elements)
+      sig { params(elements: T::Array[Expression::Base]).void }
+      def initialize(elements)
         @elements = T.let(elements.flatten.uniq, T::Array[Expression::Base])
       end
 

data/lib/repeatable/expression/union.rb

@@ -1,9 +1,11 @@
 # typed: strict
+
 module Repeatable
   module Expression
     class Union < Set
       sig { params(elements: T.any(Expression::Base, T::Array[Expression::Base])).void }
       def initialize(*elements)
+        elements = Array(elements).flatten
         other_unions, not_unions = elements.partition { |e| e.is_a?(self.class) }
         other_unions = T.cast(other_unions, T::Array[Expression::Union])
         super(other_unions.flat_map(&:elements).concat(not_unions))

data/lib/repeatable/expression/weekday.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Expression
     class Weekday < Date

data/lib/repeatable/expression/weekday_in_month.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Expression
     class WeekdayInMonth < Date

data/lib/repeatable/expression.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Expression
   end

data/lib/repeatable/last_date_of_month.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module LastDateOfMonth
     extend T::Sig

data/lib/repeatable/parse_error.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   class ParseError < StandardError
   end

data/lib/repeatable/parser.rb

@@ -1,4 +1,5 @@
 # typed: false
+
 module Repeatable
   class Parser
     extend T::Sig

data/lib/repeatable/schedule.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   class Schedule
     extend T::Sig
@@ -54,6 +55,11 @@ module Repeatable
       expression.to_h
     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: Object).returns(T::Boolean) }
     def ==(other)
       other.is_a?(self.class) && expression == other.expression

data/lib/repeatable/types.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
   module Types
     SymbolHash = T.type_alias { T::Hash[Symbol, T.untyped] }

data/lib/repeatable/version.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 module Repeatable
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/repeatable.rb

@@ -1,4 +1,5 @@
 # typed: strict
+
 require "date"
 require "sorbet-runtime"
 

data/rbi/repeatable.rbi

@@ -1,6 +1,6 @@
 # typed: strong
 module Repeatable
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 
   module Conversions
     extend T::Sig
@@ -65,6 +65,9 @@ module Repeatable
     sig { returns(T::Hash[Symbol, T.any(Types::SymbolHash, T::Array[Types::SymbolHash])]) }
     def to_h; 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); end
+
     sig { params(other: Object).returns(T::Boolean) }
     def ==(other); end
 
@@ -92,6 +95,9 @@ module Repeatable
       sig { returns(T::Hash[Symbol, T.any(Types::SymbolHash, T::Array[Types::SymbolHash])]) }
       def to_h; 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); end
+
       sig { params(other: Expression::Base).returns(Expression::Union) }
       def union(other); end
 
@@ -241,8 +247,8 @@ module Repeatable
       sig { returns(T::Array[Expression::Base]) }
       attr_reader :elements
 
-      sig { params(elements: T.any(Expression::Base, T::Array[Expression::Base])).void }
-      def initialize(*elements); end
+      sig { params(elements: T::Array[Expression::Base]).void }
+      def initialize(elements); end
 
       sig { params(element: T.untyped).returns(Repeatable::Expression::Set) }
       def <<(element); end

data/sorbet/config

@@ -1,3 +1,4 @@
 --dir
 .
---ignore=/vendor/bundle
+--ignore=tmp/
+--ignore=vendor/

data/sorbet/rbi/annotations/.gitattributes

@@ -0,0 +1 @@
+**/*.rbi linguist-vendored=true

data/sorbet/rbi/{sorbet-typed/lib/rainbow/all → annotations}/rainbow.rbi

@@ -1,13 +1,11 @@
-# This file is autogenerated. Do not edit it by hand. Regenerate it with:
-#   srb rbi sorbet-typed
-#
-# If you would like to make changes to this file, great! Please upstream any changes you make here:
-#
-#   https://github.com/sorbet/sorbet-typed/edit/master/lib/rainbow/all/rainbow.rbi
-#
-# typed: strong
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This file was pulled from a central RBI files repository.
+# Please run `bin/tapioca annotations` to update it.
 
 module Rainbow
+  # @shim: https://github.com/sickill/rainbow/blob/master/lib/rainbow.rb#L10-L12
   sig { returns(T::Boolean) }
   attr_accessor :enabled
 
@@ -15,18 +13,13 @@ module Rainbow
     sig { returns(Symbol) }
     attr_reader :ground
 
-    sig do
-      params(
-        ground: Symbol,
-        values: T.any([Integer], [Integer, Integer, Integer])
-      ).returns(Color)
-    end
+    sig { params(ground: Symbol, values: T.any([Integer], [Integer, Integer, Integer])).returns(Color) }
     def self.build(ground, values); end
 
     sig { params(hex: String).returns([Integer, Integer, Integer]) }
     def self.parse_hex_color(hex); end
 
-    class Indexed < Color
+    class Indexed < Rainbow::Color
       sig { returns(Integer) }
       attr_reader :num
 
@@ -37,44 +30,44 @@ module Rainbow
       def codes; end
     end
 
-    class Named < Indexed
+    class Named < Rainbow::Color::Indexed
       NAMES = T.let(nil, T::Hash[Symbol, Integer])
 
+      sig { params(ground: Symbol, name: Symbol).void }
+      def initialize(ground, name); end
+
       sig { returns(T::Array[Symbol]) }
       def self.color_names; end
 
       sig { returns(String) }
       def self.valid_names; end
-
-      sig { params(ground: Symbol, name: Symbol).void }
-      def initialize(ground, name); end
     end
 
-    class RGB < Indexed
+    class RGB < Rainbow::Color::Indexed
       sig { returns(Integer) }
-      attr_accessor :r, :g, :b
-
-      sig { params(value: Numeric).returns(Integer) }
-      def to_ansi_domain(value); end
+      attr_reader :r, :g, :b
 
       sig { params(ground: Symbol, values: Integer).void }
       def initialize(ground, *values); end
 
       sig { returns(T::Array[Integer]) }
       def codes; end
+
+      sig { params(value: Numeric).returns(Integer) }
+      def self.to_ansi_domain(value); end
     end
 
-    class X11Named < RGB
-      include X11ColorNames
+    class X11Named < Rainbow::Color::RGB
+      include Rainbow::X11ColorNames
+
+      sig { params(ground: Symbol, name: Symbol).void }
+      def initialize(ground, name); end
 
       sig { returns(T::Array[Symbol]) }
       def self.color_names; end
 
       sig { returns(String) }
       def self.valid_names; end
-
-      sig { params(ground: Symbol, name: Symbol).void }
-      def initialize(ground, name); end
     end
   end
 
@@ -251,7 +244,7 @@ module Rainbow
     def self.wrap_with_sgr(string, codes); end
 
     sig { params(string: String).returns(String) }
-    def uncolor(string); end
+    def self.uncolor(string); end
   end
 
   VERSION = T.let(nil, String)

data/sorbet/rbi/gems/.gitattributes

@@ -0,0 +1 @@
+**/*.rbi linguist-generated=true