acts-as-taggable-on-mongoid 6.0.1.4 → 6.1.1.11

data/lib/acts_as_taggable_on_mongoid/taggable/list_tags.rb

@@ -58,6 +58,7 @@ module ActsAsTaggableOnMongoid
           self.my_tag_types = new_tag_types
           tag_definition    = new_tag_types[tag_type] = ActsAsTaggableOnMongoid::Taggable::TagTypeDefinition.new(self, tag_type, options)
 
+          tag_definition.define_cache_field
           tag_definition.define_base_relations
           tag_definition.define_relations
           tag_definition.add_tag_list

data/lib/acts_as_taggable_on_mongoid/taggable/tag_type_definition.rb

@@ -13,27 +13,20 @@ module ActsAsTaggableOnMongoid
       attr_reader :owner,
                   :tag_type
 
+      include ActsAsTaggableOnMongoid::Taggable::TagTypeDefinition::ListMethods
       include ActsAsTaggableOnMongoid::Taggable::TagTypeDefinition::Attributes
       include ActsAsTaggableOnMongoid::Taggable::TagTypeDefinition::Names
       include ActsAsTaggableOnMongoid::Taggable::TagTypeDefinition::Changeable
 
       def initialize(owner, tag_type, options = {})
-        options = options.dup
+        options = ActsAsTaggableOnMongoid::Taggable::TagTypeDefinition.extract_tag_definition_options(options)
 
-        options.assert_valid_keys(:parser,
-                                  :preserve_tag_order,
-                                  :cached_in_model,
-                                  :force_lowercase,
-                                  :force_parameterize,
-                                  :remove_unused_tags,
-                                  :tags_table,
-                                  :taggings_table,
-                                  :default)
-
-        self.default_value = options.delete(:default)
+        default_option = options.delete(:default)
 
         save_options(options)
 
+        self.default_value = default_option
+
         @owner    = owner
         @tag_type = tag_type
       end
@@ -44,11 +37,12 @@ module ActsAsTaggableOnMongoid
                       cached_in_model
                       force_lowercase
                       force_parameterize
+                      owner_id_field
                       remove_unused_tags
                       tags_table
                       taggings_table].each_with_object({}) { |dup_key, opts_hash| opts_hash[dup_key] = tag_definition.public_send(dup_key) }
 
-        dup_hash[:default] = [tag_definition.default, parse: false]
+        dup_hash[:default] = tag_definition.default.dup
 
         ActsAsTaggableOnMongoid::Taggable::TagTypeDefinition.new klass,
                                                                  tag_definition.tag_type,
@@ -83,6 +77,18 @@ module ActsAsTaggableOnMongoid
                           end
       end
 
+      def define_cache_field
+        tag_definition = self
+
+        return unless tag_definition.cached_in_model?
+
+        owner.class_eval do
+          field_type = tag_definition.cached_in_model_as_list? ? Array : String
+
+          field tag_definition.cached_in_model_field, type: field_type
+        end
+      end
+
       def define_base_relations
         tag_definition = self
 
@@ -155,55 +161,42 @@ module ActsAsTaggableOnMongoid
       def add_tag_list
         add_list_getter
         add_list_setter
+        add_tag_list_from
+        add_tagger_tag_list
+        add_tagger_tag_lists
         add_all_list_getter
         add_list_exists
+
+        add_tag_list_change_methods
+      end
+
+      def add_tag_list_change_methods
         add_list_change
         add_list_changed
         add_changed_from_default?
         add_will_change
         add_get_was
+        add_get_lists_was
+        add_tagger_get_was
         add_reset_list
         add_reset_to_default
       end
 
