gnomon 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d6ac6a22cc7a52bc3b6a2c383c1e2344d44d454
-  data.tar.gz: 045af89d5a19b62c645ad48b1ca4712d67dab9a6
+  metadata.gz: b469cb0fddada2cb893d4139ce126ea9e5aa143d
+  data.tar.gz: e697d7b0d9f83b3dd2bdee5f40739f7e681428fa
 SHA512:
-  metadata.gz: be8b7c47100ecdd3933f0b1039d7b25660d56fb5d6863f2739454d54c3d9edcbed443e0f5d6953c9784273b755fe37271ad7642d675d271663d74991b0d1f866
-  data.tar.gz: 66876c4b85a48ad4fefcba1a228aac04e7ad504f1fe9c7415e4a1cbc9abeb4893757bdb90f09359d025c7b6c9e222ef13a1b0c621645b70b0e58fbf8a27d8817
+  metadata.gz: 6c9070fff89e68b8fa340e9857caf08ffdab3516bb53a108a4c06be4484c77b02e1bd24e5a2e85be27967e9a5f591a88463df8f23b0b195c3266d21db461e782
+  data.tar.gz: 962f27e6d37f823e187d767dc533f64a5474582269745bc3508f947dc799ea06525b19463417e66d6afc1fef54888fe4d88b8e6616ffee1330491643612ea778

data/lib/gnomon.rb

@@ -20,6 +20,8 @@ class Gnomon
 	DEFAULT_GRANULARITY = 1
 
 	# Construct
+	# Creates a new Gnomon instance
+	# @param [Float] granularity The desired resolution of the event queue, in seconds
 	def initialize granularity = DEFAULT_GRANULARITY
 
 		# Set Granularity
@@ -36,6 +38,13 @@ class Gnomon
 	end
 
 	# Schedule Event
+	# Schedules a generic event
+	# @param [Object] id An ID for later de-scheduling of this event
+	# @param [Symbol] mode The mode of scheduling - can be any of [ :at, :in, :every ]
+	# @param [Hash] mode_options Mode-specific options hash - See documentation for desired mode
+	# @param [Object] timespec Mode-specific time-specification for 'when' to trigger the event
+	# @param [Object] args Arguments to be passed as-is to the event's block upon execution
+	# @param [Object] block A block to be executed upon event trigger
 	def schedule id, mode, mode_options, timespec, *args, &block
 
 		# Synchronize
@@ -60,21 +69,40 @@ class Gnomon
 	end
 
 	# Schedule Event at a given date/time
+	# Shortcut to schedule an event to be triggered once at a specific date/time
+	# @param [Object] id
+	# @param [String] date_time A date / time string
+	# @param [Object] args
+	# @param [Object] block
 	def schedule_at id, date_time, *args, &block
 		schedule id, :at, {}, date_time, *args, &block
 	end
 
 	# Schedule Event in a given number of seconds
+	# Shortcut to schedule an event to be triggered once after a given amount of time
+	# @param [Object] id
+	# @param [Float] time
+	# @param [Object] args
+	# @param [Object] block
 	def schedule_in id, time, *args, &block
 		schedule id, :in, {}, time, *args, &block
 	end
 
 	# Schedule Event at a given interval (seconds)
+	# Shortcut to schedule an event to be triggered periodically at a given time interval
+	# @param [Object] id
+	# @param [Float] interval
+	# @param [boolean] async When true, schedule the next trigger before actually running the event's block - otherwise, schedule the next trigger only once the event block completes
+	# @param [Object] args
+	# @param [Object] block
 	def schedule_every id, interval, async, *args, &block
 		schedule id, :every, { async: async }, interval, *args, &block
 	end
 
 	# De-schedule
+	# Removes one or more previously-scheduled events from the scheduler
+	# @param [Object] id The ID of the event(s) to remove (all events with this ID will be removed)
+	# @param [Object] keep_running When true, the next trigger is maintained
 	def deschedule id, keep_running = false
 
 		# Synchronize
@@ -93,6 +121,8 @@ class Gnomon
 	private
 
 	# Enqueue Next Run
+	# Registers the next run for a given event into the event queue
+	# @param [Hash] event
 	def enqueue_next_run event
 		next_run = next_run event[:mode], event[:ts]
 		pos = @equeue.index { |p| p[:next_run] >= next_run } || 0
@@ -100,6 +130,10 @@ class Gnomon
 	end
 
 	# Determine Next Run
+	# Determines when to trigger the next run for a given event
+	# @param [Symbol] mode
+	# @param [Object] ts
+	# @return [Float] A floating-point timestamp representing the time at which to trigger the next run
 	def next_run mode, ts
 		case mode
 			when :at
@@ -112,11 +146,13 @@ class Gnomon
 	end
 
 	# Run
+	# Main Loop
 	def run
 		update until @stop
 	end
 
 	# Update
+	# Update Gnomon's internal states
 	def update
 
 		# Synchronize { Trigger Next Event in Queue }
@@ -127,6 +163,8 @@ class Gnomon
 	end
 
 	# Trigger Event
+	# Triggers an event, executing its block and re-scheduling the next run when appropriate
+	# @param [Hash] event
 	def trigger event
 
 		# Spawn Thread around Event's Block

data/lib/gnomon/version.rb

@@ -5,5 +5,5 @@
 class Gnomon
 
 	# Version
-	VERSION = '0.1.4'
+	VERSION = '0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gnomon
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Eresse