activejob-lockable 0.1.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 664f6c1cc3b4fcaa153c34c1a3dd734c66a45dbbcfa751d79c23a24f2e5bcc58
-  data.tar.gz: e1a97f5959d30c1357d77a2fe628e63a367215c08ee1c6e3bf57b33eb1faf4cd
+  metadata.gz: 17228343c0631b12e161a5107bcafca105666f2ae6427a390fa1abca3fbf6ecd
+  data.tar.gz: 0e6f680d5345f613ec56eee6c679762d5e8d1d8d7527b74bdd110b9cbfdeb0d5
 SHA512:
-  metadata.gz: 45c4f6b76f35093fbf81926898794ccac7444b8aef051b16e7b6113956f65ef02a0fae3b3d1d8282758a226de4a6a712ddae4e3c426d5e6a488ffefb4e07955f
-  data.tar.gz: 5343ddb76f4e63fe321604d2f73df42d98d89d030922489878db6b6e6c9af5e30d7dc1f0e5a650679e05e46b2f453e0a8ad2cbb73bc95561472efc601ba4a077
+  metadata.gz: 19975324abaee6a55dacb7b2f36ae3d822e54d5736085af01219f8190cd48993b999f0bdeb998a8691d203a45b44cef4b8dc02ac7b2244cc247ec96d959c4528
+  data.tar.gz: 40568b070ef7b83a7de563095c4dcded599b3efd3f6b531037a47540a0a9007087ef2d1281f915ce8c82cc4f17e88bffb7293397dded56c8b9cb29e1270e1f39

data/.github/workflows/rubygems.yml

@@ -0,0 +1,35 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - lib/activejob/lockable/version.rb
+
+jobs:
+  build:
+    name: Build and publish
+    runs-on: ubuntu-latest
+    environment: master
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby 3.2
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2.2
+
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+name: Tests
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.1', '3.2']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/README.md