-      def add_list_getter
-        tag_definition = self
-        tag_list_name  = tag_definition.tag_list_name
-
-        owner.taggable_mixin.module_eval do
-          define_method(tag_list_name) do
-            tag_list_on tag_definition
-          end
-
-          alias_method "#{tag_list_name}_before_type_cast".to_sym, tag_list_name.to_sym
-        end
-      end
-
-      def add_list_setter
-        tag_definition = self
-
-        owner.taggable_mixin.module_eval do
-          define_method("#{tag_definition.tag_list_name}=") do |new_tags|
-            dup_tags        = Array.wrap(new_tags).dup
-            options         = dup_tags.extract_options!.dup
-            options[:parse] = options.fetch(:parse) { true }
-
-            new_list = tag_definition.parse(*dup_tags, options)
-
-            mark_tag_list_changed(new_list)
-            tag_list_set(new_list)
-          end
-        end
-      end
-
-      def add_all_list_getter
-        tag_definition = self
+      def self.extract_tag_definition_options(options)
+        options = options.dup
 
-        owner.taggable_mixin.module_eval do
-          define_method(tag_definition.all_tag_list_name) do
-            all_tags_list_on tag_definition
-          end
-        end
+        options.assert_valid_keys(:parser,
+                                  :preserve_tag_order,
+                                  :cached_in_model,
+                                  :force_lowercase,
+                                  :force_parameterize,
+                                  :owner_id_field,
+                                  :remove_unused_tags,
+                                  :tags_table,
+                                  :taggings_table,
+                                  :default,
+                                  :tagger)
+        options
       end
 
       private

data/lib/acts_as_taggable_on_mongoid/taggable/tag_type_definition/attributes.rb

@@ -3,13 +3,10 @@
 module ActsAsTaggableOnMongoid
   module Taggable
     class TagTypeDefinition
-      # This module extracts out the basic configuration type attributes of the tag definition.
-      #
-      # All attributes are based off of the Configuration class and in fact will default to
-      # the corresponding value in the configuration if not explicitly specified/set when the
-      # tag is defined.
+      # This module defines methods used to evaluate the attributes of the Tag Type Definition
       module Attributes
         attr_reader :cached_in_model,
+                    :owner_id_field,
                     :default
 
         def parser
@@ -56,20 +53,87 @@ module ActsAsTaggableOnMongoid
           end
         end
 
+        def cached_in_model_field
+          @cached_in_model_field ||= cache_hash.fetch(:field) { "cached_#{tag_list_name}" }
+        end
+
+        def cached_in_model_as_list?
+          @cached_in_model_as_list ||= cache_hash.fetch(:as_list) { true }
+        end
+
         alias preserve_tag_order? preserve_tag_order
         alias cached_in_model? cached_in_model
         alias force_lowercase? force_lowercase
         alias force_parameterize? force_parameterize
         alias remove_unused_tags? remove_unused_tags
 
+        def tagger?
+          instance_variable_defined?(:@tagger)
+        end
+
+        def tag_list_uses_default_tagger?
+          return false if !tagger? || default_tagger_method.blank?
+
+          tagger_params.fetch(:tag_list_uses_default_tagger) { false }
+        end
+
+        def default_tagger_method
+          return nil unless tagger?
+
+          tagger_params[:default_tagger]
+        end
+
+        # :reek:FeatureEnvy
+        # :reek:DuplicateMethodCall
+        def taggable_default(taggable)
+          default_list = default
+
+          return unless default_list.present?
+
+          default_list          = default_list.dup
+          default_list.taggable = taggable
+          default_list.tagger   = default_list.tagger
+
+          default_list
+        end
+
+        def default_tagger(taggable)
+          return nil if default_tagger_method.nil?
+          return nil if taggable.blank?
+
+          taggable.public_send(default_tagger_method)
+        end
+
+        def tag_list_default_tagger(taggable)
+          return nil unless tag_list_uses_default_tagger?
+
+          default_tagger(taggable)
+        end
+
         private
 
+        def cache_hash
+          @cache_hash ||= cached_in_model.is_a?(Hash) ? cached_in_model : {}
+        end
+
+        def tagger_params
+          return @tagger_params if defined?(@tagger_params)
+
+          params = instance_variable_get(:@tagger)
+
+          @tagger_params = if tagger? && params.is_a?(Hash)
+                             params.with_indifferent_access
+                           else
+                             HashWithIndifferentAccess.new
+                           end
+        end
+
         def default_value=(value)
           dup_value       = Array.wrap(value).dup
           options         = dup_value.extract_options!.dup
           options[:parse] = options.fetch(:parse) { true }
 
