ranked-model 0.4.2 → 0.4.7

data/gemfiles/rails_5_2.gemfile

@@ -5,15 +5,18 @@ source "https://rubygems.org"
 gem "activerecord", "~> 5.2.0"
 
 group :sqlite do
-  gem "sqlite3", platform: :ruby
+  gem "sqlite3", "~> 1.3.13", platform: :ruby
+  gem "activerecord-jdbcsqlite3-adapter", "~> 52.0", platform: :jruby
 end
 
-group :mysql do
-  gem "mysql2", "~> 0.4.10", platform: :ruby
+group :postgresql do
+  gem "pg", "~> 1.2.0", platform: :ruby
+  gem "activerecord-jdbcpostgresql-adapter", "~> 52.0", platform: :jruby
 end
 
-group :postgresql do
-  gem "pg", "~> 0.21.0", platform: :ruby
+group :mysql do
+  gem "mysql2", "~> 0.5.0", platform: :ruby
+  gem "activerecord-jdbcmysql-adapter", "~> 52.0", platform: :jruby
 end
 
 gemspec path: "../"

data/gemfiles/rails_6_0.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.0"
+
+group :sqlite do
+  gem "sqlite3", "~> 1.4", platform: :ruby
+  gem "activerecord-jdbcsqlite3-adapter", "~> 60.0", platform: :jruby
+end
+
+group :postgresql do
+  gem "pg", "~> 1.2.0", platform: :ruby
+  gem "activerecord-jdbcpostgresql-adapter", "~> 60.0", platform: :jruby
+end
+
+group :mysql do
+  gem "mysql2", "~> 0.5.0", platform: :ruby
+  gem "activerecord-jdbcmysql-adapter", "~> 60.0", platform: :jruby
+end
+
+gemspec path: "../"

data/lib/ranked-model.rb

@@ -3,6 +3,8 @@ require File.dirname(__FILE__)+'/ranked-model/railtie' if defined?(Rails::Railti
 
 module RankedModel
 
+  class NonNilColumnDefault < StandardError; end
+
   # Signed INT in MySQL
   #
   MAX_RANK_VALUE = 2147483647
@@ -18,7 +20,7 @@ module RankedModel
       before_save :handle_ranking
 
       scope :rank, lambda { |name|
-        order ranker(name.to_sym).column
+        reorder ranker(name.to_sym).column
       }
     end
 
@@ -45,6 +47,11 @@ module RankedModel
     def ranks *args
       self.rankers ||= []
       ranker = RankedModel::Ranker.new(*args)
+
+      if column_default(ranker)
+        raise NonNilColumnDefault, %Q{Your ranked model column "#{ranker.name}" must not have a default value in the database.}
+      end
+
       self.rankers << ranker
       attr_reader "#{ranker.name}_position"
       define_method "#{ranker.name}_position=" do |position|
@@ -54,9 +61,17 @@ module RankedModel
         end
       end
 
+      define_method "#{ranker.name}_rank" do
+        ranker.with(self).relative_rank
+      end
+
       public "#{ranker.name}_position", "#{ranker.name}_position="
     end
 
+    def column_default ranker
+      column_defaults[ranker.name.to_s] if ActiveRecord::Base.connected? && table_exists?
+    end
+
   end
 
 end

data/lib/ranked-model/ranker.rb

@@ -69,10 +69,20 @@ module RankedModel
           update_all(ranker.column => value)
       end
 
+      def reset_ranks!
+        finder.update_all(ranker.column => nil)
+      end
+
       def position
         instance.send "#{ranker.name}_position"
       end
 
+      def relative_rank
+        escaped_column = instance_class.connection.quote_column_name ranker.column
+
+        finder.where("#{escaped_column} < #{rank}").count(:all)
+      end
+
       def rank
         instance.send "#{ranker.column}"
       end
@@ -171,7 +181,7 @@ module RankedModel
 
       def assure_unique_position
         if ( new_record? || rank_changed? )
-          if (rank > RankedModel::MAX_RANK_VALUE) || current_at_rank(rank)
+          if (rank > RankedModel::MAX_RANK_VALUE) || rank_taken?
             rearrange_ranks
           end
         end
@@ -179,7 +189,7 @@ module RankedModel
 
       def rearrange_ranks
         _scope = finder
-        escaped_column = ActiveRecord::Base.connection.quote_column_name ranker.column
+        escaped_column = instance_class.connection.quote_column_name ranker.column
         # If there is room at the bottom of the list and we're added to the very top of the list...
         if current_first.rank && current_first.rank > RankedModel::MIN_RANK_VALUE && rank == RankedModel::MAX_RANK_VALUE
           # ...then move everyone else down 1 to make room for us at the end
@@ -205,29 +215,35 @@ module RankedModel
       end
 
       def rebalance_ranks
-        if rank
-          origin = current_order.index { |item| item.instance.id == instance.id }
-          destination = current_order.index { |item| rank <= item.rank }
-          destination -= 1 if origin < destination
+        ActiveRecord::Base.transaction do
+          if rank && instance.persisted?
+            origin = current_order.index { |item| item.instance.id == instance.id }
+            if origin
+              destination = current_order.index { |item| rank <= item.rank }
+              destination -= 1 if origin < destination
+
+              current_order.insert destination, current_order.delete_at(origin)
+            end
+          end
 
-          current_order.insert destination, current_order.delete_at(origin)
-        end
+          gaps = current_order.size + 1
+          range = (RankedModel::MAX_RANK_VALUE - RankedModel::MIN_RANK_VALUE).to_f
+          gap_size = (range / gaps).ceil
 
-        gaps = current_order.size + 1
-        range = (RankedModel::MAX_RANK_VALUE - RankedModel::MIN_RANK_VALUE).to_f
-        gap_size = (range / gaps).ceil
+          reset_ranks!
 
-        current_order.each.with_index(1) do |item, position|
-          new_rank = (gap_size * position) + RankedModel::MIN_RANK_VALUE
+          current_order.each.with_index(1) do |item, position|
+            new_rank = (gap_size * position) + RankedModel::MIN_RANK_VALUE
 
-          if item.instance.id == instance.id
-            rank_at new_rank
-          else
-            item.update_rank! new_rank
+            if item.instance.id == instance.id
+              rank_at new_rank
+            else
+              item.update_rank! new_rank
+            end
           end
-        end
 
-        reset_cache
+          reset_cache
+        end
       end
 
       def finder(order = :asc)
@@ -256,7 +272,7 @@ module RankedModel
             _finder = _finder.where.not instance_class.primary_key.to_sym => instance.id
           end
 
-          _finder.order(ranker.column.to_sym => order).select(columns)
+          _finder.reorder(ranker.column.to_sym => order).select(columns)
         end
       end
 
@@ -286,13 +302,8 @@ module RankedModel
         end
       end
 
-      def current_at_rank _rank
-        if (ordered_instance = finder.
-                                 except( :order ).
-                                 where( ranker.column => _rank ).
-                                 first)
-          RankedModel::Ranker::Mapper.new ranker, ordered_instance
-        end
+      def rank_taken?
+        finder.except(:order).where(ranker.column => rank).exists?
       end
 
       def neighbors_at_position _pos

data/lib/ranked-model/version.rb

@@ -1,3 +1,3 @@
 module RankedModel
-  VERSION = "0.4.2"
+  VERSION = "0.4.7"
 end

data/ranked-model.gemspec

@@ -9,11 +9,11 @@ Gem::Specification.new do |s|
   s.authors     = ["Matthew Beale"]
   s.email       = ["matt.beale@madhatted.com"]
   s.homepage    = "https://github.com/mixonic/ranked-model"
-  s.summary     = %q{An acts_as_sortable replacement built for Rails 3 & 4}
-  s.description = %q{ranked-model is a modern row sorting library built for Rails 3 & 4. It uses ARel aggressively and is better optimized than most other libraries.}
+  s.summary     = %q{An acts_as_sortable replacement built for Rails 4.2+}
+  s.description = %q{ranked-model is a modern row sorting library built for Rails 4.2+. It uses ARel aggressively and is better optimized than most other libraries.}
   s.license     = 'MIT'
 
-  s.add_dependency "activerecord", ">= 4.1.16"
+  s.add_dependency "activerecord", ">= 4.2"
   s.add_development_dependency "rspec", "~> 3"
   s.add_development_dependency "rspec-its"
   s.add_development_dependency "mocha"

data/spec/duck-model/column_default_ducks_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe 'ColumnDefaultDuck' do
+
+	it "should raise an error if we try to initialise ranked_model on a column with a default value" do
+		expect {
+			class ColumnDefaultDuck < ActiveRecord::Base
+			  include RankedModel
+			  ranks :size, :with_same => :pond
+			end
+		}.to raise_error(RankedModel::NonNilColumnDefault, 'Your ranked model column "size" must not have a default value in the database.')
+	end
+
+	it "should not raise an error if we don't have a database connection when checking for default value" do
+		begin
+			ActiveRecord::Base.remove_connection
+
+			expect {
+				class ColumnDefaultDuck < ActiveRecord::Base
+				  include RankedModel
+				  ranks :size, :with_same => :pond
+				end
+			}.not_to raise_error
+		ensure
+			ActiveRecord::Base.establish_connection(ENV['DB'].to_sym)
+		end
+	end
+
+end

data/spec/duck-model/duck_spec.rb

@@ -10,12 +10,16 @@ describe Duck do
 
   it { expect(subject).to respond_to(:row_position) }
   it { expect(subject).to respond_to(:row_position=) }
+  it { expect(subject).to respond_to(:row_rank) }
   it { expect(subject).to respond_to(:size_position) }
   it { expect(subject).to respond_to(:size_position=) }
+  it { expect(subject).to respond_to(:size_rank) }
   it { expect(subject).to respond_to(:age_position) }
   it { expect(subject).to respond_to(:age_position=) }
+  it { expect(subject).to respond_to(:age_rank) }
   it { expect(subject).to respond_to(:landing_order_position) }
   it { expect(subject).to respond_to(:landing_order_position=) }
+  it { expect(subject).to respond_to(:landing_order_rank) }
 
 end
 
@@ -44,9 +48,9 @@ describe Duck do
     }
     @ducks.each { |name, duck|
       duck.reload
-      duck.update_attribute :row_position, 0
-      duck.update_attribute :size_position, 0
-      duck.update_attribute :age_position, 0
+      duck.update :row_position => 0
+      duck.update :size_position => 0
+      duck.update :age_position => 0
       duck.save!
     }
     @ducks.each {|name, duck| duck.reload }
