dayrange 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c477109871aa6b6d156b3a345778e0de371fe1daa43205fe862b3ba47cc6288
+  data.tar.gz: 1dbaa87fb96aab8b9e1c0a7c9132e73e2aef08d4abb63fd7b5db3b7b86e691cd
+SHA512:
+  metadata.gz: 3af2ac0f6ebee15d5c776fb7436bdcb74534de02a3ace7e4b2707f190d26990de53c35d09a9e5b5df4de8166ff1afbc57879403297c7a28b0a8956efa025153c
+  data.tar.gz: b9d136d735e960993755cb71f1ebeeb330f131cde2985834c4d3b793b5d630222de30a34ad6cdb9b2e4c6a15b50794e47c1d6149afd732da73061806da0e4d87

data/.rubocop.yml

@@ -0,0 +1,4 @@
+require: standard
+
+inherit_gem:
+  standard: config/base.yml

data/.standard.yml

@@ -0,0 +1,2 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2022-10-07
+
+### Added
+
+- Everything :)

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in day_range.gemspec
+gemspec
+
+gem "minitest", "~> 5.0"
+gem "rake", "~> 13.0"
+
+gem "standard", "~> 1.3"

data/README.md

@@ -0,0 +1,56 @@
+# DayRange
+
+`DayRange` provides methods to navigate and manipulate series of dates.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dayrange'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dayrange
+
+## Usage
+
+```ruby
+year = DayRange.new(Date.new(2022, 1, 1), Date.new(2022, 12, 31))
+
+# Navigate to the period before
+last_year = year.previous
+
+# Navigate to the period after
+next_year = year.next
+
+# Iterate through the year
+year.each do |date|
+  # Every day of the year
+end
+
+# Iterate in more interesting ways
+year.every(weeks: 2) do |date|
+  # Every other week of the year
+end
+```
+
+## Related projects
+
+* https://github.com/moneybird/active-date-range
+* https://rubygems.org/gems/cada
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also 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`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/substancelab/dayrange.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "day_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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/day_range.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/day_range/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "dayrange"
+  spec.version = DayRange::VERSION
+  spec.authors = ["Jakob Skjerning"]
+  spec.email = ["jakob@mentalized.net"]
+
+  spec.summary = "Range-like object that knows about dates"
+  spec.description = "DayRange provides methods to navigate and manipulate series of dates."
+  spec.homepage = "https://github.com/substancelab/day_range"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.license = "MIT"
+
+  spec.metadata["changelog_uri"] = "https://github.com/substancelab/day_range/blob/main/CHANGELOG.md"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/day_range/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class DayRange < Range
+  VERSION = "1.0.0"
+end

data/lib/day_range.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require_relative "day_range/version"
+
+# A Range-like object that represents a range of days.
+class DayRange < Range
+  class Error < StandardError; end
+
+  # Returns the number of days in the timeframe.
+  def days
+    last - first + 1
+  end
+
+  # Returns an enumerator that steps over the days in the range with specific
+  # intervals.
+  #
+  # step can be specified similarily to DateTime#advance argument
+  #
+  # Usage examples
+  #
+  #     day_range.every(days: 42)
+  #     day_range.every(weeks: 1)
+  #     day_range.every(months: 1)
+  #     day_range.every(days: 1, months: 2, years: 3)
+  #
+  def every(step)
+    c_date = first
+    finish_date = last
+    comparison_operator = exclude_end? ? :< : :<=
+
+    result = []
+    while c_date.send(comparison_operator, finish_date)
+      result << c_date
+      yield c_date if block_given?
+      c_date = advance(c_date, step)
+    end
+    result
+  end
+
+  # Returns a DayRange with the same length as this one, starting on the day
+  # after this one ends.
+  def next
+    self.class.new(
+      last.next_day,
+      last + days
+    )
+  end
+
+  # Returns a DayRange with the same length as this one, ending on the day
+  # before this one starts.
+  def previous
+    self.class.new(
+      first - days,
+      first.prev_day
+    )
+  end
+
+  private
+
+  # File activesupport/lib/active_support/core_ext/date/calculations.rb, line 112
+  def advance(date, options)
+    d = date
+
+    d = d >> options[:years] * 12 if options[:years]
+    d = d >> options[:months] if options[:months]
+    d += options[:weeks] * 7 if options[:weeks]
+    d += options[:days] if options[:days]
+
+    d
+  end
+end

data/lib/dayrange.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+# Load the actual gem code
+require "day_range"

data/sig/day_range.rbs

@@ -0,0 +1,4 @@
+class DayRange
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: dayrange
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jakob Skjerning
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-07 00:00:00.000000000 Z
+dependencies: []
+description: DayRange provides methods to navigate and manipulate series of dates.
+email:
+- jakob@mentalized.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- day_range.gemspec
+- lib/day_range.rb
+- lib/day_range/version.rb
+- lib/dayrange.rb
+- sig/day_range.rbs
+homepage: https://github.com/substancelab/day_range
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/substancelab/day_range/blob/main/CHANGELOG.md
+  homepage_uri: https://github.com/substancelab/day_range
+  source_code_uri: https://github.com/substancelab/day_range
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Range-like object that knows about dates
+test_files: []