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

data/acts-as-taggable-on-mongoid.gemspec

@@ -31,11 +31,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", "~> 4.2"
-  spec.add_dependency "mongoid", "~> 5.2"
+  spec.add_dependency "activesupport", ">= 5.0"
+  spec.add_dependency "mongoid", ">= 6.1.1", "<= 7.0.2"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "codecov", "~> 0.1", "~> 0.1.0"
+  spec.add_development_dependency "codecov", "~> 0.1", "~> 0.2.2"
   spec.add_development_dependency "cornucopia"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "pronto"
@@ -45,10 +44,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pronto-rails_best_practices"
   spec.add_development_dependency "pronto-reek"
   spec.add_development_dependency "pronto-rubocop"
-  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec_junit_formatter", "~> 0.4.1"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-rcov"
   spec.add_development_dependency "timecop"

data/lib/acts-as-taggable-on-mongoid.rb

@@ -11,11 +11,13 @@ module ActsAsTaggableOnMongoid
   eager_autoload do
     autoload :Configuration
     autoload :TagList
+    autoload :TaggerTagList
     autoload :GenericParser
     autoload :DefaultParser
     # autoload :TagsHelper
 
     autoload_under "taggable/tag_type_definition" do
+      autoload :ListMethods
       autoload :Attributes
       autoload "Changeable"
       autoload :Names
@@ -34,7 +36,7 @@ module ActsAsTaggableOnMongoid
     end
 
     autoload_under :Taggable do
-      #   autoload :Cache
+      autoload :Cache
       #   autoload :Collection
       autoload :Core
       autoload :Changeable
@@ -42,14 +44,20 @@ module ActsAsTaggableOnMongoid
       autoload :ListTags
       autoload :TaggedWith
       autoload :TaggedWithQuery
-      #   autoload :Ownership
+      autoload :TaggerRelation
       #   autoload :Related
     end
 
+    autoload_under :Tagger do
+      autoload "TagMethods"
+    end
+
     autoload :Taggable
+    autoload :Tagger
 
     autoload_under "models/concerns" do
       autoload :TagFields
+      autoload :TagHooks
       autoload :TagAssociations
       autoload :TagValidations
       autoload :TagScopes
@@ -67,7 +75,6 @@ module ActsAsTaggableOnMongoid
     autoload_under :Models do
       autoload :Tag
       autoload :Tagging
-      # autoload :Tagger
     end
 
     autoload_under :Errors do
@@ -102,5 +109,5 @@ end
 
 ::ActiveSupport.on_load(:mongoid) do
   include ActsAsTaggableOnMongoid::Taggable
-  # include ActsAsTaggableOn::Tagger
+  include ActsAsTaggableOnMongoid::Tagger
 end

data/lib/acts_as_taggable_on_mongoid/models/concerns/tag_associations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsTaggableOnMongoid
   module Models
     module Concerns
@@ -8,6 +10,18 @@ module ActsAsTaggableOnMongoid
           ### ASSOCIATIONS:
 
           has_many :taggings, dependent: :destroy, class_name: "ActsAsTaggableOnMongoid::Models::Tagging"
+          belongs_to :owner, polymorphic: true, optional: true, index: true
+
+          after_save :atom_unset_blank_owner
+        end
+
+        private
+
+        def atom_unset_blank_owner
+          return if !attributes.key?("owner_id") && !attributes.key?("owner_type")
+          return if owner_id.present? && owner_type.present?
+
+          unset(:owner_id, :owner_type)
         end
       end
     end

data/lib/acts_as_taggable_on_mongoid/models/concerns/tag_fields.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsTaggableOnMongoid
   module Models
     module Concerns
@@ -15,7 +17,10 @@ module ActsAsTaggableOnMongoid
 
           # field :type, type: String
 
-          index({ name: 1, taggable_type: 1, context: 1 }, unique: true)
+          index({ name: 1, context: 1, taggable_type: 1, owner_id: 1, owner_type: 1 },
+                unique: true,
+                name:   "name_taggable_type_context_owner")
+          index(owner_id: 1, owner_type: 1)
         end
       end
     end

data/lib/acts_as_taggable_on_mongoid/models/concerns/tag_hooks.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module ActsAsTaggableOnMongoid
+  module Models
+    module Concerns
+      # Update and Destroy hooks for tags to update denormalized data.
+      #
+      # NOTE:  If the tag is cached AND owned, assumptions are made about the
+      #        relationship of a Tag to the Taggings and the taggable_type.
+      #
+      #        Specifically, the taggable_type is assumed to have an ID field that
+      #        matches the owner.  This field can be specified in the tag_definition
+      #        as owner_id_field.
+      #
+      #        If there isn't a simple relationship like this then override the following
+      #        methods to update the cached data properly:
+      #         * remove_cached_taggings
+      #         * update_cached_taggings
+      module TagHooks
+        extend ActiveSupport::Concern
+
+        included do
+          after_update :denormalize_tag_name
+          after_destroy :remove_cached_taggings
+        end
+
+        private
+
+        def denormalize_tag_name
+          return unless name_changed?
+
+          update_taggings
+          update_cached_taggings
+        end
+
+        def update_taggings
+          taggings.update_all(tag_name: name)
+        end
+
+        def remove_cached_taggings
+          return if tag_definition.blank?
+          return unless tag_definition.cached_in_model?
+
+          cached_fields_query(name).update_all("$pull" => { "cached_#{tag_definition.tag_list_name}" => name })
+        end
+
+        def update_cached_taggings
+          return if tag_definition.blank?
+          return unless tag_definition.cached_in_model?
+
+          cached_fields_query(name_was).update_all("$set" => { "cached_#{tag_definition.tag_list_name}.$" => name })
+        end
+
+        def cached_fields_query(chached_field_value)
+          query = { "cached_#{tag_definition.tag_list_name}" => chached_field_value }
+
+          if owner_id.present?
+            id_field = tag_definition.owner_id_field || "#{owner_type.underscore}_id"
+
+            query[id_field] = owner_id
+          end
+
+          taggable_type.constantize.unscoped.where(query)
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on_mongoid/models/concerns/tag_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsTaggableOnMongoid
   module Models
     module Concerns
@@ -6,49 +8,55 @@ module ActsAsTaggableOnMongoid
 
         ### CLASS METHODS:
 
+        # rubocop:disable Metrics/BlockLength
         class_methods do
-          def find_or_create_all_with_like_by_name(tag_definition, *list)
+          def find_or_create_tagger_list_with_like_by_name(tag_definition, tagger_list)
+            tagger_list.each_with_object([]) do |(tagger, tag_list), array|
+              array.concat find_or_create_all_with_like_by_name_owner tag_definition, tagger, tag_list
+            end
+          end
+
+          def find_or_create_all_with_like_by_name_owner(tag_definition, owner, *list)
             list = ActsAsTaggableOnMongoid::TagList.new(tag_definition, *Array.wrap(list).flatten)
 
             return [] if list.empty?
 
             list.map do |tag_name|
-              begin
-                tries ||= 3
+              tries ||= 3
 
-                existing_tag = tag_definition.tags_table.for_tag(tag_definition).named(tag_name).first
-
-                existing_tag || create_tag(tag_definition, tag_name)
-              rescue Mongoid::Errors::Validations
-                # :nocov:
-                if (tries -= 1).positive?
-                  retry
-                end
-
-                raise ActsAsTaggableOnMongoid::Errors::DuplicateTagError.new, "'#{tag_name}' has already been taken"
-                # :nocov:
+              find_or_create_tag(tag_name, tag_definition, owner)
+            rescue StandardError
+              if (tries -= 1).positive?
+                retry
               end
+
+              raise
             end
           end
 
