Class: RuboCop::Cop::FormulaAudit::OptionDeclarations Private

Inherits:
RuboCop::Cop::FormulaCop show all
Defined in:
rubocops/lines.rb,
sorbet/rbi/dsl/rubo_cop/cop/formula_audit/option_declarations.rbi

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

This cop makes sure that options are used idiomatically.

Instance Attribute Summary

Attributes inherited from RuboCop::Cop::FormulaCop

#file_path

Instance Method Summary collapse

Methods inherited from RuboCop::Cop::FormulaCop

#audit_comments, #audit_urls, #caveats_strings, #dependency_name_hash_match?, #dependency_type_hash_match?, #depends_on?, #depends_on_name_type?, #formula_tap, #get_checksum_node, #on_class, #required_dependency?, #required_dependency_name?, #style_exceptions_dir, #tap_style_exception?, #versioned_formula?

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_formula(formula_nodes) ⇒ void

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.

This method returns an undefined value.

Parameters:



116
117
118
119
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'rubocops/lines.rb', line 116

def audit_formula(formula_nodes)
  return if (body_node = formula_nodes.body_node).nil?

  problem "Use new-style option definitions" if find_method_def(body_node, :options)

  if formula_tap == "homebrew-core"
    # Use of build.with? implies options, which are forbidden in homebrew/core
    find_instance_method_call(body_node, :build, :without?) do
      problem "Formulae in homebrew/core should not use `build.without?`."
    end
    find_instance_method_call(body_node, :build, :with?) do
      problem "Formulae in homebrew/core should not use `build.with?`."
    end

    return
  end

  depends_on_build_with(body_node) do |build_with_node|
    offending_node(build_with_node)
    problem "Use `:optional` or `:recommended` instead of `if #{build_with_node.source}`"
  end

  find_instance_method_call(body_node, :build, :without?) do |method|
    next unless unless_modifier?(method.parent)

    correct = method.source.gsub("out?", "?")
    problem "Use if #{correct} instead of unless #{method.source}"
  end

  find_instance_method_call(body_node, :build, :with?) do |method|
    next unless unless_modifier?(method.parent)

    correct = method.source.gsub("?", "out?")
    problem "Use if #{correct} instead of unless #{method.source}"
  end

  find_instance_method_call(body_node, :build, :with?) do |method|
    next unless expression_negated?(method)

    problem "Don't negate 'build.with?': use 'build.without?'"
  end

  find_instance_method_call(body_node, :build, :without?) do |method|
    next unless expression_negated?(method)

    problem "Don't negate 'build.without?': use 'build.with?'"
  end

  find_instance_method_call(body_node, :build, :without?) do |method|
    arg = parameters(method).first
    next unless (match = regex_match_group(arg, /^-?-?without-(.*)/))

    problem "Don't duplicate 'without': " \
            "Use `build.without? \"#{match[1]}\"` to check for \"--without-#{match[1]}\""
  end

  find_instance_method_call(body_node, :build, :with?) do |method|
    arg = parameters(method).first
    next unless (match = regex_match_group(arg, /^-?-?with-(.*)/))

    problem "Don't duplicate 'with': Use `build.with? \"#{match[1]}\"` to check for \"--with-#{match[1]}\""
  end

  find_instance_method_call(body_node, :build, :include?) do
    problem "`build.include?` is deprecated"
  end
end

#depends_on_build_with(node, *pattern, **kwargs, &block) ⇒ T.untyped

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.

Parameters:

Returns:

  • (T.untyped) 


17
 
# File 'sorbet/rbi/dsl/rubo_cop/cop/formula_audit/option_declarations.rbi', line 17

def depends_on_build_with(node, *pattern, **kwargs, &block); end

#unless_modifier?(node) ⇒ Boolean

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.

Returns:

  • (Boolean) 


184
185
186
187
188
 
# File 'rubocops/lines.rb', line 184

def unless_modifier?(node)
  return false unless node.if_type?

  node.modifier_form? && node.unless?
end