periodical 0.1.1 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87b19fdf8f3ac679f10b1be35c766f90222c8a78e1d01b99a7e097ea6d9eb391
+  data.tar.gz: 22bc626fc1c7e124490c085c80012b3f5121d800c23b922e512a24875ec99299
+SHA512:
+  metadata.gz: 823fd79066cb4b3cea6591c27710daccca0ba31d9b32d344533b969c4bc7ec48680ebbb037b6fd349eec667aedb9cb14b500b9aa0c0e715c61697ee3acc00a56
+  data.tar.gz: 5caf792943a767cdb6a3e39343c2636d742372b53a73a43996735b25498c2ea47c99fe810117126794390bcbfcfe6dc515863fce47a01895d13df71b7a24d6aa

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
@@ -21,17 +21,9 @@
 require 'date'
 
 module Periodical
-	class Duration
-		def initialize(from, to)
-			@from = from
-			@to = to
-		end
-		
-		attr :from
-		attr :to
-		
+	Duration = Struct.new(:from, :to) do
 		def days
-			@to - @from
+			to - from
 		end
 		
 		def weeks
@@ -39,29 +31,29 @@ module Periodical
 		end
 		
 		def whole_months
-			(@to.year * 12 + @to.month) - (@from.year * 12 + @from.month)
+			(to.year * 12 + to.month) - (from.year * 12 + from.month)
 		end
 		
 		def months
 			whole = self.whole_months
 			
-			partial_start = @from >> whole
-			partial_end = @from >> whole + 1
+			partial_start = from >> whole
+			partial_end = from >> whole + 1
 			
-			return whole + (@to - partial_start) / (partial_end - partial_start)
+			return whole + (to - partial_start) / (partial_end - partial_start)
 		end
 		
 		def whole_years
-			@to.year - @from.year
+			to.year - from.year
 		end
 		
 		def years
 			whole = self.whole_years
 			
-			partial_start = @from >> (whole * 12)
-			partial_end = @from >> ((whole + 1) * 12)
+			partial_start = from >> (whole * 12)
+			partial_end = from >> ((whole + 1) * 12)
 			
-			return whole + (@to - partial_start) / (partial_end - partial_start)
+			return whole + (to - partial_start) / (partial_end - partial_start)
 		end
 		
 		# Calculate the number of periods between from and to

data/lib/periodical/filter.rb

@@ -0,0 +1,138 @@
+# 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'
+require 'set'
+
+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
+			# Given times a and b, should we prefer a?
+			ORDER = {
+				# We want `a` if `a` < `b`, i.e. it's older.
+				old: ->(a, b){a < b},
+				
+				# We want `a` if `a` > `b`, i.e. it's newer.
+				new: ->(a, b){a > b}
+			}
+			
+			# @param count the number of items we should retain.
+			def initialize(count)
+				@count = count
+			end
+
+			# @param order can be a key in ORDER or a lambda.
+			# @param block is applied to the value and should typically return a Time instance.
+			def filter(values, keep: :old, &block)
+				slots = {}
+				
+				keep = ORDER.fetch(keep, keep)
+				
+				values.each do |value|
+					time = block_given? ? yield(value) : value
+					
+					granular_key = key(time)
+					
+					# We filter out this value if the slot is already full and we prefer the existing value.
+					if existing_value = slots[granular_key]
+						existing_time = block_given? ? yield(existing_value) : existing_value
+						next if keep.call(existing_time, time)
+					end
+					
+					slots[granular_key] = value
+				end
+				
+				sorted_values = slots.values.sort
+				
+				return sorted_values.first(@count)
+			end
+
+			def key(t)
+				raise NotImplementedError
+			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, &block)
+				filtered_values = Set.new
+			
+				@periods.values.each do |period|
+					filtered_values += period.filter(values, **options, &block)
+				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
@@ -19,83 +19,72 @@
 # THE SOFTWARE.
 
 module Periodical
-	class Period
-		VALID_UNITS = [:days, :weeks, :months, :years]
+	Period = Struct.new(:count, :unit) do
+		VALID_UNITS = [:days, :weeks, :months, :years].freeze
 		