@@ -55,8 +59,8 @@ describe Duck do
   describe "sorting by size on in_shin_pond" do
 
     before {
-      @ducks[:quacky].update_attribute :size_position, 0
-      @ducks[:wingy].update_attribute :size_position, 2
+      @ducks[:quacky].update :size_position => 0
+      @ducks[:wingy].update :size_position => 2
     }
 
     subject { Duck.in_shin_pond.rank(:size).to_a }
@@ -72,8 +76,8 @@ describe Duck do
   describe "sorting by age on Shin pond" do
 
     before {
-      @ducks[:feathers].update_attribute :age_position, 0
-      @ducks[:wingy].update_attribute :age_position, 0
+      @ducks[:feathers].update :age_position => 0
+      @ducks[:wingy].update :age_position => 0
     }
 
     subject { Duck.where(:pond => 'Shin').rank(:age).to_a }
@@ -89,10 +93,10 @@ describe Duck do
   describe "sorting by row" do
 
     before {
-      @ducks[:beaky].update_attribute :row_position, 0
-      @ducks[:webby].update_attribute :row_position, 2
-      @ducks[:waddly].update_attribute :row_position, 2
-      @ducks[:wingy].update_attribute :row_position, 6
+      @ducks[:beaky].update :row_position => 0
+      @ducks[:webby].update :row_position => 2
+      @ducks[:waddly].update :row_position => 2
+      @ducks[:wingy].update :row_position => 6
     }
 
     subject { Duck.rank(:row).to_a }
