mongoid 7.3.2 → 7.4.0

data/lib/mongoid/criteria/queryable/mergeable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -17,8 +16,6 @@ module Mongoid
         #   mergeable.intersect.in(field: [ 1, 2, 3 ])
         #
         # @return [ Mergeable ] The intersect flagged mergeable.
-        #
-        # @since 1.0.0
         def intersect
           use(:__intersect__)
         end
@@ -29,8 +26,6 @@ module Mongoid
         #   mergeable.override.in(field: [ 1, 2, 3 ])
         #
         # @return [ Mergeable ] The override flagged mergeable.
-        #
-        # @since 1.0.0
         def override
           use(:__override__)
         end
@@ -41,8 +36,6 @@ module Mongoid
         #   mergeable.union.in(field: [ 1, 2, 3 ])
         #
         # @return [ Mergeable ] The union flagged mergeable.
-        #
-        # @since 1.0.0
         def union
           use(:__union__)
         end
@@ -53,8 +46,6 @@ module Mongoid
         #   mergeable.reset_strategies!
         #
         # @return [ Criteria ] self.
-        #
-        # @since 1.0.0
         def reset_strategies!
           self.strategy = nil
           self.negating = nil
@@ -74,8 +65,6 @@ module Mongoid
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
-        #
-        # @since 1.0.0
         def __add__(criterion, operator)
           with_strategy(:__add__, criterion, operator)
         end
@@ -92,8 +81,6 @@ module Mongoid
         # @param [ String ] inner The inner MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
-        #
-        # @since 1.0.0
         def __expanded__(criterion, outer, inner)
           selection(criterion) do |selector, field, value|
             selector.store(field, { outer => { inner => value }})
@@ -111,8 +98,6 @@ module Mongoid
         # @param [ Hash ] criterion The criteria.
         #
         # @return [ Mergeable ] The cloned object.
-        #
-        # @since 2.0.0
         def __merge__(criterion)
           selection(criterion) do |selector, field, value|
             selector.merge!(field.__expr_part__(value))
@@ -130,8 +115,6 @@ module Mongoid
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
-        #
-        # @since 1.0.0
         def __intersect__(criterion, operator)
           with_strategy(:__intersect__, criterion, operator)
         end
@@ -152,8 +135,6 @@ module Mongoid
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
-        #
-        # @since 1.0.0
         def __multi__(criteria, operator)
           clone.tap do |query|
             sel = query.selector
@@ -171,7 +152,7 @@ module Mongoid
 
         # Combines criteria into a MongoDB selector.
         #
-        # Criteria is an array of criterions which will be flattened.
+        # Criteria is an array of criterion objects which will be flattened.
         #
         # Each criterion can be:
         # - A hash
@@ -337,8 +318,6 @@ module Mongoid
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
-        #
-        # @since 1.0.0
         def __override__(criterion, operator)
           if criterion.is_a?(Selectable)
             criterion = criterion.selector
@@ -365,8 +344,6 @@ module Mongoid
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The new mergeable.
-        #
-        # @since 1.0.0
         def __union__(criterion, operator)
           with_strategy(:__union__, criterion, operator)
         end
@@ -381,8 +358,6 @@ module Mongoid
         # @param [ Symbol ] strategy The strategy to use.
         #
         # @return [ Mergeable ] The existing mergeable.
-        #
-        # @since 1.0.0
         def use(strategy)
           tap do |mergeable|
             mergeable.strategy = strategy
@@ -401,8 +376,6 @@ module Mongoid
         # @param [ String ] operator The MongoDB operator.
         #
         # @return [ Mergeable ] The cloned query.
