resque-population-control 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 393c9c0078543f7c093ea7b6a918212db58f2606
-  data.tar.gz: 124adb43a962a87db494620c432a1da3afb33e84
+  metadata.gz: 4c479293957e554a99b6d9eaee204547149bc2bc
+  data.tar.gz: ea106605ddf5dcb92f4707c073016c0ca18b41cf
 SHA512:
-  metadata.gz: 58b09927f36d92500573ca6ba36053bc1bc4c11eedb52152d325b80ca53e5f84c0a2c450d414a195493bc950dfc308401504c00093479d20b79f4eef2bc33bc1
-  data.tar.gz: f522188248425c90f140fdecd4d5e9f2ec5f0c538e618f0412544c751c282d52c422e55e7b9a4c66e0b511d020f76451c996a1e7c8eae964f0ab02d4b5581303
+  metadata.gz: 1d0d7928de244a58296757f893a32da9a3c9ce4865c373113abca921b36cc8c97813910a6c0d891764a7103f391433d92703f42c77ac40fe2c8b041269bf9b0b
+  data.tar.gz: 88624ec32e93f3b3bfc74c47020e2a5605fd9caa6c3ff497d5197c28f29c4b26bbfce12961d8846a008e0322aa8f0e58686e816a327cf6a27c17a7e73fe1f049

data/README.md

@@ -35,6 +35,25 @@ The following examples limits Job to having at most 100 enqeueud or running inst
         end
     end
 
+By default, a Resque::Plugins::PopulationControl::PopulationExceeded exception will be thrown whenever things get out of hand.
+If you wish to suppress this, there is an option to do that. This will cause things to fail silently and prevent any job from getting enqueued if the current population is past the limit.
+To get more info and visibility in these situations, you can implement on_population_exceeded to add things like logging and whatever else you deem needed.
+
+    class Job
+        extend Resque::Plugins::PopulationControl
+        population_control 100, :suppress_exceptions => true
+
+         @queue = :jobs
+
+        def self.perform(customer_id)
+           ...
+        end
+
+        def self.on_population_exceeded max_size, *args
+           logger.debug "Attempt to enqueue #{name} with payload #{args.inspect} failed since population exceeds #{max_size}."
+        end
+    end
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/resque/plugins/population_control.rb

@@ -1,12 +1,13 @@
 module Resque
   module Plugins
     module PopulationControl
-      VERSION = "0.3.0"
+      VERSION = "0.4.0"
 
       class PopulationExceeded < ::StandardError; end;
 
-      def population_control max
+      def population_control max, options = {}
         @population_control_max = max
+        @population_control_options = options
       end
 
       def population_controlled?
@@ -17,8 +18,10 @@ module Resque
         population_control_count = population_control_increment
         if population_control_count > population_control_max
           population_control_decrement
-          suppress_exception = respond_to?(:on_population_exceeded) && on_population_exceeded(population_control_max, *args)
-          unless suppress_exception
+          if respond_to? :on_population_exceeded
+            on_population_exceeded(population_control_max, *args)
+          end
+          unless @population_control_options[:suppress_exceptions]
             raise PopulationExceeded, "Enqueuing #{name} would exceed max allowed population of #{population_control_max}."
           end
           false

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-population-control
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Misha Conway
@@ -69,7 +69,6 @@ files:
 - bin/setup
 - lib/resque-population-control.rb
 - lib/resque/plugins/population_control.rb
-- lib/resque/population/control.rb
 - population-control.gemspec
 homepage: https://github.com/MishaConway/resque-population-control
 licenses: []

data/lib/resque/population/control.rb

@@ -1 +0,0 @@
-require '../plugins/population_control'