periodical 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 2555e6758e16ddd84d99a9f56a223cd8c19cdfe1
-  data.tar.gz: 3187ffebf9e51e9175a76d2321ea1b2c2b516b3a
+SHA256:
+  metadata.gz: 87b19fdf8f3ac679f10b1be35c766f90222c8a78e1d01b99a7e097ea6d9eb391
+  data.tar.gz: 22bc626fc1c7e124490c085c80012b3f5121d800c23b922e512a24875ec99299
 SHA512:
-  metadata.gz: 7adb54adb0d5d51a4193e8519497f57412beeb043ca4c145f850894e59cb684e25e149ec29c414fc51991f40ebcd5a2c0451da5d25809492ef81a549757054c8
-  data.tar.gz: 92a27112f8b1c656b5e7f368dfd6f776c3ee017243656c75785a94640c64df4febe673cd8e8c8c634ca449b6d204daafae9cf4ac4209b8a22752c4274dde02cc
+  metadata.gz: 823fd79066cb4b3cea6591c27710daccca0ba31d9b32d344533b969c4bc7ec48680ebbb037b6fd349eec667aedb9cb14b500b9aa0c0e715c61697ee3acc00a56
+  data.tar.gz: 5caf792943a767cdb6a3e39343c2636d742372b53a73a43996735b25498c2ea47c99fe810117126794390bcbfcfe6dc515863fce47a01895d13df71b7a24d6aa

data/lib/periodical/period.rb

@@ -36,6 +36,8 @@ module Periodical
 		end
 		
 		def advance(date, multiple = 1)
+			raise TypeError unless date.is_a?(Date)
+			
 			self.send("advance_#{unit}", date, multiple * self.count)
 		end
 		
@@ -46,7 +48,7 @@ module Periodical
 		end
 		
 		def advance_weeks(date, count)
-			date + (7 * count)
+			advance_days(date, count*7)
 		end
 		
 		def advance_months(date, count)
@@ -54,7 +56,7 @@ module Periodical
 		end
 		
 		def advance_years(date, count)
-			date >> (12 * count)
+			advance_months(date, count*12)
 		end
 		
 		class << self

data/lib/periodical/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Periodical
-	VERSION = "1.1.0"
+	VERSION = "1.2.0"
 end

metadata

@@ -1,45 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: periodical
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-06-20 00:00:00.000000000 Z
+date: 2020-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: bake-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bake-modernize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,33 +38,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
-- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
-- ".simplecov"
-- ".travis.yml"
-- Gemfile
-- README.md
-- Rakefile
 - lib/periodical.rb
 - lib/periodical/duration.rb
 - lib/periodical/filter.rb
 - lib/periodical/period.rb
 - lib/periodical/version.rb
-- periodical.gemspec
-- spec/periodical/duration_spec.rb
-- spec/periodical/filter_spec.rb
-- spec/periodical/period_spec.rb
-homepage: 
+homepage: https://github.com/ioquatix/periodical
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix/
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -93,12 +69,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Periodical is a simple framework for working with durations and periods.
-test_files:
-- spec/periodical/duration_spec.rb
-- spec/periodical/filter_spec.rb
-- spec/periodical/period_spec.rb
+test_files: []

data/.rspec

@@ -1,4 +0,0 @@
---color
---format documentation
---backtrace
---warnings

data/.simplecov

@@ -1,9 +0,0 @@
-
-SimpleCov.start do
-	add_filter "/spec/"
-end
-
-if ENV['TRAVIS']
-	require 'coveralls'
-	Coveralls.wear!
-end

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
-  - ruby-head
-  - rbx-2
-env: COVERAGE=true
-matrix:
-  allow_failures:
-    - rvm: "rbx-2"

data/Gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :test do
-	gem 'coveralls', platforms: [:mri]
-end

data/README.md

