brew/Library/Homebrew/extend/io.rb

# typed: true # rubocop:todo Sorbet/StrictSigil
# frozen_string_literal: true

class IO
  def readline_nonblock(sep = $INPUT_RECORD_SEPARATOR)
    line = +""
    buffer = +""

    begin
      loop do
        break if buffer == sep

        read_nonblock(1, buffer)
        line.concat(buffer)
      end

      line.freeze
    rescue IO::WaitReadable, EOFError
      raise if line.empty?

      line.freeze
    end
  end
end
rubocop: Use `Sorbet/StrictSigil` as it's better than comments - 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 ``` 2024-08-12 10:30:59 +01:00			`# typed: true # rubocop:todo Sorbet/StrictSigil`
Add frozen_string_literal to all files. 2019-04-19 15:38:03 +09:00			`# frozen_string_literal: true`

init 2016-08-18 22:11:42 +03:00			`class IO`
			`def readline_nonblock(sep = $INPUT_RECORD_SEPARATOR)`
Enable/fix optional Ruby frozen string literal usage Combined with https://github.com/Homebrew/homebrew-test-bot/pull/247 this will test Homebrew's use of frozen strings in CI. After this we will then enable it for Homebrew developers and eventually all Homebrew users. 2019-04-18 17:33:02 +09:00			`line = +""`
			`buffer = +""`
Ensure `readline_nonblock` returns an UTF-8 string. 2017-04-20 04:47:03 +02:00
Add Utils popen sigs, enable IO types 2023-03-30 15:04:25 -07:00			`begin`
			`loop do`
			`break if buffer == sep`
Update to RuboCop 0.59.1. 2018-09-17 02:45:00 +02:00
Add Utils popen sigs, enable IO types 2023-03-30 15:04:25 -07:00			`read_nonblock(1, buffer)`
			`line.concat(buffer)`
			`end`
Ensure `readline_nonblock` returns an UTF-8 string. 2017-04-20 04:47:03 +02:00
Add Utils popen sigs, enable IO types 2023-03-30 15:04:25 -07:00			`line.freeze`
			`rescue IO::WaitReadable, EOFError`
			`raise if line.empty?`
Update to RuboCop 0.59.1. 2018-09-17 02:45:00 +02:00
Add Utils popen sigs, enable IO types 2023-03-30 15:04:25 -07:00			`line.freeze`
			`end`
init 2016-08-18 22:11:42 +03:00			`end`
			`end`