positioning 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0d883985a674ffd2262b5ae6fbfa004cdeb21f76cb4f47b293c252498abf047
-  data.tar.gz: 6b2e92166a991cc255e9db3eacd1f3a504e165033d5351285c6200e6a4e44f78
+  metadata.gz: 20e2658aa131e9c641fc3b5bdd2f685d64af56d56a53abb0eef4a25f12b4f293
+  data.tar.gz: 61d5b5e9afb5ad0d037ccb2a14185dfe0fca705cb0850f89e436d1e371608d9f
 SHA512:
-  metadata.gz: 3a21c3d4429ba5bb280490e555781023a4062df76760d37ae77c073cacb8e875c3a57e9735f15e042d9ed63445865ce1bddf4e52ef3a6db79896945fd8b417e2
-  data.tar.gz: 658091668c0a500dddd65275bfabc4506358fce770cc6b9a01026f7803d26a10386e37fec883a13a96e3f42be8d879d936efafec5127880b9e55fa5ca62ee0d2
+  metadata.gz: 51c9fa527fea19618a9b5362cc81cce367dfa15039328a3085598fd1c5ea8e2f6b8bcf92b650c82d83fb0e221ef307b893580a4172fb0f3c94200a8cdb1579c4
+  data.tar.gz: 8ca5d909229d1c2d8f1712c5ca21275ac75f733de7bf799c7c3d8777f609116efa6127b7a657d09e6a5396769c5451a8a44218941e15d836abaa3b99e954bef3

data/CHANGELOG.md

@@ -1,9 +1,19 @@
 ## [Unreleased]
 
-## [0.1.1] - 2024-02-07
+## [0.1.3] - 2024-03-04
+
+- Internal refactoring of Mechanisms for clarity
+- Additional unit testing of Mechanisms
+- Added additional Ruby and Rails versions to the Github Actions matrix
+
+## [0.1.2] - 2024-02-29
+
+- Fix a bug related to the scope changing with an explicitly set position value that is the same as the original position.
+
+## [0.1.1] - 2024-02-25
 
 - Fix issues with STI based models
 
-## [0.1.0] - 2024-02-07
+## [0.1.0] - 2024-02-24
 
 - Initial release

data/Gemfile

@@ -8,3 +8,8 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
 gem "standard", "~> 1.3"
+
+if ENV["RAILS_VERSION"]
+  gem "activerecord", ENV["RAILS_VERSION"]
+  gem "activesupport", ENV["RAILS_VERSION"]
+end

data/lib/positioning/mechanisms.rb

@@ -20,29 +20,16 @@ module Positioning
     end
 
     def update_position
-      # If we're changing scope but not explicitly setting the position then we set the position
-      # to nil so that the item gets placed at the end of the list.
-      self.position = nil if positioning_scope_changed? && !position_changed?
+      clear_position if positioning_scope_changed? && !position_changed?
 
       solidify_position
 
-      # The update strategy is to temporarily set our position to 0, then shift everything out of the way of
-      # our new desired position before finalising it.
       if positioning_scope_changed? || position_changed?
-        record_scope = base_class.where("#{primary_key_column}": primary_key)
-
-        position_was = record_scope.pick(@column)
-        record_scope.update_all "#{@column}": 0
+        move_out_of_the_way
 
         if positioning_scope_changed?
-          positioning_scope_was = base_class.where record_scope.first.slice(*positioning_columns)
-
           contract(positioning_scope_was, position_was..)
           expand(positioning_scope, position..)
-
-          # If the position integer was set to the same as its prior value but the scope has changed then
-          # we need to tell Rails that it has changed so that it gets updated from the temporary 0 value.
-          position_will_change!
         elsif position_was > position
           expand(positioning_scope, position..position_was)
         else
@@ -69,6 +56,10 @@ module Positioning
       @positioned.send primary_key_column
     end
 
+    def record_scope
+      base_class.where("#{primary_key_column}": primary_key)
+    end
+
     def position
       @positioned.send @column
     end
@@ -77,12 +68,21 @@ module Positioning
       @positioned.send :"#{@column}=", position
     end
 
+    def clear_position
+      self.position = nil
+    end
+
     def position_changed?
       @positioned.send :"#{@column}_changed?"
     end
 
-    def position_will_change!
-      @positioned.send :"#{@column}_will_change!"
+    def position_was
+      @position_was ||= record_scope.pick(@column)
+    end
+
+    def move_out_of_the_way
+      position_was # Memoize the original position before changing it
+      record_scope.update_all "#{@column}": 0
     end
 
     def expand(scope, range)
