acts_as_positioned 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83b94938abcb3a029732e108e86d077e46d60674
-  data.tar.gz: 445a9a8fd77994dca9df179e796f3208397bd1b1
+  metadata.gz: 6d3bc41882a5401fb9cba86783a4ec62e0a51028
+  data.tar.gz: 7dd0ca43f2a54ccc6697f58f892734f781f8e104
 SHA512:
-  metadata.gz: 949f19c613d45803c816678b6b6f3dcc00ddf1f67f47b533c4d9e0443285970c41f5f90330e9fbb1f61c3cd7a546354d3bda2859e58bb8b43858ea5a45d3eaa7
-  data.tar.gz: 847050cd223261db55862b04d71113975ddc7057f70a8bc0b0e94e5ec4a3482ba9e62995267189a430dcc5f8dd370544c62d1e9926cd94c5bbeaa1535499d560
+  metadata.gz: 2a41117d8ce0709ddf8c10448880b75357f9699dde310ae4a40bcf5116d8ff18203bd7d1044d7eb5d8f4ad2b04e75461ea91eec1eebbb5654ec09ea68f79a7f2
+  data.tar.gz: fd3424c2a28730f35e77bd08eaf4b5c7fca883e52e941eba8fe74734b53b54817ee7246fbe2bdc0407850dbc83864ba59010a2cfa6e2478cfb622f6296bcc1e9

data/lib/acts_as_positioned.rb

@@ -7,79 +7,81 @@ module ActsAsPositioned
   # Class methods that will be added to the base class (the class mixing in this module).
   module ClassMethods
     def acts_as_positioned(options = {})
-      column = options[:column] || :position
-      scope_columns = Array.wrap(options[:scope])
+      column = (options[:column] || :position).to_s
+      scope_columns = Array.wrap(options[:scope]).map(&:to_s)
 
       after_validation do
-        acts_as_positioned_validation(column, scope_columns)
+        aap_validate_position(column, scope_columns)
       end
 
       before_create do
-        acts_as_positioned_create(column, scope_columns)
+        aap_insert_position(column, scope_columns)
       end
 
       before_destroy do
-        acts_as_positioned_destroy(column, scope_columns)
+        aap_remove_position(column, scope_columns)
       end
 
       before_update do
-        acts_as_positioned_update(column, scope_columns)
+        aap_update_position(column, scope_columns)
       end
     end
   end
 
   private
 
-  def acts_as_positioned_create(column, scope_columns)
-    scope = acts_as_positioned_scope(column, scope_columns)
+  def aap_insert_position(column, scope_columns)
+    scope = aap_scope(column, scope_columns)
     scope.where(scope.arel_table[column].gteq(send(column))).update_all("#{column} = #{column} + 1")
   end
 
-  def acts_as_positioned_destroy(column, scope_columns)
-    scope = acts_as_positioned_scope(column, scope_columns, true)
+  def aap_remove_position(column, scope_columns)
+    scope = aap_scope(column, scope_columns, true)
     scope.where(scope.arel_table[column].gt(send("#{column}_was"))).update_all("#{column} = #{column} - 1")
   end
 
-  def acts_as_positioned_scope(column, scope_columns, use_old_values = false)
-    scope_columns.reduce(self.class.base_class.where.not(column => nil)) do |scope, scope_column|
-      scope.where(scope_column => use_old_values ? send("#{scope_column}_was") : send(scope_column))
-    end
+  def aap_scope(column, scope_columns, use_old_values = false)
+    # When using the old values, make sure to overwrite the attribute values with the old values.
+    attrs = use_old_values ? attributes.merge(changed_attributes) : attributes
+    self.class.base_class.where(attrs.slice(*scope_columns)).where.not(column => nil)
   end
 
-  def acts_as_positioned_update(column, scope_columns)
-    if scope_columns.any? { |scope_column| send("#{scope_column}_changed?") }
-      acts_as_positioned_create(column, scope_columns)
-      acts_as_positioned_destroy(column, scope_columns)
+  def aap_switch_positions(column, scope_columns)
+    old_value, new_value = changes[column]
+    from, to, sign = old_value < new_value ? [old_value + 1, new_value, '-'] : [new_value, old_value - 1, '+']
 
-    elsif send(:"#{column}_changed?")
-      old_value, new_value = send("#{column}_change")
+    scope = aap_scope(column, scope_columns)
+    statement = "#{column} = #{column} #{sign} 1"
+    statement = ", #{locking_column} = #{locking_column} + 1" if scope.locking_enabled?
+    scope.where(column => from.eql?(to) ? from : from..to).update_all(statement)
+  end
 
-      # If the new position becomes nil (and thus the old position wasn't), it should destroy a position.
-      if new_value.nil?
-        acts_as_positioned_destroy(column, scope_columns)
+  def aap_update_position(column, scope_columns)
+    if (changes.keys & scope_columns).present?
+      aap_insert_position(column, scope_columns)
+      aap_remove_position(column, scope_columns)
 
-      # If the old position was nil (and thus the new position isn't), it should insert a position.
-      elsif old_value.nil?
-        acts_as_positioned_create(column, scope_columns)
+    elsif changes.key?(column)
+      # If the position was nil, it should insert a position.
+      if changes[column][0].nil?
+        aap_insert_position(column, scope_columns)
 
-      else
-        from, to, sign = old_value < new_value ? [old_value + 1, new_value, '-'] : [new_value, old_value - 1, '+']
+      # If the position becomes nil, it should remove a position.
+      elsif changes[column][1].nil?
+        aap_remove_position(column, scope_columns)
 
-        acts_as_positioned_scope(column, scope_columns)
-          .where(column => from.eql?(to) ? from : from..to)
-          .update_all("#{column} = #{column} #{sign} 1")
+      else
+        aap_switch_positions(column, scope_columns)
       end
     end
   end
 
-  def acts_as_positioned_validation(column, scope_columns)
-    return if errors[column].any?
-
-    scope = acts_as_positioned_scope(column, scope_columns)
-    scope = scope.where(scope.arel_table[scope.primary_key].not_eq(id)) unless new_record?
-    options = { attributes: column, allow_nil: true, only_integer: true, greater_than_or_equal_to: 0,
-                less_than_or_equal_to: (scope.maximum(column) || -1) + 1 }
+  def aap_validate_position(column, scope_columns)
+    return if errors[column].present? || (changes.keys & ([column] + scope_columns)).empty?
 
+    scope = aap_scope(column, scope_columns)
+    options = { attributes: column, allow_nil: true, greater_than_or_equal_to: 0, only_integer: true,
+                less_than_or_equal_to: scope.where.not(scope.primary_key => id).count }
     ActiveModel::Validations::NumericalityValidator.new(options).validate(self)
   end
 end

data/test/acts_as_positioned_test.rb

