rails_soft_lock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 952f05764b7d784066806fb56d9e91481bf75e7b32116d67b0d0b808c067ef63
+  data.tar.gz: ca98fdc3816f3ae28e344d410f34ed80e445a836eeda7bc88972c732d4f45623
+SHA512:
+  metadata.gz: 51d3d93903af11c4fb821555fa0cbfa6308c8e5fe88d96be8ce9f5e0aaa36d31650aa35c169bc9dd233d9eda99c8a1c6aefd86641a9a8edf812324712ff5ee7a
+  data.tar.gz: 749c56642dbbee636c6053f612688a2f0306624dd5019aff37fa258e8ef20ef32443b33f48c88297d92723f456e6471bbdf644293048911581d4ebf650282053

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  NewCops: enable
+
+plugins:
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-rails
+  - rubocop-rspec_rails
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+RSpec/ExampleLength:
+  Max: 8
+
+Rails/ApplicationRecord:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.4.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-04-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Sergey Arkhipov
+
+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,104 @@
+# RailsSoftLock
+
+This gem implements the ability to lock Rails Active Records using adapters for in-memory databases, such as redis, nats, etc.
+Locks can be done by using the active record attribute.
+it is possible to define the uniqueness scope of the attribute.
+The gem is under active development.
+Currently, an adapter to redis-compatible databases, such as redis, walkey, etc., has been implemented.
+
+## Installation
+
+Install the gem and add to the application's Gemfile:
+
+```bash
+gem "rails_soft_lock", git: "https://github.com/sergey-arkhipov/rails_soft_lock.git"
+
+```
+
+After run
+
+```bash
+bundle install
+```
+
+Run rake task
+
+```bash
+rake rails_soft_lock:install
+
+```
+
+This will install config for gem, if file does not exists
+
+```ruby
+## config/initializers/rails_soft_lock.rb
+# frozen_string_literal: true
+
+# Configuration for RailsSoftLock gem
+# This file sets up the adapter and options for soft locking Active Record models
+require "rails_soft_lock"
+RailsSoftLock.configure do |config|
+  # Specify the adapter for storing locks
+  config.adapter = :redis
+
+  # Configuration for the Redis adapter
+  config.adapter_options = {
+    redis: Rails.application.config_for(:redis).merge(
+      timeout: 5
+    )
+  }
+```
+
+You can add any modification there.
+
+Gem use ConnectionPool inside for safety connect to Redis adapter (now inplemented)
+
+## Usage
+
+Gem assumes that the User model is used to determine the user who sets the lock.
+
+Model < ApplicationRecord should include `RailsSoftLock::ModelExtensions`
+and `acts_as_locked_by` with `acts_as_locked_scope` should be set, for example
+
+```ruby
+class Article < ApplicationRecord
+  include RailsSoftLock::ModelExtensions
+
+  acts_as_locked_by(:attribyte)
+  acts_as_locked_scope(proc { :scoped_attribute || "none" })
+
+```
+
+See `spec/rails_soft_lock/model_extensions_spec.rb for implemented methods`
+
+### Attention
+
+Pay attention how method `locak_or_find` work
+
+Method return hash
+`has_locked: false, locked_by: user.id`
+
+`has_lock`: false implies that there was no lock on the passed object before this point.
+Not to be confused with the result of executing the lock itself.
+Since this is an in-memory base and the goal is quick and easy access, the method sets the lock,
+reports that there was no lock before, and returns the user of the lock.
+If there was a lock, true is returned and the user of this current lock.
+The lock itself is not changed.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_soft_lock. 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/[USERNAME]/rails_soft_lock/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RailsSoftLock project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rails_soft_lock/blob/master/CODE_OF_CONDUCT.md).

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/rails_soft_lock/configuration.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# lib/rails_soft_lock/configuration.rb
+module RailsSoftLock
+  # Configuration class for RailsSoftLock gem.
+  class Configuration
+    # List of supported adapters.
+    VALID_ADAPTERS = %i[redis nats memcached].freeze
+    attr_reader :adapter
+    attr_accessor :adapter_options, :acts_as_locked_by, :acts_as_locked_scope
+
+    def initialize
+      @adapter = :redis # Default adapter
+      @adapter_options = adapter_options || {} # Default adapter options
+      @acts_as_locked_by = :none
+      @acts_as_locked_scope = -> { "default" }
+    end
+
+    def [](key)
+      send(key)
+    end
+
+    def []=(key, value)
+      send("#{key}=", value)
+    end
+
+    # Sets the adapter and validates it.
+    # @param value [Symbol] The adapter to use.
+    # @raise [ArgumentError] If the adapter is not supported.
+    def adapter=(value)
+      raise ArgumentError, "Adapter must be one of: #{VALID_ADAPTERS.join(", ")}" unless VALID_ADAPTERS.include?(value)
+
+      @adapter = value
+    end
+  end
+
+  class << self
+    # Configures the RailsSoftLock gem with a block.
+    # @yield [config] Yields the configuration object to the block.
+    # @return [void]
+    def configure
+      @configuration ||= Configuration.new
+      if block_given?
+        yield(@configuration)
+      else
+        warn "[RailsSoftLock] No configuration block provided in `configure`"
+      end
+    end
+
+    # Returns the current configuration instance.
+    # @return [Configuration] The configuration object.
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Resets the configuration (useful for testing).
+    # @return [void]
+    def reset_configuration
+      @configuration = nil
+    end
+  end
+end

data/lib/rails_soft_lock/lock_object.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+# lib/rails_soft_lock/lock_object.rb
+
+module RailsSoftLock
+  # Service for managing object locks
+  # A lock object contains the following parameters:
+  #   - object_name: The name of the lock storage, typically the model name with an optional scope
+  #   - object_key: The identifier of the lock instance, typically a unique database record ID
+  #   - object_value: The identifier of the locker that locked the record
+  class LockObject
+    # Подключаем адаптер на основе конфигурации
+    def self.adapter
+      case RailsSoftLock.configuration.adapter
+      when :redis
+        RailsSoftLock::RedisAdapter
+      when :nats
+        RailsSoftLock::NatsAdapter
+      when :memcached
+        RailsSoftLock::MemcachedAdapter
+      else
+        raise ArgumentError, "Unknown adapter: #{RailsSoftLock.configuration.adapter}"
+      end
+    end
+
+    include adapter
+
+    attr_reader :object_name, :object_key, :object_value
+
+    def initialize(object_name:, object_key: nil, object_value: nil)
+      @object_name = object_name
+      @object_key = object_key
+      @object_value = object_value.present? ? object_value.to_s : nil # Convert to string for consistency
+    end
+
+    # Returns the ID of the locker who locked the object
+    # @return [String, nil] The locker's ID or nil if not locked
+    def locked_by
+      get
+    end
+
+    # Attempts to lock the object or returns the existing lock
+    # @return [Hash] { has_locked: Boolean, locked_by: String or nil }
+    def lock_or_find
+      locked_object = get
+      { has_locked: create, locked_by: locked_object || object_value }
+    end
+
+    # Unlocks the object
+    # @return [Boolean] True if the lock was removed, false otherwise
+    def unlock
+      delete
+    end
+
+    # Returns all locks in the storage
+    # @return [Hash] All key-value pairs in the storage
+    def all_locks
+      all
+    end
+  end
+end

data/lib/rails_soft_lock/model_extensions.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# lib/rails_soft_lock/model_extensions.rb
+
+module RailsSoftLock
+  # Определяет настройки блокировки модели
+  module ModelExtensions
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def acts_as_locked_by(attribute = :none)
+        RailsSoftLock.configuration[:acts_as_locked_by] = attribute
+      end
+
+      def current_locked_attribute
+        RailsSoftLock.configuration[:acts_as_locked_by]
+      end
+
+      def acts_as_locked_scope(attribute = nil)
+        RailsSoftLock.configuration[:acts_as_locked_scope] = attribute || -> { "default" }
+      end
+
+      def current_locked_scope
+        RailsSoftLock.configuration[:acts_as_locked_scope]
+      end
+
+      def all_locks
+        RailsSoftLock::LockObject.new(object_name: object_name).all_locks
+      end
+
+      def unlock(object_key)
+        RailsSoftLock::LockObject.new(object_name: object_name, object_key: object_key).unlock
+      end
+
+      def object_name
+        scope = current_locked_scope&.call || "default"
+        "#{name}-#{scope}"
+      end
+    end
+
+    included do # rubocop:disable Metrics/BlockLength
+      delegate :object_name, to: :class
+
+      def lock_or_find(user)
+        lock_object_for(user).lock_or_find
+      end
+
+      def unlock(user)
+        lock_object_for(user).unlock
+      end
+
+      def locked?
+        locked_by.present?
+      end
+
+      def locked_by
+        user_id = base_lock_object.locked_by&.to_i
+        user_id ? User.find_by(id: user_id) : nil
+      end
+
+      def object_key
+        attribute = RailsSoftLock.configuration[:acts_as_locked_by]
+        raise ArgumentError, "No locked attribute defined" if attribute == :none
+
+        send(attribute)
+      end
+
+      private
+
+      def lock_object_for(user)
+        RailsSoftLock::LockObject.new(
+          object_name: object_name,
+          object_key: object_key,
+          object_value: user.id.to_s
+        )
+      end
+
+      def base_lock_object
+        RailsSoftLock::LockObject.new(
+          object_name: object_name,
+          object_key: object_key
+        )
+      end
+    end
+  end
+end

data/lib/rails_soft_lock/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# lib/rails_soft_lock/railtie.rb
+
+module RailsSoftLock
+  # Load rails_soft_lock:install
+  # After load rails rails_soft_lock:install check config/initializers/rails_soft_lock.rb
+  # and create initializer if do not exists
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/rails_soft_lock.rake"
+    end
+  end
+end

data/lib/rails_soft_lock/redis_adapter.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# lib/rails_soft_lock/redis_adapter.rb
+
+require "redis"
+require "connection_pool"
+
+module RailsSoftLock
+  # Adapter for store lock in redis
+  module RedisAdapter
+    # Initialize Redis client
+    def redis_client # rubocop:disable Metrics/MethodLength
+      @redis_client ||= begin
+        redis_config = RailsSoftLock.configuration.adapter_options.fetch(:redis, {})
+
+        # Set config defaults
+        defaults = {
+          url: "redis://localhost:6379/0",
+          timeout: 5
+        }
+        # Merge config options
+        config = defaults.merge(redis_config)
+
+        ConnectionPool::Wrapper.new do
+          Redis.new(**config)
+        end
+      rescue Redis::CannotConnectError => e
+        raise RailsSoftLock::Error, "Failed to connect to Redis: #{e.message}"
+      end
+    end
+
+    # Retrieves a value by key from the specified hash
+    # @return [String, nil] The value associated with the key
+    def get
+      redis_client.hget(@object_name, @object_key)
+    end
+
+    # Creates a new key-value pair if the key does not exist
+    # @return [Boolean] true if the key was created, false if it already existed
+    def create
+      result = redis_client.multi do |transaction|
+        transaction.hsetnx(@object_name, @object_key, @object_value)
+        transaction.hget(@object_name, @object_key)
+      end
+      !result.first # has_locked - false id created
+    end
+
+    # Updates the value for an existing key or creates a new key-value pair
+    # @return [Boolean] true if the key was updated, false if it was created
+    def update
+      result = redis_client.hset(@object_name, @object_key, @object_value)
+      result.zero?
+    end
+
+    # Deletes a key from the specified hash
+    # @return [Boolean] true if the key was deleted, false if it did not exist
+    def delete
+      result = redis_client.hdel(@object_name, @object_key)
+      !result.zero?
+    end
+
+    # Retrieves all key-value pairs in the specified hash
+    # @return [Hash] The key-value pairs in the hash
+    def all
+      redis_client.hgetall(@object_name)
+    end
+  end
+end

data/lib/rails_soft_lock/version.rb

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

data/lib/rails_soft_lock.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+# RailsSoftLock - module for soft lock ApplicationRecord by attribyte
+module RailsSoftLock
+  # Error class for gem
+  class Error < StandardError; end
+
+  def self.lock_manager(object_name:, object_key: nil, object_value: nil)
+    @lock_manager ||= LockObject.new(
+      object_name: object_name,
+      object_key: object_key,
+      object_value: object_value
+    )
+  end
+
+  # Pass methods to adapter
+  def self.get(object_name, object_key)
+    lock_manager(object_name: object_name, object_key: object_key).locked_by
+  end
+
+  def self.create(object_name, object_key, object_value)
+    lock_manager(object_name: object_name, object_key: object_key, object_value: object_value).lock_or_find
+  end
+
+  def self.update(object_name, object_key, object_value)
+    lock_manager(object_name: object_name, object_key: object_key, object_value: object_value).lock_or_find
+  end
+
+  # Load rake task if Rails
+  require "rails_soft_lock/railtie" if defined?(Rails)
+end

data/lib/tasks/rails_soft_lock.rake

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# lib/tasks/rails_soft_lock.rake
+
+namespace :rails_soft_lock do
+  desc "Generate a RailsSoftLock configuration file in config/initializers"
+  task :install do # rubocop:disable Rails/RakeEnvironment
+    initializer_path = Rails.root.join("config/initializers/rails_soft_lock.rb")
+
+    if File.exist?(initializer_path)
+      puts "RailsSoftLock configuration file already exists at #{initializer_path}"
+    else
+      File.write(initializer_path, <<~RUBY)
+              # frozen_string_literal: true
+
+              # Configuration for RailsSoftLock gem
+              # This file sets up the adapter and options for soft locking Active Record models
+
+              RailsSoftLock.configure do |config|
+                # Specify the adapter for storing locks
+                config.adapter = :redis
+
+        # configuration for the redis adapter
+        config.adapter_options = {
+          redis: rails.application.config_for(:redis).merge(
+            timeout: 5
+          )
+        }
+
+                # (Optional) Attribute used for locking
+                # config.acts_as_locked_by = :lock_attribute
+
+                # (Optional) Scope for separating locks
+                # config.acts_as_locked_scope = -> { "default_scope" }
+
+                # (Optional) Model class for locked_by lookups
+                # config.locked_by_class = User
+              end
+      RUBY
+      puts "Created RailsSoftLock configuration file at #{initializer_path}"
+    end
+  end
+end

data/sig/rails_soft_lock/configuration.rbs

@@ -0,0 +1,50 @@
+# lib/rails_soft_lock/configuration.rb
+module RailsSoftLock
+  self.@configuration: untyped
+
+  # Configuration class for RailsSoftLock gem.
+  class Configuration
+    @adapter: untyped
+
+    @adapter_options: untyped
+
+    @acts_as_locked_by: untyped
+
+    @acts_as_locked_scope: untyped
+
+    # List of supported adapters.
+    VALID_ADAPTERS: ::Array[:redis | :nats | :memcached]
+
+    attr_reader adapter: untyped
+
+    attr_accessor adapter_options: untyped
+
+    attr_accessor acts_as_locked_by: untyped
+
+    attr_accessor acts_as_locked_scope: untyped
+
+    def initialize: () -> void
+
+    def []: (untyped key) -> untyped
+
+    def []=: (untyped key, untyped value) -> untyped
+
+    # Sets the adapter and validates it.
+    # @param value [Symbol] The adapter to use.
+    # @raise [ArgumentError] If the adapter is not supported.
+    def adapter=: (untyped value) -> untyped
+  end
+
+  # Configures the RailsSoftLock gem with a block.
+  # @yield [config] Yields the configuration object to the block.
+  # @return [void]
+  def self.configure: () ?{ (untyped) -> untyped } -> untyped
+
+  # Returns the current configuration instance.
+  # @return [Configuration] The configuration object.
+  def self.configuration: () -> untyped
+
+  # Resets the configuration (useful for testing).
+  # @return [void]
+  def self.reset_configuration: () -> untyped
+end

data/sig/rails_soft_lock/lock_object.rbs

@@ -0,0 +1,41 @@
+module RailsSoftLock
+  # Service for managing object locks
+  # A lock object contains the following parameters:
+  #   - object_name: The name of the lock storage, typically the model name with an optional scope
+  #   - object_key: The identifier of the lock instance, typically a unique database record ID
+  #   - object_value: The identifier of the locker that locked the record
+  class LockObject
+    @object_name: untyped
+
+    @object_key: untyped
+
+    @object_value: untyped
+
+    # Подключаем адаптер на основе конфигурации
+    def self.adapter: () -> untyped
+
+    attr_reader object_name: untyped
+
+    attr_reader object_key: untyped
+
+    attr_reader object_value: untyped
+
+    def initialize: (object_name: untyped, ?object_key: untyped?, ?object_value: untyped?) -> void
+
+    # Returns the ID of the locker who locked the object
+    # @return [String, nil] The locker's ID or nil if not locked
+    def locked_by: () -> untyped
+
+    # Attempts to lock the object or returns the existing lock
+    # @return [Hash] { has_locked: Boolean, locked_by: String or nil }
+    def lock_or_find: () -> { has_locked: untyped, locked_by: untyped }
+
+    # Unlocks the object
+    # @return [Boolean] True if the lock was removed, false otherwise
+    def unlock: () -> untyped
+
+    # Returns all locks in the storage
+    # @return [Hash] All key-value pairs in the storage
+    def all_locks: () -> untyped
+  end
+end

data/sig/rails_soft_lock/model_extensions.rbs

@@ -0,0 +1,6 @@
+module RailsSoftLock
+  # Определяет настройки блокировки модели
+  module ModelExtensions
+    extend ActiveSupport::Concern
+  end
+end

data/sig/rails_soft_lock/railtie.rbs

@@ -0,0 +1,7 @@
+module RailsSoftLock
+  # Load rails_soft_lock:install
+  # After load rails rails_soft_lock:install check config/initializers/rails_soft_lock.rb
+  # and create initializer if do not exists
+  class Railtie < Rails::Railtie
+  end
+end

data/sig/rails_soft_lock/redis_adapter.rbs

@@ -0,0 +1,29 @@
+module RailsSoftLock
+  # Adapter for store lock in redis
+  module RedisAdapter
+    @redis_client: untyped
+
+    # Initialize Redis client
+    def redis_client: () -> untyped
+
+    # Retrieves a value by key from the specified hash
+    # @return [String, nil] The value associated with the key
+    def get: () -> untyped
+
+    # Creates a new key-value pair if the key does not exist
+    # @return [Boolean] true if the key was created, false if it already existed
+    def create: () -> untyped
+
+    # Updates the value for an existing key or creates a new key-value pair
+    # @return [Boolean] true if the key was updated, false if it was created
+    def update: () -> untyped
+
+    # Deletes a key from the specified hash
+    # @return [Boolean] true if the key was deleted, false if it did not exist
+    def delete: () -> untyped
+
+    # Retrieves all key-value pairs in the specified hash
+    # @return [Hash] The key-value pairs in the hash
+    def all: () -> untyped
+  end
+end

data/sig/rails_soft_lock/version.rbs

@@ -0,0 +1,3 @@
+module RailsSoftLock
+  VERSION: "0.1.0"
+end

data/sig/rails_soft_lock.rbs

@@ -0,0 +1,17 @@
+# RailsSoftLock - module for soft lock ApplicationRecord by attribyte
+module RailsSoftLock
+  self.@lock_manager: untyped
+
+  # Error class for gem
+  class Error < StandardError
+  end
+
+  def self.lock_manager: (object_name: untyped, ?object_key: untyped?, ?object_value: untyped?) -> untyped
+
+  # Pass methods to adapter
+  def self.get: (untyped object_name, untyped object_key) -> untyped
+
+  def self.create: (untyped object_name, untyped object_key, untyped object_value) -> untyped
+
+  def self.update: (untyped object_name, untyped object_key, untyped object_value) -> untyped
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: rails_soft_lock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergey Arkhipov
+- Vladimir Peskov
+bindir: lib
+cert_chain: []
+date: 2025-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+description: Using In-Memory Databases to Work with Rails Active Record Locks
+email:
+- Sergey-Arkhipov@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails_soft_lock.rb
+- lib/rails_soft_lock/configuration.rb
+- lib/rails_soft_lock/lock_object.rb
+- lib/rails_soft_lock/model_extensions.rb
+- lib/rails_soft_lock/railtie.rb
+- lib/rails_soft_lock/redis_adapter.rb
+- lib/rails_soft_lock/version.rb
+- lib/tasks/rails_soft_lock.rake
+- sig/rails_soft_lock.rbs
+- sig/rails_soft_lock/configuration.rbs
+- sig/rails_soft_lock/lock_object.rbs
+- sig/rails_soft_lock/model_extensions.rbs
+- sig/rails_soft_lock/railtie.rbs
+- sig/rails_soft_lock/redis_adapter.rbs
+- sig/rails_soft_lock/version.rbs
+homepage: https://github.com/sergey-arkhipov/rails_soft_lock
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sergey-arkhipov/rails_soft_lock
+  source_code_uri: https://github.com/sergey-arkhipov/rails_soft_lock
+  changelog_uri: https://github.com/sergey-arkhipov/rails_soft_lock
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Lock Active record by attribyte using in-memory adapters
+test_files: []