acts_as_list 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36b9ed8db57946d5ac96c829c68ce4f4107068628827840140e9dadb3c682fa
-  data.tar.gz: 60b6890922d26b913aed5a212eae7d228629c1ce3721dd0818ec2e5069697d25
+  metadata.gz: ece77b4a7a9c6c50d1d7a188c91c6dedd4c1dba4c8ece714c2922b339c3b5490
+  data.tar.gz: e7d925c76332e504d6a3db3706c4362b962d5bef2f9c882023bef99a0763e2d1
 SHA512:
-  metadata.gz: 1bfced5d2dd4e50194eb8bdb92b244d40dd0a19df0ee663649510a965077a0d332715dc0100c1e9d006222e96e57745638c77812767b88ec7b9274dd350af4c1
-  data.tar.gz: 485f6be53763f1f112095075b1c69d6e620f89018c2e3435f3500decf986e110c832f78ce5db6462d6233d13816516a2c1d59df1e3c172455439a11704b1c8b5
+  metadata.gz: 8ca617673d046ef18baab0a51d4e481ac10e7b044c569a9efb201c894be702aec66eb72cbc5364bb85b6374c144990fcc3c367b01cc62e0f431d87b6e41e0f4f
+  data.tar.gz: c1ce411f1aa503b28a837b714db52a4bcb42ae78542183f6641aa0d0f483c9c98b3521a4557554e9de539b12effeee6f901632636d61408e423c55d67287f47b

data/.github/dependabot.yml

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

data/.github/workflows/ci.yml

