mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
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 ```
35 lines
914 B
Ruby
35 lines
914 B
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
module RuboCop
|
|
module Cop
|
|
module Homebrew
|
|
# This cop restricts usage of `IO.read` functions for security reasons.
|
|
class IORead < Base
|
|
MSG = "The use of `IO.%<method>s` is a security risk."
|
|
|
|
RESTRICT_ON_SEND = [:read, :readlines].freeze
|
|
|
|
def on_send(node)
|
|
return if node.receiver != s(:const, nil, :IO)
|
|
return if safe?(node.arguments.first)
|
|
|
|
add_offense(node, message: format(MSG, method: node.method_name))
|
|
end
|
|
|
|
private
|
|
|
|
def safe?(node)
|
|
if node.str_type?
|
|
!node.str_content.empty? && !node.str_content.start_with?("|")
|
|
elsif node.dstr_type? || (node.send_type? && node.method?(:+))
|
|
safe?(node.children.first)
|
|
else
|
|
false
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|