angael 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,8 @@
 # Angael
 
 Angael is a lightweight library for running repetitive background processes.
+It handles the forking and signal catching, allow you to just define what the
+background workers should do.
 
 ## Documentation
 

data/angael.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["paul@thoughtless.ca"]
   s.homepage    = "http://github.com/thoughtless/angael"
   s.summary     = %q{Lightweight library for running repetitive background processes.}
-  #s.description = %q{TODO: Write a gem description}
+  s.description = %q{Angael is a lightweight library for running repetitive background processes. It handles the forking and signal catching, allow you to just define what the background workers should do.}
 
   s.rubyforge_project = "angael"
 

data/lib/angael/version.rb

@@ -1,3 +1,3 @@
 module Angael
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/angael/worker.rb

@@ -11,54 +11,25 @@ module Angael
   #                  to do wrap the child process in a block. This is useful for
   #                  exception handling. Be sure to actually fork or you may break
   #                  something important.
+  #    #log        - If defined, this will be called at various points of interest
+  #                  with 1 String as the argument. Log levels are not supported.
+  #    #timeout    - Number of seconds to wait for the child process to exit after
+  #                  it is sent SIGINT. If you don't define this method, it waits
+  #                  60 seconds.
   module Worker
     class ChildProcessNotStoppedError < StandardError; end
 
     attr_reader :pid
 
-    # Options:
-    #   :batch_timeout - After this number of seconds, other workers will be able
-    #                    to work on the jobs reserved by #process_jobs.
-    #   :batch_timeout_buffer - This is the number of seconds between when the
-    #                           worker stops processing jobs and when other workers
-    #                           can start processing the jobs that this worker had
-    #                           resered. This should be set to the maximum length
-    #                           of time a single job should take, plus the maximum
-    #                           expected discrepancy between the system clocks on
-    #                           all the worker servers.
-    #   :logger => A logger object, which should follow the Logger class in the
-    #     standard library. Default nil, as in no logging.
-    #   :log_level => The log level, as defined by the Logger class in the
-    #     standard library. One of:
-    #       Logger::FATAL
-    #       Logger::ERROR
-    #       Logger::WARN
-    #       Logger::INFO  # Default
-    #       Logger::DEBUG
-    def initialize(attrs={})
-      @timeout = attrs[:timeout] || 60 # Seconds
-      @batch_size = attrs[:batch_size] || 1
-      @batch_timeout = attrs[:batch_timeout] || @batch_size * 5 # Seconds
-      @batch_timeout_buffer = attrs[:batch_timeout_buffer] || 5 # Seconds
-      @logger = attrs[:logger]
-      if @logger
-        @log_level = attrs[:log_level] || begin
-          require 'logger' # Only require it if it is absolutely neccessary.
-          Logger::INFO
-        end
-      end
-    end
-
-
     # Loops forever, taking jobs off the queue. SIGINT will stop it after
     # allowing any jobs already taken from the queue to be processed.
     def start!
       trap("CHLD") do
-        log("trapped SIGCHLD. Child PID #{pid}.")
+        __log("trapped SIGCHLD. Child PID #{pid}.")
 
         # @stopping is set by #stop!. If it is true, then the child process was
         # expected to die. If it is false/nil, then this is unexpected.
-        log("Child process died unexpectedly") unless @stopping
+        __log("Child process died unexpectedly") unless @stopping
         # Reap the child process so that #started? will return false. But we can't
         # block because this may be called for a Worker when a different Worker's
         # child is the process that died.
@@ -66,27 +37,27 @@ module Angael
       end
 
       @pid = fork_child do
-        log("Started")
+        __log("Started")
 
         if respond_to?(:after_fork)
-          log("Running after fork callback")
+          __log("Running after fork callback")
           after_fork
-          log("Finished running after fork callback")
+          __log("Finished running after fork callback")
         end
 
         @interrupted = false
         trap("INT") do
-          log("SIGINT Received")
+          __log("SIGINT Received")
           @interrupted = true
         end
         trap("TERM") do
-          log("SIGTERM Received")
+          __log("SIGTERM Received")
           @interrupted = true
         end
 
         loop do
           if @interrupted
-            log("Child process exiting gracefully")
+            __log("Child process exiting gracefully")
             exit 0
           end
           work
@@ -96,7 +67,7 @@ module Angael
 
     def stop!
       unless started?
-        log("Called stop for worker with PID #{pid} but it is not started")
+        __log("Called stop for worker with PID #{pid} but it is not started")
         return false
       end
 
@@ -105,14 +76,14 @@ module Angael
       @stopping = true
 
       begin
-        log("Sending SIGINT to child process with pid #{pid}.")
-        Timeout::timeout(@timeout) do
+        __log("Sending SIGINT to child process with pid #{pid}.")
+        Timeout::timeout(timeout) do
           Process.kill('INT', pid)
           wait_for_child
         end
       rescue Timeout::Error
         begin
-          log("Child process with pid #{pid} did not stop with #@timeout seconds of SIGINT. Sending SIGKILL to child process.")
+          __log("Child process with pid #{pid} did not stop within #{timeout} seconds of SIGINT. Sending SIGKILL to child process.")
           # This only leaves 1 second for the SIGKILL to take effect. I don't
           # know if that is enough time (or maybe too much time).
           Timeout::timeout(1) do
@@ -122,7 +93,7 @@ module Angael
         rescue Timeout::Error
           if pid_running?
             msg = "Unable to kill child process with PID: #{pid}"
-            log(msg)
+            __log(msg)
             raise ChildProcessNotStoppedError, msg
           end
         end
@@ -148,8 +119,14 @@ module Angael
     end
 
 
-    def log(msg)
-      @logger.add(@log_level, "#{Time.now.utc} - #{self.class} (pid #{$$}): #{msg}") if @logger
+    def __log(msg)
+      log(msg) if respond_to?(:log)
+    end
+
+
+    # In seconds
+    def timeout
+      60
     end
 
 
@@ -166,7 +143,7 @@ module Angael
     # Will just return if the child process is not running.
     def wait_for_child(opts={})
       begin
-        log("Waiting for child with pid #{pid}.")
+        __log("Waiting for child with pid #{pid}.")
         if opts[:dont_block]
           # When this is called as the result of a SIGCHLD
           # we need to pass in Process::WNOHANG as the 2nd argument, otherwise when

data/spec/lib/angael/worker_spec.rb

@@ -101,7 +101,11 @@ describe Angael::Worker do
       end
 
       context "child process does die within the worker's timeout" do
-        subject { @worker ||= Angael::TestSupport::SampleWorker.new(:timeout => 2) }
+        subject do
+          worker = Angael::TestSupport::SampleWorker.new
+          worker.stub(:timeout => 2)
+          worker
+        end
         before do
           subject.stub(:work) { nil }
           subject.start!
@@ -129,7 +133,11 @@ describe Angael::Worker do
       end
 
       context "child process does not die within the worker's timeout" do
-        subject { @worker ||= Angael::TestSupport::SampleWorker.new(:timeout => 1) }
+        subject do
+          worker = Angael::TestSupport::SampleWorker.new
+          worker.stub(:timeout => 1)
+          worker
+        end
         before do
           subject.stub(:work) { sleep 1000 }
           subject.start!

metadata

@@ -2,7 +2,7 @@
 name: angael
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Paul Cortens
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-28 00:00:00 -07:00
+date: 2011-06-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,7 +35,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
-description: 
+description: Angael is a lightweight library for running repetitive background processes. It handles the forking and signal catching, allow you to just define what the background workers should do.
 email: 
 - paul@thoughtless.ca
 executables: []