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 



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

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 



118
119
120
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 118

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 



147
148
149
150
151
152
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 147

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



156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 156

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 



122
123
124
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 122

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

#custom_contexts ⇒ Object 



110
111
112
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 110

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



106
107
108
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 106

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

#is_taggable? ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 114

def is_taggable?
  self.class.is_taggable?
end

#load_tags(tag_list) ⇒ Object

Find existing tags or create non-existing tags



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

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 



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 193

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 



211
212
213
214
215
216
217
218
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 211

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 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 226

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 



180
181
182
183
184
185
186
187
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 180

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 



131
132
133
134
135
136
137
138
139
140
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 131

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) && ensure_included_cache_methods! && 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 



126
127
128
129
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 126

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 



142
143
144
145
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 142

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

#tagging_contexts ⇒ Object 



189
190
191
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 189

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



172
173
174
175
176
177
178
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 172

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