ranked-model 0.4.0 → 0.4.7

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,23 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0"
+
+group :sqlite do
+  gem "sqlite3", "~> 1.3.13", platform: :ruby
+  gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.24", platform: :jruby
+end
+
+group :postgresql do
+  gem "pg", "~> 0.18.4", platform: :ruby
+  gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.24", platform: :jruby
+end
+
+group :mysql do
+  gem "mysql2", "~> 0.4.0", platform: :ruby
+  gem "jdbc-mysql", "~> 5.1.47", platform: :jruby
+  gem "activerecord-jdbcmysql-adapter", "~> 1.3.24", platform: :jruby
+end
+
+gemspec path: "../"

data/gemfiles/rails_5_0.gemfile

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

data/gemfiles/rails_5_1.gemfile

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

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,22 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+
+group :sqlite do
+  gem "sqlite3", "~> 1.3.13", platform: :ruby
+  gem "activerecord-jdbcsqlite3-adapter", "~> 52.0", platform: :jruby
+end
+
+group :postgresql do
+  gem "pg", "~> 1.2.0", platform: :ruby
+  gem "activerecord-jdbcpostgresql-adapter", "~> 52.0", platform: :jruby
+end
+
+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,10 +3,12 @@ require File.dirname(__FILE__)+'/ranked-model/railtie' if defined?(Rails::Railti
 
 module RankedModel
 
-  # Signed MEDIUMINT in MySQL
+  class NonNilColumnDefault < StandardError; end
+
+  # Signed INT in MySQL
   #
-  MAX_RANK_VALUE = 8388607
-  MIN_RANK_VALUE = -8388607
+  MAX_RANK_VALUE = 2147483647
+  MIN_RANK_VALUE = -2147483648
 
   def self.included base
 
@@ -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
 
@@ -40,11 +42,16 @@ module RankedModel
       end
     end
 
-  private
+    private
 
     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

@@ -40,11 +40,11 @@ module RankedModel
                 when Symbol
                   !instance.respond_to?(ranker.with_same)
                 when Array
-                  ranker.with_same.detect {|attr| !instance.respond_to?(attr) }
+                  array_element = ranker.with_same.detect {|attr| !instance.respond_to?(attr) }
                 else
                   false
               end)
-            raise RankedModel::InvalidField, %Q{No field called "#{ranker.with_same}" found in model}
+            raise RankedModel::InvalidField, %Q{No field called "#{array_element || ranker.with_same}" found in model}
           end
         end
       end
@@ -66,13 +66,23 @@ module RankedModel
         #
         instance_class.
           where(instance_class.primary_key => instance.id).
