Sha256: cf5e5756a308abb8e5eaf999990c77f9669dad542d2d7726842a74b2f7720732

Contents?: true

Size: 1.55 KB

Versions: 21

Compression:

Stored size: 1.55 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # This cop checks for `:true` and `:false` symbols.
      # In most cases it would be a typo.
      #
      # @safety
      #   Autocorrection is unsafe for this cop because code relying
      #   on `:true` or `:false` symbols will break when those are
      #   changed to actual booleans.
      #
      # @example
      #
      #   # bad
      #   :true
      #
      #   # good
      #   true
      #
      # @example
      #
      #   # bad
      #   :false
      #
      #   # good
      #   false
      class BooleanSymbol < Base
        extend AutoCorrector

        MSG = 'Symbol with a boolean name - you probably meant to use `%<boolean>s`.'

        # @!method boolean_symbol?(node)
        def_node_matcher :boolean_symbol?, '(sym {:true :false})'

        def on_sym(node)
          return unless boolean_symbol?(node)

          parent = node.parent
          return if parent&.array_type? && parent&.percent_literal?(:symbol)

          add_offense(node, message: format(MSG, boolean: node.value)) do |corrector|
            autocorrect(corrector, node)
          end
        end

        private

        def autocorrect(corrector, node)
          boolean_literal = node.source.delete(':')
          parent = node.parent
          if parent&.pair_type? && node.equal?(parent.children[0])
            corrector.remove(parent.loc.operator)
            boolean_literal = "#{node.source} =>"
          end

          corrector.replace(node, boolean_literal)
        end
      end
    end
  end
end

Version data entries

21 entries across 21 versions & 4 rubygems

Version Path
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/lint/boolean_symbol.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.26.0/lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.29.1 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.29.0 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.28.2 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.28.1 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.28.0 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.27.0 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.26.1 lib/rubocop/cop/lint/boolean_symbol.rb
op_connect-0.1.2 vendor/bundle/ruby/3.1.0/gems/rubocop-1.26.0/lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.26.0 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.25.1 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.25.0 lib/rubocop/cop/lint/boolean_symbol.rb
phillipug-foodie-0.1.0 .vendor/ruby/3.0.0/gems/rubocop-1.24.0/lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.24.1 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.24.0 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.23.0 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.22.3 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.22.2 lib/rubocop/cop/lint/boolean_symbol.rb
rubocop-1.22.1 lib/rubocop/cop/lint/boolean_symbol.rb