-          @default = ActsAsTaggableOnMongoid::TagList.new self, dup_value, options
+          @default = ActsAsTaggableOnMongoid::TagList.new self, *dup_value, options
         end
       end
     end

data/lib/acts_as_taggable_on_mongoid/taggable/tag_type_definition/changeable.rb

@@ -11,16 +11,36 @@ module ActsAsTaggableOnMongoid
       #   * tag_list_will_change!
       #   * tag_list_changed_from_default?
       #   * tag_list_was
+      #   * tagger_tag_list_was
+      #   * tag_lists_was
       #   * reset_tag_list!
       #   * reset_tag_list_to_default!
+
+      # :reek:FeatureEnvy
+      # :reek:DuplicateMethodCall
       module Changeable
+        def default_tagger_tag_list(taggable)
+          list = ActsAsTaggableOnMongoid::TaggerTagList.new(self, nil)
+
+          list_default              = default.dup
+          list_default.taggable     = taggable
+          list_default.tagger       = list_default.tagger
+          list[list_default.tagger] = list_default
+
+          list.taggable = taggable
+
+          list
+        end
+
+        private
+
         def add_list_exists
           tag_definition = self
           tag_list_name  = tag_definition.tag_list_name
 
           owner.taggable_mixin.module_eval do
             define_method("#{tag_list_name}?") do
-              public_send(tag_list_name).present?
+              tag_list_cache_on(tag_definition).values.any?(&:present?)
             end
           end
         end
@@ -31,48 +51,29 @@ module ActsAsTaggableOnMongoid
 
           owner.taggable_mixin.module_eval do
             define_method("#{tag_list_name}_change") do
-              return nil unless public_send("#{tag_list_name}_changed?")
-
-              changed_value = public_send("#{tag_list_name}_was")
-              current_value = public_send(tag_list_name)
-
-              [changed_value, current_value] unless current_value == changed_value
+              get_tag_list_change(tag_definition)
             end
           end
         end
 
-        # rubocop:disable Metrics/AbcSize
-
         def add_list_changed
           tag_definition = self
           tag_list_name  = tag_definition.tag_list_name
 
           owner.taggable_mixin.module_eval do
             define_method("#{tag_list_name}_changed?") do
-              return false unless changed_attributes.key?(tag_list_name)
-
-              changed_value = new_record? ? tag_definition.default : changed_attributes[tag_list_name]
-              current_value = public_send(tag_list_name)
-
-              unless tag_definition.preserve_tag_order?
-                changed_value.sort!
-                current_value.sort!
-              end
-
-              current_value != changed_value
+              get_tag_list_changed(tag_definition)
             end
           end
         end
 
-        # rubocop:enable Metrics/AbcSize
-
         def add_will_change
           tag_definition = self
           tag_list_name  = tag_definition.tag_list_name
 
           owner.taggable_mixin.module_eval do
             define_method("#{tag_list_name}_will_change!") do
-              attribute_wil_change! tag_list_name
+              attribute_will_change! tag_list_name
             end
           end
         end
@@ -83,15 +84,10 @@ module ActsAsTaggableOnMongoid
 
           owner.taggable_mixin.module_eval do
             define_method("#{tag_list_name}_changed_from_default?") do
-              changed_value = tag_definition.default
-              current_value = public_send(tag_list_name)
-
-              unless tag_definition.preserve_tag_order?
-                changed_value.sort!
-                current_value.sort!
-              end
+              changed_value = tag_definition.default_tagger_tag_list(self)
+              current_value = tag_list_cache_on(tag_definition)
 
-              current_value != changed_value
+              !(changed_value <=> current_value)&.zero?
             end
           end
         end
