sucker_punch 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a0ceca855b6c2b2f1c6805c41c6cc2aed155124
-  data.tar.gz: 4056269dfa7f9f038fedfc1284747b3ae4f3db64
+  metadata.gz: 063fd2167ea7931708d817864a566519fed44bc4
+  data.tar.gz: 90c335d21c42d04a3b83ff4c58aa336dbdcff216
 SHA512:
-  metadata.gz: 32210d326e0fcfe3ca9c71332845a9be81b9b925fb2bdf2884ab8595d3471dc8af2a6ff9cec8d4819102c1ed9229bdfa2d6df39f5daf5ea5d6855f653b4e4624
-  data.tar.gz: 51e927141ac7442ee675ba72352d3105755175a7175044e64816cd134b8c98d53d6e28b4f5e578889f83f508f925ba7649481964e2e7dda53f77994d586ffada
+  metadata.gz: bdedb891160c8569ee0e022d4f4dbd501306cdc2e6f27dba368ca027a86fc13a147834438c392a1ab60b7f34716effb0c6fd8dfe548953f46e3dc239a62bccb0
+  data.tar.gz: 999af4061d5ec40a10bcc6efd65effacfea1565c17fcf8b736638af5504e0c234e686dd9ad3e81b4f7e9470afdbf83d2416fd5e741fe092f3def99e7d960c094

data/CHANGES.md

@@ -1,3 +1,8 @@
+1.4.0
+--------
+
+- Added Rails generate task to create a job from the command line
+
 1.3.2
 --------
 

data/README.md

@@ -7,6 +7,17 @@ Sucker Punch is a single-process Ruby asynchronous processing library. It's [gir
 
 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...
 
+Sucker Punch is built on top of [Celluloid
+Pools](https://github.com/celluloid/celluloid/wiki/Pools). Each job is setup as
+a pool, which equates to its own queue with individual workers working against
+the jobs. Unlike most other background processing libraries, Sucker
+Punch's jobs are stored in memory. The benefit to this is there is no
+additional infrastructure requirement (ie. database, redis, etc.). The downside
+is that if the web processes is restarted and there are jobs that haven't yet
+been processed, they will be lost. For this reason, Sucker Punch is generally
+recommended for jobs that are fast and non-mission critical (ie. logs, emails,
+etc.).
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -147,9 +158,20 @@ require 'sucker_punch/testing/inline'
 Log.new.async.perform("login") # => Will be synchronous and block until job is finished
 ```
 
+## Rails
+
+If you're using Sucker Punch with Rails, there's a built-in generator task:
+
+```ruby
+$ rails g sucker_punch:job logger
+```
+
+would create the file `app/jobs/logger_job.rb` with a unimplemented `#perform`
+method.
+
 ## Active Job
 
-Sucker Punch has been added as an Active job adapter in the upcoming Rails 4.2 release.
+Sucker Punch has been added as an Active Job adapter in Rails 4.2.
 See the [guide](http://edgeguides.rubyonrails.org/active_job_basics.html) for
 configuration and implementation.
 
@@ -162,7 +184,11 @@ gem 'sucker_punch'
 And then configure the backend to use Sucker Punch:
 
 ```Ruby
-Rails.application.config.active_job.queue_adapter = :sucker_punch
+# config/initializers/sucker_punch.rb
+Rails.application.configure do
+  config.active_job.queue_adapter = :sucker_punch
+end
+
 ```
 
 ## Troubleshooting

data/lib/generators/sucker_punch/job_generator.rb

@@ -0,0 +1,16 @@
+module SuckerPunch
+  module Generators
+    class JobGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc <<desc
+description:
+    create job in app/jobs directory
+desc
+
+      def create_job_file
+        template 'job.rb', File.join('app/jobs', class_path, "#{file_name}_job.rb")
+      end
+    end
+  end
+end

data/lib/generators/sucker_punch/templates/job.rb

@@ -0,0 +1,7 @@
+class <%= class_name %>Job 
+  include SuckerPunch::Job
+  
+  def perform
+    raise NotImplementedError
+  end
+end

data/lib/sucker_punch/version.rb

@@ -1,3 +1,3 @@
 module SuckerPunch
-  VERSION = "1.3.2"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sucker_punch
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Brandon Hilkert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-28 00:00:00.000000000 Z
+date: 2015-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -80,6 +80,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/sucker_punch/job_generator.rb
+- lib/generators/sucker_punch/templates/job.rb
 - lib/sucker_punch.rb
 - lib/sucker_punch/core_ext.rb
 - lib/sucker_punch/job.rb
@@ -160,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Sucker Punch is a Ruby asynchronous processing using Celluloid, heavily influenced
@@ -172,3 +174,4 @@ test_files:
 - spec/sucker_punch/queue_spec.rb
 - spec/sucker_punch/testing/inline_spec.rb
 - spec/sucker_punch_spec.rb
+has_rdoc: