mongoid 6.4.4 → 7.1.7

data/lib/mongoid/shardable.rb

@@ -1,15 +1,41 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # This module contains behaviour for adding shard key fields to updates.
+  # This module contains behavior for adding shard key fields to updates.
   #
   # @since 4.0.0
   module Shardable
     extend ActiveSupport::Concern
 
     included do
+      # Returns the list of shard key fields, if shard key was declared on
+      # this model. If no shard key was declared, returns an empty array.
+      #
+      # @return [ Array<Symbol> ] List of shard key fields.
+      # @api public
       cattr_accessor :shard_key_fields
       self.shard_key_fields = []
+
+      # Returns the shard configuration, which is a hash with the following
+      # (symbol) keys:
+      #
+      # - keys: A hash mapping (symbol) field names to values, defining the
+      #   shard key. Values can be either the integer 1 for ranged sharding
+      #   or the string "hashed" for hashed sharding.
+      # - options: A hash containing options for shardCollections command.
+      #
+      # If shard key was not declared via the +shard_key+ macro, +shard_config+
+      # attribute is nil.
+      #
+      # @example Get the shard configuration.
+      #   Model.shard_config
+      #   # => {key: {foo: 1, bar: 1}, options: {unique: true}}
+      #
+      # @return [ Hash | nil ] Shard configuration.
+      # @api public
+      cattr_accessor :shard_config
     end
 
     # Get the shard key fields.
@@ -37,7 +63,7 @@ module Mongoid
     def shard_key_selector
       selector = {}
       shard_key_fields.each do |field|
-        selector[field.to_s] = send(field)
+        selector[field.to_s] = new_record? ? send(field) : attribute_was(field)
       end
       selector
     end
@@ -53,14 +79,42 @@ module Mongoid
       #     field :first_name, :type => String
       #     field :last_name, :type => String
       #
-      #     shard_key :first_name, :last_name
+      #     shard_key first_name: 1, last_name: 1
       #   end
       #
       # @since 2.0.0
-      def shard_key(*names)
-        names.each do |name|
-          self.shard_key_fields << self.database_field_name(name).to_sym
+      def shard_key(*args)
+        unless args.first.is_a?(Hash)
+          # Shorthand syntax
+          if args.last.is_a?(Hash)
+            raise ArgumentError, 'Shorthand shard_key syntax does not permit options'
+          end
+
+          spec = Hash[args.map do |name|
+            [name, 1]
+          end]
+
+          return shard_key(spec)
+        end
+
+        if args.length > 2
+          raise ArgumentError, 'Full shard_key syntax requires 1 or 2 arguments'
         end
+
+        spec, options = args
+
+        spec = Hash[spec.map do |name, value|
+          if value.is_a?(Symbol)
+            value = value.to_s
+          end
+          [database_field_name(name).to_sym, value]
+        end]
+
+        self.shard_key_fields = spec.keys
+        self.shard_config = {
+          key: spec.freeze,
+          options: (options || {}).dup.freeze,
+        }.freeze
       end
     end
   end

data/lib/mongoid/stateful.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # This module contains the behaviour for getting the various states a
+  # This module contains the behavior for getting the various states a
   # document can transition through.
   module Stateful
 

data/lib/mongoid/tasks/database.rake

@@ -1,29 +1,36 @@
+# frozen_string_literal: true
+
 namespace :db do
   namespace :mongoid do
     task :load_models do
     end
 
-    desc "Create the indexes defined on your mongoid models"
+    desc "Create indexes specified in Mongoid models"
     task :create_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.create_indexes
     end
 
-    desc "Remove indexes that exist in the database but aren't specified on the models"
+    desc "Remove indexes that exist in the database but are not specified in Mongoid models"
     task :remove_undefined_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.remove_undefined_indexes
     end
 
-    desc "Remove the indexes defined on your mongoid models without questions!"
+    desc "Remove indexes specified in Mongoid models"
     task :remove_indexes => [:environment, :load_models] do
       ::Mongoid::Tasks::Database.remove_indexes
     end
 
-    desc "Drops the default client database"
+    desc "Shard collections with shard keys specified in Mongoid models"
+    task :shard_collections => [:environment, :load_models] do
+      ::Mongoid::Tasks::Database.shard_collections
+    end
+
+    desc "Drop the database of the default Mongoid client"
     task :drop => :environment do
       ::Mongoid::Clients.default.database.drop
     end
 
