ranked-model 0.4.2 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5cfad22b2acf05bc3deda080d1bb11b96ade3c9d
-  data.tar.gz: cd2d02de24cf6465ee4211818beb6696ec41e616
+SHA256:
+  metadata.gz: c342543b3341c81d62ceca340fc0966a3386a6115fc2ee36f309582995f8af52
+  data.tar.gz: 25408af509201219ce0539dbfe3324c8b3806bce367d3e00b80a2f15dc6e7dc4
 SHA512:
-  metadata.gz: fd1dbb2069c730aeda634d15cc4cd5a5fa0be8def4cca8db3b6bb320e40ef97f29f88bac16f2ba12720a1287cbb06ae3188e7862f5586599757fc2c56f6d3e6e
-  data.tar.gz: b5f0896c2a4979b3f8d157bc20f3ee1bc7846ea6ef2ffb3432b50d5696e0852f803026bea3d0177c8db22b949c3d8c89022582b4c79da84c8ff8fc4a2611d3a6
+  metadata.gz: 139bcf7c985b68e017e03bb3718a4377ec878ec7b249ac32ad20900d1467e5026a093e82725f8e39e1d8a378a7db0959f6a37f7571d1bccae40e9b8f70244a55
+  data.tar.gz: ca739746fb067e6de9ae52bcb08f352fcdf676a02063e04f5d3b5f3b8a54d773ff57227d5dc5fca7c6d402155920b3da39c73d83d495680ff988f67248fac321

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 
 Gemfile.lock
 *.gemfile.lock
+.ruby-version

data/.rspec

@@ -1,2 +1,3 @@
 --color
+--warnings
 --format documentation

data/.travis.yml

@@ -1,47 +1,35 @@
-sudo: false # use newer travis infrastructure
 language: ruby
 cache: bundler
+sudo: false
 before_install:
-  - gem install bundler -v 1.16.1
+  - gem update --system
+  - gem install bundler
 before_script:
   - mysql -e 'create database ranked_model_test;'
   - psql -c 'create database ranked_model_test;' -U postgres
 rvm:
-  - 1.9.3
-  - 2.1.10
-  - 2.2.10
-  - 2.3.7
   - 2.4.4
   - 2.5.1
+  - 2.6.4
   - jruby-9.1.17.0
-  - rbx-3.107
 env:
   - DB=sqlite
   - DB=mysql
   - DB=postgresql
+services:
+  - mysql
+  - postgresql
 gemfile:
-  - gemfiles/rails_4_1.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
 matrix:
   exclude:
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: 1.9.3
-      gemfile: gemfiles/rails_5_2.gemfile
-    - rvm: 2.1.10
-      gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: 2.1.10
-      gemfile: gemfiles/rails_5_1.gemfile
-    - rvm: 2.1.10
-      gemfile: gemfiles/rails_5_2.gemfile
     - rvm: jruby-9.1.17.0
       gemfile: gemfiles/rails_5_2.gemfile
     - rvm: 2.4.4
-      gemfile: gemfiles/rails_4_1.gemfile
-    - rvm: 2.5.1
-      gemfile: gemfiles/rails_4_1.gemfile
+      gemfile: gemfiles/rails_6_0.gemfile
+    - rvm: jruby-9.1.17.0
+      gemfile: gemfiles/rails_6_0.gemfile

data/Appraisals

@@ -1,81 +1,71 @@
-appraise "rails-4-1" do
+appraise "rails-4-2" do
   group :sqlite do
-    gem "sqlite3", platform: :ruby
     gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.24", platform: :jruby
   end
   group :mysql do
-    gem "mysql2", "~> 0.3.21", platform: :ruby
+    gem "mysql2", "~> 0.4.0", platform: :ruby
     gem "activerecord-jdbcmysql-adapter", "~> 1.3.24", platform: :jruby
   end
   group :postgresql do
-    gem "pg", "~> 0.18.0", platform: :ruby
+    gem "pg", "~> 0.18.4", platform: :ruby
     gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.24", platform: :jruby
   end
 
-  gem "activerecord", "~> 4.1.16"
+  gem "activerecord", "~> 4.2.0"
 end
 
-appraise "rails-4-2" do
+appraise "rails-5-0" do
   group :sqlite do
-    gem "sqlite3", platform: :ruby
-    gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.24", platform: :jruby
+    gem "activerecord-jdbcsqlite3-adapter", "~> 50.0", platform: :jruby
   end
   group :mysql do
-    gem "mysql2", "~> 0.4.10", platform: :ruby
-    gem "activerecord-jdbcmysql-adapter", "~> 1.3.24", platform: :jruby
+    gem "activerecord-jdbcmysql-adapter", "~> 50.0", platform: :jruby
   end
   group :postgresql do
-    gem "pg", "~> 0.18.0", platform: :ruby
-    gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.24", platform: :jruby
+    gem "activerecord-jdbcpostgresql-adapter", "~> 50.0", platform: :jruby
   end
 