@@ -1,72 +0,0 @@
-# Periodical
-
-Periodical is a simple framework for working with durations and periods. A duration measures a range of time bounded by a `from` date and `to` date. A period is a relative unit of time such as `4 weeks`.
-
-[![Build Status](https://travis-ci.org/ioquatix/periodical.svg)](https://travis-ci.org/ioquatix/periodical)
-[![Code Climate](https://codeclimate.com/github/ioquatix/periodical.svg)](https://codeclimate.com/github/ioquatix/periodical)
-[![Coverage Status](https://coveralls.io/repos/ioquatix/periodical/badge.svg)](https://coveralls.io/r/ioquatix/periodical)
-
-## Motivation
-
-The original idea for this library came from a [Python script which performed backup rotation](http://www.scottlu.com/Content/Snapfilter.html) from 2009. In particular, I thought it had a novel way to retain backups according to a given policy (e.g. one backup every year for 10 years, one backup every month for 12 months, one backup every week for 8 weeks, one backup every day for 30 days). This is done by constructing a special slot based hash structure with keys based on the date being stored. This functionality is used by [LSync](https://github.com/ioquatix/LSync) for performing backup rotation (i.e. deleting old backups).
-
-In addition, I had a need to implement periodical billing in [Financier](https://github.com/ioquatix/financier). Not only can this gem advance a date by a given period, it can compute the number of periods between two dates. This is useful for invoicing, say, once every 6 months for a weekly or monthly service.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-	gem 'periodical'
-
-And then execute:
-
-	$ bundle
-
-Or install it yourself as:
-
-	$ gem install periodical
-
-## Usage
-
-The main use case for this framework involves periodic billing or accounting (e.g. calculating fortnightly rental payments).
-
-	duration = Periodical::Duration.new(Date.parse("2010-01-01"), Date.parse("2010-02-01"))
-	period = Periodical::Period.new(2, :weeks)
-	
-	# How many periods in the duration?
-	count = duration / period
-	
-	# Calculate the date which is 2 * (2 weeks)
-	next = period.advance(duration.from, 2)
-
-## Contributing
-
-1. Fork it
-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 new Pull Request
-
-## License
-
-Released under the MIT license.
-
-Copyright, 2010, 2014, 2016, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
-
-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/Rakefile

@@ -1,14 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec) do |task|
-	if ENV['COVERAGE']
-		begin
-			require('simplecov/version')
-			task.rspec_opts = %w{--require simplecov}
-		rescue LoadError
-		end
-	end
-end
-
-task :default => :spec

data/periodical.gemspec

@@ -1,24 +0,0 @@
-# -*- encoding: utf-8 -*-
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'periodical/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "periodical"
-	spec.version       = Periodical::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-	spec.summary       = %q{Periodical is a simple framework for working with durations and periods.}
-	spec.license       = "MIT"
-
-	spec.files         = `git ls-files`.split($/)
-	spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-	spec.require_paths = ["lib"]
-	
-	spec.required_ruby_version = '>= 2.0'
-	
-	spec.add_development_dependency "bundler", "~> 1.3"
-	spec.add_development_dependency "rspec", "~> 3.4.0"
-	spec.add_development_dependency "rake"
-end

data/spec/periodical/duration_spec.rb

@@ -1,50 +0,0 @@
-# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
-
-require 'periodical'
-
-module Periodical::DurationSpec
-	describe Periodical::Duration do
-		it "should measure durations correctly" do
-			duration = Periodical::Duration.new(Date.parse("2010-01-01"), Date.parse("2010-02-01"))
-			expect(duration.days).to be == 31
-			expect(duration.weeks).to be == Rational(31, 7)
-			expect(duration.months).to be == 1
-			expect(duration.years).to be == Rational(31, 365)
-		
-			expect(duration.whole_months).to be == 1
-			expect(duration.whole_years).to be == 0
-		end
-	
-		it "should compute the correct number of weeks" do
-			duration = Periodical::Duration.new(Date.parse("2010-01-01"), Date.parse("2010-02-01"))
-			period = Periodical::Period.new(2, :weeks)
-		
-			expect(duration / period).to be == Rational(31, 14)
-		end
-		
-		it "should compute the correct number of months" do
-			duration = Periodical::Duration.new(Date.parse("2010-01-01"), Date.parse("2011-03-01"))
-			period = Periodical::Period.new(2, :months)
-		
-			expect(duration / period).to be == Rational(14, 2)
-		end
-	end
-end

data/spec/periodical/filter_spec.rb

@@ -1,61 +0,0 @@
-# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
-
-require 'periodical/filter'
-
-module Periodical::PeriodSpec
-	describe Periodical::Filter do
-		it "should select at most 3 days worth of data" do
-			dates = [
-				Date.parse("2010-01-01"),
-				Date.parse("2010-01-02"),
-				Date.parse("2010-01-03"),
-				Date.parse("2010-01-04"),
-				Date.parse("2010-01-05"),
-				Date.parse("2010-01-06"),
-			]
-			
-			policy = Periodical::Filter::Policy.new
-			policy << Periodical::Filter::Daily.new(3)
-			
-			selected, rejected = policy.filter(dates)
-			
-			expect(selected).to include(*dates.first(3))
-			expect(rejected).to include(*dates.last(3))
-		end
-		
-		it "should keep youngest" do
-			dates = [
-				Date.parse("2010-01-01"),
-				Date.parse("2010-01-02"),
-			]
-			
-			policy = Periodical::Filter::Policy.new
-			policy << Periodical::Filter::Monthly.new(1)
-			
-			selected, rejected = policy.filter(dates, :keep => :new)
-			expect(selected.count).to be 1
-			expect(rejected.count).to be 1
-			
-			# Keep oldest is the default policy
-			expect(selected).to be_include(dates[1])
-		end
-	end
-end

data/spec/periodical/period_spec.rb

@@ -1,64 +0,0 @@
-# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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.
-
-require 'periodical'
-
-module Periodical::PeriodSpec
-	describe Periodical::Period do
-		it "should advance by 1 month" do
-			duration = Periodical::Duration.new(Date.parse("2010-01-01"), Date.parse("2011-01-01"))
-			
-			period = Periodical::Period.new(1, :months)
-			
-			expect(period.advance(duration.from, 12)).to be == duration.to
-		end
-		
-		it "should parse a singular period" do
-			period = Periodical::Period.parse("years")
-			
-			expect(period.count).to be == 1
-			expect(period.unit).to be == :years
-		end
-		
-		it "should parse a multiple count period" do
-			period = Periodical::Period.parse("5 days")
-			
-			expect(period.count).to be == 5
-			expect(period.unit).to be == :days
-		end
-		
-		it "can load nil" do
-			expect(Periodical::Period.load(nil)).to be == nil
-			expect(Periodical::Period.load("")).to be == nil
-		end
-		
-		it "can dump nil" do
-			expect(Periodical::Period.dump(nil)).to be == nil
-		end
-		
-		it "can load string" do
-			expect(Periodical::Period.load("5 weeks")).to be == Periodical::Period.new(5, :weeks)
-		end
-		
-		it "can dump nil" do
-			expect(Periodical::Period.dump(Periodical::Period.new(5, :weeks))).to be == "5 weeks"
-		end
-	end
-end