92 lines
2.8 KiB
Ruby
92 lines
2.8 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require "rubocops/extend/formula"
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module FormulaAudit
|
|
class ClassName < FormulaCop
|
|
DEPRECATED_CLASSES = %w[
|
|
GithubGistFormula
|
|
ScriptFileFormula
|
|
AmazonWebServicesFormula
|
|
].freeze
|
|
|
|
def audit_formula(_node, _class_node, parent_class_node, _body_node)
|
|
parent_class = class_name(parent_class_node)
|
|
return unless DEPRECATED_CLASSES.include?(parent_class)
|
|
|
|
problem "#{parent_class} is deprecated, use Formula instead"
|
|
end
|
|
|
|
def autocorrect(node)
|
|
lambda do |corrector|
|
|
corrector.replace(node.source_range, "Formula")
|
|
end
|
|
end
|
|
end
|
|
|
|
class Test < FormulaCop
|
|
def audit_formula(_node, _class_node, _parent_class_node, body_node)
|
|
test = find_block(body_node, :test)
|
|
return unless test
|
|
|
|
if test.body.nil?
|
|
problem "`test do` should not be empty"
|
|
return
|
|
end
|
|
|
|
problem "`test do` should contain a real test" if test.body.single_line? && test.body.source.to_s == "true"
|
|
|
|
test_calls(test) do |node, params|
|
|
p1, p2 = params
|
|
if match = string_content(p1).match(%r{(/usr/local/(s?bin))})
|
|
offending_node(p1)
|
|
problem "use \#{#{match[2]}} instead of #{match[1]} in #{node}"
|
|
end
|
|
|
|
if node == :shell_output && node_equals?(p2, 0)
|
|
offending_node(p2)
|
|
problem "Passing 0 to shell_output() is redundant"
|
|
end
|
|
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
|
|
|
|
def_node_search :test_calls, <<~EOS
|
|
(send nil? ${:system :shell_output :pipe_output} $...)
|
|
EOS
|
|
end
|
|
end
|
|
|
|
module FormulaAuditStrict
|
|
# - `test do ..end` should defined in the formula.
|
|
class TestPresent < FormulaCop
|
|
def audit_formula(_node, _class_node, _parent_class_node, body_node)
|
|
return if find_block(body_node, :test)
|
|
|
|
problem "A `test do` test block should be added"
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|