sucker_punch 0.2 → 0.3

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - 2.0.0

data/README.md

@@ -1,6 +1,11 @@
 # Sucker Punch
 
-Sucker Punch is a Ruby asynchronous processing using Celluloid, heavily influenced by Sidekiq and girl_friday. With Celluloid's actor pattern, we use do asynchronous processing within a single process. This reduces costs of hosting on a service like Heroku along with the memory footprint of having to maintain additional workers if hosting on a dedicated server.
+[![Build Status](https://travis-ci.org/brandonhilkert/sucker_punch.png?branch=master)](https://travis-ci.org/brandonhilkert/sucker_punch)
+[![Code Climate](https://codeclimate.com/github/brandonhilkert/sucker_punch.png)](https://codeclimate.com/github/brandonhilkert/sucker_punch)
+
+Sucker Punch is a single-process Ruby asynchronous processing library. It's [girl_friday](https://github.com/mperham/girl_friday) with syntax from [Sidekiq](https://github.com/mperham/sidekiq) and DSL sugar on top of [Celluloid](https://github.com/celluloid/celluloid/). With Celluloid's actor pattern, we can do asynchronous processing within a single process. This reduces costs of hosting on a service like Heroku along with the memory footprint of having to maintain additional workers if hosting on a dedicated server. All queues can run within a single Rails/Sinatra process.
+
+Sucker Punch is perfect for asynchronous processes like emailing, data crunching, or social platform manipulation. No reason to hold up a user when you can do these things in the background within the same process as your web application...
 
 ## Installation
 
@@ -16,11 +21,9 @@ Or install it yourself as:
 
     $ gem install sucker_punch
 
-## Usage
+## Configuration
 
-Configuration:
-
-`app/config/sucker_punch.rb`
+`config/initializers/sucker_punch.rb`
 
 ```Ruby
   SuckerPunch.config do
@@ -29,7 +32,7 @@ Configuration:
   end
 ```
 
-Workers:
+## Usage
 
 `app/workers/log_worker.rb`
 
@@ -45,7 +48,7 @@ end
 
 All workers should define an instance method `perform`, of which the job being queued will adhere to.
 
-Workers interacting with `ActiveRecord` should take special precaution not to exhause connections in the pool. This can be done with `ActiveRecord::Base.connection_pool.with_connection`, which ensures the connection is returned back to the pool when completed.
+Workers interacting with `ActiveRecord` should take special precaution not to exhaust connections in the pool. This can be done with `ActiveRecord::Base.connection_pool.with_connection`, which ensures the connection is returned back to the pool when completed.
 
 `app/workers/awesome_worker.rb`
 
@@ -62,10 +65,27 @@ class AwesomeWorker
 end
 ```
 
+We can create a job from within another job:
+
+```Ruby
+class AwesomeWorker
+  include SuckerPunch::Worker
+
+  def perform(user_id)
+    ActiveRecord::Base.connection_pool.with_connection do
+      user = User.find(user_id)
+      user.update_attributes(is_awesome: true)
+      SuckerPunch::Queue[:log_queue].async.perform("User #{user.id} became awesome!")
+    end
+  end
+end
+```
+
 Queues:
 
 ```Ruby
-SuckerPunch::Queue[:log_queue] # Is just the class LogWorker
+SuckerPunch::Queue[:log_queue] # Just a wrapper for the LogWorker class
+SuckerPunch::Queue.new(:log_queue)
 ```
 
 Synchronous:
@@ -80,9 +100,30 @@ Asynchronous:
 SuckerPunch::Queue[:log_queue].async.perform("login") # => nil
 ```
 
+## Stats
+
+```Ruby
+SuckerPunch::Queue[:log_queue].size # => 7
+SuckerPunch::Queue[:log_queue].busy_size # => 4
+SuckerPunch::Queue[:log_queue].idle_size # => 3
+```
+
+## Testing
+
+`spec/spec_helper.rb`
+```Ruby
+require 'sucker_punch/inline'
+```
+
+Requiring this library causes your workers to run everything inline. So a call to the following will actually be SYNCHRONOUS.
+
+```Ruby
+SuckerPunch::Queue[:log_queue].async.perform("login")
+```
+
 ## Gem Name
 
-With all due respect, [@jmazzi](https://twitter.com/jmazzi) is completely responsible for the name, which is totally awesome. If you're looking for a name for something, he is the one to go to.
+...is awesome. But I can't take credit for it. Thanks to [@jmazzi](https://twitter.com/jmazzi) for his superior naming skills. If you're looking for a name for something, he is the one to go to.
 
 ## Contributing
 
@@ -91,5 +132,3 @@ With all due respect, [@jmazzi](https://twitter.com/jmazzi) is completely respon
 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/lib/sucker_punch/queue.rb

@@ -17,5 +17,9 @@ module SuckerPunch
                                   klass.send(:pool)
                                 end
     end
+
+    def method_missing(method_name, *args, &block)
+      Celluloid::Actor[name].send(method_name, *args, &block)
+    end
   end
 end

data/lib/sucker_punch/testing.rb

@@ -0,0 +1,8 @@
+module Celluloid
+  class ActorProxy
+    def async(method_name = nil, *args, &block)
+      self
+    end
+  end
+end
+

data/lib/sucker_punch/version.rb

@@ -1,3 +1,3 @@
 module SuckerPunch
-  VERSION = "0.2"
+  VERSION = "0.3"
 end

data/spec/queue_spec.rb

@@ -3,9 +3,6 @@ require 'spec_helper'
 class FakeWorker
   include Celluloid
 end
-class FakeOtherWorker
-  include Celluloid
-end
 
 describe SuckerPunch::Queue do
   describe ".[]" do
@@ -22,6 +19,7 @@ describe SuckerPunch::Queue do
     end
 
     it "turns the class into an actor" do
+      Celluloid::Actor[:crazy_queue].should be_a(Celluloid)
       Celluloid::Actor[:crazy_queue].should be_a(FakeWorker)
       Celluloid::Actor[:crazy_queue].methods.should include(:async)
     end
@@ -30,4 +28,18 @@ describe SuckerPunch::Queue do
       Celluloid::Actor[:crazy_queue].size.should == 7
     end
   end
+
+  describe "delegation" do
+    let(:queue) { SuckerPunch::Queue.new(:crazy_queue) }
+
+    before(:each) do
+      SuckerPunch::Queue.new(:crazy_queue).register(FakeWorker, 7)
+    end
+
+    it "sends messages to Actor" do
+      queue.size.should == 7
+      queue.idle_size.should == 7
+      queue.busy_size.should == 0
+    end
+  end
 end

data/spec/testing_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require_relative '../lib/sucker_punch/testing'
+
+class PatchedWorker
+  include SuckerPunch::Worker
+
+  def perform
+    "do stuff"
+  end
+end
+SuckerPunch::Queue.new(:patched_queue).register(PatchedWorker, 2)
+
+describe "Testing" do
+  let(:queue) { SuckerPunch::Queue.new(:patched_queue) }
+
+  it "processes jobs inline" do
+    job = queue.async.perform
+    expect(job).to eq "do stuff"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sucker_punch
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-19 00:00:00.000000000 Z
+date: 2013-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -67,6 +67,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -74,11 +76,13 @@ files:
 - lib/sucker_punch.rb
 - lib/sucker_punch/exceptions.rb
 - lib/sucker_punch/queue.rb
+- lib/sucker_punch/testing.rb
 - lib/sucker_punch/version.rb
 - lib/sucker_punch/worker.rb
 - spec/queue_spec.rb
 - spec/spec_helper.rb
 - spec/sucker_punch_spec.rb
+- spec/testing_spec.rb
 - spec/worker_spec.rb
 - sucker_punch.gemspec
 homepage: https://github.com/brandonhilkert/sucker_punch
@@ -110,4 +114,5 @@ test_files:
 - spec/queue_spec.rb
 - spec/spec_helper.rb
 - spec/sucker_punch_spec.rb
+- spec/testing_spec.rb
 - spec/worker_spec.rb