positioning 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf799b4590dc7a86e63c7ba46fe624bd7c6353989a6d33833942b30dd0c5bd46
-  data.tar.gz: 773a8c4b1f0cc6d528577c8d5c8f0263e310a5e8e3f2e69beeeaf9265e063dca
+  metadata.gz: c5d59cea57ca298c21e0628f0127b5a265dc10c511964ee9d8bd68509e05d1c5
+  data.tar.gz: 128d55b9f0f77920c288ca0986d4260fdaee20daf5fc5b780178d81f0c8fcccd
 SHA512:
-  metadata.gz: 50423eee7719178be13087622bcc14b4a9e74974bdb0685fe7281838cc7cca8f784251b81a28d92e848a2b2eb7b79e4081a3ad4043ed483200f51341c71bf82f
-  data.tar.gz: e2ccbac3a7d0994e997a0b17907becc017893d5355fa9c06a745828b8ec90661076332e9ef1769bd9c0f6c1f8ba808e3d209e0f56b9acdf33d4e1ba6e5d9bd88
+  metadata.gz: 0d85df90cc7178941062d4e011e62ee857f0e24d08d36d676cbb64696b626da3b383edd66236d9dd5688e4cc0d87d3f96569495f5ae044ce0f8a6f461cad2c16
+  data.tar.gz: b8cada361907d53e53f0b9a93ba84d22a7dffc2a4be79914558638b4905e1305553c3c95f8055cc96931175e61208b4a928b3cc2702a7ab0ae54789fc6040db0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.4.3] - 2024-11-18
+
+- Add support for polymorphic `belongs_to` where we add both the `id` and the `type` to the scope.
+
 ## [0.4.2] - 2024-11-08
 
 NOTE: Versions 0.4.0 and 0.4.1 contain fatal flaws with the locking logic. Upgrade as soon as you can.

data/Gemfile

@@ -6,6 +6,8 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
+gem "minitest-hooks", "~> 1.5.1"
+gem "mocha", "~> 2.1.0"
 
 gem "standard", "~> 1.3"
 
@@ -13,3 +15,17 @@ if ENV["RAILS_VERSION"]
   gem "activerecord", ENV["RAILS_VERSION"]
   gem "activesupport", ENV["RAILS_VERSION"]
 end
+
+case ENV["DB"]
+when "sqlite"
+  if ENV["RAILS_VERSION"] &&
+      Gem::Version.new(ENV["RAILS_VERSION"]) >= Gem::Version.new("7.2")
+    gem "sqlite3", "~> 2.2.0"
+  else
+    gem "sqlite3", "~> 1.7.2"
+  end
+when "postgresql"
+  gem "pg", "~> 1.5.5"
+else
+  gem "mysql2", "~> 0.5.6"
+end

data/README.md

@@ -32,6 +32,10 @@ You should also add an index to ensure that the `position` column value is uniqu
 
 The above assumes that your items are scoped to a parent table called `lists`.
 
+If you have a polymorphic `belongs_to` then you'll want to add the type column to the index also:
+
+`add_index :items, [:listable_id, :listable_type, :position], unique: true`
+
 The Positioning gem uses `0` and negative integers to rearrange the lists it manages so don't add database validations to restrict the usage of these. You are also restricted from using `0` and negative integers as position values. If you try, the position value will become `1`. If you try to set an explicit position value that is greater than the next available list position, it will be rounded down to that value.
 
 ### Declaring Positioning
@@ -40,10 +44,10 @@ To declare that your model should keep track of the position of its records you
 
 ```ruby
 # The scope is global (all records will belong to the same list) and the database column
-# is 'positioned'
+# is 'position'
 positioned
 
-# The scope is on the belongs_to relationship 'list' and the database column is 'positioned'
+# The scope is on the belongs_to relationship 'list' and the database column is 'position'
 # We check if the scope is a belongs_to relationship and use its declared foreign_key as
 # the scope value. In this case it would be 'list_id' since we haven't overridden the
 # default foreign key.
@@ -67,9 +71,9 @@ 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
+# If your belongs_to is polymorphic positioning will automatically add the type to the scope
+belongs_to :listable, polymorphic: true
+positioned on: :listable
 ```
 
 ### Initialising a List

data/lib/positioning/version.rb

@@ -1,3 +1,3 @@
 module Positioning
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/lib/positioning.rb

@@ -36,6 +36,7 @@ module Positioning
 
             if reflection&.belongs_to?
               positioning_columns[column][:scope_columns] << reflection.foreign_key
+              positioning_columns[column][:scope_columns] << reflection.foreign_type if reflection.polymorphic?
               positioning_columns[column][:scope_associations] << reflection.name
             else
               positioning_columns[column][:scope_columns] << scope_component

data/positioning.gemspec

@@ -29,11 +29,6 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   spec.add_dependency "activesupport", ">= 6.1"
   spec.add_dependency "activerecord", ">= 6.1"
-  spec.add_development_dependency "minitest-hooks", "~> 1.5.1"
-  spec.add_development_dependency "mocha", "~> 2.1.0"
-  spec.add_development_dependency "mysql2", "~> 0.5.6"
-  spec.add_development_dependency "pg", "~> 1.5.5"
-  spec.add_development_dependency "sqlite3", "~> 1.7.2"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: positioning
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Brendon Muir
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2024-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,76 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
-- !ruby/object:Gem::Dependency
-  name: minitest-hooks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.1
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.6
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.6
-- !ruby/object:Gem::Dependency
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.5
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.5
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.2
 description:
 email:
 - brendon@spike.net.nz