Module: RuboCop::Cop::OnSystemConditionalsHelper Private
- Extended by:
- NodePattern::Macros
- Includes:
- HelperFunctions
- Included in:
- Cask::OnSystemConditionals, FormulaAudit::OnSystemConditionals
- Defined in:
- rubocops/shared/on_system_conditionals_helper.rb
Overview
This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.
This module performs common checks on on_{system}
blocks in both formulae and casks.
Constant Summary collapse
- ARCH_OPTIONS =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
[:arm, :intel].freeze
- BASE_OS_OPTIONS =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
[:macos, :linux].freeze
- MACOS_VERSION_OPTIONS =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
MacOSVersion::SYMBOLS.keys.freeze
- ON_SYSTEM_OPTIONS =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
[*ARCH_OPTIONS, *BASE_OS_OPTIONS, *MACOS_VERSION_OPTIONS, :system].freeze
- MACOS_VERSION_CONDITIONALS =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
{ "==" => nil, "<=" => :or_older, ">=" => :or_newer, }.freeze
Instance Method Summary collapse
-
#audit_arch_conditionals(body_node, allowed_methods: [], allowed_blocks: []) ⇒ Object
private
-
#audit_base_os_conditionals(body_node, allowed_methods: [], allowed_blocks: []) ⇒ Object
private
-
#audit_macos_version_conditionals(body_node, allowed_methods: [], allowed_blocks: [], recommend_on_system: true) ⇒ Object
private
-
#audit_on_system_blocks(body_node, parent_name) ⇒ Object
private
Methods included from HelperFunctions
#block_method_called_in_block?, #block_size, #check_precedence, #class_name, #component_precedes?, #end_column, #expression_negated?, #find_all_blocks, #find_block, #find_blocks, #find_const, #find_every_func_call_by_name, #find_every_method_call_by_name, #find_instance_call, #find_instance_method_call, #find_method_calls_by_name, #find_method_def, #find_method_with_args, #find_node_method_by_name, #find_strings, #format_component, #line_number, #line_start_column, #method_called?, #method_called_ever?, #method_name, #node_equals?, #offending_node, #parameters, #parameters_passed?, #problem, #regex_match_group, #size, #source_buffer, #start_column, #string_content
Instance Method Details
#audit_arch_conditionals(body_node, allowed_methods: [], allowed_blocks: []) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'rubocops/shared/on_system_conditionals_helper.rb', line 81 def audit_arch_conditionals(body_node, allowed_methods: [], allowed_blocks: []) ARCH_OPTIONS.each do |arch_option| else_method = (arch_option == :arm) ? :on_intel : :on_arm if_arch_node_search(body_node, arch: :"#{arch_option}?") do |if_node, else_node| next if if_node_is_allowed?(if_node, allowed_methods: allowed_methods, allowed_blocks: allowed_blocks) if_statement_problem(if_node, "if Hardware::CPU.#{arch_option}?", "on_#{arch_option}", 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| # These should already be caught by `if_arch_node_search` next if method_node.parent.source.start_with? "if #{method_node.source}" 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 |
#audit_base_os_conditionals(body_node, allowed_methods: [], allowed_blocks: []) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'rubocops/shared/on_system_conditionals_helper.rb', line 104 def audit_base_os_conditionals(body_node, allowed_methods: [], allowed_blocks: []) BASE_OS_OPTIONS.each do |base_os_option| os_method, else_method = if base_os_option == :macos [:mac?, :on_linux] else [:linux?, :on_macos] end if_base_os_node_search(body_node, base_os: os_method) do |if_node, else_node| next if if_node_is_allowed?(if_node, allowed_methods: allowed_methods, allowed_blocks: allowed_blocks) if_statement_problem(if_node, "if OS.#{os_method}", "on_#{base_os_option}", else_method: else_method, else_node: else_node) end end end |
#audit_macos_version_conditionals(body_node, allowed_methods: [], allowed_blocks: [], recommend_on_system: true) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 |
# File 'rubocops/shared/on_system_conditionals_helper.rb', line 120 def audit_macos_version_conditionals(body_node, allowed_methods: [], allowed_blocks: [], recommend_on_system: true) MACOS_VERSION_OPTIONS.each do |macos_version_option| if_macos_version_node_search(body_node, os_version: macos_version_option) do |if_node, operator, else_node| next if if_node_is_allowed?(if_node, allowed_methods: allowed_methods, allowed_blocks: allowed_blocks) autocorrect = else_node.blank? && MACOS_VERSION_CONDITIONALS.key?(operator.to_s) on_system_method_string = if recommend_on_system && operator == :< "on_system" elsif recommend_on_system && operator == :<= "on_system :linux, macos: :#{macos_version_option}_or_older" elsif operator != :== && MACOS_VERSION_CONDITIONALS.key?(operator.to_s) "on_#{macos_version_option} :#{MACOS_VERSION_CONDITIONALS[operator.to_s]}" else "on_#{macos_version_option}" end if_statement_problem(if_node, "if MacOS.version #{operator} :#{macos_version_option}", on_system_method_string, autocorrect: autocorrect) end macos_version_comparison_search(body_node, os_version: macos_version_option) do |method_node| # These should already be caught by `if_macos_version_node_search` next if method_node.parent.source.start_with? "if #{method_node.source}" 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_{macos_version}` blocks instead." end end end |
#audit_on_system_blocks(body_node, parent_name) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'rubocops/shared/on_system_conditionals_helper.rb', line 27 def audit_on_system_blocks(body_node, parent_name) parent_string = if body_node.def_type? "def #{parent_name}" else "#{parent_name} do" end ON_SYSTEM_OPTIONS.each do |on_system_option| on_system_method = :"on_#{on_system_option}" if_statement_string = if ARCH_OPTIONS.include?(on_system_option) "if Hardware::CPU.#{on_system_option}?" elsif BASE_OS_OPTIONS.include?(on_system_option) "if OS.#{(on_system_option == :macos) ? "mac" : "linux"}?" elsif on_system_option == :system "if OS.linux? || MacOS.version" else "if MacOS.version" end find_every_method_call_by_name(body_node, on_system_method).each do |on_system_node| if_conditional = "" if MACOS_VERSION_OPTIONS.include? on_system_option on_macos_version_method_call(on_system_node, on_method: on_system_method) do |on_method_parameters| if on_method_parameters.empty? if_conditional = " == :#{on_system_option}" else if_condition_operator = MACOS_VERSION_CONDITIONALS.key(on_method_parameters.first) if_conditional = " #{if_condition_operator} :#{on_system_option}" end end elsif on_system_option == :system on_system_method_call(on_system_node) do |macos_symbol| base_os, condition = macos_symbol.to_s.split(/_(?=or_)/).map(&:to_sym) if_condition_operator = MACOS_VERSION_CONDITIONALS.key(condition) if_conditional = " #{if_condition_operator} :#{base_os}" end end offending_node(on_system_node) problem "Don't use `#{on_system_node.source}` in `#{parent_string}`, " \ "use `#{if_statement_string}#{if_conditional}` instead." do |corrector| block_node = offending_node.parent next if block_node.type != :block # TODO: could fix corrector to handle this but punting for now. next if block_node.single_line? source_range = offending_node.source_range.join(offending_node.parent.loc.begin) corrector.replace(source_range, "#{if_statement_string}#{if_conditional}") end end end end |