Module: ActsAsTaggableOn::Taggable::Core::InstanceMethods

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

Instance Method Summary collapse

Instance Method Details

#add_custom_context(value) ⇒ Object 



233
234
235
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 233

def add_custom_context(value)
  custom_contexts << value.to_s unless custom_contexts.include?(value.to_s) or self.class.tag_types.map(&:to_s).include?(value.to_s)
end

#all_tags_list_on(context) ⇒ Object 



262
263
264
265
266
267
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 262

def all_tags_list_on(context)
  variable_name = "@all_#{context.to_s.singularize}_list"
  return instance_variable_get(variable_name) if instance_variable_defined?(variable_name) && instance_variable_get(variable_name)

  instance_variable_set(variable_name, ActsAsTaggableOn::TagList.new(all_tags_on(context).map(&:name)).freeze)
end

#all_tags_on(context) ⇒ Object

Returns all tags of a given context



271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 271

def all_tags_on(context)
  tag_table_name = ActsAsTaggableOn::Tag.table_name
  tagging_table_name = ActsAsTaggableOn::Tagging.table_name

  opts  =  ["#{tagging_table_name}.context = ?", context.to_s]
  scope = base_tags.where(opts)

  if ActsAsTaggableOn::Tag.using_postgresql?
    group_columns = grouped_column_names_for(ActsAsTaggableOn::Tag)
    scope.order("max(#{tagging_table_name}.created_at)").group(group_columns)
  else
    scope.group("#{ActsAsTaggableOn::Tag.table_name}.#{ActsAsTaggableOn::Tag.primary_key}")
  end.to_a
end

#cached_tag_list_on(context) ⇒ Object 



237
238
239
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 237

def cached_tag_list_on(context)
  self["cached_#{context.to_s.singularize}_list"]
end

#custom_contexts ⇒ Object 



225
226
227
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 225

def custom_contexts
  @custom_contexts ||= []
end

#grouped_column_names_for(object) ⇒ Object

all column names are necessary for PostgreSQL group clause



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

def grouped_column_names_for(object)
  self.class.grouped_column_names_for(object)
end

#is_taggable? ⇒ Boolean

Returns:

  • (Boolean) 


229
230
231
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 229

def is_taggable?
  self.class.is_taggable?
end

#load_tags(tag_list) ⇒ Object

Find existing tags or create non-existing tags



334
335
336
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 334

def load_tags(tag_list)
  ActsAsTaggableOn::Tag.find_or_create_all_with_like_by_name(tag_list)
end

#process_dirty_object(context, new_list) ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 309

def process_dirty_object(context,new_list)
  value = new_list.is_a?(Array) ? ActsAsTaggableOn::TagList.new(new_list) : new_list
  attrib = "#{context.to_s.singularize}_list"

  if changed_attributes.include?(attrib)
    # The attribute already has an unsaved change.
    old = changed_attributes[attrib]
    changed_attributes.delete(attrib) if (old.to_s == value.to_s)
  else
    old = tag_list_on(context).to_s
    changed_attributes[attrib] = old if (old.to_s != value.to_s)
  end
end

#reload(*args) ⇒ Object 



323
324
325
326
327
328
329
330
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 323

def reload(*args)
  self.class.tag_types.each do |context|
    instance_variable_set("@#{context.to_s.singularize}_list", nil)
    instance_variable_set("@all_#{context.to_s.singularize}_list", nil)
  end

  super(*args)
end

#save_tags ⇒ Object 



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 338

def save_tags
  tagging_contexts.each do |context|
    next unless tag_list_cache_set_on(context)
    # List of currently assigned tag names
    tag_list = tag_list_cache_on(context).uniq

    # Find existing tags or create non-existing tags:
    tags = load_tags(tag_list)

    # Tag objects for currently assigned tags
    current_tags = tags_on(context)

    # Tag maintenance based on whether preserving the created order of tags
    if self.class.preserve_tag_order?
      old_tags, new_tags = current_tags - tags, tags - current_tags

      shared_tags = current_tags & tags

      if shared_tags.any? && tags[0...shared_tags.size] != shared_tags
        index = shared_tags.each_with_index { |_, i| break i unless shared_tags[i] == tags[i] }

        # Update arrays of tag objects
        old_tags |= current_tags[index...current_tags.size]
        new_tags |= current_tags[index...current_tags.size] & shared_tags

        # Order the array of tag objects to match the tag list
        new_tags = tags.map do |t|
          new_tags.find { |n| n.name.downcase == t.name.downcase }
        end.compact
      end
    else
      # Delete discarded tags and create new tags
      old_tags = current_tags - tags
      new_tags = tags - current_tags
    end

    # Find taggings to remove:
    if old_tags.present?
      old_taggings = taggings.where(:tagger_type => nil, :tagger_id => nil, :context => context.to_s, :tag_id => old_tags)
    end

    # Destroy old taggings:
    if old_taggings.present?
      ActsAsTaggableOn::Tagging.destroy_all "#{ActsAsTaggableOn::Tagging.primary_key}".to_sym => old_taggings.map(&:id)
    end

    # Create new taggings:
    new_tags.each do |tag|
      taggings.create!(:tag_id => tag.id, :context => context.to_s, :taggable => self)
    end
  end

  true
end

#set_tag_list_on(context, new_list) ⇒ Object 



296
297
298
299
300
301
302
303
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 296

def set_tag_list_on(context, new_list)
  add_custom_context(context)

  variable_name = "@#{context.to_s.singularize}_list"
  process_dirty_object(context, new_list) unless custom_contexts.include?(context.to_s)

  instance_variable_set(variable_name, ActsAsTaggableOn::TagList.from(new_list))
end

#tag_list_cache_on(context) ⇒ Object 



246
247
248
249
250
251
252
253
254
255
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 246

def tag_list_cache_on(context)
  variable_name = "@#{context.to_s.singularize}_list"
  if instance_variable_get(variable_name)
    instance_variable_get(variable_name)
  elsif cached_tag_list_on(context) && self.class.caching_tag_list_on?(context)
    instance_variable_set(variable_name, ActsAsTaggableOn::TagList.from(cached_tag_list_on(context)))
  else
    instance_variable_set(variable_name, ActsAsTaggableOn::TagList.new(tags_on(context).map(&:name)))
  end
end

#tag_list_cache_set_on(context) ⇒ Object 



241
242
243
244
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 241

def tag_list_cache_set_on(context)
  variable_name = "@#{context.to_s.singularize}_list"
  instance_variable_defined?(variable_name) && !instance_variable_get(variable_name).nil?
end

#tag_list_on(context) ⇒ Object 



257
258
259
260
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 257

def tag_list_on(context)
  add_custom_context(context)
  tag_list_cache_on(context)
end

#tagging_contexts ⇒ Object 



305
306
307
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 305

def tagging_contexts
  custom_contexts + self.class.tag_types.map(&:to_s)
end

#tags_on(context) ⇒ Object

Returns all tags that are not owned of a given context



288
289
290
291
292
293
294
 
# File 'lib/acts_as_taggable_on/acts_as_taggable_on/core.rb', line 288

def tags_on(context)
  scope = base_tags.where(["#{ActsAsTaggableOn::Tagging.table_name}.context = ? AND #{ActsAsTaggableOn::Tagging.table_name}.tagger_id IS NULL", context.to_s])
  # when preserving tag order, return tags in created order
  # if we added the order to the association this would always apply
  scope = scope.order("#{ActsAsTaggableOn::Tagging.table_name}.id") if self.class.preserve_tag_order?
  scope
end