-          update_all([%Q{#{ranker.column} = ?}, value])
+          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
@@ -89,6 +99,10 @@ module RankedModel
 
     private
 
+      def reset_cache
+        @finder, @current_order, @current_first, @current_last = nil
+      end
+
       def instance_class
         ranker.class_name.nil? ? instance.class : ranker.class_name.constantize
       end
@@ -114,31 +128,31 @@ module RankedModel
         case position
           when :first, 'first'
             if current_first && current_first.rank
-              rank_at( ( ( RankedModel::MIN_RANK_VALUE - current_first.rank ).to_f / 2 ).ceil + current_first.rank)
+              rank_at_average current_first.rank, RankedModel::MIN_RANK_VALUE
             else
               position_at :middle
             end
           when :last, 'last'
             if current_last && current_last.rank
-              rank_at( ( ( RankedModel::MAX_RANK_VALUE - current_last.rank ).to_f / 2 ).ceil + current_last.rank )
+              rank_at_average current_last.rank, RankedModel::MAX_RANK_VALUE
             else
               position_at :middle
             end
           when :middle, 'middle'
-            rank_at( ( ( RankedModel::MAX_RANK_VALUE - RankedModel::MIN_RANK_VALUE ).to_f / 2 ).ceil + RankedModel::MIN_RANK_VALUE )
+            rank_at_average RankedModel::MIN_RANK_VALUE, RankedModel::MAX_RANK_VALUE
           when :down, 'down'
             neighbors = find_next_two(rank)
             if neighbors[:lower]
               min = neighbors[:lower].rank
               max = neighbors[:upper] ? neighbors[:upper].rank : RankedModel::MAX_RANK_VALUE
-              rank_at( ( ( max - min ).to_f / 2 ).ceil + min )
+              rank_at_average min, max
             end
           when :up, 'up'
             neighbors = find_previous_two(rank)
             if neighbors[:upper]
               max = neighbors[:upper].rank
               min = neighbors[:lower] ? neighbors[:lower].rank : RankedModel::MIN_RANK_VALUE
-              rank_at( ( ( max - min ).to_f / 2 ).ceil + min )
+              rank_at_average min, max
             end
           when String
             position_at position.to_i
@@ -148,7 +162,7 @@ module RankedModel
             neighbors = neighbors_at_position(position)
             min = ((neighbors[:lower] && neighbors[:lower].has_rank?) ? neighbors[:lower].rank : RankedModel::MIN_RANK_VALUE)
             max = ((neighbors[:upper] && neighbors[:upper].has_rank?) ? neighbors[:upper].rank : RankedModel::MAX_RANK_VALUE)
-            rank_at( ( ( max - min ).to_f / 2 ).ceil + min )
+            rank_at_average min, max
           when NilClass
             if !rank
               position_at :last
@@ -156,13 +170,18 @@ module RankedModel
         end
       end
 
+      def rank_at_average(min, max)
+        if (max - min).between?(-1, 1) # No room at the inn...
+          rebalance_ranks
+          position_at position
+        else
+          rank_at( ( ( max - min ).to_f / 2 ).ceil + min )
+        end
+      end
+
       def assure_unique_position
         if ( new_record? || rank_changed? )
-          unless rank
-            rank_at( RankedModel::MAX_RANK_VALUE )
-          end
-
-          if (rank > RankedModel::MAX_RANK_VALUE) || current_at_rank(rank)
+          if (rank > RankedModel::MAX_RANK_VALUE) || rank_taken?
             rearrange_ranks
           end
         end
@@ -170,22 +189,25 @@ module RankedModel
 
       def rearrange_ranks
         _scope = finder
-        unless instance.id.nil?
-          # Never update ourself, shift others around us.
-          _scope = _scope.where( instance_class.arel_table[instance_class.primary_key].not_eq(instance.id) )
-        end
+        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
           _scope.
             where( instance_class.arel_table[ranker.column].lteq(rank) ).
-            update_all( %Q{#{ranker.column} = #{ranker.column} - 1} )
+            update_all( "#{escaped_column} = #{escaped_column} - 1" )
+        # If there is room at the top of the list and we're added below the last value in the list...
         elsif current_last.rank && current_last.rank < (RankedModel::MAX_RANK_VALUE - 1) && rank < current_last.rank
+          # ...then move everyone else at or above our desired rank up 1 to make room for us
           _scope.
             where( instance_class.arel_table[ranker.column].gteq(rank) ).
-            update_all( %Q{#{ranker.column} = #{ranker.column} + 1} )
+            update_all( "#{escaped_column} = #{escaped_column} + 1" )
+        # If there is room at the bottom of the list and we're added above the lowest value in the list...
         elsif current_first.rank && current_first.rank > RankedModel::MIN_RANK_VALUE && rank > current_first.rank
+          # ...then move everyone else below us down 1 and change our rank down 1 to avoid the collission
           _scope.
             where( instance_class.arel_table[ranker.column].lt(rank) ).
-            update_all( %Q{#{ranker.column} = #{ranker.column} - 1} )
+            update_all( "#{escaped_column} = #{escaped_column} - 1" )
           rank_at( rank - 1 )
         else
           rebalance_ranks
@@ -193,66 +215,70 @@ module RankedModel
       end
 
       def rebalance_ranks
-        total = current_order.size + 2
-        has_set_self = false
-        total.times do |index|
-          next if index == 0 || index == total
-          rank_value = ((((RankedModel::MAX_RANK_VALUE - RankedModel::MIN_RANK_VALUE).to_f / total) * index ).ceil + RankedModel::MIN_RANK_VALUE)
-          index = index - 1
-          if has_set_self
-            index = index - 1
-          else
-            if !current_order[index] ||
-               ( !current_order[index].rank.nil? &&
-                 current_order[index].rank >= rank )
-              rank_at rank_value
-              has_set_self = true
-              next
+        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[index].update_rank! rank_value
+
+          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
+
+            if item.instance.id == instance.id
+              rank_at new_rank
+            else
+              item.update_rank! new_rank
+            end
+          end
+
+          reset_cache
         end
       end
 
       def finder(order = :asc)
-        @finder ||= begin
+        @finder ||= {}
+        @finder[order] ||= begin
           _finder = instance_class
-          columns = [instance_class.arel_table[instance_class.primary_key], instance_class.arel_table[ranker.column]]
+          columns = [instance_class.primary_key.to_sym, ranker.column]
+
           if ranker.scope
             _finder = _finder.send ranker.scope
           end
+
           case ranker.with_same
-            when Symbol
-              columns << instance_class.arel_table[ranker.with_same]
-              _finder = _finder.where \
-                instance_class.arel_table[ranker.with_same].eq(instance.attributes["#{ranker.with_same}"])
-            when Array
-              ranker.with_same.each {|c| columns.push instance_class.arel_table[c] }
-              _finder = _finder.where(
-                ranker.with_same[1..-1].inject(
-                  instance_class.arel_table[ranker.with_same.first].eq(
-                    instance.attributes["#{ranker.with_same.first}"]
-                  )
-                ) {|scoper, attr|
-                  scoper.and(
-                    instance_class.arel_table[attr].eq(
-                      instance.attributes["#{attr}"]
-                    )
-                  )
-                }
-              )
-          end
-          if !new_record?
+          when Symbol
+            columns << ranker.with_same
             _finder = _finder.where \
-              instance_class.arel_table[instance_class.primary_key].not_eq(instance.id)
+              ranker.with_same => instance.attributes[ranker.with_same.to_s]
+          when Array
+            ranker.with_same.each do |column|
+              columns << column
+              _finder = _finder.where column => instance.attributes[column.to_s]
+            end
+          end
+
+          unless new_record?
+            _finder = _finder.where.not instance_class.primary_key.to_sym => instance.id
           end
-          _finder.order(instance_class.arel_table[ranker.column].send(order)).select(columns)
+
+          _finder.reorder(ranker.column.to_sym => order).select(columns)
         end
       end
 
       def current_order
         @current_order ||= begin
-          finder.collect { |ordered_instance|
+          finder.unscope(where: instance_class.primary_key.to_sym).collect { |ordered_instance|
             RankedModel::Ranker::Mapper.new ranker, ordered_instance
           }
         end
@@ -276,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