Remove all @SInCE comments. These are generally not useful as: (#5037)

1. They do not reflect significant interface changes to methods
2. They are inconstiently used and we're not adding them on new PRs

Co-authored-by: shields <[email protected]>

Author: johnnyshields

lib/mongoid.rb

@@ -42,8 +42,6 @@ module Mongoid
   extend self
 
   # A string added to the platform details of Ruby driver client handshake documents.
-  #
-  # @since 6.1.0
   PLATFORM_DETAILS = "mongoid-#{VERSION}".freeze
 
   # The minimum MongoDB version supported.
@@ -62,8 +60,6 @@ module Mongoid
   #   end
   #
   # @return [ Config ] The configuration object.
-  #
-  # @since 1.0.0
   def configure
     block_given? ? yield(Config) : Config
   end
@@ -74,8 +70,6 @@ def configure
   #   Mongoid.default_client
   #
   # @return [ Mongo::Client ] The default client.
-  #
-  # @since 5.0.0
   def default_client
     Clients.default
   end
@@ -86,8 +80,6 @@ def default_client
   #   Mongoid.disconnect_clients
   #
   # @return [ true ] True.
-  #
-  # @since 5.0.0
   def disconnect_clients
     Clients.disconnect
   end
@@ -98,8 +90,6 @@ def disconnect_clients
   #   Mongoid.client(:default)
   #
   # @return [ Mongo::Client ] The named client.
-  #
-  # @since 5.0.0
   def client(name)
     Clients.with_name(name)
   end
@@ -109,8 +99,6 @@ def client(name)
   #
   # @example Delegate the configuration methods.
   #   Mongoid.database = Mongo::Connection.new.db("test")
-  #
-  # @since 1.0.0
   def_delegators Config, *(Config.public_instance_methods(false) - [ :logger=, :logger ])
 
 

lib/mongoid/association.rb

@@ -34,8 +34,6 @@ module Association
     # Map the macros to their corresponding Association classes.
     #
     # @return [ Hash ] The mapping from macros to their Association class.
-    #
-    # @since 7.0
     MACRO_MAPPING = {
         embeds_one: Association::Embedded::EmbedsOne,
         embeds_many: Association::Embedded::EmbedsMany,
@@ -60,8 +58,6 @@ module Association
     #   address.embedded?
     #
     # @return [ true, false ] True if the document has a parent document.
-    #
-    # @since 2.0.0.rc.1
     def embedded?
       @embedded ||= (cyclic ? _parent.present? : self.class.embedded?)
     end
@@ -72,8 +68,6 @@ def embedded?
     #   address.embedded_many?
     #
     # @return [ true, false ] True if in an embeds many.
-    #
-    # @since 2.0.0.rc.1
     def embedded_many?
       _association && _association.is_a?(Association::Embedded::EmbedsMany)
     end
@@ -84,8 +78,6 @@ def embedded_many?
     #   address.embedded_one?
     #
     # @return [ true, false ] True if in an embeds one.
-    #
-    # @since 2.0.0.rc.1
     def embedded_one?
       _association && _association.is_a?(Association::Embedded::EmbedsOne)
     end
@@ -99,8 +91,6 @@ def embedded_one?
     # @raise [ Errors::NoMetadata ] If no association metadata is present.
     #
     # @return [ Symbol ] The association name.
-    #
-    # @since 3.0.0
     def association_name
       raise Errors::NoMetadata.new(self.class.name) unless _association
       _association.name
@@ -112,8 +102,6 @@ def association_name
     #   post.referenced_many?
     #
     # @return [ true, false ] True if in a references many.
-    #
-    # @since 2.0.0.rc.1
     def referenced_many?
       _association && _association.is_a?(Association::Referenced::HasMany)
     end
@@ -124,8 +112,6 @@ def referenced_many?
     #   address.referenced_one?
     #
     # @return [ true, false ] True if in a references one.
-    #
-    # @since 2.0.0.rc.1
     def referenced_one?
       _association && _association.is_a?(Association::Referenced::HasOne)
     end
@@ -137,8 +123,6 @@ def referenced_one?
     #   document.reload_relations
     #
     # @return [ Hash ] The association metadata.
-    #
-    # @since 2.1.6
     def reload_relations
       relations.each_pair do |name, meta|
         if instance_variable_defined?("@_#{name}")

lib/mongoid/association/accessors.rb

@@ -24,8 +24,6 @@ module Accessors
       #   accessible in the built document.
       #
       # @return [ Proxy ] The association.
-      #
-      # @since 2.0.0.rc.1
       def __build__(name, object, association, selected_fields = nil)
         relation = create_relation(object, association, selected_fields)
         set_relation(name, relation)
@@ -43,8 +41,6 @@ def __build__(name, object, association, selected_fields = nil)
       #   accessible in the created association document.
       #
       # @return [ Proxy ] The association.
-      #
-      # @since 2.0.0.rc.1
       def create_relation(object, association, selected_fields = nil)
         type = @attributes[association.inverse_type]
         target = association.build(self, object, type, selected_fields)
@@ -58,8 +54,6 @@ def create_relation(object, association, selected_fields = nil)
       #   person.reset_relation_criteria(:preferences)
       #
       # @param [ Symbol ] name The name of the association.
-      #
-      # @since 3.0.14
       def reset_relation_criteria(name)
         if instance_variable_defined?("@_#{name}")
           send(name).reset_unloaded
@@ -76,8 +70,6 @@ def reset_relation_criteria(name)
       # @param [ Proxy ] relation The association to set.
       #
       # @return [ Proxy ] The association.
-      #
-      # @since 2.0.0.rc.1
       def set_relation(name, relation)
         instance_variable_set("@_#{name}", relation)
       end
@@ -98,8 +90,6 @@ def set_relation(name, relation)
       # @param [ true, false ] reload If the association is to be reloaded.
       #
       # @return [ Proxy ] The association.
-      #
-      # @since 3.0.16
       def get_relation(name, association, object, reload = false)
         if !reload && (value = ivar(name)) != false
           value
@@ -209,8 +199,6 @@ def needs_no_database_query?(object, association)
       #   document.without_autobuild?
       #
       # @return [ true, false ] If autobuild is disabled.
-      #
-      # @since 3.0.0
       def without_autobuild?
         Threaded.executing?(:without_autobuild)
       end
@@ -223,8 +211,6 @@ def without_autobuild?
       #   end
       #
       # @return [ Object ] The result of the yield.
-      #
-      # @since 3.0.0
       def without_autobuild
         Threaded.begin_execution("without_autobuild")
         yield
@@ -241,8 +227,6 @@ def without_autobuild
       # @param [ Array ] args The arguments.
       #
       # @return [ Array<Hash> ] The attributes and options.
-      #
-      # @since 2.3.4
       def parse_args(*args)
         [args.first || {}, args.size > 1 ? args[1] : {}]
       end
@@ -260,8 +244,6 @@ def parse_args(*args)
       # @param [ Association ] association The association.
       #
       # @return [ Class ] The model being set up.
-      #
-      # @since 3.0.0
       def self.define_existence_check!(association)
         name = association.name
         association.inverse_class.tap do |klass|
@@ -284,8 +266,6 @@ def #{name}?
       # @param [ Association ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_getter!(association)
         name = association.name
         association.inverse_class.tap do |klass|
@@ -328,8 +308,6 @@ def self.define_ids_getter!(association)
       # @param [ Association ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_setter!(association)
         name = association.name
         association.inverse_class.tap do |klass|
@@ -380,8 +358,6 @@ def self.define_ids_setter!(association)
       # @param [ Association ] association The association for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_builder!(association)
         name = association.name
         association.inverse_class.tap do |klass|
@@ -407,8 +383,6 @@ def self.define_builder!(association)
       # @param [ Association ] association The association for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_creator!(association)
         name = association.name
         association.inverse_class.tap do |klass|

lib/mongoid/association/bindable.rb

@@ -18,8 +18,6 @@ module Bindable
       # @param [ Document ] base The base of the binding.
       # @param [ Document, Array<Document> ] target The target of the binding.
       # @param [ Association ] association The association metadata.
-      #
-      # @since 2.0.0.rc.1
       def initialize(base, target, association)
         @_base, @_target, @_association = base, target, association
       end
@@ -32,8 +30,6 @@ def initialize(base, target, association)
       #   end
       #
       # @return [ Object ] The result of the yield.
-      #
-      # @since 3.0.0
       def binding
         unless _binding?
           _binding do
@@ -54,8 +50,6 @@ def binding
       # @param [ Document ] doc The document getting bound.
       #
       # @raise [ Errors::InverseNotFound ] If no inverse found.
-      #
-      # @since 3.0.0
       def check_inverse!(doc)
         unless _association.bindable?(doc)
           raise Errors::InverseNotFound.new(
@@ -77,8 +71,6 @@ def check_inverse!(doc)
       #
       # @param [ Document ] keyed The document that stores the foreign key.
       # @param [ Object ] id The id of the bound document.
-      #
-      # @since 3.0.0
       def bind_foreign_key(keyed, id)
         unless keyed.frozen?
           keyed.you_must(_association.foreign_key_setter, id)
@@ -95,8 +87,6 @@ def bind_foreign_key(keyed, id)
       #
       # @param [ Document ] typed The document that stores the type field.
       # @param [ String ] name The name of the model.
-      #
-      # @since 3.0.0
       def bind_polymorphic_type(typed, name)
         if _association.type
           typed.you_must(_association.type_setter, name)
@@ -113,8 +103,6 @@ def bind_polymorphic_type(typed, name)
       #
       # @param [ Document ] typed The document that stores the type field.
       # @param [ String ] name The name of the model.
-      #
-      # @since 3.0.0
       def bind_polymorphic_inverse_type(typed, name)
         if _association.inverse_type
           typed.you_must(_association.inverse_type_setter, name)
@@ -131,8 +119,6 @@ def bind_polymorphic_inverse_type(typed, name)
       #
       # @param [ Document ] doc The base document.
       # @param [ Document ] inverse The inverse document.
-      #
-      # @since 3.0.0
       def bind_inverse(doc, inverse)
         if doc.respond_to?(_association.inverse_setter)
           doc.you_must(_association.inverse_setter, inverse)
@@ -147,8 +133,6 @@ def bind_inverse(doc, inverse)
       #   binding.bind_from_relational_parent(doc)
       #
       # @param [ Document ] doc The document to bind.
-      #
-      # @since 3.0.0
       def bind_from_relational_parent(doc)
         check_inverse!(doc)
         bind_foreign_key(doc, record_id(_base))
@@ -170,8 +154,6 @@ def record_id(_base)
       #   binding.set_base_association
       #
       # @return [ true, false ] If the association changed.
-      #
-      # @since 2.4.4
       def set_base_association
         inverse_association = _association.inverse_association(_target)
         if inverse_association != _association && !inverse_association.nil?
@@ -187,8 +169,6 @@ def set_base_association
       #   unbinding.unbind_from_relational_parent(doc)
       #
       # @param [ Document ] doc The document to unbind.
-      #
-      # @since 3.0.0
       def unbind_from_relational_parent(doc)
         check_inverse!(doc)
         bind_foreign_key(doc, nil)

lib/mongoid/association/builders.rb

@@ -17,8 +17,6 @@ module Association
     #   # The following methods get created:
     #   person.build_name({ :first_name => "Durran" })
     #   person.create_name({ :first_name => "Durran" })
-    #
-    # @since 2.0.0.rc.1
     module Builders
       extend ActiveSupport::Concern
 
@@ -33,8 +31,6 @@ module Builders
       # @param [ Array ] args The arguments.
       #
       # @return [ Array<Hash> ] The attributes and options.
-      #
-      # @since 2.3.4
       def parse_args(*args)
         [ args.first || {}, args.size > 1 ? args[1] : {} ]
       end
@@ -47,8 +43,6 @@ def parse_args(*args)
       # @param [ Association ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_builder!(association)
         association.inverse_class.tap do |klass|
           klass.re_define_method("build_#{association.name}") do |*args|
@@ -72,8 +66,6 @@ def self.define_builder!(association)
       # @param [ Association ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_creator!(association)
         association.inverse_class.tap do |klass|
           klass.re_define_method("create_#{association.name}") do |*args|

lib/mongoid/association/constrainable.rb

@@ -18,8 +18,6 @@ module Constrainable
       # @param [ Object ] object The object to convert.
       #
       # @return [ Object ] The object cast to the correct type.
-      #
-      # @since 2.0.0.rc.7
       def convert_to_foreign_key(object)
         return convert_polymorphic(object) if polymorphic?
         field = relation_class.fields["_id"]