@@ -126,8 +126,6 @@ module Positioning
           raise Error.new, "relative `#{@column}` record must be in the same scope"
         end
 
-        position_was = base_class.where("#{primary_key_column}": primary_key).pick(@column)
-
         solidified_position = relative_record_scope.pick(@column)
         solidified_position += 1 if relative_position == :after
         solidified_position -= 1 if in_positioning_scope? && position_was < solidified_position
@@ -151,11 +149,15 @@ module Positioning
     end
 
     def positioning_scope
-      base_class.where(@positioned.slice(*positioning_columns)).order(@column)
+      base_class.where @positioned.slice(*positioning_columns)
+    end
+
+    def positioning_scope_was
+      base_class.where record_scope.first.slice(*positioning_columns)
     end
 
     def in_positioning_scope?
-      @positioned.persisted? && positioning_scope.exists?(primary_key)
+      @positioned.persisted? && positioning_scope.where("#{primary_key_column}": primary_key).exists?
     end
 
     def positioning_scope_changed?

data/lib/positioning/version.rb

@@ -1,3 +1,3 @@
 module Positioning
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/positioning.rb

@@ -34,6 +34,11 @@ module Positioning
         define_method(:"prior_#{column}") { Mechanisms.new(self, column).prior }
         define_method(:"subsequent_#{column}") { Mechanisms.new(self, column).subsequent }
 
+        redefine_method(:"#{column}=") do |position|
+          send :"#{column}_will_change!"
+          super(position)
+        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 }

data/positioning.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/brendon/positioning"
-  spec.metadata["changelog_uri"] = "https://github.com/brendon/positioning/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "https://github.com/brendon/positioning/blob/main/CHANGELOG.md"
 
   # 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: positioning
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Brendon Muir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2024-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -118,7 +118,6 @@ files:
 - ".standard.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -133,7 +132,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/brendon/positioning
   source_code_uri: https://github.com/brendon/positioning
-  changelog_uri: https://github.com/brendon/positioning/CHANGELOG.md
+  changelog_uri: https://github.com/brendon/positioning/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/Gemfile.lock

@@ -1,109 +0,0 @@
-PATH
-  remote: .
-  specs:
-    positioning (0.1.1)
-      activerecord (>= 6.1)
-      activesupport (>= 6.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (7.1.3)
-      activesupport (= 7.1.3)
-    activerecord (7.1.3)
-      activemodel (= 7.1.3)
-      activesupport (= 7.1.3)
-      timeout (>= 0.4.0)
-    activesupport (7.1.3)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.6)
-    concurrent-ruby (1.2.3)
-    connection_pool (2.4.1)
-    drb (2.2.0)
-      ruby2_keywords
-    i18n (1.14.1)
-      concurrent-ruby (~> 1.0)
-    json (2.7.1)
-    language_server-protocol (3.17.0.3)
-    lint_roller (1.1.0)
-    minitest (5.22.1)
-    minitest-hooks (1.5.1)
-      minitest (> 5.3)
-    mocha (2.1.0)
-      ruby2_keywords (>= 0.0.5)
-    mutex_m (0.2.0)
-    mysql2 (0.5.6)
-    parallel (1.24.0)
-    parser (3.3.0.5)
-      ast (~> 2.4.1)
-      racc
-    pg (1.5.5)
-    racc (1.7.3)
-    rainbow (3.1.1)
-    rake (13.1.0)
-    regexp_parser (2.9.0)
-    rexml (3.2.6)
-    rubocop (1.59.0)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.2.2.4)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.20.2)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    sqlite3 (1.7.2-arm64-darwin)
-    sqlite3 (1.7.2-x86_64-linux)
-    standard (1.33.0)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.59.0)
-      standard-custom (~> 1.0.0)
-      standard-performance (~> 1.3)
-    standard-custom (1.0.2)
-      lint_roller (~> 1.0)
-      rubocop (~> 1.50)
-    standard-performance (1.3.1)
-      lint_roller (~> 1.1)
-      rubocop-performance (~> 1.20.2)
-    timeout (0.4.1)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
-
-PLATFORMS
-  arm64-darwin-21
-  x86_64-linux
-
-DEPENDENCIES
-  minitest (~> 5.0)
-  minitest-hooks (~> 1.5.1)
-  mocha (~> 2.1.0)
-  mysql2 (~> 0.5.6)
-  pg (~> 1.5.5)
-  positioning!
-  rake (~> 13.0)
-  sqlite3 (~> 1.7.2)
-  standard (~> 1.3)
-
-BUNDLED WITH
-   2.3.8