recurring_date 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d4cc8eff5210dd36470912daacacd4a4a44f7109
-  data.tar.gz: d339946cc56e30491139b5577a63033e963be901
+SHA256:
+  metadata.gz: 7852f2274c200712705a14f593a92ad3b68d69a935b4dd81d4d6ee29b3b83035
+  data.tar.gz: 20f777337f3cb1afde4cdc3fc03f95833a70b1816116f486f4887e2724fda14e
 SHA512:
-  metadata.gz: 4465192a86991d9f4cd3fb2d0d9eede1845ddc690cc39a2c9990d7dd0947c6935fdc2ea4d417e3856a399e15fa327514168f3813a5303aa92a99e11bb168f029
-  data.tar.gz: 31e51294b9b93401ae693aee6d2c61b01ebb25947835f5bd41d6e86bff79cf608dd69a9eba680de394e955459c4431152e788a5c8427a0fdb4d253381184f4e2
+  metadata.gz: 13b085b3ccd9bff2227f451979adadf7be355ca0da35d09a15827848217d0e59d3bdd150447e597866a63f42ddbd68a59fb55ae8b50b17e22cc589c1eb738eba
+  data.tar.gz: 9744b7f105c3aa9099210208bd4ee5447c9b91fc2aea3d3919e390f628cbbf4012f16f5841ee52f5da533b8a1e3c4f7df44c4a2e2fcc07f8b41445da8e5b8070

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# ignore gem releses
+*.gem

data/.gitlab-ci.yml

@@ -0,0 +1,31 @@
+image: "reg01.binarapps.com/docker-images/ruby-rvm:2.3.1"
+
+variables:
+
+cache:
+  key: "$CI_BUILD_REF_NAME"
+
+stages:
+  - build
+  - test
+
+before_script:
+  - rvm current
+  - bundle install --jobs $(nproc) --path /cache
+
+bundle install:
+  stage: build
+  before_script: []
+  script:
+    - rvm current
+    - bundle install --jobs $(nproc) --path /cache
+
+rspec:
+  stage: test
+  script:
+    - bundle exec rspec -fp
+
+rubocop:
+  stage: test
+  script:
+    - bundle exec rubocop

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,39 @@
+AllCops:
+  Include:
+    - '**/Gemfile'
+  Exclude:
+    - '**/Gemfile*'
+    - '**/*.gemspec'
+  TargetRubyVersion: 2.3
+Style/WhileUntilModifier:
+  MaxLineLength: 120
+Style/WhileUntilModifier:
+  MaxLineLength: 120
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 25
+Metrics/AbcSize:
+  Max: 50
+Metrics/ClassLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Style/DotPosition:
+  EnforcedStyle: trailing
+Style/MultilineHashBraceLayout:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/CharacterLiteral:
+  Enabled: false
+Style/CharacterLiteral:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-gemset