-  gem "activerecord", "~> 4.2.10"
+  gem "activerecord", "~> 5.0.0"
 end
 
-appraise "rails-5-0" do
+appraise "rails-5-1" do
   group :sqlite do
-    gem "sqlite3", platform: :ruby
-    gem "activerecord-jdbcsqlite3-adapter", "~> 50.1", platform: :jruby
+    gem "activerecord-jdbcsqlite3-adapter", "~> 51.0", platform: :jruby
   end
   group :mysql do
-    gem "mysql2", "~> 0.4.10", platform: :ruby
-    gem "activerecord-jdbcmysql-adapter", "~> 50.1", platform: :jruby
+    gem "activerecord-jdbcmysql-adapter", "~> 51.0", platform: :jruby
   end
   group :postgresql do
-    gem "pg", "~> 0.21.0", platform: :ruby
-    gem "activerecord-jdbcpostgresql-adapter", "~> 50.1", platform: :jruby
+    gem "activerecord-jdbcpostgresql-adapter", "~> 51.0", platform: :jruby
   end
 
-  gem "activerecord", "~> 5.0.7"
+  gem "activerecord", "~> 5.1.0"
 end
 
-appraise "rails-5-1" do
+appraise "rails-5-2" do
   group :sqlite do
-    gem "sqlite3", platform: :ruby
-    gem "activerecord-jdbcsqlite3-adapter", "~> 51.1", platform: :jruby
+    gem "activerecord-jdbcsqlite3-adapter", "~> 52.0", platform: :jruby
   end
   group :mysql do
-    gem "mysql2", "~> 0.4.10", platform: :ruby
-    gem "activerecord-jdbcmysql-adapter", "~> 51.1", platform: :jruby
+    gem "activerecord-jdbcmysql-adapter", "~> 52.0", platform: :jruby
   end
   group :postgresql do
-    gem "pg", "~> 0.21.0", platform: :ruby
-    gem "activerecord-jdbcpostgresql-adapter", "~> 51.1", platform: :jruby
+    gem "activerecord-jdbcpostgresql-adapter", "~> 52.0", platform: :jruby
   end
 
-  gem "activerecord", "~> 5.1.6"
+  gem "activerecord", "~> 5.2.0"
 end
 
-appraise "rails-5-2" do
+appraise "rails-6-0" do
   group :sqlite do
-    gem "sqlite3", platform: :ruby
+    gem "sqlite3", "~> 1.4", platform: :ruby
+    gem "activerecord-jdbcsqlite3-adapter", "~> 60.0", platform: :jruby
   end
   group :mysql do
-    gem "mysql2", "~> 0.4.10", platform: :ruby
+    gem "activerecord-jdbcmysql-adapter", "~> 60.0", platform: :jruby
   end
   group :postgresql do
-    gem "pg", "~> 0.21.0", platform: :ruby
+    gem "activerecord-jdbcpostgresql-adapter", "~> 60.0", platform: :jruby
   end
-
-  gem "activerecord", "~> 5.2.0"
-end
+  gem "activerecord", "~> 6.0.0"
+end

data/Gemfile

@@ -2,3 +2,15 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in ranked-model.gemspec
 gemspec
+
+group :sqlite do
+  gem "sqlite3", "~> 1.3.13", platform: :ruby
+end
+
+group :postgresql do
+  gem "pg", "~> 1.1.4", platform: :ruby
+end
+
+group :mysql do
+  gem "mysql2", "~> 0.5.0", platform: :ruby
+end

data/Readme.mkd

@@ -5,7 +5,7 @@
 Installation
 ------------
 
-ranked-model passes specs with Rails 4.1, 4.2, 5.0, 5.1 and 5.2 for MySQL, Postgres, and SQLite on Ruby 1.9.3, 2.1 through 2.5, jruby-9.1.17.0, and rbx-3.107 where Rails supports the platform. This is with the exception of Postgres before Rails 4.0 on all platforms, which is unsupported by `ranked-model`. Note that the `pg` gem has pulled support for rbx (Rubinius) from version 1 onward.
+ranked-model passes specs with Rails 4.2, 5.0, 5.1, 5.2, 6.0 for MySQL, Postgres, and SQLite on Ruby 2.4 through 2.6, and jruby-9.1.17.0 where Rails supports the platform. This is with the exception of Postgres before Rails 4.0 on all platforms, which is unsupported by `ranked-model`. Note that the `pg` gem has pulled support for rbx (Rubinius) from version 1 onward.
 
 TL;DR, if you are using Rails 4 and up you are 100% good to go. Before Rails 4, be wary of Postgres.
 
@@ -52,7 +52,7 @@ The ranking integers stored in the `row_order` column will be big and spaced apa
 implement a sorting UI, just update the resource by appending the column name with `_position` and indicating the desired position:
 
 ``` ruby
-@duck.update_attribute :row_order_position, 0  # or 1, 2, 37. :first, :last, :up and :down are also valid
+@duck.update :row_order_position => 0  # or 1, 2, 37. :first, :last, :up and :down are also valid
 ```
 
 **IMPORTANT: Note that you MUST append _position to the column name when setting a new position on an instance. This is a fake column that can take relative as well as absolute index-based values for position.**
@@ -72,6 +72,15 @@ $.ajax({
 });
 ```
 
+If you need to find the rank of an item with respect to other ranked items, you can use the `{column_name}_rank` method on the model instance. `{column_name}` is your resource ranking column.
+
+Following on from our examples above, the `row_order_rank` method will return the position of the duck object in the list with respect to the order defined by the row_order column.
+
+``` ruby
+Duck.rank(:row_order).first.row_order_rank # => 0
+Duck.rank(:row_order).third.row_order_rank # => 2
+```
+
 Complex Use
 -----------
 

data/gemfiles/rails_4_2.gemfile

@@ -2,21 +2,21 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 4.2.10"
+gem "activerecord", "~> 4.2.0"
 
 group :sqlite do
-  gem "sqlite3", platform: :ruby
+  gem "sqlite3", "~> 1.3.13", platform: :ruby
   gem "activerecord-jdbcsqlite3-adapter", "~> 1.3.24", platform: :jruby
 end
 
-group :mysql do
-  gem "mysql2", "~> 0.4.10", platform: :ruby
-  gem "activerecord-jdbcmysql-adapter", "~> 1.3.24", platform: :jruby
-end
-
 group :postgresql do
-  gem "pg", "~> 0.18.0", platform: :ruby
+  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 "activerecord-jdbcmysql-adapter", "~> 1.3.24", platform: :jruby
+end
+
 gemspec path: "../"

data/gemfiles/rails_5_0.gemfile

@@ -2,21 +2,21 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 5.0.7"
+gem "activerecord", "~> 5.0.0"
 
 group :sqlite do
-  gem "sqlite3", platform: :ruby
-  gem "activerecord-jdbcsqlite3-adapter", "~> 50.1", platform: :jruby
+  gem "sqlite3", "~> 1.3.13", platform: :ruby
+  gem "activerecord-jdbcsqlite3-adapter", "~> 50.0", platform: :jruby
 end
 
-group :mysql do
-  gem "mysql2", "~> 0.4.10", platform: :ruby
-  gem "activerecord-jdbcmysql-adapter", "~> 50.1", platform: :jruby
+group :postgresql do
+  gem "pg", "~> 1.1.4", platform: :ruby
+  gem "activerecord-jdbcpostgresql-adapter", "~> 50.0", platform: :jruby
 end
 
-group :postgresql do
-  gem "pg", "~> 0.21.0", platform: :ruby
-  gem "activerecord-jdbcpostgresql-adapter", "~> 50.1", platform: :jruby
+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

@@ -2,21 +2,21 @@
 
 source "https://rubygems.org"
 
-gem "activerecord", "~> 5.1.6"
+gem "activerecord", "~> 5.1.0"
 
 group :sqlite do
-  gem "sqlite3", platform: :ruby
-  gem "activerecord-jdbcsqlite3-adapter", "~> 51.1", platform: :jruby
+  gem "sqlite3", "~> 1.3.13", platform: :ruby
+  gem "activerecord-jdbcsqlite3-adapter", "~> 51.0", platform: :jruby
 end
 
-group :mysql do
-  gem "mysql2", "~> 0.4.10", platform: :ruby
-  gem "activerecord-jdbcmysql-adapter", "~> 51.1", platform: :jruby
+group :postgresql do
+  gem "pg", "~> 1.1.4", platform: :ruby
+  gem "activerecord-jdbcpostgresql-adapter", "~> 51.0", platform: :jruby
 end
 
-group :postgresql do
-  gem "pg", "~> 0.21.0", platform: :ruby
-  gem "activerecord-jdbcpostgresql-adapter", "~> 51.1", platform: :jruby
+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

@@ -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.1.4", 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.1.4", 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/ranker.rb

@@ -73,6 +73,10 @@ module RankedModel
         instance.send "#{ranker.name}_position"
       end
 
+      def relative_rank
+        finder.where("#{ranker.column} < #{rank}").count(:all)
+      end
+
       def rank
         instance.send "#{ranker.column}"
       end
@@ -171,7 +175,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
@@ -205,12 +209,14 @@ module RankedModel
       end
 
       def rebalance_ranks
-        if rank
+        if rank && instance.persisted?
           origin = current_order.index { |item| item.instance.id == instance.id }
-          destination = current_order.index { |item| rank <= item.rank }
-          destination -= 1 if origin < destination
+          if origin
+            destination = current_order.index { |item| rank <= item.rank }
+            destination -= 1 if origin < destination
 
-          current_order.insert destination, current_order.delete_at(origin)
+            current_order.insert destination, current_order.delete_at(origin)
+          end
         end
 
         gaps = current_order.size + 1
@@ -256,7 +262,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 +292,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.5"
 end

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/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