Class: RuboCop::Cop::Generator

Inherits:
Object
  • Object
show all
Defined in:
lib/rubocop/cop/generator.rb

Overview

Source and spec generator for new cops

This generator will take a cop name and generate a source file and spec file when given a valid qualified cop name.

Constant Summary collapse

SOURCE_TEMPLATE = 
<<-RUBY.strip_indent
  # frozen_string_literal: true

  # TODO: when finished, run `rake generate_cops_documentation` to update the docs
  module RuboCop
    module Cop
      module %<department>s
        # TODO: Write cop description and example of bad / good code.
        #
        # @example
        #   # bad
        #   bad_method()
        #
        #   # bad
        #   bad_method(args)
        #
        #   # good
        #   good_method()
        #
        #   # good
        #   good_method(args)
        class %<cop_name>s < Cop
          # TODO: Implement the cop into here.
          #
          # In many cases, you can use a node matcher for matching node pattern.
          # See. https://github.com/bbatsov/rubocop/blob/master/lib/rubocop/node_pattern.rb
          #
          # For example
          MSG = 'Message of %<cop_name>s'.freeze

          def_node_matcher :bad_method?, <<-PATTERN
            (send nil :bad_method ...)
          PATTERN

          def on_send(node)
            return unless bad_method?(node)
            add_offense(node, :expression)
          end
        end
      end
    end
  end
RUBY
SPEC_TEMPLATE = 
<<-RUBY.strip_indent
  # frozen_string_literal: true

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

    # TODO: Write test code
    #
    # For example
    it 'registers an offense for offending code' do
      inspect_source(cop, 'bad_method')
      expect(cop.offenses.size).to eq(1)
      expect(cop.messages)
        .to eq(['Message of %<cop_name>s'])
    end

    it 'accepts' do
      inspect_source(cop, 'good_method')
      expect(cop.offenses).to be_empty
    end
  end
RUBY

Instance Method Summary collapse

Constructor Details

#initialize(name) ⇒ Generator

Returns a new instance of Generator.

Raises:

  • (ArgumentError) 


78
79
80
81
82
83
84
 
# File 'lib/rubocop/cop/generator.rb', line 78

def initialize(name)
  @badge = Badge.parse(name)

  return if badge.qualified?

  raise ArgumentError, 'Specify a cop name with Department/Name style'
end

Instance Method Details

#todo ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/rubocop/cop/generator.rb', line 94

def todo
  <<-TODO.strip_indent
    created
    - #{source_path}
    - #{spec_path}

    Do 4 steps
    - Add an entry to `New feature` section in CHANGELOG.md
      - e.g. Add new `#{badge.cop_name}` cop. ([@your_id][])
    - Add `require '#{require_path}'` into lib/rubocop.rb
    - Add an entry into config/enabled.yml or config/disabled.yml
    - Implement a new cop to the generated file!
  TODO
end

#write_source ⇒ Object 



86
87
88
 
# File 'lib/rubocop/cop/generator.rb', line 86

def write_source
  write_unless_file_exists(source_path, generated_source)
end

#write_spec ⇒ Object 



90
91
92
 
# File 'lib/rubocop/cop/generator.rb', line 90

def write_spec
  write_unless_file_exists(spec_path, generated_spec)
end