periodical 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5d5f44fda3a8acc8323a74e2133d65c91adccbe
-  data.tar.gz: f5d2c4f492dba6f84a1206d562886bea742f7c0d
+  metadata.gz: 2555e6758e16ddd84d99a9f56a223cd8c19cdfe1
+  data.tar.gz: 3187ffebf9e51e9175a76d2321ea1b2c2b516b3a
 SHA512:
-  metadata.gz: 443f7a20e40c12764d8e148f7aa6436509e1a547a154114fcd9dfbbc822f232ddcc6156dc8d90247271a7a980a105e619e16c6d3d78261cab753e7b6bded3a3b
-  data.tar.gz: e7defa3af54ceebdaac4f9e64d59c723d92a316128fb395b01c80570ca3f990c8d64bb1706690fd7f012fb6e304cab994d0bf222247c6ec01d39b254afbc2b06
+  metadata.gz: 7adb54adb0d5d51a4193e8519497f57412beeb043ca4c145f850894e59cb684e25e149ec29c414fc51991f40ebcd5a2c0451da5d25809492ef81a549757054c8
+  data.tar.gz: 92a27112f8b1c656b5e7f368dfd6f776c3ee017243656c75785a94640c64df4febe673cd8e8c8c634ca449b6d204daafae9cf4ac4209b8a22752c4274dde02cc

data/lib/periodical/filter.rb

@@ -26,35 +26,44 @@ module Periodical
 	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
-
+			# 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
 
-			def filter(values, options = {})
+			# @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 = (options[:keep] == :youngest) ? KeepYoungest : KeepOldest
-
+				
+				keep = ORDER.fetch(keep, keep)
+				
 				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
+					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[0...@count]
+				
+				return sorted_values.first(@count)
 			end
 
 			def key(t)
@@ -113,11 +122,11 @@ module Periodical
 				@periods[period.class] = period
 			end
 
-			def filter(values, options = {})
+			def filter(values, **options, &block)
 				filtered_values = Set.new
 			
 				@periods.values.each do |period|
-					filtered_values += period.filter(values, options)
+					filtered_values += period.filter(values, **options, &block)
 				end
 
 				return filtered_values, (Set.new(values) - filtered_values)

data/lib/periodical/version.rb

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

data/spec/periodical/filter_spec.rb

@@ -36,11 +36,9 @@ module Periodical::PeriodSpec
 			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])
+			expect(selected).to include(*dates.first(3))
+			expect(rejected).to include(*dates.last(3))
 		end
 		
 		it "should keep youngest" do
@@ -52,7 +50,7 @@ module Periodical::PeriodSpec
 			policy = Periodical::Filter::Policy.new
 			policy << Periodical::Filter::Monthly.new(1)
 			
-			selected, rejected = policy.filter(dates, :keep => :youngest)
+			selected, rejected = policy.filter(dates, :keep => :new)
 			expect(selected.count).to be 1
 			expect(rejected.count).to be 1
 			

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: periodical
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Samuel Williams