@@ -0,0 +1,168 @@
+require('active_record')
+require('minitest')
+require('minitest/autorun')
+require_relative('../lib/acts_as_positioned')
+
+# Test by running: ruby test/acts_as_positioned_test.rb
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: File.dirname(__FILE__) + '/test.sqlite3')
+
+# Create "posts" table.
+ActiveRecord::Schema.define do
+  create_table(:posts, force: true) do |t|
+    t.string(:text, null: false)
+    t.integer(:position)
+    t.integer(:author_id)
+  end
+end
+
+# Create "animals" table.
+ActiveRecord::Schema.define do
+  create_table(:animals, force: true) do |t|
+    t.string(:type, null: false)
+    t.integer(:ordering)
+  end
+end
+
+class BasicPost < ActiveRecord::Base
+  self.table_name = 'posts'
+  acts_as_positioned
+end
+
+# Basic tests.
+class BasicTests < Minitest::Test
+  def setup
+    BasicPost.delete_all
+    @post1 = BasicPost.create(text: '1st post', position: 0)
+    @post2 = BasicPost.create(text: '2nd post', position: 1)
+    @post3 = BasicPost.create(text: '3rd post', position: 2)
+  end
+
+  def test_insert_record
+    post4 = BasicPost.create(text: '4th post', position: 1)
+    assert_equal(post4.position, 1)
+    assert_equal(@post1.reload.position, 0)
+    assert_equal(@post2.reload.position, 2)
+    assert_equal(@post3.reload.position, 3)
+  end
+
+  def test_delete_record
+    @post2.destroy
+    assert_equal(@post1.reload.position, 0)
+    assert_equal(@post3.reload.position, 1)
+  end
+
+  def test_move_record_downwards
+    @post1.update(position: 1)
+    assert_equal(@post1.reload.position, 1)
+    assert_equal(@post2.reload.position, 0)
+    assert_equal(@post3.reload.position, 2)
+  end
+
+  def test_move_record_upwards
+    @post3.update(position: 0)
+    assert_equal(@post1.reload.position, 1)
+    assert_equal(@post2.reload.position, 2)
+    assert_equal(@post3.reload.position, 0)
+  end
+
+  def test_move_record_downwards_and_upwards
+    @post1.update(position: 1)
+    @post1.update(position: 0)
+    assert_equal(@post1.reload.position, 0)
+    assert_equal(@post2.reload.position, 1)
+    assert_equal(@post3.reload.position, 2)
+  end
+
+  def test_insert_record_without_position_should_do_nothing
+    post4 = BasicPost.create(text: '4th post')
+    assert_nil(post4.position)
+    assert_equal(@post1.reload.position, 0)
+    assert_equal(@post2.reload.position, 1)
+    assert_equal(@post3.reload.position, 2)
+  end
+
+  def test_clear_position
+    @post1.update(position: nil)
+    assert_equal(@post2.reload.position, 0)
+    assert_equal(@post3.reload.position, 1)
+  end
+
+  def test_fill_position
+    post4 = BasicPost.create(text: '4th post')
+    assert_nil(post4.position)
+    assert_equal(@post1.reload.position, 0)
+    assert_equal(@post2.reload.position, 1)
+    assert_equal(@post3.reload.position, 2)
+
+    post4.update(position: 1)
+    assert_equal(post4.position, 1)
+    assert_equal(@post1.reload.position, 0)
+    assert_equal(@post2.reload.position, 2)
+    assert_equal(@post3.reload.position, 3)
+  end
+
+  def test_update_record_without_position_should_do_nothing
+    post4 = BasicPost.create(text: 'Initial text', position: 0)
+    assert_equal(post4.reload.position, 0)
+    post4.update(text: 'Changed text')
+    assert_equal(post4.reload.position, 0)
+  end
+
+  # First record that gets created, must have position 0.
+  def test_validation
+    post4 = BasicPost.new(text: 'Post', position: 4)
+    assert_equal(post4.valid?, false)
+  end
+end
+
+class ScopedPost < ActiveRecord::Base
+  self.table_name = 'posts'
+  acts_as_positioned(scope: :author_id)
+end
+
+# Scoped model tests.
+class ScopedTests < Minitest::Test
+  def setup
+    ScopedPost.delete_all
+    @post1 = ScopedPost.create(text: '1st post', position: 0)
+    @post2 = ScopedPost.create(text: '1nd post for author 1', position: 0, author_id: 1)
+    @post3 = ScopedPost.create(text: '2nd post for author 1', position: 1, author_id: 1)
+  end
+
+  def test_insert_record_with_scope_column
+    post4 = ScopedPost.create(text: '3th post for author 1', position: 1, author_id: 1)
+    assert_equal(post4.position, 1)
+    assert_equal(@post1.reload.position, 0)
+    assert_equal(@post2.reload.position, 0)
+    assert_equal(@post3.reload.position, 2)
+  end
+
+  def test_reposition_when_author_changes
+    @post2.update(author_id: nil)
+    assert_equal(@post2.position, 0)
+    assert_equal(@post1.reload.position, 1)
+    assert_equal(@post3.reload.position, 0)
+  end
+end
+
+# Animal base class to test single table inheritance.
+class Animal < ActiveRecord::Base
+  acts_as_positioned(column: :ordering)
+end
+
+# Cat sub class to test single table inheritance.
+class Cat < Animal
+end
+
+# Dog sub class to test single table inheritance.
+class Dog < Animal
+end
+
+class SingleTableInheritanceTests < Minitest::Test
+  def test_single_table_inheritance
+    cat = Cat.create(ordering: 0)
+    dog = Dog.create(ordering: 0)
+    assert_equal(dog.ordering, 0)
+    assert_equal(cat.reload.ordering, 1)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_positioned
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Walter Horstman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-23 00:00:00.000000000 Z
+date: 2017-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -91,7 +91,8 @@ files:
 - README.md
 - Rakefile
 - lib/acts_as_positioned.rb
