MONGOID-5270: Follow-ups to tally PR (#5351)

* Follow-ups to tally PR:
- Remove unused variable "k" in #extract value
- Add missing code comment
- Minor code comment fixes

* Use pipe doc syntax

* More pipes

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

Author: johnnyshields

lib/mongoid/contextual/memory.rb

@@ -74,7 +74,7 @@ def destroy
       # @example Get the distinct values.
       #   context.distinct(:name)
       #
-      # @param [ String, Symbol ] field The name of the field.
+      # @param [ String | Symbol ] field The name of the field.
       #
       # @return [ Array<Object> ] The distinct values for the field.
       def distinct(field)
@@ -215,7 +215,7 @@ def length
       #
       # @param [ Integer ] value The number of documents to return.
       #
-      # @return [ Mongo ] The context.
+      # @return [ Memory ] The context.
       def limit(value)
         self.limiting = value
         self
@@ -233,6 +233,14 @@ def pluck(*fields)
         documents.pluck(*fields)
       end
 
+      # Tally the field values in memory.
+      #
+      # @example Get the counts of values in memory.
+      #   context.tally(:name)
+      #
+      # @param [ String | Symbol ] field Field to tally.
+      #
+      # @return [ Hash ] The hash of counts.
       def tally(field)
         return documents.each_with_object({}) do |d, acc|
           v = retrieve_value_at_path(d, field)
@@ -248,7 +256,7 @@ def tally(field)
       #
       # @param [ Integer ] value The number of documents to skip.
       #
-      # @return [ Mongo ] The context.
+      # @return [ Memory ] The context.
       def skip(value)
         self.skipping = value
         self
@@ -262,7 +270,7 @@ def skip(value)
       # @param [ Hash ] values The sorting values as field/direction(1/-1)
       #   pairs.
       #
-      # @return [ Mongo ] The context.
+      # @return [ Memory ] The context.
       def sort(values)
         in_place_sort(values) and self
       end

lib/mongoid/contextual/mongo.rb

@@ -377,7 +377,8 @@ def last(opts = {})
         end
       end
 
-      # Get's the number of documents matching the query selector.
+      # Returns the number of documents in the database matching
+      # the query selector.
       #
       # @example Get the length.
       #   context.length
@@ -832,7 +833,6 @@ def fetch_and_demongoize(obj, meth, field)
       def extract_value(attrs, field_name)
         i = 1
         num_meths = field_name.count('.') + 1
-        k = klass
         curr = attrs.dup
 
         klass.traverse_association_tree(field_name) do |meth, obj, is_field|
@@ -870,10 +870,6 @@ def extract_value(attrs, field_name)
             fetch_and_demongoize(curr, meth, field)
           end
 
-          # If it's a relation, update the current klass with the relation klass.
-          if !is_field && !obj.nil?
-            k = obj.klass
-          end
           i += 1
         end
         curr
@@ -910,7 +906,7 @@ def demongoize_with_field(field, value, is_translation)
           # again, we already have the translation. If it's an _translations
           # field, don't demongoize, we want the full hash not just a
           # specific translation.
-          # If it is a hash, and it's not a transaltions field, we need to
+          # If it is a hash, and it's not a translations field, we need to
           # demongoize to get the correct translation.
           if field.localized? && (!value.is_a?(Hash) || is_translation)
             value.class.demongoize(value)

lib/mongoid/contextual/none.rb

@@ -50,7 +50,7 @@ def ==(other)
       # @example Get the distinct values in null context.
       #   context.distinct(:name)
       #
-      # @param [ String, Symbol ] _field The name of the field.
+      # @param [ String | Symbol ] _field The name of the field.
       #
       # @return [ Array ] An empty Array.
       def distinct(_field)
@@ -88,10 +88,10 @@ def exists?; false; end
       # @example Get the values for null context.
       #   context.pluck(:name)
       #
-      # @param [ String, Symbol, Array ] args Field or fields to pluck.
+      # @param [ String | Symbol ] *_fields Field or fields to pluck.
       #
       # @return [ Array ] An empty Array.
-      def pluck(*args)
+      def pluck(*_fields)
         []
       end
 
@@ -100,10 +100,10 @@ def pluck(*args)
       # @example Get the values for null context.
       #   context.tally(:name)
       #
-      # @param [ String, Symbol ] arg Field to tally.
+      # @param [ String | Symbol ] _field Field to tally.
       #
       # @return [ Hash ] An empty Hash.
-      def tally(arg)
+      def tally(_field)
         {}
       end