acts_as_list 1.0.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36b9ed8db57946d5ac96c829c68ce4f4107068628827840140e9dadb3c682fa
-  data.tar.gz: 60b6890922d26b913aed5a212eae7d228629c1ce3721dd0818ec2e5069697d25
+  metadata.gz: 97086f40e0296a92be25b988885cb618bd17323c31639c7b976e20e82005da54
+  data.tar.gz: 225e05bc8973871d0a7955abaf181180ff5b8de3d2b461278eeb260df3a49b2c
 SHA512:
-  metadata.gz: 1bfced5d2dd4e50194eb8bdb92b244d40dd0a19df0ee663649510a965077a0d332715dc0100c1e9d006222e96e57745638c77812767b88ec7b9274dd350af4c1
-  data.tar.gz: 485f6be53763f1f112095075b1c69d6e620f89018c2e3435f3500decf986e110c832f78ce5db6462d6233d13816516a2c1d59df1e3c172455439a11704b1c8b5
+  metadata.gz: 6d43449915c885f64e477bff8c4a9e0d581e632e4cfab61e0f313fc0b67c4507f6cda9e3aab5afb53357cc44fee664f873e7ca2b93b0f22a22b1e272ed1e39db
+  data.tar.gz: 24dfa6bf08290e1d18331ee5ad7c0eeb03ae1dce2191881503a889058136ccfb8007d0acbee9bc57e5363073740a8efec872225b4978922d0a1f1dcf49c3ca0a

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/continuous_integration.yml

