race_block 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fabe01c4bff14ed3b474f4ebdefed580c6e99882ff1109f6039cb3455de624a9
-  data.tar.gz: bb1476d977667ab35fba7614b3ba4f5fce3d7d7c3cfd4ceeebf15d4301a09a86
+  metadata.gz: 6891e1559d3458e5ce722b5d5c384fc9820fd0c7ea6fddf9a24a51e515fa6e96
+  data.tar.gz: 956a5414c1a69d3c55f5d7e8ccf6ce885f766544736dc92a26b8d4f1ce967ccb
 SHA512:
-  metadata.gz: 6f05edc168a9e77c0200b898592f2bc1d1c44830deb23de29bd0c7d386d95f4426a7851590351c12b0e8b00a449f16bba1bd2313e65f249a72b8ce1e41a9fde8
-  data.tar.gz: 62e7a5934630e63e267f01116ef649072450e2d3938e80215b17298b3569c456bd26f2508a5f0e19925b05c28af7d569b96e8ce3541ec580811debaad2d9fb5c
+  metadata.gz: 0f263d2351ec39423095fe1a4885fb6b0f80b1fd6a4792ff8ee5174af67fc16562c65ba0a8350cb82f2ec9e07121b409e2e40e3f3dd44ca076f3cb77e6fb8b01
+  data.tar.gz: 53c25dfa16723901211c7bae027497a20f009404cfe96ac8bcae6f837f1e6a23c99d3c3dda0d5b67173bb4b8d8f771861da5096f80ba0e4e80e122148e2fbeba

data/.deepsource.toml

@@ -0,0 +1,9 @@
+version = 1
+
+[[analyzers]]
+name = "shell"
+enabled = true
+
+[[analyzers]]
+name = "ruby"
+enabled = true

data/.rubocop_todo.yml

@@ -15,4 +15,4 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 91
+  Max: 103

data/README.md

@@ -62,7 +62,7 @@ RaceBlock.config.redis = Redis.new
 Any code that you want to be "thread-safe" and ensure is only executing in one location should be placed in a `RaceBlock` with a unique identifying key that will be checked across all instances.
 
 ```ruby
-RaceBlock.start('unique_key', {}) do
+RaceBlock.start('unique_key', **kwargs) do
     # Insert code that should only be executed once at a time here...
 end
 ```
@@ -97,6 +97,16 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/joeyparis/race_block. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joeyparis/race_block/blob/master/CODE_OF_CONDUCT.md).
 
+I am also interested in porting this project to multiple languages and would love help in the languages I am less familiar with.
+
+- [x] Ruby
+- [ ] JavaScript
+- [ ] Python
+- [ ] Go
+- [ ] LolCode
+- [ ] ..?
+
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/race_block/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RaceBlock
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/race_block.rb

@@ -50,35 +50,30 @@ module RaceBlock
     RaceBlock.client.del(RaceBlock.key(key))
   end
 
-  def self.start(key, expire: config.expire, expiration_delay: config.expiration_delay, **args)
-    raise("A Redis client must be added to the RaceBlock configuration") unless configuration.redis
-    raise("A key must be provided to start a RaceBlock") if key.empty?
+  def self.start(base_key, expire: config.expire, expiration_delay: config.expiration_delay, **args)
+    raise("A key must be provided to start a RaceBlock") if base_key.empty?
 
-    @key = RaceBlock.key(key)
+    key = RaceBlock.key(base_key)
 
     # Set an expiration for the token if the key is defined but doesn't
     # have an expiration set (happens sometimes if a thread dies early).
     # `-1` means the key is set but does not expire, `-2` means the key is
     # not set
-    RaceBlock.client.expire(@key, 10) if RaceBlock.client.ttl(@key) == -1
+    RaceBlock.client.expire(key, 10) if RaceBlock.client.ttl(key) == -1
 
     # Token already exists
-    # todo: Revoke version 0.2.1 because it always return nil no matter what (never committed but released because I'm not a smart man)
-    if RaceBlock.client.get(@key)
-      logger.debug("Token already exists") 
-      return
-    end
+    return logger.debug("Token already exists") if RaceBlock.client.get(key)
 
-    return unless set_token_and_wait(@key, **args)
+    return unless set_token_and_wait(key, **args)
 
-    RaceBlock.client.expire(@key, expire)
+    RaceBlock.client.expire(key, expire)
     logger.debug("Running block")
 
     r = yield
 
     # I have lots of internal debates on whether I should full
     # delete the key here or still let it sit for a few seconds
-    RaceBlock.client.expire(@key, expiration_delay)
+    RaceBlock.client.expire(key, expiration_delay)
 
     r
   end
@@ -101,7 +96,7 @@ module RaceBlock
     # moment, and I also believe this is what is keep the EmailQueue
     # stable which seems to have no duplicate sending problems.
 
-    return true if RaceBlock.client.get(@key) == token
+    return true if RaceBlock.client.get(key) == token
 
     # Token out of sync
     logger.debug("Token out of sync")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: race_block
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Joey Paris
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -94,7 +94,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.2.0
-description: 
+description:
 email:
 - joey@leadjig.com
 executables: []
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".actrc"
+- ".deepsource.toml"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
@@ -123,7 +124,7 @@ licenses:
 metadata:
   homepage_uri: https://rubygems.org/gems/race_block
   source_code_uri: https://github.com/joeyparis/race_block
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,8 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A Ruby code block wrapper to help prevent race conditions across multiple
   threads and even separate servers.