rubocop-socketry 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45d8b27941b7424a315428ba04dd6dc98218896b54551f49f0cdde531c41b1af
-  data.tar.gz: d602b39fd19660eb34908a17c0681fd884d7d2fb9b14395e1f2070ee54910ced
+  metadata.gz: 199a4f2c374f6e452459742724b7ba8ba9b0e9d9859ddf4ae12172a95e033bd9
+  data.tar.gz: ddc2c5a20e4b7181b1cdc0d07c53f85dc7acabb9ea4681616e3000292b45496f
 SHA512:
-  metadata.gz: f3dbbc01b527507b658225ad95dcce305a1c33764636a88d3f83f7772a9c5264e7729d4d554335c4427c13f66b3a7535ef05e11842c0acddfa88d143a9cea83b
-  data.tar.gz: a09b66c884a2258df7e9f53010af7fe638ac6454b4c36195406136b694116f9f5cb16465e7d67bdbddfd872b525f10dfc104cd8bcc659c323209b5a4f759c2fe
+  metadata.gz: f04815a61b6651a7c4325967a9d193ade2ecb85800cb3ef816afed0a0f51d5849ab8a3aeb758474b93a8927b7fd984826f983749a9ff4824a0cf5beba1d72d95
+  data.tar.gz: 6b255a3e77c44782ea801bc3de112411896f9395ab0b78191998b8a064528a29cbca77bc50be56223f68c1b2df2e1155332f3985fd6e62bc935f5850a7b91553

data/lib/rubocop/socketry/style/global_exception_variables.rb

@@ -8,7 +8,7 @@ require "rubocop"
 module RuboCop
 	module Socketry
 		module Style
-			# A RuboCop cop that warns against using global exception variables.
+			# A RuboCop cop that warns against using global exception variables in unsafe contexts.
 			# 
 			# This cop discourages the use of:
 			# - `$!` (last exception)
@@ -17,26 +17,52 @@ module RuboCop
 			# - `$ERROR_POSITION` (English name for `$@`)
 			# 
 			# These global variables are implicit and can make code harder to understand.
-			# Instead, use explicit exception handling with rescue blocks and local variables.
+			# 
+			# However, this cop allows their use in safe contexts where the scope is well-defined:
+			# - Inside rescue blocks (well-defined scope)
+			# - In rescue modifiers (`expression rescue $!`)
+			# - In method parameter defaults (`def foo(error = $!)`, `def bar(error: $!)`)
+			# 
+			# This cop specifically flags their use in unsafe contexts:
+			# - Inside ensure blocks (extremely unsafe - exception state is unpredictable)
+			# - Outside of exception handling contexts
 			# 
 			# @example
-			#   # bad
+			#   # bad - unsafe in ensure block
 			#   begin
 			#     risky_operation
-			#   rescue
+			#   ensure
+			#     log($!.message) if $!  # unsafe!
+			#   end
+			# 
+			#   # bad - outside exception handling
+			#   def process
 			#     puts $!.message
-			#     puts $@.first
 			#   end
 			# 
-			#   # good
+			#   # good - explicit exception handling
 			#   begin
 			#     risky_operation
 			#   rescue => error
 			#     puts error.message
-			#     puts error.backtrace.first
 			#   end
+			# 
+			#   # allowed - inside rescue block (well-defined scope)
+			#   begin
+			#     risky_operation
+			#   rescue
+			#     puts $!.message
+			#   end
+			# 
+			#   # allowed - rescue modifier
+			#   result = risky_operation rescue $!
+			# 
+			#   # allowed - parameter defaults
+			#   def foo(error = $!)
+			#   def bar(error: $!)
 			class GlobalExceptionVariables < RuboCop::Cop::Base
-				MSG = "Avoid using global exception variable `%<variable>s`. Use explicit exception handling with `rescue => error` instead."
+				MSG = "Avoid using global exception variable `%<variable>s` in %<context>s. Use explicit exception handling with `rescue => error` instead."
+				ENSURE_MSG = "Using global exception variable `%<variable>s` in an ensure block is extremely unsafe."
 				
 				EXCEPTION_VARIABLES = %i[$! $@ $ERROR_INFO $ERROR_POSITION].freeze
 				
@@ -45,11 +71,53 @@ module RuboCop
 					
 					return unless EXCEPTION_VARIABLES.include?(variable_name)
 					
+					# Allow in parameter defaults (explicitly opting in)
+					return if in_parameter_default?(node)
+					
+					# Allow in rescue modifier (well-defined scope)
+					return if in_rescue_modifier?(node)
+					
+					# Allow in rescue block (well-defined scope)
+					return if in_rescue_block?(node)
+					
+					# Flag if in ensure block (extremely unsafe)
+					if in_ensure_block?(node)
+						add_offense(
+							node,
+							message: format(ENSURE_MSG, variable: variable_name)
+						)
+						return
+					end
+					
+					# Flag in all other contexts
 					add_offense(
 						node,
-						message: format(MSG, variable: variable_name)
+						message: format(MSG, variable: variable_name, context: "this context")
 					)
 				end
+				
+				private
+				
+				def in_parameter_default?(node)
+					node.each_ancestor(:args, :optarg, :kwoptarg).any?
+				end
+				
+				def in_rescue_modifier?(node)
+					node.each_ancestor(:rescue).any? do |ancestor|
+						# A rescue modifier has no resbody children
+						# e.g., `expression rescue $!` is a rescue node with 2 children: expression and handler
+						# A regular rescue has resbody children
+						!ancestor.children.any?{|child| child.is_a?(RuboCop::AST::Node) && child.type == :resbody}
+					end
+				end
+				
+				def in_rescue_block?(node)
+					node.each_ancestor(:resbody).any?
+				end
+				
+				def in_ensure_block?(node)
+					node.each_ancestor(:ensure).any?
+				end
 			end
 		end
 	end

data/lib/rubocop/socketry/version.rb

@@ -5,6 +5,6 @@
 
 module RuboCop
 	module Socketry
-		VERSION = "0.6.0"
+		VERSION = "0.6.1"
 	end
 end 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-socketry
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Samuel Williams