repeatable 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f6976240c976a027e08e04dc46dff2a7a420894f089ae7fa8c9fded126bafc6
-  data.tar.gz: 4e0e0e4d45d72b543549904a9a6f4b041430b9808075ccb64a81583366a4e414
+  metadata.gz: 71a9ecf64d973e0e8298628e5ab19ab4025c9c3281a357efaae330f42c9767a0
+  data.tar.gz: 190a230b24d32f0df2f6565d35c2da1867d3ae87c82d0e00d98ab16b53baa46c
 SHA512:
-  metadata.gz: 2698038cb582f612642c1b2f9c595e3830ff42556fb89eef56d4bbf5e3c34396d318175699ecb74a2c589aefe861cc5c7e17a6bde0b4950b6939421fedcb1260
-  data.tar.gz: 6a98285ed9058b186651055e5afecae2b2abcb64ca0dbc488b92b76ff6a20da02d4ab1d96f204bd864b210a5d183fdff34db31b82d4b06595e0b7c16f2dc3dcf
+  metadata.gz: 8335d2132cd0fc2cdf5d991431bafcec688819b9b2df45090afcdb05886f74632ebb262ae6f014911aa300589a5f1a776d2a5325adb39569824af306cd94bbfc
+  data.tar.gz: 26a637424b6a64a3a1a6b6db0ed8fb6c0e1ece5040b15499182fd3e45cdb3bf7298634620d1f3284af1a47f00655f7bac7212bea369fbc5f287e154fc3ce45cf

data/.github/workflows/ci.yml

@@ -0,0 +1,72 @@
+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.0'
+            coverage: 'true'
+    steps:
+      - uses: actions/checkout@v2
+      - 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.0'
+          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.0'
+          bundler-cache: true
+      - name: Run Sorbet
+        run: bundle exec rake sorbet

data/CHANGELOG.md

@@ -2,7 +2,24 @@
 
 ### Unreleased
 
-[Commits](https://github.com/molawson/repeatable/compare/v1.0.0...main)
+[Commits](https://github.com/molawson/repeatable/compare/v1.1.0...main)
+
+### 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,8 +3,10 @@ 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"
 gem "standard", "~> 1.0"
 
 group :test do

data/Gemfile.lock

@@ -1,17 +1,26 @@
 PATH
   remote: .
   specs:
-    repeatable (1.0.0)
+    repeatable (1.1.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)
+    highline (2.0.3)
     method_source (1.0.0)
     parallel (1.20.1)
+    parlour (6.0.1)
+      commander (~> 4.5)
+      parser
+      rainbow (~> 3.0)
+      sorbet-runtime (>= 0.5)
     parser (3.0.0.0)
       ast (~> 2.4.1)
     pry (0.14.0)
@@ -20,7 +29,7 @@ GEM
     rainbow (3.0.0)
     rake (13.0.3)
     regexp_parser (2.1.1)
-    rexml (3.2.4)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -54,23 +63,33 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.2)
+    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)
 
 PLATFORMS
+  arm64-darwin-21
+  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
   standard (~> 1.0)
 
 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 } }
@@ -186,16 +182,39 @@ 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).

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/lib/repeatable/conversions.rb

@@ -1,7 +1,11 @@
+# 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
@@ -10,7 +14,7 @@ module Repeatable
         Date.parse(arg)
       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,13 @@
+# 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 +17,29 @@ 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(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 +47,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

data/lib/repeatable/expression/biweekly.rb

@@ -1,23 +1,31 @@
+# typed: strict
 module Repeatable
   module Expression
     class Biweekly < Date
+      sig { params(weekday: Integer, start_after: Object).void }
       def initialize(weekday:, start_after: ::Date.today)
         @weekday = weekday
-        @start_after = Conversions::Date(start_after)
+        @start_after = T.let(Conversions::Date(start_after), ::Date)
+        @_first_occurrence = T.let(find_first_occurrence, ::Date)
       end
 
+      sig { override.params(date: ::Date).returns(T::Boolean) }
       def include?(date)
-        date >= start_after && (date - first_occurrence) % 14 == 0
+        date >= start_after && (date - _first_occurrence) % 14 == 0
       end
 
       private
 