@@ -108,13 +112,13 @@ describe Duck do
   describe "mixed sorting by" do
 
     before {
-      @ducks[:quacky].update_attribute :size_position, 0
-      @ducks[:beaky].update_attribute :row_position, 0
-      @ducks[:webby].update_attribute :row_position, 2
-      @ducks[:wingy].update_attribute :size_position, 1
-      @ducks[:waddly].update_attribute :row_position, 2
-      @ducks[:wingy].update_attribute :row_position, 6
-      @ducks[:webby].update_attribute :row_position, 6
+      @ducks[:quacky].update :size_position => 0
+      @ducks[:beaky].update :row_position => 0
+      @ducks[:webby].update :row_position => 2
+      @ducks[:wingy].update :size_position => 1
+      @ducks[:waddly].update :row_position => 2
+      @ducks[:wingy].update :row_position => 6
+      @ducks[:webby].update :row_position => 6
     }
 
     describe "row" do
@@ -149,7 +153,7 @@ describe Duck do
       # puts Duck.rank(:age).collect {|duck| "#{duck.name} #{duck.age}" }
       duck = Duck.rank(:age)[2]
       expect(->{
-        duck.update_attribute :name, 'New Name'
+        duck.update :name => 'New Name'
       }).to_not change(duck.reload, :age)
       # puts Duck.rank(:age).collect {|duck| "#{duck.name} #{duck.age}" }
     end
@@ -183,7 +187,7 @@ describe Duck do
 
       before {
         @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:wingy].id).collect {|duck| duck.id }
-        @ducks[:wingy].update_attribute :row_position, 2
+        @ducks[:wingy].update :row_position => 2
       }
 
       context {
@@ -210,7 +214,7 @@ describe Duck do
 
       before {
         @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:wingy].id).collect {|duck| duck.id }
-        @ducks[:wingy].update_attribute :row_position, 0
+        @ducks[:wingy].update :row_position => 0
       }
 
       context {
@@ -250,7 +254,7 @@ describe Duck do
 
       context {
 
-        before { @ducks[:wingy].update_attribute :row_position, (@ducks.size - 2) }
+        before { @ducks[:wingy].update :row_position => (@ducks.size - 2) }
 
         subject { Duck.ranker(:row).with(Duck.new).current_at_position(@ducks.size - 2).instance }
 
@@ -260,7 +264,7 @@ describe Duck do
 
       context {
 
-        before { @ducks[:wingy].update_attribute :row_position, :down }
+        before { @ducks[:wingy].update :row_position => :down }
 
         subject { Duck.ranker(:row).with(Duck.new).current_at_position(@ducks.size - 2).instance }
 
@@ -274,7 +278,7 @@ describe Duck do
 
       before {
         @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:wingy].id).collect {|duck| duck.id }
-        @ducks[:wingy].update_attribute :row_position, (@ducks.size - 1)
+        @ducks[:wingy].update :row_position => (@ducks.size - 1)
       }
 
       context {
@@ -315,7 +319,7 @@ describe Duck do
 
       before {
         @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:wingy].id).collect {|duck| duck.id }
-        @ducks[:wingy].update_attribute :row_position, :last
+        @ducks[:wingy].update :row_position => :last
       }
 
       context {
@@ -356,7 +360,7 @@ describe Duck do
 
       before {
         @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:wingy].id).collect {|duck| duck.id }
