Sha256: b03cbba44f9cec537bff2e24721b61cb32df8a586829fde1c534cd9d86c09208

Contents?: true

Size: 1.72 KB

Versions: 145

Compression:

Stored size: 1.72 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # Checks for colons and commas in %i, e.g. `%i(:foo, :bar)`
      #
      # It is more likely that the additional characters are unintended (for
      # example, mistranslating an array of literals to percent string notation)
      # rather than meant to be part of the resulting symbols.
      #
      # @example
      #
      #   # bad
      #
      #   %i(:foo, :bar)
      #
      # @example
      #
      #   # good
      #
      #   %i(foo bar)
      class PercentSymbolArray < Base
        include PercentLiteral
        extend AutoCorrector

        MSG = "Within `%i`/`%I`, ':' and ',' are unnecessary and may be " \
              'unwanted in the resulting symbols.'

        def on_array(node)
          process(node, '%i', '%I')
        end

        def on_percent_literal(node)
          return unless contains_colons_or_commas?(node)

          add_offense(node) { |corrector| autocorrect(corrector, node) }
        end

        private

        def autocorrect(corrector, node)
          node.children.each do |child|
            range = child.source_range

            corrector.remove_trailing(range, 1) if range.source.end_with?(',')
            corrector.remove_leading(range, 1) if
              range.source.start_with?(':')
          end
        end

        def contains_colons_or_commas?(node)
          node.children.any? do |child|
            literal = child.children.first.to_s

            next if non_alphanumeric_literal?(literal)

            literal.start_with?(':') || literal.end_with?(',')
          end
        end

        def non_alphanumeric_literal?(literal)
          !/[[:alnum:]]/.match?(literal)
        end
      end
    end
  end
end

Version data entries

145 entries across 144 versions & 15 rubygems

Version Path
rubocop-1.56.0 lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.55.1 lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.55.0 lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.54.2 lib/rubocop/cop/lint/percent_symbol_array.rb
mlh-rubocop-config-1.0.2 vendor/bundle/ruby/3.2.0/gems/rubocop-1.54.1/lib/rubocop/cop/lint/percent_symbol_array.rb
fablicop-1.10.3 vendor/bundle/ruby/3.2.0/gems/rubocop-1.52.1/lib/rubocop/cop/lint/percent_symbol_array.rb
fablicop-1.10.3 vendor/bundle/ruby/3.2.0/gems/rubocop-1.54.1/lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.54.1 lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.54.0 lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.53.1 lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.53.0 lib/rubocop/cop/lint/percent_symbol_array.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.52.1/lib/rubocop/cop/lint/percent_symbol_array.rb
fablicop-1.10.2 vendor/bundle/ruby/3.2.0/gems/rubocop-1.52.1/lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.52.1 lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.52.0 lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.51.0 lib/rubocop/cop/lint/percent_symbol_array.rb
fluent-plugin-google-cloud-logging-on-prem-0.1.0 vendor/ruby/3.1.0/gems/rubocop-1.50.2/lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.50.2 lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.50.1 lib/rubocop/cop/lint/percent_symbol_array.rb
rubocop-1.50.0 lib/rubocop/cop/lint/percent_symbol_array.rb