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 = 
"  # frozen_string_literal: true\n\n  # TODO: when finished, run `rake generate_cops_documentation` to update the docs\n  module RuboCop\n    module Cop\n      module %<department>s\n        # TODO: Write cop description and example of bad / good code.\n        #\n        # @example\n        #   # bad\n        #   bad_method()\n        #\n        #   # bad\n        #   bad_method(args)\n        #\n        #   # good\n        #   good_method()\n        #\n        #   # good\n        #   good_method(args)\n        class %<cop_name>s < Cop\n          # TODO: Implement the cop into here.\n          #\n          # In many cases, you can use a node matcher for matching node pattern.\n          # See. https://github.com/bbatsov/rubocop/blob/master/lib/rubocop/node_pattern.rb\n          #\n          # For example\n          MSG = 'Message of %<cop_name>s'.freeze\n\n          def_node_matcher :bad_method?, <<-PATTERN\n            (send nil :bad_method ...)\n          PATTERN\n\n          def on_send(node)\n            return unless bad_method?(node)\n            add_offense(node)\n          end\n        end\n      end\n    end\n  end\n".strip_indent
SPEC_TEMPLATE = 
"  # frozen_string_literal: true\n\n  describe RuboCop::Cop::%<department>s::%<cop_name>s do\n    let(:config) { RuboCop::Config.new }\n    subject(:cop) { described_class.new(config) }\n\n    # TODO: Write test code\n    #\n    # For example\n    it 'registers an offense when using `#bad_method`' do\n      expect_offense(<<-RUBY.strip_indent)\n        bad_method\n        ^^^^^^^^^^ Use `#good_method` instead of `#bad_method`.\n      RUBY\n    end\n\n    it 'does not register an offense when using `#good_method`' do\n      expect_no_offenses(<<-RUBY.strip_indent)\n        good_method\n      RUBY\n    end\n  end\n".strip_indent

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
  "    Files created:\n      - \#{source_path}\n      - \#{spec_path}\n\n    Do 3 steps:\n      1. Add an entry to the \"New features\" section in CHANGELOG.md,\n         e.g. \"Add new `\#{badge}` cop. ([@your_id][])\"\n      2. Add an entry into config/enabled.yml or config/disabled.yml\n      3. Implement your new cop in the generated file!\n  TODO\nend\n".strip_indent

#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