active_waiter 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c34c63c0bd1531f81f881957386f35e8e2b08f3f
-  data.tar.gz: d88400a7785719d0fff8588bf57eb8a5dc418a7d
+  metadata.gz: 2208fadf74c295220f10cac3714b6f8fa64d8c04
+  data.tar.gz: 1cd270203efe90bc7d94083a608f6933b29bb769
 SHA512:
-  metadata.gz: ee6ac59397ebc6126fff1703e4221f9a14d7b7573b1fa6ee35faa6eeeeec0143d9fb1576c602b04e086e3c28146267d196feba7b73ee444a0c58389fe8a44ae3
-  data.tar.gz: cf414b2c9b6962895e74e2dbb7cf8892b39f13c60a7e3acc0248a15e2d5b29103a75b0bfeaf5a292e6f9ca9e5fe156a6dc757e2484b194e0c80f2007016fa5a3
+  metadata.gz: d783491504ea06ddddb4229dbb322c053f1a3c6d4753bbb1e6f01040f2e34d417e97102ae3e5b1c85cc8222fe446e9653898873c95b4e939fcdd3f9d788b8e91
+  data.tar.gz: aaac2b8016a772a4074b6ef5a2d028ad28ed88e8c267dc6f86fe6c38dc4ca894026750db4f4c54e8197cb37ad28f4e61d441c93d16f8f9d56863d198e63996ee

data/README.md

@@ -29,7 +29,7 @@ But how do you get that PDF into the hands of your users now? Email? Push notifi
 
 ## Solution
 
-Let `ActiveWaiter` enqueue that job instead and redirect to it's progress tracking page.
+Let `ActiveWaiter` enqueue that job instead and redirect to its progress tracking page.
 
 ``` ruby
 def index
@@ -103,7 +103,51 @@ ActiveWaiter.configure do |config|
 end
 ```
 
-Next, prefix any routes used in your application's layout with `main_app.`, e.g. `main_app.sign_in_path`.   
+Next, prefix any routes used in your application's layout with `main_app.`, e.g. `main_app.sign_in_path`.
 
-This is required because `ActiveWaiter` is a Rails Engine mounted into your application, 
+This is required because `ActiveWaiter` is a Rails Engine mounted into your application,
 and it doesn't know about the routes declared within your application.
+
+#### Exceptions
+
+When your job gets an exception, the error message will be written in the error message and passed along
+to the user. If your job has a method `suppress_exceptions` that returns a truthy value (default false),
+`ActiveWaiter::Job` will swallow the exception and not raise it - this means there will be no retry by
+`ActiveJob`.
+
+### Common Jobs
+
+#### ActiveWaiter::EnumerableJob
+
+If you need to wait, you're likely doing one thing slowly or many things. For the latter case, you can just
+`include ActiveWaiter::EnumerableJob` and add a few interface methods
+
+``` ruby
+def before(*args); end # called once with arguments of `perform`
+def enumerable; [] end # an Enumerable interface
+def items_count; 1 end # called 0-n times, depending on enumerable
+def foreach(item); end # called 0-n times, depending on enumerable
+def after;         end # called once
+def result;        end # called once
+```
+
+Here's an example from our test code, that will generate an array of range `0...count` and return the sum
+of all the numbers
+
+``` ruby
+class LoopJob < ActiveJob::Base
+  include ActiveWaiter::EnumerableJob
+
+  attr_accessor :items_count, :enumerable, :result
+
+  def before(count)
+    @items_count = count
+    @enumerable = count.times
+    @result = 0
+  end
+
+  def foreach(item)
+    @result += item
+  end
+end
+```

data/app/controllers/active_waiter/jobs_controller.rb

@@ -13,7 +13,7 @@ module ActiveWaiter
 
     protected
 
-      def on_not_found(data)
+      def on_not_found(_data)
         raise ActionController::RoutingError.new('Not Found')
       end
 

data/lib/active_waiter/enumerable_job.rb

@@ -0,0 +1,29 @@
+module ActiveWaiter::EnumerableJob
+  extend ActiveSupport::Concern
+
+  included do
+    include ActiveWaiter::Job
+  end
+
+  def perform(*args)
+    before(*args)
+    enumerable.each_with_index do |item, index|
+      foreach(item)
+      update_active_waiter(percentage: (100 * (index+1.to_f) / items_count))
+    end
+    after
+    result
+  end
+
+  def before(*_args); end # called once with arguments of `perform`
+
+  def enumerable; [] end # an Enumerable interface
+
+  def items_count; 1 end # called 0-n times, depending on enumerable
+
+  def foreach(_item); end # called 0-n times, depending on enumerable
+
+  def after;         end # called once
+
+  def result;        end # called once
+end

data/lib/active_waiter/job.rb

@@ -13,7 +13,7 @@ module ActiveWaiter::Job
         ::ActiveWaiter.write(@active_waiter_options[:uid], {
           error: $!.to_s,
         })
-        raise
+        raise unless suppress_exceptions
       end
     end
   end
@@ -24,4 +24,6 @@ module ActiveWaiter::Job
       error: error,
     }) if @active_waiter_options.try(:[], :uid)
   end
+
+  def suppress_exceptions; false; end
 end

data/lib/active_waiter/version.rb

@@ -1,3 +1,3 @@
 module ActiveWaiter
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/active_waiter.rb

@@ -1,6 +1,7 @@
 require "active_waiter/engine"
 require "active_waiter/configuration"
 require "active_waiter/job"
+require "active_waiter/enumerable_job"
 
 module ActiveWaiter
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_waiter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - choonkeat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple mechanism allowing your users to wait for the completion of
   your `ActiveJob`
 email:
@@ -78,6 +92,7 @@ files:
 - lib/active_waiter.rb
 - lib/active_waiter/configuration.rb
 - lib/active_waiter/engine.rb
+- lib/active_waiter/enumerable_job.rb
 - lib/active_waiter/job.rb
 - lib/active_waiter/version.rb
 - lib/tasks/waiter_tasks.rake