-          def create_tag(tag_definition, name)
+          # :reek:UtilityFunction
+          def create_tag(tag_definition, owner, name)
             tag_definition.tags_table.create!(name:          name,
+                                              owner:         owner,
                                               context:       tag_definition.tag_type,
                                               taggable_type: tag_definition.owner.name)
           end
 
           def as_8bit_ascii(string)
             string = string.to_s
-            if defined?(Encoding)
-              string.dup.force_encoding("BINARY")
-            else
-              # :nocov:
-              string.mb_chars
-              # :nocov:
-            end
+
+            string.mb_chars
+          end
+
+          def find_or_create_tag(tag_name, tag_definition, owner)
+            existing_tag = tag_definition.tags_table.for_tag(tag_definition).named(tag_name).owned_by(owner).first
+
+            existing_tag || create_tag(tag_definition, owner, tag_name)
           end
         end
 
+        # rubocop:enable Metrics/BlockLength
+
         ### INSTANCE METHODS:
 
         def ==(other)
@@ -61,6 +69,12 @@ module ActsAsTaggableOnMongoid
         def to_s
           name
         end
+
+        private
+
+        def tag_definition
+          @tag_definition ||= taggable_type.constantize.tag_types[context]
+        end
       end
     end
   end

data/lib/acts_as_taggable_on_mongoid/models/concerns/tag_migration.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ActsAsTaggableOnMongoid
+  module Models
+    module Concerns
+      # A module that defines methods to migrate a Tag model.
+      #
+      # Mongoid does not have a standardized migration scheme, but migrations of one kind or another
+      # are often a fact of life, and are in this situation because of the need to change an existing
+      # index.
+      #
+      # Using whatever migration methodology you prefer, you need to run the appropriate migration method
+      # or methods on the Tag module used by your project.
+      #
+      # The migrations are named for the ActsAsTaggableMongoid versions upon which they need to be run.
+      # Run the correct migration(s) for the version of ActsAsTaggableOnMongoid you are currently using
+      # This module does not and cannot verify the version you are migrating from nor if the migration
+      # has been run before.  Doing so is assumed to be the responsibility of your chosen
+      # Migration methodology.
+      #
+      # Example:
+      #
+      # # When a migration is needed, the method "up" is called:
+      # def up
+      #   TagModel.include ActsAsTaggableOnMongoid::Models::Concerns::TagMigration
+      #   TagModel.atom_migrate_up_6_0_1_to_6_1_1
+      # end
+      #
+      # The migration methods should only be run once if possible, but every reasonable effort is made to
+      # ensure that the migration methods are safe to re-run.
+      module TagMigration
+        extend ActiveSupport::Concern
+
+        class_methods do
+          # :reek:UncommunicativeMethodName - The name indicates what gem versions the migration is from/to
+          def atom_migrate_up_6_0_1_to_6_1_1
+            indexes = collection.indexes
+            indexes.drop_one "name_1_taggable_type_1_context_1" if indexes.get "name_1_taggable_type_1_context_1"
+
+            create_indexes
+          end
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on_mongoid/models/concerns/tag_model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsTaggableOnMongoid
   module Models
     module Concerns
@@ -10,6 +12,7 @@ module ActsAsTaggableOnMongoid
           include ActsAsTaggableOnMongoid::Models::Concerns::TagAssociations
           include ActsAsTaggableOnMongoid::Models::Concerns::TagValidations
           include ActsAsTaggableOnMongoid::Models::Concerns::TagScopes
+          include ActsAsTaggableOnMongoid::Models::Concerns::TagHooks
         end
       end
     end

data/lib/acts_as_taggable_on_mongoid/models/concerns/tag_scopes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsTaggableOnMongoid
   module Models
     module Concerns
