queue_kit 0.0.6 → 0.0.8

data/lib/queue_kit/clients/command_timeout.rb

@@ -1,15 +1,6 @@
 module QueueKit
   module Clients
     module CommandTimeout
-      def self.with_ivars(klass)
-        mod = self
-        klass.class_eval do
-          include mod
-          attr_accessor :command_timeout_ms
-          attr_accessor :max_command_timeout_ms
-        end
-      end
-
       def command_timeout(attempts = 0)
         timeout = command_timeout_ms
         timeout += timeout * (attempts / command_clients_size).floor
@@ -22,16 +13,16 @@ module QueueKit
       end
 
       def command_timeout_from(options)
-        @command_timeout_ms = options[:command_timeout_ms] || 10
-        @max_command_timeout_ms = options[:max_command_timeout_ms] || 1000
+        @command_timeout_ms = options[:command_timeout_ms]
+        @max_command_timeout_ms = options[:max_command_timeout_ms]
       end
 
       def command_timeout_ms
-        10
+        @command_timeout_ms ||= 10
       end
 
       def max_command_timeout_ms
-        1000
+        @max_command_timeout_ms ||= 1000
       end
 
       def command_clients_size

data/lib/queue_kit/clients/round_robin_shuffler.rb

@@ -1,12 +1,11 @@
 module QueueKit
   module Clients
     module RoundRobinShuffler
-      def self.with_ivars(klass)
-        mod = self
-        klass.class_eval do
-          include mod
-          attr_accessor :commands_per_client
+      include QueueKit::Instrumentable
 
+      def self.included(klass)
+        super(klass)
+        klass.class_eval do
           def command_clients_size
             @clients.size
           end
@@ -35,14 +34,15 @@ module QueueKit
           rotate_client
         end
 
-        clients[@client_index]
+        @current_client
       end
 
       def round_robin_from(options)
-        @commands_per_client = options[:commands_per_client] || 100
+        @commands_per_client = options[:commands_per_client]
       end
 
       def rotate_client
+        instrument "worker.rotate_client"
         @client_index ||= -1
         @client_len ||= clients.size
 
@@ -52,10 +52,12 @@ module QueueKit
         if @client_index >= @client_len
           @client_index = 0
         end
+
+        @current_client = clients[@client_index]
       end
 
       def commands_per_client
-        100
+        @commands_per_client ||= 100
       end
 
       def clients

data/lib/queue_kit/instrumentable.rb

@@ -0,0 +1,47 @@
+module QueueKit
+  module Instrumentable
+    def instrumenter_from(options)
+      @instrumenter = options[:instrumenter]
+      if options.fetch(:debug) { false }
+        enable_debug_mode
+      end
+    end
+
+    def instrumenter
+      @instrumenter ||= default_instrumenter
+    end
+
+    def instrument(name, payload = nil)
+      options = default_instrument_options
+      options.update(payload) if payload
+      instrumenter.instrument("queuekit.#{name}", options)
+    end
+
+    def force_debug
+      instrument(*yield)
+    end
+
+    def debug
+    end
+
+    def enable_debug_mode
+      class << self
+        alias debug force_debug
+      end
+    end
+
+    def default_instrument_options
+      {}
+    end
+
+    def default_instrumenter
+      PutsInstrumenter.new
+    end
+
+    class PutsInstrumenter
+      def instrument(name, payload = nil)
+        puts "[#{Time.now}] #{name}: #{payload.inspect}"
+      end
+    end
+  end
+end

data/lib/queue_kit/worker.rb

@@ -1,18 +1,15 @@
 module QueueKit
   module Worker
+    include Instrumentable
+
     def initialize(queue, options = {})
       @queue = queue
       @processor = options.fetch(:processor) { method(:process) }
       @cooler = options.fetch(:cooler) { method(:cool) }
       @error_handler = options.fetch(:error_handler) { method(:handle_error) }
-      @instrumenter = options.fetch(:instrumenter) { PutsInstrumenter.new }
       @stopped = true
 
-      if options.fetch(:debug) { false }
-        class << self
-          alias debug force_debug
-        end
-      end
+      instrumenter_from(options)
     end
 
     def process(item)
@@ -26,7 +23,7 @@ module QueueKit
       raise err
     end
 
-    def trap(signal_handler)
+    def trap_signals(signal_handler)
       SignalChecker.trap(self, signal_handler)
     end
 
@@ -35,7 +32,8 @@ module QueueKit
       interval_debugger = lambda { "worker.interval" }
 
       loop do
-        working? ? work : break
+        work
+        break unless working?
         debug(&interval_debugger)
       end
     end
