activerecord-slotted_counters 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f3309ca0e6671a6dbb844a5e3c7e8f0bf289b6125e9cbbed9d8234ed2afb596
+  data.tar.gz: be5e21d8aea9e6dc73a0150bed7cf13f349a6af7dc71cbe38cc86bd0ed785e3c
+SHA512:
+  metadata.gz: 5ec60f4a1eaeff23861b5c1fe7ba6ea2ab866097f2f3d2ced182fcf36c82b34d402a536f37567423f3cdb4b9fe7baa5ca3d434d99fe2235adaeb30ebc0348493
+  data.tar.gz: fcee85f67d01bc7a4938fc7b261962157ee96d7db69e65003f9091fcffc9d6776fc3b905f6efb6516aeeaa95ae2ac104826671b00e030948f90675dcee4f20c8

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change log
+
+## master
+
+[@palkan]: https://github.com/palkan

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2022 Evil Martians
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+[![Gem Version](https://badge.fury.io/rb/activerecord-slotted_counters.svg)](https://rubygems.org/gems/activerecord-slotted_counters) [![Build](https://github.com/evilmartians/activerecord-slotted_counters/workflows/Build/badge.svg)](https://github.com/evilmartians/activerecord-slotted_counters/actions)
+
+# Active Record slotted counters
+
+This gem adds **slotted counters** support to [Active Record counter cache][counter-cache]. Slotted counters help to reduce contention on a single row update in case you many concurrent operations (like updating a page views counter during traffic spikes).
+
+Read more about slotted counters in [this post](https://planetscale.com/blog/the-slotted-counter-pattern).
+
+## Installation
+
+Add to your project:
+
+```ruby
+# Gemfile
+gem "activerecord-slotted_counters"
+```
+
+### Supported Ruby versions
+
+- Ruby (MRI) >= 2.7.0
+
+## Usage
+
+First, add and apply the required migration(-s):
+
+```sh
+bin/rails generate slotted_counters:install
+bin/rails db:migrate
+```
+
+Then, add the following line to the model to add a slotted counter:
+
+```ruby
+class User < ApplicationRecord
+  has_slotted_counter :comments
+end
+```
+
+Now you can use all the common counter cache APIs as before:
+
+```ruby
+# Manipulating the counter explicitly
+user = User.first
+
+User.increment_counter(:comments_count, user.id)
+User.decrement_counter(:comments_count, user.id)
+User.reset_counters(user.id, :comments)
+# etc.
+
+# Reading the value
+user.comments_count
+```
+
+Under the hood, a row in the `slotted_counters` table is created associated with the record.
+
+**NOTE:** Reading the current value performs SQL query once:
+
+```ruby
+user.comments_count #=> select count from slotted_counters where ...
+user.comments_count #=> no sql
+```
+
+If you want to want preload counters for multiple records, you can use a convinient `#with_slotted_counters` method:
+
+```ruby
+User.all.with_slotted_counters(:comments).find_each do
+  _1.comments_count #=> no sql
+end
+```
+
+Using `counter_cache: true` on `belongs_to` associations also works as expected.
+
+## Limitations / TODO
+
+- Add `reset_counters` implementation
+- Add `update_counters` implementation
+- Add `with_slotted_counters` scope
+- Add multiple `has_slotted_counter` support
+- Rails 6 support
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/evilmartians/activerecord-slotted_counters](https://github.com/evilmartians/activerecord-slotted_counters).
+
+## Credis
+
+This gem is generated via [new-gem-generator](https://github.com/palkan/new-gem-generator).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+[counter-cache]: https://api.rubyonrails.org/classes/ActiveRecord/CounterCache/ClassMethods.html

data/lib/activerecord-slotted_counters.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "activerecord_slotted_counters/version"
+require "activerecord_slotted_counters/railtie" if defined?(Rails::Railtie)
+
+require "activerecord_slotted_counters/has_slotted_counter"

data/lib/activerecord_slotted_counters/has_slotted_counter.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "activerecord_slotted_counters/utils"
+
+module ActiveRecordSlottedCounters
+  class SlottedCounter < ::ActiveRecord::Base
+    scope :associated_records, ->(counter_name, id, klass) do
+      where(counter_name: counter_name, associated_record_id: id, associated_record_type: klass)
+    end
+  end
+
+  module HasSlottedCounter
+    extend ActiveSupport::Concern
+    include ActiveRecordSlottedCounters::Utils
+
+    # TODO setup in gem config
+    DEFAULT_MAX_SLOT_NUMBER = 100
+
+    SLOTTED_COUNTERS_ASSOCIATION_OPTIONS = {
+      class_name: "ActiveRecordSlottedCounters::SlottedCounter",
+      foreign_key: "associated_record_id"
+    }
+
+    class_methods do
+      include ActiveRecordSlottedCounters::Utils
+
+      def has_slotted_counter(counter_type)
+        counter_name = slotted_counter_name(counter_type)
+        association_name = slotted_counter_association_name(counter_type)
+
+        has_many association_name, **SLOTTED_COUNTERS_ASSOCIATION_OPTIONS
+
+        _slotted_counters << counter_type
+
+        define_method(counter_name) do
+          read_slotted_counter(counter_type)
+        end
+      end
+
+      def increment_counter(counter_name, id, touch: nil)
+        return super unless registered_slotted_counter? counter_name
+
+        insert_counter_record(counter_name, id, 1)
+      end
+
+      def decrement_counter(counter_name, id, touch: nil)
+        return super unless registered_slotted_counter? counter_name
+
+        insert_counter_record(counter_name, id, -1)
+      end
+
+      def slotted_counters
+        if superclass.respond_to?(:slotted_counters)
+          superclass.slotted_counters + _slotted_counters
+        else
+          _slotted_counters
+        end
+      end
+
+      private
+
+      def _slotted_counters
+        @_slotted_counters ||= []
+      end
+
+      def registered_slotted_counter?(counter_name)
+        counter_type = slotted_counter_type(counter_name)
+
+        slotted_counters.include? counter_type
+      end
+
+      def insert_counter_record(counter_name, id, count)
+        slot = rand(DEFAULT_MAX_SLOT_NUMBER)
+        on_duplicate_clause = "count = slotted_counters.count + #{count}"
+
+        result = ActiveRecordSlottedCounters::SlottedCounter.upsert(
+          {
+            counter_name: counter_name,
+            associated_record_type: name,
+            associated_record_id: id,
+            slot: slot,
+            count: count
+          },
+          on_duplicate: Arel.sql(on_duplicate_clause),
+          unique_by: :index_slotted_counters
+        )
+
+        result.rows.count
+      end
+    end
+
+    private
+
+    def read_slotted_counter(counter_type)
+      association_name = slotted_counter_association_name(counter_type)
+
+      if association_cached?(association_name)
+        scope = association(association_name).scope
+        counter = scope.sum(&:count)
+
+        return counter
+      end
+
+      counter_name = slotted_counter_name(counter_type)
+      scope = send(association_name).associated_records(counter_name, id, self.class.to_s)
+      scope.sum(:count)
+    end
+  end
+end

data/lib/activerecord_slotted_counters/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module ActiveRecordSlottedCounters # :nodoc:
+  class Railtie < ::Rails::Railtie # :nodoc:
+    config.app_generators do
+      # TODO can I use slotted_counters:install naming without relative import?
+      require_relative "../../lib/generators/slotted_counters/install_generator"
+    end
+
+    initializer "extend ActiveRecord with  ActiveRecordSlottedCounters" do |_app|
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.include ActiveRecordSlottedCounters::HasSlottedCounter
+      end
+    end
+  end
+end

data/lib/activerecord_slotted_counters/utils.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "active_support"
+
+module ActiveRecordSlottedCounters
+  module Utils
+    private
+
+    def slotted_counter_association_name(counter_type)
+      "#{counter_type}_slotted_counters".to_sym
+    end
+
+    def slotted_counter_name(counter_type)
+      "#{counter_type}_count".to_sym
+    end
+
+    # TODO refactoring
+    def slotted_counter_type(counter_name)
+      counter_name.to_s.split("_")[0..-2].join("_").to_sym
+    end
+  end
+end

data/lib/activerecord_slotted_counters/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveRecordSlottedCounters # :nodoc:
+  VERSION = "0.0.1"
+end

data/lib/generators/slotted_counters/install_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module SlottedCounters
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
+
+      def copy_migration
+        migration_template "migration.rb", "db/migrate/create_slotted_counters.rb", migration_version: migration_version
+      end
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+    end
+  end
+end

data/lib/generators/slotted_counters/templates/migration.rb.tt

@@ -0,0 +1,15 @@
+class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :slotted_counters do |t|
+      t.string :counter_name, null: false
+      t.string :associated_record_type, null: false
+      t.integer :associated_record_id, null: false
+      t.integer :slot, null: false
+      t.integer :count, null: false
+
+      t.timestamps
+    end
+
+    add_index :slotted_counters, [:associated_record_id, :associated_record_type, :counter_name, :slot], unique: true, name: 'index_slotted_counters'
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-slotted_counters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Egor Lukin
+- Vladimir Dementyev
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Active Record slotted counters support
+email:
+- dementiev.vm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/activerecord-slotted_counters.rb
+- lib/activerecord_slotted_counters/has_slotted_counter.rb
+- lib/activerecord_slotted_counters/railtie.rb
+- lib/activerecord_slotted_counters/utils.rb
+- lib/activerecord_slotted_counters/version.rb
+- lib/generators/slotted_counters/install_generator.rb
+- lib/generators/slotted_counters/templates/migration.rb.tt
+homepage: http://github.com/evilmartians/activerecord-slotted_counters
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: http://github.com/evilmartians/activerecord-slotted_counters/issues
+  changelog_uri: https://github.com/evilmartians/activerecord-slotted_counters/blob/master/CHANGELOG.md
+  documentation_uri: http://github.com/evilmartians/activerecord-slotted_counters
+  homepage_uri: http://github.com/evilmartians/activerecord-slotted_counters
+  source_code_uri: http://github.com/evilmartians/activerecord-slotted_counters
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.11
+signing_key:
+specification_version: 4
+summary: Active Record slotted counters support
+test_files: []