-        @ducks[:wingy].update_attribute :row_position, 'last'
+        @ducks[:wingy].update :row_position => 'last'
       }
 
       context {
@@ -399,7 +403,7 @@ describe Duck do
 
         before {
           @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:wingy].id).collect { |duck| duck.id }
-          @ducks[:wingy].update_attribute :row_position, :down
+          @ducks[:wingy].update :row_position => :down
         }
 
         context {
@@ -426,7 +430,7 @@ describe Duck do
         
         before {
           @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:quacky].id).collect { |duck| duck.id }
-          @ducks[:quacky].update_attribute :row_position, :down
+          @ducks[:quacky].update :row_position => :down
         }
 
         context {
@@ -451,7 +455,7 @@ describe Duck do
         
         before {
           @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:feathers].id).collect { |duck| duck.id }
-          @ducks[:feathers].update_attribute :row_position, :down
+          @ducks[:feathers].update :row_position => :down
         }
 
         context {
@@ -480,7 +484,7 @@ describe Duck do
 
         before {
           @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:wingy].id).collect { |duck| duck.id }
-          @ducks[:wingy].update_attribute :row_position, 'down'
+          @ducks[:wingy].update :row_position => 'down'
         }
 
         context {
@@ -507,7 +511,7 @@ describe Duck do
         
         before {
           @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:quacky].id).collect { |duck| duck.id }
-          @ducks[:quacky].update_attribute :row_position, 'down'
+          @ducks[:quacky].update :row_position => 'down'
         }
 
         context {
@@ -532,7 +536,7 @@ describe Duck do
         
         before {
           @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:feathers].id).collect { |duck| duck.id }
-          @ducks[:feathers].update_attribute :row_position, 'down'
+          @ducks[:feathers].update :row_position => 'down'
         }
 
         context {
@@ -561,7 +565,7 @@ describe Duck do
 
         before {
           @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:wingy].id).collect { |duck| duck.id }
-          @ducks[:wingy].update_attribute :row_position, :up
+          @ducks[:wingy].update :row_position => :up
         }
 
         context {
@@ -588,7 +592,7 @@ describe Duck do
         
         before {
           @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:beaky].id).collect { |duck| duck.id }
-          @ducks[:beaky].update_attribute :row_position, :up
+          @ducks[:beaky].update :row_position => :up
         }
 
         context {
@@ -613,7 +617,7 @@ describe Duck do
         
         before {
           @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:waddly].id).collect { |duck| duck.id }
-          @ducks[:waddly].update_attribute :row_position, :up
+          @ducks[:waddly].update :row_position => :up
         }
 
         context {
@@ -641,7 +645,7 @@ describe Duck do
             Duck.where(id: @ducks[name].id).update_all(row: i)
             @ducks[name].reload
           end
-          @ducks[:wingy].update_attribute :row_position, :up
+          @ducks[:wingy].update :row_position => :up
         }
 
         context {
@@ -671,7 +675,7 @@ describe Duck do
 
         before {
           @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:wingy].id).collect { |duck| duck.id }
-          @ducks[:wingy].update_attribute :row_position, 'up'
+          @ducks[:wingy].update :row_position => 'up'
         }
 
         context {
@@ -698,7 +702,7 @@ describe Duck do
         
         before {
           @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:beaky].id).collect { |duck| duck.id }
-          @ducks[:beaky].update_attribute :row_position, 'up'
+          @ducks[:beaky].update :row_position => 'up'
         }
 
         context {
@@ -723,7 +727,7 @@ describe Duck do
         
         before {
           @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:waddly].id).collect { |duck| duck.id }
