Lint/InheritException

Ruby's `rescue => e` only rescues StandardException so it's preferrable to
always create exceptions that inherit from StandardException, not Exception.
However, there are times where we intentially do want to inherit from Exception.

In the evaluator, break, next, etc relies on inheriting from Exception for
control flow.

In a few other cases, changing the hierarchy would break anyone using puppet
as a library, so disable them on a case-by-case basis.

Author: joshcooper

.rubocop_todo.yml

@@ -585,17 +585,6 @@ Layout/TrailingWhitespace:
 Lint/ConstantDefinitionInBlock:
   Enabled: false
 
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: standard_error, runtime_error
-Lint/InheritException:
-  Exclude:
-    - 'lib/puppet/agent.rb'
-    - 'lib/puppet/network/http/error.rb'
-    - 'lib/puppet/pops/evaluator/closure.rb'
-    - 'lib/puppet/util/logging.rb'
-    - 'lib/puppet/util/retry_action.rb'
-
 Lint/MissingSuper:
   Enabled: false
 

lib/puppet/agent.rb

@@ -18,7 +18,7 @@ class Puppet::Agent
   include Puppet::Util::Splayer
 
   # Special exception class used to signal an agent run has timed out.
-  class RunTimeoutError < Exception
+  class RunTimeoutError < Exception # rubocop:disable Lint/InheritException
   end
 
   attr_reader :client_class, :client, :should_fork

lib/puppet/network/http/error.rb

@@ -4,7 +4,7 @@
 module Puppet::Network::HTTP::Error
   Issues = Puppet::Network::HTTP::Issues
 
-  class HTTPError < Exception
+  class HTTPError < Exception # rubocop:disable Lint/InheritException
     attr_reader :status, :issue_kind
 
     def initialize(message, status, issue_kind)

lib/puppet/pops/evaluator/closure.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 module Puppet::Pops
 module Evaluator
-  class Jumper < Exception
+  class Jumper < Exception # rubocop:disable Lint/InheritException
     attr_reader :value
     attr_reader :file
     attr_reader :line

lib/puppet/util/logging.rb

@@ -125,7 +125,7 @@ def log_and_raise(exception, message)
     raise exception, message + "\n" + exception.to_s, exception.backtrace
   end
 
-  class DeprecationWarning < Exception; end
+  class DeprecationWarning < Exception; end # rubocop:disable Lint/InheritException
 
   # Logs a warning indicating that the Ruby code path is deprecated.  Note that
   # this method keeps track of the offending lines of code that triggered the

lib/puppet/util/retry_action.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Puppet::Util::RetryAction
-  class RetryException < Exception; end
+  class RetryException < Exception; end # rubocop:disable Lint/InheritException
   class RetryException::NoBlockGiven < RetryException; end
   class RetryException::NoRetriesGiven < RetryException;end
   class RetryException::RetriesExceeded < RetryException; end