-      attr_reader :weekday, :start_after
+      sig { returns(Integer) }
+      attr_reader :weekday
 
-      def first_occurrence
-        @first_occurrence ||= find_first_occurrence
-      end
+      sig { returns(::Date) }
+      attr_reader :start_after
+
+      sig { returns(::Date) }
+      attr_reader :_first_occurrence
 
+      sig { returns(::Date) }
       def find_first_occurrence
         days_away = weekday - start_after.wday
         days_away += 7 if days_away <= 0

data/lib/repeatable/expression/date.rb

@@ -1,29 +1,33 @@
+# typed: strict
 module Repeatable
   module Expression
     class Date < Base
-      def to_h
-        Hash[hash_key, attributes]
-      end
+      abstract!
 
+      sig { params(other: Object).returns(T::Boolean) }
       def ==(other)
         other.is_a?(self.class) && attributes == other.attributes
       end
-
       alias_method :eql?, :==
 
+      sig { returns(Integer) }
       def hash
         [attributes.values, self.class.name].hash
       end
 
       protected
 
+      sig { returns(Types::SymbolHash) }
       def attributes
         instance_variables.each_with_object({}) do |name, hash|
-          key = name.to_s.gsub(/^@/, "").to_sym
-          hash[key] = normalize_attribute_value(instance_variable_get(name))
+          key = name.to_s.gsub(/^@/, "")
+          next if key.start_with?("_")
+          hash[key.to_sym] = normalize_attribute_value(instance_variable_get(name))
         end
       end
+      alias_method :hash_value, :attributes
 
+      sig { params(value: BasicObject).returns(T.untyped) }
       def normalize_attribute_value(value)
         case value
         when ::Date

data/lib/repeatable/expression/day_in_month.rb

@@ -1,12 +1,15 @@
+# typed: strict
 module Repeatable
   module Expression
     class DayInMonth < Date
       include LastDateOfMonth
 
+      sig { params(day: Integer).void }
       def initialize(day:)
         @day = day
       end
 
+      sig { override.params(date: ::Date).returns(T::Boolean) }
       def include?(date)
         if day < 0
           date - last_date_of_month(date) - 1 == day
@@ -17,6 +20,7 @@ module Repeatable
 
       private
 
+      sig { returns(Integer) }
       attr_reader :day
     end
   end

data/lib/repeatable/expression/difference.rb

@@ -1,19 +1,19 @@
+# typed: strict
 module Repeatable
   module Expression
     class Difference < Base
+      sig { params(included: Expression::Base, excluded: Expression::Base).void }
       def initialize(included:, excluded:)
         @included = included
         @excluded = excluded
       end
 
+      sig { override.params(date: ::Date).returns(T::Boolean) }
       def include?(date)
         included.include?(date) && !excluded.include?(date)
       end
 
-      def to_h
-        Hash[hash_key, {included: included.to_h, excluded: excluded.to_h}]
-      end
-
+      sig { params(other: Object).returns(T::Boolean) }
       def ==(other)
         other.is_a?(self.class) &&
           included == other.included &&
@@ -22,7 +22,16 @@ module Repeatable
 
       protected
 
-      attr_reader :included, :excluded
+      sig { returns(Expression::Base) }
+      attr_reader :included
+
+      sig { returns(Expression::Base) }
+      attr_reader :excluded
+
+      sig { override.returns(Types::SymbolHash) }
+      def hash_value
+        {included: included.to_h, excluded: excluded.to_h}
+      end
     end
   end
 end

data/lib/repeatable/expression/exact_date.rb

@@ -1,16 +1,20 @@
+# typed: strict
 module Repeatable
   module Expression
     class ExactDate < Date
+      sig { params(date: Object).void }
       def initialize(date:)
-        @date = Conversions::Date(date)
+        @date = T.let(Conversions::Date(date), ::Date)
       end
 
+      sig { override.params(other_date: ::Date).returns(T::Boolean) }
       def include?(other_date)
         date == other_date
       end
 
       private
 
+      sig { returns(::Date) }
       attr_reader :date
     end
   end