brew/Library/Homebrew/os/linux.rb
Issy Long 45978435e7
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 15:24:27 +01:00

121 lines
2.8 KiB
Ruby

# typed: true # rubocop:todo Sorbet/StrictSigil
# frozen_string_literal: true
require "utils"
module OS
# Helper module for querying system information on Linux.
module Linux
# Get the OS version.
#
# @api internal
sig { returns(String) }
def self.os_version
if which("lsb_release")
lsb_info = Utils.popen_read("lsb_release", "-a")
description = lsb_info[/^Description:\s*(.*)$/, 1].force_encoding("UTF-8")
codename = lsb_info[/^Codename:\s*(.*)$/, 1]
if codename.blank? || (codename == "n/a")
description
else
"#{description} (#{codename})"
end
elsif (redhat_release = Pathname.new("/etc/redhat-release")).readable?
redhat_release.read.chomp
elsif ::OS_VERSION.present?
::OS_VERSION
else
"Unknown"
end
end
sig { returns(T::Boolean) }
def self.wsl?
/-microsoft/i.match?(OS.kernel_version.to_s)
end
sig { returns(Version) }
def self.wsl_version
return Version::NULL unless wsl?
kernel = OS.kernel_version.to_s
if Version.new(T.must(kernel[/^([0-9.]*)-.*/, 1])) > Version.new("5.15")
Version.new("2 (Microsoft Store)")
elsif kernel.include?("-microsoft")
Version.new("2")
elsif kernel.include?("-Microsoft")
Version.new("1")
else
Version::NULL
end
end
end
# rubocop:disable Style/Documentation
module Mac
::MacOS = OS::Mac
raise "Loaded OS::Linux on generic OS!" if ENV["HOMEBREW_TEST_GENERIC_OS"]
def self.version
odisabled "`MacOS.version` on Linux"
MacOSVersion::NULL
end
def self.full_version
odisabled "`MacOS.full_version` on Linux"
MacOSVersion::NULL
end
def self.languages
odisabled "`MacOS.languages` on Linux"
@languages ||= Array(ENV["LANG"]&.slice(/[a-z]+/)).uniq
end
def self.language
odisabled "`MacOS.language` on Linux"
languages.first
end
def self.sdk_root_needed?
odisabled "`MacOS.sdk_root_needed?` on Linux"
false
end
def self.sdk_path_if_needed(_version = nil)
odisabled "`MacOS.sdk_path_if_needed` on Linux"
nil
end
def self.sdk_path(_version = nil)
odisabled "`MacOS.sdk_path` on Linux"
nil
end
module Xcode
def self.version
odisabled "`MacOS::Xcode.version` on Linux"
::Version::NULL
end
def self.installed?
odisabled "`MacOS::Xcode.installed?` on Linux"
false
end
end
module CLT
def self.version
odisabled "`MacOS::CLT.version` on Linux"
::Version::NULL
end
def self.installed?
odisabled "`MacOS::CLT.installed?` on Linux"
false
end
end
end
# rubocop:enable Style/Documentation
end