rubocop-socketry 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fb81a6b4ae8d6132faef03c4f809249303f4fd8c649b0848b3ad50739651373
-  data.tar.gz: 36458e66b06668b2b7e2982463c9502ea198949b6b1ec8d8f88e3cc8d3fdd494
+  metadata.gz: 535ee9879245dcd6059d6ad744862b405ef49eec9203d70c8b07e03ca77b3f47
+  data.tar.gz: ccd2df428d0cb2652beb7452f0e80952e3dbe0845adb41bcebea5d8d83c0bff6
 SHA512:
-  metadata.gz: 0caef0060a18b50b43248beeb00276513ee6be2d33c1e8818cc1293588cdb2844a7639e32886a0409dd00f93928bb8a7d5eda11ce1c3b814d8313d97c3a32388
-  data.tar.gz: 8f0dd11b87b6e878cef827ccab72891840c4f6668b78d486e85dbbc0be7c3afcafd7fa1494b0ef653b6c6134d83f3b5898e75bb420a6f2061b8fe1fcb3ad8714
+  metadata.gz: 40daa847ae78f73f5c9d2a2521d457a8de458985dded66fb6d06e027c9545ce5dd65eeb3edd38d202fa4c87941ecdc9eee9cacb12d5a231a222acee64ddad889
+  data.tar.gz: da03f159be23f86eaea8b43fdfba3f80eca079b8e9c410c8a1f9e66d7e3e09f10e784944f8904fd40cd9d28dd5cd9124d79402633079bc637e3a55652b9c8000

data/lib/rubocop/socketry/config.yaml

@@ -7,3 +7,13 @@ Layout/ConsistentBlankLineIndentation:
   Description: "Ensures that blank lines have the same indentation as the previous non-blank line."
   Enabled: true
   VersionAdded: "0.1.0" 
+
+Layout/BlockDelimiterSpacing:
+  Description: "Enforces consistent spacing before block delimiters."
+  Enabled: true
+  VersionAdded: "0.4.0"
+
+Style/GlobalExceptionVariables:
+  Description: "Warns against using global exception variables like $! and $@."
+  Enabled: true
+  VersionAdded: "0.5.0"

data/lib/rubocop/socketry/layout/block_delimiter_spacing.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require "rubocop"
+
+module RuboCop
+	module Socketry
+		module Layout
+			# A RuboCop cop that enforces consistent spacing before block delimiters.
+			# 
+			# This cop enforces the following style:
+			# - `foo {bar}` - space when method has no parentheses and is not chained
+			# - `foo(1, 2) {bar}` - space after closing paren for standalone methods
+			# - `array.each{|x| x*2}.reverse` - no space for method chains (even with parens)
+			class BlockDelimiterSpacing < RuboCop::Cop::Base
+				extend Cop::AutoCorrector
+				
+				MSG_ADD_SPACE = "Add a space before the opening brace."
+				MSG_REMOVE_SPACE = "Remove space before the opening brace for method chains."
+				
+				def on_block(node)
+					return unless node.braces?
+					
+					send_node = node.send_node
+					
+					# Priority: Check if it's part of a method chain first
+					# Method chains should never have space, even with parentheses
+					if part_of_method_chain?(node)
+						# array.each{|x| x*2}.reverse - no space
+						# obj.method(1, 2){|x| x}.other - also no space
+						check_no_space_before_brace(node, send_node)
+					elsif has_parentheses?(send_node)
+						# foo(1, 2) {bar} - space after ) for standalone methods
+						check_space_after_paren(node, send_node)
+					else
+						# foo {bar} - space for standalone methods without parens
+						check_space_before_brace(node, send_node)
+					end
+				end
+				
+				private
+				
+				# Check if the block is part of a method chain (e.g., foo{}.bar or foo.bar{}.baz)
+				def part_of_method_chain?(block_node)
+					send_node = block_node.send_node
+					parent = block_node.parent
+					
+					# Check if there's a method call after the block (foo{}.bar)
+					has_chained_method_after = parent&.send_type? && parent.receiver == block_node
+					
+					# Check if the block's receiver exists (foo.bar{} or array.map{})
+					# Any method call with a receiver is part of a chain
+					has_receiver_before = send_node.receiver
+					
+					has_chained_method_after || has_receiver_before
+				end
+				
+				# Check if the method call has parentheses
+				def has_parentheses?(send_node)
+					send_node.parenthesized?
+				end
+				
+				# Check that there's a space between closing paren and opening brace
+				def check_space_after_paren(block_node, send_node)
+					paren_end = send_node.loc.end
+					brace_begin = block_node.loc.begin
+					
+					return unless paren_end && brace_begin
+					
+					# Get the source between ) and {
+					space_range = Parser::Source::Range.new(
+						processed_source.buffer,
+						paren_end.end_pos,
+						brace_begin.begin_pos
+					)
+					
+					space_between = space_range.source
+					
+					# Should have exactly one space
+					return if space_between == " "
+					
+					if space_between.empty?
+						add_offense(
+							brace_begin,
+							message: MSG_ADD_SPACE
+						) do |corrector|
+							corrector.insert_before(brace_begin, " ")
+						end
+					elsif space_between.match?(/\A\s+\z/)
+						# Multiple spaces or tabs - replace with single space
+						add_offense(
+							space_range,
+							message: MSG_ADD_SPACE
+						) do |corrector|
+							corrector.replace(space_range, " ")
+						end
+					end
+				end
+				
+				# Check that there's no space before the opening brace
+				def check_no_space_before_brace(block_node, send_node)
+					brace_begin = block_node.loc.begin
+					
+					# Find the position just before the brace
+					char_before_pos = brace_begin.begin_pos - 1
+					
+					return if char_before_pos < 0
+					
+					char_before = processed_source.buffer.source[char_before_pos]
+					
+					# If there's a space before the brace, we need to remove it
+					return unless char_before == " "
+					
+					# Don't remove space if it's after a closing paren (that case is handled separately)
+					if send_node.loc.end && send_node.loc.end.end_pos == char_before_pos + 1
+						return
+					end
+					
+					# Find the extent of whitespace before the brace
+					start_pos = char_before_pos
+					while start_pos > 0 && processed_source.buffer.source[start_pos - 1] =~ /\s/
+						start_pos -= 1
+					end
+					
+					space_range = Parser::Source::Range.new(
+						processed_source.buffer,
+						start_pos,
+						brace_begin.begin_pos
+					)
+					
+					add_offense(
+						space_range,
+						message: MSG_REMOVE_SPACE
+					) do |corrector|
+						corrector.remove(space_range)
+					end
+				end
+				
+				# Check that there's a space before the opening brace (for standalone methods)
+				def check_space_before_brace(block_node, send_node)
+					brace_begin = block_node.loc.begin
+					
+					# Find the position just before the brace
+					char_before_pos = brace_begin.begin_pos - 1
+					
+					return if char_before_pos < 0
+					
+					char_before = processed_source.buffer.source[char_before_pos]
+					
+					# If there's already a space, we're good
+					return if char_before == " "
+					
+					# Otherwise, we need to add a space
+					add_offense(
+						brace_begin,
+						message: MSG_ADD_SPACE
+					) do |corrector|
+						corrector.insert_before(brace_begin, " ")
+					end
+				end
+			end
+		end
+	end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require "rubocop"
+
+module RuboCop
+	module Socketry
+		module Style
+			# A RuboCop cop that warns against using global exception variables.
+			# 
+			# This cop discourages the use of:
+			# - `$!` (last exception)
+			# - `$@` (backtrace of last exception)
+			# - `$ERROR_INFO` (English name for `$!`)
+			# - `$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.
+			# 
+			# @example
+			#   # bad
+			#   begin
+			#     risky_operation
+			#   rescue
+			#     puts $!.message
+			#     puts $@.first
+			#   end
+			# 
+			#   # good
+			#   begin
+			#     risky_operation
+			#   rescue => error
+			#     puts error.message
+			#     puts error.backtrace.first
+			#   end
+			class GlobalExceptionVariables < RuboCop::Cop::Base
+				MSG = "Avoid using global exception variable `%<variable>s`. " \
+				      "Use explicit exception handling with `rescue => error` instead."
+				
+				EXCEPTION_VARIABLES = %i[$! $@ $ERROR_INFO $ERROR_POSITION].freeze
+				
+				def on_gvar(node)
+					variable_name = node.children.first
+					
+					return unless EXCEPTION_VARIABLES.include?(variable_name)
+					
+					add_offense(
+						node,
+						message: format(MSG, variable: variable_name)
+					)
+				end
+			end
+		end
+	end
+end
+

