Rubocop

Author: lifeBCE

.rubocop.yml

@@ -1,8 +1,41 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 3.1
+  Exclude:
+    - 'test.rb'
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+# TODO: revisit this exclusion - (zero?)
+Style/NumericPredicate:
+  Exclude:
+    - lib/redis_single_file/semaphore.rb
+
+#
+# rspec stuff
+#
+
+# Prefer have_received for setting message expectations.
+#   Setup redis_mock as a spy using allow or instance_spy.
+RSpec/MessageSpies:
+  Enabled: false
+
+# Prefer allow over expect when configuring a response.
+RSpec/StubbedMock:
+  Enabled: false
 
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
+# Example has too many expectations [3/1].
+RSpec/MultipleExpectations:
+  Max: 6
 
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+# Example has too many lines. [8/5]
+RSpec/ExampleLength:
+  Max: 10

Gemfile

@@ -1,16 +1,18 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in redis_single_file.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'
 
-gem "rspec", "~> 3.0"
+gem 'rspec', '~> 3.0'
 
-gem "rubocop", "~> 1.21"
+gem 'rubocop', '~> 1.21'
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 3.4.0 '
 
-gem "pry", "~> 0.15.2"
+gem 'pry', '~> 0.15.2'
 
 gem 'mock_redis', '~> 0.49.0'

Gemfile.lock

@@ -56,6 +56,10 @@ GEM
       unicode-display_width (>= 2.4.0, < 4.0)
     rubocop-ast (1.38.0)
       parser (>= 3.3.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.4.0)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     unicode-display_width (3.1.4)
       unicode-emoji (~> 4.0, >= 4.0.4)
@@ -72,6 +76,8 @@ DEPENDENCIES
   redis-single-file!
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 3.4.0)
 
 BUNDLED WITH
    2.6.3

Rakefile

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+require 'rubocop/rake_task'
 
 RuboCop::RakeTask.new
 

bin/console

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "bundler/setup"
-require "redis_single_file"
+require 'bundler/setup'
+require 'redis_single_file'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

lib/redis_single_file.rb

@@ -3,10 +3,20 @@
 require 'redis'
 require 'singleton'
 
-require_relative "redis_single_file/version"
-require_relative "redis_single_file/configuration"
-require_relative "redis_single_file/semaphore"
+require_relative 'redis_single_file/version'
+require_relative 'redis_single_file/configuration'
+require_relative 'redis_single_file/semaphore'
 
+#
+# RedisSingleFile - Distributed Execution Synchronization
+#
+# Redis single file is a queue-based implementation of a remote/shared
+# semaphore for distributed execution synchronization. A distributed
+# semaphore may be useful for synchronizing execution across numerous
+# instances or between the application and background job workers.
+#
+# @author lifeBCE
+#
 module RedisSingleFile
   # alias semaphore as mutex
   Mutex = Semaphore

lib/redis_single_file/semaphore.rb

@@ -82,7 +82,7 @@ def initialize(
     # @return [nil] redis blpop timeout
     def synchronize(timeout: 0, &blk)
       synchronize!(timeout:, &blk)
-    rescue QueueTimeout => _err
+    rescue QueueTimeout => _e
       nil
     end
 
@@ -140,16 +140,14 @@ def unlock_queue
     end
 
     def with_retry_protection
-      begin
-        yield if block_given?
-      rescue Redis::ConnectionError => _err
-        retry_count ||= 0
-        retry_count  += 1
+      yield if block_given?
+    rescue Redis::ConnectionError => _e
+      retry_count ||= 0
+      retry_count  += 1
 
-        # retry 5 times over 15 seconds then give up
-        sleep(retry_count) && retry if retry_count < 6
-        raise # re-raise after all retries exhausted
-      end
+      # retry 5 times over 15 seconds then give up
+      sleep(retry_count) && retry if retry_count < 6
+      raise # re-raise after all retries exhausted
     end
   end
 end

lib/redis_single_file/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RedisSingleFile
-  VERSION = "0.1.1"
+  VERSION = '0.1.1'
 end

redis-single-file.gemspec

@@ -1,24 +1,24 @@
 # frozen_string_literal: true
 
-require_relative "lib/redis_single_file/version"
+require_relative 'lib/redis_single_file/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "redis-single-file"
+  spec.name = 'redis-single-file'
   spec.version = RedisSingleFile::VERSION
-  spec.authors = ["LifeBCE"]
-  spec.email = ["[email protected]"]
+  spec.authors = ['LifeBCE']
+  spec.email = ['[email protected]']
 
-  spec.summary = "Distributed semaphore implementation with redis."
-  spec.description = "Synchronize execution across numerous instances."
-  spec.homepage = "https://coming.com/soon"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.1.0"
+  spec.summary = 'Distributed semaphore implementation with redis.'
+  spec.description = 'Synchronize execution across numerous instances.'
+  spec.homepage = 'https://coming.com/soon'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.1.0'
 
-  spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+  spec.metadata['allowed_push_host'] = "TODO: Set to your gem server 'https://example.com'"
 
-  spec.metadata["homepage_uri"] = spec.homepage
-#  spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-#  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  spec.metadata['homepage_uri'] = spec.homepage
+  #  spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -29,13 +29,14 @@ Gem::Specification.new do |spec|
         f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
     end
   end
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "redis", "~> 5.3.0"
+  spec.add_dependency 'redis', '~> 5.3.0'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

spec/redis_single_file/configuration_spec.rb

@@ -1,7 +1,17 @@
 # frozen_string_literal: true
 
 RSpec.describe RedisSingleFile::Configuration do
-  it "defaults are configured as expected" do
+  after do
+    # reset singleton to defaults
+    RedisSingleFile.configuration do |config|
+      config.host = RedisSingleFile::Configuration::DEFAULT_HOST
+      config.port = RedisSingleFile::Configuration::DEFAULT_PORT
+      config.name = RedisSingleFile::Configuration::DEFAULT_NAME
+      config.expire_in = RedisSingleFile::Configuration::DEFAULT_EXPIRE_IN
+    end
+  end
+
+  it 'defaults are configured as expected' do
     expect(RedisSingleFile::Configuration::DEFAULT_HOST).to eq('localhost')
     expect(RedisSingleFile::Configuration::DEFAULT_PORT).to eq('6379')
     expect(RedisSingleFile::Configuration::DEFAULT_NAME).to eq('default')
@@ -10,34 +20,26 @@
     expect(RedisSingleFile::Configuration::DEFAULT_QUEUE_KEY).to eq('RedisSingleFile/Queue/%s')
   end
 
-  it "delegations return expected default values" do
-    expect(RedisSingleFile::Configuration.host).to eq('localhost')
-    expect(RedisSingleFile::Configuration.port).to eq('6379')
-    expect(RedisSingleFile::Configuration.name).to eq('default')
-    expect(RedisSingleFile::Configuration.expire_in).to eq(300)
-    expect(RedisSingleFile::Configuration.mutex_key).to eq('RedisSingleFile/Mutex/%s')
-    expect(RedisSingleFile::Configuration.queue_key).to eq('RedisSingleFile/Queue/%s')
+  it 'delegations return expected default values' do
+    expect(described_class.host).to eq('localhost')
+    expect(described_class.port).to eq('6379')
+    expect(described_class.name).to eq('default')
+    expect(described_class.expire_in).to eq(300)
+    expect(described_class.mutex_key).to eq('RedisSingleFile/Mutex/%s')
+    expect(described_class.queue_key).to eq('RedisSingleFile/Queue/%s')
   end
 
-  it "configuration block changes values" do
+  it 'configuration block changes values' do
     RedisSingleFile.configuration do |config|
       config.host = 'test_host'
       config.port = '1234'
       config.name = 'queue_name'
       config.expire_in = 100
     end
 
-    expect(RedisSingleFile::Configuration.host).to eq('test_host')
-    expect(RedisSingleFile::Configuration.port).to eq('1234')
-    expect(RedisSingleFile::Configuration.name).to eq('queue_name')
-    expect(RedisSingleFile::Configuration.expire_in).to eq(100)
-
-    # reset singleton to defaults
-    RedisSingleFile.configuration do |config|
-      config.host = RedisSingleFile::Configuration::DEFAULT_HOST
-      config.port = RedisSingleFile::Configuration::DEFAULT_PORT
-      config.name = RedisSingleFile::Configuration::DEFAULT_NAME
-      config.expire_in = RedisSingleFile::Configuration::DEFAULT_EXPIRE_IN
-    end
+    expect(described_class.host).to eq('test_host')
+    expect(described_class.port).to eq('1234')
+    expect(described_class.name).to eq('queue_name')
+    expect(described_class.expire_in).to eq(100)
   end
 end