lib/timers/timer.rb in timers-4.1.2 vs lib/timers/timer.rb in timers-4.2.0

@@ -1,129 +1,134 @@
 # frozen_string_literal: true
+#
+# This file is part of the "timers" project and released under the MIT license.
+#
+# Copyright, 2018, by Samuel Williams. All rights reserved.
+#
 
 module Timers
-  # An individual timer set to fire a given proc at a given time. A timer is
-  # always connected to a Timer::Group but it would ONLY be in @group.timers
-  # if it also has a @handle specified. Otherwise it is either PAUSED or has
-  # been FIRED and is not recurring. You can manually enter this state by
-  # calling #cancel and resume normal operation by calling #reset.
-  class Timer
-    include Comparable
-    attr_reader :interval, :offset, :recurring
+	# An individual timer set to fire a given proc at a given time. A timer is
+	# always connected to a Timer::Group but it would ONLY be in @group.timers
+	# if it also has a @handle specified. Otherwise it is either PAUSED or has
+	# been FIRED and is not recurring. You can manually enter this state by
+	# calling #cancel and resume normal operation by calling #reset.
+	class Timer
+		include Comparable
+		attr_reader :interval, :offset, :recurring
 
-    def initialize(group, interval, recurring = false, offset = nil, &block)
-      @group = group
+		def initialize(group, interval, recurring = false, offset = nil, &block)
+			@group = group
 
-      @interval = interval
-      @recurring = recurring
-      @block = block
-      @offset = offset
+			@interval = interval
+			@recurring = recurring
+			@block = block
+			@offset = offset
 
-      @handle = nil
+			@handle = nil
 
-      # If a start offset was supplied, use that, otherwise use the current timers offset.
-      reset(@offset || @group.current_offset)
-    end
+			# 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 paused?
+			@group.paused_timers.include? self
+		end
 
-    def pause
-      return if paused?
+		def pause
+			return if paused?
 
-      @group.timers.delete self
-      @group.paused_timers.add self
+			@group.timers.delete self
+			@group.paused_timers.add self
 
-      @handle.cancel! if @handle
-      @handle = nil
-    end
+			@handle.cancel! if @handle
+			@handle = nil
+		end
 
-    def resume
-      return unless paused?
+		def resume
+			return unless paused?
 
-      @group.paused_timers.delete self
+			@group.paused_timers.delete self
 
-      # This will add us back to the group:
-      reset
-    end
+			# This will add us back to the group:
+			reset
+		end
 
-    alias continue resume
+		alias continue resume
 
-    # Extend this timer
-    def delay(seconds)
-      @handle.cancel! if @handle
+		# Extend this timer
+		def delay(seconds)
+			@handle.cancel! if @handle
 
-      @offset += seconds
+			@offset += seconds
 
-      @handle = @group.events.schedule(@offset, self)
-    end
+			@handle = @group.events.schedule(@offset, self)
+		end
 
-    # Cancel this timer. Do not call while paused.
-    def cancel
-      return unless @handle
+		# Cancel this timer. Do not call while paused.
+		def cancel
+			return unless @handle
 
-      @handle.cancel! if @handle
-      @handle = nil
+			@handle.cancel! if @handle
+			@handle = nil
 
-      # This timer is no longer valid:
-      @group.timers.delete self if @group
-    end
+			# This timer is no longer valid:
+			@group.timers.delete self if @group
+		end
 
-    # Reset this timer. Do not call while paused.
-    def reset(offset = @group.current_offset)
-      # This logic allows us to minimise the interaction with @group.timers.
-      # A timer with a handle is always registered with the group.
-      if @handle
-        @handle.cancel!
-      else
-        @group.timers << self
-      end
+		# Reset this timer. Do not call while paused.
+		def reset(offset = @group.current_offset)
+			# This logic allows us to minimise the interaction with @group.timers.
+			# A timer with a handle is always registered with the group.
+			if @handle
+				@handle.cancel!
+			else
+				@group.timers << self
+			end
 
-      @offset = Float(offset) + @interval
+			@offset = Float(offset) + @interval
 
-      @handle = @group.events.schedule(@offset, self)
-    end
+			@handle = @group.events.schedule(@offset, self)
+		end
 
-    # Fire the block.
-    def fire(offset = @group.current_offset)
-      if recurring == :strict
-        # ... make the next interval strictly the last offset + the interval:
-        reset(@offset)
-      elsif recurring
-        reset(offset)
-      else
-        @offset = offset
-      end
+		# Fire the block.
+		def fire(offset = @group.current_offset)
+			if recurring == :strict
+				# ... make the next interval strictly the last offset + the interval:
+				reset(@offset)
+			elsif recurring
+				reset(offset)
+			else
+				@offset = offset
+			end
 
-      @block.call(offset)
+			@block.call(offset)
 
-      cancel unless recurring
-    end
+			cancel unless recurring
+		end
 
-    alias call fire
+		alias call fire
 
-    # Number of seconds until next fire / since last fire
-    def fires_in
-      @offset - @group.current_offset if @offset
-    end
+		# 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 = "#<Timers::Timer:#{object_id.to_s(16)} ".dup
+		# Inspect a timer
+		def inspect
+			str = "#{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
+			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
-      else
-        str << "dead"
-      end
+				str << ", recurs every #{interval}" if recurring
+			else
+				str << "dead"
+			end
 
-      str << ">"
-    end
-  end
+			str << ">"
+		end
+	end
 end