-		# Accepts strings in the format of "2 weeks" or "weeks"
-		def self.parse(value)
-			if Array === value
-				parts = value
-			else
-				parts = value.to_s.split(/\s+/, 2)
-			end
-			
-			if parts.size == 1
-				if parts[0].to_i == 0
-					count = 1
-					unit = parts[0].to_sym
-				else
-					count = parts[0].to_i
-					unit = :days
-					
-					if count == 7
-						count = 1
-						unit = :weeks
-					end
-					
-					if count == 365
-						count = 1
-						unit = :years
-					end
-				end
+		# Plural is preferred, as in "1 or more days".
+		def initialize(count = 1, unit = :days)
+			super(count, unit)
+		end
+		
+		def to_s
+			if self.count != 1
+				"#{self.count} #{self.unit}"
 			else
-				count = parts[0].to_i
-				unit = parts[1].gsub(/\s+/, '_').downcase.to_sym
-			end
-			
-			unless VALID_UNITS.include? unit
-				raise ArgumentError.new("Invalid unit specified #{unit}!")
-			end
-			
-			if count == 0
-				raise ArgumentError.new("Count must be non-zero!")
+				self.unit.to_s
 			end
+		end
+		
+		def advance(date, multiple = 1)
+			raise TypeError unless date.is_a?(Date)
 			
-			return self.new(count, unit)
+			self.send("advance_#{unit}", date, multiple * self.count)
 		end
 		
-		def initialize(count = 1, unit = :days)
-			@count = count
-			@unit = unit
+		private
+		
+		def advance_days(date, count)
+			date + count
 		end
 		
-		def to_s
-			"#{@count} #{@unit}"
+		def advance_weeks(date, count)
+			advance_days(date, count*7)
 		end
 		
-		def to_formatted_s
-			if @count == 1
-				@unit.to_s.gsub(/s$/, '')
-			else
-				to_s
-			end
+		def advance_months(date, count)
+			date >> count
 		end
 		
-		def advance(date, multiple = 1)
-			total = multiple * @count
+		def advance_years(date, count)
+			advance_months(date, count*12)
+		end
+		
+		class << self
+			# Accepts strings in the format of "2 weeks" or "weeks"
+			def parse(string)
+				parts = string.split(/\s+/, 2)
+				
+				if parts.size == 1
+					count = 1
+					unit = parts[0]
+				else
+					count, unit = parts
+				end
+				
+				self.new(count.to_i, unit.to_sym)
+			end
 			
-			if unit == :days
-				date + total
-			elsif unit == :weeks
-				date + (total * 7)
-			elsif unit == :months
-				date >> total
-			elsif unit == :years
-				date >> (total * 12)
+			def load(string)
+				if string
+					string = string.strip
+					
+					parse(string) unless string.empty?
+				end
+			end
+			
+			def dump(period)
+				period.to_s if period
 			end
 		end
-		
-		attr :unit
-		attr :count
 	end
 end

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 = "1.2.0"
 end

metadata

@@ -1,53 +1,76 @@
 --- !ruby/object:Gem::Specification
 name: periodical
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Samuel Williams
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-07-26 00:00:00.000000000 Z
-dependencies: []
-description: 
-email: samuel.williams@oriontransfer.co.nz
+date: 2020-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bake-bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: bake-modernize
+  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:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- 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: []
-post_install_message: 
+homepage: https://github.com/ioquatix/periodical
+licenses:
+- MIT
+metadata:
+  funding_uri: https://github.com/sponsors/ioquatix/
+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
-signing_key: 
-specification_version: 3
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
 summary: Periodical is a simple framework for working with durations and periods.
 test_files: []
-has_rdoc: 

data/README.md

@@ -1,45 +0,0 @@
-Periodical
-=========
-
-* Author: Samuel G. D. Williams (<http://www.oriontransfer.co.nz>)
-* Copyright (C) 2012 Samuel G. D. Williams.
-* Released under the MIT license.
-
-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
------------
-
-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)
-
-License
--------
-
-Copyright (c) 2010, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
-
-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/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