mongoid 7.3.2 → 7.4.0

data/lib/mongoid/criteria/findable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -16,8 +15,6 @@ module Mongoid
       # @raise [ Errors::DocumentNotFound ] If nothing returned.
       #
       # @return [ Document, Array<Document> ] The document(s).
-      #
-      # @since 2.0.0
       def execute_or_raise(ids, multi)
         result = multiple_from_db(ids)
         check_for_missing_documents!(result, ids)
@@ -35,8 +32,6 @@ module Mongoid
       # @param [ Array<BSON::ObjectId> ] args The ids to search for.
       #
       # @return [ Array<Document>, Document ] The matching document(s).
-      #
-      # @since 1.0.0
       def find(*args)
         ids = args.__find_args__
         raise_invalid if ids.any?(&:nil?)
@@ -88,8 +83,6 @@ module Mongoid
       #   criteria.id_finder
       #
       # @return [ Symbol ] The name of the finder method.
-      #
-      # @since 3.1.0
       def id_finder
         @id_finder ||= extract_id ? :all_of : :where
       end
@@ -104,8 +97,6 @@ module Mongoid
       # @param [ Array<Object> ] ids The ids to fetch with.
       #
       # @return [ Array<Document> ] The matching documents.
-      #
-      # @since 3.0.0
       def from_database(ids)
         from_database_selector(ids).entries
       end
@@ -128,8 +119,6 @@ module Mongoid
       # @param [ Array<Object> ] ids The ids to convert.
       #
       # @return [ Array<Object> ] The converted ids.
-      #
-      # @since 3.0.0
       def mongoize_ids(ids)
         ids.map do |id|
           id = id[:_id] if id.respond_to?(:keys) && id[:_id]
@@ -143,8 +132,6 @@ module Mongoid
       #   criteria.raise_invalid
       #
       # @raise [ Errors::InvalidOptions ] The error.
-      #
-      # @since 2.0.0
       def raise_invalid
         raise Errors::InvalidFind.new
       end

data/lib/mongoid/criteria/includable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -26,8 +25,6 @@ module Mongoid
       #   load.
       #
       # @return [ Criteria ] The cloned criteria.
-      #
-      # @since 2.2.0
       def includes(*relations)
         extract_includes_list(klass, relations)
         clone
@@ -39,8 +36,6 @@ module Mongoid
       #   Person.includes(:game).inclusions
       #
       # @return [ Array<Association> ] The inclusions.
-      #
-      # @since 2.2.0
       def inclusions
         @inclusions ||= []
       end
@@ -53,8 +48,6 @@ module Mongoid
       # @param [ Array<Association> ] value The inclusions.
       #
       # @return [ Array<Association> ] The new inclusions.
-      #
-      # @since 3.0.0
       def inclusions=(value)
         @inclusions = value
       end
@@ -70,8 +63,6 @@ module Mongoid
       # @param [ Symbol ] association The association.
       #
       # @raise [ Errors::InvalidIncludes ] If no association is found.
-      #
-      # @since 5.1.0
       def add_inclusion(_klass, association)
         inclusions.push(association) unless inclusions.include?(association)
       end

data/lib/mongoid/criteria/inspectable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -12,8 +11,6 @@ module Mongoid
       #   criteria.inspect
       #
       # @return [ String ] The inspection string.
