sideband 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sideband.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mike Evans
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Sideband
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sideband'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sideband
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/lib/sideband/manager.rb

@@ -0,0 +1,48 @@
+module Sideband
+  class Manager
+    
+    def initialize
+      @pid = ::Process.pid
+      thread!
+      queue!
+    end
+  
+    def queue
+      handle_fork
+      @queue
+    end
+  
+    def thread
+      @thread
+    end
+
+    def join
+      @queue.kill
+      @thread.join
+    end
+
+    def kill
+      @thread.kill
+      @thread = @queue = nil
+    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
+        thread!
+        queue!
+      end
+    end
+  end
+end

data/lib/sideband/queue.rb

@@ -0,0 +1,24 @@
+module Sideband
+  class Queue
+
+    def initialize
+      @queue = ::Queue.new
+    end
+
+    def kill
+      @queue << nil
+    end
+
+    def push(work)
+      return false if work.nil?
+      @queue.push(work)
+      true
+    end
+    alias_method :<<, :push
+
+    def pop
+      @queue.pop
+    end
+
+  end
+end

data/lib/sideband/thread.rb

@@ -0,0 +1,30 @@
+module Sideband
+  class Thread
+
+    attr_reader :thread
+
+    def initialize(manager)
+      @manager = manager
+      @thread = ::Thread.new do
+        while work = @manager.queue.pop
+          exit if work.nil?
+          
+          begin
+            work.call
+          rescue Exception
+            # Sideband will ignore all Exceptions, 
+            # better to handle in your workers.
+          end
+        end
+      end
+    end
+
+    def join
+      thread.join
+    end
+
+    def kill
+      thread.kill
+    end
+  end
+end

data/lib/sideband/version.rb

@@ -0,0 +1,3 @@
+module Sideband
+  VERSION = '1.0.0'
+end

data/lib/sideband/worker.rb

@@ -0,0 +1,14 @@
+module Sideband
+  class Worker
+
+    def call
+      raise NotImplementedError.new('Define your Work in a Worker subclass.')
+    end
+    
+    def enqueue
+      Sideband.queue << self
+      true
+    end
+    alias_method :queue, :enqueue
+  end
+end

data/lib/sideband.rb

@@ -0,0 +1,48 @@
+require 'thread'
+require 'sideband/version'
+require 'sideband/manager'
+require 'sideband/queue'
+require 'sideband/thread'
+require 'sideband/worker'
+
+module Sideband
+
+  class NotInitializedError < Exception; end
+
+  def self.initialize!
+    new_manager = Manager.new
+    puts 'Sideband initialized!'
+
+    if block_given?
+      begin
+        ::Thread.current['sideband.manager'] = new_manager
+        yield
+      ensure
+        join
+      end
+    else
+      ::Thread.current['sideband.manager'] = new_manager
+    end
+  end
+
+  def self.join
+    manager.join
+    kill
+  end
+
+  def self.kill
+    manager.kill
+    ::Thread.current['sideband.manager'] = nil
+  end
+
+  def self.queue
+    manager.queue
+  end
+
+  def self.manager
+    manager = ::Thread.current['sideband.manager']
+    raise NotInitializedError.new('Sideband must be initialized! before using.') if manager.nil?
+    manager
+  end
+
+end

data/sideband.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sideband/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'sideband'
+  gem.version       = Sideband::VERSION
+  gem.authors       = ['Mike Evans']
+  gem.email         = ['mike@urlgonomics.com']
+  gem.description   = %q{Run simple workers in a separate thread}
+  gem.summary       = %q{Run simple workers in a separate thread}
+  gem.homepage      = 'https://github.com/mje113/sideband'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

data/test/helper.rb

@@ -0,0 +1,15 @@
+require 'minitest/autorun'
+require 'sideband'
+
+class EmailWorker < Sideband::Worker
+
+  attr_reader :work
+
+  def initialize
+    @work = 'work'
+  end
+
+  def call
+    @work = 'finished'
+  end
+end

data/test/test_manager.rb

