From a504d2c1aa5ad9c9a7e2740c6f154ca4ff513337 Mon Sep 17 00:00:00 2001 From: Rylan Polster Date: Thu, 25 Aug 2022 01:22:41 -0400 Subject: [PATCH] Check for loose `Hardware::CPU` method calls --- .../shared/on_system_conditionals_helper.rb | 13 ++++ .../cask/on_system_conditionals_spec.rb | 76 +++++++++++++++++++ 2 files changed, 89 insertions(+) diff --git a/Library/Homebrew/rubocops/shared/on_system_conditionals_helper.rb b/Library/Homebrew/rubocops/shared/on_system_conditionals_helper.rb index f8cfafaceb..b87541af2a 100644 --- a/Library/Homebrew/rubocops/shared/on_system_conditionals_helper.rb +++ b/Library/Homebrew/rubocops/shared/on_system_conditionals_helper.rb @@ -88,6 +88,15 @@ module RuboCop else_method: else_method, else_node: else_node) end end + + [:arch, :arm?, :intel?].each do |method| + hardware_cpu_search(body_node, method: method) do |method_node| + next if if_node_is_allowed?(method_node, allowed_methods: allowed_methods, allowed_blocks: allowed_blocks) + + offending_node(method_node) + problem "Don't use `#{method_node.source}`, use `on_arm` and `on_intel` blocks instead." + end + end end def audit_base_os_conditionals(body_node, allowed_methods: [], allowed_blocks: []) @@ -180,6 +189,10 @@ module RuboCop (send nil? :on_system (sym :linux) (hash (pair (sym :macos) (sym $_)))) PATTERN + def_node_search :hardware_cpu_search, <<~PATTERN + (send (const (const nil? :Hardware) :CPU) %method) + PATTERN + def_node_search :if_arch_node_search, <<~PATTERN $(if (send (const (const nil? :Hardware) :CPU) %arch) _ $_) PATTERN diff --git a/Library/Homebrew/test/rubocops/cask/on_system_conditionals_spec.rb b/Library/Homebrew/test/rubocops/cask/on_system_conditionals_spec.rb index a815225b27..1003a7c482 100644 --- a/Library/Homebrew/test/rubocops/cask/on_system_conditionals_spec.rb +++ b/Library/Homebrew/test/rubocops/cask/on_system_conditionals_spec.rb @@ -262,4 +262,80 @@ describe RuboCop::Cop::Cask::OnSystemConditionals do include_examples "does not report any offenses" end end + + context "when auditing loose `Hardware::CPU` method calls" do + context "when there is a `Hardware::CPU.arm?` reference" do + let(:source) do + <<-CASK.undent + cask 'foo' do + if Hardware::CPU.arm? && other_condition + sha256 "67cdb8a02803ef37fdbf7e0be205863172e41a561ca446cd84f0d7ab35a99d94" + else + sha256 "8c62a2b791cf5f0da6066a0a4b6e85f62949cd60975da062df44adf887f4370b" + end + end + CASK + end + let(:expected_offenses) do + [{ + message: "Don't use `Hardware::CPU.arm?`, use `on_arm` and `on_intel` blocks instead.", + severity: :convention, + line: 2, + column: 5, + source: "Hardware::CPU.arm?", + }] + end + + include_examples "reports offenses" + end + + context "when there is a `Hardware::CPU.intel?` reference" do + let(:source) do + <<-CASK.undent + cask 'foo' do + if Hardware::CPU.intel? && other_condition + sha256 "67cdb8a02803ef37fdbf7e0be205863172e41a561ca446cd84f0d7ab35a99d94" + else + sha256 "8c62a2b791cf5f0da6066a0a4b6e85f62949cd60975da062df44adf887f4370b" + end + end + CASK + end + let(:expected_offenses) do + [{ + message: "Don't use `Hardware::CPU.intel?`, use `on_arm` and `on_intel` blocks instead.", + severity: :convention, + line: 2, + column: 5, + source: "Hardware::CPU.intel?", + }] + end + + include_examples "reports offenses" + end + + context "when there is a `Hardware::CPU.arch` reference" do + let(:source) do + <<-CASK.undent + cask 'foo' do + version "1.2.3" + sha256 "67cdb8a02803ef37fdbf7e0be205863172e41a561ca446cd84f0d7ab35a99d94" + + url "https://example.com/foo-\#{version}-\#{Hardware::CPU.arch}.zip" + end + CASK + end + let(:expected_offenses) do + [{ + message: "Don't use `Hardware::CPU.arch`, use `on_arm` and `on_intel` blocks instead.", + severity: :convention, + line: 5, + column: 44, + source: "Hardware::CPU.arch", + }] + end + + include_examples "reports offenses" + end + end end