-        #
-        # @since 1.0.0
         def with_strategy(strategy, criterion, operator)
           selection(criterion) do |selector, field, value|
             selector.store(
@@ -423,8 +396,6 @@ module Mongoid
         # @param [ Object ] value The value.
         #
         # @return [ Object ] The serialized value.
-        #
-        # @since 1.0.0
         def prepare(field, operator, value)
           unless operator =~ /exists|type|size/
             value = value.__expand_complex__

data/lib/mongoid/criteria/queryable/optional.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -21,8 +20,6 @@ module Mongoid
         # @param [ Array<Symbol> ] fields The fields to sort.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def ascending(*fields)
           sort_with_list(*fields, 1)
         end
@@ -39,8 +36,6 @@ module Mongoid
         # @param [ Integer ] value The batch size.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def batch_size(value = nil)
           option(value) { |options| options.store(:batch_size, value) }
         end
@@ -53,8 +48,6 @@ module Mongoid
         # @param [ Array<Symbol> ] fields The fields to sort.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def descending(*fields)
           sort_with_list(*fields, -1)
         end
@@ -70,8 +63,6 @@ module Mongoid
         # @param [ Hash ] value The index hint.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def hint(value = nil)
           option(value) { |options| options.store(:hint, value) }
         end
@@ -84,8 +75,6 @@ module Mongoid
         # @param [ Integer ] value The number of documents to return.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def limit(value = nil)
           option(value) do |options, query|
             val = value.to_i
@@ -103,8 +92,6 @@ module Mongoid
         # @param [ Integer ] value The max number of documents to scan.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def max_scan(value = nil)
           option(value) { |options| options.store(:max_scan, value) }
         end
@@ -117,8 +104,6 @@ module Mongoid
         # @param [ Integer ] value The max time in milliseconds for processing operations on a cursor.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 6.0.0
         def max_time_ms(value = nil)
           option(value) { |options| options.store(:max_time_ms, value) }
         end
@@ -129,8 +114,6 @@ module Mongoid
         #   optional.no_timeout
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def no_timeout
           clone.tap { |query| query.options.store(:timeout, false) }
         end
@@ -143,8 +126,6 @@ module Mongoid
         # @param [ Array<Symbol> ] args The fields to return.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def only(*args)
           args = args.flatten
           option(*args) do |options|
@@ -185,8 +166,6 @@ module Mongoid
         # @param [ Array, Hash, String ] spec The sorting specification.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def order_by(*spec)
           option(spec) do |options, query|
             spec.compact.each do |criterion|
@@ -208,8 +187,6 @@ module Mongoid
         # @param [ Array, Hash, String ] spec The sorting specification.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 2.1.0
         def reorder(*spec)
           clone.tap do |query|
             query.options.delete(:sort)
@@ -224,8 +201,6 @@ module Mongoid
         # @param [ Integer ] value The number to skip.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def skip(value = nil)
           option(value) do |options, query|
             val = value.to_i
@@ -243,8 +218,6 @@ module Mongoid
         # @param [ Hash ] criterion The slice options.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def slice(criterion = nil)
           option(criterion) do |options|
             options.__union__(
@@ -261,8 +234,6 @@ module Mongoid
         #   optional.snapshot
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def snapshot
           clone.tap do |query|
             query.options.store(:snapshot, true)
@@ -277,8 +248,6 @@ module Mongoid
         # @param [ Array<Symbol> ] args The fields to ignore.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def without(*args)
           args = args.flatten
           option(*args) do |options|
@@ -301,8 +270,6 @@ module Mongoid
         # @param [ String ] comment The comment to be associated with the query.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 2.2.0
         def comment(comment = nil)
           clone.tap do |query|
             query.options.store(:comment, comment)
@@ -320,8 +287,6 @@ module Mongoid
         # @param [ Symbol ] type The type of cursor to create.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 2.2.0
         def cursor_type(type)
           clone.tap { |query| query.options.store(:cursor_type, type) }
         end
@@ -334,8 +299,6 @@ module Mongoid
         # @param [ Hash ] collation_doc The document describing the collation to use.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 6.1.0
         def collation(collation_doc)
           clone.tap { |query| query.options.store(:collation, collation_doc) }
         end
@@ -354,8 +317,6 @@ module Mongoid
         # @param [ Integer ] direction The sort direction.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def add_sort_option(options, field, direction)
           if driver == :mongo1x
             sorting = (options[:sort] || []).dup
@@ -379,8 +340,6 @@ module Mongoid
         # @param [ Array ] args The options.
         #
         # @return [ Queryable ] The cloned queryable.
-        #
-        # @since 1.0.0
         def option(*args)
           clone.tap do |query|
             unless args.compact.empty?
@@ -400,8 +359,6 @@ module Mongoid
         # @param [ Integer ] direction The sort direction.
         #
         # @return [ Optional ] The cloned optional.
-        #
-        # @since 1.0.0
         def sort_with_list(*fields, direction)
           option(fields) do |options, query|
             fields.flatten.compact.each do |field|
@@ -419,8 +376,6 @@ module Mongoid
           #   Optional.forwardables
           #
           # @return [ Array<Symbol> ] The names of the forwardable methods.
-          #
-          # @since 1.0.0
           def forwardables
             public_instance_methods(false) - [ :options, :options= ]
           end

data/lib/mongoid/criteria/queryable/options.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -15,8 +14,6 @@ module Mongoid
         #   options.fields
         #
         # @return [ Hash ] The fields options.
-        #
-        # @since 1.0.0
         def fields
           self[:fields]
         end
@@ -27,8 +24,6 @@ module Mongoid
         #   options.limit
         #
         # @return [ Integer ] The limit option.
-        #
-        # @since 1.0.0
         def limit
           self[:limit]
         end
@@ -39,8 +34,6 @@ module Mongoid
         #   options.skip
         #
         # @return [ Integer ] The skip option.
-        #
-        # @since 1.0.0
         def skip
           self[:skip]
         end
@@ -51,8 +44,6 @@ module Mongoid
         #   options.sort
         #
         # @return [ Hash ] The sort options.
-        #
-        # @since 1.0.0
         def sort
           self[:sort]
         end
@@ -67,8 +58,6 @@ module Mongoid
         # @param [ Object ] value The value to add.
         #
         # @return [ Object ] The stored object.
-        #
-        # @since 1.0.0
         def store(key, value, localize = true)
           super(key, evolve(value, localize))
         end
@@ -80,8 +69,6 @@ module Mongoid
         #   options.to_pipeline
         #
         # @return [ Array<Hash> ] The options in pipeline form.
-        #
-        # @since 2.0.0
         def to_pipeline
           pipeline = []
           pipeline.push({ "$skip" => skip }) if skip
@@ -96,8 +83,6 @@ module Mongoid
         #   options.__deep_copy__
         #
         # @return [ Options ] The copied options.
-        #
-        # @since 6.1.1
         def __deep_copy__
           self.class.new(aliases, serializers) do |copy|
             each_pair do |key, value|
@@ -118,8 +103,6 @@ module Mongoid
         # @param [ Object ] value The value to serialize.
         #
         # @return [ Object ] The serialized object.
-        #
-        # @since 1.0.0
         def evolve(value, localize = true)
           case value
           when Hash
@@ -139,8 +122,6 @@ module Mongoid
         # @param [ Hash ] value The hash to serialize.
         #
         # @return [ Object ] The serialized hash.
-        #
-        # @since 1.0.0
         def evolve_hash(value, localize = true)
           value.inject({}) do |hash, (field, _value)|
             name, serializer = storage_pair(field)

data/lib/mongoid/criteria/queryable/pipeline.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
     module Queryable
 
       # Represents an aggregation pipeline.
-      #
-      # @since 2.0.0
       class Pipeline < Array
 
         # @attribute [r] aliases The field aliases.
@@ -20,8 +17,6 @@ module Mongoid
         #   pipeline.__deep_copy__
         #
         # @return [ Pipeline ] The cloned pipeline.
-        #
-        # @since 2.0.0
         def __deep_copy__
           self.class.new(aliases) do |copy|
             each do |entry|
@@ -38,8 +33,6 @@ module Mongoid
         # @param [ Hash ] entry The group entry.
         #
         # @return [ Pipeline ] The pipeline.
-        #
-        # @since 2.0.0
         def group(entry)
           push("$group" => evolve(entry.__expand_complex__))
         end
@@ -51,8 +44,6 @@ module Mongoid
         #
         # @param [ Hash ] aliases A hash of mappings from aliases to the actual
         #   field names in the database.
-        #
-        # @since 2.0.0
         def initialize(aliases = {})
           @aliases = aliases
           yield(self) if block_given?
@@ -80,8 +71,6 @@ module Mongoid
         #   document.
         #
         # @return [ Pipeline ] The pipeline.
-        #
-        # @since 2.0.0
         def unwind(field_or_doc)
           unless field_or_doc.respond_to? :keys
             normalized = field_or_doc.to_s
@@ -104,8 +93,6 @@ module Mongoid
         # @param [ Hash ] entry The entry to evolve.
         #
         # @return [ Hash ] The evolved entry.
-        #
-        # @since 2.0.0
         def evolve(entry)
           aggregate = Selector.new(aliases)
           entry.each_pair do |field, value|