@@ -55,7 +53,7 @@ module QueueKit
         @processor.call(item)
         set_popping_procline
       else
-        @cooler.call
+        @cooler.call if working?
       end
     end
 
@@ -84,11 +82,6 @@ module QueueKit
       !@stopped
     end
 
-    def instrument(name, payload = nil)
-      (payload ||= {}).update(:worker => self)
-      @instrumenter.instrument("queuekit.#{name}", payload)
-    end
-
     def set_working_procline
       procline("Processing since #{Time.now.to_i}")
     end
@@ -98,17 +91,8 @@ module QueueKit
       procline("Waiting since #{@last_job_at.to_i}")
     end
 
-    def force_debug
-      instrument(*yield)
-    end
-
-    def debug
-    end
-
-    class PutsInstrumenter
-      def instrument(name, payload = nil)
-        puts "[#{Time.now}] #{name}: #{payload.inspect}"
-      end
+    def default_instrument_options
+      {:worker => self}
     end
   end
 end

data/lib/queue_kit.rb

@@ -1,5 +1,5 @@
 module QueueKit
-  VERSION = "0.0.6"
+  VERSION = "0.0.8"
   ROOT = File.expand_path("../queue_kit", __FILE__)
 
   def self.require_lib(*libs)
@@ -12,6 +12,6 @@ module QueueKit
     alias require_libs require_lib
   end
 
-  require_lib "worker"
+  require_lib "instrumentable", "worker"
 end
 

data/test/command_timeout_test.rb

@@ -6,8 +6,8 @@ class CommandTimeoutTest < Test::Unit::TestCase
 
   def test_with_ivars
     object = FakeQueue.new
-    assert_nil object.command_timeout_ms
-    assert_nil object.max_command_timeout_ms
+    assert_equal 10, object.command_timeout_ms
+    assert_equal 1000, object.max_command_timeout_ms
 
     object.command_timeout_from({})
     assert_equal 10, object.command_timeout_ms
@@ -33,7 +33,7 @@ class CommandTimeoutTest < Test::Unit::TestCase
   end
 
   class FakeQueue
-    QueueKit::Clients::CommandTimeout.with_ivars(self)
+    include QueueKit::Clients::CommandTimeout
   end
 end
 

data/test/helper.rb

@@ -2,3 +2,8 @@ require 'bundler'
 require 'test/unit'
 require File.expand_path("../../lib/queue_kit", __FILE__)
 
+class NullInstrumenter
+  def instrument(name, payload = nil)
+  end
+end
+

data/test/round_robin_shuffler_test.rb

@@ -37,7 +37,7 @@ class RoundRobinShufflerTest < Test::Unit::TestCase
 
   def test_with_ivars
     object = FakeQueue.new
-    assert_nil object.commands_per_client
+    assert_equal 100, object.commands_per_client
 
     object.round_robin_from({})
     assert_equal 100, object.commands_per_client
@@ -73,7 +73,15 @@ class RoundRobinShufflerTest < Test::Unit::TestCase
   end
 
   class FakeQueue
-    QueueKit::Clients::RoundRobinShuffler.with_ivars(self)
+    include QueueKit::Clients::RoundRobinShuffler
+
+    def default_instrumenter
+      NullInstrumenter.new
+    end
+  end
+
+  def default_instrumenter
+    NullInstrumenter.new
   end
 end
 

data/test/worker_test.rb

@@ -3,12 +3,13 @@ require File.expand_path("../helper", __FILE__)
 class WorkerTest < Test::Unit::TestCase
   def test_cooler
     cooled = false
-    cooler = lambda { cooled = true }
+    worker = nil
+    cooler = lambda { worker.stop;cooled = true }
 
     worker = new_worker [], :processor => lambda { |_| fail 'item found?' },
       :cooler => cooler
 
-    worker.work
+    worker.run
     assert cooled
   end
 
@@ -72,10 +73,5 @@ class WorkerTest < Test::Unit::TestCase
   class Worker
     include QueueKit::Worker
   end
-
-  class NullInstrumenter
-    def instrument(name, payload = nil)
-    end
-  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: queue_kit
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -23,6 +23,7 @@ files:
 - queue_kit.gemspec
 - lib/queue_kit/clients/command_timeout.rb
 - lib/queue_kit/clients/round_robin_shuffler.rb
+- lib/queue_kit/instrumentable.rb
 - lib/queue_kit/signal_checker.rb
 - lib/queue_kit/signal_handlers/graceful_quit.rb
 - lib/queue_kit/worker.rb