Lint/StructNewOverride

All Ruby Objects have a method named "method" which can be used to retrieve a
method by name:

    irb(main):002> "".method(:length)
    => #<Method: String#length()>

Our request struct accidentally overrides "method" and its version returns the
name of the HTTP method, e.g. GET. This breaks the contract if any caller were
to call request.method and expect the Object behavior.

Since Request is public API, renaming "method" to something else would be a
breaking change.

Author: joshcooper

.rubocop_todo.yml

@@ -618,10 +618,6 @@ Lint/RescueException:
     - 'lib/puppet/util/command_line/trollop.rb'
     - 'util/rspec_grouper'
 
-Lint/StructNewOverride:
-  Exclude:
-    - 'lib/puppet/network/http/request.rb'
-
 # Configuration parameters: AllowComments, AllowNil.
 Lint/SuppressedException:
   Exclude:

lib/puppet/network/http/request.rb

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
-Puppet::Network::HTTP::Request = Struct.new(:headers, :params, :method, :path, :routing_path, :client_cert, :body) do
+
+# This class is effectively public API, because a Request object is passed as a
+# parameter to the current Handler subclass. Puppetserver implements its own
+# Handler
+# https://github.com/puppetlabs/puppetserver/blob/8.3.0/src/ruby/puppetserver-lib/puppet/server/network/http/handler.rb#L9
+# and the Request object is passed to its Handler#body method
+# https://github.com/puppetlabs/puppetserver/blob/8.3.0/src/ruby/puppetserver-lib/puppet/server/network/http/handler.rb#L36
+Puppet::Network::HTTP::Request = Struct.new(:headers, :params, :method, :path, :routing_path, :client_cert, :body) do # rubocop:disable Lint/StructNewOverride
   def self.from_hash(hash)
     symbol_members = members.collect(&:intern)
     unknown = hash.keys - symbol_members