acts_as_list 0.7.7 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d62dacdeb7972152a2ee04cee3cccb8ef26898d7
-  data.tar.gz: fe6b02bfa1c5ed33407d1852c7b988a1848c7cd4
+  metadata.gz: cf7464bb2c953b31ccf95b2e3017ce77cf9e40bc
+  data.tar.gz: f65a617c773c1c5ebad2b85827fc675da6c23d2c
 SHA512:
-  metadata.gz: 6b376b14646463802f4aee7080663eefdb3d7b1a43088df7126f57c84ecfb0a8730470efe4b57758f2b2079d6bd52b19f2a80293b211095318425d5892194897
-  data.tar.gz: fa104b99749d08767074e96f5fea1e97590ee841673660c39d03bb3d2cd50a3d2db2de4d1d195d5503d1bfadec7cbe84e046714f0ab98d0d509bc4c4797949e2
+  metadata.gz: 664518e270eafe5380772fe9dab0d661ab6184b526648ba1322f28d4c04040e9d412f00b011abe072eb289d73dc422be0aa411b1e759d2933c5ea05d08ef8773
+  data.tar.gz: ffd987ff9646c697fe2972ff2516bcc66286d528c71af311e8fe27524568d5eaad6ee774cd351345a2c8aaad8326fd9c42bd83dd9acf77d3f34dfb2a98d99d2d

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Change Log
 
