Module: CounterCulture::Extensions::ClassMethods

Defined in:
lib/counter_culture/extensions.rb

Instance Method Summary collapse

Instance Method Details

#after_commit_counter_cache ⇒ Object

this holds all configuration data



7
8
9
10
11
12
13
 
# File 'lib/counter_culture/extensions.rb', line 7

def after_commit_counter_cache
  config = @after_commit_counter_cache || []
  if superclass.respond_to?(:after_commit_counter_cache) && superclass.after_commit_counter_cache
    config = superclass.after_commit_counter_cache + config
  end
  config
end

#counter_culture(relation, options = {}) ⇒ Object

called to configure counter caches



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/counter_culture/extensions.rb', line 16

def counter_culture(relation, options = {})
  unless @after_commit_counter_cache
    # initialize callbacks only once
    after_create :_update_counts_after_create
    before_destroy :_update_counts_before_destroy
    after_update :_update_counts_after_update

    if respond_to?(:before_real_destroy) &&
        instance_methods.include?(:paranoia_destroyed?)
      before_real_destroy :_update_counts_before_real_destroy
    end

    if respond_to?(:before_restore)
      before_restore :_update_counts_before_restore
    end

    if defined?(Discard::Model) && include?(Discard::Model)
      before_discard :_update_counts_before_discard
      before_undiscard :_update_counts_before_undiscard
    end

    # we keep a list of all counter caches we must maintain
    @after_commit_counter_cache = []
  end

  if options[:column_names] && !(options[:column_names].is_a?(Hash) || options[:column_names].is_a?(Proc))
    raise ArgumentError.new(
      ":column_names must be a Hash of conditions and column names, " \
      "or a Proc that when called returns such a Hash"
    )
  end

  # add the counter to our collection
  @after_commit_counter_cache << Counter.new(self, relation, options)
end

#counter_culture_fix_counts(options = {}) ⇒ Object

checks all of the declared counter caches on this class for correctnes based on original data; if the counter cache is incorrect, sets it to the correct count

options:

{ :exclude => list of relations to skip when fixing counts,
  :only => only these relations will have their counts fixed,
  :column_name => only this column will have its count fixed
  :polymorphic_classes => specify the class(es) to update in polymorphic associations }

returns: a list of fixed record as an array of hashes of the form:

{ :entity => which model the count was fixed on,
  :id => the id of the model that had the incorrect count,
  :what => which column contained the incorrect count,
  :wrong => the previously saved, incorrect count,
  :right => the newly fixed, correct count }



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/counter_culture/extensions.rb', line 68

def counter_culture_fix_counts(options = {})
  raise "No counter cache defined on #{name}" unless @after_commit_counter_cache

  options[:exclude] = Array(options[:exclude]) if options[:exclude]
  options[:exclude] = options[:exclude].try(:map) {|x| x.is_a?(Enumerable) ? x : [x] }
  options[:only] = [options[:only]] if options[:only] && !options[:only].is_a?(Enumerable)
  options[:only] = options[:only].try(:map) {|x| x.is_a?(Enumerable) ? x : [x] }

  @after_commit_counter_cache.flat_map do |counter|
    next if options[:exclude] && options[:exclude].include?(counter.relation)
    next if options[:only] && !options[:only].include?(counter.relation)

    reconciler_options = %i(context batch_size column_name db_connection_builder finish skip_unsupported start touch verbose where polymorphic_classes)

    reconciler = CounterCulture::Reconciler.new(counter, options.slice(*reconciler_options))
    reconciler.reconcile!
    reconciler.changes
  end.compact
end

#skip_counter_culture_updates ⇒ Object 



88
89
90
91
92
93
94
95
96
 
# File 'lib/counter_culture/extensions.rb', line 88

def skip_counter_culture_updates
  return unless block_given?

  counter_culture_updates_was = Thread.current[:skip_counter_culture_updates]
  Thread.current[:skip_counter_culture_updates] = Array(counter_culture_updates_was) + [self]
  yield
ensure
  Thread.current[:skip_counter_culture_updates] = counter_culture_updates_was
end