sideband 1.0.2 → 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5dcf753ca6d3cd3a7f67785308963896f58b1fe
+  data.tar.gz: 61098cce70008cdc16cabf43d579800a4b246a8f
+SHA512:
+  metadata.gz: fde0cfb008a6406d2ed9fcbc4ad7d31b304af26f5475cabd37bd0d13f614909a5c37a37369b5d4155ed0a1ffc18a5751ab2b5e6ddcbfd927482334e9d5761533
+  data.tar.gz: f47a574a0c17145a536cf5d8ba23660d05a103cae7ec873e1b12c822094775017e9baaab574509856bcfb19999d7221cb0da7c7f58eb2762e55c5380f2c5e7fb

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.rbx

data/.travis.yml

@@ -3,4 +3,4 @@ rvm:
   - 1.9.3
   - 2.0.0
   - jruby-19mode
-  
+  - rbx-19mode

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sideband.gemspec
 gemspec
+gem 'coveralls', require: false

data/README.md

@@ -1,13 +1,14 @@
 # Sideband
 
+[![Build Status](https://api.travis-ci.org/mje113/sideband.png)](http://travis-ci.org/mje113/sideband)
+[![Code Climate](https://codeclimate.com/github/mje113/sideband.png)](https://codeclimate.com/github/mje113/sideband)
+[![Coverage Status](https://coveralls.io/repos/mje113/sideband/badge.png)](https://coveralls.io/r/mje113/sideband)
+[![Dependency Status](https://gemnasium.com/mje113/sideband.png)](https://gemnasium.com/mje113/sideband)
+
 Run simple jobs in a separate sideband thread.
 
 Sideband makes it easy to pass small jobs off to a separate in-process thread. It makes no attempt to handle errors, nor return any results. Its primary focus is queueing up potentially IO blocking bits of code, where the results of which are not necessarily vital to your application's business logic.
 
-Use cases:
-* 
-
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -30,8 +31,6 @@ To be used Sideband needs to be intialized, typically in an Rails initializer (b
 Sideband.initialize!
 ```
 
-In theory you can create one Sideband thread per thread, however it's most useful in your main thread.
-
 To pass work off to Sideband, you can add anything that is callable (procs, lambdas, workers) to its queue:
 
 ```ruby
@@ -62,23 +61,17 @@ Sideband.queue << MetricWorker.new(params[:metric])
 Metricworker.new(params[:metric]).enqueue
 ```
 
-## Use Cases
-
-
+A practical Rails example:
 ```ruby
-@user = User.create(params[:user])
-Sideband.queue << -> { UserMailer.welcome_email(@user).deliver }
-render :welcome
-```
+class UsersController < ApplicationController
 
-## Code Status
-
-[![Build Status](https://api.travis-ci.org/mje113/sideband.png)](http://travis-ci.org/mje113/sideband)
-[![Code Climate](https://codeclimate.com/github/mje113/sideband.png)](https://codeclimate.com/github/mje113/sideband)
-
-## Code Status
-
-[![Code Climate](https://codeclimate.com/github/mje113/sideband.png)](https://codeclimate.com/github/mje113/sideband)
+  def create
+    @user = User.create(params[:user])
+    Sideband.queue << -> { UserMailer.welcome_email(@user).deliver }
+    render :welcome
+  end
+end
+```
 
 ## Contributing
 

data/lib/sideband/manager.rb

@@ -1,17 +1,18 @@
 module Sideband
   class Manager
-    
+
     def initialize
       @pid = ::Process.pid
       thread!
       queue!
     end
-  
+
     def queue
       handle_fork
+      handle_dead_thread
       @queue
     end
-  
+
     def thread
       @thread
     end
@@ -27,16 +28,16 @@ module Sideband
     end
 
     private
-  
+
     def queue!
       @queue = Sideband::Queue.new
     end
-  
+
     def thread!
       @thread.kill if @thread
       @thread = Sideband::Thread.new(self)
     end
-  
+
     def handle_fork
       if ::Process.pid != @pid
         @pid = ::Process.pid
@@ -44,5 +45,11 @@ module Sideband
         queue!
       end
     end
+
+    def handle_dead_thread
+      if @thread && @thread.thread.alive?
+        thread!
+      end
+    end
   end
 end

data/lib/sideband/version.rb

@@ -1,3 +1,3 @@
 module Sideband
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/lib/sideband.rb

@@ -7,18 +7,19 @@ require 'sideband/worker'
 
 module Sideband
 
+  @manager = nil
+
   def self.initialize!
-    new_manager = Manager.new
+    @manager = Manager.new
 
     if block_given?
       begin
-        ::Thread.current['sideband.manager'] = new_manager
         yield
       ensure
         join
       end
     else
-      ::Thread.current['sideband.manager'] = new_manager
+      @manager
     end
   end
 
@@ -29,7 +30,7 @@ module Sideband
 
   def self.kill
     manager.kill
-    ::Thread.current['sideband.manager'] = nil
+    @manager = nil
   end
 
   def self.queue(job = nil)
@@ -45,9 +46,9 @@ module Sideband
   end
 
   def self.manager
-    manager = ::Thread.current['sideband.manager']
-    manager = initialize! if manager.nil?
-    manager
+    m = @manager
+    m = initialize! if m.nil?
+    m
   end
 
 end

data/test/helper.rb

@@ -1,5 +1,10 @@
+require 'simplecov'
+SimpleCov.start
+gem 'minitest'
 require 'minitest/autorun'
 require 'minitest/mock'
+require 'coveralls'
+Coveralls.wear!
 require 'sideband'
 
 class EmailWorker < Sideband::Worker

data/test/test_manager.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestManager < MiniTest::Unit::TestCase
+class TestManager < Minitest::Test
 
   def setup
     @manager = Sideband::Manager.new
@@ -19,7 +19,7 @@ class TestManager < MiniTest::Unit::TestCase
     work = 'work'
     @manager.queue << -> { work = 'finished' }
     sleep 0.5
-    assert_equal 'finished', work 
+    assert_equal 'finished', work
   end
 
   def test_can_queue_and_process_worker
@@ -28,14 +28,14 @@ class TestManager < MiniTest::Unit::TestCase
     assert_equal 'work', worker.work
     @manager.queue << worker
     sleep 0.5
-    assert_equal 'finished', worker.work 
+    assert_equal 'finished', worker.work
   end
 
   if !jruby?
     def test_fork_handling
       queue  = @manager.queue
       thread = @manager.thread
-      
+
       Process.stub(:pid, Process.pid + 1) do
         @manager.queue << -> { 'work' }
         refute_equal queue,  @manager.queue

data/test/test_queue.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestQueue < MiniTest::Unit::TestCase
+class TestQueue < Minitest::Test
 
   def setup
     @queue = Sideband::Queue.new

data/test/test_sideband.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestSideband < MiniTest::Unit::TestCase
+class TestSideband < Minitest::Test
 
   def test_autoinitialization
     assert Sideband.queue << -> { 'work' }
@@ -18,26 +18,4 @@ class TestSideband < MiniTest::Unit::TestCase
       assert Sideband.enqueue(-> { 'work' })
     end
   end
-
-  def test_manager_stored_in_thread_current
-    Sideband.initialize! do
-      assert_kind_of Sideband::Manager, ::Thread.current['sideband.manager']
-    end
-  end
-
-  def test_can_be_used_in_separate_threads
-    work_a, work_b = 'work', 'work'
-    Sideband.initialize! do
-      Sideband.queue << -> { work_a = 'finished' }
-
-      Thread.new {
-        Sideband.initialize! do
-          Sideband.queue << -> { work_b = 'finished' }
-        end
-      }.join
-    end
-
-    assert_equal 'finished', work_a
-    assert_equal 'finished', work_b
-  end
 end

data/test/test_thread.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestThread < MiniTest::Unit::TestCase
+class TestThread < Minitest::Test
 
   def setup
     @manager = OpenStruct.new(queue: OpenStruct.new)

data/test/test_worker.rb

@@ -1,6 +1,6 @@
 require 'helper'
 
-class TestWorker < MiniTest::Unit::TestCase
+class TestWorker < Minitest::Test
 
   def test_can_queue_itself
     Sideband.initialize! do

metadata

@@ -1,38 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: sideband
 version: !ruby/object:Gem::Version
-  version: 1.0.2
-  prerelease: 
+  version: 1.0.3
 platform: ruby
 authors:
 - Mike Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70193563013700 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70193563013700
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70193563013140 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.6.2
   type: :development
   prerelease: false
-  version_requirements: *70193563013140
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.6.2
 description: Run simple workers in a separate thread
 email:
 - mike@urlgonomics.com
@@ -61,27 +66,26 @@ files:
 - test/test_worker.rb
 homepage: https://github.com/mje113/sideband
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 2.0.7
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Run simple workers in a separate thread
 test_files:
 - test/helper.rb