-    desc "Drop all collections except the system collections"
+    desc "Drop all non-system collections"
     task :purge => :environment do
       ::Mongoid.purge!
     end

data/lib/mongoid/tasks/database.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Tasks
     module Database
@@ -106,6 +108,89 @@ module Mongoid
         end.compact
       end
 
+      # Shard collections for models that declare shard keys.
+      #
+      # Returns the model classes that have had their collections sharded,
+      # including model classes whose collections had already been sharded
+      # prior to the invocation of this method.
+      #
+      # @example Shard all collections
+      #   Mongoid::Tasks::Database.shard_collections
+      #
+      # @return [ Array<Class> ] The sharded models
+      def shard_collections(models = ::Mongoid.models)
+        models.map do |model|
+          next if model.shard_config.nil?
+
+          if model.embedded? && !model.cyclic?
+            logger.warn("MONGOID: #{model} has shard config but is emdedded")
+            next
+          end
+
+          unless model.collection.cluster.sharded?
+            logger.warn("MONGOID: #{model} has shard config but is not persisted in a sharded cluster: #{model.collection.cluster.summary}")
+            next
+          end
+
+          # Database of the collection must exist in order to run collStats.
+          # Depending on server version, the collection itself must also
+          # exist.
+          # MongoDB does not have a command to create the database; the best
+          # approximation of it is to create the collection we want.
+          # On older servers, creating a collection that already exists is
+          # an error.
+          # Additionally, 3.6 and potentially older servers do not provide
+          # the error code when they are asked to collStats a non-existent
+          # collection (https://jira.mongodb.org/browse/SERVER-50070).
+          begin
+            stats = model.collection.database.command(collStats: model.collection.name).first
+          rescue Mongo::Error::OperationFailure => exc
+            # Code 26 is database does not exist.
+            # Code 8 is collection does not exist, as of 4.0.
+            # On 3.6 and earlier match the text of exception message.
+            if exc.code == 26 || exc.code == 8 ||
+              exc.code.nil? && exc.message =~ /not found/
+            then
+              model.collection.create
+
+              stats = model.collection.database.command(collStats: model.collection.name).first
+            else
+              raise
+            end
+          end
+
+          stats = model.collection.database.command(collStats: model.collection.name).first
+          if stats[:sharded]
+            logger.info("MONGOID: #{model.collection.namespace} is already sharded for #{model}")
+            next model
+          end
+
+          admin_db = model.collection.client.use(:admin).database
+
+          begin
+            admin_db.command(enableSharding: model.collection.database.name)
+          rescue Mongo::Error::OperationFailure => exc
+            # Server 2.6 fails if sharding is already enabled
+            if exc.code == 23 || exc.code.nil? && exc.message =~ /already enabled/
+              # Nothing
+            else
+              raise
+            end
+          end
+
+          begin
+            admin_db.command(shardCollection: model.collection.namespace, **model.shard_config)
+          rescue Mongo::Error::OperationFailure => e
+            logger.error("MONGOID: Failed to shard collection #{model.collection.namespace} for #{model}: #{e.class}: #{e}")
+            next
+          end
+
+          logger.info("MONGOID: Sharded collection #{model.collection.namespace} for #{model}")
+
+          model
+        end.compact
+      end
+
       private
 
       def logger

data/lib/mongoid/threaded/lifecycle.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Threaded
     BIND = 'bind'.freeze

data/lib/mongoid/threaded.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/threaded/lifecycle"
 
 module Mongoid

data/lib/mongoid/timestamps/created/short.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Timestamps
     module Created

data/lib/mongoid/timestamps/created.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/timestamps/created/short"
 
 module Mongoid
   module Timestamps
-    # This module handles the behaviour for setting up document created at
+    # This module handles the behavior for setting up document created at
     # timestamp.
     module Created
       extend ActiveSupport::Concern

data/lib/mongoid/timestamps/short.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Timestamps
     module Short

data/lib/mongoid/timestamps/timeless.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Timestamps
 
-    # This module adds behaviour for turning off timestamping in single or
+    # This module adds behavior for turning off timestamping in single or
     # multiple calls.
     module Timeless
       extend ActiveSupport::Concern