-      #
-      # @since 1.0.0
       def inspect
 %Q{#<Mongoid::Criteria
   selector: #{selector.inspect}

data/lib/mongoid/criteria/marshalable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -11,8 +10,6 @@ module Mongoid
       #   Marshal.dump(criteria)
       #
       # @return [ Array<Object> ] The dumped data.
-      #
-      # @since 3.0.15
       def marshal_dump
         data = [ klass, driver, inclusions, documents, strategy, negating ]
         data.push(scoping_options).push(dump_hash(:selector)).push(dump_hash(:options))
@@ -24,8 +21,6 @@ module Mongoid
       #   Marshal.load(criteria)
       #
       # @param [ Array ] data The raw data.
-      #
-      # @since 3.0.15
       def marshal_load(data)
         @scoping_options, raw_selector, raw_options = data.pop(3)
         @klass, @driver, @inclusions, @documents, @strategy, @negating = data

data/lib/mongoid/criteria/modifiable.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -19,8 +18,6 @@ module Mongoid
       #   Person.where(:age.gt => 5).build
       #
       # @return [ Document ] A non-persisted document.
-      #
-      # @since 2.0.0
       def build(attrs = {}, &block)
         create_document(:new, attrs, &block)
       end
@@ -36,8 +33,6 @@ module Mongoid
       #   Person.where(:age.gt => 5).create
       #
       # @return [ Document ] A newly created document.
-      #
-      # @since 2.0.0.rc.1
       def create(attrs = {}, &block)
         create_document(:create, attrs, &block)
       end
@@ -55,8 +50,6 @@ module Mongoid
       # @raise [ Errors::Validations ] on a validation error.
       #
       # @return [ Document ] A newly created document.
-      #
-      # @since 3.0.0
       def create!(attrs = {}, &block)
         create_document(:create!, attrs, &block)
       end
@@ -70,8 +63,6 @@ module Mongoid
       #   Person.create_with(job: 'Engineer').find_or_create_by(employer: 'MongoDB')
       #
       # @return [ Mongoid::Criteria ] A criteria.
-      #
-      # @since 5.1.0
       def create_with(attrs = {})
         tap do
           @create_attrs ||= {}
@@ -130,8 +121,6 @@ module Mongoid
       # @param [ Hash ] attrs The additional attributes to add.
       #
       # @return [ Document ] A matching or newly created document.
-      #
-      # @since 3.1.0
       def first_or_create(attrs = nil, &block)
         first_or(:create, attrs, &block)
       end
@@ -146,8 +135,6 @@ module Mongoid
       # @param [ Hash ] attrs The additional attributes to add.
       #
       # @return [ Document ] A matching or newly created document.
-      #
-      # @since 3.1.0
       def first_or_create!(attrs = nil, &block)
         first_or(:create!, attrs, &block)
       end
@@ -161,8 +148,6 @@ module Mongoid
       # @param [ Hash ] attrs The additional attributes to add.
       #
       # @return [ Document ] A matching or newly initialized document.
-      #
-      # @since 3.1.0
       def first_or_initialize(attrs = nil, &block)
         first_or(:new, attrs, &block)
       end
@@ -181,8 +166,6 @@ module Mongoid
       # @param [ Hash ] attrs Additional attributes to use.
       #
       # @return [ Document ] The new or saved document.
-      #
-      # @since 3.0.0
       def create_document(method, attrs = nil, &block)
         attrs = (create_attrs || {}).merge(attrs || {})
         attributes = selector.reduce(attrs) do |hash, (key, value)|
@@ -228,8 +211,6 @@ module Mongoid
       # @param [ Hash ] attrs The attributes to query or set.
       #
       # @return [ Document ] The first or new document.
-      #
-      # @since 3.1.0
       def first_or(method, attrs = {}, &block)
         first || create_document(method, attrs, &block)
       end

data/lib/mongoid/criteria/options.rb

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
 
     # Module containing functionality for getting options on a Criteria object.
-    #
-    # @since 6.0.0
     module Options
 
       private

data/lib/mongoid/criteria/permission.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria

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

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
     module Queryable
 
       # Provides a DSL around crafting aggregation framework commands.
-      #
-      # @since 2.0.0
       module Aggregable
         extend Macroable
 
@@ -24,8 +21,6 @@ module Mongoid
         #   aggregable.aggregating?
         #
         # @return [ true, false ] If the aggregable is aggregating.
-        #
-        # @since 2.0.0
         def aggregating?
           !!@aggregating
         end
@@ -41,8 +36,6 @@ module Mongoid
         # @param [ Hash ] operation The group operation.
         #
         # @return [ Aggregable ] The aggregable.
-        #
-        # @since 2.0.0
         def group(operation)
           aggregation(operation) do |pipeline|
             pipeline.group(operation)
@@ -65,8 +58,6 @@ module Mongoid
         # @param [ Hash ] operation The projection to make.
         #
         # @return [ Aggregable ] The aggregable.
-        #
-        # @since 2.0.0
         def project(operation = nil)
           aggregation(operation) do |pipeline|
             pipeline.project(operation)
@@ -81,8 +72,6 @@ module Mongoid
         # @param [ String, Symbol ] field The name of the field to unwind.
         #
         # @return [ Aggregable ] The aggregable.
-        #
-        # @since 2.0.0
         def unwind(field)
           aggregation(field) do |pipeline|
             pipeline.unwind(field)
@@ -103,8 +92,6 @@ module Mongoid
         # @param [ Hash ] operation The operation for the pipeline.
         #
         # @return [ Aggregable ] The cloned aggregable.
-        #
-        # @since 2.0.0
         def aggregation(operation)
           return self unless operation
           clone.tap do |query|

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria

data/lib/mongoid/criteria/queryable/extensions/array.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -17,8 +16,6 @@ module Mongoid
           # @param [ Object ] object The object to add.
           #
           # @return [ Object ] The result of the add.
-          #
-          # @since 1.0.0
           def __add__(object)
             object.__add_from_array__(self)
           end
@@ -29,8 +26,6 @@ module Mongoid
           #   [ 1, 2 ].__array__
           #
           # @return [ Array ] self
-          #
-          # @since 1.0.0
           def __array__; self; end
 
           # Makes a deep copy of the array, deep copying every element inside the
@@ -40,8 +35,6 @@ module Mongoid
           #   [ 1, 2, 3 ].__deep_copy__
           #
           # @return [ Array ] The deep copy of the array.
-          #
-          # @since 1.0.0
           def __deep_copy__
             map { |value| value.__deep_copy__ }
           end
@@ -53,8 +46,6 @@ module Mongoid
           #   [ Date.new(2010, 1, 1) ].__evolve_date__
           #
           # @return [ Array<Time> ] The array as times at midnight UTC.
-          #
-          # @since 1.0.0
           def __evolve_date__
             map { |value| value.__evolve_date__ }
           end
@@ -65,8 +56,6 @@ module Mongoid
           #   obj.__expand_complex__
           #
           # @return [ Array ] The expanded array.
-          #
-          # @since 1.1.0
           def __expand_complex__
             map do |value|
               value.__expand_complex__
@@ -79,22 +68,18 @@ module Mongoid
           #   [ 1231231231 ].__evolve_time__
           #
           # @return [ Array<Time> ] The array as times.
-          #
-          # @since 1.0.0
           def __evolve_time__
             map { |value| value.__evolve_time__ }
           end
 
           # Combine the two objects using an intersection strategy.
           #
-          # @example Interset with the object.
+          # @example Intersect with the object.
           #   [ 1, 2 ].__intersect__(3)
           #
           # @param [ Object ] object The object to intersect with.
           #
           # @return [ Object ] The result of the intersection.
-          #
-          # @since 1.0.0
           def __intersect__(object)
             object.__intersect_from_array__(self)
           end
@@ -106,8 +91,6 @@ module Mongoid
           #   [ :field, 1 ].__sort_option__
           #
           # @return [ Hash ] The array as sort criterion.
-          #
-          # @since 1.0.0
           def __sort_option__
             multi.inject({}) do |options, criteria|
               options.merge!(criteria.__sort_pair__)
@@ -121,8 +104,6 @@ module Mongoid
           #   [ field, 1 ].__sort_pair__
           #
           # @return [ Hash ] The field/direction pair.
-          #
-          # @since 1.0.0
           def __sort_pair__
             { first => last.to_direction }
           end
@@ -135,8 +116,6 @@ module Mongoid
           # @param [ Proc ] block The block to execute on each value.
           #
           # @return [ Array ] the array.
-          #
-          # @since 1.0.0
           def update_values(&block)
             replace(map(&block))
           end
@@ -151,8 +130,6 @@ module Mongoid
           #   [ 1, 2, 3 ].multi
           #
           # @return [ Array ] The multi-dimensional array.
-          #
-          # @since 1.0.0
           def multi
             first.is_a?(::Symbol) || first.is_a?(::String) ? [ self ] : self
           end
@@ -167,8 +144,6 @@ module Mongoid
             # @param [ Object ] object The object to evolve.
             #
             # @return [ Object ] The evolved object.
-            #
-            # @since 1.0.0
             def evolve(object)
               if object.is_a?(::Array)
                 object.map { |obj| obj.class.evolve(obj) }

data/lib/mongoid/criteria/queryable/extensions/big_decimal.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "bigdecimal"
 
@@ -22,8 +21,6 @@ module Mongoid
             # @param [ BigDecimal ] object The object to convert.
             #
             # @return [ String ] The big decimal as a string.
-            #
-            # @since 1.0.0
             def evolve(object)
               __evolve__(object) do |obj|
                 obj ? obj.to_s : obj

data/lib/mongoid/criteria/queryable/extensions/boolean.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -19,8 +18,6 @@ module Mongoid
             # @param [ Object ] object The object to evolve.
             #
             # @return [ true, false ] The boolean value.
-            #
-            # @since 1.0.0
             def evolve(object)
               __evolve__(object) do |obj|
                 obj.to_s =~ (/\A(true|t|yes|y|on|1|1.0)\z/i) ? true : false

data/lib/mongoid/criteria/queryable/extensions/date.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -15,8 +14,6 @@ module Mongoid
           #   date.__evolve_date__
           #
           # @return [ Time ] The date as a UTC time at midnight.
-          #
-          # @since 1.0.0
           def __evolve_date__
             ::Time.utc(year, month, day, 0, 0, 0, 0)
           end
@@ -27,8 +24,6 @@ module Mongoid
           #   date.__evolve_time__
           #
           # @return [ Time ] The date as a local time.
-          #
-          # @since 1.0.0
           def __evolve_time__
             ::Time.local(year, month, day)
           end
@@ -49,8 +44,6 @@ module Mongoid
             # @param [ Object ] object The object to evolve.
             #
             # @return [ Time ] The evolved date.
-            #
-            # @since 1.0.0
             def evolve(object)
               object.__evolve_date__
             end

data/lib/mongoid/criteria/queryable/extensions/date_time.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -15,8 +14,6 @@ module Mongoid
           #   date_time.__evolve_time__
           #
           # @return [ Time ] The converted time in UTC.
-          #
-          # @since 1.0.0
           def __evolve_time__
             usec = strftime("%6N").to_f
             u = utc
@@ -36,8 +33,6 @@ module Mongoid
             # @param [ Object ] object The object to evolve.
             #
             # @return [ Time ] The evolved date time.
-            #
-            # @since 1.0.0
             def evolve(object)
               object.__evolve_time__
             end

data/lib/mongoid/criteria/queryable/extensions/hash.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -17,8 +16,6 @@ module Mongoid
           # @param [ Hash ] object The other hash to add.
           #
           # @return [ Hash ] The hash with object added.
-          #
-          # @since 1.0.0
           def __add__(object)
             apply_strategy(:__add__, object)
           end
@@ -31,8 +28,6 @@ module Mongoid
           # @param [ Array ] array The array to add to.
           #
           # @return [ Hash ] The merged hash.
-          #
-          # @since 1.0.0
           def __add_from_array__(array)
             { keys.first => array.__add__(values.first) }
           end
@@ -45,8 +40,6 @@ module Mongoid
           # @param [ Hash ] object The other hash to intersect.
           #
           # @return [ Hash ] The hash with object intersected.
-          #
-          # @since 1.0.0
           def __intersect__(object)
             apply_strategy(:__intersect__, object)
           end
@@ -59,8 +52,6 @@ module Mongoid
           # @param [ Array ] array The array to intersect to.
           #
           # @return [ Hash ] The merged hash.
-          #
-          # @since 1.0.0
           def __intersect_from_array__(array)
             { keys.first => array.__intersect__(values.first) }
           end
@@ -73,8 +64,6 @@ module Mongoid
           # @param [ Object ] object The object to intersect to.
           #
           # @return [ Hash ] The merged hash.
-          #
-          # @since 1.0.0
           def __intersect_from_object__(object)
             { keys.first => object.__intersect__(values.first) }
           end
@@ -87,8 +76,6 @@ module Mongoid
           # @param [ Hash ] object The other hash to union.
           #
           # @return [ Hash ] The hash with object unioned.
-          #
-          # @since 1.0.0
           def __union__(object)
             apply_strategy(:__union__, object)
           end
@@ -101,8 +88,6 @@ module Mongoid
           # @param [ Object ] object The object to union to.
           #
           # @return [ Hash ] The merged hash.
-          #
-          # @since 1.0.0
           def __union_from_object__(object)
             { keys.first => object.__union__(values.first) }
           end
@@ -113,8 +98,6 @@ module Mongoid
           #   { field: value }.__deep_copy__
           #
           # @return [ Hash ] The copied hash.
-          #
-          # @since 1.0.0
           def __deep_copy__
             {}.tap do |copy|
               each_pair do |key, value|
@@ -129,8 +112,6 @@ module Mongoid
           #   { field: 1 }.__sort_option__
           #
           # @return [ Hash ] The hash as sort option.
-          #
-          # @since 1.0.0
           def __sort_option__
             tap do |hash|
               hash.each_pair do |key, value|
@@ -145,8 +126,6 @@ module Mongoid
           #   obj.__expand_complex__
           #
           # @return [ Hash ] The expanded hash.
-          #
-          # @since 1.0.5
           def __expand_complex__
             replacement = {}
             each_pair do |key, value|
@@ -163,8 +142,6 @@ module Mongoid
           # @param [ Proc ] block The block to execute on each value.
           #
           # @return [ Hash ] the hash.
-          #
-          # @since 1.0.0
           def update_values(&block)
             each_pair do |key, value|
               store(key, block[value])
@@ -184,8 +161,6 @@ module Mongoid
           # @param [ Object ] object The object to merge.
           #
           # @return [ Hash ] The merged hash.
-          #
-          # @since 1.0.0
           def apply_strategy(strategy, object)
             tap do |hash|
               object.each_pair do |key, value|

data/lib/mongoid/criteria/queryable/extensions/nil_class.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   class Criteria
@@ -17,8 +16,6 @@ module Mongoid
           # @param [ Object ] object The object to add.
           #
           # @return [ Object ] The provided object.
-          #
-          # @since 1.0.0
           def __add__(object); object; end
 
           # Add this object to nil.
@@ -29,8 +26,6 @@ module Mongoid
           # @param [ Object ] object The object to expanded.
           #
           # @return [ Object ] The provided object.
-          #
-          # @since 1.0.0
           def __expanded__(object); object; end
 
           # Evolve the nil into a date or time.
@@ -39,8 +34,6 @@ module Mongoid
           #   nil.__evolve_time__
           #
           # @return [ nil ] nil.
-          #
-          # @since 1.0.0
           def __evolve_time__; self; end
           alias :__evolve_date__ :__evolve_time__
 
@@ -52,8 +45,6 @@ module Mongoid
           # @param [ Object ] object The object to intersect.
           #
           # @return [ Object ] The provided object.
-          #
-          # @since 1.0.0
           def __intersect__(object); object; end
 
           # Add this object to nil.
@@ -64,8 +55,6 @@ module Mongoid
           # @param [ Object ] object The object to override.
           #
           # @return [ Object ] The provided object.
-          #
-          # @since 1.0.0
           def __override__(object); object; end
 
           # Add this object to nil.
@@ -76,8 +65,6 @@ module Mongoid
           # @param [ Object ] object The object to union.
           #
           # @return [ Object ] The provided object.
-          #
-          # @since 1.0.0
           def __union__(object); object; end
         end
       end