rubocops/class: use rubocop v1 API
This commit is contained in:
parent
3bda457478
commit
a778dc3bdb
@ -10,6 +10,8 @@ module RuboCop
|
|||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
class ClassName < FormulaCop
|
class ClassName < FormulaCop
|
||||||
|
extend AutoCorrector
|
||||||
|
|
||||||
DEPRECATED_CLASSES = %w[
|
DEPRECATED_CLASSES = %w[
|
||||||
GithubGistFormula
|
GithubGistFormula
|
||||||
ScriptFileFormula
|
ScriptFileFormula
|
||||||
@ -20,12 +22,8 @@ module RuboCop
|
|||||||
parent_class = class_name(parent_class_node)
|
parent_class = class_name(parent_class_node)
|
||||||
return unless DEPRECATED_CLASSES.include?(parent_class)
|
return unless DEPRECATED_CLASSES.include?(parent_class)
|
||||||
|
|
||||||
problem "#{parent_class} is deprecated, use Formula instead"
|
problem "#{parent_class} is deprecated, use Formula instead" do |corrector|
|
||||||
end
|
corrector.replace(parent_class_node.source_range, "Formula")
|
||||||
|
|
||||||
def autocorrect(node)
|
|
||||||
lambda do |corrector|
|
|
||||||
corrector.replace(node.source_range, "Formula")
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@ -34,6 +32,8 @@ module RuboCop
|
|||||||
#
|
#
|
||||||
# @api private
|
# @api private
|
||||||
class Test < FormulaCop
|
class Test < FormulaCop
|
||||||
|
extend AutoCorrector
|
||||||
|
|
||||||
def audit_formula(_node, _class_node, _parent_class_node, body_node)
|
def audit_formula(_node, _class_node, _parent_class_node, body_node)
|
||||||
test = find_block(body_node, :test)
|
test = find_block(body_node, :test)
|
||||||
return unless test
|
return unless test
|
||||||
@ -49,31 +49,17 @@ module RuboCop
|
|||||||
p1, p2 = params
|
p1, p2 = params
|
||||||
if match = string_content(p1).match(%r{(/usr/local/(s?bin))})
|
if match = string_content(p1).match(%r{(/usr/local/(s?bin))})
|
||||||
offending_node(p1)
|
offending_node(p1)
|
||||||
problem "use \#{#{match[2]}} instead of #{match[1]} in #{node}"
|
problem "use \#{#{match[2]}} instead of #{match[1]} in #{node}" do |corrector|
|
||||||
|
corrector.replace(p1.source_range, p1.source.sub(match[1], "\#{#{match[2]}}"))
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
if node == :shell_output && node_equals?(p2, 0)
|
if node == :shell_output && node_equals?(p2, 0)
|
||||||
offending_node(p2)
|
offending_node(p2)
|
||||||
problem "Passing 0 to shell_output() is redundant"
|
problem "Passing 0 to shell_output() is redundant" do |corrector|
|
||||||
end
|
corrector.remove(range_with_surrounding_comma(range_with_surrounding_space(range: p2.source_range,
|
||||||
end
|
side: :left)))
|
||||||
end
|
end
|
||||||
|
|
||||||
def autocorrect(node)
|
|
||||||
lambda do |corrector|
|
|
||||||
case node.type
|
|
||||||
when :str, :dstr
|
|
||||||
# Rubocop: intentionally outputted non-interpolated strings
|
|
||||||
corrector.replace(node.source_range,
|
|
||||||
node.source.to_s.sub(%r{(/usr/local/(s?bin))},
|
|
||||||
'#{\2}')) # rubocop:disable Lint/InterpolationCheck
|
|
||||||
when :int
|
|
||||||
corrector.remove(
|
|
||||||
range_with_surrounding_comma(
|
|
||||||
range_with_surrounding_space(range: node.source_range,
|
|
||||||
side: :left),
|
|
||||||
),
|
|
||||||
)
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|||||||
@ -6,55 +6,47 @@ require "rubocops/class"
|
|||||||
describe RuboCop::Cop::FormulaAudit::ClassName do
|
describe RuboCop::Cop::FormulaAudit::ClassName do
|
||||||
subject(:cop) { described_class.new }
|
subject(:cop) { described_class.new }
|
||||||
|
|
||||||
it "reports an offense when using ScriptFileFormula" do
|
corrected_source = <<~RUBY
|
||||||
|
class Foo < Formula
|
||||||
|
url 'https://brew.sh/foo-1.0.tgz'
|
||||||
|
end
|
||||||
|
RUBY
|
||||||
|
|
||||||
|
it "reports and corrects an offense when using ScriptFileFormula" do
|
||||||
expect_offense(<<~RUBY)
|
expect_offense(<<~RUBY)
|
||||||
class Foo < ScriptFileFormula
|
class Foo < ScriptFileFormula
|
||||||
^^^^^^^^^^^^^^^^^ ScriptFileFormula is deprecated, use Formula instead
|
^^^^^^^^^^^^^^^^^ ScriptFileFormula is deprecated, use Formula instead
|
||||||
url 'https://brew.sh/foo-1.0.tgz'
|
url 'https://brew.sh/foo-1.0.tgz'
|
||||||
end
|
end
|
||||||
RUBY
|
RUBY
|
||||||
|
expect_correction(corrected_source)
|
||||||
end
|
end
|
||||||
|
|
||||||
it "reports an offense when using GithubGistFormula" do
|
it "reports and corrects an offense when using GithubGistFormula" do
|
||||||
expect_offense(<<~RUBY)
|
expect_offense(<<~RUBY)
|
||||||
class Foo < GithubGistFormula
|
class Foo < GithubGistFormula
|
||||||
^^^^^^^^^^^^^^^^^ GithubGistFormula is deprecated, use Formula instead
|
^^^^^^^^^^^^^^^^^ GithubGistFormula is deprecated, use Formula instead
|
||||||
url 'https://brew.sh/foo-1.0.tgz'
|
url 'https://brew.sh/foo-1.0.tgz'
|
||||||
end
|
end
|
||||||
RUBY
|
RUBY
|
||||||
|
expect_correction(corrected_source)
|
||||||
end
|
end
|
||||||
|
|
||||||
it "reports an offense when using AmazonWebServicesFormula" do
|
it "reports and corrects an offense when using AmazonWebServicesFormula" do
|
||||||
expect_offense(<<~RUBY)
|
expect_offense(<<~RUBY)
|
||||||
class Foo < AmazonWebServicesFormula
|
class Foo < AmazonWebServicesFormula
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^ AmazonWebServicesFormula is deprecated, use Formula instead
|
^^^^^^^^^^^^^^^^^^^^^^^^ AmazonWebServicesFormula is deprecated, use Formula instead
|
||||||
url 'https://brew.sh/foo-1.0.tgz'
|
url 'https://brew.sh/foo-1.0.tgz'
|
||||||
end
|
end
|
||||||
RUBY
|
RUBY
|
||||||
end
|
expect_correction(corrected_source)
|
||||||
|
|
||||||
it "supports auto-correcting deprecated parent classes" do
|
|
||||||
source = <<~RUBY
|
|
||||||
class Foo < AmazonWebServicesFormula
|
|
||||||
url 'https://brew.sh/foo-1.0.tgz'
|
|
||||||
end
|
|
||||||
RUBY
|
|
||||||
|
|
||||||
corrected_source = <<~RUBY
|
|
||||||
class Foo < Formula
|
|
||||||
url 'https://brew.sh/foo-1.0.tgz'
|
|
||||||
end
|
|
||||||
RUBY
|
|
||||||
|
|
||||||
new_source = autocorrect_source(source)
|
|
||||||
expect(new_source).to eq(corrected_source)
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
describe RuboCop::Cop::FormulaAudit::Test do
|
describe RuboCop::Cop::FormulaAudit::Test do
|
||||||
subject(:cop) { described_class.new }
|
subject(:cop) { described_class.new }
|
||||||
|
|
||||||
it "reports an offense when /usr/local/bin is found in test calls" do
|
it "reports and corrects an offense when /usr/local/bin is found in test calls" do
|
||||||
expect_offense(<<~RUBY)
|
expect_offense(<<~RUBY)
|
||||||
class Foo < Formula
|
class Foo < Formula
|
||||||
url 'https://brew.sh/foo-1.0.tgz'
|
url 'https://brew.sh/foo-1.0.tgz'
|
||||||
@ -65,9 +57,19 @@ describe RuboCop::Cop::FormulaAudit::Test do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
RUBY
|
RUBY
|
||||||
|
|
||||||
|
expect_correction(<<~RUBY)
|
||||||
|
class Foo < Formula
|
||||||
|
url 'https://brew.sh/foo-1.0.tgz'
|
||||||
|
|
||||||
|
test do
|
||||||
|
system "\#{bin}/test"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
RUBY
|
||||||
end
|
end
|
||||||
|
|
||||||
it "reports an offense when passing 0 as the second parameter to shell_output" do
|
it "reports and corrects an offense when passing 0 as the second parameter to shell_output" do
|
||||||
expect_offense(<<~RUBY)
|
expect_offense(<<~RUBY)
|
||||||
class Foo < Formula
|
class Foo < Formula
|
||||||
url 'https://brew.sh/foo-1.0.tgz'
|
url 'https://brew.sh/foo-1.0.tgz'
|
||||||
@ -78,6 +80,16 @@ describe RuboCop::Cop::FormulaAudit::Test do
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
RUBY
|
RUBY
|
||||||
|
|
||||||
|
expect_correction(<<~RUBY)
|
||||||
|
class Foo < Formula
|
||||||
|
url 'https://brew.sh/foo-1.0.tgz'
|
||||||
|
|
||||||
|
test do
|
||||||
|
shell_output("\#{bin}/test")
|
||||||
|
end
|
||||||
|
end
|
||||||
|
RUBY
|
||||||
end
|
end
|
||||||
|
|
||||||
it "reports an offense when there is an empty test block" do
|
it "reports an offense when there is an empty test block" do
|
||||||
@ -104,31 +116,6 @@ describe RuboCop::Cop::FormulaAudit::Test do
|
|||||||
end
|
end
|
||||||
RUBY
|
RUBY
|
||||||
end
|
end
|
||||||
|
|
||||||
it "supports auto-correcting test calls" do
|
|
||||||
source = <<~RUBY
|
|
||||||
class Foo < Formula
|
|
||||||
url 'https://brew.sh/foo-1.0.tgz'
|
|
||||||
|
|
||||||
test do
|
|
||||||
shell_output("/usr/local/sbin/test", 0)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
RUBY
|
|
||||||
|
|
||||||
corrected_source = <<~RUBY
|
|
||||||
class Foo < Formula
|
|
||||||
url 'https://brew.sh/foo-1.0.tgz'
|
|
||||||
|
|
||||||
test do
|
|
||||||
shell_output("\#{sbin}/test")
|
|
||||||
end
|
|
||||||
end
|
|
||||||
RUBY
|
|
||||||
|
|
||||||
new_source = autocorrect_source(source)
|
|
||||||
expect(new_source).to eq(corrected_source)
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
describe RuboCop::Cop::FormulaAuditStrict::TestPresent do
|
describe RuboCop::Cop::FormulaAuditStrict::TestPresent do
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user