# typed: true # frozen_string_literal: true require "forwardable" module RuboCop module Cop module Cask # This cop checks that a cask's stanzas are ordered correctly. # @see https://github.com/Homebrew/homebrew-cask/blob/HEAD/doc/cask_language_reference/readme.md#stanza-order class StanzaOrder < Cop extend Forwardable include CaskHelp MESSAGE = "`%s` stanza out of order" def on_cask(cask_block) @cask_block = cask_block add_offenses end def autocorrect(stanza) lambda do |corrector| correct_stanza_index = toplevel_stanzas.index(stanza) correct_stanza = sorted_toplevel_stanzas[correct_stanza_index] corrector.replace(stanza.source_range_with_comments, correct_stanza.source_with_comments) end end private attr_reader :cask_block def_delegators :cask_block, :cask_node, :toplevel_stanzas, :sorted_toplevel_stanzas def add_offenses offending_stanzas.each do |stanza| message = format(MESSAGE, stanza: stanza.stanza_name) add_offense(stanza, location: stanza.source_range_with_comments, message: message) end end def offending_stanzas stanza_pairs = toplevel_stanzas.zip(sorted_toplevel_stanzas) stanza_pairs.each_with_object([]) do |stanza_pair, offending_stanzas| stanza, sorted_stanza = *stanza_pair offending_stanzas << stanza unless stanza == sorted_stanza end end end end end end