@@ -102,13 +98,28 @@ module ActsAsTaggableOnMongoid
 
           owner.taggable_mixin.module_eval do
             define_method("#{tag_list_name}_was") do
-              return tag_definition.default if new_record?
+              get_tag_list_was tag_definition
+            end
+          end
+        end
+
+        def add_get_lists_was
+          tag_definition = self
 
-              if public_send "#{tag_list_name}_changed?"
-                changed_attributes[tag_list_name]
-              else
-                public_send tag_list_name
-              end
+          owner.taggable_mixin.module_eval do
+            define_method("#{tag_definition.tagger_tag_lists_name}_was") do
+              get_tag_lists_was(tag_definition)
+            end
+          end
+        end
+
+        def add_tagger_get_was
+          tag_definition = self
+          tag_list_name  = tag_definition.tag_list_name
+
+          owner.taggable_mixin.module_eval do
+            define_method("tagger_#{tag_list_name}_was") do |tagger|
+              get_tagger_list_was(tag_definition, tagger)
             end
           end
         end
@@ -119,7 +130,9 @@ module ActsAsTaggableOnMongoid
 
           owner.taggable_mixin.module_eval do
             define_method("reset_#{tag_list_name}!") do
-              public_send "#{tag_list_name}=", public_send("#{tag_list_name}_was")
+              return unless public_send("#{tag_list_name}_changed?")
+
+              tagger_tag_list_set(changed_attributes[tag_list_name].dup)
             end
           end
         end
@@ -130,7 +143,7 @@ module ActsAsTaggableOnMongoid
 
           owner.taggable_mixin.module_eval do
             define_method("reset_#{tag_list_name}_to_default!") do
-              public_send "#{tag_list_name}=", tag_definition.default
+              tagger_tag_list_set(tag_definition.default_tagger_tag_list(self))
             end
           end
         end

data/lib/acts_as_taggable_on_mongoid/taggable/tag_type_definition/list_methods.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ActsAsTaggableOnMongoid
+  module Taggable
+    class TagTypeDefinition
+      # This module extracts out the methods used to add list methods to the taggable object
+      module ListMethods
+        def add_list_getter
+          tag_definition = self
+          tag_list_name  = tag_definition.tag_list_name
+
+          owner.taggable_mixin.module_eval do
+            define_method(tag_list_name) do
+              tag_list_on tag_definition
+            end
+
+            alias_method "#{tag_list_name}_before_type_cast".to_sym, tag_list_name.to_sym
+          end
+        end
+
+        def add_list_setter
+          tag_definition = self
+
+          owner.taggable_mixin.module_eval do
+            define_method("#{tag_definition.tag_list_name}=") do |new_tags|
+              set_tag_list(tag_definition, new_tags)
+            end
+          end
+        end
+
+        def add_all_list_getter
+          tag_definition = self
+
+          owner.taggable_mixin.module_eval do
+            define_method(tag_definition.all_tag_list_name) do
+              all_tags_list_on tag_definition
+            end
+          end
+        end
+
+        def add_tagger_tag_list
+          tag_definition = self
+          tag_list_name  = tag_definition.tagger_tag_list_name
+
+          owner.taggable_mixin.module_eval do
+            define_method(tag_list_name) do |owner|
+              return nil unless tag_definition.tagger?
+
+              tag_list_cache_on(tag_definition)[owner]
+            end
+          end
+        end
+
+        def add_tag_list_from
+          tag_definition = self
+
+          owner.taggable_mixin.module_eval do
+            define_method(tag_definition.from_list_name) do |owner|
+              public_send(tag_definition.tagger_tag_list_name, owner)
+            end
+          end
+        end
+
+        def add_tagger_tag_lists
+          tag_definition = self
+          tag_list_name  = tag_definition.tagger_tag_lists_name
+
+          owner.taggable_mixin.module_eval do
+            define_method(tag_list_name) do
+              tag_list_cache_on(tag_definition)
+            end
+          end
+        end
+      end
+    end
+  end
+end