@@ -0,0 +1,123 @@
+---
+name: CI
+on: [push, pull_request]
+
+jobs:
+  tests:
+    name: Ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}, DB ${{ matrix.db }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.4
+          - 2.5
+          - 2.6
+          - 2.7
+          - '3.0'
+          - 3.1
+          - 3.2
+        gemfile:
+          - gemfiles/rails_4_2.gemfile
+          - gemfiles/rails_5_0.gemfile
+          - gemfiles/rails_5_1.gemfile
+          - gemfiles/rails_5_2.gemfile
+          - gemfiles/rails_6_0.gemfile
+          - gemfiles/rails_6_1.gemfile
+          - gemfiles/rails_7_0.gemfile
+        db:
+          - sqlite
+          - mysql
+          - postgresql
+        exclude:
+          - ruby: 2.4
+            gemfile: gemfiles/rails_6_0.gemfile
+          - ruby: 2.4
+            gemfile: gemfiles/rails_6_1.gemfile
+          - ruby: 2.4
+            gemfile: gemfiles/rails_7_0.gemfile
+          - ruby: 2.5
+            gemfile: gemfiles/rails_7_0.gemfile
+          - ruby: 2.6
+            gemfile: gemfiles/rails_7_0.gemfile
+          - ruby: 2.7
+            gemfile: gemfiles/rails_4_2.gemfile
+          - ruby: 2.7
+            gemfile: gemfiles/rails_5_0.gemfile
+            db: sqlite
+          - ruby: '3.0'
+            gemfile: gemfiles/rails_4_2.gemfile
+          - ruby: '3.0'
+            gemfile: gemfiles/rails_5_0.gemfile
+          - ruby: '3.0'
+            gemfile: gemfiles/rails_5_1.gemfile
+          - ruby: '3.0'
+            gemfile: gemfiles/rails_5_2.gemfile
+          - ruby: 3.1
+            gemfile: gemfiles/rails_4_2.gemfile
+          - ruby: 3.1
+            gemfile: gemfiles/rails_5_0.gemfile
+          - ruby: 3.1
+            gemfile: gemfiles/rails_5_1.gemfile
+          - ruby: 3.1
+            gemfile: gemfiles/rails_5_2.gemfile
+          - ruby: 3.1
+            gemfile: gemfiles/rails_6_0.gemfile
+          - ruby: 3.2
+            gemfile: gemfiles/rails_4_2.gemfile
+          - ruby: 3.2
+            gemfile: gemfiles/rails_5_0.gemfile
+          - ruby: 3.2
+            gemfile: gemfiles/rails_5_1.gemfile
+          - ruby: 3.2
+            gemfile: gemfiles/rails_5_2.gemfile
+          - ruby: 3.2
+            gemfile: gemfiles/rails_6_0.gemfile
+          - ruby: 3.2
+            gemfile: gemfiles/rails_6_1.gemfile
+        os:
+          - ubuntu-latest
+    services:
+      mysql:
+        image: mysql:5.7
+        env:
+            MYSQL_ALLOW_EMPTY_PASSWORD: yes
+        ports:
+            - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+      postgres:
+        # Docker Hub image
+        image: postgres
+        # Provide the password for postgres
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_HOST_AUTH_METHOD: trust
+        ports:
+          - 5432:5432
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+      DB: ${{ matrix.db }}
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: "Create MySQL database"
+        if: ${{ env.DB == 'mysql' }}
+        run: |
+          mysql -h 127.0.0.1 -u root -e 'create database acts_as_list;'
+      - name: "Create PostgreSQL database"
+        if: ${{ env.DB == 'postgresql' }}
+        run: |
+          psql -c 'create database acts_as_list;' -h localhost -U postgres
+      - name: Run tests
+        run: bundle exec rake 

data/Appraisals

@@ -36,5 +36,9 @@ appraise "rails-6-0" do
 end
 
 appraise "rails-6-1" do
-  gem "activerecord", "6.1.0.rc1"
+  gem "activerecord", "~> 6.1.0"
+end
+
+appraise "rails-7-0" do
+  gem "activerecord", "~> 7.0.0"
 end

data/CHANGELOG.md

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

@@ -133,26 +133,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`

data/gemfiles/rails_6_1.gemfile

@@ -4,7 +4,7 @@ source "http://rubygems.org"
 
 gem "rake"
 gem "appraisal"
-gem "activerecord", "6.1.0.rc1"
+gem "activerecord", "~> 6.1.0"
 
 group :development do
   gem "github_changelog_generator", "1.9.0"

data/gemfiles/rails_7_0.gemfile

@@ -0,0 +1,31 @@
+# This file was generated by Appraisal
+
+source "http://rubygems.org"
+
+gem "rake"
+gem "appraisal"
+gem "activerecord", "~> 7.0.0"
+
+group :development do
+  gem "github_changelog_generator", "~> 1.16.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.3.0"
+end
+
+group :mysql do
+  gem "mysql2", "~> 0.5.0"
+end
+
+gemspec path: "../"

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

@@ -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?
@@ -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
 

data/lib/acts_as_list/version.rb

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

data/test/database.yml

@@ -4,13 +4,15 @@ sqlite:
 
 mysql:
   adapter: mysql2
+  host: 127.0.0.1
   username: root
   password:
   database: acts_as_list
 
 postgresql:
   adapter: postgresql
+  host: localhost
   username: postgres
-  password:
+  password: postgres
   database: acts_as_list
   min_messages: ERROR

data/test/shared_no_addition.rb

@@ -34,5 +34,40 @@ module Shared
       new.reload
       assert !new.in_list?
     end
+
+    def test_collision_avoidance_with_explicit_position
+      first = NoAdditionMixin.create(parent_id: 20, pos: 1)
+      second = NoAdditionMixin.create(parent_id: 20, pos: 1)
+      third = NoAdditionMixin.create(parent_id: 30, pos: 1)
+
+      first.reload
+      second.reload
+      third.reload
+
+      assert_equal 2, first.pos
+      assert_equal 1, second.pos
+      assert_equal 1, third.pos
+
+      first.update(pos: 1)
+
+      first.reload
+      second.reload
+
+      assert_equal 1, first.pos
+      assert_equal 2, second.pos
+
+      first.update(parent_id: 30)
+
+      first.reload
+      second.reload
+      third.reload
+
+      assert_equal 1, first.pos
+      assert_equal 30, first.parent_id
+      assert_equal 1, second.pos
+      assert_equal 20, second.parent_id
+      assert_equal 2, third.pos
+      assert_equal 30, third.parent_id
+    end
   end
 end

data/test/test_list.rb

@@ -604,6 +604,42 @@ class MultiDestroyTest < ActsAsListTestCase
   end
 end
 
+class MultiUpdateTest < ActsAsListTestCase
+
+  def setup
+    setup_db
+  end
+
+  def test_multiple_updates_within_transaction
+    @page = ListMixin.create! id: 100, parent_id: nil, pos: 1
+    @row = ListMixin.create! parent_id: @page.id, pos: 1
+    @column1 = ListMixin.create! parent_id: @row.id, pos: 1
+    @column2 = ListMixin.create! parent_id: @row.id, pos: 2
+    @rich_text1 = ListMixin.create! parent_id: @column1.id, pos: 1
+    @rich_text2 = ListMixin.create! parent_id: @column2.id, pos: 1
+
+    ActiveRecord::Base.transaction do
+      @rich_text1.update!(parent_id: @column2.id, pos: 1)
+
+      assert_equal [@rich_text1.id, @rich_text2.id], ListMixin.where(parent_id: @column2.id).order('pos').map(&:id)
+      assert_equal [1, 2], ListMixin.where(parent_id: @column2.id).order('pos').map(&:pos)
+
+      @column1.destroy!
+      assert_equal [@column2.id], ListMixin.where(parent_id: @row.id).order('pos').map(&:id)
+      assert_equal [1], ListMixin.where(parent_id: @row.id).order('pos').map(&:pos)
+
+      @rich_text1.update!(parent_id: @page.id, pos: 1)
+      @rich_text2.update!(parent_id: @page.id, pos: 2)
+      @row.destroy!
+      @column2.destroy!
+    end
+
+    assert_equal(1, @page.reload.pos)
+    assert_equal [@rich_text1.id, @rich_text2.id], ListMixin.where(parent_id: @page.id).order('pos').map(&:id)
+    assert_equal [1, 2], ListMixin.where(parent_id: @page.id).order('pos').map(&:pos)
+  end
+end
+
 #class TopAdditionMixin < Mixin
 
 class TopAdditionTest < ActsAsListTestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_list
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Swanand Pagnis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -51,6 +51,8 @@ extra_rdoc_files: []
 files:
 - ".gemtest"
 - ".github/FUNDING.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".travis.yml"
 - Appraisals
@@ -66,6 +68,7 @@ files:
 - gemfiles/rails_5_2.gemfile
 - gemfiles/rails_6_0.gemfile
 - gemfiles/rails_6_1.gemfile
+- gemfiles/rails_7_0.gemfile
 - init.rb
 - lib/acts_as_list.rb
 - lib/acts_as_list/active_record/acts/active_record.rb
@@ -118,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: A gem adding sorting, reordering capabilities to an active_record model,