sideband 1.0.0 → 1.0.1

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  

data/README.md

@@ -1,6 +1,12 @@
 # Sideband
 
-TODO: Write a gem description
+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
 
@@ -18,7 +24,57 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To be used Sideband needs to be intialized, typically in an Rails initializer (but can be used outside of Rails).
+
+```ruby
+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
+Sideband.queue << -> { Something.expensive }
+```
+
+Sideband will queue the work, then return immediately.  The work will get called whenever the thread scheduler schedules the worker thread--typically after your controller renders.
+
+Sideband is truly fire-and-forget, any exceptions are caught and thrown away.  If you want to handle exception, you should probably do so in a custom worker.
+
+```ruby
+class MetricWorker < Sideband::Worker
+  def initialize(params)
+    @params = params
+  end
+
+  def call
+    Work.create!(@params)
+  rescue ActiveRecord::RecordInvalid
+    Rails.logger.error("Could not save Metric: #{@params}")
+  end
+end
+
+Sideband.queue << MetricWorker.new(params[:metric])
+
+ # or Sideband::Workers can enqueue themselves
+
+Metricworker.new(params[:metric]).enqueue
+```
+
+## Use Cases
+
+
+```ruby
+@user = User.create(params[:user])
+Sideband.queue << -> { UserMailer.welcome_email(@user).deliver }
+render :welcome
+```
+
+## 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)
 
 ## Contributing
 

data/lib/sideband/version.rb

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

data/sideband.gemspec

@@ -16,4 +16,6 @@ Gem::Specification.new do |gem|
   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']
+  
+  gem.add_development_dependency 'rake'
 end

data/test/helper.rb

@@ -13,3 +13,7 @@ class EmailWorker < Sideband::Worker
     @work = 'finished'
   end
 end
+
+def jruby?
+  RUBY_PLATFORM =~ /java/
+end

data/test/test_manager.rb

@@ -29,16 +29,19 @@ class TestManager < MiniTest::Unit::TestCase
     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
+  if !jruby?
+    def test_fork_handling
+      puts RUBY_PLATFORM
+      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
+end
 
   def test_killed
     @manager.kill

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sideband
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-08 00:00:00.000000000 Z
-dependencies: []
+date: 2013-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Run simple workers in a separate thread
 email:
 - mike@urlgonomics.com
@@ -19,6 +35,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -45,18 +62,24 @@ require_paths:
 required_ruby_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -823111614033344564
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -823111614033344564
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Run simple workers in a separate thread
@@ -67,4 +90,3 @@ test_files:
 - test/test_sideband.rb
 - test/test_thread.rb
 - test/test_worker.rb
-has_rdoc: