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

- (Object) acts_as_taggable_on(*args)



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

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

- (Object) all_tag_counts(options = {})

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



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
122
123
124
125
126
127
128
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/collection.rb', line 91

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

  ## Generate conditions:
  options[:conditions] = sanitize_sql(options[:conditions]) if options[:conditions]

  ## Generate joins:
  taggable_join = "INNER JOIN #{table_name} ON #{table_name}.#{primary_key} = #{ActsAsTaggableOn::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


  ## Generate scope:
  tagging_scope = ActsAsTaggableOn::Tagging.select("#{ActsAsTaggableOn::Tagging.table_name}.tag_id, COUNT(#{ActsAsTaggableOn::Tagging.table_name}.tag_id) AS tags_count")
  tag_scope = ActsAsTaggableOn::Tag.select("#{ActsAsTaggableOn::Tag.table_name}.*, #{ActsAsTaggableOn::Tagging.table_name}.tags_count AS count").order(options[:order]).limit(options[:limit])

  # Joins and conditions
  tagging_scope = tagging_scope.joins(taggable_join)
  tagging_conditions(options).each { |condition| tagging_scope = tagging_scope.where(condition) }
  tag_scope     = tag_scope.where(options[:conditions])

  # GROUP BY and HAVING clauses:
  having = ["COUNT(#{ActsAsTaggableOn::Tagging.table_name}.tag_id) > 0"]
  having.push sanitize_sql(["COUNT(#{ActsAsTaggableOn::Tagging.table_name}.tag_id) >= ?", options.delete(:at_least)]) if options[:at_least]
  having.push sanitize_sql(["COUNT(#{ActsAsTaggableOn::Tagging.table_name}.tag_id) <= ?", options.delete(:at_most)]) if options[:at_most]
  having = having.compact.join(' AND ')

  group_columns = "#{ActsAsTaggableOn::Tagging.table_name}.tag_id"

  unless options[:id]
    # 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}"
    tagging_scope = tagging_scope.where("#{ActsAsTaggableOn::Tagging.table_name}.taggable_id IN(#{safe_to_sql(select(scoped_select))})")
  end

  tagging_scope = tagging_scope.group(group_columns).having(having)

  tag_scope_joins(tag_scope, tagging_scope)
end

- (Object) all_tags(options = {})

Calculate the tag names. To be used when you don't need tag counts and want to avoid the taggable joins.

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. Note we don't join the taggable objects for performance reasons.

    • :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'

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/collection.rb', line 55

def all_tags(options = {})
  options.assert_valid_keys :start_at, :end_at, :conditions, :order, :limit, :on

  ## Generate conditions:
  options[:conditions] = sanitize_sql(options[:conditions]) if options[:conditions]

  ## Generate scope:
  tagging_scope = ActsAsTaggableOn::Tagging.select("#{ActsAsTaggableOn::Tagging.table_name}.tag_id")
  tag_scope = ActsAsTaggableOn::Tag.select("#{ActsAsTaggableOn::Tag.table_name}.*").order(options[:order]).limit(options[:limit])

  # Joins and conditions
  tagging_conditions(options).each { |condition| tagging_scope = tagging_scope.where(condition) }
  tag_scope     = tag_scope.where(options[:conditions])

  group_columns = "#{ActsAsTaggableOn::Tagging.table_name}.tag_id"

  # 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}"
  tagging_scope = tagging_scope.where("#{ActsAsTaggableOn::Tagging.table_name}.taggable_id IN(#{safe_to_sql(select(scoped_select))})").group(group_columns)

  tag_scope_joins(tag_scope, tagging_scope)
end

- (Object) initialize_acts_as_taggable_on_collection



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

def initialize_acts_as_taggable_on_collection
  tag_types.map(&:to_s).each do |tag_type|
    class_eval <<-RUBY, __FILE__, __LINE__ + 1
      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
    RUBY
  end
end

- (Object) safe_to_sql(relation)



130
131
132
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/collection.rb', line 130

def safe_to_sql(relation)
  connection.respond_to?(:unprepared_statement) ? connection.unprepared_statement{relation.to_sql} : relation.to_sql
end

- (Object) tag_counts_on(context, options = {})



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

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

- (Object) tags_on(context, options = {})



40
41
42
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/collection.rb', line 40

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