@@ -13,9 +15,10 @@ module ActsAsTaggableOnMongoid
           scope :named_any, ->(*names) { where(:name.in => names.map { |name| as_8bit_ascii(name) }) }
           scope :named_like, ->(name) { where(name: /#{as_8bit_ascii(name)}/i) }
           scope :named_like_any, ->(*names) { where(:name.in => names.map { |name| /#{as_8bit_ascii(name)}/i }) }
-          scope :for_context, ->(context) { where(context: context) }
+          scope :owned_by, ->(owner) { owner ? where(owner: owner) : where(:owner_id.exists => false) }
+          scope :for_tag_type, ->(context) { where(context: context) }
           scope :for_taggable_class, ->(taggable_type) { where(taggable_type: taggable_type.name) }
-          scope :for_tag, ->(tag_definition) { for_taggable_class(tag_definition.owner).for_context(tag_definition.tag_type) }
+          scope :for_tag, ->(tag_definition) { for_taggable_class(tag_definition.owner).for_tag_type(tag_definition.tag_type) }
         end
       end
     end

data/lib/acts_as_taggable_on_mongoid/models/concerns/tag_validations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsTaggableOnMongoid
   module Models
     module Concerns
@@ -10,7 +12,7 @@ module ActsAsTaggableOnMongoid
           validates :name, presence: true
           validates :context, presence: true
           validates :taggable_type, presence: true
-          validates :name, uniqueness: { scope: %i[context taggable_type] }
+          validates :name, uniqueness: { scope: %i[context taggable_type owner] }
         end
       end
     end

data/lib/acts_as_taggable_on_mongoid/models/concerns/tagging_associations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsTaggableOnMongoid
   module Models
     module Concerns
@@ -5,9 +7,25 @@ module ActsAsTaggableOnMongoid
         extend ActiveSupport::Concern
 
         included do
+          ### ASSOCIATIONS:
+
           belongs_to :tag, counter_cache: true, inverse_of: :taggings
-          belongs_to :taggable, polymorphic: true
-          # belongs_to :tagger, { polymorphic: true, optional: true }
+          belongs_to :tagger, polymorphic: true, optional: true
+
+          # Tags and Taggings are created in an after_save event on taggable.
+          # If autosave is not false, then this will cause the taggable object
+          # to be saved AGAIN, that could cause a number of unwanted side-effects.
+          belongs_to :taggable, polymorphic: true, autosave: false
+
+          before_validation :atom_unset_blank_owner
+        end
+
+        private
+
+        def atom_unset_blank_owner
+          return if tagger_id.present? && tagger_type.present?
+
+          unset(:tagger_id, :tagger_type)
         end
       end
     end

data/lib/acts_as_taggable_on_mongoid/models/concerns/tagging_fields.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsTaggableOnMongoid
   module Models
     module Concerns
@@ -11,10 +13,12 @@ module ActsAsTaggableOnMongoid
           field :tag_name, type: String
           field :context, type: String
 
-          # If/when adding the concept of a tagger, this index will need to be changed.
-          index({ taggable_id: 1, taggable_type: 1, context: 1, tag_name: 1 }, unique: true, name: "tagging_taggable_context_tag_name")
+          index({ taggable_id: 1, taggable_type: 1, context: 1, tagger_id: 1, tagger_type: 1, tag_name: 1 },
+                unique: true,
+                name:   "tagging_taggable_tagger_context_tag_name")
           index(tag_name: 1)
           index(tag_id: 1, tag_type: 1)
+          index(tagger_id: 1, tagger_type: 1)
         end
       end
     end

data/lib/acts_as_taggable_on_mongoid/models/concerns/tagging_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ActsAsTaggableOnMongoid
   module Models
     module Concerns
@@ -30,7 +32,7 @@ module ActsAsTaggableOnMongoid
 
           return unless tag_definition
 
-          tag_list = taggable.public_send(tag_definition.tag_list_name)
+          tag_list = taggable.public_send(tag_definition.tagger_tag_lists_name)[tagger]
           tag_list.add_tagging(self)
         end
 
@@ -43,7 +45,7 @@ module ActsAsTaggableOnMongoid
 
           return unless tag_definition
 
-          taggable_was.public_send(tag_definition.tag_list_name).remove(tag_name_was)
+          taggable_was.public_send(tag_definition.tagger_tag_lists_name)[tagger].remove(tag_name_was)
         end
       end
     end