+## [v0.7.7](https://github.com/swanandp/acts_as_list/tree/v0.7.7) (2016-08-18)
+[Full Changelog](https://github.com/swanandp/acts_as_list/compare/v0.7.6...v0.7.7)
+
+**Closed issues:**
+
+- Issue after upgrading to 0.7.5: No connection pool with id primary found. [\#214](https://github.com/swanandp/acts_as_list/issues/214)
+- Changing scope is inconsistent based on add\_new\_at [\#138](https://github.com/swanandp/acts_as_list/issues/138)
+- Duplicate positions and lost items [\#76](https://github.com/swanandp/acts_as_list/issues/76)
+
+**Merged pull requests:**
+
+- Add quoted table names to some columns [\#221](https://github.com/swanandp/acts_as_list/pull/221) ([jpalumickas](https://github.com/jpalumickas))
+- Appraisals cleanup [\#217](https://github.com/swanandp/acts_as_list/pull/217) ([brendon](https://github.com/brendon))
+- Fix insert\_at\_position in race condition [\#195](https://github.com/swanandp/acts_as_list/pull/195) ([danielross](https://github.com/danielross))
+
 ## [v0.7.6](https://github.com/swanandp/acts_as_list/tree/v0.7.6) (2016-07-15)
 [Full Changelog](https://github.com/swanandp/acts_as_list/compare/v0.7.5...v0.7.6)
 

data/README.md

@@ -4,6 +4,13 @@
 
 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.
 
+## 0.8.0 Upgrade Notes
+
+There are a couple of changes of behaviour from `0.8.0` onwards:
+
+- If you specify `add_new_at: :top`, new items will be added to the top of the list like always. But now, if you specify a position at insert time: `.create(position: 3)`, the position will be respected. In this example, the item will end up at position `3` and will move other items further down the list. Before `0.8.0` the position would be ignored and the item would still be added to the top of the list. [#220](https://github.com/swanandp/acts_as_list/pull/220)
+- `acts_as_list` now copes with disparate position integers (i.e. gaps between the numbers). There has been a change in behaviour for the `higher_items` method. It now returns items with the first item in the collection being the closest item to the reference item, and the last item in the collection being the furthest from the reference item (a.k.a. the first item in the list). [#223](https://github.com/swanandp/acts_as_list/pull/223)
+
 ## Installation
 
 In your Gemfile:
@@ -71,8 +78,6 @@ In `acts_as_list`, "higher" means further up the list (a lower `position`), and
 - `list_item.lower_items` will return all the items below `list_item` in the list (ordered by the position, ascending)
 
 ## Notes
-If the `position` column has a default value, then there is a slight change in behavior, i.e if you have 4 items in the list, and you insert 1, with a default position 0, it would be pushed to the bottom of the list. Please look at the tests for this and some recent pull requests for discussions related to this.
-
 All `position` queries (select, update, etc.) inside gem methods are executed without the default scope (i.e. `Model.unscoped`), this will prevent nasty issues when the default scope is different from `acts_as_list` scope.
 
 The `position` column is set after validations are called, so you should not put a `presence` validation on the `position` column.
@@ -88,11 +93,11 @@ end
 
 ## More Options
 - `column`
-default: 'position'. Use this option if the column name in your database is different from position.
+default: `position`. Use this option if the column name in your database is different from position.
 - `top_of_list`
-default: '1'. Use this option to define the top of the list. Use 0 to make the collection act more like an array in its indexing.
+default: `1`. Use this option to define the top of the list. Use 0 to make the collection act more like an array in its indexing.
 - `add_new_at`
-default: ':bottom'. Use this option to specify whether objects get added to the :top or :bottom of the list. `nil` will result in new items not being added to the list on create, i.e, position will be kept nil after create.
+default: `:bottom`. Use this option to specify whether objects get added to the `:top` or `:bottom` of the list. `nil` will result in new items not being added to the list on create, i.e, position will be kept nil after create.
 
 ## Versions
 As of version `0.7.5` Rails 5 is supported.

data/gemfiles/rails_4_1.gemfile

@@ -16,10 +16,4 @@ group :test do
   gem "after_commit_exception_notification"
 end
 
-platforms :rbx do
-  gem "rubysl", "~> 2.0"
-  gem "rubinius-developer_tools"
-  gem "rubysl-test-unit"
-end
-
 gemspec :path => "../"

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

@@ -174,8 +174,12 @@ module ActiveRecord
           return unless lower_item
 
           acts_as_list_class.transaction do
-            lower_item.decrement_position
-            increment_position
+            if lower_item.send(position_column) != self.send(position_column)
+              swap_positions(lower_item, self)
+            else
+              lower_item.decrement_position
+              increment_position
+            end
           end
         end
 
@@ -184,8 +188,12 @@ module ActiveRecord
           return unless higher_item
 
           acts_as_list_class.transaction do
-            higher_item.increment_position
-            decrement_position
+            if higher_item.send(position_column) != self.send(position_column)
+              swap_positions(higher_item, self)
+            else
+              higher_item.increment_position
+              decrement_position
+            end
           end
         end
 
@@ -236,16 +244,14 @@ module ActiveRecord
           set_list_position(self.send(position_column).to_i - 1)
         end
 
-        # Return +true+ if this object is the first in the list.
         def first?
           return false unless in_list?
-          self.send(position_column) == acts_as_list_top
+          !higher_item
         end
 
-        # Return +true+ if this object is the last in the list.
         def last?
           return false unless in_list?
-          self.send(position_column) == bottom_position_in_list
+          !lower_item
         end
 
         # Return the next higher item in the list.
@@ -261,9 +267,8 @@ module ActiveRecord
           position_value = send(position_column)
           acts_as_list_list.
             where("#{quoted_position_column_with_table_name} < ?", position_value).
-            where("#{quoted_position_column_with_table_name} >= ?", position_value - limit).
-            limit(limit).
-            order("#{quoted_position_column_with_table_name} ASC")
+            order("#{quoted_position_column_with_table_name} DESC").
+            limit(limit)
         end
 
         # Return the next lower item in the list.
@@ -279,9 +284,8 @@ module ActiveRecord
           position_value = send(position_column)
           acts_as_list_list.
             where("#{quoted_position_column_with_table_name} > ?", position_value).
-            where("#{quoted_position_column_with_table_name} <= ?", position_value + limit).
-            limit(limit).
-            order("#{quoted_position_column_with_table_name} ASC")
+            order("#{quoted_position_column_with_table_name} ASC").
+            limit(limit)
         end
 
         # Test if this record is in a list
@@ -308,23 +312,36 @@ module ActiveRecord
         end
 
         private
+
+          def swap_positions(item1, item2)
+            item1.set_list_position(item2.send(position_column))
+            item2.set_list_position(item1.send("#{position_column}_was"))
+          end
+
           def acts_as_list_list
             acts_as_list_class.unscoped do
               acts_as_list_class.where(scope_condition)
             end
           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
-            increment_positions_on_all_items
-            self[position_column] = acts_as_list_top
+            if not_in_list? || internal_scope_changed? && !position_changed || 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
-            #dont halt the callback chain
+
+            # Don't halt the callback chain
             true
           end
 
-          # A poorly named method. It will insert the item at the desired position if the position
-          # has been set manually using position=, not necessarily the bottom of the list
           def add_to_list_bottom
             if not_in_list? || internal_scope_changed? && !position_changed || default_position?
               self[position_column] = bottom_position_in_list.to_i + 1
@@ -335,7 +352,7 @@ module ActiveRecord
             # Make sure we know that we've processed this scope change already
             @scope_changed = false
 
-            #dont halt the callback chain
+            # Don't halt the callback chain
             true
           end
 

data/lib/acts_as_list/version.rb

@@ -1,7 +1,7 @@
 module ActiveRecord
   module Acts
     module List
-      VERSION = '0.7.7'
+      VERSION = '0.8.0'
     end
   end
 end

data/test/shared_list_sub.rb

@@ -43,6 +43,32 @@ module Shared
       assert_nil ListMixin.where(id: 4).first.lower_item
     end
 
+    def test_next_prev_not_regular_sequence
+      ListMixin.all.each do |item|
+        item.update_attributes(pos: item.pos * 5)
+      end
+
+      assert_equal [1, 2, 3, 4], ListMixin.where(parent_id: 5000).order('pos').map(&:id)
+
+      ListMixin.where(id: 2).first.move_lower
+      assert_equal [1, 3, 2, 4], ListMixin.where(parent_id: 5000).order('pos').map(&:id)
+
+      ListMixin.where(id: 2).first.move_higher
+      assert_equal [1, 2, 3, 4], ListMixin.where(parent_id: 5000).order('pos').map(&:id)
+
+      ListMixin.where(id: 1).first.move_to_bottom
+      assert_equal [2, 3, 4, 1], ListMixin.where(parent_id: 5000).order('pos').map(&:id)
+
+      ListMixin.where(id: 1).first.move_to_top
+      assert_equal [1, 2, 3, 4], ListMixin.where(parent_id: 5000).order('pos').map(&:id)
+
+      ListMixin.where(id: 2).first.move_to_bottom
+      assert_equal [1, 3, 4, 2], ListMixin.where(parent_id: 5000).order('pos').map(&:id)
+
+      ListMixin.where(id: 4).first.move_to_top
+      assert_equal [4, 1, 3, 2], ListMixin.where(parent_id: 5000).order('pos').map(&:id)
+    end
+
     def test_next_prev_groups
       li1 = ListMixin.where(id: 1).first
       li2 = ListMixin.where(id: 2).first
@@ -53,9 +79,9 @@ module Shared
       assert_equal [li2, li3], li1.lower_items(2)
       assert_equal [], li4.lower_items
 
-      assert_equal [li1, li2], li3.higher_items
+      assert_equal [li2, li1], li3.higher_items
       assert_equal [li1], li2.higher_items
-      assert_equal [li2, li3], li4.higher_items(2)
+      assert_equal [li3, li2], li4.higher_items(2)
       assert_equal [], li1.higher_items
     end
 

data/test/shared_top_addition.rb

@@ -4,23 +4,26 @@ module Shared
       (1..4).each { |counter| TopAdditionMixin.create! pos: counter, parent_id: 5 }
     end
 
-    def test_reordering
-      assert_equal [4, 3, 2, 1], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
+    def test_setup_state
+      # If we explicitly define a position (as above) then that position is what gets applied
+      assert_equal [1, 2, 3, 4], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
+    end
 
+    def test_reordering
       TopAdditionMixin.where(id: 2).first.move_lower
-      assert_equal [4, 3, 1, 2], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
+      assert_equal [1, 3, 2, 4], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
 
       TopAdditionMixin.where(id: 2).first.move_higher
-      assert_equal [4, 3, 2, 1], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
+      assert_equal [1, 2, 3, 4], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
 
       TopAdditionMixin.where(id: 1).first.move_to_bottom
-      assert_equal [4, 3, 2, 1], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
+      assert_equal [2, 3, 4, 1], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
 
       TopAdditionMixin.where(id: 1).first.move_to_top
-      assert_equal [1, 4, 3, 2], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
+      assert_equal [1, 2, 3, 4], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
 
       TopAdditionMixin.where(id: 2).first.move_to_bottom
-      assert_equal [1, 4, 3, 2], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
+      assert_equal [1, 3, 4, 2], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
 
       TopAdditionMixin.where(id: 4).first.move_to_top
       assert_equal [4, 1, 3, 2], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
@@ -71,16 +74,19 @@ module Shared
       assert_equal 3, new4.pos
     end
 
-    def test_delete_middle
-      assert_equal [4, 3, 2, 1], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
+    def test_supplied_position
+      new = TopAdditionMixin.create(parent_id: 20, pos: 3)
+      assert_equal 3, new.pos
+    end
 
+    def test_delete_middle
       TopAdditionMixin.where(id: 2).first.destroy
 
-      assert_equal [4, 3, 1], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
+      assert_equal [1, 3, 4], TopAdditionMixin.where(parent_id: 5).order('pos').map(&:id)
 
-      assert_equal 3, TopAdditionMixin.where(id: 1).first.pos
+      assert_equal 1, TopAdditionMixin.where(id: 1).first.pos
       assert_equal 2, TopAdditionMixin.where(id: 3).first.pos
-      assert_equal 1, TopAdditionMixin.where(id: 4).first.pos
+      assert_equal 3, TopAdditionMixin.where(id: 4).first.pos
     end
 
   end

data/test/test_joined_list.rb

@@ -51,7 +51,7 @@ class TestHigherLowerItems < JoinedTestCase
     item1 = Item.create section: section
     item2 = Item.create section: section
     item3 = Item.create section: section
-    assert_equal item3.higher_items.visible, [item1, item2]
+    assert_equal item3.higher_items.visible, [item2, item1]
   end
 
   def test_lower_items

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_list
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.8.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord