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.

Defined Under Namespace

Classes: RequireFileInjector

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)
          end
        end
      end
    end
  end
RUBY
SPEC_TEMPLATE = 
<<-SPEC.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 when using `#bad_method`' do
      expect_offense(<<-RUBY.strip_indent)
        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.strip_indent)
        good_method
      RUBY
    end
  end
SPEC

Instance Method Summary collapse

Constructor Details

#initialize(name) ⇒ Generator

Returns a new instance of Generator.

Raises:

  • (ArgumentError) 


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

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

#inject_require ⇒ Object 



95
96
97
 
# File 'lib/rubocop/cop/generator.rb', line 95

def inject_require
  RequireFileInjector.new(require_path).inject
end

#todo ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/rubocop/cop/generator.rb', line 99

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

    Do 3 steps:
      1. Add an entry to the "New features" section in CHANGELOG.md,
         e.g. "Add new `#{badge}` cop. ([@your_id][])"
      2. Add an entry into config/enabled.yml or config/disabled.yml
      3. Implement your new cop in the generated file!
  TODO
end

#write_source ⇒ Object 



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

def write_source
  write_unless_file_exists(source_path, generated_source)
end

#write_spec ⇒ Object 



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

def write_spec
  write_unless_file_exists(spec_path, generated_spec)
end