1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
# frozen_string_literal: true
require 'open3'
# require 'bundler'
# require 'bundler/gem_tasks'
# begin
# Bundler.setup(:default, :development)
# rescue Bundler::BundlerError => e
# warn e.message
# warn 'Run `bundle install` to install missing gems'
# exit e.status_code
# end
require 'rspec/core/rake_task'
require 'rubocop/rake_task'
Dir['tasks/**/*.rake'].each { |t| load t }
RSpec::Core::RakeTask.new(:spec) do |spec|
spec.pattern = FileList['spec/**/*_spec.rb']
end
desc 'Run RuboCop over this gem'
RuboCop::RakeTask.new(:internal_investigation)
desc 'Build config/default.yml'
task :build_config do
require 'yard'
require 'rubocop-rspec'
require 'rubocop/rspec/config_formatter'
require 'rubocop/rspec/description_extractor'
glob = File.join('lib', 'rubocop', 'cop', 'rspec', '*.rb')
# Due to YARD's sensitivity to file require order (as of 0.9.25),
# we have to prepend the list with our base cop, RuboCop::Cop::RSpec::Base.
# Otherwise, cop's parent class for cops loaded before our base cop class
# are detected as RuboCop::Cop::Base, and that complicates the detection
# of their relation with RuboCop RSpec.
rspec_cop_path = File.join('lib', 'rubocop', 'cop', 'rspec', 'base.rb')
YARD::Tags::Library.define_tag('Cop Safety Information', :safety)
YARD.parse(Dir[glob].prepend(rspec_cop_path), [])
descriptions =
RuboCop::RSpec::DescriptionExtractor.new(YARD::Registry.all(:class)).to_h
current_config = if Psych::VERSION >= '4.0.0' # RUBY_VERSION >= '3.1.0'
YAML.unsafe_load_file('config/default.yml')
else
YAML.load_file('config/default.yml')
end
File.write(
'config/default.yml',
RuboCop::RSpec::ConfigFormatter.new(current_config, descriptions).dump
)
end
desc 'Confirm config/default.yml is up to date'
task confirm_config: :build_config do
_, stdout, _, process =
Open3.popen3('git diff --exit-code config/default.yml')
raise <<~ERROR unless process.value.success?
default.yml is out of sync:
#{stdout.read}
Please run `rake build_config`
ERROR
end
desc 'Confirm documentation is up to date'
task confirm_documentation: :generate_cops_documentation do
stdout, _stderr, status =
Open3.capture3('git diff --exit-code docs/')
unless status.success?
warn 'Documentation is out of sync:'
warn stdout
warn 'Please run `rake generate_cops_documentation` ' \
'and add docs/ to the commit.'
exit 1
end
end
task default: %i[build_config spec
internal_investigation
confirm_config
documentation_syntax_check
confirm_documentation]
desc 'Generate a new cop template'
task :new_cop, [:cop] do |_task, args|
require 'rubocop'
require_relative 'lib/rubocop/rspec/cop/generator'
cop_name = args.fetch(:cop) do
warn "usage: bundle exec rake 'new_cop[Department/Name]'"
exit!
end
generator = RuboCop::RSpec::Cop::Generator.new(cop_name)
generator.write_source
generator.write_spec
generator.inject_require(root_file_path: 'lib/rubocop/cop/rspec_cops.rb')
generator.inject_config
puts generator.todo
end
|
