ranked-model 0.4.8 → 0.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '004680e8b292451d304375f3ae01d0100702db74867d93b2a713e7c908241d78'
-  data.tar.gz: cc831e2837ba8ad07c21f6b890959e071005824a4f53bd51c135c8055fb1904f
+  metadata.gz: c219aee4691eca3a788bd590e056349623685e2dac26405247eccc807b3b580b
+  data.tar.gz: 7d50bd015aa1f38ead1a4a4c795d3fc3f5f7ad101e416f37c66415d50251e010
 SHA512:
-  metadata.gz: d4494e9eede725ef30ecbd05006a4d91deb89f62aced56b96fa3be2f0f5732f41336d5a3d1c450e3f5d2c0f1821a15de096a1ee68732d8cb5d10a300008270ca
-  data.tar.gz: 04fa0d21ff8b2c6533ebc6705cc00c7258bd955c88a91636995d362136de9cf2a57c6e8ca49c43e112757e1209dc9a9fe3c2285b2bfde47639bcab90d2368fd4
+  metadata.gz: 75a9f1e64091a37289aa2c3f6f35bd30be059237121e8f00af61196be089de2df645304854fb9a80bd1fc1de91d6014e741839b91714cc70ab9e7562e6367451
+  data.tar.gz: f8a6ac22945db1b7c609c776db78445f3dd60c550e7b421b4530c974af51fb4e0040375c676f72c7920240cff143b8ac236ec258f7c76f5cdbd418748e493243

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+github: [brendon]

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yml

@@ -0,0 +1,107 @@
+---
+name: CI
+on: [push, pull_request]
+
+jobs:
+  tests:
+    name: Ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}, DB ${{ matrix.db }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - 2.5
+          - 2.6
+          - 2.7
+          - '3.0'
+          - 3.1
+          - 3.2
+          - 3.3
+        gemfile:
+          - gemfiles/rails_5_2.gemfile
+          - gemfiles/rails_6_0.gemfile
+          - gemfiles/rails_6_1.gemfile
+          - gemfiles/rails_7_0.gemfile
+        db:
+          - sqlite
+          - mysql
+          - postgresql
+        exclude:
+          - ruby: 2.5
+            gemfile: gemfiles/rails_7_0.gemfile
+          - ruby: 2.6
+            gemfile: gemfiles/rails_7_0.gemfile
+          - ruby: '3.0'
+            gemfile: gemfiles/rails_5_2.gemfile
+          - ruby: 3.1
+            gemfile: gemfiles/rails_5_2.gemfile
+          - ruby: 3.2
+            gemfile: gemfiles/rails_4_2.gemfile
+          - ruby: 3.2
+            gemfile: gemfiles/rails_5_0.gemfile
+          - ruby: 3.2
+            gemfile: gemfiles/rails_5_1.gemfile
+          - ruby: 3.2
+            gemfile: gemfiles/rails_5_2.gemfile
+          - ruby: 3.2
+            gemfile: gemfiles/rails_6_0.gemfile
+          - ruby: 3.2
+            gemfile: gemfiles/rails_6_1.gemfile
+          - ruby: 3.3
+            gemfile: gemfiles/rails_4_2.gemfile
+          - ruby: 3.3
+            gemfile: gemfiles/rails_5_0.gemfile
+          - ruby: 3.3
+            gemfile: gemfiles/rails_5_1.gemfile
+          - ruby: 3.3
+            gemfile: gemfiles/rails_5_2.gemfile
+          - ruby: 3.3
+            gemfile: gemfiles/rails_6_0.gemfile
+          - ruby: 3.3
+            gemfile: gemfiles/rails_6_1.gemfile
+        os:
+          - ubuntu-latest
+    services:
+      mysql:
+        image: mysql:5.7
+        env:
+            MYSQL_ALLOW_EMPTY_PASSWORD: yes
+        ports:
+            - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+      postgres:
+        # Docker Hub image
+        image: postgres
+        # Provide the password for postgres
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_HOST_AUTH_METHOD: trust
+        ports:
+          - 5432:5432
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    env:
+      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+      DB: ${{ matrix.db }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: "Create MySQL database"
+        if: ${{ env.DB == 'mysql' }}
+        run: |
+          mysql -h 127.0.0.1 -u root -e 'create database ranked_model_test;'
+      - name: "Create PostgreSQL database"
+        if: ${{ env.DB == 'postgresql' }}
+        run: |
+          psql -c 'create database ranked_model_test;' -h localhost -U postgres
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -2,6 +2,7 @@ pkg/*
 *.gem
 .bundle
 *.un~
+*.swp
 
 Gemfile.lock
 *.gemfile.lock

data/Appraisals

@@ -1,48 +1,3 @@
-appraise "rails-4-2" do
-  group :sqlite do
-    gem "activerecord-jdbcsqlite3-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
-  group :postgresql do
-    gem "pg", "~> 0.18.4", platform: :ruby
-    gem "activerecord-jdbcpostgresql-adapter", "~> 1.3.24", platform: :jruby
-  end
-
-  gem "activerecord", "~> 4.2.0"
-end
-
-appraise "rails-5-0" do
-  group :sqlite do
-    gem "activerecord-jdbcsqlite3-adapter", "~> 50.0", platform: :jruby
-  end
-  group :mysql do
-    gem "activerecord-jdbcmysql-adapter", "~> 50.0", platform: :jruby
-  end
-  group :postgresql do
-    gem "activerecord-jdbcpostgresql-adapter", "~> 50.0", platform: :jruby
-  end
-
-  gem "activerecord", "~> 5.0.0"
-end
-
-appraise "rails-5-1" do
-  group :sqlite do
-    gem "activerecord-jdbcsqlite3-adapter", "~> 51.0", platform: :jruby
-  end
-  group :mysql do
-    gem "activerecord-jdbcmysql-adapter", "~> 51.0", platform: :jruby
-  end
-  group :postgresql do
-    gem "activerecord-jdbcpostgresql-adapter", "~> 51.0", platform: :jruby
-  end
-
-  gem "activerecord", "~> 5.1.0"
-end
-
 appraise "rails-5-2" do
   group :sqlite do
     gem "activerecord-jdbcsqlite3-adapter", "~> 52.0", platform: :jruby
@@ -84,3 +39,17 @@ appraise "rails-6-1" do
   end
   gem "activerecord", "~> 6.1.0"
 end
+
+appraise "rails-7-0" do
+  group :sqlite do
+    gem "sqlite3", "~> 1.4", platform: :ruby
+    gem "activerecord-jdbcsqlite3-adapter", "~> 61.0", platform: :jruby
+  end
+  group :mysql do
+    gem "activerecord-jdbcmysql-adapter", "~> 61.0", platform: :jruby
+  end
+  group :postgresql do
+    gem "activerecord-jdbcpostgresql-adapter", "~> 61.0", platform: :jruby
+  end
+  gem "activerecord", "~> 7.0.0"
+end

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [Unreleased]
+
+## [0.4.11] - 2024-10-20
+
+- Add `funding_uri` to gemspec.
+
+## [0.4.10] - 2024-08-09
+
+- Publish ActiveSupport notifications on rebalancing. Thanks @tjvc!

data/Readme.mkd

@@ -1,6 +1,13 @@
 **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)
+[![Build Status](https://github.com/brendon/ranked-model/actions/workflows/ci.yml/badge.svg)](https://github.com/brendon/ranked-model/actions/workflows/ci.yml)
+
+ANNOUNCING: Positioning, the gem
+--------------------------------
+
+As maintainer of both Acts As List and the Ranked Model gems, I've become intimately aquainted with the strengths and weaknesses of each. I ended up writing a small scale Rails Concern for positioning database rows for a recent project and it worked really well so I've decided to release it as a gem: [Positioning](https://github.com/brendon/positioning)
+
+Positioning works similarly to Acts As List in that it maintains a sequential list of integer values as positions. It differs in that it encourages a unique constraints on the position column and supports multiple lists per database table. It borrows Ranked Model's concept of relative positioning. I encourage you to check it out and give it a whirl on your project!
 
 Installation
 ------------
@@ -136,6 +143,37 @@ Pond.first.ducks.rank(:swimming_order)
 Duck.walking.rank(:walking)
 ```
 
+Drawbacks
+---------
+
+While ranked-model is performant when storing data, it might cause N+1s depending on how you write your code. Consider this snippet:
+
+```ruby
+ducks = Duck.all
+ducks.map do |duck|
+  {
+    id: duck.id,
+    position: duck.row_order_rank # This causes N+1!
+  }
+end
+```
+
+Every call to `duck.row_order_rank` will make a call to the DB to check the rank of that
+particular element. If you have a long list of elements this might cause issues to your DB.
+
+In order to avoid that, you can use the `rank(:your_rank)` scope and some Ruby code to get
+the element's position:
+
+```ruby
+ducks = Duck.rank(:row_order).all
+ducks.map.with_index do |duck, index|
+  {
+    id: duck.id,
+    position: index
+  }
+end
+```
+
 Single Table Inheritance (STI)
 ------------------------------
 
@@ -231,6 +269,21 @@ this occurs, ranked-model will try to shift other records out of the way. If ite
 shifted anymore, it will rebalance the distribution of rank numbers across all members
 of the ranked group.
 
+Record updates to rebalance ranks do not trigger ActiveRecord callbacks. If you need to react to these updates
+(to index them in a secondary data store, for example), you can subscribe to the `ranked_model.ranks_updated`
+[ActiveSupport notification](https://api.rubyonrails.org/v7.1/classes/ActiveSupport/Notifications.html).
+Subscribed consumers receive an event for each rearrangement or rebalancing, the payload of which includes the
+triggering instance and the `scope` and `with_same` options for the ranking, which can be used to retrieve the
+affected records.
+
+```ruby
+ActiveSupport::Notifications.subscribe("ranked_model.ranks_updated") do |_name, _start, _finish, _id, payload|
+  # payload[:instance] - the instance whose update triggered the rebalance
+  # payload[:scope] - the scope applied to the ranking
+  # payload[:with_same] - the with_same option applied to the ranking
+end
+```
+
 Contributing
 ------------
 

data/gemfiles/rails_5_2.gemfile

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

data/gemfiles/rails_6_0.gemfile

@@ -10,12 +10,12 @@ group :sqlite do
 end
 
 group :postgresql do
-  gem "pg", "~> 1.2.0", platform: :ruby
+  gem "pg", platform: :ruby
   gem "activerecord-jdbcpostgresql-adapter", "~> 60.0", platform: :jruby
 end
 
 group :mysql do
-  gem "mysql2", "~> 0.5.0", platform: :ruby
+  gem "mysql2", platform: :ruby
   gem "activerecord-jdbcmysql-adapter", "~> 60.0", platform: :jruby
 end
 

data/gemfiles/rails_6_1.gemfile

@@ -10,12 +10,12 @@ group :sqlite do
 end
 
 group :postgresql do
-  gem "pg", "~> 1.2.0", platform: :ruby
+  gem "pg", platform: :ruby
   gem "activerecord-jdbcpostgresql-adapter", "~> 61.0", platform: :jruby
 end
 
 group :mysql do
-  gem "mysql2", "~> 0.5.0", platform: :ruby
+  gem "mysql2", platform: :ruby
   gem "activerecord-jdbcmysql-adapter", "~> 61.0", platform: :jruby
 end
 

data/gemfiles/rails_7_0.gemfile

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