-          @ducks[:waddly].update_attribute :row_position, 'up'
+          @ducks[:waddly].update :row_position => 'up'
         }
 
         context {
@@ -748,6 +752,71 @@ describe Duck do
 
   end
 
+  describe "fetching rank for an instance" do
+    before {
+      [:quacky, :feathers, :wingy, :webby, :waddly, :beaky].each_with_index do |name, i|
+         Duck.where(id: @ducks[name].id).update_all(row: RankedModel::MAX_RANK_VALUE - i)
+         @ducks[name].reload
+      end
+    }
+
+    context {
+      subject { Duck.find_by(id: @ducks[:beaky]).row_rank }
+
+      it { should == 0 }
+    }
+
+    context {
+      subject { Duck.find_by(id: @ducks[:wingy]).row_rank }
+
+      it { should == 3 }
+    }
+
+    context {
+      subject { Duck.find_by(id: @ducks[:quacky]).row_rank }
+
+      it { should == 5 }
+    }
+  end
+
+  describe "when moving between ponds should work when rebalancing" do
+    before do
+      [:feathers, :wingy, :webby, :waddly, :beaky].each_with_index do |name, i|
+        Duck.where(id: @ducks[name].id)
+          .update_all(age: RankedModel::MIN_RANK_VALUE + i, pond: "Boyden")
+      end
+
+      @ducks[:quacky].update!(age_position: 2, pond: "Boyden")
+    end
+
+    it 'rebalances ranks correctly' do
+      expect(@ducks[:feathers].reload.age_rank).to eq 0
+      expect(@ducks[:quacky].reload.age_rank).to eq 2
+      expect(@ducks[:beaky].reload.age_rank).to eq 5
+    end
+
+    context 'when attempting to update position to a non-unique value' do
+      before do
+        @duck_one = Duck.create(landing_order: RankedModel::MIN_RANK_VALUE,
+                               lake_id: 42, flock_id: 42)
+        # Duck one's landing order will be rebalanced to -715_827_883.
+        # Given a unique index on [:landing_order, :lake_id, :flock_id] we
+        # verify that the operation succeeds despite the value already being
+        # occupied by duck two.
+        @duck_two = Duck.create(landing_order: -715_827_883,
+                                lake_id: 42, flock_id: 42)
+      end
+
+      it 'rebalances ranks correctly' do
+        @ducks[:quacky].update!(landing_order_position: :first,
+                                lake_id: 42, flock_id: 42)
+        expect(@ducks[:quacky].reload.landing_order_rank).to eq 0
+        expect(@duck_one.reload.landing_order_rank).to eq 1
+        expect(@duck_two.reload.landing_order_rank).to eq 2
+      end
+    end
+  end
+
 end
 
 describe Duck do
@@ -781,7 +850,7 @@ describe Duck do
     }
     @ducks.each { |name, duck|
       duck.reload
-      duck.update_attribute :landing_order_position, 0
+      duck.update :landing_order_position => 0
       duck.save!
     }
     @ducks.each {|name, duck| duck.reload }
@@ -790,8 +859,8 @@ describe Duck do
   describe "sorting by landing_order" do
 
     before {
-      @ducks[:quacky].update_attribute :landing_order_position, 0
-      @ducks[:wingy].update_attribute :landing_order_position, 1
+      @ducks[:quacky].update :landing_order_position => 0
+      @ducks[:wingy].update :landing_order_position => 1
     }
 
     subject { Duck.in_lake_and_flock(0,0).rank(:landing_order).to_a }
@@ -815,10 +884,10 @@ describe Duck do
 
       @previous_ranks = @untouchable_ranks.call
 
-      @ducks[:quacky].update_attribute :landing_order_position, 0
-      @ducks[:wingy].update_attribute :landing_order_position, 1
-      @ducks[:feathers].update_attribute :landing_order_position, 0
-      @ducks[:wingy].update_attribute :landing_order_position, 1
+      @ducks[:quacky].update :landing_order_position => 0
+      @ducks[:wingy].update :landing_order_position => 1
+      @ducks[:feathers].update :landing_order_position => 0
+      @ducks[:wingy].update :landing_order_position => 1
     }
 
     subject { @untouchable_ranks.call }