[Fix #11802] Improve handling of delimiters with percent style symbol…

… arrays

changelog/fix_improve_handling_of_bracket_and_parentheses_with_percent_symbol_arrays.md

@@ -0,0 +1 @@
+* [#11802](https://github.com/rubocop/rubocop/issues/11802): Improve handling of `[]` and `()` with percent symbol arrays. ([@jasondoc3][])

lib/rubocop/cop/style/symbol_array.rb

@@ -22,6 +22,15 @@ module Style
       #   # bad
       #   [:foo, :bar, :baz]
       #
+      #   # bad (contains spaces)
+      #   %i[foo\ bar baz\ quux]
+      #
+      #   # bad (contains [] with spaces)
+      #   %i[foo \[ \]]
+      #
+      #   # bad (contains () with spaces)
+      #   %i(foo \( \))
+      #
       # @example EnforcedStyle: brackets
       #   # good
       #   [:foo, :bar, :baz]
@@ -40,14 +49,15 @@ class SymbolArray < Base
 
         PERCENT_MSG = 'Use `%i` or `%I` for an array of symbols.'
         ARRAY_MSG = 'Use %<prefer>s for an array of symbols.'
+        DELIMITERS = ['[', ']', '(', ')'].freeze
 
         class << self
           attr_accessor :largest_brackets
         end
 
         def on_array(node)
           if bracketed_array_of?(:sym, node)
-            return if symbols_contain_spaces?(node)
+            return if complex_content?(node)
 
             check_bracketed_array(node, 'i')
           elsif node.percent_literal?(:symbol)
@@ -57,13 +67,22 @@ def on_array(node)
 
         private
 
-        def symbols_contain_spaces?(node)
+        def complex_content?(node)
           node.children.any? do |sym|
             content, = *sym
-            content.to_s.include?(' ')
+            content = content.to_s
+            content_without_delimiter_pairs = content.gsub(/(\[\])|(\(\))/, '')
+
+            content.include?(' ') || DELIMITERS.any? do |delimiter|
+              content_without_delimiter_pairs.include?(delimiter)
+            end
           end
         end
 
+        def invalid_percent_array_contents?(node)
+          complex_content?(node)
+        end
+
         def build_bracketed_array(node)
           return '[]' if node.children.empty?
 

spec/rubocop/cop/style/symbol_array_spec.rb

@@ -79,17 +79,6 @@
       RUBY
     end
 
-    it "doesn't break when a symbol contains )" do
-      expect_offense(<<~RUBY)
-        [:one, :")", :three, :"(", :"]", :"["]
-        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `%i` or `%I` for an array of symbols.
-      RUBY
-
-      expect_correction(<<~'RUBY')
-        %i(one \) three \( ] [)
-      RUBY
-    end
-
     it 'does not register an offense for array with non-syms' do
       expect_no_offenses('[:one, :two, "three"]')
     end
@@ -98,10 +87,22 @@
       expect_no_offenses('%i(one two three)')
     end
 
+    it 'does not register an offense for array containing delimiters without spaces' do
+      expect_no_offenses('%i[one two [] ()]')
+    end
+
     it 'does not register an offense if symbol contains whitespace' do
       expect_no_offenses('[:one, :two, :"space here"]')
     end
 
+    it 'does not register an offense if a symbol contains unclosed delimiters' do
+      expect_no_offenses('[:one, :")", :two, :"(", :"]"]')
+    end
+
+    it 'does not register an offense if a symbol contains a delimiter with spaces' do
+      expect_no_offenses('[:one, :two, :"[ ]", :"( )"]')
+    end
+
     it 'registers an offense in a non-ambiguous block context' do
       expect_offense(<<~RUBY)
         foo([:bar, :baz]) { qux }
@@ -133,6 +134,28 @@
       expect(cop.config_to_allow_offenses).to eq('Enabled' => false)
     end
 
+    it 'registers an offense for a %i array containing [ ]' do
+      expect_offense(<<~'RUBY')
+        %i[one \[ \] two]
+        ^^^^^^^^^^^^^^^^^ Use `[:one, :'[', :']', :two]` for an array of symbols.
+      RUBY
+
+      expect_correction(<<~RUBY)
+        [:one, :'[', :']', :two]
+      RUBY
+    end
+
+    it 'registers an offense for a %i array containing ( )' do
+      expect_offense(<<~'RUBY')
+        %i(one \( \) two)
+        ^^^^^^^^^^^^^^^^^ Use `[:one, :'(', :')', :two]` for an array of symbols.
+      RUBY
+
+      expect_correction(<<~RUBY)
+        [:one, :'(', :')', :two]
+      RUBY
+    end
+
     context 'when PreferredDelimiters is specified' do
       let(:other_cops) do
         {
@@ -144,17 +167,6 @@
         }
       end
 
-      it 'autocorrects an array with delimiters' do
-        expect_offense(<<~RUBY)
-          [:one, :")", :three, :"(", :"]", :"["]
-          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `%i` or `%I` for an array of symbols.
-        RUBY
-
-        expect_correction(<<~'RUBY')
-          %i[one ) three ( \] \[]
-        RUBY
-      end
-
       it 'autocorrects an array in multiple lines' do
         expect_offense(<<-RUBY)
           [