timers 4.3.1 → 4.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f9fdee45ad2b102af90e2d529a1384a5f6b975d6ec3112dfafebac2d8574b0f
-  data.tar.gz: 5bec94f4fb24de10acaf4fba0e93514aa2912444f19188e6ecd1c6b6e3d25340
+  metadata.gz: 6aaa0d481ea83db607add1809f3f5d96b085bddf5bda6fa17165c18316c4c527
+  data.tar.gz: 8995d8268bd1c49b047e0fe0d1bf252d8c943962d05eee4026601b952cacc339
 SHA512:
-  metadata.gz: 712db02d6c449fca924459a952df2c9ae21058b7c492ce81d4b86f4989c69aa9ef90cc98ae421ab2f13934da6488d7d91a5718c2f1070714476147302c3d9b6e
-  data.tar.gz: c4a358d3bdc7e108afd016e42fdb478b8e717e3c400ae6cf0694e880b91112c9b118e7609d1c31143247d5d87db2577851b1e6002f2731e524a40d7e96c1cc28
+  metadata.gz: 3d5a69bc7f7e32e02365476d9a25e97dbe72c572497874356603554ecc28f5ee88821af1a2bfd4239a232f0d7a9ef0048c45a1909eefa7faae3619c51c3ec87a
+  data.tar.gz: 6521553ef5271c9191aa0dc4f23a65c3eb776293273784e46597bda0a92ae0d97aa915e4f9c25869b8923f516fe23ed2bf389abf34e1cb76ac6f5484d6d927da

checksums.yaml.gz.sig