-- test/lib/acts_as_positioned_test.rb
+- test/acts_as_positioned_test.rb
+- test/test.sqlite3
 homepage: http://github.com/walterhorstman/acts_as_positioned
 licenses: []
 metadata: {}
@@ -116,4 +117,5 @@ signing_key:
 specification_version: 4
 summary: Lightweight ordering of models in ActiveRecord 3 or higher
 test_files:
-- test/lib/acts_as_positioned_test.rb
+- test/acts_as_positioned_test.rb
+- test/test.sqlite3

data/test/lib/acts_as_positioned_test.rb

@@ -1,179 +0,0 @@
-require('active_record')
-require('minitest')
-require('minitest/autorun')
-require('acts_as_positioned')
-
-# Test by running: ruby -Ilib test/lib/acts_as_positioned_test.rb
-ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: File.dirname(__FILE__) + '/../test.sqlite3')
-
-# Create "posts" table.
-ActiveRecord::Schema.define do
-  create_table(:posts, force: true) do |t|
-    t.string(:text, null: false)
-    t.integer(:position)
-    t.integer(:author_id)
-  end
-end
-
-# Create "animals" table.
-ActiveRecord::Schema.define do
-  create_table(:animals, force: true) do |t|
-    t.string(:type, null: false)
-    t.string(:sound, null: false)
-    t.integer(:ordering)
-  end
-end
-
-class Post < ActiveRecord::Base
-  acts_as_positioned
-end
-
-class PostWithScope < ActiveRecord::Base
-  self.table_name = 'posts'
-  acts_as_positioned(scope: :author_id)
-end
-
-class Animal < ActiveRecord::Base
-  acts_as_positioned(column: :ordering)
-end
-
-class Cat < Animal
-end
-
-class Dog < Animal
-end
-
-class ActsAsPositionedTest < Minitest::Test
-  def setup
-    Post.delete_all
-  end
-
-  def test_insert_record
-    post1 = Post.create(text: '1st post', position: 0)
-    post2 = Post.create(text: '2nd post', position: 1)
-    post3 = Post.create(text: '3rd post', position: 2)
-    post4 = Post.create(text: '4th post', position: 1)
-    assert_equal(post4.position, 1)
-    assert_equal(post1.reload.position, 0)
-    assert_equal(post2.reload.position, 2)
-    assert_equal(post3.reload.position, 3)
-  end
-
-  def test_delete_record
-    post1 = Post.create(text: '1st post', position: 0)
-    post2 = Post.create(text: '2nd post', position: 1)
-    post3 = Post.create(text: '3rd post', position: 2)
-    post2.destroy
-    assert_equal(post1.reload.position, 0)
-    assert_equal(post3.reload.position, 1)
-  end
-
-  def test_move_record_downwards
-    post1 = Post.create(text: '1st post', position: 0)
-    post2 = Post.create(text: '2nd post', position: 1)
-    post3 = Post.create(text: '3rd post', position: 2)
-    post1.update(position: 1)
-    assert_equal(post1.reload.position, 1)
-    assert_equal(post2.reload.position, 0)
-    assert_equal(post3.reload.position, 2)
-  end
-
-  def test_move_record_upwards
-    post1 = Post.create(text: '1st post', position: 0)
-    post2 = Post.create(text: '2nd post', position: 1)
-    post3 = Post.create(text: '3rd post', position: 2)
-    post3.update(position: 0)
-    assert_equal(post1.reload.position, 1)
-    assert_equal(post2.reload.position, 2)
-    assert_equal(post3.reload.position, 0)
-  end
-
-  def test_move_record_downwards_and_upwards
-    post1 = Post.create(text: '1st post', position: 0)
-    post2 = Post.create(text: '2nd post', position: 1)
-    post3 = Post.create(text: '3rd post', position: 2)
-    post1.update(position: 1)
-    post1.update(position: 0)
-    assert_equal(post1.reload.position, 0)
-    assert_equal(post2.reload.position, 1)
-    assert_equal(post3.reload.position, 2)
-  end
-
-  def test_insert_record_without_position_should_do_nothing
-    post1 = Post.create(text: '1st post', position: 0)
-    post2 = Post.create(text: '2nd post', position: 1)
-    post3 = Post.create(text: '3rd post', position: 2)
-    post4 = Post.create(text: '4th post')
-    assert_nil(post4.position)
-    assert_equal(post1.reload.position, 0)
-    assert_equal(post2.reload.position, 1)
-    assert_equal(post3.reload.position, 2)
-  end
-
-  def test_clear_position
-    post1 = Post.create(text: '1st post', position: 0)
-    post2 = Post.create(text: '2nd post', position: 1)
-    post3 = Post.create(text: '3rd post', position: 2)
-    post1.update(position: nil)
-    assert_equal(post2.reload.position, 0)
-    assert_equal(post3.reload.position, 1)
-  end
-
-  def test_fill_position
-    post1 = Post.create(text: '1st post', position: 0)
-    post2 = Post.create(text: '2nd post', position: 1)
-    post3 = Post.create(text: '3rd post', position: 2)
-    post4 = Post.create(text: '4th post')
-    assert_nil(post4.position)
-    assert_equal(post1.reload.position, 0)
-    assert_equal(post2.reload.position, 1)
-    assert_equal(post3.reload.position, 2)
-
-    post4.update(position: 1)
-    assert_equal(post4.position, 1)
-    assert_equal(post1.reload.position, 0)
-    assert_equal(post2.reload.position, 2)
-    assert_equal(post3.reload.position, 3)
-  end
-
-  def test_update_record_without_position_should_do_nothing
-    post = Post.create(text: 'Initial text', position: 0)
-    assert_equal(post.reload.position, 0)
-    post.update(text: 'Changed text')
-    assert_equal(post.reload.position, 0)
-  end
-
-  # First record that gets created, must have position 0.
-  def test_validation
-    post = Post.new(text: 'Post', position: 4)
-    assert_equal(post.valid?, false)
-  end
-
-  def test_insert_record_with_scope_column
-    post1 = PostWithScope.create(text: '1st post', position: 0)
-    post2 = PostWithScope.create(text: '1nd post for author 1', position: 0, author_id: 1)
-    post3 = PostWithScope.create(text: '2nd post for author 1', position: 1, author_id: 1)
-    post4 = PostWithScope.create(text: '3th post for author 1', position: 1, author_id: 1)
-    assert_equal(post4.position, 1)
-    assert_equal(post1.reload.position, 0)
-    assert_equal(post2.reload.position, 0)
-    assert_equal(post3.reload.position, 2)
-  end
-
-  def test_reposition_when_author_changes
-    post1 = PostWithScope.create(text: '1st post', position: 0)
-    post2 = PostWithScope.create(text: '1nd post for author 1', position: 0, author_id: 1)
-    post3 = PostWithScope.create(text: '2nd post for author 1', position: 1, author_id: 1)
-    post2.update(author_id: nil)
-    assert_equal(post2.position, 0)
-    assert_equal(post1.reload.position, 1)
-    assert_equal(post3.reload.position, 0)
-  end
-
-  def test_single_table_inheritance
-    cat = Cat.create(sound: 'Miaow', ordering: 0)
-    dog = Dog.create(sound: 'Bark', ordering: 0)
-    assert_equal(dog.ordering, 0)
-    assert_equal(cat.reload.ordering, 1)
-  end
-end