Module: ActsAsTaggableOn::Taggable::Collection::ClassMethods

Defined in:
lib/acts_as_taggable_on/acts_as_taggable_on/collection.rb

Instance Method Summary collapse

Instance Method Details

#acts_as_taggable_on(*args) ⇒ Object 



32
33
34
35
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/collection.rb', line 32

def acts_as_taggable_on(*args)
  super(*args)
  initialize_acts_as_taggable_on_collection
end

#all_tag_counts(options = {}) ⇒ Object

Calculate the tag counts for all tags.

Parameters:

  • options (Hash) (defaults to: {}) —

    Options:

    • :start_at - Restrict the tags to those created after a certain time

    • :end_at - Restrict the tags to those created before a certain time

    • :conditions - A piece of SQL conditions to add to the query

    • :limit - The maximum number of tags to return

    • :order - A piece of SQL to order by. Eg ‘tags.count desc’ or ‘taggings.created_at desc’

    • :at_least - Exclude tags with a frequency less than the given value

    • :at_most - Exclude tags with a frequency greater than the given value

    • :on - Scope the find to only include a certain context



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/collection.rb', line 53

def all_tag_counts(options = {})
  options.assert_valid_keys :start_at, :end_at, :conditions, :at_least, :at_most, :order, :limit, :on, :id

  scope = if ActiveRecord::VERSION::MAJOR >= 3
            {}
          else
            scope(:find) || {}           
          end

  ## Generate conditions:
  options[:conditions] = sanitize_sql(options[:conditions]) if options[:conditions]     
    
  start_at_conditions = sanitize_sql(["#{Tagging.table_name}.created_at >= ?", options.delete(:start_at)]) if options[:start_at]
  end_at_conditions   = sanitize_sql(["#{Tagging.table_name}.created_at <= ?", options.delete(:end_at)])   if options[:end_at]

  taggable_conditions  = sanitize_sql(["#{Tagging.table_name}.taggable_type = ?", base_class.name])
  taggable_conditions << sanitize_sql([" AND #{Tagging.table_name}.taggable_id = ?", options.delete(:id)]) if options[:id]

  conditions = [
    taggable_conditions,
    options[:conditions],
    scope[:conditions],
    start_at_conditions,
    end_at_conditions
  ].compact.reverse
  
  ## Generate joins:
  tagging_join  = "LEFT OUTER JOIN #{Tagging.table_name} ON #{Tag.table_name}.id = #{Tagging.table_name}.tag_id"
  tagging_join << sanitize_sql([" AND #{Tagging.table_name}.context = ?", options.delete(:on).to_s]) if options[:on]

  taggable_join = "INNER JOIN #{table_name} ON #{table_name}.#{primary_key} = #{Tagging.table_name}.taggable_id"
  taggable_join << " AND #{table_name}.#{inheritance_column} = '#{name}'" unless descends_from_active_record? # Current model is STI descendant, so add type checking to the join condition      

  joins = [
    tagging_join,
    taggable_join,
    scope[:joins]
  ].compact.reverse


  ## Generate scope:
  scope = Tag.scoped(:select => "#{Tag.table_name}.*, COUNT(*) AS count").order(options[:order]).limit(options[:limit])   
  
  # Joins and conditions
  joins.each      { |join|      scope = scope.joins(join)      }
  conditions.each { |condition| scope = scope.where(condition) }
  
  # GROUP BY and HAVING clauses:
  at_least  = sanitize_sql(['COUNT(*) >= ?', options.delete(:at_least)]) if options[:at_least]
  at_most   = sanitize_sql(['COUNT(*) <= ?', options.delete(:at_most)]) if options[:at_most]
  having    = [at_least, at_most].compact.join(' AND ')        

  if ActiveRecord::VERSION::MAJOR >= 3
    # Append the current scope to the scope, because we can't use scope(:find) in RoR 3.0 anymore:
    scoped_select = "#{table_name}.#{primary_key}"
    scope = scope.where("#{Tagging.table_name}.taggable_id IN(#{select(scoped_select).to_sql})")
    
    # We have having() in RoR 3.0 so use it:
    having = having.blank? ? "COUNT(*) > 0" : "COUNT(*) > 0 AND #{having}"
    scope = scope.group(grouped_column_names_for(Tag)).having(having)
  else
    # Having is not available in 2.3.x:
    group_by  = "#{grouped_column_names_for(Tag)} HAVING COUNT(*) > 0"
    group_by << " AND #{having}" unless having.blank?
    scope = scope.group(group_by)
  end

  scope
end

#initialize_acts_as_taggable_on_collection ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/collection.rb', line 10

def initialize_acts_as_taggable_on_collection
  tag_types.map(&:to_s).each do |tag_type|
    class_eval %(
      def self.#{tag_type.singularize}_counts(options={})
        tag_counts_on('#{tag_type}', options)
      end

      def #{tag_type.singularize}_counts(options = {})
        tag_counts_on('#{tag_type}', options)
      end

      def top_#{tag_type}(limit = 10)
        tag_counts_on('#{tag_type}', :order => 'count desc', :limit => limit.to_i)
      end

      def self.top_#{tag_type}(limit = 10)
        tag_counts_on('#{tag_type}', :order => 'count desc', :limit => limit.to_i)
      end        
    )
  end        
end

#tag_counts_on(context, options = {}) ⇒ Object 



37
38
39
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/collection.rb', line 37

def tag_counts_on(context, options = {})
  all_tag_counts(options.merge({:on => context.to_s}))
end