periodical 0.1.1 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1fec77aa23c72fb853689f5157e26f7f99e1d9cc
+  data.tar.gz: 9121f8a1b764ca0800904cee8fabc878298df225
+SHA512:
+  metadata.gz: d4a1cfc15f47f1c6f6db749bd988ae65d2bd88927e7af67e5588787765ab64f99f28add125f8cadd1ff4dac1bc9961137023098d1f0824389d1f40dfb6068f15
+  data.tar.gz: 5a3035e609a4abb6613ac897a282d088b3eaa571c671ab227e722c4eb85d46b2dbc88055797f82b79cfcf4ac39da7f316a5e3a6037b36f314b6f47b3a30bf56a

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - "2.0"
+  - "2.1"
+matrix:
+  allow_failures:
+    - rvm: "1.9"

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in periodical.gemspec
+gemspec

data/README.md

@@ -1,14 +1,22 @@
-Periodical
-=========
-
-* Author: Samuel G. D. Williams (<http://www.oriontransfer.co.nz>)
-* Copyright (C) 2012 Samuel G. D. Williams.
-* Released under the MIT license.
+# 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`.
 
-Basic Usage
------------
+## 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).
 
@@ -21,10 +29,19 @@ The main use case for this framework involves periodic billing or accounting (e.
 	# Calculate the date which is 2 * (2 weeks)
 	next = period.advance(duration.from, 2)
 
-License
--------
+## 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 (c) 2010, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+Copyright, 2010, 2014, 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

data/Rakefile

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

data/lib/periodical/duration.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 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

data/lib/periodical/filter.rb

@@ -0,0 +1,128 @@
+# 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 'date'
+
+module Periodical
+	# A filter module for backup rotation like behaviour, e.g. keep every hour for 24 hours, every day for 30 days, etc.
+	module Filter
+		# Keep count sorted objects per period.
+		class Period
+			KeepOldest = Proc.new do |t1, t2|
+				t1 > t2
+			end
+
+			KeepYoungest = Proc.new do |t1, t2|
+				t1 < t2
+			end
+
+			def initialize(count)
+				@count = count
+			end
+
+			def filter(values, options = {})
+				slots = {}
+
+				keep = (options[:keep] == :youngest) ? KeepYoungest : KeepOldest
+
+				values.each do |value|
+					k = key(value)
+
+					# We want to keep the newest backup if possible (<).
+					next if slots.key?(k) and keep.call(value, slots[k])
+
+					slots[k] = value
+				end
+
+				sorted_values = slots.values.sort
+
+				return sorted_values[0...@count]
+			end
+
+			def key(t)
+				raise ArgumentError
+			end
+
+			def mktime(year, month=1, day=1, hour=0, minute=0, second=0)
+				return Time.new(year, month, day, hour, minute, second)
+			end
+
+			attr :count
+		end
+
+		class Hourly < Period
+			def key(t)
+				mktime(t.year, t.month, t.day, t.hour)
+			end
+		end
+
+		class Daily < Period
+			def key(t)
+				mktime(t.year, t.month, t.day)
+			end
+		end
+
+		class Weekly < Period
+			def key(t)
+				mktime(t.year, t.month, t.day) - (t.wday * 3600 * 24)
+			end
+		end
+
+		class Monthly < Period
+			def key(t)
+				mktime(t.year, t.month)
+			end
+		end
+
+		class Quarterly < Period
+			def key(t)
+				mktime(t.year, (t.month - 1) / 3 * 3 + 1)
+			end
+		end
+
+		class Yearly < Period
+			def key(t)
+				mktime(t.year)
+			end
+		end
+
+		class Policy
+			def initialize
+				@periods = {}
+			end
+
+			def <<(period)
+				@periods[period.class] = period
+			end
+
+			def filter(values, options = {})
+				filtered_values = Set.new
+			
+				@periods.values.each do |period|
+					filtered_values += period.filter(values, options)
+				end
+
+				return filtered_values, (Set.new(values) - filtered_values)
+			end
+
+			attr :periods
+		end
+	end
+end

data/lib/periodical/period.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 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

data/lib/periodical/version.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 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
@@ -19,11 +19,5 @@
 # THE SOFTWARE.
 
 module Periodical
-	module VERSION
-		MAJOR = 0
-		MINOR = 1
-		TINY  = 1
-
-		STRING = [MAJOR, MINOR, TINY].join('.')
-	end
+	VERSION = "0.2.0"
 end

data/periodical.gemspec

@@ -0,0 +1,24 @@
+# -*- 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.0.0"
+	spec.add_development_dependency "rake"
+end

data/spec/periodical/duration_spec.rb

@@ -0,0 +1,50 @@
+# 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

@@ -0,0 +1,63 @@
+# 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.count).to be 3
+			expect(rejected.count).to be 3
+			
+			# Keep oldest is the default policy
+			expect(selected).to be_include(dates[0])
+		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 => :youngest)
+			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

@@ -0,0 +1,33 @@
+# 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
+	end
+end

metadata

@@ -1,53 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: periodical
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-26 00:00:00.000000000 Z
-dependencies: []
+date: 2014-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: 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.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !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: 
-email: samuel.williams@oriontransfer.co.nz
+email:
+- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".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
-- lib/periodical.rb
-- test/helper.rb
-- test/test_duration.rb
-- test/test_period.rb
-- README.md
-homepage: http://www.oriontransfer.co.nz/
-licenses: []
+- periodical.gemspec
+- spec/periodical/duration_spec.rb
+- spec/periodical/filter_spec.rb
+- spec/periodical/period_spec.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Periodical is a simple framework for working with durations and periods.
-test_files: []
-has_rdoc: 
+test_files:
+- spec/periodical/duration_spec.rb
+- spec/periodical/filter_spec.rb
+- spec/periodical/period_spec.rb

data/test/helper.rb

@@ -1,4 +0,0 @@
-
-$LOAD_PATH.unshift File.expand_path("../../lib/", __FILE__)
-
-require 'test/unit'

data/test/test_duration.rb

@@ -1,34 +0,0 @@
-
-require 'helper'
-
-require 'periodical'
-
-class DurationTest < Test::Unit::TestCase
-	def setup
-	end
-	
-	def test_duration
-		duration = Periodical::Duration.new(Date.parse("2010-01-01"), Date.parse("2010-02-01"))
-		assert_equal 31, duration.days
-		assert_equal Rational(31, 7), duration.weeks
-		assert_equal 1, duration.months
-		assert_equal Rational(31, 365), duration.years
-		
-		assert_equal 1, duration.whole_months
-		assert_equal 0, duration.whole_years
-	end
-	
-	def test_weekly_period
-		duration = Periodical::Duration.new(Date.parse("2010-01-01"), Date.parse("2010-02-01"))
-		period = Periodical::Period.new(2, :weeks)
-		
-		assert_equal Rational(31, 14), duration / period
-	end
-	
-	def test_monthly_period
-		duration = Periodical::Duration.new(Date.parse("2010-01-01"), Date.parse("2011-03-01"))
-		period = Periodical::Period.new(2, :months)
-		
-		assert_equal Rational(14, 2), duration / period
-	end
-end

data/test/test_period.rb

@@ -1,15 +0,0 @@
-
-require 'helper'
-
-require 'periodical'
-
-class PeriodTest < Test::Unit::TestCase
-	def setup
-	end
-	
-	def test_advance
-		duration = Periodical::Duration.new(Date.parse("2010-01-01"), Date.parse("2011-01-01"))
-		period = Periodical::Period.new(1, :months)
-		assert_equal duration.to, period.advance(duration.from, 12)
-	end
-end