ranked-model 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61451e859060c7d8a3f889bd54327b103797d728312cedef66efa1b25d11767f
-  data.tar.gz: 2e1df0f514decf2e43667c2d0139e510202fc0ebc32aed758831ea20497aaf1a
+  metadata.gz: 329351cc90908d43dfeda2987183ebedff1abe8cbefc05afe1d0bd6760df2c41
+  data.tar.gz: f99a8987935928d33ac77555ff9bd5614002db38fffc7cd1a6c85449e236a42b
 SHA512:
-  metadata.gz: d046ed8e55533b8f453a67e0c705738e9353b22b20b01310381a56195803ee066cd647e1b8801484ca79518a8ea2394577841d4b9c4eb97d12f0b36246c1bfc7
-  data.tar.gz: ca05b38d74cbe11544cabb70890c64d26c9a94c4608d2b4d7da1253535efc03775ef3fed80fc9b93709f503f3f53a8cd725b7f2b8c43ad8565a72139f0ec53e5
+  metadata.gz: 6b31ddb712c2425d6a59c918ab506f6e2855f9a40575cc298df8d1271f701741a5bfa88040410299226c46ace4cec00459a1f5d804b303a0326de428c1035cd1
+  data.tar.gz: 02ef12162bec60ee6b82f4f8dd0200ed82926bed9d4a6e5e4e77ce6d8c46ec7d2343d347ecf6e6a234cadec2e3e42042f7097bf9e7791fe2ab75342ac89c2777

data/.github/workflows/ci.yml

@@ -10,12 +10,13 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - 2.4
           - 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
@@ -26,12 +27,6 @@ jobs:
           - mysql
           - postgresql
         exclude:
-          - ruby: 2.4
-            gemfile: gemfiles/rails_6_0.gemfile
-          - ruby: 2.4
-            gemfile: gemfiles/rails_6_1.gemfile
-          - ruby: 2.4
-            gemfile: gemfiles/rails_7_0.gemfile
           - ruby: 2.5
             gemfile: gemfiles/rails_7_0.gemfile
           - ruby: 2.6
@@ -40,8 +35,30 @@ jobs:
             gemfile: gemfiles/rails_5_2.gemfile
           - ruby: 3.1
             gemfile: gemfiles/rails_5_2.gemfile
-          - ruby: 3.1
+          - 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:
@@ -72,7 +89,7 @@ jobs:
       BUNDLE_GEMFILE: ${{ matrix.gemfile }}
       DB: ${{ matrix.db }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [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
 ------------
@@ -151,7 +158,7 @@ ducks.map do |duck|
 end
 ```
 
-Every call to `duck.row_order_rank` will make a call to the DB to check the rank of that 
+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
@@ -262,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/lib/ranked-model/ranker.rb

@@ -173,7 +173,7 @@ module RankedModel
 
       def rank_at_average(min, max)
         if (max - min).between?(-1, 1) # No room at the inn...
-          rebalance_ranks
+          notify_ranks_updated { rebalance_ranks }
           position_at position
         else
           rank_at( ( ( max - min ).to_f / 2 ).ceil + min )
@@ -183,7 +183,7 @@ module RankedModel
       def assure_unique_position
         if ( new_record? || rank_changed? )
           if (rank > RankedModel::MAX_RANK_VALUE) || rank_taken?
-            rearrange_ranks
+            notify_ranks_updated { rearrange_ranks }
           end
         end
       end
@@ -350,6 +350,16 @@ module RankedModel
         end
       end
 
+      def notify_ranks_updated(&block)
+        ActiveSupport::Notifications.instrument(
+          "ranked_model.ranks_updated",
+          instance: instance,
+          scope: ranker.scope,
+          with_same: ranker.with_same
+        ) do
+          block.call
+        end
+      end
     end
 
   end

data/lib/ranked-model/version.rb

@@ -1,3 +1,3 @@
 module RankedModel
-  VERSION = "0.4.9"
+  VERSION = "0.4.10"
 end

data/spec/notifications_spec.rb

@@ -0,0 +1,89 @@
+require "spec_helper"
+
+describe "notifications" do
+  before do
+    @notifications_count = 0
+    @notification_payloads = []
+
+    ActiveSupport::Notifications.subscribe("ranked_model.ranks_updated") do |name, start, finish, id, payload|
+      @notifications_count += 1
+      @notification_payloads << payload
+    end
+  end
+
+  after do
+    ActiveSupport::Notifications.unsubscribe("ranked_model.ranks_updated")
+  end
+
+  context "when rearranging" do
+    it "notifies subscribers with the instance" do
+      Number.create(order: RankedModel::MAX_RANK_VALUE)
+      second_number = Number.create(order: RankedModel::MAX_RANK_VALUE)
+
+      expect(@notifications_count).to eq(1)
+      expect(@notification_payloads.last[:instance]).to eq(second_number)
+    end
+
+    context "with scope" do
+      it "notifies subscribers with the instance and scope" do
+        Duck.create(size: RankedModel::MAX_RANK_VALUE, pond: "Shin")
+        second_duck = Duck.create(size: RankedModel::MAX_RANK_VALUE, pond: "Shin")
+
+        expect(@notifications_count).to eq(1)
+        expect(@notification_payloads.last[:instance]).to eq(second_duck)
+        expect(@notification_payloads.last[:scope]).to eq(:in_shin_pond)
+      end
+    end
+
+    context "with with_same" do
+      it "notifies subscribers with the instance and with_same" do
+        Duck.create(age: RankedModel::MAX_RANK_VALUE, pond: "Shin")
+        second_duck = Duck.create(age: RankedModel::MAX_RANK_VALUE, pond: "Shin")
+
+        expect(@notifications_count).to eq(1)
+        expect(@notification_payloads.last[:instance]).to eq(second_duck)
+        expect(@notification_payloads.last[:with_same]).to eq(:pond)
+      end
+    end
+  end
+
+  context "when rebalancing" do
+    it "notifies subscribers with the instance" do
+      31.times { Number.create }
+      thirty_second_number = Number.create
+
+      expect(@notifications_count).to eq(1)
+      expect(@notification_payloads.last[:instance]).to eq(thirty_second_number)
+    end
+
+    context "with scope" do
+      it "notifies subscribers with the instance and scope" do
+        31.times { Duck.create(pond: "Shin") }
+        thirty_second_duck = Duck.create(pond: "Shin")
+
+        expect(@notifications_count).to eq(4) # Duck has four ranks
+        expect(@notification_payloads.last[:instance]).to eq(thirty_second_duck)
+        expect(@notification_payloads.map { |p| p[:scope] }).to include(:in_shin_pond)
+      end
+    end
+
+    context "with with_same" do
+      it "notifies subscribers with the instance and with_same" do
+        31.times { Duck.create(pond: "Shin") }
+        thirty_second_duck = Duck.create(pond: "Shin")
+
+        expect(@notifications_count).to eq(4)
+        expect(@notification_payloads.last[:instance]).to eq(thirty_second_duck)
+        expect(@notification_payloads.map { |p| p[:with_same] }).to include(:pond)
+      end
+    end
+  end
+
+  context "when not rearranging or rebalancing" do
+    it "does not notify subscribers" do
+      Number.create
+
+      expect(@notifications_count).to eq(0)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ranked-model
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.4.10
 platform: ruby
 authors:
 - Matthew Beale
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-22 00:00:00.000000000 Z
+date: 2024-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -137,6 +137,7 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - Rakefile
@@ -157,6 +158,7 @@ files:
 - spec/duck-model/lots_of_ducks_spec.rb
 - spec/duck-model/wrong_ducks_spec.rb
 - spec/ego-model/ego_spec.rb
+- spec/notifications_spec.rb
 - spec/number-model/number_spec.rb
 - spec/player-model/records_already_exist_spec.rb
 - spec/ranked-model/ranker_spec.rb
@@ -197,6 +199,7 @@ test_files:
 - spec/duck-model/lots_of_ducks_spec.rb
 - spec/duck-model/wrong_ducks_spec.rb
 - spec/ego-model/ego_spec.rb
+- spec/notifications_spec.rb
 - spec/number-model/number_spec.rb
 - spec/player-model/records_already_exist_spec.rb
 - spec/ranked-model/ranker_spec.rb