2023-03-19 17:31:32 +00:00
|
|
|
# typed: true
|
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
module RuboCop
|
|
|
|
module Cop
|
|
|
|
module Cask
|
|
|
|
class NoOverrides < Base
|
|
|
|
extend T::Sig
|
|
|
|
include CaskHelp
|
|
|
|
|
2023-03-19 20:41:43 +00:00
|
|
|
ON_SYSTEM_METHODS = RuboCop::Cask::Constants::ON_SYSTEM_METHODS
|
2023-03-19 17:31:32 +00:00
|
|
|
MESSAGE = <<~EOS
|
|
|
|
Do not use top-level `%<stanza>s` stanza as the default, add an `on_{system}` block instead.
|
|
|
|
Use `:or_older` or `:or_newer` to specify a range of macOS versions.
|
|
|
|
EOS
|
|
|
|
|
|
|
|
def on_cask(cask_block)
|
2023-03-19 20:41:43 +00:00
|
|
|
return if (cask_stanzas = cask_block.toplevel_stanzas).empty?
|
|
|
|
# Skip if there are no `on_*` blocks.
|
2023-03-19 22:40:53 +00:00
|
|
|
return unless (on_blocks = cask_stanzas.select { |s| ON_SYSTEM_METHODS.include?(s.stanza_name) }).any?
|
2023-03-19 17:31:32 +00:00
|
|
|
|
2023-03-19 20:41:43 +00:00
|
|
|
cask_stanzas.each do |stanza|
|
2023-03-19 22:40:53 +00:00
|
|
|
# Skip if the stanza is itself an `on_*` block.
|
2023-03-20 00:30:15 +00:00
|
|
|
next if ON_SYSTEM_METHODS.include?(stanza.stanza_name)
|
2023-03-19 17:31:32 +00:00
|
|
|
# Skip if the stanza we detect is already in an `on_*` block.
|
2023-03-19 20:41:43 +00:00
|
|
|
next if stanza.parent_node.block_type? && ON_SYSTEM_METHODS.include?(stanza.parent_node.method_name)
|
2023-03-19 22:40:53 +00:00
|
|
|
# Skip if the stanza outside of a block is not also in an `on_*` block.
|
|
|
|
next if on_system_stanzas(on_blocks).none?(stanza.stanza_name)
|
2023-03-19 17:31:32 +00:00
|
|
|
|
|
|
|
add_offense(stanza.source_range, message: format(MESSAGE, stanza: stanza.stanza_name))
|
|
|
|
end
|
|
|
|
end
|
2023-03-19 22:40:53 +00:00
|
|
|
|
|
|
|
def on_system_stanzas(on_system)
|
|
|
|
names = []
|
|
|
|
method_nodes = on_system.map(&:method_node)
|
|
|
|
method_nodes.each do |node|
|
|
|
|
next unless node.block_type?
|
|
|
|
|
|
|
|
node.child_nodes.each do |child|
|
|
|
|
child.each_node(:send) do |send_node|
|
|
|
|
next if ON_SYSTEM_METHODS.include?(send_node.method_name)
|
|
|
|
|
|
|
|
names << send_node.method_name
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
names
|
|
|
|
end
|
2023-03-19 17:31:32 +00:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|