appease Lint/IneffectiveAccessModifier

Author: jamis

.rubocop_todo.yml

@@ -42,12 +42,6 @@ Lint/IncompatibleIoSelectWithFiberScheduler:
     - 'lib/mongo/socket/ssl.rb'
     - 'lib/mongo/socket/tcp.rb'
 
-# Offense count: 7
-Lint/IneffectiveAccessModifier:
-  Exclude:
-    - 'lib/mongo/operation/shared/polymorphic_result.rb'
-    - 'lib/mongo/protocol/message.rb'
-    - 'lib/mongo/uri/options_mapper.rb'
 
 
 # Offense count: 31

lib/mongo/operation/shared/polymorphic_result.rb

@@ -26,12 +26,12 @@ module Operation
     module PolymorphicResult
       include PolymorphicLookup
 
-      private
-
       def self.included(base)
         base.extend ClassMethods
       end
 
+      private
+
       module ClassMethods
         attr_accessor :result_class
       end

lib/mongo/protocol/message.rb

@@ -320,64 +320,19 @@ def number_returned
         0
       end
 
-      private
-
-      # A method for getting the fields for a message class
-      #
-      # @return [Integer] the fields for the message class
-      def fields
-        self.class.fields
-      end
-
       # A class method for getting the fields for a message class
       #
       # @return [Integer] the fields for the message class
+      # @api private
       def self.fields
         @fields ||= []
       end
 
-      # Serializes message fields into a buffer
-      #
-      # @param buffer [String] buffer to receive the field
-      # @return [String] buffer with serialized field
-      def serialize_fields(buffer, max_bson_size = nil)
-        fields.each do |field|
-          value = instance_variable_get(field[:name])
-          if field[:multi]
-            value.each do |item|
-              if field[:type].respond_to?(:size_limited?)
-                field[:type].serialize(buffer, item, max_bson_size)
-              else
-                field[:type].serialize(buffer, item)
-              end
-            end
-          elsif field[:type].respond_to?(:size_limited?)
-            field[:type].serialize(buffer, value, max_bson_size)
-          else
-            field[:type].serialize(buffer, value)
-          end
-        end
-      end
-
-      # Serializes the header of the message consisting of 4 32bit integers
-      #
-      # The integers represent a message length placeholder (calculation of
-      # the actual length is deferred) the request id, the response to id,
-      # and the op code for the message
-      #
-      # Currently uses hardcoded 0 for request id and response to as their
-      # values are irrelevent to the server
-      #
-      # @param buffer [String] Buffer to receive the header
-      # @return [String] Serialized header
-      def serialize_header(buffer)
-        Header.serialize(buffer, [ 0, request_id, 0, op_code ])
-      end
-
       # Deserializes the header of the message
       #
       # @param io [IO] Stream containing the header.
       # @return [Array<Fixnum>] Deserialized header.
+      # @api private
       def self.deserialize_header(io)
         Header.deserialize(io)
       end
@@ -397,6 +352,7 @@ def self.deserialize_header(io)
       #     fields that use the number.
       #
       # @return [NilClass]
+      # @api private
       def self.field(name, type, multi = false)
         fields << {
           name: :"@#{name}",
@@ -422,6 +378,7 @@ def self.field(name, type, multi = false)
       #   each of the elements in this array using BSON types wherever possible.
       #
       # @return [Message] Message with deserialized array.
+      # @api private
       def self.deserialize_array(message, io, field, options = {})
         elements = []
         count = message.instance_variable_get(field[:multi])
@@ -440,12 +397,60 @@ def self.deserialize_array(message, io, field, options = {})
       #   this field using BSON types wherever possible.
       #
       # @return [Message] Message with deserialized field.
+      # @api private
       def self.deserialize_field(message, io, field, options = {})
         message.instance_variable_set(
           field[:name],
           field[:type].deserialize(io, options)
         )
       end
+
+      private
+
+      # A method for getting the fields for a message class
+      #
+      # @return [Integer] the fields for the message class
+      def fields
+        self.class.fields
+      end
+
+      # Serializes message fields into a buffer
+      #
+      # @param buffer [String] buffer to receive the field
+      # @return [String] buffer with serialized field
+      def serialize_fields(buffer, max_bson_size = nil)
+        fields.each do |field|
+          value = instance_variable_get(field[:name])
+          if field[:multi]
+            value.each do |item|
+              if field[:type].respond_to?(:size_limited?)
+                field[:type].serialize(buffer, item, max_bson_size)
+              else
+                field[:type].serialize(buffer, item)
+              end
+            end
+          elsif field[:type].respond_to?(:size_limited?)
+            field[:type].serialize(buffer, value, max_bson_size)
+          else
+            field[:type].serialize(buffer, value)
+          end
+        end
+      end
+
+      # Serializes the header of the message consisting of 4 32bit integers
+      #
+      # The integers represent a message length placeholder (calculation of
+      # the actual length is deferred) the request id, the response to id,
+      # and the op code for the message
+      #
+      # Currently uses hardcoded 0 for request id and response to as their
+      # values are irrelevent to the server
+      #
+      # @param buffer [String] Buffer to receive the header
+      # @return [String] Serialized header
+      def serialize_header(buffer)
+        Header.serialize(buffer, [ 0, request_id, 0, op_code ])
+      end
     end
   end
 end

lib/mongo/uri/options_mapper.rb

@@ -185,6 +185,28 @@ def ruby_to_string(opts)
         rv
       end
 
+      # Hash for storing map of URI option parameters to conversion strategies
+      # @api private
+      URI_OPTION_MAP = {}
+
+      # @return [ Hash<String, String> ] Map from lowercased to canonical URI
+      #   option names.
+      # @api private
+      URI_OPTION_CANONICAL_NAMES = {}
+
+      # Simple internal dsl to register a MongoDB URI option in the URI_OPTION_MAP.
+      #
+      # @param [ String ] uri_key The MongoDB URI option to register.
+      # @param [ Symbol ] name The name of the option in the driver.
+      # @param [ Hash ] extra Extra options.
+      #   * :group [ Symbol ] Nested hash where option will go.
+      #   * :type [ Symbol ] Name of function to transform value.
+      # @api private
+      def self.uri_option(uri_key, name, **extra)
+        URI_OPTION_MAP[uri_key.downcase] = { name: name }.update(extra)
+        URI_OPTION_CANONICAL_NAMES[uri_key.downcase] = uri_key
+      end
+
       private
 
       # Applies URI value transformation by either using the default cast
@@ -224,25 +246,6 @@ def merge_uri_option(target, value, name)
         end
       end
 
-      # Hash for storing map of URI option parameters to conversion strategies
-      URI_OPTION_MAP = {}
-
-      # @return [ Hash<String, String> ] Map from lowercased to canonical URI
-      #   option names.
-      URI_OPTION_CANONICAL_NAMES = {}
-
-      # Simple internal dsl to register a MongoDB URI option in the URI_OPTION_MAP.
-      #
-      # @param [ String ] uri_key The MongoDB URI option to register.
-      # @param [ Symbol ] name The name of the option in the driver.
-      # @param [ Hash ] extra Extra options.
-      #   * :group [ Symbol ] Nested hash where option will go.
-      #   * :type [ Symbol ] Name of function to transform value.
-      def self.uri_option(uri_key, name, **extra)
-        URI_OPTION_MAP[uri_key.downcase] = { name: name }.update(extra)
-        URI_OPTION_CANONICAL_NAMES[uri_key.downcase] = uri_key
-      end
-
       # Replica Set Options
       uri_option 'replicaSet', :replica_set