threaded_in_memory_queue 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8caa931f0f7d256bef31f16943b720971a4aba33
-  data.tar.gz: 58779b11127871c2922e7d56ae1e65501e2e9264
+  metadata.gz: 7fd506634cc145e6c56e1e10deb6c71b6df2721a
+  data.tar.gz: b3cd8cc4435837aaf9f3032e1b63e5852bb679a6
 SHA512:
-  metadata.gz: 43b262f01b9b14826df1499106e037024d83d65098318831bd761ba32df9a91a2da57e001ea2390ddbb66682559ac2fb9b73c15119b65831cd11ede249124b07
-  data.tar.gz: 8754a70e9e7e994b89089cfeeeb2f84ba448e2f0d04953d473ab39a20652887846f5969280de16ca48cf677f33bab9e9034e6bf5eb73dafa93412b564ec9fab0
+  metadata.gz: 53b102591e99d460779bf499cdb29422fa69eb4448119797a3cd62d50496bfa565c84a5ded0fde3e12115bdcde9286052e5f776925dc088cbc39038cbdc2b785
+  data.tar.gz: f48dfc1c7284f51da6051cb8271beb273e80ceb1f1eee79547016aba2005faf293eb80ac0922512d4499e52a496b16c940ae5baac886b89dc61b55e1ef97d610

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    threaded_in_memory_queue (0.0.3)
+    threaded_in_memory_queue (0.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -54,19 +54,31 @@ The first argument is a class that defines the task to be processed and the rest
 The default number of worker threads is 16, you can configure that when you start your queue:
 
 ```ruby
-ThreadedInMemoryQueue.start(size: 5)
+ThreadedInMemoryQueue.config do |config|
+  config.size = 5
+end
 ```
 
 By default jobs have a timeout value of 60 seconds. Since this is an in-memory queue (goes away when your process terminates) it is in your best interests to keep jobs small and quick, and not overload the queue. You can configure a different timeout on start:
 
 ```ruby
-ThreadedInMemoryQueue.start(timeout: 90) # timeout is in seconds
+ThreadedInMemoryQueue.config do |config|
+  config.timeout = 90 # timeout is in seconds
+end
 ```
 
 Want a different logger? Specify a different Logger:
 
 ```ruby
-ThreadedInMemoryQueue.start(logger: MyCustomLogger.new)
+ThreadedInMemoryQueue.config do |config|
+  config.logger = Logger.new(STDOUT)
+end
+```
+
+Make sure to configure before you start your queue. You can also inline your config if you want when you start the queue:
+
+```ruby
+ThreadedInMemoryQueue.start(size: 5, timeout: 90, logger: Logger.new(STDOUT))
 ```
 
 For testing or guaranteed code execution use the Inline option:
@@ -89,7 +101,11 @@ at_exit do
 end
 ```
 
-This call takes an optional timeout value (in seconds), the default is 10.
+This call takes an optional timeout value (in seconds).
+
+```ruby
+ThreadedInMemoryQueue.stop(42)
+```
 
 ## License
 

data/lib/threaded_in_memory_queue.rb

@@ -6,35 +6,46 @@ require 'threaded_in_memory_queue/version'
 require 'threaded_in_memory_queue/timeout'
 
 module ThreadedInMemoryQueue
-  class << self
-    attr_accessor :logger, :inline
-    alias :inline? :inline
-  end
+  STOP_TIMEOUT = 10 # seconds
+  extend self
+  attr_accessor :inline, :logger, :size, :timeout
+  alias :inline? :inline
 
-  def self.start(options = {})
-    self.logger = options[:logger] if options[:logger]
-    self.master = Master.new(options).start
+  def start(options = {})
+    self.logger  = options[:logger]  if options[:logger]
+    self.size    = options[:size]    if options[:size]
+    self.timeout = options[:timeout] if options[:timeout]
+    self.master  = Master.new(logger:  self.logger,
+                              size:    self.size,
+                              timeout: self.timeout)
+    self.master.start
     return self
   end
 
-  def self.started?
+  def configure(&block)
+    raise "Queue is already started, must configure queue before starting" if started?
+    yield self
+  end
+  alias :config  :configure
+
+  def started?
     return false unless master
     master.alive?
   end
 
-  def self.stopped?
+  def stopped?
     !started?
   end
 
-  def self.master
+  def master
     @master
   end
 
-  def self.master=(master)
+  def master=(master)
     @master = master
   end
 
-  def self.enqueue(job, *args)
+  def enqueue(job, *args)
     if inline?
       job.call(*args)
     else
@@ -44,14 +55,14 @@ module ThreadedInMemoryQueue
     return true
   end
 
-  def self.stop(timeout = 10)
+  def stop(timeout = STOP_TIMEOUT)
     return true unless master
     master.stop(timeout)
     return true
   end
 end
 
-ThreadedInMemoryQueue.logger = Logger.new(STDOUT)
+ThreadedInMemoryQueue.logger       = Logger.new(STDOUT)
 ThreadedInMemoryQueue.logger.level = Logger::INFO
 
 

data/lib/threaded_in_memory_queue/version.rb

@@ -1,3 +1,3 @@
 module ThreadedInMemoryQueue
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/threaded_in_memory_queue/config_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+require 'stringio'
+
+class ConfigTest < Test::Unit::TestCase
+
+  def teardown
+    ThreadedInMemoryQueue.stop
+  end
+
+  def test_config_works
+    fake_out = StringIO.new
+    logger   = Logger.new(fake_out)
+    size     = rand(1..99)
+    timeout  = rand(1..99)
+
+    ThreadedInMemoryQueue.configure do |config|
+      config.size    = size
+      config.logger  = logger
+      config.timeout = timeout
+    end
+
+    ThreadedInMemoryQueue.start
+
+    assert_equal ThreadedInMemoryQueue.size, size
+    assert_equal ThreadedInMemoryQueue.master.instance_variable_get("@size"), size
+
+    assert_equal ThreadedInMemoryQueue.timeout, timeout
+    assert_equal ThreadedInMemoryQueue.master.instance_variable_get("@timeout"), timeout
+
+    assert_equal ThreadedInMemoryQueue.logger, logger
+    assert_equal ThreadedInMemoryQueue.master.instance_variable_get("@logger"), logger
+  end
+
+  def test_config_cannot_call_after_start
+    ThreadedInMemoryQueue.start
+    assert_raise(RuntimeError) do
+      ThreadedInMemoryQueue.configure do |config|
+        config.size    = size
+        config.logger  = logger
+        config.timeout = timeout
+      end
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: threaded_in_memory_queue
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Richard Schneeman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,6 +58,7 @@ files:
 - lib/threaded_in_memory_queue/version.rb
 - lib/threaded_in_memory_queue/worker.rb
 - test/test_helper.rb
+- test/threaded_in_memory_queue/config_test.rb
 - test/threaded_in_memory_queue/master_test.rb
 - test/threaded_in_memory_queue/worker_test.rb
 - test/threaded_in_memory_queue_test.rb
@@ -88,6 +89,7 @@ specification_version: 4
 summary: Memory, Enqueue stuff you will
 test_files:
 - test/test_helper.rb
+- test/threaded_in_memory_queue/config_test.rb
 - test/threaded_in_memory_queue/master_test.rb
 - test/threaded_in_memory_queue/worker_test.rb
 - test/threaded_in_memory_queue_test.rb