lockless 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04eeee62146005a7c2f6f68e89ba5ad82763a9b80918d68e63a1c47fcd486839
-  data.tar.gz: e2ae421f25787bbb0a52413710c67ae1d2c29279c0436eb1f08bafe1561b14b0
+  metadata.gz: b5cc6bb9658c48705098956a9caabc7c3f10cd99631dcd6b0fe776592f57cc9d
+  data.tar.gz: 48d0dc5d8709224b6481e6d5b6316487c66b82b735a88a77d370d783bcaa62fd
 SHA512:
-  metadata.gz: 8ff5c03de7a60853770cb7ae0fa0d07a06faa7750bb46dee3826eea73e9679b171011831e8e39f57d01fac9694028942959f88febcda3d8b0c758535ffce22d1
-  data.tar.gz: add5bb7893659aba38ec88c41a20b56bd2c532f1275db13a029c35aa1ef1874f48c9bf82f643f933fd4003d9f479637b561e4ff5579591db18b54f3b528df7e7
+  metadata.gz: a6580bfc5ac693248c355b82d6e6b9113c2772660ce0d7b2d9c31553a2da212d122cf0b757c93df78b7a985544f030b6bb66697e400f8857a749418a17ca16c0
+  data.tar.gz: 3a6da4c0530cbe62a28831aec86966953cecf54433fac6ccd75070ff659b4febb1db2b1b5232f521476fca6595fc0a36402bcf4e3a42be9ba980e578e2e4cfb7

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.
 
@@ -66,6 +67,8 @@ 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
@@ -75,6 +78,15 @@ 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 +95,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 +136,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,15 @@
+# frozen_string_literal: true
+
+module Lockless
+  module Relation
+    def update_all(updates)
+      if model.method_defined?(:lockless_column) && updates[model.lockless_column].blank?
+        updates[model.lockless_column] = model.generate_uuid
+      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.1"
+  VERSION = "0.2.0"
 end

data/lib/lockless.rb

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

data/lockless.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = "Allows for safe concurrent updates to a single record without the need for locks."
   spec.homepage = "https://github.com/cianmce/lockless"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.3.0"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lockless
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Cian McElhinney
@@ -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