@@ -1,4 +1,6 @@
-# ActiveJob::Lockable [![Build Status](https://travis-ci.org/qonto/activejob-lockable.svg?branch=master)](https://travis-ci.org/qonto/activejob-lockable)
+![Gem Version](https://badge.fury.io/rb/activejob-lockable.svg) ![CI Status](https://github.com/qonto/activejob-lockable/actions/workflows/tests.yml/badge.svg)
+
+# ActiveJob::Lockable
 
 Gem to make to make jobs lockable. Useful when a job is called N times, but only a single execution is needed.
 
@@ -17,7 +19,7 @@ And then execute:
 Or install it yourself as:
 
     $ gem install activejob-lockable
-    
+
 ## Configuration
 
 Create an initializer with redis connection:
@@ -102,3 +104,7 @@ Bug reports and pull requests are welcome on GitHub at [qonto/activejob-lockable
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Releasing
+
+To publish a new version to rubygems, update the version in `lib/activejob/lockable/version.rb`, and merge.

data/activejob-lockable.gemspec

@@ -23,9 +23,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activejob'
   spec.add_dependency 'activesupport'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'fakeredis'
   spec.add_development_dependency 'pry'
 end

data/lib/activejob/lockable/lockable.rb

@@ -16,31 +16,25 @@ module ActiveJob
 
       def enqueue(options = {})
         @options = options
-        if locked?
-          logger.info "Job is locked, expires in #{locked_ttl} second(s)"
-          send(on_locked_action) if on_locked_action && respond_to?(on_locked_action)
-        else
-          lock!
-          super(options)
-        end
+        return trigger_on_locked_action unless lock!
+
+        super(options)
       end
 
       def lock!
-        return if lock_period.to_i <= 0
+        return true if lock_period.to_i <= 0
         logger.info "Acquiring lock #{lock_extra_info}"
-        begin
-          # `:ex => Fixnum`: Set the specified expire time, in seconds.
-          # `:nx => true`: Only set the key if it does not already exist.
-          lock_acquired = ActiveJob::Lockable::RedisStore.set(
-            lock_key,
-            self.job_id,
-            { ex: lock_period.to_i, nx: true }
-          )
-          raise "Could not acquire lock #{lock_extra_info}" unless lock_acquired
-        rescue StandardError => e
-          logger.info "EXCEPTION acquiring lock #{lock_extra_info}"
-          raise
-        end
+        # `:ex => Fixnum`: Set the specified expire time, in seconds.
+        # `:nx => true`: Only set the key if it does not already exist.
+        # Returns boolean, lock acquired or not
+        ActiveJob::Lockable::RedisStore.set(
+          lock_key,
+          self.job_id,
+          { ex: lock_period.to_i, nx: true }
+        )
+      rescue StandardError => e
+        logger.info "EXCEPTION acquiring lock #{lock_extra_info}"
+        raise
       end
 
       def unlock!
@@ -55,7 +49,7 @@ module ActiveJob
       end
 
       def locked?
-        ActiveJob::Lockable::RedisStore.exists?(lock_key)
+        ActiveJob::Lockable::RedisStore.exists?(lock_key) != 0
       end
 
       def locked_ttl
@@ -70,6 +64,11 @@ module ActiveJob
         options[:lock].to_i
       end
 
+      def trigger_on_locked_action
+        logger.info "Job is locked, expires in #{locked_ttl} second(s)"
+        public_send(on_locked_action) if on_locked_action && respond_to?(on_locked_action)
+      end
+
       def lock_extra_info
         "[key #{lock_key}] [seconds #{lock_period.to_i}] [job_id #{self.job_id}] [class_name: #{self.class}]"
       end

data/lib/activejob/lockable/redis_store.rb

@@ -3,7 +3,7 @@ module ActiveJob
     class RedisStore
       class << self
         def set(cache_key, cache_value, options = {})
-          ActiveJob::Lockable.redis.set(cache_key, cache_value, options)
+          ActiveJob::Lockable.redis.set(cache_key, cache_value, **options)
         end
 
         def exists?(cache_key)

data/lib/activejob/lockable/version.rb

@@ -1,5 +1,5 @@
 module ActiveJob
   module Lockable
-    VERSION = '0.1.5'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activejob-lockable
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Dmytro Zakharov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-13 00:00:00.000000000 Z
+date: 2023-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -42,44 +42,44 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeredis
   requirement: !ruby/object:Gem::Requirement
@@ -115,9 +115,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rubygems.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Prevents jobs from enqueuing with unique arguments for a certain period of

data/.travis.yml

@@ -1,13 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-- 2.4.2
-deploy:
-  skip_cleanup: true
-  provider: rubygems
-  api_key:
-    secure: aD0lrk/+PZnWSJVdDRHFB6kzea1dmJl1nlWXMsyr0s5FlXPGuF1O01LEJIxQSNhl2AiA/yQBbT/ldcEsYyzYvRJWlkXbzzfTNa3pl0MYM3U7lDfAA9oJn2Xis/jiW7pI+vEehIA+6V5rr/V1KBNrxxveWQhcpfiQi7p6efF/XBugCqNhVW8G/NLN2S2Zi5ITFekAHoubYh1h0stFqnt9pxKLlm3eTBjs77DsMtLZtoy5KIMptRCOxTSOGteqFy/saeDWEPTWJWaKZ6zJ4bCQG15WJIJ+J+zcCO3kTD+hZUGkOgsy/lYuwOPu845f16kstPVBkqbcxbCdrQaI5sgwwdGNLF14yzwFS8c309ZC9Wnx6QsfPdQjV6Ol4ZTufVqi3EMEmvJQ78gX2T3J8E/6Cer4Ay2vrny5SyzekFSbGcMPr++iGk4JVn/jgEulAxMvDJoqdrJhETCKAcPlk1EesPUPP5JuXuW6HfDXNEYvv7Bzo2xVuaUsNvSMLsbZai7E2PchkBYApIKg9A6hFkt7ymiAIszMiSDuIj90aBtKpOIoMw6TyRp/x0qXJkPw2UOO22YJHeJanEjKtc2jk3r65FPCRKna3GcHXBXGAcJTKP2fJdBcRKtB7Y/SjRq84uDZJxwNKRBfyCittpMuu20uln+ylQzE9hnM28O7dOUfNBs=
-  gem: activejob-lockable
-  on:
-    tags: true
-    repo: qonto/activejob-lockable