data/lib/rubocop/socketry/version.rb

@@ -5,6 +5,6 @@
 
 module RuboCop
 	module Socketry
-		VERSION = "0.3.0"
+		VERSION = "0.5.0"
 	end
 end 

data/lib/rubocop/socketry.rb

@@ -6,6 +6,8 @@
 require_relative "socketry/version"
 require_relative "socketry/plugin"
 require_relative "socketry/layout/consistent_blank_line_indentation"
+require_relative "socketry/layout/block_delimiter_spacing"
+require_relative "socketry/style/global_exception_variables"
 
 # @namespace
 module RuboCop
@@ -14,5 +16,9 @@ module RuboCop
 		# @namespace
 		module Layout
 		end
+		
+		# @namespace
+		module Style
+		end
 	end
 end

data/readme.md

@@ -27,9 +27,17 @@ Layout/ConsistentBlankLineIndentation:
 
 Please see the [project releases](https://socketry.github.io/rubocop-socketry/releases/index) for all releases.
 
+### v0.5.0
+
+  - Added `Style/GlobalExceptionVariables` cop to warn against using global exception variables (`$!`, `$@`, `$ERROR_INFO`, `$ERROR_POSITION`).
+
+### v0.4.0
+
+  - Added `Layout/BlockDelimiterSpacing` cop to enforce consistent spacing before block delimiters.
+
 ### v0.1.0
 
-  - Initial implementaiton of `Layout/ConsistentBlankLineIndentation`.
+  - Initial implementation of `Layout/ConsistentBlankLineIndentation`.
 
 ## Contributing
 

data/releases.md

@@ -1,5 +1,13 @@
 # Releases
 
+## v0.5.0
+
+  - Added `Style/GlobalExceptionVariables` cop to warn against using global exception variables (`$!`, `$@`, `$ERROR_INFO`, `$ERROR_POSITION`).
+
+## v0.4.0
+
+  - Added `Layout/BlockDelimiterSpacing` cop to enforce consistent spacing before block delimiters.
+
 ## v0.1.0
 
-  - Initial implementaiton of `Layout/ConsistentBlankLineIndentation`.
+  - Initial implementation of `Layout/ConsistentBlankLineIndentation`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-socketry
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -73,8 +73,10 @@ files:
 - agent.md
 - lib/rubocop/socketry.rb
 - lib/rubocop/socketry/config.yaml
+- lib/rubocop/socketry/layout/block_delimiter_spacing.rb
 - lib/rubocop/socketry/layout/consistent_blank_line_indentation.rb
 - lib/rubocop/socketry/plugin.rb
+- lib/rubocop/socketry/style/global_exception_variables.rb
 - lib/rubocop/socketry/version.rb
 - license.md
 - readme.md