acts-as-taggable-on-mongoid 6.1.1.7 → 6.1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3389918de3bd83bfcc3ac3f82d9413d5a0f8ec076b8ae83c226d0787dd96158
-  data.tar.gz: a2e731e6cf8b57d91697d3feb0fc61acca0073bbda5ef41452768bb42ffb7f57
+  metadata.gz: 923975d7d231581699ec0944f7482b0b80b66071bbf042f5ef8264dd70e6f2f9
+  data.tar.gz: 8220f30f3cc1901e0a7d2d8182b28c6cf9f7b7175e7ddddb3ee9cef52dd6cf77
 SHA512:
-  metadata.gz: 0a21b7c8cb425ce8a839411cf2bd5db8985bacf7d16b527c0f5fcc58431af787603928aa14a4c5ae9dd200836756188242b908173b69293067c4b3db1906aef4
-  data.tar.gz: 67918b704a7b3cdeb1c200e883e806b12562e7724daa1f67a8ebeee2ce3452339e9b84c7de5916b9715193b6496be82b802598b073f35ce8d3ef4ba0d6981d24
+  metadata.gz: 8115eb367985f2609847c95a54285a03d488f77eb5bbe390104539c7aec5fa68dc7530776371a888be68283cc77d0443ec01a0c7378532c5f73edee783ba93d1
+  data.tar.gz: 024c2fd74c764ab2658e1b77df1d375721c67d47fd212c4390b1494c601fe8b04cc8dd5fff65ebbe8ff7acd67572897fc3c4ab714e3122dd8cfeca24457ff66c

data/.rubocop.yml

@@ -13,6 +13,15 @@ AllCops:
     - 'node_modules/**/*'
   UseCache: false
 
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 Style/CollectionMethods:
   Description: Preferred collection methods.
   StyleGuide: https://github.com/bbatsov/ruby-style-guide#map-find-select-reduce-size

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acts-as-taggable-on-mongoid (6.1.1.7)
+    acts-as-taggable-on-mongoid (6.1.1.8)
       activesupport (>= 5.0)
       mongoid (>= 6.1.1, <= 7.0.2)
 
@@ -22,7 +22,7 @@ GEM
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
-    brakeman (4.7.2)
+    brakeman (4.8.0)
     bson (4.7.1)
     code_analyzer (0.5.1)
       sexp_processor
@@ -54,7 +54,7 @@ GEM
     gitlab (4.13.1)
       httparty (~> 0.14, >= 0.14.0)
       terminal-table (~> 1.5, >= 1.5.1)
-    httparty (0.17.3)
+    httparty (0.18.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
     i18n (0.9.5)
@@ -123,6 +123,7 @@ GEM
       psych (~> 3.1.0)
       rainbow (>= 2.0, < 4.0)
     require_all (3.0.0)
+    rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -138,11 +139,12 @@ GEM
     rspec-support (3.9.2)
     rspec_junit_formatter (0.4.1)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (0.78.0)
+    rubocop (0.80.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      rexml
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.7)
     rubocop-performance (1.5.2)
@@ -155,10 +157,10 @@ GEM
       addressable (>= 2.3.5)
       faraday (> 0.8, < 2.0)
     sexp_processor (4.14.1)
-    simplecov (0.18.1)
+    simplecov (0.18.2)
       docile (~> 1.1)
-      simplecov-html (~> 0.11.0)
-    simplecov-html (0.11.0)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.0)
     simplecov-rcov (0.2.3)
       simplecov (>= 0.4.1)
     terminal-table (1.8.0)

data/README.md

@@ -190,6 +190,7 @@ end
 class MyTaggable
   include ::Mongoid::Document
 
+  # See lib/acts_as_taggable_on_mongoid/taggable.rb for more details on options.
   acts_as_taggable_on :my_tags,
                       :your_tags,
                       :other_tags,

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

@@ -36,7 +36,7 @@ module ActsAsTaggableOnMongoid
     end
 
     autoload_under :Taggable do
-      #   autoload :Cache
+      autoload :Cache
       #   autoload :Collection
       autoload :Core
       autoload :Changeable

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

@@ -11,7 +11,11 @@ module ActsAsTaggableOnMongoid
 
           belongs_to :tag, counter_cache: true, inverse_of: :taggings
           belongs_to :tagger, polymorphic: true, optional: true
-          belongs_to :taggable, polymorphic: 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

