mongodb/mongoid

View on GitHub
lib/mongoid/association/referenced/counter_cache.rb

Summary

Maintainability
C
1 day
Test Coverage
# frozen_string_literal: true
# encoding: utf-8

module Mongoid
  module Association
    module Referenced
      module CounterCache
        extend ActiveSupport::Concern

        # Reset the given counter using the .count() query from the
        # db. This method is usuful in case that a counter got
        # corrupted, or a new counter was added to the collection.
        #
        # @example Reset the given counter cache
        #   post.reset_counters(:comments)
        #
        # @param [ Symbol, Array ] counters One or more counter caches to reset
        #
        # @since 4.0.0
        def reset_counters(*counters)
          self.class.with(persistence_context) do |_class|
            _class.reset_counters(self, *counters)
          end
        end

        module ClassMethods

          # Reset the given counter using the .count() query from the
          # db. This method is usuful in case that a counter got
          # corrupted, or a new counter was added to the collection.
          #
          # @example Reset the given counter cache
          #   Post.reset_counters('50e0edd97c71c17ea9000001', :comments)
          #
          # @param [ String ] id The id of the object that will be reset.
          # @param [ Symbol, Array ] counters One or more counter caches to reset
          #
          # @since 3.1.0
          def reset_counters(id, *counters)
            document = id.is_a?(Document) ? id : find(id)
            counters.each do |name|
              relation_association = relations[name]
              counter_name = relation_association.inverse_association.counter_cache_column_name
              document.update_attribute(counter_name, document.send(name).count)
            end
          end

          # Update the given counters by the value factor. It uses the
          # atomic $inc command.
          #
          # @example Add 5 to comments counter and remove 2 from likes
          #   counter.
          #   Post.update_counters('50e0edd97c71c17ea9000001',
          #              :comments_count => 5, :likes_count => -2)
          #
          # @param [ String ] id The id of the object to update.
          # @param [ Hash ] counters
          #
          # @since 3.1.0
          def update_counters(id, counters)
            where(:_id => id).inc(counters)
          end

          # Increment the counter name from the entries that match the
          # id by one. This method is used on associations callbacks
          # when counter_cache is enabled
          #
          # @example Increment comments counter
          #   Post.increment_counter(:comments_count, '50e0edd97c71c17ea9000001')
          #
          # @param [ Symbol ] counter_name Counter cache name
          # @param [ String ] id The id of the object that will have its counter incremented.
          #
          # @since 3.1.0
          def increment_counter(counter_name, id)
            update_counters(id, counter_name.to_sym => 1)
          end

          # Decrement the counter name from the entries that match the
          # id by one. This method is used on associations callbacks
          # when counter_cache is enabled
          #
          # @example Decrement comments counter
          #   Post.decrement_counter(:comments_count, '50e0edd97c71c17ea9000001')
          #
          # @param [ Symbol ] counter_name Counter cache name
          # @param [ String ] id The id of the object that will have its counter decremented.
          #
          # @since 3.1.0
          def decrement_counter(counter_name, id)
            update_counters(id, counter_name.to_sym => -1)
          end
        end

        # Add the callbacks responsible for update the counter cache field.
        #
        # @api private
        #
        # @example Add the touchable.
        #   Mongoid::Association::Referenced::CounterCache.define_callbacks!(association)
        #
        # @param [ Association ] association The association.
        #
        # @return [ Class ] The association's owning class.
        #
        # @since 7.0
        def self.define_callbacks!(association)
          name = association.name
          cache_column = association.counter_cache_column_name.to_sym

          association.inverse_class.tap do |klass|
            klass.after_update do
              if record = __send__(name)
                foreign_key = association.foreign_key

                if attribute_changed?(foreign_key)
                  original, current = attribute_change(foreign_key)

                  unless original.nil?
                    record.class.with(persistence_context) do |_class|
                      _class.decrement_counter(cache_column, original)
                    end
                  end

                  unless current.nil?
                    record[cache_column] = (record[cache_column] || 0) + 1
                    record.class.with(record.persistence_context) do |_class|
                      _class.increment_counter(cache_column, current) if record.persisted?
                    end
                  end
                end
              end
            end

            klass.after_create do
              if record = __send__(name)
                record[cache_column] = (record[cache_column] || 0) + 1

                if record.persisted?
                  record.class.with(record.persistence_context) do |_class|
                    _class.increment_counter(cache_column, record._id)
                  end
                  record.remove_change(cache_column)
                end
              end
            end

            klass.before_destroy do
              if record = __send__(name)
                record[cache_column] = (record[cache_column] || 0) - 1 unless record.frozen?

                if record.persisted?
                  record.class.with(record.persistence_context) do |_class|
                    _class.decrement_counter(cache_column, record._id)
                  end
                  record.remove_change(cache_column)
                end
              end
            end
          end
        end
      end
    end
  end
end