acts_as_list 1.0.4 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36b9ed8db57946d5ac96c829c68ce4f4107068628827840140e9dadb3c682fa
-  data.tar.gz: 60b6890922d26b913aed5a212eae7d228629c1ce3721dd0818ec2e5069697d25
+  metadata.gz: 8fb937125e21c3674aefbf6cce0dbc334380a975b3c0cbf1e13c79f43a4fecd4
+  data.tar.gz: ead5fb00d9321a35f409e7c005eeebfb66192d7e4952040f4008d557726e38df
 SHA512:
-  metadata.gz: 1bfced5d2dd4e50194eb8bdb92b244d40dd0a19df0ee663649510a965077a0d332715dc0100c1e9d006222e96e57745638c77812767b88ec7b9274dd350af4c1
-  data.tar.gz: 485f6be53763f1f112095075b1c69d6e620f89018c2e3435f3500decf986e110c832f78ce5db6462d6233d13816516a2c1d59df1e3c172455439a11704b1c8b5
+  metadata.gz: c8a8c099d4808b9f5c92eefd0a70f3b6f9b7e694b80f68a5b985bab159ec32be9f0256f5d7f9b053891e81d507eae9cb8c0a3fbb56e18646ce2e3202c10c6d68
+  data.tar.gz: 0f4f91c1879293d00012462f37f0cb3e801d88450369d6db52ab7c53a7abab6c4523a1a5b691ad0a9d937bc783fa44008770617c541a22ef35393b69f0afaf3c

data/CHANGELOG.md

