Module: ActsAsTaggableOn::Taggable::Core::ClassMethods

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

Instance Method Summary (collapse)

Instance Method Details

- (Object) adjust_taggings_alias(taggings_alias)



220
221
222
223
224
225
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 220

def adjust_taggings_alias(taggings_alias)
  if taggings_alias.size > 75
    taggings_alias = 'taggings_alias_' + Digest::SHA1.hexdigest(taggings_alias)
  end
  taggings_alias
end

- (Object) grouped_column_names_for(object)

all column names are necessary for PostgreSQL group clause



63
64
65
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 63

def grouped_column_names_for(object)
  object.column_names.map { |column| "#{object.table_name}.#{column}" }.join(", ")
end

- (Object) initialize_acts_as_taggable_on_core



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
51
52
53
54
55
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 16

def initialize_acts_as_taggable_on_core
  include taggable_mixin
  tag_types.map(&:to_s).each do |tags_type|
    tag_type         = tags_type.to_s.singularize
    context_taggings = "#{tag_type}_taggings".to_sym
    context_tags     = tags_type.to_sym
    taggings_order   = (preserve_tag_order? ? "#{ActsAsTaggableOn::Tagging.table_name}.id" : [])

    class_eval do
      # when preserving tag order, include order option so that for a 'tags' context
      # the associations tag_taggings & tags are always returned in created order
      has_many_with_compatibility context_taggings, :as => :taggable,
                                  :dependent => :destroy,
                                  :class_name => "ActsAsTaggableOn::Tagging",
                                  :order => taggings_order,
                                  :conditions => ["#{ActsAsTaggableOn::Tagging.table_name}.context = (?)", tags_type],
                                  :include => :tag

      has_many_with_compatibility context_tags, :through => context_taggings,
                                  :source => :tag,
                                  :class_name => "ActsAsTaggableOn::Tag",
                                  :order => taggings_order

    end

    taggable_mixin.class_eval <<-RUBY, __FILE__, __LINE__ + 1
      def #{tag_type}_list
        tag_list_on('#{tags_type}')
      end

      def #{tag_type}_list=(new_tags)
        set_tag_list_on('#{tags_type}', new_tags)
      end

      def all_#{tags_type}_list
        all_tags_list_on('#{tags_type}')
      end
    RUBY
  end
end

- (Boolean) is_taggable?

Returns:

  • (Boolean)


216
217
218
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 216

def is_taggable?
  true
end

- (Object) taggable_mixin



227
228
229
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 227

def taggable_mixin
  @taggable_mixin ||= Module.new
end

- (Object) taggable_on(preserve_tag_order, *tag_types)



57
58
59
60
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 57

def taggable_on(preserve_tag_order, *tag_types)
  super(preserve_tag_order, *tag_types)
  initialize_acts_as_taggable_on_core
end

- (Object) tagged_with(tags, options = {})

Return a scope of objects that are tagged with the specified tags.

Example:

User.tagged_with("awesome", "cool")                     # Users that are tagged with awesome and cool
User.tagged_with("awesome", "cool", :exclude => true)   # Users that are not tagged with awesome or cool
User.tagged_with("awesome", "cool", :any => true)       # Users that are tagged with awesome or cool
User.tagged_with("awesome", "cool", :any => true, :order_by_matching_tag_count => true)  # Sort by users who match the most tags, descending
User.tagged_with("awesome", "cool", :match_all => true) # Users that are tagged with just awesome and cool
User.tagged_with("awesome", "cool", :owned_by => foo ) # Users that are tagged with just awesome and cool by 'foo'

Parameters:

  • tags

    The tags that we want to query for

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

    A hash of options to alter you query:

    • :exclude - if set to true, return objects that are NOT tagged with the specified tags

    • :any - if set to true, return objects that are tagged with ANY of the specified tags

    • :order_by_matching_tag_count - if set to true and used with :any, sort by objects matching the most tags, descending

    • :match_all - if set to true, return objects that are ONLY tagged with the specified tags

    • :owned_by - return objects that are ONLY owned by the owner



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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 85

def tagged_with(tags, options = {})
  tag_list = ActsAsTaggableOn::TagList.from(tags)
  empty_result = where("1 = 0")

  return empty_result if tag_list.empty?

  joins = []
  conditions = []
  having = []
  select_clause = []
  order_by = []

  context = options.delete(:on)
  owned_by = options.delete(:owned_by)
  alias_base_name = undecorated_table_name.gsub('.','_')
  quote = ActsAsTaggableOn::Tag.using_postgresql? ? '"' : ''

  if options.delete(:exclude)
    if options.delete(:wild)
      tags_conditions = tag_list.map { |t| sanitize_sql(["#{ActsAsTaggableOn::Tag.table_name}.name #{like_operator} ? ESCAPE '!'", "%#{escape_like(t)}%"]) }.join(" OR ")
    else
      tags_conditions = tag_list.map { |t| sanitize_sql(["#{ActsAsTaggableOn::Tag.table_name}.name #{like_operator} ?", t]) }.join(" OR ")
    end

    conditions << "#{table_name}.#{primary_key} NOT IN (SELECT #{ActsAsTaggableOn::Tagging.table_name}.taggable_id FROM #{ActsAsTaggableOn::Tagging.table_name} JOIN #{ActsAsTaggableOn::Tag.table_name} ON #{ActsAsTaggableOn::Tagging.table_name}.tag_id = #{ActsAsTaggableOn::Tag.table_name}.#{ActsAsTaggableOn::Tag.primary_key} AND (#{tags_conditions}) WHERE #{ActsAsTaggableOn::Tagging.table_name}.taggable_type = #{quote_value(base_class.name, nil)})"

    if owned_by
      joins <<  "JOIN #{ActsAsTaggableOn::Tagging.table_name}" +
                "  ON #{ActsAsTaggableOn::Tagging.table_name}.taggable_id = #{quote}#{table_name}#{quote}.#{primary_key}" +
                " AND #{ActsAsTaggableOn::Tagging.table_name}.taggable_type = #{quote_value(base_class.name, nil)}" +
                " AND #{ActsAsTaggableOn::Tagging.table_name}.tagger_id = #{quote_value(owned_by.id, nil)}" +
                " AND #{ActsAsTaggableOn::Tagging.table_name}.tagger_type = #{quote_value(owned_by.class.base_class.to_s, nil)}"
    end

  elsif options.delete(:any)
    # get tags, drop out if nothing returned (we need at least one)
    tags = if options.delete(:wild)
      ActsAsTaggableOn::Tag.named_like_any(tag_list)
    else
      ActsAsTaggableOn::Tag.named_any(tag_list)
    end

    return empty_result unless tags.length > 0

    # setup taggings alias so we can chain, ex: items_locations_taggings_awesome_cool_123
    # avoid ambiguous column name
    taggings_context = context ? "_#{context}" : ''

    taggings_alias   = adjust_taggings_alias(
      "#{alias_base_name[0..4]}#{taggings_context[0..6]}_taggings_#{sha_prefix(tags.map(&:name).join('_'))}"
    )

    tagging_join  = "JOIN #{ActsAsTaggableOn::Tagging.table_name} #{taggings_alias}" +
                    "  ON #{taggings_alias}.taggable_id = #{quote}#{table_name}#{quote}.#{primary_key}" +
                    " AND #{taggings_alias}.taggable_type = #{quote_value(base_class.name, nil)}"
    tagging_join << " AND " + sanitize_sql(["#{taggings_alias}.context = ?", context.to_s]) if context

    # don't need to sanitize sql, map all ids and join with OR logic
    conditions << tags.map { |t| "#{taggings_alias}.tag_id = #{quote_value(t.id, nil)}" }.join(" OR ")
    select_clause = " #{table_name}.*" unless context and tag_types.one?

    if owned_by
        tagging_join << " AND " +
            sanitize_sql([
                "#{taggings_alias}.tagger_id = ? AND #{taggings_alias}.tagger_type = ?",
                owned_by.id,
                owned_by.class.base_class.to_s
            ])
    end

    joins << tagging_join
  else
    tags = ActsAsTaggableOn::Tag.named_any(tag_list)

    return empty_result unless tags.length == tag_list.length

    tags.each do |tag|
      taggings_alias = adjust_taggings_alias("#{alias_base_name[0..11]}_taggings_#{sha_prefix(tag.name)}")
      tagging_join  = "JOIN #{ActsAsTaggableOn::Tagging.table_name} #{taggings_alias}" +
                      "  ON #{taggings_alias}.taggable_id = #{quote}#{table_name}#{quote}.#{primary_key}" +
                      " AND #{taggings_alias}.taggable_type = #{quote_value(base_class.name, nil)}" +
                      " AND #{taggings_alias}.tag_id = #{quote_value(tag.id, nil)}"

      tagging_join << " AND " + sanitize_sql(["#{taggings_alias}.context = ?", context.to_s]) if context

      if owned_by
          tagging_join << " AND " +
            sanitize_sql([
              "#{taggings_alias}.tagger_id = ? AND #{taggings_alias}.tagger_type = ?",
              owned_by.id,
              owned_by.class.base_class.to_s
            ])
      end

      joins << tagging_join
    end
  end

  group = [] # Rails interprets this as a no-op in the group() call below
  if options.delete(:order_by_matching_tag_count)
    select_clause = "#{table_name}.*, COUNT(#{taggings_alias}.tag_id) AS #{taggings_alias}_count"
    group_columns = ActsAsTaggableOn::Tag.using_postgresql? ? grouped_column_names_for(self) : "#{table_name}.#{primary_key}"
    group = group_columns
    order_by << "#{taggings_alias}_count DESC"

  elsif options.delete(:match_all)
    taggings_alias, _ = adjust_taggings_alias("#{alias_base_name}_taggings_group"), "#{alias_base_name}_tags_group"
    joins << "LEFT OUTER JOIN #{ActsAsTaggableOn::Tagging.table_name} #{taggings_alias}" +
             "  ON #{taggings_alias}.taggable_id = #{quote}#{table_name}#{quote}.#{primary_key}" +
             " AND #{taggings_alias}.taggable_type = #{quote_value(base_class.name, nil)}"

    joins << " AND " + sanitize_sql(["#{taggings_alias}.context = ?", context.to_s]) if context

    group_columns = ActsAsTaggableOn::Tag.using_postgresql? ? grouped_column_names_for(self) : "#{table_name}.#{primary_key}"
    group = group_columns
    having = "COUNT(#{taggings_alias}.taggable_id) = #{tags.size}"
  end

  order_by << options[:order] if options[:order].present?

  request = select(select_clause).
    joins(joins.join(" ")).
    where(conditions.join(" AND ")).
    group(group).
    having(having).
    order(order_by.join(", ")).
    readonly(false)

  ((context and tag_types.one?) && options.delete(:any)) ? request : request.uniq
end