positioning 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9a6be17ba30233c2d789bbc32055280262feee10c5cef80badc42f18b829f13
-  data.tar.gz: 68e477089f16ad23111bc8e5e39f43f8c2bcac389b04ee5855d0729d1a50771f
+  metadata.gz: a486284bed84d9458dfc46093bf97d94f56e808de40843bffbc5cdacde4606b3
+  data.tar.gz: f31839ad358b3db74b55596dda9c77ce32a8a661923dc257962ac36deb7520c7
 SHA512:
-  metadata.gz: 6cce0ad940005e740b64c858250e425307578aa37697f35258f886acdb9de31954db04bc73589dd0931cc6665b1f5e5ddf0439f195ea0caa6010a66eed1f882d
-  data.tar.gz: 9f9a8587420495b693b340bd8108328116fb2414b7879ab90be3e8e2b2740346730fff4e5434c3bb951aead42d739c23fcb409d62843eea6bf73318b96e4724e
+  metadata.gz: 54a7ea806656b3cab3b32846dfb365b9107389d83ac37fed41b145a3daa82917ce27c2f7765713e6440d6571d4b735d9a958713e65c61879244378b9c6f1511e
+  data.tar.gz: 85af57db02799e96fddb74f9a14debaa1a0e0d2ff06144f41c50be9d5bd9c66d103fbd1cefc86a9c0e9061e3f172c37015eee078440b418da055bd4c67075c97

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.2.3] - 2024-07-06
+
+- Advisory Lock can now be optionally turned off via `advisory_lock: false` on your `positioned` call. See the README for more details. Advisory Lock remains on by default. Thanks @joaomarcos96!
+
+## [0.2.2] - 2024-05-17
+
+- When destroying a positioned item, first move it out of the way (position = 0) then contract the scope. Do this before destruction. Moving the item out of the way memoizes its original position to cope with the case where multiple items are destroyed with `destroy_all` as they'll have their position column cached. Thanks @james-reading for the report.
+
 ## [0.2.1] - 2024-04-08
 
 - Fetch the adapter_name from #connection_db_config (@tijn)
@@ -12,7 +20,7 @@
 
 ## [0.1.7] - 2024-03-06
 
-- Seperated the Concern that is included into ActiveRecord::Base into its own submodule so that Mechanisms isn't also included.
+- Separated the Concern that is included into ActiveRecord::Base into its own submodule so that Mechanisms isn't also included.
 - Added the RelativePosition Struct and documentation to make it easier to supply relative positions via form helpers.
 
 ## [0.1.6] - 2024-03-05

data/README.md

@@ -66,6 +66,10 @@ positioned on: :type
 belongs_to :list
 belongs_to :category
 positioned on: [:list, :category, :enabled]
+
+# If you do not want to use Advisory Lock, you can disable it entirely by passing the 'advisory_lock' flag as false
+belongs_to :list
+positioned on: :list, advisory_lock: false
 ```
 
 ### Manipulating Positioning
@@ -243,6 +247,33 @@ https://github.com/brendon/positioning/blob/main/lib/positioning/advisory_lock.r
 
 If you have any concerns or improvements please file a GitHub issue.
 
+### Opting out of Advisory Lock
+
+There are cases where Advisory Lock may be unwanted or unnecessary, for instance, if you already lock the parent record in **every** operation that will touch the database on the positioned item, **everywhere** in your application.
+
+Example of such scenario in your application:
+
+```ruby
+list = List.create(name: "List")
+
+list.with_lock do
+  item_a = list.items.create(name: "Item A")
+  item_b = list.items.create(name: "Item B")
+  item_c = list.items.create(name: "Item C")
+
+  item_c.update(position: {before: item_a})
+
+  item_a.destroy
+end
+```
+
+Therefore, making sure you already have another mechanism to avoid race conditions, you can opt out of Advisory Lock by setting `advisory_lock` to `false` when declaring positioning:
+
+```ruby
+belongs_to :list
+positioned on: :list, advisory_lock: false
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/positioning/mechanisms.rb

@@ -39,7 +39,10 @@ module Positioning
     end
 
     def destroy_position
-      contract(positioning_scope, (position + 1)..) unless destroyed_via_positioning_scope?
+      unless destroyed_via_positioning_scope?
+        move_out_of_the_way
+        contract(positioning_scope, (position_was + 1)..)
+      end
     end
 
     private

data/lib/positioning/version.rb

@@ -1,3 +1,3 @@
 module Positioning
-  VERSION = "0.2.1"
+  VERSION = "0.2.3"
 end

data/lib/positioning.rb

@@ -18,7 +18,7 @@ module Positioning
         @positioning_columns ||= {}
       end
 
-      def positioned(on: [], column: :position)
+      def positioned(on: [], column: :position, advisory_lock: true)
         unless base_class?
           raise Error.new "can't be called on an abstract class or STI subclass."
         end
@@ -43,18 +43,22 @@ module Positioning
             super(position)
           end
 
-          advisory_lock = AdvisoryLock.new(base_class, column)
+          if advisory_lock
+            advisory_lock_callback = AdvisoryLock.new(base_class, column)
 
-          before_create advisory_lock
-          before_update advisory_lock
-          before_destroy advisory_lock
+            before_create advisory_lock_callback
+            before_update advisory_lock_callback
+            before_destroy advisory_lock_callback
+          end
 
           before_create { Mechanisms.new(self, column).create_position }
           before_update { Mechanisms.new(self, column).update_position }
-          after_destroy { Mechanisms.new(self, column).destroy_position }
+          before_destroy { Mechanisms.new(self, column).destroy_position }
 
-          after_commit advisory_lock
-          after_rollback advisory_lock
+          if advisory_lock
+            after_commit advisory_lock_callback
+            after_rollback advisory_lock_callback
+          end
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: positioning
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Brendon Muir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-08 00:00:00.000000000 Z
+date: 2024-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport