ranked-model 0.4.2 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5cfad22b2acf05bc3deda080d1bb11b96ade3c9d
-  data.tar.gz: cd2d02de24cf6465ee4211818beb6696ec41e616
+SHA256:
+  metadata.gz: 8dac9a4acefc5a44cfe74e77931854bb8edd031cc986f3bc0bd8232f543dc0f9
+  data.tar.gz: 9bd6120114a23ef47ae08581b860cd0cb4fa18779fb237b9b9570d94a889cc75
 SHA512:
-  metadata.gz: fd1dbb2069c730aeda634d15cc4cd5a5fa0be8def4cca8db3b6bb320e40ef97f29f88bac16f2ba12720a1287cbb06ae3188e7862f5586599757fc2c56f6d3e6e
-  data.tar.gz: b5f0896c2a4979b3f8d157bc20f3ee1bc7846ea6ef2ffb3432b50d5696e0852f803026bea3d0177c8db22b949c3d8c89022582b4c79da84c8ff8fc4a2611d3a6
+  metadata.gz: dc8d0ad9348de7596934a2eab69da78228c3351bd4d16303eae592b3893ecfedc28ff4620997977e8a88dc9d26dc27999c99e6e2abddc7ab6fe1f24aeb108527
+  data.tar.gz: 03a77db0fc8e9f59b4ffaccf24c966a54125141ab07a931046387e30cf62b7bf0577d9d983d268322dc69a7004c68c001168083d428cffff118832085afe3d21

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,51 @@
-sudo: false # use newer travis infrastructure
 language: ruby
 cache: bundler
 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.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - 3.0
   - 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
+    # Rails <6 does not support Ruby 3, see:
+    # https://github.com/rails/rails/issues/40938#issuecomment-751898275
+    - rvm: 3.0
+      gemfile: gemfiles/rails_4_2.gemfile
+    - rvm: 3.0
       gemfile: gemfiles/rails_5_0.gemfile
-    - rvm: 1.9.3
+    - rvm: 3.0
       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
+    - rvm: 3.0
       gemfile: gemfiles/rails_5_2.gemfile
+    # Ruby ≥2.7 uses a `bigdecimal` version that doesn't support BigDecimal.new
+    # that Rails 4.2 uses. See also:
+    # https://github.com/ruby/bigdecimal#which-version-should-you-select
+    - rvm: 2.7
+      gemfile: gemfiles/rails_4_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
+    - rvm: 2.4
+      gemfile: gemfiles/rails_6_0.gemfile
+    - rvm: jruby-9.1.17.0
+      gemfile: gemfiles/rails_6_0.gemfile

data/Appraisals

@@ -1,81 +1,72 @@
-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 "jdbc-mysql", "~> 5.1.47", platform: :jruby
     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.2.0", platform: :ruby
+end
+
+group :mysql do
+  gem "mysql2", "~> 0.5.0", platform: :ruby
+end

data/Readme.mkd

@@ -1,13 +1,11 @@
-**ranked-model** is a modern row sorting library built for Rails 3, 4 and 5.  It uses ARel aggressively and is better optimized than most other libraries.
+**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.
 
 [![Build Status](https://travis-ci.org/mixonic/ranked-model.png)](https://travis-ci.org/mixonic/ranked-model)
 
 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.
-
-TL;DR, if you are using Rails 4 and up you are 100% good to go. Before Rails 4, be wary of Postgres.
+ranked-model passes specs with Rails 4.2, 5.0, 5.1, 5.2 and 6.0 for MySQL, Postgres, and SQLite on Ruby 2.4 through 3.0 (with exceptions, please check the CI setup for supported combinations), and jruby-9.1.17.0 where Rails supports the platform.
 
 To install ranked-model, just add it to your `Gemfile`:
 
@@ -16,7 +14,7 @@ gem 'ranked-model'
 
 # Or pin ranked-model to git
 # gem 'ranked-model',
-#   :git => 'git@github.com:mixonic/ranked-model.git'
+#   git: 'git@github.com:mixonic/ranked-model.git'
 ```
 
 Then use `bundle install` to update your `Gemfile.lock`.
@@ -31,6 +29,18 @@ class Duck < ActiveRecord::Base
 end
 ```
 
+Give them an order (integer column):
+
+```bash
+rails g migration AddRowOrderToDucks row_order:integer
+rails db:migrate
+```
+
+**IMPORTANT: The `_order` table column MUST allow null values. For the reason behind this requirement see [issue#167](https://github.com/mixonic/ranked-model/issues/167)**
+
+
+
+
 Put your ducks in a row:
 
 ``` ruby
@@ -42,7 +52,7 @@ class Duck < ActiveRecord::Base
 end
 ```
 
-This simple example assumes an integer column called `row_order`.  To order Ducks by this order:
+Order the Ducks by this order:
 
 ``` ruby
 Duck.rank(:row_order).all
@@ -52,7 +62,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 +82,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
 -----------
 
@@ -83,19 +102,27 @@ class Duck < ActiveRecord::Base
   include RankedModel
 
   ranks :row_order,                  # Name this ranker, used with rank()
-    :column => :sort_order           # Override the default column, which defaults to the name
+    column: :sort_order              # Override the default column, which defaults to the name
 
   belongs_to :pond
   ranks :swimming_order,
-    :with_same => :pond_id           # Ducks belong_to Ponds, make the ranker scoped to one pond
+    with_same: :pond_id              # Ducks belong_to Ponds, make the ranker scoped to one pond
 
   ranks :row_order,
-    :with_same => [:pond_id, :breed] # Lets rank them by breed
+    with_same: [:pond_id, :breed]    # Lets rank them by breed
 
-  scope :walking, where(:walking => true )
+  scope :walking, where(walking: true )
   ranks :walking_order,
-    :scope => :walking               # Narrow this ranker to a scope
+    scope: :walking                  # Narrow this ranker to a scope
+
+  belongs_to :parent, class_name: 'Duck', optional: true
+  ranks :child_order,
+    unless: :has_no_parent?,         # Rank only ducks that have a parent. Alternatively a Proc or lambda can be passed, e.g. proc { parent.nil? }
+    with_same: :parent_id
 
+  def has_no_parent?
+    parent.nil?
+  end
 end
 ```
 
@@ -163,6 +190,35 @@ truck.row_order
 => 4194304
 ```
 
+Migrations for existing data
+----------------------------
+
+If you use `ranked_model` with existing data, the following migration (for Rails
+6) can be a starting point. Make sure to declare `include RankedModel` and
+`ranks :row_order` in your `Duck` before running the migration.
+
+```bash
+rails g migration AddRowOrderToDucks row_order:integer
+```
+
+Then, adjust the migration:
+```ruby
+# e.g. file db/migrate/20200325095038_add_row_order_to_ducks.rb
+class AddRowOrderToDucks < ActiveRecord::Migration[6.0]
+  def change
+    add_column :ducks, :row_order, :integer
+
+    # Newest Duck shall rank "highest"" (be last).
+    Duck.update_all('row_order = EXTRACT(EPOCH FROM created_at)')
+
+    # Alternatively, implement any other sorting default
+    # Duck.order(created_at: :desc).desc.each do |duck|
+    #   duck.update!(row_order: duck.created_at.to_i + duck.age / 2)
+    # end
+  end
+end
+```
+
 Internals
 ---------
 
@@ -180,6 +236,8 @@ Contributing
 
 Fork, clone, write a test, write some code, commit, push, send a pull request.  Github FTW!
 
+The code is published under the [MIT License](LICENSE).
+
 The specs can be run with sqlite, postgres, and mysql:
 
 ```

data/gemfiles/rails_4_2.gemfile

@@ -2,21 +2,22 @@
 
 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 "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

@@ -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.2.0", 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.2.0", 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: "../"