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 



9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 9

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 



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

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

#all_tags_list_on(context) ⇒ Object 



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

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

  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



183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 183

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(Arel.sql("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 



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

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

#custom_contexts ⇒ Object 



133
134
135
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 133

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



129
130
131
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 129

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

#is_taggable? ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 137

def is_taggable?
  self.class.is_taggable?
end

#load_tags(tag_list) ⇒ Object

Find existing tags or create non-existing tags



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

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

#reload(*args) ⇒ Object 



227
228
229
230
231
232
233
234
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 227

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 



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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 242

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
    old_tags = current_tags - tags
    new_tags = tags - current_tags
    if self.class.preserve_tag_order?

      shared_tags = current_tags & tags

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

        # 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
    end

    # Destroy old taggings:
    taggings.not_owned.by_context(context).where(tag_id: old_tags).destroy_all if old_tags.present?

    # Create new taggings:
    new_tags.each do |tag|
      if taggable_tenant
        taggings.create!(tag_id: tag.id, context: context.to_s, taggable: self, tenant: taggable_tenant)
      else
        taggings.create!(tag_id: tag.id, context: context.to_s, taggable: self)
      end
    end
  end

  true
end

#set_tag_list_on(context, new_list) ⇒ Object 



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

def set_tag_list_on(context, new_list)
  add_custom_context(context)

  variable_name = "@#{context.to_s.singularize}_list"

  parsed_new_list = ActsAsTaggableOn.default_parser.new(new_list).parse

  instance_variable_set(variable_name, parsed_new_list)
end

#tag_list_cache_on(context) ⇒ Object 



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

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 



151
152
153
154
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 151

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 



167
168
169
170
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 167

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

#taggable_tenant ⇒ Object 



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

def taggable_tenant
  public_send(self.class.tenant_column) if self.class.tenant_column
end

#tagging_contexts ⇒ Object 



219
220
221
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 219

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



199
200
201
202
203
204
205
206
207
 
# File 'lib/acts_as_taggable_on/taggable/core.rb', line 199

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