activejob-locking 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1b1ea7063b5406f553e6d4282892299b6733cf5
-  data.tar.gz: 4fc8b9e358ec0583dc02eb6e6c069ef079653ad4
+  metadata.gz: dc5170f734ea482c37205c31fd82389b4a67225c
+  data.tar.gz: 9a54a53cbd88f1da58824e05b1c51502020787e0
 SHA512:
-  metadata.gz: e84f37fc29ad783441943835f2157e530522dc52ff2e6953c047d029e2d19ad654c6c2f300ae1df277013c7f9e2cca8cd048002e234fb81f518f4572aff667e8
-  data.tar.gz: 9f05089c530aa8bcb0db266eda5210126d7d25634462495c448861b9057aa7d9ff037301081b74c1ca90de574fc62b9358bca76d88059c035383903e88a523a2
+  metadata.gz: f7c86564b3c0d43210e7fe90abb524d4a8e7151113ea950edf5625590986e954a46e8be3da0f24118ff43ac81064c9e85929da66a4af9e52d133aa1ab3e912fb
+  data.tar.gz: 2e13fe88cfcb4cba7cc953986d29e076b704fad7400e6b59075f3fd491f7fb785428f6edf9be97fad5ff2b6858f37ffc3367282ff2b0d9e59e8986a6c5052ed1

data/HISTORY.md

@@ -1,3 +1,7 @@
+## 0.3.0 (2017-06-21)
+
+- Change lock_key signature
+
 ## 0.2.0 (2017-06-20)
 
 - Bug fixes

data/README.md

@@ -34,11 +34,11 @@ class UniqueJob < ActiveJob::Base
   include ActiveJob::Locking::Unique
 
   # Make sure the lock_key is always the same
-  def lock_key
+  def lock_key(object)
     self.class.name
   end
  
-  def perform
+  def perform(object)
     # do some work
   end
 end
@@ -102,12 +102,14 @@ and performed.
 By default the key is defined as:
 
 ```ruby
- def lock_key
+ def lock_key(*args)
    [self.class.name, serialize_arguments(self.arguments)].join('/')
  end 
 ```
 Thus it has the format `<job class name>/<serialized_job_arguments>`
 
+The args passed to the lock key method are the same that are passed to the job's perform method.
+
 To use this gem, you will want to override this method per job.
   
 ### Examples
@@ -115,7 +117,7 @@ To use this gem, you will want to override this method per job.
 Allow only one job per queue to be enqueued or performed: 
   
 ```ruby
- def lock_key
+ def lock_key(*args)
    self.queue
  end 
 ```
@@ -123,7 +125,7 @@ Allow only one job per queue to be enqueued or performed:
 Allow only one instance of a job class to be enqueued of performed:  
   
 ```ruby
- def lock_key
+ def lock_key(*args)
    self.class.name
  end 
 ```

data/lib/activejob/locking/base.rb

@@ -24,7 +24,7 @@ module ActiveJob
           self.adapter.lock_token = job_data['lock_token']
         end
 
-        def lock_key
+        def lock_key(*args)
           [self.class.name, serialize_arguments(self.arguments)].join('/')
         end
 
@@ -36,8 +36,12 @@ module ActiveJob
             # Merge local and global options
             merged_options = ActiveJob::Locking.options.dup.merge(self.class.lock_options)
 
+            # Get the key
+            base_key = self.lock_key(*self.arguments)
+            key = "activejoblocking:#{base_key}"
+
             # Remember the lock might be acquired in one process and released in another
-            merged_options.adapter.new(self.lock_key, merged_options)
+            merged_options.adapter.new(key, merged_options)
           end
           @adapter
         end

data/test/jobs/fail_job.rb

@@ -4,7 +4,7 @@ class FailJob < ActiveJob::Base
   self.lock_acquire_time = 2
 
   # We want the job ids to be all the same for testing
-  def lock_key
+  def lock_key(index, sleep_time)
     self.class.name
   end
 

data/test/jobs/serial_job.rb

@@ -4,7 +4,7 @@ class SerialJob < ActiveJob::Base
   self.lock_acquire_time = 2
 
   # We want the job ids to be all the same for testing
-  def lock_key
+  def lock_key(index, sleep_time)
     self.class.name
   end
 

data/test/jobs/unique_job.rb

@@ -4,7 +4,7 @@ class UniqueJob < ActiveJob::Base
   self.lock_acquire_time = 2
 
   # We want the job ids to be all the same for testing
-  def lock_key
+  def lock_key(index, sleep_time)
     self.class.name
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activejob-locking
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Charlie Savage