@@ -42,11 +44,13 @@ module Mongoid
       end
 
       class << self
+        extend Forwardable
 
         def timeless_table
           Thread.current['[mongoid]:timeless'] ||= Hash.new
         end
-        delegate :[]=, :[], to: :timeless_table
+
+        def_delegators :timeless_table, :[]=, :[]
       end
 
       private

data/lib/mongoid/timestamps/updated/short.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Timestamps
     module Updated

data/lib/mongoid/timestamps/updated.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/timestamps/updated/short"
 
 module Mongoid
   module Timestamps
-    # This module handles the behaviour for setting up document updated at
+    # This module handles the behavior for setting up document updated at
     # timestamp.
     module Updated
       extend ActiveSupport::Concern

data/lib/mongoid/timestamps.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/timestamps/timeless"
 require "mongoid/timestamps/created"
 require "mongoid/timestamps/updated"
@@ -6,7 +8,7 @@ require "mongoid/timestamps/short"
 
 module Mongoid
 
-  # This module handles the behaviour for setting up document created at and
+  # This module handles the behavior for setting up document created at and
   # updated at timestamps.
   module Timestamps
     extend ActiveSupport::Concern

data/lib/mongoid/touchable.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module Mongoid
+  module Touchable
+
+    module InstanceMethods
+
+      # Touch the document, in effect updating its updated_at timestamp and
+      # optionally the provided field to the current time. If any belongs_to
+      # associations exist with a touch option, they will be updated as well.
+      #
+      # @example Update the updated_at timestamp.
+      #   document.touch
+      #
+      # @example Update the updated_at and provided timestamps.
+      #   document.touch(:audited)
+      #
+      # @note This will not autobuild associations if those options are set.
+      #
+      # @param [ Symbol ] field The name of an additional field to update.
+      #
+      # @return [ true/false ] false if record is new_record otherwise true.
+      #
+      # @since 3.0.0
+      def touch(field = nil)
+        return false if _root.new_record?
+        current = Time.now
+        field = database_field_name(field)
+        write_attribute(:updated_at, current) if respond_to?("updated_at=")
+        write_attribute(field, current) if field
+
+        touches = touch_atomic_updates(field)
+        unless touches["$set"].blank?
+          selector = atomic_selector
+          _root.collection.find(selector).update_one(positionally(selector, touches), session: _session)
+        end
+        run_callbacks(:touch)
+        true
+      end
+    end
+
+    extend self
+
+    # Add the association to the touchable associations if the touch option was
+    # provided.
+    #
+    # @example Add the touchable.
+    #   Model.define_touchable!(assoc)
+    #
+    # @param [ Association ] association The association metadata.
+    #
+    # @return [ Class ] The model class.
+    #
+    # @since 3.0.0
+    def define_touchable!(association)
+      name = association.name
+      method_name = define_relation_touch_method(name, association)
+      association.inverse_class.tap do |klass|
+        klass.after_save method_name
+        klass.after_destroy method_name
+        klass.after_touch method_name
+      end
+    end
+
+    private
+
+    # Define the method that will get called for touching belongs_to
+    # associations.
+    #
+    # @api private
+    #
+    # @example Define the touch association.
+    #   Model.define_relation_touch_method(:band)
+    #   Model.define_relation_touch_method(:band, :band_updated_at)
+    #
+    # @param [ Symbol ] name The name of the association.
+    # @param [ Association ] association The association metadata.
+    #
+    # @since 3.1.0
+    #
+    # @return [ Symbol ] The method name.
+    def define_relation_touch_method(name, association)
+      relation_classes = if association.polymorphic?
+                           association.send(:inverse_association_classes)
+                         else
+                           [ association.relation_class ]
+                         end
+
+      relation_classes.each { |c| c.send(:include, InstanceMethods) }
+      method_name = "touch_#{name}_after_create_or_destroy"
+      association.inverse_class.class_eval do
+        define_method(method_name) do
+          without_autobuild do
+            if relation = __send__(name)
+              if association.touch_field
+                # Note that this looks up touch_field at runtime, rather than
+                # at method definition time.
+                relation.touch association.touch_field
+              else
+                relation.touch
+              end
+            end
+          end
+        end
+      end
+      method_name.to_sym
+    end
+  end
+end