Add audit for Ruby files in taps.

[reitermarkus]

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same change?
• Have you added an explanation of what your changes do and why you'd like us to include them?
• Have you written new tests for your changes? Here's an example.
• Have you successfully run brew style with your changes locally?
• Have you successfully run brew typecheck with your changes locally?
• Have you successfully run brew tests with your changes locally?

---

Replaces the same logic in the homebrew/cask CI workflow with an audit in TapAuditor.

See Homebrew/homebrew-cask#177890 (comment).

[MikeMcQuaid]

There seems to be a bunch of changes here and I don't fully understand which ones are stylistic and which ones change behaviour. Can you elaborate a bit more on what this is doing, how and why?

[reitermarkus]

Most of the changes are caused by moving Homebrew.with_no_api_env from TapAuditor#initialize to TapAuditor#audit to avoid duplicating every Tap instance variable.

Apart from that, the only thing that's new is the TapAuditor#audit_ruby_files method.

[MikeMcQuaid]

This should say what location they should be in. Even from reading the code: I don't really understand what would be the right/wrong location here. Can you elaborate?

[reitermarkus]

Correct would be *.rb (if Formula/ doesn't exist), cmd/**/*.rb, Formula/**/*.rb and Casks/**/*.rb, anything else incorrect.

Additionally, Formula/**/*.rb is incorrect in homebrew/cask and cask/**/*.rb is incorrect in homebrew/core.

[Bo98]

Homebrew/test-bot is a tap with formulae but also uses lib/**/*.rb and spec/**/*.rb.
Homebrew/portable-ruby has Abstract/*.rb.

Stray files detection here seems somewhat far reaching.

[MikeMcQuaid]

Additionally, Formula/**/*.rb is incorrect in homebrew/cask and cask/**/*.rb is incorrect in homebrew/core.

This seems reasonable and a good add. Could also look for Ruby files that look like formulae or casks that aren't in a directory that Homebrew will ever find

Correct would be *.rb (if Formula/ doesn't exist), cmd/**/*.rb, Formula/**/*.rb and Casks/**/*.rb, anything else incorrect.

Agreed with @Bo98: this does not and feels like it's going to blow up on a lot of taps, official and otherwise.

What's the motivation here?

[reitermarkus]

The motivation is to move the logic from the cask CI workflow into brew audit. I'm also fine with simly removing this check altogether.

[Bo98]

Which part of the cask CI currently checks this?

[reitermarkus]

See Homebrew/homebrew-cask#177890.

[MikeMcQuaid]

Personally I think either:

• this check can be removed entirely
• if we want it to be in Homebrew/brew: it should check for files than e.g. contain class .+ < Formula or cask ".+" do that aren't in potential_formula_dirs

  brew/Library/Homebrew/tap.rb

  Lines 655 to 658 in 9f58612

  	sig { returns(T::Array[Pathname]) }
  	def potential_formula_dirs
  	@potential_formula_dirs ||= [path/"Formula", path/"HomebrewFormula", path].freeze
  	end

  or cask_dir

  brew/Library/Homebrew/tap.rb

  Lines 668 to 671 in 9f58612

  	sig { returns(Pathname) }
  	def cask_dir
  	@cask_dir ||= path/"Casks"
  	end

  and leave all other random Ruby files alone

[reitermarkus]

Matching class .+ < Formula would still include the Abstract/*.rb mentioned above. Then again, I'm not a fan of subclassing Formula that way in the first place.

[MikeMcQuaid]

Then: remove it entirely, I think.