@@ -0,0 +1 @@
+recurring_date

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    recurring_date (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  recurring_date!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Paweł Placzyński
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# recurring_date
+
+Iterate over a set of dates, giving an iteration conditions.
+
+This gem provides an enumerator `RecurringDate::Enumerator`, selecting specific dates due to the recursion pattern.
+
+`RecurringDate::Enumerator` is lazy so pattern can be applied to an infinite set of dates.
+
+The enumerator operates on objects that implements the `Enumerator#each` and yields `Date`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'recurring_date'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install recurring_date
+
+## Usage
+
+
+### `RecurringDate`
+
+`RecurringDate` module adds two methods to class `Date`:
+
+| Method     | Description
+|------------|-------------
+| `#mweek`   | Returns a number - n'th occurence of the week day in the month.
+| `#to_enum` | Returns `RecurringDate::Enumerator` enumerator with given range from `self` iterating forever (infinite set).
+
+### `RecurringDate::Enumerator`
+
+The enumerator implements bunch of chainable methods to provide simple DSL for selecting wanted recursion pattern.
+
+| Pattern                                                  | DSL
+|----------------------------------------------------------|-----
+| dates matching `condition`                               | `enumerator.select { ❘d❘ condition }`
+| dates not matching `condition`                           | `enumerator.reject { ❘d❘ condition }`
+| dates matching `condition` (with index `i`)              | `enumerator.select_with_index { ❘d, i❘ condition }`
+| dates from beginning as long as `condition` is fulfilled | `enumerator.take_while { ❘d❘ condition }`
+| `n` dates from beginning                                 | `enumerator.take(n)`
+| every 4th of October                                     | `enumerator.month(10).mday(4)`
+| every 3rd and 23rd of August                             | `enumerator.month(8).mday(3, 23)`
+| every 17th June and July                                 | `enumerator.month(6, 7).mday(17)`
+| every 10th and 12th of February and April                | `enumerator.month(2, 4).mday(10, 12)`
+| every 13th of the month                                  | `enumerator.mday(13)`
+| every 21st and 23rd of the month                         | `enumerator.mday(21, 23)`
+| every Friday                                             | `enumerator.wday(5)`
+| every Saturday and Sunday                                | `enumerator.wday(6, 0)`
+| every Saturday and Sunday                                | `enumerator.matching(6, 0) { ❘d❘ d.wday }`
+| every Saturday and Sunday                                | `enumerator.matching(6, 0, &:wday)`
+| every 4th day                                            | `enumerator.pattern(4)`
+| every 7th or 10th day                                    | `enumerator.pattern(7, 10)`
+| every second Friday                                      | `enumerator.wday(5).pattern(2)`
+| every 2nd Monday of the month                            | `enumerator.wday(1).mweek(2)`
+| 2nd and 4th Sunday of the month                          | `enumerator.wday(0).mweek(2,4)`
+| 3rd Tuesday and Wednesday of the month                   | `enumerator.wday(2,3).mweek(3)`
+| until `date`                                             | `enumerator.until(date)`
+
+###### NOTE
+
+* There is a method `RecurringDate::Enumerator.eternity` that returns `RecurringDate::Enumerator` instance that iterates perpetualy over every day after _1970-01-01_.
+* The `RecurringDate::Enumerator.from(date)` method does the same, but from `date`.
+* Every enumerator method (except `select`, `select_with_index`, `reject`, `take`, `take_while` and `until`) has a corresponding method with `not_` prefix.
+* For `rails` models the pattern can be used to select records, like: `Model.where('column::date IN (?)', dates)`.
+
+### Example
+
+    require 'recurring_date'
+    rule = RecurringDate::Enumerator.eternity
+    rule.wday(5).mweek(1)                       # => enumerator of all first Fridays of a month
+    rule.pattern(2).until(Date.new(2020, 8, 1)) # => enumerator of every second day until 2020-08-01
+    rule.wday(6,0).mweek(2,4).take(8)           # => enumerator of next four 2nd and 4th weekends of a month
+    rule.to_a                                   # => array of `Date` instances (be careful - it can be infinite)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 `lib/recurring_date/version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, 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/placek/recurring_date.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'recurring_date'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/recurring_date/enumerator.rb

@@ -0,0 +1,132 @@
+require 'date'
+
+module RecurringDate
+  class Enumerator < ::Enumerator
+    def initialize(range)
+      super() do |result|
+        begin
+          range.each { |val| block_given? ? yield(result, val) : result << val }
+        rescue ::StopIteration
+          nil
+        end
+      end
+    end
+
+    def self.eternity
+      from(Date.new(1970))
+    end
+
+    def self.from(date)
+      RecurringDate::Enumerator.new(infinity(date))
+    end
+
+    def yday(*args)
+      matching(*args, &:yday)
+    end
+
+    def mday(*args)
+      matching(*args, &:mday)
+    end
+
+    def wday(*args)
+      matching(*args, &:wday)
+    end
+
+    def mweek(*args)
+      matching(*args, &:mweek)
+    end
+
+    def month(*args)
+      matching(*args, &:month)
+    end
+
+    def year(*args)
+      matching(*args, &:year)
+    end
+
+    def not_yday(*args)
+      not_matching(*args, &:yday)
+    end
+
+    def not_mday(*args)
+      not_matching(*args, &:mday)
+    end
+
+    def not_wday(*args)
+      not_matching(*args, &:wday)
+    end
+
+    def not_mweek(*args)
+      not_matching(*args, &:mweek)
+    end
+
+    def not_month(*args)
+      not_matching(*args, &:month)
+    end
+
+    def not_year(*args)
+      not_matching(*args, &:year)
+    end
+
+    def matching(*args)
+      select { |date| args.include?(yield(date)) }
+    end
+
+    def not_matching(*args)
+      reject { |date| args.include?(yield(date)) }
+    end
+
+    def pattern(*args)
+      select_with_index do |_, i|
+        args.any? { |arg| ((i + 1) % arg).zero? }
+      end
+    end
+
+    def until(arg)
+      take_while { |date| date <= arg.to_date }
+    end
+
+    def select_with_index
+      index = 0
+      RecurringDate::Enumerator.new(self) do |result, value|
+        result << value if yield(value, index)
+        index += 1
+      end
+    end
+
+    def select
+      RecurringDate::Enumerator.new(self) { |result, value| result << value if yield(value) }
+    end
+
+    def reject
+      RecurringDate::Enumerator.new(self) { |result, value| result << value unless yield(value) }
+    end
+
+    def take(n)
+      taken = n
+      RecurringDate::Enumerator.new(self) do |result, value|
+        raise ::StopIteration if taken.zero?
+        result << value
+        taken -= 1
+      end
+    end
+
+    def take_while
+      RecurringDate::Enumerator.new(self) do |result, value|
+        raise ::StopIteration unless yield(value)
+        result << value
+      end
+    end
+
+    def inspect
+      ['#<RecurringDate::Enumerator:0x', object_id, '>'].join
+    end
+
+    def self.infinity(date)
+      ::Enumerator.new do |y|
+        i = date.prev_day
+        loop { y << (i = i.next) }
+      end
+    end
+  end
+end

data/lib/recurring_date/version.rb

@@ -0,0 +1,3 @@
+module RecurringDate
+  VERSION = '0.1.1'.freeze
+end

data/lib/recurring_date.rb

@@ -1,4 +1,4 @@
-require_relative 'recurring_date_enumerator'
+require 'recurring_date/enumerator'
 
 module RecurringDate
   def mweek
@@ -6,7 +6,7 @@ module RecurringDate
   end
 
   def to_enum
-    RecurringDateEnumerator.eternity(from: self)
+    RecurringDate::Enumerator.from(self)
   end
 end
 

data/recurring_date.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'recurring_date/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'recurring_date'
+  spec.version     = RecurringDate::VERSION
+  spec.authors     = ['Paweł Placzyński']
+  spec.email       = ['placzynski.pawel@gmail.com']
+
+  spec.summary     = %q{Dates enumerator with conditions}
+  spec.description = %q{Iterate over a set of dates, giving an iteration conditions.}
+  spec.homepage    = 'https://gitlab.binarapps.com/placek/recurring_date'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri']    = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://gitlab.binarapps.com/placek/recurring_date'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+end

metadata

@@ -1,31 +1,86 @@
 --- !ruby/object:Gem::Specification
 name: recurring_date
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
-- Paweł Placzyński
+- Paweł Placzyński
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-01 00:00:00.000000000 Z
-dependencies: []
-description: Enumerator for recurring dates with specific patterns
+date: 2020-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Iterate over a set of dates, giving an iteration conditions.
 email:
-- should@not-fail.pl
-- p.placzynski@binarapps.com
 - placzynski.pawel@gmail.com
-- silquenarmo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/recurring_date.rb
-- lib/recurring_date_enumerator.rb
-homepage: ''
-licenses:
-- MIT
-metadata: {}
+- lib/recurring_date/enumerator.rb
+- lib/recurring_date/version.rb
+- recurring_date.gemspec
+homepage: https://gitlab.binarapps.com/placek/recurring_date
+licenses: []
+metadata:
+  homepage_uri: https://gitlab.binarapps.com/placek/recurring_date
+  source_code_uri: https://gitlab.binarapps.com/placek/recurring_date
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -41,9 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: Recurring dates enumerator
+summary: Dates enumerator with conditions
 test_files: []

data/lib/recurring_date_enumerator.rb

@@ -1,128 +0,0 @@
-require 'date'
-
-class RecurringDateEnumerator < Enumerator
-  def initialize(range)
-    super() do |result|
-      begin
-        range.each { |val| block_given? ? yield(result, val) : result << val }
-      rescue StopIteration
-        nil
-      end
-    end
-  end
-
-  def self.eternity(from: Date.new(1970))
-    RecurringDateEnumerator.new(infinity(from))
-  end
-
-  def yday(*args)
-    matching(*args, &:yday)
-  end
-
-  def mday(*args)
-    matching(*args, &:mday)
-  end
-
-  def wday(*args)
-    matching(*args, &:wday)
-  end
-
-  def mweek(*args)
-    matching(*args, &:mweek)
-  end
-
-  def month(*args)
-    matching(*args, &:month)
-  end
-
-  def year(*args)
-    matching(*args, &:year)
-  end
-
-  def not_yday(*args)
-    not_matching(*args, &:yday)
-  end
-
-  def not_mday(*args)
-    not_matching(*args, &:mday)
-  end
-
-  def not_wday(*args)
-    not_matching(*args, &:wday)
-  end
-
-  def not_mweek(*args)
-    not_matching(*args, &:mweek)
-  end
-
-  def not_month(*args)
-    not_matching(*args, &:month)
-  end
-
-  def not_year(*args)
-    not_matching(*args, &:year)
-  end
-
-  def matching(*args)
-    select { |date| args.include?(yield(date)) }
-  end
-
-  def not_matching(*args)
-    reject { |date| args.include?(yield(date)) }
-  end
-
-  def pattern(*args)
-    select_with_index do |_, i|
-      args.any? do |arg|
-        ((i + 1) % arg).zero?
-      end
-    end
-  end
-
-  def until(arg)
-    take_while { |date| date <= arg.to_date }
-  end
-
-  def select_with_index
-    index = 0
-    RecurringDateEnumerator.new(self) do |result, value|
-      result << value if yield(value, index)
-      index += 1
-    end
-  end
-
-  def select
-    RecurringDateEnumerator.new(self) { |result, value| result << value if yield(value) }
-  end
-
-  def reject
-    RecurringDateEnumerator.new(self) { |result, value| result << value unless yield(value) }
-  end
-
-  def take(n)
-    taken = n
-    RecurringDateEnumerator.new(self) do |result, value|
-      raise StopIteration if taken.zero?
-      result << value
-      taken -= 1
-    end
-  end
-
-  def take_while
-    RecurringDateEnumerator.new(self) do |result, value|
-      raise StopIteration unless yield(value)
-      result << value
-    end
-  end
-
-  def inspect
-    ['#<RecurringDateEnumerator: 0x', object_id, '>'].join
-  end
-
-  def self.infinity(date)
-    Enumerator.new do |y|
-      i = date.prev_day
-      loop { y << (i = i.next) }
-    end
-  end
-end