45978435e7
- Previously I thought that comments were fine to discourage people from wasting their time trying to bump things that used `undef` that Sorbet didn't support. But RuboCop is better at this since it'll complain if the comments are unnecessary. - Suggested in https://github.com/Homebrew/brew/pull/18018#issuecomment-2283369501. - I've gone for a mixture of `rubocop:disable` for the files that can't be `typed: strict` (use of undef, required before everything else, etc) and `rubocop:todo` for everything else that should be tried to make strictly typed. There's no functional difference between the two as `rubocop:todo` is `rubocop:disable` with a different name. - And I entirely disabled the cop for the docs/ directory since `typed: strict` isn't going to gain us anything for some Markdown linting config files. - This means that now it's easier to track what needs to be done rather than relying on checklists of files in our big Sorbet issue: ```shell $ git grep 'typed: true # rubocop:todo Sorbet/StrictSigil' | wc -l 268 ``` - And this is confirmed working for new files: ```shell $ git status On branch use-rubocop-for-sorbet-strict-sigils Untracked files: (use "git add <file>..." to include in what will be committed) Library/Homebrew/bad.rb Library/Homebrew/good.rb nothing added to commit but untracked files present (use "git add" to track) $ brew style Offenses: bad.rb:1:1: C: Sorbet/StrictSigil: Sorbet sigil should be at least strict got true. ^^^^^^^^^^^^^ 1340 files inspected, 1 offense detected ```
100 lines
3.0 KiB
Ruby
100 lines
3.0 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "forwardable"
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Cask
|
|
# This cop checks that a cask's stanzas are grouped correctly, including nested within `on_*` blocks.
|
|
# @see https://docs.brew.sh/Cask-Cookbook#stanza-order
|
|
class StanzaGrouping < Base
|
|
extend Forwardable
|
|
extend AutoCorrector
|
|
include CaskHelp
|
|
include RangeHelp
|
|
|
|
MISSING_LINE_MSG = "stanza groups should be separated by a single empty line"
|
|
EXTRA_LINE_MSG = "stanzas within the same group should have no lines between them"
|
|
|
|
def on_cask(cask_block)
|
|
@cask_block = cask_block
|
|
@line_ops = {}
|
|
cask_stanzas = cask_block.toplevel_stanzas
|
|
add_offenses(cask_stanzas)
|
|
|
|
return if (on_blocks = on_system_methods(cask_stanzas)).none?
|
|
|
|
on_blocks.map(&:method_node).select(&:block_type?).each do |on_block|
|
|
stanzas = inner_stanzas(on_block, processed_source.comments)
|
|
add_offenses(stanzas)
|
|
end
|
|
end
|
|
|
|
private
|
|
|
|
attr_reader :cask_block, :line_ops
|
|
|
|
def_delegators :cask_block, :cask_node, :toplevel_stanzas
|
|
|
|
def add_offenses(stanzas)
|
|
stanzas.each_cons(2) do |stanza, next_stanza|
|
|
next unless next_stanza
|
|
|
|
if missing_line_after?(stanza, next_stanza)
|
|
add_offense_missing_line(stanza)
|
|
elsif extra_line_after?(stanza, next_stanza)
|
|
add_offense_extra_line(stanza)
|
|
end
|
|
end
|
|
end
|
|
|
|
def missing_line_after?(stanza, next_stanza)
|
|
!(stanza.same_group?(next_stanza) ||
|
|
empty_line_after?(stanza))
|
|
end
|
|
|
|
def extra_line_after?(stanza, next_stanza)
|
|
stanza.same_group?(next_stanza) &&
|
|
empty_line_after?(stanza)
|
|
end
|
|
|
|
def empty_line_after?(stanza)
|
|
source_line_after(stanza).empty?
|
|
end
|
|
|
|
def source_line_after(stanza)
|
|
processed_source[index_of_line_after(stanza)]
|
|
end
|
|
|
|
def index_of_line_after(stanza)
|
|
stanza.source_range.last_line
|
|
end
|
|
|
|
def add_offense_missing_line(stanza)
|
|
line_index = index_of_line_after(stanza)
|
|
line_ops[line_index] = :insert
|
|
add_offense(line_index, message: MISSING_LINE_MSG) do |corrector|
|
|
corrector.insert_before(@range, "\n")
|
|
end
|
|
end
|
|
|
|
def add_offense_extra_line(stanza)
|
|
line_index = index_of_line_after(stanza)
|
|
line_ops[line_index] = :remove
|
|
add_offense(line_index, message: EXTRA_LINE_MSG) do |corrector|
|
|
corrector.remove(@range)
|
|
end
|
|
end
|
|
|
|
def add_offense(line_index, message:)
|
|
line_length = [processed_source[line_index].size, 1].max
|
|
@range = source_range(processed_source.buffer, line_index + 1, 0,
|
|
line_length)
|
|
super(@range, message:)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|