@@ -6,6 +6,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## v1.2.4 - 2024-11-20
+
+### Added
+- funding_uri to gemspec
+
+## v1.2.3 - 2024-10-14
+
+### Changed
+- Use `.with_connection do |connection|` where possible instead of `.connection` [\#441](https://github.com/brendon/acts_as_list/pull/441) ([flood4life])
+
+## v1.2.2 - 2024-07-16
+
+### Fixed
+- Updated .gemspec to exclude unnecessary files from the gem package. [\#437](https://github.com/brendon/acts_as_list/pull/437) ([f440])
+
+## v1.2.1 - 2024-06-06
+
+### Fixed
+- We no longer delegate the class `connection` method to the instance. [\#436](https://github.com/brendon/acts_as_list/pull/436) ([davidcelis])
+
+## v1.2.0 - 2024-06-03
+
+### Added
+- Add support for composite primary keys. [\#430](https://github.com/brendon/acts_as_list/pull/430) ([divagueame])
+
+### Changed
+- Refactored CI testing framework and removed the Appraisals gem. Use RAILS_VERSION to switch the Rails version you are currently running the tests against.
+- We now only explicitly test against Rails 6.1+ and Ruby 3.0+.
+
+## v1.1.0 - 2023-02-01
+
+### Fixed (Possibly Breaking)
+- Use `after_save` instead of `after_commit` for `clear_scope_changed` callback [\#407](https://github.com/brendon/acts_as_list/pull/407) ([@Flixt](https://github.com/Flixt))
+- Rename `add_to_list_top` and `add_to_list_bottom` private methods to `avoid_collision` that handles both cases as well as the case where `:add_new_at` is `nil`. Setting an explicit position when `:add_new_at` is `nil` will now shuffle other items out of the way if necessary. *This may break existing workarounds you have in place to deal with this bug*. [\#411](https://github.com/brendon/acts_as_list/pull/411). ([brendon])
+
 ## v1.0.4 - 2021-04-20
 
 ### Fixed
@@ -250,7 +285,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 **Closed issues:**
 
 - DEPRECATION WARNING on rails 5.0 as of acts\_as\_list 0.9 [\#251](https://github.com/brendon/acts_as_list/issues/251)
-- highter\_items returns items with the same position value [\#247](https://github.com/brendon/acts_as_list/issues/247)
+- higher\_items returns items with the same position value [\#247](https://github.com/brendon/acts_as_list/issues/247)
 - Broken with unique constraint on position [\#245](https://github.com/brendon/acts_as_list/issues/245)
 
 **Merged pull requests:**
@@ -478,7 +513,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Fix sanitize\_sql\_hash\_for\_conditions deprecation warning in Rails 4.2 [\#140](https://github.com/brendon/acts_as_list/pull/140) ([eagletmt](https://github.com/eagletmt))
 - Simpler method to find the subclass name [\#139](https://github.com/brendon/acts_as_list/pull/139) ([brendon](https://github.com/brendon))
 - Rails4 enum column support [\#130](https://github.com/brendon/acts_as_list/pull/130) ([arunagw](https://github.com/arunagw))
-- use eval for determing the self.class.name useful when this is used in an abstract class [\#123](https://github.com/brendon/acts_as_list/pull/123) ([flarik](https://github.com/flarik))
+- use eval for determining the self.class.name useful when this is used in an abstract class [\#123](https://github.com/brendon/acts_as_list/pull/123) ([flarik](https://github.com/flarik))
 
 ## [0.5.0](https://github.com/brendon/acts_as_list/tree/0.5.0) (2014-10-31)
 [Full Changelog](https://github.com/brendon/acts_as_list/compare/0.4.0...0.5.0)
@@ -618,7 +653,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - acts\_as\_list :scope =\> "doesnt\_seem\_to\_work" [\#12](https://github.com/brendon/acts_as_list/issues/12)
 - don't work perfectly with default\_scope [\#11](https://github.com/brendon/acts_as_list/issues/11)
 - MySQL: Position column MUST NOT have default [\#10](https://github.com/brendon/acts_as_list/issues/10)
-- insert\_at fails on postgresql w/ non-null constraint on postion\_column  [\#8](https://github.com/brendon/acts_as_list/issues/8)
+- insert\_at fails on postgresql w/ non-null constraint on position\_column  [\#8](https://github.com/brendon/acts_as_list/issues/8)
 
 **Merged pull requests:**
 
@@ -627,7 +662,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Massive test refactorings. [\#24](https://github.com/brendon/acts_as_list/pull/24) ([splattael](https://github.com/splattael))
 - Silent migrations to reduce test noise. [\#22](https://github.com/brendon/acts_as_list/pull/22) ([splattael](https://github.com/splattael))
 - Should decrement lower items after the item has been destroyed to avoid unique key conflicts. [\#18](https://github.com/brendon/acts_as_list/pull/18) ([aepstein](https://github.com/aepstein))
-- Fix spelling and grammer [\#15](https://github.com/brendon/acts_as_list/pull/15) ([tmiller](https://github.com/tmiller))
+- Fix spelling and grammar [\#15](https://github.com/brendon/acts_as_list/pull/15) ([tmiller](https://github.com/tmiller))
 - store\_at\_0 should yank item from the list then decrement items to avoid r [\#14](https://github.com/brendon/acts_as_list/pull/14) ([aepstein](https://github.com/aepstein))
 - Support default\_scope ordering by calling .unscoped [\#13](https://github.com/brendon/acts_as_list/pull/13) ([tanordheim](https://github.com/tanordheim))
 

data/README.md

@@ -1,9 +1,14 @@
 # Acts As List
 
 ## Build Status
-[![Build Status](https://travis-ci.org/brendon/acts_as_list.svg?branch=master)](https://travis-ci.org/brendon/acts_as_list)
+[![Continuous Integration](https://github.com/brendon/acts_as_list/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/brendon/acts_as_list/actions/workflows/continuous_integration.yml)
 [![Gem Version](https://badge.fury.io/rb/acts_as_list.svg)](https://badge.fury.io/rb/acts_as_list)
 
+## ANNOUNCING: Positioning, the gem
+As maintainer of both Acts As List and the Ranked Model gems, I've become intimately acquainted with the strengths and weaknesses of each. I ended up writing a small scale Rails Concern for positioning database rows for a recent project and it worked really well so I've decided to release it as a gem: [Positioning](https://github.com/brendon/positioning)
+
+Positioning works similarly to Acts As List in that it maintains a sequential list of integer values as positions. It differs in that it encourages a unique constraints on the position column and supports multiple lists per database table. It borrows Ranked Model's concept of relative positioning. I encourage you to check it out and give it a whirl on your project!
+
 ## Description
 
 This `acts_as` extension provides the capabilities for sorting and reordering a number of objects in a list. The class that has this specified needs to have a `position` column defined as an integer on the mapped database table.
@@ -117,7 +122,7 @@ When using PostgreSQL, it is also possible to leave this migration up to the dat
        ROW_NUMBER() OVER (
          PARTITION BY todo_list_id
          ORDER BY updated_at
-       ) as new_position
+       ) AS new_position
      FROM todo_items
    ) AS mapping
    WHERE todo_items.id = mapping.id;
@@ -133,26 +138,29 @@ The `position` column is set after validations are called, so you should not put
 If you need a scope by a non-association field you should pass an array, containing field name, to a scope:
 ```ruby
 class TodoItem < ActiveRecord::Base
-  # `kind` is a plain text field (e.g. 'work', 'shopping', 'meeting'), not an association
-  acts_as_list scope: [:kind]
+  # `task_category` is a plain text field (e.g. 'work', 'shopping', 'meeting'), not an association
+  acts_as_list scope: [:task_category]
 end
 ```
 
 You can also add multiple scopes in this fashion:
 ```ruby
 class TodoItem < ActiveRecord::Base
-  acts_as_list scope: [:kind, :owner_id]
+  belongs_to :todo_list
+  acts_as_list scope: [:task_category, :todo_list_id]
 end
 ```
 
 Furthermore, you can optionally include a hash of fixed parameters that will be included in all queries:
 ```ruby
 class TodoItem < ActiveRecord::Base
-  acts_as_list scope: [:kind, :owner_id, deleted_at: nil]
+  belongs_to :todo_list
+  # or `discarded_at` if using discard
+  acts_as_list scope: [:task_category, :todo_list_id, deleted_at: nil]
 end
 ```
 
-This is useful when using this gem in conjunction with the popular [acts_as_paranoid](https://github.com/ActsAsParanoid/acts_as_paranoid) gem.
+This is useful when using this gem in conjunction with the popular [acts_as_paranoid](https://github.com/ActsAsParanoid/acts_as_paranoid) or [discard](https://github.com/jhawthorn/discard) gems.
 
 ## More Options
 - `column`
@@ -192,7 +200,7 @@ class TodoItem < ActiveRecord::Base
 end
 
 class TodoAttachment < ActiveRecord::Base
-  belongs_to :todo_list
+  belongs_to :todo_item
   acts_as_list scope: :todo_item
 end
 
@@ -282,7 +290,7 @@ All versions `0.1.5` onwards require Rails 3.0.x and higher.
 
 We often hear complaints that `position` values are repeated, incorrect etc. For example, #254. To ensure data integrity, you should rely on your database. There are two things you can do:
 
-1. Use constraints.  If you model `Item` that `belongs_to` an `Order`, and it has a `position` column, then add a unique constraint on `items` with `[:order_id, :position]`.  Think of it as a list invariant. What are the properties of your list that don't change no matter how many items you have in it?  One such propery is that each item has a distinct position. Another _could be_ that position is always greater than 0. It is strongly recommended that you rely on your database to enforce these invariants or constraints. Here are the docs for [PostgreSQL](https://www.postgresql.org/docs/9.5/static/ddl-constraints.html) and [MySQL](https://dev.mysql.com/doc/refman/8.0/en/alter-table.html).
+1. Use constraints.  If you model `Item` that `belongs_to` an `Order`, and it has a `position` column, then add a unique constraint on `items` with `[:order_id, :position]`.  Think of it as a list invariant. What are the properties of your list that don't change no matter how many items you have in it?  One such property is that each item has a distinct position. Another _could be_ that position is always greater than 0. It is strongly recommended that you rely on your database to enforce these invariants or constraints. Here are the docs for [PostgreSQL](https://www.postgresql.org/docs/9.5/static/ddl-constraints.html) and [MySQL](https://dev.mysql.com/doc/refman/8.0/en/alter-table.html).
 2. Use mutexes or row level locks. At its heart the duplicate problem is that of handling concurrency. Adding a contention resolution mechanism like locks will solve it to some extent.  But it is not a solution or replacement for constraints.  Locks are also prone to deadlocks.
 
 As a library, `acts_as_list` may not always have all the context needed to apply these tools. They are much better suited at the application level.

data/Rakefile

@@ -32,11 +32,3 @@ rescue LoadError
 rescue StandardError
   puts "RDocTask is not supported on this platform."
 end
-
-# See https://github.com/skywinder/github-changelog-generator#rake-task for details
-# and github_changelog_generator --help for available options
-require 'github_changelog_generator/task'
-GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-  config.project = 'acts_as_list'
-  config.user = 'brendon'
-end

data/lib/acts_as_list/active_record/acts/callback_definer.rb

@@ -11,11 +11,9 @@ module ActiveRecord::Acts::List::CallbackDefiner #:nodoc:
       before_update :check_scope, unless: :act_as_list_no_update?
       after_update :update_positions, unless: :act_as_list_no_update?
 
-      after_commit :clear_scope_changed
+      after_save :clear_scope_changed
 
-      if add_new_at.present?
-        before_create "add_to_list_#{add_new_at}".to_sym, unless: :act_as_list_no_update?
-      end
+      before_create :avoid_collision, unless: :act_as_list_no_update?
     end
   end
 end

data/lib/acts_as_list/active_record/acts/list.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative './with_connection'
+
 module ActiveRecord
   module Acts #:nodoc:
     module List #:nodoc:
@@ -171,7 +173,7 @@ module ActiveRecord
           limit ||= acts_as_list_list.count
           acts_as_list_list.
             where("#{quoted_position_column_with_table_name} <= ?", current_position).
-            where("#{quoted_table_name}.#{self.class.primary_key} != ?", self.send(self.class.primary_key)).
+            where.not(primary_key_condition).
             reorder(acts_as_list_order_argument(:desc)).
             limit(limit)
         end
@@ -188,7 +190,7 @@ module ActiveRecord
           limit ||= acts_as_list_list.count
           acts_as_list_list.
             where("#{quoted_position_column_with_table_name} >= ?", current_position).
-            where("#{quoted_table_name}.#{self.class.primary_key} != ?", self.send(self.class.primary_key)).
+            where.not(primary_key_condition).
             reorder(acts_as_list_order_argument(:asc)).
             limit(limit)
         end
@@ -229,36 +231,27 @@ module ActiveRecord
           acts_as_list_class.default_scoped.unscope(:select, :where).where(scope_condition)
         end
 
-        # Poorly named methods. They will insert the item at the desired position if the position
-        # has been set manually using position=, not necessarily the top or bottom of the list:
-
-        def add_to_list_top
-          if assume_default_position?
-            increment_positions_on_all_items
-            self[position_column] = acts_as_list_top
-          else
-            increment_positions_on_lower_items(self[position_column], id)
-          end
-
-          # Make sure we know that we've processed this scope change already
-          @scope_changed = false
-
-          # Don't halt the callback chain
-          true
-        end
-
-        def add_to_list_bottom
-          if assume_default_position?
-            self[position_column] = bottom_position_in_list.to_i + 1
+        def avoid_collision
+          case add_new_at
+          when :top
+            if assume_default_position?
+              increment_positions_on_all_items
+              self[position_column] = acts_as_list_top
+            else
+              increment_positions_on_lower_items(self[position_column], id)
+            end
+          when :bottom
+            if assume_default_position?
+              self[position_column] = bottom_position_in_list.to_i + 1
+            else
+              increment_positions_on_lower_items(self[position_column], id)
+            end
           else
-            increment_positions_on_lower_items(self[position_column], id)
+            increment_positions_on_lower_items(self[position_column], id) if position_changed
           end
 
-          # Make sure we know that we've processed this scope change already
-          @scope_changed = false
-
-          # Don't halt the callback chain
-          true
+          @scope_changed = false # Make sure we know that we've processed this scope change already
+          return true # Don't halt the callback chain
         end
 
         def assume_default_position?
@@ -282,7 +275,7 @@ module ActiveRecord
           scope = acts_as_list_list
 
           if except
-            scope = scope.where("#{quoted_table_name}.#{self.class.primary_key} != ?", except.id)
+            scope = scope.where.not(primary_key_condition(except.id))
           end
 
           scope.in_list.reorder(acts_as_list_order_argument(:desc)).first
@@ -309,7 +302,7 @@ module ActiveRecord
           scope = acts_as_list_list
 
           if avoid_id
-            scope = scope.where("#{quoted_table_name}.#{self.class.primary_key} != ?", avoid_id)
+            scope = scope.where.not(primary_key_condition(avoid_id))
           end
 
           if sequential_updates?
@@ -350,7 +343,7 @@ module ActiveRecord
           scope = acts_as_list_list
 
           if avoid_id
-            scope = scope.where("#{quoted_table_name}.#{self.class.primary_key} != ?", avoid_id)
+            scope = scope.where.not(primary_key_condition(avoid_id))
           end
 
           if old_position < new_position
@@ -454,7 +447,7 @@ module ActiveRecord
             send('decrement_positions_on_lower_items') if lower_item
             cached_changes.each { |attribute, values| send("#{attribute}=", values[1]) }
 
-            send("add_to_list_#{add_new_at}") if add_new_at.present?
+            avoid_collision
           end
         end
 
@@ -468,7 +461,9 @@ module ActiveRecord
 
         # When using raw column name it must be quoted otherwise it can raise syntax errors with SQL keywords (e.g. order)
         def quoted_position_column
-          @_quoted_position_column ||= self.class.connection.quote_column_name(position_column)
+          @_quoted_position_column ||= ActiveRecord::Acts::List::WithConnection.new(self.class).call do |connection|
+            connection.quote_column_name(position_column)
+          end
         end
 
         # Used in order clauses
@@ -489,6 +484,10 @@ module ActiveRecord
           version = Gem.loaded_specs['activerecord'].version
           requirement.satisfied_by?(version)
         end
+
+        def primary_key_condition(id = self.id)
+          { self.class.primary_key => [id] }
+        end
       end
 
     end

data/lib/acts_as_list/active_record/acts/position_column_method_definer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative './with_connection'
+
 module ActiveRecord::Acts::List::PositionColumnMethodDefiner #:nodoc:
   def self.call(caller_class, position_column, touch_on_update)
     define_class_methods(caller_class, position_column, touch_on_update)
@@ -15,7 +17,9 @@ module ActiveRecord::Acts::List::PositionColumnMethodDefiner #:nodoc:
   def self.define_class_methods(caller_class, position_column, touch_on_update)
     caller_class.class_eval do
       define_singleton_method :quoted_position_column do
-        @_quoted_position_column ||= connection.quote_column_name(position_column)
+        @_quoted_position_column ||= ActiveRecord::Acts::List::WithConnection.new(self).call do |connection|
+          connection.quote_column_name(position_column)
+        end
       end
 
       define_singleton_method :quoted_position_column_with_table_name do
@@ -72,17 +76,22 @@ module ActiveRecord::Acts::List::PositionColumnMethodDefiner #:nodoc:
         cached_quoted_now = quoted_current_time_from_proper_timezone
 
         timestamp_attributes_for_update_in_model.map do |attr|
-          ", #{connection.quote_column_name(attr)} = #{cached_quoted_now}"
+          ActiveRecord::Acts::List::WithConnection.new(self.class).call do |connection|
+            ", #{connection.quote_column_name(attr)} = #{cached_quoted_now}"
+          end
         end.join
       end
 
       private
 
-      delegate :connection, to: self
-
       def quoted_current_time_from_proper_timezone
-        connection.quote(connection.quoted_date(
-          current_time_from_proper_timezone))
+        ActiveRecord::Acts::List::WithConnection.new(self.class).call do |connection|
+          connection.quote(
+            connection.quoted_date(
+              current_time_from_proper_timezone
+            )
+          )
+        end
       end
     end
   end

data/lib/acts_as_list/active_record/acts/scope_method_definer.rb

@@ -2,7 +2,6 @@
 require "active_support/inflector"
 
 module ActiveRecord::Acts::List::ScopeMethodDefiner #:nodoc:
-  extend ActiveSupport::Inflector
 
   def self.call(caller_class, scope)
     scope = idify(caller_class, scope) if scope.is_a?(Symbol)
@@ -71,7 +70,7 @@ module ActiveRecord::Acts::List::ScopeMethodDefiner #:nodoc:
     if caller_class.reflections.key?(name.to_s)
       caller_class.reflections[name.to_s].foreign_key.to_sym
     else
-      foreign_key(name).to_sym
+      ActiveSupport::Inflector.foreign_key(name).to_sym
     end
   end
 end

data/lib/acts_as_list/active_record/acts/sequential_updates_method_definer.rb

@@ -1,24 +1,24 @@
 # frozen_string_literal: true
 
+require_relative './with_connection'
+
 module ActiveRecord::Acts::List::SequentialUpdatesMethodDefiner #:nodoc:
   def self.call(caller_class, column, sequential_updates_option)
     caller_class.class_eval do
       define_method :sequential_updates? do
-        if !defined?(@sequential_updates)
-          if sequential_updates_option.nil?
-            table_exists =
-              if active_record_version_is?('>= 5')
-                caller_class.connection.data_source_exists?(caller_class.table_name)
-              else
-                caller_class.connection.table_exists?(caller_class.table_name)
-              end
-            index_exists = caller_class.connection.index_exists?(caller_class.table_name, column, unique: true)
-            @sequential_updates = table_exists && index_exists
-          else
-            @sequential_updates = sequential_updates_option
-          end
-        else
-          @sequential_updates
+        return @sequential_updates if defined?(@sequential_updates)
+
+        return @sequential_updates = sequential_updates_option unless sequential_updates_option.nil?
+
+        ActiveRecord::Acts::List::WithConnection.new(caller_class).call do |connection|
+          table_exists =
+            if active_record_version_is?('>= 5')
+              connection.data_source_exists?(caller_class.table_name)
+            else
+              connection.table_exists?(caller_class.table_name)
+            end
+          index_exists = connection.index_exists?(caller_class.table_name, column, unique: true)
+          @sequential_updates = table_exists && index_exists
         end
       end
 

data/lib/acts_as_list/active_record/acts/with_connection.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Acts
+    module List
+      class WithConnection
+        def initialize(recipient)
+          @recipient = recipient
+        end
+
+        attr_reader :recipient
+
+        def call
+          if recipient.respond_to?(:with_connection)
+            recipient.with_connection do |connection|
+              yield connection
+            end
+          else
+            yield recipient.connection
+          end
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_list/version.rb

@@ -3,7 +3,7 @@
 module ActiveRecord
   module Acts
     module List
-      VERSION = '1.0.4'
+      VERSION = '1.2.4'
     end
   end
 end