simple_lock 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e1bc79cf05fb49bb0c5bb534dd371f58f1128f2dace0d89ffe158a9554ef165b
+  data.tar.gz: 11d9f6d973acc1385195f21919e7aa27eb807bed2a7017cba326bd4f51c9e776
+SHA512:
+  metadata.gz: b2512f7dea061d557af92adadc02d8eab15aa300bad6e3e5841ed4ebf859a909ab9641d9b2476fda3a1a4129f16f95e10c579508d237583c58f2d6349a55d2a8
+  data.tar.gz: 9b6a9439032b7309cb5b829778f939b0c4d875511e3bbd1e0bc3b13448d82a3ed2dd189137cd3d38e0979bb0390023c8497c7c20ec3720e93ebdc5cf318c43a4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 2.7.0
+  NewCops: disable
+  SuggestExtensions: false
+  Include:
+    - lib/simple_lock.rb
+    - lib/simple_lock/*.rb
+    - spec/*.rb
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*.rb
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-12-27
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 caiodsc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,141 @@
+
+# SimpleLock
+
+**SimpleLock** is a simple implementation of distributed locking using Ruby and Redis, designed to prevent deadlocks and ensure that concurrent processes can be managed efficiently.
+
+## Installation
+
+Add the gem to your `Gemfile`:
+
+```ruby
+gem "simple_lock"
+```
+
+Then run the following command:
+
+```bash
+bundle install
+```
+
+Or, if you prefer installing it directly via terminal:
+
+```bash
+gem install simple_lock
+```
+
+## Usage
+
+### Simple Locking
+
+The main goal of **SimpleLock** is to provide a distributed locking mechanism. You can use the gem to ensure that only one process or thread can access a critical resource or operation at a time.
+
+### Basic Example
+
+```ruby
+# Using the simple lock with a key and expiration time (TTL)
+locked = SimpleLock.lock("my_unique_lock_key", 30)
+
+if locked
+  # Execute the critical operation
+  puts "Lock acquired! Executing critical operation."
+else
+  # Lock couldn't be acquired, another process already has it
+  puts "Failed to acquire lock, try again later."
+end
+```
+
+### Using with Block
+
+You can also use **SimpleLock** with a block, ensuring the lock will be automatically released when the block finishes, even if an exception occurs:
+
+```ruby
+SimpleLock.lock("my_unique_lock_key", 30) do |locked|
+  if locked
+    # Critical operation
+    puts "Safe operation is running."
+  else
+    # Couldn't acquire the lock
+    puts "Failed to acquire lock."
+  end
+end
+```
+
+### Unlocking
+
+You can manually release the lock using the `unlock` method:
+
+```ruby
+SimpleLock.unlock("my_unique_lock_key")
+```
+
+## Configuration
+
+You can configure various behaviors of the gem, such as the key prefix, retry count, retry delay, and more.
+
+### Example Configuration:
+
+```ruby
+SimpleLock.config.key_prefix = "simple_lock:"
+SimpleLock.config.retry_count = 3
+SimpleLock.config.retry_delay = 200 # in milliseconds
+SimpleLock.config.retry_jitter = 50 # in milliseconds
+SimpleLock.config.retry_proc = Proc.new { |attempt| attempt * 100 }
+```
+
+## Features
+
+- **Distributed locking and unlocking** with Redis.
+- **Automatic retry** with increasing delay and jitter, useful for high-concurrency systems.
+- **Safe unlocking** even in case of failure.
+- **Low latency** and easy integration.
+
+## Development
+
+After cloning the repository, install dependencies:
+
+```bash
+bin/setup
+```
+
+Run tests:
+
+```bash
+rake spec
+```
+
+To interact with the code in the console:
+
+```bash
+bin/console
+```
+
+To install the gem locally:
+
+```bash
+bundle exec rake install
+```
+
+### Releasing a New Version
+
+1. Update the version number in `lib/simple_lock/version.rb`.
+2. Run the command to release the version:
+
+```bash
+bundle exec rake release
+```
+
+This will create a Git tag, push the code, and upload the `.gem` file to RubyGems.
+
+## Contributing
+
+Contributions are welcome! Open an issue or submit a pull request on the [GitHub repository](https://github.com/caiodsc/simple_lock).
+
+1. Fork the project.
+2. Create a new branch (`git checkout -b feature-branch`).
+3. Commit your changes (`git commit -am 'Add new feature'`).
+4. Push to the branch (`git push origin feature-branch`).
+5. Create a new Pull Request.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/initializers/delegation.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require "set"
+
+module SimpleLock
+  module Delegation
+    class DelegationError < NoMethodError; end
+
+    RUBY_RESERVED_KEYWORDS = %w[__ENCODING__ __LINE__ __FILE__ alias and BEGIN begin break
+                                case class def defined? do else elsif END end ensure false for if in module next nil
+                                not or redo rescue retry return self super then true undef unless until when while yield].freeze
+    DELEGATION_RESERVED_KEYWORDS = %w[_ arg args block].freeze
+    DELEGATION_RESERVED_METHOD_NAMES = Set.new(
+      RUBY_RESERVED_KEYWORDS + DELEGATION_RESERVED_KEYWORDS
+    ).freeze
+
+    def delegate(*methods, to: nil, prefix: nil, allow_nil: nil, private: nil)
+      unless to
+        raise ArgumentError,
+              "Delegation needs a target. Supply a keyword argument 'to' (e.g. delegate :hello, to: :greeter)."
+      end
+
+      if prefix == true && /^[^a-z_]/.match?(to)
+        raise ArgumentError, "Can only automatically set the delegation prefix when delegating to a method."
+      end
+
+      method_prefix = \
+        if prefix
+          "#{prefix == true ? to : prefix}_"
+        else
+          ""
+        end
+
+      location = caller_locations(1, 1).first
+      file = location.path
+      line = location.lineno
+
+      receiver = to.to_s
+      receiver = "self.#{receiver}" if DELEGATION_RESERVED_METHOD_NAMES.include?(receiver)
+
+      method_def = []
+      method_names = []
+
+      method_def << "self.private" if private
+
+      methods.each do |method|
+        method_name = prefix ? "#{method_prefix}#{method}" : method
+        method_names << method_name.to_sym
+
+        definition = \
+          if /[^\]]=\z/.match?(method)
+            "arg"
+          else
+            method_object =
+              begin
+                if to.is_a?(Module)
+                  to.method(method)
+                elsif receiver == "self.class"
+                  method(method)
+                end
+              rescue NameError
+                # Do nothing. Fall back to `"..."`
+              end
+
+            if method_object
+              parameters = method_object.parameters
+
+              if (parameters.map(&:first) & %i[opt rest keyreq key keyrest]).any?
+                "..."
+              else
+                defn = parameters.filter_map { |type, arg| arg if type == :req }
+                defn << "&block"
+                defn.join(", ")
+              end
+            else
+              "..."
+            end
+          end
+
+        method = method.to_s
+        if allow_nil
+
+          method_def <<
+            "def #{method_name}(#{definition})" \
+            "  _ = #{receiver}" \
+            "  if !_.nil? || nil.respond_to?(:#{method})" \
+            "    _.#{method}(#{definition})" \
+            "  end" \
+            "end"
+        else
+          method_name = method_name.to_s
+
+          method_def <<
+            "def #{method_name}(#{definition})" \
+            "  _ = #{receiver}" \
+            "  _.#{method}(#{definition})" \
+            "rescue NoMethodError => e" \
+            "  if _.nil? && e.name == :#{method}" <<
+            %(   raise DelegationError, "#{self}##{method_name} delegated to #{receiver}.#{method}, but #{receiver} is nil: \#{self.inspect}") <<
+            "  else" \
+            "    raise" \
+            "  end" \
+            "end"
+        end
+      end
+      module_eval(method_def.join(";"), file, line)
+      method_names
+    end
+
+    def delegate_missing_to(target, allow_nil: nil)
+      target = target.to_s
+      target = "self.#{target}" if DELEGATION_RESERVED_METHOD_NAMES.include?(target) || target == "__target"
+
+      if allow_nil
+        module_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def respond_to_missing?(name, include_private = false)
+            # It may look like an oversight, but we deliberately do not pass
+            # +include_private+, because they do not get delegated.
+
+            return false if name == :marshal_dump || name == :_dump
+            #{target}.respond_to?(name) || super
+          end
+
+          def method_missing(method, *args, &block)
+            __target = #{target}
+            if __target.nil? && !nil.respond_to?(method)
+              nil
+            elsif __target.respond_to?(method)
+              __target.public_send(method, *args, &block)
+            else
+              super
+            end
+          end
+          ruby2_keywords(:method_missing)
+        RUBY
+      else
+        module_eval <<~RUBY, __FILE__, __LINE__ + 1
+          def respond_to_missing?(name, include_private = false)
+            # It may look like an oversight, but we deliberately do not pass
+            # +include_private+, because they do not get delegated.
+
+            return false if name == :marshal_dump || name == :_dump
+            #{target}.respond_to?(name) || super
+          end
+
+          def method_missing(method, *args, &block)
+            __target = #{target}
+            if __target.nil? && !nil.respond_to?(method)
+              raise DelegationError, "\#{method} delegated to #{target}, but #{target} is nil"
+            elsif __target.respond_to?(method)
+              __target.public_send(method, *args, &block)
+            else
+              super
+            end
+          end
+          ruby2_keywords(:method_missing)
+        RUBY
+      end
+    end
+  end
+end

data/lib/initializers/with.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module SimpleLock
+  module With
+    def with(**attributes)
+      old_values = {}
+      begin
+        attributes.each do |key, value|
+          old_values[key] = public_send(key)
+          public_send("#{key}=", value)
+        end
+        yield self
+      ensure
+        old_values.each do |key, old_value|
+          public_send("#{key}=", old_value)
+        end
+      end
+    end
+  end
+end

data/lib/simple_lock/config.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module SimpleLock
+  class Config
+    extend SimpleLock::Delegation
+
+    DEFAULT_CONFIG = OpenStruct.new(
+      {
+        retry_count: 3,
+        retry_delay: 200,
+        retry_jitter: 50,
+        retry_proc: nil,
+        key_prefix: "simple_lock:"
+      }
+    )
+
+    def initialize
+      @config = DEFAULT_CONFIG
+    end
+
+    delegate_missing_to :@config, allow_nil: false
+
+    def respond_to_missing?(method_name, ...)
+      DEFAULT_CONFIG.table.keys.include?(method_name.to_s.delete_suffix("=").to_sym)
+    end
+  end
+end

data/lib/simple_lock/redis.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SimpleLock
+  class Redis
+    extend SimpleLock::Delegation
+
+    def initialize(url: nil)
+      @redis = ::Redis.new(url: url)
+    end
+
+    delegate_missing_to :@redis, allow_nil: false
+  end
+end

data/lib/simple_lock/scripts.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require "digest"
+
+module SimpleLock
+  Script = Struct.new(:raw) do
+    def sha
+      @sha ||= Digest::SHA1.hexdigest(raw)
+    end
+  end
+
+  LOCK_VALUE = "1"
+
+  SCRIPTS = {
+    lock: Script.new("return redis.call('set', KEYS[1], #{LOCK_VALUE}, 'NX', 'PX', ARGV[1])"),
+    unlock: Script.new("redis.call('del', KEYS[1])")
+  }.freeze
+end

data/lib/simple_lock/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleLock
+  VERSION = "1.0.0"
+end

data/lib/simple_lock.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "redis"
+
+Dir["./lib/initializers/*.rb"].sort.each { |f| require(f) }
+Dir["./lib/simple_lock/*.rb"].sort.each { |f| require(f) }
+
+module SimpleLock
+  extend SimpleLock::With
+
+  class Error < StandardError; end
+
+  NOSCRIPT_MAX_RETRIES = 1
+
+  def self.client
+    @client ||= SimpleLock::Redis.new(url: nil)
+  end
+
+  def self.client=(client_or_url)
+    case client_or_url
+    when SimpleLock::Redis
+      @client = client
+    when String
+      @client = SimpleLock::Redis.new(url: client_or_url)
+    else
+      raise ArgumentError, "client must be an instance of SimpleLock::Redis or a String"
+    end
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def self.lock(key, ttl)
+    key = "#{config.key_prefix}#{key}"
+
+    locked = (config.retry_count + 1).times.any? do |attempt|
+      sleep(backoff_for_attempt(attempt)) unless attempt.zero?
+
+      safe_exec_script(SCRIPTS[:lock], [key], [ttl]) == "OK"
+    end
+
+    return locked unless block_given?
+
+    begin
+      yield(locked)
+    ensure
+      unlock(key) if locked
+    end
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  def self.unlock(key)
+    key = "#{config.key_prefix}#{key}"
+
+    safe_exec_script(SCRIPTS[:unlock], [key])
+  rescue StandardError
+    # Nothing to do, this is just a best-effort attempt.
+  end
+
+  def self.load_scripts
+    SCRIPTS.each_value do |script|
+      client.script("load", script.raw)
+    end
+  end
+
+  def self.safe_exec_script(script, ...)
+    retries = 0
+
+    begin
+      client.evalsha(script.sha, ...)
+    rescue ::Redis::CommandError => e
+      if e.message.include?("NOSCRIPT") && (retries += 1) <= NOSCRIPT_MAX_RETRIES
+        load_scripts
+        retry
+      end
+
+      raise Error, e.message
+    end
+  end
+
+  def self.backoff_for_attempt(attempt)
+    delay = config.retry_proc.respond_to?(:call) ? config.retry_proc.call(attempt) : config.retry_delay
+
+    (delay + rand(config.retry_jitter)).fdiv(1000)
+  end
+end

data/sig/simple_lock.rbs

@@ -0,0 +1,4 @@
+module SimpleLock
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: simple_lock
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- caiodsc
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description:
+email:
+- caio.dscamara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/initializers/delegation.rb
+- lib/initializers/with.rb
+- lib/simple_lock.rb
+- lib/simple_lock/config.rb
+- lib/simple_lock/redis.rb
+- lib/simple_lock/scripts.rb
+- lib/simple_lock/version.rb
+- sig/simple_lock.rbs
+homepage: https://github.com/caiodsc/simple_lock
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/caiodsc/simple_lock
+  source_code_uri: https://github.com/caiodsc/simple_lock
+  changelog_uri: https://github.com/caiodsc/simple_lock/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: Simple Deadlock implementation using Ruby.
+test_files: []