Module: ActsAsTaggableOn::Taggable::Core

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

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 3

def self.included(base)
  base.extend ActsAsTaggableOn::Taggable::Core::ClassMethods

  base.class_eval do
    attr_writer :custom_contexts
    after_save :save_tags
  end

  base.initialize_acts_as_taggable_on_core
end

Instance Method Details

#add_custom_context(value) ⇒ Object 



269
270
271
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 269

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 



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

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



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

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

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

  if ActsAsTaggableOn::Utils.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 



273
274
275
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 273

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

#custom_contexts ⇒ Object 



261
262
263
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 261

def custom_contexts
  @custom_contexts ||= taggings.map(&:context).uniq
end

#grouped_column_names_for(object) ⇒ Object

all column names are necessary for PostgreSQL group clause



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

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

#is_taggable? ⇒ Boolean

Returns:

  • (Boolean) 


265
266
267
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 265

def is_taggable?
  self.class.is_taggable?
end

#load_tags(tag_list) ⇒ Object

Find existing tags or create non-existing tags



373
374
375
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 373

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 



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 344

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)
    if self.class.preserve_tag_order
      @changed_attributes[attrib] = old if old.to_s != value.to_s
    else
      @changed_attributes[attrib] = old.to_s if old.sort != ActsAsTaggableOn.default_parser.new(value).parse.sort
    end
  end
end

#reload(*args) ⇒ Object 



362
363
364
365
366
367
368
369
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 362

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 



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 377

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 = find_or_create_tags_from_list_with_context(tag_list, context)

    # 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

    # Destroy old taggings:
    if old_tags.present?
      taggings.not_owned.by_context(context).where(tag_id: old_tags).destroy_all
    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 



331
332
333
334
335
336
337
338
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 331

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.default_parser.new(new_list).parse)
end

#tag_list_cache_on(context) ⇒ Object 



282
283
284
285
286
287
288
289
290
291
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 282

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.default_parser.new(cached_tag_list_on(context)).parse)
  else
    instance_variable_set(variable_name, ActsAsTaggableOn::TagList.new(tags_on(context).map(&:name)))
  end
end

#tag_list_cache_set_on(context) ⇒ Object 



277
278
279
280
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 277

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

#tag_list_on(context) ⇒ Object 



293
294
295
296
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 293

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

#tagging_contexts ⇒ Object 



340
341
342
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 340

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

#tags_on(context) ⇒ Object

Returns all tags that are not owned of a given context



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

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