@@ -0,0 +1,49 @@
+require 'helper'
+
+class TestManager < MiniTest::Unit::TestCase
+
+  def setup
+    @manager = Sideband::Manager.new
+  end
+
+  def test_has_queue
+    assert_kind_of Sideband::Queue, @manager.queue
+  end
+
+  def test_has_thread
+    assert_kind_of Sideband::Thread, @manager.thread
+  end
+
+  def test_can_queue_and_process_proc
+    work = 'work'
+    @manager.queue << -> { work = 'finished' }
+    sleep 0.1
+    assert_equal 'finished', work 
+  end
+
+  def test_can_queue_and_process_worker
+    worker = EmailWorker.new
+    assert_equal 'work', worker.work
+    @manager.queue << worker
+    sleep 0.1
+    assert_equal 'finished', worker.work 
+  end
+
+  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
+      refute_equal thread, @manager.thread
+    end
+  end
+
+  def test_killed
+    @manager.kill
+    assert_nil @manager.queue
+    assert_nil @manager.thread
+  end
+
+end

data/test/test_queue.rb

@@ -0,0 +1,22 @@
+require 'helper'
+
+class TestQueue < MiniTest::Unit::TestCase
+
+  def setup
+    @queue = Sideband::Queue.new
+  end
+
+  def test_killed
+    @queue.kill
+    assert_nil @queue.pop
+  end
+
+  def test_can_push_and_pop
+    assert_equal true, @queue.push(:a)
+    assert_equal :a,   @queue.pop
+  end
+
+  def test_nil_blocked
+    refute @queue << nil
+  end
+end

data/test/test_sideband.rb

@@ -0,0 +1,38 @@
+require 'helper'
+
+class TestSideband < MiniTest::Unit::TestCase
+
+  def test_must_be_initialized_before_use
+    assert_raises Sideband::NotInitializedError do
+      Sideband.queue << -> { 'work' }
+    end
+  end
+
+  def test_has_queue
+    Sideband.initialize! do
+      assert_kind_of Sideband::Queue, Sideband.queue
+    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

@@ -0,0 +1,32 @@
+require 'helper'
+
+class TestThread < MiniTest::Unit::TestCase
+
+  def setup
+    @manager = OpenStruct.new(queue: OpenStruct.new)
+  end
+
+  def test_initialized
+    thread = Sideband::Thread.new(@manager)
+    assert_kind_of ::Thread, thread.thread
+  end
+
+  def test_killed
+    thread = Sideband::Thread.new(@manager)
+    thread.kill
+    sleep 0.1
+    refute thread.thread.alive?
+  end
+
+  def test_joined
+    work = 'work'
+    @manager.queue = Queue.new
+    @manager.queue << -> { work = 'finished' }
+    @manager.queue << nil
+    thread = Sideband::Thread.new(@manager)
+
+    thread.join
+    refute thread.thread.alive?
+    assert_equal 'finished', work
+  end
+end

data/test/test_worker.rb

@@ -0,0 +1,24 @@
+require 'helper'
+
+class TestWorker < MiniTest::Unit::TestCase
+
+  def test_can_queue_itself
+    Sideband.initialize! do
+      assert Sideband::Worker.new.enqueue
+      assert Sideband::Worker.new.queue
+      assert EmailWorker.new.enqueue
+      assert EmailWorker.new.queue
+    end
+  end
+
+  def test_raises_error_if_call_not_implemented
+    assert_raises NotImplementedError do
+      Sideband::Worker.new.call
+    end
+  end
+
+  def test_call_implemented
+    assert_equal 'finished', EmailWorker.new.call
+  end
+
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: sideband
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Mike Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-08 00:00:00.000000000 Z
+dependencies: []
+description: Run simple workers in a separate thread
+email:
+- mike@urlgonomics.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sideband.rb
+- lib/sideband/manager.rb
+- lib/sideband/queue.rb
+- lib/sideband/thread.rb
+- lib/sideband/version.rb
+- lib/sideband/worker.rb
+- sideband.gemspec
+- test/helper.rb
+- test/test_manager.rb
+- test/test_queue.rb
+- test/test_sideband.rb
+- test/test_thread.rb
+- test/test_worker.rb
+homepage: https://github.com/mje113/sideband
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: Run simple workers in a separate thread
+test_files:
+- test/helper.rb
+- test/test_manager.rb
+- test/test_queue.rb
+- test/test_sideband.rb
+- test/test_thread.rb
+- test/test_worker.rb
+has_rdoc: