lockless 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 309a363dd9ca963e995c6e95b2e8b5a7d3b56e4a18e5a1db38c907f1849e3582
-  data.tar.gz: 35ab5c79f82880b34f741a505232d75bd2b9675bf9be6362ec621d4314084947
+  metadata.gz: dfbf0af85c74d0fc3b05165382effa2efcc35648ba4d6fa0c378a9d7bb2b53ff
+  data.tar.gz: ab37c259d96aeb2689756b84748be5648ced851c374db572ff6d215fb17167c6
 SHA512:
-  metadata.gz: 05c084e18869a15d55038959dd0e18c170b95f8ff11be5a9799cafaf9a8e88381a6c74394493b9739674e6ee7c824e2f17dc44abfbd748d0d27765e33f5c4a5e
-  data.tar.gz: 86451dffd6f60aff22d91808d97a8712a472aef3e54574b14bfa9d7eb0152c91089213cfc2dcfdbb68f73c1d3f0ca24137569ed20b23478dc2a7f3dae01dbc32
+  metadata.gz: 99c8c3878e4353f8a8863dc0d4efb0b24a63ac6460fdf438274a225404cf0a106af52e677cf3869fced18aa736c9a0d3ad9afdee5fa97ae6219fb3cd54861360
+  data.tar.gz: c06923cbc493206e78bf8c5376a3b3ba21c2d7265ed461d2018fe50ca1358e2d1af66def2d03e015cd1a97ad032f4f944bacb15d6391e7ed60d7b97212948b1a

data/.github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: Ruby
+name: RubyCI
 
 on: [push,pull_request]
 

data/.rspec_status

@@ -1,7 +1,9 @@
 example_id                                 | status | run_time        |
 ------------------------------------------ | ------ | --------------- |
-./spec/lockless/model_spec.rb[1:1]         | passed | 0.01249 seconds |
-./spec/lockless/model_spec.rb[1:2:1:1]     | passed | 0.02708 seconds |
-./spec/lockless/model_spec.rb[1:2:2:1:1]   | passed | 0.00505 seconds |
-./spec/lockless/model_spec.rb[1:2:2:1:2:1] | passed | 0.02621 seconds |
-./spec/lockless/model_spec.rb[1:2:2:2:1]   | passed | 0.00658 seconds |
+./spec/lockless/model_spec.rb[1:1]         | passed | 0.01148 seconds |
+./spec/lockless/model_spec.rb[1:2:1:1]     | passed | 0.02232 seconds |
+./spec/lockless/model_spec.rb[1:3:1:1]     | passed | 0.00415 seconds |
+./spec/lockless/model_spec.rb[1:3:2:1:1]   | passed | 0.005 seconds   |
+./spec/lockless/model_spec.rb[1:3:2:1:2:1] | passed | 0.03027 seconds |
+./spec/lockless/model_spec.rb[1:3:2:2:1]   | passed | 0.00563 seconds |
+./spec/lockless/model_spec.rb[1:3:2:2:2]   | passed | 0.00243 seconds |

data/README.md

@@ -1,6 +1,7 @@
 # Lockless
 
-Concurrently update records without locks.
+[![Gem Version](https://badge.fury.io/rb/lockless.png)](https://badge.fury.io/rb/lockless)
+[![CI Status](https://github.com/cianmce/lockless/actions/workflows/main.yml/badge.svg)](https://github.com/cianmce/lockless/actions)
 
 Allows for safe concurrent updates to a single record without the need for locks.
 
@@ -54,6 +55,15 @@ class AddLocklessUuidToUsers < ActiveRecord::Migration[5.0]
 end
 ```
 
+### Custom column name
+
+```ruby
+class User < ActiveRecord::Base
+  include Lockless::Model
+  self.lockless_column = :custom_uuid
+end
+```
+
 ### Sample Usage
 
 ```ruby
@@ -66,15 +76,28 @@ user2.name = "new name2"
 
 # Save user2 before saving user1
 user2.lockless_save! # => true
+
+# user1 fails to save as it's been updated earlier by user2
 user1.lockless_save! # => false
 
-# when lockless_save doesn't work you can either ignored the update
+# when lockless_save doesn't work you can either ignore the update and continue
 # or reload the record and try again
+# or calling `.save!` will forcefully save changes without respecting lockless
+# `.save!` will cause the UUID to be changed again
 
 user1.reload
 user1.name # => "new name2"
 user1.name = "new name3"
 user1.lockless_save! # => true
+user1.reload.name # => "new name3"
+
+user1.reload
+user1.name = "new name1"
+User.all.update_all(name: "new name4")
+
+# user1 fails to save as it's been updated earlier in `update_all`
+user1.lockless_save! # => false
+user1.reload.name # => "new name4"
 ```
 
 ## Development
@@ -83,13 +106,26 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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).
 
-### Run all specs + standardrb
+### Testing
+#### Run all specs + standardrb
 
 ```sh
 bundle exec rake
 ```
 
-### Run specs using guard
+#### Run only standardrb
+
+```sh
+bundle exec rake standard
+````
+
+#### Apply standardrb auto fixes
+
+```sh
+bundle exec rake standard:fix
+```
+
+#### Run specs using guard
 
 ```sh
 bundle exec guard
@@ -111,6 +147,5 @@ Everyone interacting in the Lockless project's codebases, issue trackers, chat r
 
 ## TODO
 
-- [ ] Allow for custom lockless column name
 - [ ] Allow for custom primary key column name
 - [ ] Allow a boolean to be passed to allow for validation to be skipped like in `.save`

data/lib/lockless/model.rb

@@ -2,6 +2,11 @@
 
 module Lockless
   # Handles lockless saves
+
+  #
+  # Options:
+  #
+  # - :lockless_column - The columns used to track soft delete, defaults to `:lockless_uuid`.
   module Model
     extend ActiveSupport::Concern
 
@@ -10,6 +15,14 @@ module Lockless
       self.lockless_column = :lockless_uuid
 
       before_save :set_lockless_uuid
+
+      delegate :generate_uuid, :lockless_column, to: :class
+    end
+
+    class_methods do
+      def generate_uuid
+        SecureRandom.uuid
+      end
     end
 
     # Saves record if it has not be modified in the time after it was loaded from the database.
@@ -18,18 +31,18 @@ module Lockless
     # false is returned if record is outdated or invalid
     def lockless_save
       return false unless valid?
-      old_lockless_uuid = lockless_uuid
+      old_lockless_uuid = public_send(lockless_column)
       return save if new_record?
 
       run_callbacks(:save) do |variable|
         new_attrs = changed.collect { |prop| [prop.to_sym, self[prop]] }.to_h
 
-        update_count = self.class.where(id: id, lockless_uuid: old_lockless_uuid).update_all(new_attrs)
+        update_count = self.class.where(:id => id, lockless_column => old_lockless_uuid).update_all(new_attrs)
         if update_count == 1
           changes_applied
           true
         else
-          self.lockless_uuid = old_lockless_uuid
+          public_send("#{lockless_column}=", old_lockless_uuid)
           false
         end
       end
@@ -49,7 +62,7 @@ module Lockless
     private
 
     def set_lockless_uuid
-      self.lockless_uuid = SecureRandom.uuid
+      public_send("#{lockless_column}=", generate_uuid)
     end
   end
 end

data/lib/lockless/relation.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lockless
+  module Relation
+    # Appends update attributes with a random UUID when the model is a lockless model
+    #
+    # @param [String, Array, Hash] A string, array, or hash representing the SET part of an SQL statement.
+    # Lockless will only append random UUID updates if the param is a Hash
+    #
+    # @return [Boolean] Similar to `.save`, true is returned if the model is updated
+    # false is returned if record is outdated or invalid
+    def update_all(updates)
+      if updates.is_a?(Hash)
+        if model.method_defined?(:lockless_column) && updates[model.lockless_column].blank?
+          updates[model.lockless_column] = model.generate_uuid
+        end
+      end
+
+      super(updates)
+    end
+  end
+end
+
+ActiveRecord::Relation.prepend(Lockless::Relation)

data/lib/lockless/version.rb

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

data/lib/lockless.rb

@@ -4,3 +4,4 @@ require "active_record"
 
 require "lockless/version"
 require "lockless/model"
+require "lockless/relation"

data/lockless.gemspec

@@ -14,10 +14,9 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
-
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/lockless/#{Lockless::VERSION}"
 
   # 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.
@@ -28,12 +27,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
-
   spec.add_development_dependency "standardrb", "~> 1.0"
   spec.add_development_dependency "bundler", ">= 1"
   spec.add_development_dependency "rake", "~> 13.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockless
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Cian McElhinney
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-21 00:00:00.000000000 Z
+date: 2021-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: standardrb
@@ -215,6 +215,7 @@ files:
 - bin/setup
 - lib/lockless.rb
 - lib/lockless/model.rb
+- lib/lockless/relation.rb
 - lib/lockless/version.rb
 - lockless.gemspec
 homepage: https://github.com/cianmce/lockless
@@ -223,6 +224,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/cianmce/lockless
   source_code_uri: https://github.com/cianmce/lockless
+  documentation_uri: https://www.rubydoc.info/gems/lockless/0.2.2
 post_install_message: 
 rdoc_options: []
 require_paths: