Class: RuboCop::Cop::Generator Private

'[modify] A configuration for the cop is added into ' \
'%<configuration_file_path>s.'

<<~RUBY
  # frozen_string_literal: true

  module RuboCop
    module Cop
      module %<department>s
        # TODO: Write cop description and example of bad / good code. For every
        # `SupportedStyle` and unique configuration, there needs to be examples.
        # Examples must have valid Ruby syntax. Do not use upticks.
        #
        # @safety
        #   Delete this section if the cop is not unsafe (`Safe: false` or
        #   `SafeAutoCorrect: false`), or use it to explain how the cop is
        #   unsafe.
        #
        # @example EnforcedStyle: bar (default)
        #   # Description of the `bar` style.
        #
        #   # bad
        #   bad_bar_method
        #
        #   # bad
        #   bad_bar_method(args)
        #
        #   # good
        #   good_bar_method
        #
        #   # good
        #   good_bar_method(args)
        #
        # @example EnforcedStyle: foo
        #   # Description of the `foo` style.
        #
        #   # bad
        #   bad_foo_method
        #
        #   # bad
        #   bad_foo_method(args)
        #
        #   # good
        #   good_foo_method
        #
        #   # good
        #   good_foo_method(args)
        #
        class %<cop_name>s < Base
          # TODO: Implement the cop in here.
          #
          # In many cases, you can use a node matcher for matching node pattern.
          # See https://github.com/rubocop/rubocop-ast/blob/master/lib/rubocop/ast/node_pattern.rb
          #
          # For example
          MSG = 'Use `#good_method` instead of `#bad_method`.'

          # TODO: Don't call `on_send` unless the method name is in this list
          # If you don't need `on_send` in the cop you created, remove it.
          RESTRICT_ON_SEND = %%i[bad_method].freeze

          # @!method bad_method?(node)
          def_node_matcher :bad_method?, <<~PATTERN
            (send nil? :bad_method ...)
          PATTERN

          # Called on every `send` node (method call) while walking the AST.
          # TODO: remove this method if inspecting `send` nodes is unneeded for your cop.
          # By default, this is aliased to `on_csend` as well to handle method calls
          # with safe navigation, remove the alias if this is unnecessary.
          # If kept, ensure your tests cover safe navigation as well!
          def on_send(node)
            return unless bad_method?(node)

            add_offense(node)
          end
          alias on_csend on_send
        end
      end
    end
  end
RUBY

<<~SPEC
  # frozen_string_literal: true

  RSpec.describe RuboCop::Cop::%<department>s::%<cop_name>s, :config do
    let(:config) { RuboCop::Config.new }

    # TODO: Write test code
    #
    # For example
    it 'registers an offense when using `#bad_method`' do
      expect_offense(<<~RUBY)
        bad_method
        ^^^^^^^^^^ Use `#good_method` instead of `#bad_method`.
      RUBY
    end

    it 'does not register an offense when using `#good_method`' do
      expect_no_offenses(<<~RUBY)
        good_method
      RUBY
    end
  end
SPEC