date_iterator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56ce56dcfc36825be40c067bbf96a19bf71f0172
+  data.tar.gz: a2505232b1fd0a984237c9e11bcede08395babfa
+SHA512:
+  metadata.gz: e969f0e08cdc3f5fef7ebd595cd7005f37a78acd91ebe9ccc177166d888b6a3e041dddbc9e46925568569824b0f6701ee0ecf4c88f45f7f1e848441c63b372fc
+  data.tar.gz: eea00652d8057f833ed166b2c12c0e728f9766e61e45b38eb8edf1740c7b807e4e6d6169651cda9c503eda9a5e542b1a21b3c12d55e36639118b2007b13c1427

data/.gitignore

@@ -0,0 +1 @@
+.DS_Store

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    date_iterator (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  date_iterator!
+  rake

data/LICENSE

@@ -0,0 +1,9 @@
+(The MIT License)
+
+Copyright © 2011 Jonathan Otto
+
+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 SOFTW

data/README.md

@@ -0,0 +1,32 @@
+# DateIterator
+---
+
+**Iterate by day, week, or month - inclusive**
+
+* Tested on CRuby: 2.1, 2.2 (but should work at least from 1.8.7)
+* **adds 3 instance methods** to Date:
+  * `each_day_until`
+  * `each_week_until`
+  * `each_month_until`
+  * If no block is given, returns an enumerator.
+
+## Usage
+```ruby
+>> Date.parse("2010-01-01").each_day_until("2010-01-05") { |d| puts d }
+2010-01-01
+2010-01-02
+2010-01-03
+2010-01-04
+2010-01-05
+=> nil
+
+>> Date.parse("2010-01-01").each_week_until("2010-01-05") { |d| puts d }
+2009-12-28
+2010-01-04
+=> nil
+
+>> Date.parse("2010-01-01").each_month_until("2010-02-05") { |d| puts d }
+2010-01-01
+2010-02-01
+=> nil
+```

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/date_iterator.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'date_iterator/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'date_iterator'
+  s.version     = DateIterator::VERSION
+  s.authors     = ['Jonathan Otto']
+  s.email       = ['jonathan.otto@gmail.com']
+  s.homepage    = 'https://github.com/jotto/date_iterator'
+  s.summary     = 'iterate by day, week, or month on the date class'
+  s.description = 'iterate by day, week, or month on the date class'
+
+  s.files         = `git ls-files`.split($/)
+  s.test_files    = s.files.grep(%r{^(test)/})
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 1.5'
+  s.add_development_dependency 'rake'
+end

data/lib/date_iterator.rb

@@ -0,0 +1,53 @@
+require 'date'
+
+module DateIterator
+
+  # yields inclusive date object of each day
+  def each_day_until(_until=Date.today, &block)
+    return self.to_enum(:each_day_until, _until) unless block_given?
+    self.step(_until.is_a?(Date) ? _until : Date.parse(_until.to_s), +1, &block)
+    nil
+  end
+
+  # yields inclusive date object of first day of week, starting with mondays
+  def each_week_until(_until=Date.today, use_sunday_as_beg_of_week = false, &block)
+    return self.to_enum(:each_week_until, _until, use_sunday_as_beg_of_week) unless block_given?
+    _days_to_monday = self.wday == 0 ? 6 : self.wday - 1
+    _monday = self - _days_to_monday
+    _monday.step(_until.is_a?(Date) ? _until : Date.parse(_until.to_s), +7, &block)
+    nil
+  end
+
+  # yields inclusive date object of first day of month
+  def each_month_until(_until=Date.today, &block)
+    return self.to_enum(:each_month_until, _until) unless block_given?
+
+    _date = Date.new(self.year,self.month,1)
+    _until = _until.is_a?(Date) ? _until : Date.parse(_until.to_s)
+    _until = Date.new(_until.year,_until.month,1)
+
+    while _date <= _until
+      yield _date
+      _date = _date >> 1
+      _date = Date.new(_date.year,_date.month,1)
+    end
+  end
+
+  # yields inclusive date object of first day of the year
+  def each_year_until(_until=Date.today, &block)
+    return self.to_enum(:each_year_until, _until) unless block_given?
+
+    _date = Date.new(self.year,1,1)
+    _until = _until.is_a?(Date) ? _until : Date.parse(_until.to_s)
+    _until = Date.new(_until.year,1,1)
+
+    while _date <= _until
+      yield _date
+      _date = _date >> 12
+      _date = Date.new(_date.year,_date.month,1)
+    end
+  end
+
+end
+
+Date.send(:include, DateIterator)

data/lib/date_iterator/version.rb

@@ -0,0 +1,3 @@
+module DateIterator
+  VERSION = '1.0.0'
+end

data/test/date_iterator_test.rb

@@ -0,0 +1,100 @@
+require_relative '../lib/date_iterator'
+require 'minitest/autorun'
+
+class DateIteratorTest < Minitest::Test
+
+  def test_day_iterator
+    counter = 0
+    Date.parse("2011-01-25").each_day_until("2011-02-02") do |date|
+      assert date.is_a?(Date)
+      counter += 1
+    end
+    assert_equal 9, counter
+  end
+
+  def test_day_iterator_with_iterator
+    counter = 0
+    Date.parse("2011-01-25").each_day_until("2011-02-02").each do |date|
+      assert date.is_a?(Date)
+      counter += 1
+    end
+    assert_equal 9, counter
+  end
+
+  def test_week_iterator
+    counter = 0
+    Date.parse("2010-12-05").each_week_until("2011-02-02") do |date|
+      assert date.is_a?(Date)
+      assert_equal 1, date.wday
+      counter += 1
+    end
+    assert_equal 10, counter
+  end
+
+  def test_week_iterator_with_iterator
+    counter = 0
+    Date.parse("2010-12-05").each_week_until("2011-02-02").each do |date|
+      assert date.is_a?(Date)
+      assert_equal 1, date.wday
+      counter += 1
+    end
+    assert_equal 10, counter
+  end
+
+  def test_month_iterator
+    counter = 0
+    Date.parse("2010-12-25").each_month_until("2011-05-02") do |date|
+      assert date.is_a?(Date)
+      assert_equal 1, date.day
+      counter += 1
+    end
+    assert_equal 6, counter
+  end
+
+  def test_month_iterator_with_iterator
+    counter = 0
+    Date.parse("2010-12-25").each_month_until("2011-05-02").each do |date|
+      assert date.is_a?(Date)
+      assert_equal 1, date.day
+      counter += 1
+    end
+    assert_equal 6, counter
+  end
+
+  def test_original_value_is_preserved_in_day_iterator_and_block_returns_nil
+    _date = Date.parse("2010-12-25")
+    assert_nil _date.each_day_until("2011-02-01") {}
+    assert_equal Date.parse("2010-12-25"), _date
+  end
+
+  def test_original_value_is_preserved_in_month_iterator_and_block_returns_nil
+    _date = Date.parse("2010-12-25")
+    assert_nil _date.each_week_until("2011-02-01") {}
+    assert_equal Date.parse("2010-12-25"), _date
+  end
+
+  def test_original_value_is_preserved_in_month_iterator_and_block_returns_nil
+    _date = Date.parse("2010-12-25")
+    assert_nil _date.each_month_until("2011-02-01") {}
+    assert_equal Date.parse("2010-12-25"), _date
+  end
+
+  def test_year_iterator
+    counter = 0
+    Date.parse("2009-01-01").each_year_until("2012-02-02") do |date|
+      assert date.is_a?(Date)
+      counter += 1
+    end
+    assert_equal 4, counter
+  end
+
+  def test_year_iterator_with_iterator
+    counter = 0
+    Date.parse("2009-01-01").each_year_until("2012-02-02").each do |date|
+      assert date.is_a?(Date)
+      counter += 1
+    end
+    assert_equal 4, counter
+  end
+
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: date_iterator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jonathan Otto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: iterate by day, week, or month on the date class
+email:
+- jonathan.otto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- date_iterator.gemspec
+- lib/date_iterator.rb
+- lib/date_iterator/version.rb
+- test/date_iterator_test.rb
+homepage: https://github.com/jotto/date_iterator
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: iterate by day, week, or month on the date class
+test_files:
+- test/date_iterator_test.rb