gnomon 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b469cb0fddada2cb893d4139ce126ea9e5aa143d
-  data.tar.gz: e697d7b0d9f83b3dd2bdee5f40739f7e681428fa
+  metadata.gz: 2df2fb4bd5565c7a0e51b29646d1a403e6d083e9
+  data.tar.gz: bd3ecdcfb103a8078f8fdc26a7c5becd2d278ae7
 SHA512:
-  metadata.gz: 6c9070fff89e68b8fa340e9857caf08ffdab3516bb53a108a4c06be4484c77b02e1bd24e5a2e85be27967e9a5f591a88463df8f23b0b195c3266d21db461e782
-  data.tar.gz: 962f27e6d37f823e187d767dc533f64a5474582269745bc3508f947dc799ea06525b19463417e66d6afc1fef54888fe4d88b8e6616ffee1330491643612ea778
+  metadata.gz: 0136237e49d7ca5b449e42320e26d5b416654cfee9f95adf4c8a4b3c0e29da9d0c2a2baef135b09deb0186c7e0ce00ab99ae9509f45b47f1300cc0b5cd0cb401
+  data.tar.gz: aff7291a48f8d79739d4022d3dd165df498f23d1df6fc895596ed3e8284f2e749ba604ee860910d119517bfa31449b19d4e06228a667e58db3d966114fbacc3d

data/lib/gnomon.rb

@@ -9,8 +9,8 @@ require 'date'
 require 'thread'
 require 'runify'
 
-# Gnomon Class
-# Root Class for Gnomon
+# Gnomon Class:
+# Root Class for Gnomon.
 class Gnomon
 
 	# Runify
@@ -19,8 +19,8 @@ class Gnomon
 	# Defaults
 	DEFAULT_GRANULARITY = 1
 
-	# Construct
-	# Creates a new Gnomon instance
+	# Construct:
+	# Creates a new Gnomon instance.
 	# @param [Float] granularity The desired resolution of the event queue, in seconds
 	def initialize granularity = DEFAULT_GRANULARITY
 
@@ -37,8 +37,8 @@ class Gnomon
 		@lock = Mutex.new
 	end
 
-	# Schedule Event
-	# Schedules a generic event
+	# 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
@@ -68,8 +68,8 @@ class Gnomon
 		end
 	end
 
-	# Schedule Event at a given date/time
-	# Shortcut to schedule an event to be triggered once at a specific date/time
+	# 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
@@ -78,8 +78,8 @@ class Gnomon
 		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
+	# 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
@@ -88,8 +88,8 @@ class Gnomon
 		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
+	# 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
@@ -99,8 +99,8 @@ class Gnomon
 		schedule id, :every, { async: async }, interval, *args, &block
 	end
 
-	# De-schedule
-	# Removes one or more previously-scheduled events from the scheduler
+	# 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
@@ -120,8 +120,8 @@ class Gnomon
 	# Privates
 	private
 
-	# Enqueue Next Run
-	# Registers the next run for a given event into the event queue
+	# 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]
@@ -129,8 +129,8 @@ class Gnomon
 		@equeue.insert pos, { next_run: next_run, event: event }
 	end
 
-	# Determine Next Run
-	# Determines when to trigger the next run for a given event
+	# 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
@@ -145,14 +145,14 @@ class Gnomon
 		end
 	end
 
-	# Run
-	# Main Loop
+	# Run:
+	# Executes the main loop.
 	def run
 		update until @stop
 	end
 
-	# Update
-	# Update Gnomon's internal states
+	# Update:
+	# Updates Gnomon's internal states.
 	def update
 
 		# Synchronize { Trigger Next Event in Queue }
@@ -162,8 +162,8 @@ class Gnomon
 		sleep @granularity
 	end
 
-	# Trigger Event
-	# Triggers an event, executing its block and re-scheduling the next run when appropriate
+	# Trigger Event:
+	# Triggers an event, executing its block and re-scheduling the next run when appropriate.
 	# @param [Hash] event
 	def trigger event
 

data/lib/gnomon/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gnomon
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Eresse
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-01 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Simple event scheduling for Ruby