@@ -0,0 +1,62 @@
+name: Continuous Integration
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    name: Ruby ${{ matrix.ruby }}, DB ${{ matrix.db }}, Rails ${{ matrix.rails }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+        rails:
+          - '6.1'
+          - '7.0'
+          - '7.1'
+        db:
+          - mysql
+          - postgresql
+          - sqlite
+        exclude:
+          - rails: '7.0'
+            ruby: '3.1'
+          - rails: '7.0'
+            ruby: '3.2'
+          - rails: '7.0'
+            ruby: '3.3'
+    env:
+      DB: ${{ matrix.db }}
+      RAILS_VERSION: ${{ matrix.rails }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Enable MySQL
+        if: ${{ matrix.db == 'mysql' }}
+        run: sudo systemctl start mysql.service
+      - name: Create MySQL Database
+        if: ${{ matrix.db == 'mysql' }}
+        run: mysql -u root -proot -e 'CREATE DATABASE runner;'
+      - name: Enable PostgreSQL
+        if: ${{ matrix.db == 'postgresql' }}
+        run: sudo systemctl start postgresql.service
+      - name: Create PostgreSQL User
+        if: ${{ matrix.db == 'postgresql' }}
+        run: sudo -u postgres -i createuser runner -s
+      - name: Create PostgreSQL Database
+        if: ${{ matrix.db == 'postgresql' }}
+        run: createdb runner
+      - name: Run the default task
+        run: bundle exec rake

data/.gitignore

@@ -7,6 +7,7 @@ pkg/*
 .rbenv-version
 .ruby-gemset
 .ruby-version
-# Appraisal generated lockfiles
-*.gemfile.lock
 .DS_Store
+/tmp/
+/db/
+file::memory*

data/CHANGELOG.md

@@ -6,6 +6,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 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

data/Gemfile

@@ -1,28 +1,13 @@
 source "http://rubygems.org"
 
+# Specify your gem's dependencies in positioning.gemspec
 gemspec
 
-gem "rake"
-gem "appraisal"
+gem "rake", "~> 13.0"
 
-group :development do
-  gem "github_changelog_generator", "1.9.0"
-end
-
-group :test do
-  gem "minitest", "~> 5.0"
-  gem "timecop"
-  gem "mocha"
-end
-
-group :sqlite do
-  gem "sqlite3", "~> 1.4"
-end
-
-group :postgresql do
-  gem "pg", "~> 1.2.0"
-end
+gem "minitest", "~> 5.0"
 
-group :mysql do
-  gem "mysql2", "~> 0.5.0"
+if ENV["RAILS_VERSION"]
+  gem "activerecord", ENV["RAILS_VERSION"]
+  gem "activesupport", ENV["RAILS_VERSION"]
 end

data/README.md

@@ -4,6 +4,11 @@
 [![Build Status](https://travis-ci.org/brendon/acts_as_list.svg?branch=master)](https://travis-ci.org/brendon/acts_as_list)
 [![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 aquainted 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
 

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/acts_as_list.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.platform              = Gem::Platform::RUBY
   s.authors               = ["Swanand Pagnis", "Brendon Muir"]
   s.email                 = %w(swanand.pagnis@gmail.com brendon@spikeatschool.co.nz)
-  s.homepage              = "http://github.com/brendon/acts_as_list"
+  s.homepage              = "https://github.com/brendon/acts_as_list"
   s.summary               = "A gem adding sorting, reordering capabilities to an active_record model, allowing it to act as a list"
   s.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.'
   s.license               = "MIT"
@@ -27,8 +27,13 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map {|f| File.basename(f)}
   s.require_paths = ["lib"]
 
-
   # Dependencies (installed via "bundle install")
-  s.add_dependency "activerecord", ">= 4.2"
-  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_dependency "activerecord", ">= 6.1"
+  s.add_dependency "activesupport", ">= 6.1"
+  s.add_development_dependency "minitest-hooks", "~> 1.5.1"
+  s.add_development_dependency "mocha", "~> 2.1.0"
+  s.add_development_dependency "timecop", "~> 0.9.8"
+  s.add_development_dependency "mysql2", "~> 0.5.6"
+  s.add_development_dependency "pg", "~> 1.5.5"
+  s.add_development_dependency "sqlite3", "~> 1.7.2"
 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

@@ -171,7 +171,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 +188,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 +229,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 +273,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 +300,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 +341,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 +445,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
 
@@ -489,6 +480,11 @@ module ActiveRecord
           version = Gem.loaded_specs['activerecord'].version
           requirement.satisfied_by?(version)
         end
+
+        def primary_key_condition(id = nil)
+          primary_keys = Array.wrap(self.class.primary_key)
+          id ? primary_keys.zip(Array.wrap(id)).to_h : slice(*primary_keys)
+        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/version.rb

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

data/test/helper.rb

@@ -16,6 +16,8 @@ require "minitest/autorun"
 require "mocha/minitest"
 require "#{File.dirname(__FILE__)}/../init"
 
+ENV["DB"] = "mysql" unless ENV["DB"]
+
 if defined?(ActiveRecord::VERSION) &&
   ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR >= 2
 
@@ -23,8 +25,10 @@ if defined?(ActiveRecord::VERSION) &&
   ActiveRecord::Base.raise_in_transactional_callbacks = true
 end
 
-db_config = YAML.load_file(File.expand_path("../database.yml", __FILE__)).fetch(ENV["DB"] || "sqlite")
-ActiveRecord::Base.establish_connection(db_config)
+database_configuration = ENV["CI"] ? "test/support/ci_database.yml" : "test/support/database.yml"
+
+ActiveRecord::Base.configurations = YAML.safe_load(IO.read(database_configuration))
+ActiveRecord::Base.establish_connection(ENV["DB"].to_sym)
 ActiveRecord::Schema.verbose = false
 
 def teardown_db
@@ -53,8 +57,8 @@ def assert_equal_or_nil(a, b)
 end
 
 def assert_no_deprecation_warning_raised_by(failure_message = 'ActiveRecord deprecation warning raised when we didn\'t expect it', pass_message = 'No ActiveRecord deprecation raised')
-  original_behavior = ActiveSupport::Deprecation.behavior
-  ActiveSupport::Deprecation.behavior = :raise
+  original_behavior = active_record_deprecator.behavior
+  active_record_deprecator.behavior = :raise
   begin
     yield
   rescue ActiveSupport::DeprecationException => e
@@ -65,5 +69,13 @@ def assert_no_deprecation_warning_raised_by(failure_message = 'ActiveRecord depr
     pass pass_message
   end
 ensure
-  ActiveSupport::Deprecation.behavior = original_behavior
+  active_record_deprecator.behavior = original_behavior
+end
+
+def active_record_deprecator
+  if ActiveRecord::VERSION::MAJOR == 7 && ActiveRecord::VERSION::MINOR >= 1 || ActiveRecord::VERSION::MAJOR > 7
+    ActiveRecord.deprecator
+  else
+    ActiveSupport::Deprecation
+  end
 end