@@ -0,0 +1,4 @@
+@BC�S���rr�H�rW
+���۳�Jc�ݠb�1ɥY���(���.W����Li����"^�'���&��.����y�2Sk\Ї7�?.q(IK��(��?�:�s
���A�(L������f8)��(0�[�
+RʞY��s����`�L[�D*t��R}MG�?�����l�Jƒ���ߩTu���mx��G��
+�W8��� u��4ټn_�D|N���[����m�1��l�U�a�Y�N.�?'	0fTtH��_r邧��i�KW�^��س�ڲN�R�o�2��~e$'��=��%���@��	H��5ŭ#�

data/lib/timers/events.rb

@@ -1,143 +1,111 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2014-2022, by Samuel Williams.
+# Copyright, 2014-2016, by Tony Arcieri.
+# Copyright, 2014, by Lavir the Whiolet.
+# Copyright, 2015, by Utenmiki.
+# Copyright, 2015, by Donovan Keme.
+# Copyright, 2021, by Wander Hillen.
 
 require_relative "timer"
+require_relative "priority_heap"
 
 module Timers
-	# Maintains an ordered list of events, which can be cancelled.
+	# Maintains a PriorityHeap of events ordered on time, which can be cancelled.
 	class Events
 		# Represents a cancellable handle for a specific timer event.
 		class Handle
+			include Comparable
+			
 			def initialize(time, callback)
 				@time = time
 				@callback = callback
 			end
-
+			
 			# The absolute time that the handle should be fired at.
 			attr_reader :time
-
+			
 			# Cancel this timer, O(1).
 			def cancel!
 				# The simplest way to keep track of cancelled status is to nullify the
 				# callback. This should also be optimal for garbage collection.
 				@callback = nil
 			end
-
+			
 			# Has this timer been cancelled? Cancelled timer's don't fire.
 			def cancelled?
 				@callback.nil?
 			end
-
-			def > other
-				@time > other.to_f
-			end
-
-			def >= other
-				@time >= other.to_f
-			end
-
-			def to_f
-				@time
+			
+			def <=> other
+				@time <=> other.time
 			end
-
+			
 			# Fire the callback if not cancelled with the given time parameter.
 			def fire(time)
 				@callback.call(time) if @callback
 			end
 		end
-
+		
 		def initialize
 			# A sequence of handles, maintained in sorted order, future to present.
 			# @sequence.last is the next event to be fired.
-			@sequence = []
+			@sequence = PriorityHeap.new
 			@queue = []
 		end
-
+		
 		# Add an event at the given time.
 		def schedule(time, callback)
+			flush!
+			
 			handle = Handle.new(time.to_f, callback)
 			
 			@queue << handle
 			
 			return handle
 		end
-
+		
 		# Returns the first non-cancelled handle.
 		def first
 			merge!
 			
-			while (handle = @sequence.last)
+			while (handle = @sequence.peek)
 				return handle unless handle.cancelled?
 				@sequence.pop
 			end
 		end
-
+		
 		# Returns the number of pending (possibly cancelled) events.
 		def size
 			@sequence.size + @queue.size
 		end
-
+		
 		# Fire all handles for which Handle#time is less than the given time.
 		def fire(time)
 			merge!
 			
-			while handle = @sequence.last and handle.time <= time
+			while handle = @sequence.peek and handle.time <= time
 				@sequence.pop
 				handle.fire(time)
 			end
 		end
-
+		
 		private
-
+		
+		# Move all non-cancelled timers from the pending queue to the priority heap
 		def merge!
 			while handle = @queue.pop
 				next if handle.cancelled?
 				
-				index = bisect_right(@sequence, handle)
-				
-				if current_handle = @sequence[index] and current_handle.cancelled?
-					# puts "Replacing handle at index: #{index} due to cancellation in array containing #{@sequence.size} item(s)."
-					@sequence[index] = handle
-				else
-					# puts "Inserting handle at index: #{index} in array containing #{@sequence.size} item(s)."
-					@sequence.insert(index, handle)
-				end
+				@sequence.push(handle)
 			end
 		end
-
-		# Return the right-most index where to insert item e, in a list a, assuming
-		# a is sorted in descending order.
-		def bisect_right(a, e, l = 0, u = a.length)
-			while l < u
-				m = l + (u - l).div(2)
-
-				if a[m] >= e
-					l = m + 1
-				else
-					u = m
-				end
+		
+		def flush!
+			while @queue.last&.cancelled?
+				@queue.pop
 			end
-
-			l
 		end
 	end
 end

data/lib/timers/group.rb

@@ -1,24 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2014-2022, by Samuel Williams.
+# Copyright, 2014-2016, by Tony Arcieri.
+# Copyright, 2015, by Donovan Keme.
+# Copyright, 2015, by Tommy Ong Gia Phu.
 
 require "set"
 require "forwardable"
@@ -31,62 +17,62 @@ module Timers
 	# A collection of timers which may fire at different times
 	class Group
 		include Enumerable
-
+		
 		extend Forwardable
 		def_delegators :@timers, :each, :empty?
-
+		
 		def initialize
 			@events = Events.new
-
+			
 			@timers = Set.new
 			@paused_timers = Set.new
-
+			
 			@interval = Interval.new
 			@interval.start
 		end
-
+		
 		# Scheduled events:
 		attr_reader :events
-
+		
 		# Active timers:
 		attr_reader :timers
-
+		
 		# Paused timers:
 		attr_reader :paused_timers
-
+		
 		# Call the given block after the given interval. The first argument will be
 		# the time at which the group was asked to fire timers for.
 		def after(interval, &block)
 			Timer.new(self, interval, false, &block)
 		end
-
+		
 		# Call the given block immediately, and then after the given interval. The first
 		# argument will be the time at which the group was asked to fire timers for.
 		def now_and_after(interval, &block)
 			yield
 			after(interval, &block)
 		end
-
+		
 		# Call the given block periodically at the given interval. The first
 		# argument will be the time at which the group was asked to fire timers for.
 		def every(interval, recur = true, &block)
 			Timer.new(self, interval, recur, &block)
 		end
-
+		
 		# Call the given block immediately, and then periodically at the given interval. The first
 		# argument will be the time at which the group was asked to fire timers for.
 		def now_and_every(interval, recur = true, &block)
 			yield
 			every(interval, recur, &block)
 		end
-
+		
 		# Wait for the next timer and fire it. Can take a block, which should behave
 		# like sleep(n), except that n may be nil (sleep forever) or a negative
 		# number (fire immediately after return).
 		def wait
 			if block_given?
 				yield wait_interval
-
+				
 				while (interval = wait_interval) && interval > 0
 					yield interval
 				end
@@ -99,7 +85,7 @@ module Timers
 			
 			fire
 		end
-
+		
 		# Interval to wait until when the next timer will fire.
 		# - nil: no timers
 		# - -ve: timers expired already
@@ -109,36 +95,36 @@ module Timers
 			handle = @events.first
 			handle.time - Float(offset) if handle
 		end
-
+		
 		# Fire all timers that are ready.
 		def fire(offset = current_offset)
 			@events.fire(offset)
 		end
-
+		
 		# Pause all timers.
 		def pause
 			@timers.dup.each(&:pause)
 		end
-
+		
 		# Resume all timers.
 		def resume
 			@paused_timers.dup.each(&:resume)
 		end
-
+		
 		alias continue resume
-
+		
 		# Delay all timers.
 		def delay(seconds)
 			@timers.each do |timer|
 				timer.delay(seconds)
 			end
 		end
-
+		
 		# Cancel all timers.
 		def cancel
 			@timers.dup.each(&:cancel)
 		end
-
+		
 		# The group's current time.
 		def current_offset
 			@interval.to_f

data/lib/timers/interval.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2018-2022, by Samuel Williams.
 
 module Timers
 	# A collection of timers which may fire at different times

data/lib/timers/priority_heap.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2021, by Wander Hillen.
+# Copyright, 2021-2022, by Samuel Williams.
+
+module Timers
+	# A priority queue implementation using a standard binary minheap. It uses straight comparison
+	# of its contents to determine priority. This works because a Handle from Timers::Events implements
+	# the '<' operation by comparing the expiry time.
+	# See <https://en.wikipedia.org/wiki/Binary_heap> for explanations of the main methods.
+	class PriorityHeap
+		def initialize
+			# The heap is represented with an array containing a binary tree. See
+			# https://en.wikipedia.org/wiki/Binary_heap#Heap_implementation for how this array
+			# is built up.
+			@contents = []
+		end
+		
+		# Returns the earliest timer or nil if the heap is empty.
+		def peek
+			@contents[0]
+		end
+		
+		# Returns the number of elements in the heap
+		def size
+			@contents.size
+		end
+		
+		# Returns the earliest timer if the heap is non-empty and removes it from the heap.
+		# Returns nil if the heap is empty. (and doesn't change the heap in that case)
+		def pop
+			# If the heap is empty:
+			if @contents.empty?
+				return nil
+			end
+			
+			# If we have only one item, no swapping is required:
+			if @contents.size == 1
+				return @contents.pop
+			end
+			
+			# Take the root of the tree:
+			value = @contents[0]
+			
+			# Remove the last item in the tree:
+			last = @contents.pop
+			
+			# Overwrite the root of the tree with the item:
+			@contents[0] = last
+			
+			# Bubble it down into place:
+			bubble_down(0)
+			
+			# validate!
+			
+			return value
+		end
+		
+		# Inserts a new timer into the heap, then rearranges elements until the heap invariant is true again.
+		def push(element)
+			# Insert the item at the end of the heap:
+			@contents.push(element)
+			
+			# Bubble it up into position:
+			bubble_up(@contents.size - 1)
+			
+			# validate!
+			
+			return self
+		end
+		
+    # Empties out the heap, discarding all elements
+		def clear!
+      @contents = []
+    end
+
+		# Validate the heap invariant. Every element except the root must not be smaller than
+    # its parent element. Note that it MAY be equal.
+		def valid?
+      # notice we skip index 0 on purpose, because it has no parent
+      (1..(@contents.size - 1)).all? { |e| @contents[e] >= @contents[(e - 1) / 2] }
+		end
+
+		private
+		
+		def swap(i, j)
+			@contents[i], @contents[j] = @contents[j], @contents[i]
+		end
+		
+		def bubble_up(index)
+			parent_index = (index - 1) / 2 # watch out, integer division!
+			
+			while index > 0 && @contents[index] < @contents[parent_index]
+				# if the node has a smaller value than its parent, swap these nodes
+				# to uphold the minheap invariant and update the index of the 'current'
+				# node. If the node is already at index 0, we can also stop because that
+				# is the root of the heap.
+				# swap(index, parent_index)
+				@contents[index], @contents[parent_index] = @contents[parent_index], @contents[index]
+				
+				index = parent_index
+				parent_index = (index - 1) / 2 # watch out, integer division!
+			end
+		end
+		
+		def bubble_down(index)
+			swap_value = 0
+			swap_index = nil
+			
+			while true
+				left_index = (2 * index) + 1
+				left_value = @contents[left_index]
+				
+				if left_value.nil?
+					# This node has no children so it can't bubble down any further.
+					# We're done here!
+					return
+				end
+				
+				# Determine which of the child nodes has the smallest value:
+				right_index = left_index + 1
+				right_value = @contents[right_index]
+				
+				if right_value.nil? or right_value > left_value
+					swap_value = left_value
+					swap_index = left_index
+				else
+					swap_value = right_value
+					swap_index = right_index
+				end
+				
+				if @contents[index] < swap_value
+					# No need to swap, the minheap invariant is already satisfied:
+					return
+				else
+					# At least one of the child node has a smaller value than the current node, swap current node with that child and update current node for if it might need to bubble down even further:
+					# swap(index, swap_index)
+					@contents[index], @contents[swap_index] = @contents[swap_index], @contents[index]
+					
+					index = swap_index
+				end
+			end
+		end
+	end
+end

data/lib/timers/timer.rb

@@ -1,24 +1,11 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2014-2022, by Samuel Williams.
+# Copyright, 2014-2017, by Tony Arcieri.
+# Copyright, 2014, by Utenmiki.
+# Copyright, 2014, by Lin Jen-Shin.
+# Copyright, 2017, by Vít Ondruch.
 
 module Timers
 	# An individual timer set to fire a given proc at a given time. A timer is
@@ -29,66 +16,66 @@ module Timers
 	class Timer
 		include Comparable
 		attr_reader :interval, :offset, :recurring
-
+		
 		def initialize(group, interval, recurring = false, offset = nil, &block)
 			@group = group
-
+			
 			@interval = interval
 			@recurring = recurring
 			@block = block
 			@offset = offset
-
+			
 			@handle = nil
-
+			
 			# If a start offset was supplied, use that, otherwise use the current timers offset.
 			reset(@offset || @group.current_offset)
 		end
-
+		
 		def paused?
 			@group.paused_timers.include? self
 		end
-
+		
 		def pause
 			return if paused?
-
+			
 			@group.timers.delete self
 			@group.paused_timers.add self
-
+			
 			@handle.cancel! if @handle
 			@handle = nil
 		end
-
+		
 		def resume
 			return unless paused?
-
+			
 			@group.paused_timers.delete self
-
+			
 			# This will add us back to the group:
 			reset
 		end
-
+		
 		alias continue resume
-
+		
 		# Extend this timer
 		def delay(seconds)
 			@handle.cancel! if @handle
-
+			
 			@offset += seconds
-
+			
 			@handle = @group.events.schedule(@offset, self)
 		end
-
+		
 		# Cancel this timer. Do not call while paused.
 		def cancel
 			return unless @handle
-
+			
 			@handle.cancel! if @handle
 			@handle = nil
-
+			
 			# This timer is no longer valid:
 			@group.timers.delete self if @group
 		end
-
+		
 		# Reset this timer. Do not call while paused.
 		# @param offset [Numeric] the duration to add to the timer.
 		def reset(offset = @group.current_offset)
@@ -99,12 +86,12 @@ module Timers
 			else
 				@group.timers << self
 			end
-
+			
 			@offset = Float(offset) + @interval
-
+			
 			@handle = @group.events.schedule(@offset, self)
 		end
-
+		
 		# Fire the block.
 		def fire(offset = @group.current_offset)
 			if recurring == :strict
@@ -115,36 +102,38 @@ module Timers
 			else
 				@offset = offset
 			end
-
+			
 			@block.call(offset, self)
-
+			
 			cancel unless recurring
 		end
-
+		
 		alias call fire
-
+		
 		# Number of seconds until next fire / since last fire
 		def fires_in
 			@offset - @group.current_offset if @offset
 		end
-
+		
 		# Inspect a timer
 		def inspect
-			str = "#{to_s[0..-2]} ".dup
-
+			buffer = "#{to_s[0..-2]} ".dup
+			
 			if @offset
-				str << if fires_in >= 0
-								 "fires in #{fires_in} seconds"
-							 else
-								 "fired #{fires_in.abs} seconds ago"
-							 end
-
-				str << ", recurs every #{interval}" if recurring
+				if fires_in >= 0
+					buffer << "fires in #{fires_in} seconds"
+				else
+					buffer << "fired #{fires_in.abs} seconds ago"
+				end
+				
+				buffer << ", recurs every #{interval}" if recurring
 			else
-				str << "dead"
+				buffer << "dead"
 			end
-
-			str << ">"
+			
+			buffer << ">"
+			
+			return buffer
 		end
 	end
 end

data/lib/timers/version.rb

@@ -1,25 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2012-2016, by Tony Arcieri.
+# Copyright, 2014-2022, by Samuel Williams.
+# Copyright, 2015, by Donovan Keme.
 
 module Timers
-	VERSION = "4.3.1"
+	VERSION = "4.3.4"
 end

data/lib/timers/wait.rb

@@ -1,24 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2014-2022, by Samuel Williams.
+# Copyright, 2014-2016, by Tony Arcieri.
+# Copyright, 2015, by Utenmiki.
+# Copyright, 2015, by Donovan Keme.
 
 require_relative "interval"
 
@@ -28,7 +14,7 @@ module Timers
 		def self.for(duration, &block)
 			if duration
 				timeout = new(duration)
-
+				
 				timeout.while_time_remaining(&block)
 			else
 				loop do
@@ -36,31 +22,31 @@ module Timers
 				end
 			end
 		end
-
+		
 		def initialize(duration)
 			@duration = duration
 			@remaining = true
 		end
-
+		
 		attr_reader :duration
 		attr_reader :remaining
-
+		
 		# Yields while time remains for work to be done:
 		def while_time_remaining
 			@interval = Interval.new
 			@interval.start
-
+			
 			yield @remaining while time_remaining?
 		ensure
 			@interval.stop
 			@interval = nil
 		end
-
+		
 		private
-
+		
 		def time_remaining?
 			@remaining = (@duration - @interval.to_f)
-
+			
 			@remaining > 0
 		end
 	end

data/lib/timers.rb

@@ -1,24 +1,19 @@
 # frozen_string_literal: true
 
-# Copyright, 2020, 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.
+# Released under the MIT License.
+# Copyright, 2012-2016, by Tony Arcieri.
+# Copyright, 2012, by Ryan LeCompte.
+# Copyright, 2012, by Nicholas Evans.
+# Copyright, 2012, by Dimitrij Denissenko.
+# Copyright, 2013, by Chuck Remes.
+# Copyright, 2013, by Ron Evans.
+# Copyright, 2013, by Sean Gregory.
+# Copyright, 2013, by Utenmiki.
+# Copyright, 2013, by Jeremy Hinegardner.
+# Copyright, 2014, by Larry Lv.
+# Copyright, 2014, by Bruno Enten.
+# Copyright, 2014-2022, by Samuel Williams.
+# Copyright, 2014, by Mike Bourgeous.
 
 require_relative "timers/version"
 

data/license.md

@@ -0,0 +1,48 @@
+# MIT License
+
+Copyright, 2012-2017, by Tony Arcieri.  
+Copyright, 2012, by Ryan LeCompte.  
+Copyright, 2012, by Jesse Cooke.  
+Copyright, 2012, by Nicholas Evans.  
+Copyright, 2012, by Dimitrij Denissenko.  
+Copyright, 2013, by Chuck Remes.  
+Copyright, 2013, by Ron Evans.  
+Copyright, 2013, by Sean Gregory.  
+Copyright, 2013-2015, by Utenmiki.  
+Copyright, 2013, by Jeremy Hinegardner.  
+Copyright, 2014, by Larry Lv.  
+Copyright, 2014, by Bruno Enten.  
+Copyright, 2014-2022, by Samuel Williams.  
+Copyright, 2014, by Mike Bourgeous.  
+Copyright, 2014, by Klaus Trainer.  
+Copyright, 2014, by Lin Jen-Shin.  
+Copyright, 2014, by Lavir the Whiolet.  
+Copyright, 2015-2016, by Donovan Keme.  
+Copyright, 2015, by Tommy Ong Gia Phu.  
+Copyright, 2015, by Will Jessop.  
+Copyright, 2016, by Ryunosuke SATO.  
+Copyright, 2016, by Atul Bhosale.  
+Copyright, 2016, by Feram.  
+Copyright, 2017, by Vít Ondruch.  
+Copyright, 2017-2020, by Olle Jonsson.  
+Copyright, 2020, by Tim Smith.  
+Copyright, 2021, by Wander Hillen.  
+Copyright, 2022, by Yoshiki Takagi.  
+
+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/readme.md

@@ -0,0 +1,110 @@
+# Timers
+
+Collections of one-shot and periodic timers, intended for use with event loops such as [async](https://github.com/socketry/async).
+
+[![Development Status](https://github.com/socketry/timers/workflows/Test/badge.svg)](https://github.com/socketry/timers/actions?workflow=Test)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'timers'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install timers
+
+## Usage
+
+Create a new timer group with `Timers::Group.new`:
+
+``` ruby
+require 'timers'
+
+timers = Timers::Group.new
+```
+
+Schedule a proc to run after 5 seconds with `Timers::Group#after`:
+
+``` ruby
+five_second_timer = timers.after(5) { puts "Take five" }
+```
+
+The `five_second_timer` variable is now bound to a Timers::Timer object. To
+cancel a timer, use `Timers::Timer#cancel`
+
+Once you've scheduled a timer, you can wait until the next timer fires with `Timers::Group#wait`:
+
+``` ruby
+# Waits 5 seconds
+timers.wait
+
+# The script will now print "Take five"
+```
+
+You can schedule a block to run periodically with `Timers::Group#every`:
+
+``` ruby
+every_five_seconds = timers.every(5) { puts "Another 5 seconds" }
+
+loop { timers.wait }
+```
+
+You can also schedule a block to run immediately and periodically with `Timers::Group#now_and_every`:
+
+``` ruby
+now_and_every_five_seconds = timers.now_and_every(5) { puts "Now and in another 5 seconds" }
+
+loop { timers.wait }
+```
+
+If you'd like another method to do the waiting for you, e.g. `Kernel.select`,
+you can use `Timers::Group#wait_interval` to obtain the amount of time to wait. When
+a timeout is encountered, you can fire all pending timers with `Timers::Group#fire`:
+
+``` ruby
+loop do
+  interval = timers.wait_interval
+  ready_readers, ready_writers = select readers, writers, nil, interval
+
+  if ready_readers || ready_writers
+    # Handle IO
+    ...
+  else
+    # Timeout!
+    timers.fire
+  end
+end
+```
+
+You can also pause and continue individual timers, or all timers:
+
+``` ruby
+paused_timer = timers.every(5) { puts "I was paused" }
+
+paused_timer.pause
+10.times { timers.wait } # will not fire paused timer
+
+paused_timer.resume
+10.times { timers.wait } # will fire timer
+
+timers.pause
+10.times { timers.wait } # will not fire any timers
+
+timers.resume
+10.times { timers.wait } # will fire all timers
+```
+
+## 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

metadata

@@ -1,15 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: timers
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.3.4
 platform: ruby
 authors:
-- Samuel Williams
 - Tony Arcieri
+- Samuel Williams
+- "//de"
+- Wander Hillen
+- Jeremy Hinegardner
+- skinnyjames
+- Chuck Remes
+- utenmiki
+- Olle Jonsson
+- deadprogrammer
+- takiy33
+- Larry Lv
+- Lin Jen-Shin
+- Ryunosuke SATO
+- Tommy Ong Gia Phu
+- Atul Bhosale
+- Bruno Enten
+- Dimitrij Denissenko
+- Donovan Keme
+- Feram
+- Jesse Cooke
+- Klaus Trainer
+- Lavir the Whiolet
+- Mike Bourgeous
+- Ryan LeCompte
+- Tim Smith
+- Vít Ondruch
+- Will Jessop
+- Yoshiki Takagi
+- nicholas a. evans
+- tommyogp
 autorequire:
 bindir: bin
-cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2022-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -40,19 +98,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bake-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bake-test-external
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: sus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 description:
 email:
 executables: []
@@ -63,9 +149,12 @@ files:
 - lib/timers/events.rb
 - lib/timers/group.rb
 - lib/timers/interval.rb
+- lib/timers/priority_heap.rb
 - lib/timers/timer.rb
 - lib/timers/version.rb
 - lib/timers/wait.rb
+- license.md
+- readme.md
 homepage: https://github.com/socketry/timers
 licenses:
 - MIT
@@ -78,14 +167,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Pure Ruby one-shot and periodic timers.