blue_colr 0.1.1 → 0.1.2

data/bin/bluecolrd

@@ -149,7 +149,7 @@ begin
 
   loop do
     # get all pending items
-    pending_processes = @db[:process_items].filter(:status => BlueColr.get_pending_states).all
+    pending_processes = @db[:process_items].filter(:status => BlueColr.get_pending_states).filter(:environment => @environment).all
     pending_processes = pending_processes.map do |process|
       # get all the parents' statuses
       parent_statuses = @db[:process_items].

data/lib/blue_colr.rb

@@ -9,18 +9,14 @@ require 'optparse'
 require 'yaml'
 require 'sequel'
 
-
+# This class provides a DSL for enqueuing processes, at the same time describing their mutual dependance.
 class BlueColr
-#  STATUS_OK = 'ok'
-#  STATUS_ERROR = 'error'
-#  STATUS_PENDING = 'pending'
-#  STATUS_RUNNING = 'running'
-#  STATUS_PREPARING = 'preparing'
-#  STATUS_SKIPPED = 'skipped'
-
-  # default state transitions with simple state setup ('PENDING => RUNNING => OK or ERROR')
+
+  # If no alternative statemap is provided, all newly launched processes will have this state by default.
   DEFAULT_PENDING_STATE = 'pending'
+  # Used internally.
   PREPARING_STATE = 'preparing'
+  # Default state transitions with simple state setup ('PENDING => RUNNING => OK or ERROR')
   DEFAULT_STATEMAP = {
     'on_pending' => {
       DEFAULT_PENDING_STATE => [
@@ -208,10 +204,14 @@ class BlueColr
     self.class.log
   end
 
+  # All processes enqueued within the given block should be executed sequentially,
+  # i.e. one after another.
   def sequential &block
     exec :sequential, &block
   end
 
+  # All processes enqueued within the given block should be executed in parallel
+  # (not waiting for each other to finish).
   def parallel &block
     exec :parallel, &block
   end
@@ -247,6 +247,15 @@ class BlueColr
     id
   end
 
+  # Enqueue a single command +cmd+.
+  #
+  # == Parameters
+  # cmd::
+  #   A string containing the command that should be executed.
+  # options::
+  #   A set of optional parameters which override default fields associated with the given command
+  #   (e.g. here you can specify different +:environment+ that the command should be launched in,
+  #   optional +:description+, or whatever you decide to store along the command).
   def run cmd, opts = {}
     id = enqueue cmd, @waitfor, opts
     if @type == :sequential

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: blue_colr
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Mladen Jablanovic