feat!: TimeIterator -> TimeRange

.github/workflows/main.yml

@@ -13,7 +13,7 @@ jobs:
     name: Ruby ${{ matrix.ruby }}
     strategy:
       matrix:
-        ruby: [3.0, 3.1, 3.2]
+        ruby: [2.7, 3.0, 3.1, 3.2, 3.3]
 
     steps:
     - uses: actions/checkout@v3

.markdownlint.json

@@ -0,0 +1,4 @@
+{
+    "MD046": false,
+    "MD013": false
+}

.rubocop.yml

@@ -5,7 +5,7 @@ require:
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 2.7
 
 # Useful to separate conceptual expressions.
 Layout/SpaceInsideArrayLiteralBrackets:
@@ -28,6 +28,9 @@ RSpec/ExampleLength:
 RSpec/ExpectChange:
   Enabled: false
 
+RSpec/ImplicitSubject:
+  EnforcedStyle: single_statement_only
+
 # Just one expectation per example is ambitious.
 RSpec/MultipleExpectations:
   Max: 5

.yardopts

@@ -0,0 +1 @@
+--no-private

Gemfile

@@ -2,7 +2,7 @@
 
 source "https://rubygems.org"
 
-# Specify your gem's dependencies in time_iterator.gemspec
+# Specify your gem's dependencies in time_range.gemspec
 gemspec
 
 gem "rake", "~> 13.0"

README.md

@@ -1,24 +1,28 @@
-# TimeIterator
+# TimeRange
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/time_iterator`. To experiment with that code, run `bin/console` for an interactive prompt.
+Range over Time using time intervals without ActiveSupport.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    bundle add time_range
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    gem install time_range
 
 ## Usage
 
-TODO: Write usage instructions here
+Works just like Range with one important change; **you must call `#by` to set a time interval.**
+
+    require 'time_range'
+
+    # Print the first day of each month of 2024.
+    time_range = TimeRange
+      .new(Time.local(2024), Time.local(2025), true)
+      .by(months: 1)
+    time_range.each { |time| puts time }
 
 ## Development
 
@@ -28,4 +32,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/schwern/ruby-time_iterator.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/schwern/ruby-time_range>.

bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "time_iterator"
+require "time_range"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

lib/time_range.rb

@@ -0,0 +1,71 @@
+require 'date'
+
+require_relative 'time_range/advancer'
+require_relative 'time_range/time'
+
+# Range over Time stepping by time intervals.
+#
+# Does not require ActiveSupport.
+#
+# Unlike a Range, it is necessary to call #by to say how long between
+# each step.
+#
+# @example Print every week of 2024.
+#   TimeRange
+#     .new(Time.local(2024), Time.local(2025), true)
+#     .by(weeks: 1)
+#     .each { |week| puts week }
+class TimeRange < Range
+  # Same as Range.new, but it takes Time objects.
+  #
+  # @param first [Time] the beginning of the range
+  # @param last [Time] the end of the range
+  # @param exclude_last [Boolean] if true, exclude the last value from the range, default false
+  #
+  # @see Range.new
+  def initialize(first, last, exclude_last = false) # rubocop:disable Style/OptionalBooleanParameter
+    super(
+      first ? TimeRange::Time.new(first) : first,
+      last ? TimeRange::Time.new(last) : last,
+      exclude_last
+    )
+  end
+
+  # The time interval to use when iterating through the TimeRange.
+  #
+  # Returns the TimeRange object so you can safely chain
+  # time_range = TimeRange.new(...).by(...)
+  #
+  # Currently cannot be negative.
+  #
+  # @param seconds [Numeric]
+  # @param minutes [Numeric]
+  # @param hours [Numeric]
+  # @param days [Numeric]
+  # @param weeks [Numeric]
+  # @param months [Numeric]
+  # @param years [Numeric]
+  #
+  # @return [TimeRange] the TimeRange object
+  def by( # rubocop:disable Metrics/ParameterLists
+    seconds: nil, minutes: nil, hours: nil,
+    days: nil, weeks: nil, months: nil, years: nil
+  )
+    by = {
+      seconds: seconds, minutes: minutes, hours: hours,
+      days: days, weeks: weeks, months: months, years: years
+    }.compact!
+
+    self.begin&.by = by
+    self.end&.by = by
+
+    return self
+  end
+
+  # Like Range#eql?, but will be false if their #by is different.
+  def eql?(other)
+    return false if self.begin&.by != other.begin&.by || self.end&.by != other.end&.by
+
+    super
+  end
+end