Sha256: 16a41c7373e5f04cc018a365d4dfa0deb2c692ec1ef0ea4139e76d646a5f0167

Contents?: true

Size: 1.31 KB

Versions: 38

Compression:

Stored size: 1.31 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # This cop checks for trailing commas in attribute declarations, such as
      # `#attr_reader`. Leaving a trailing comma will nullify the next method
      # definition by overriding it with a getter method.
      #
      # @example
      #
      #   # bad
      #   class Foo
      #     attr_reader :foo,
      #
      #     def bar
      #       puts "Unreachable."
      #     end
      #   end
      #
      #   # good
      #   class Foo
      #     attr_reader :foo
      #
      #     def bar
      #       puts "No problem!"
      #     end
      #   end
      #
      class TrailingCommaInAttributeDeclaration < Base
        extend AutoCorrector
        include RangeHelp

        MSG = 'Avoid leaving a trailing comma in attribute declarations.'

        def on_send(node)
          return unless node.attribute_accessor? && node.arguments.last.def_type?

          trailing_comma = trailing_comma_range(node)

          add_offense(trailing_comma) { |corrector| corrector.remove(trailing_comma) }
        end

        private

        def trailing_comma_range(node)
          range_with_surrounding_space(
            range: node.arguments[-2].source_range,
            side: :right
          ).end.resize(1)
        end
      end
    end
  end
end

Version data entries

38 entries across 38 versions & 6 rubygems

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