data/lib/acts_as_taggable_on_mongoid/taggable.rb

@@ -18,7 +18,11 @@ module ActsAsTaggableOnMongoid
       #   * preserve_tag_order
       #     If true, the _list accessor will save and returns tags in the order they are added to the object.
       #   * cached_in_model
-      #     Not currently supported
+      #     If true, a field is added to de-normalize/cache the list into.  Can also be a hash with options:
+      #       field: The name of the field to cache the list in
+      #       as_list: true/false - If the cached value should be an Array or a String.  No order is guaranteed
+      #                             in either case.
+      #                             Defaults to true.
       #   * force_lowercase
       #     If true, values stored for tags will first be downcased to make the values effectively case-insensitive
       #   * force_parameterize
@@ -122,7 +126,7 @@ module ActsAsTaggableOnMongoid
          ActsAsTaggableOnMongoid::Taggable::Changeable,
          ActsAsTaggableOnMongoid::Taggable::TaggedWith,
          # include Collection - not sure we will need as done here.  Need to think more on this one.
-         # include Cache - TODO: Add this.
+         ActsAsTaggableOnMongoid::Taggable::Cache,
          # include Related - TODO: Add this.
          ActsAsTaggableOnMongoid::Taggable::TaggerRelation,
          ActsAsTaggableOnMongoid::Taggable::ListTags].each do |include_module|

data/lib/acts_as_taggable_on_mongoid/taggable/cache.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ActsAsTaggableOnMongoid
+  module Taggable
+    # A collection of generic methods which use the tag definition to perform actions.
+    #
+    # These methods are called by the individual tag generated methods to do their work so that
+    # the code can be defined in only one location and "shared" by all tags rather than putting the code
+    # and definitions into the dynamically defined methods directly.
+    #
+    # This module actually consists almost exclusively of utility functions
+
+    # :reek:FeatureEnvy
+    # :reek:UtilityFunction
+    module Cache
+      def save_cached_tag_lists
+        tag_types.each_value do |tag_definition|
+          next unless tag_definition.cached_in_model?
+          next unless tag_list_cache_set_on(tag_definition)
+
+          list = all_tags_list_on(tag_definition)
+
+          list = list.to_s unless tag_definition.cached_in_model_as_list?
+
+          public_send("#{tag_definition.cached_in_model_field}=", list)
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_taggable_on_mongoid/taggable/core.rb

@@ -22,6 +22,7 @@ module ActsAsTaggableOnMongoid
         # attr_writer :custom_contexts
 
         after_save :save_tags
+        before_save :save_cached_tag_lists
       end
 
       class_methods do
@@ -171,7 +172,7 @@ module ActsAsTaggableOnMongoid
       end
 
       def all_tags_list_on(tag_definition)
-        tag_list_on(tag_definition).flatten
+        tag_list_cache_on(tag_definition).flatten
       end
 
       ##

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

@@ -76,6 +76,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
 

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

@@ -52,6 +52,14 @@ 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
@@ -103,6 +111,10 @@ module ActsAsTaggableOnMongoid
 
         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)
 

data/lib/acts_as_taggable_on_mongoid/tagger_tag_list.rb

@@ -101,7 +101,7 @@ module ActsAsTaggableOnMongoid
     def taggable=(value)
       @taggable = value
 
-      tagger_tag_lists.values.each do |tag_list|
+      tagger_tag_lists.each_value do |tag_list|
         tag_list.taggable = taggable
       end
     end

data/lib/acts_as_taggable_on_mongoid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActsAsTaggableOnMongoid
-  VERSION = "6.1.1.7"
+  VERSION = "6.1.1.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts-as-taggable-on-mongoid
 version: !ruby/object:Gem::Version
-  version: 6.1.1.7
+  version: 6.1.1.8
 platform: ruby
 authors:
 - RealNobody
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-19 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -350,6 +350,7 @@ files:
 - lib/acts_as_taggable_on_mongoid/models/tagging.rb
 - lib/acts_as_taggable_on_mongoid/tag_list.rb
 - lib/acts_as_taggable_on_mongoid/taggable.rb
+- lib/acts_as_taggable_on_mongoid/taggable/cache.rb
 - lib/acts_as_taggable_on_mongoid/taggable/changeable.rb
 - lib/acts_as_taggable_on_mongoid/taggable/core.rb
 - lib/acts_as_taggable_on_mongoid/taggable/list_tags.rb