Класс: RuboCop::Cop::FormulaAudit::ComponentsOrder Закрытый

135
136
137
138

# File 'rubocops/components_order.rb', line 135

def check_block_component_order(component_precedence_list, block)
  @present_components, offensive_node = check_order(component_precedence_list, block.body)
  component_problem(*offensive_node) if offensive_node
end

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
183
184
185
186
187
188

# File 'rubocops/components_order.rb', line 146

def check_on_system_block_content(component_precedence_list, on_system_block)
  if on_system_block.body.block_type? && !on_system_methods.include?(on_system_block.body.method_name) &&
     on_system_block.body.method_name != :fails_with
    offending_node(on_system_block)
    problem "Nest `#{on_system_block.method_name}` blocks inside `#{on_system_block.body.method_name}` " \
            "blocks when there is only one inner block." do |corrector|
      original_source = on_system_block.source.split("\n")
      new_source = [original_source.second, original_source.first, *original_source.drop(2)]
      corrector.replace(on_system_block.source_range, new_source.join("\n"))
    end
  end
  on_system_allowed_methods = %w[livecheckkeg_onlydisable!deprecate!depends_onconflicts_withfails_withresourcepatchpour_bottle?]
  on_system_allowed_methods += on_system_methods.map(&:to_s)
  _, offensive_node = check_order(component_precedence_list, on_system_block.body)
  component_problem(*offensive_node) if offensive_node
  child_nodes = on_system_block.body.begin_type? ? on_system_block.body.child_nodes : [on_system_block.body]
  child_nodes.each do |child|
    valid_node = depends_on_node?(child)
    # Check for RuboCop::AST::SendNode and RuboCop::AST::BlockNode instances
    # only, as we are checking the method_name for `patch`, `resource`, etc.
    method_type = child.send_type? || child.block_type?
    next unless method_type

    valid_node ||= on_system_allowed_methods.include? child.method_name.to_s

    @offensive_node = child
    next if valid_node

    problem "`#{on_system_block.method_name}` cannot include `#{child.method_name}`. " \
            "Only #{on_system_allowed_methods.map { |m| "`#{m}`" }.to_sentence} are allowed."
  end
end

230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257

# File 'rubocops/components_order.rb', line 230

def check_order(component_precedence_list, body_node)
  present_components = component_precedence_list.map do |components|
    components.flat_map do |component|
      case component[:type]
      when :method_call
        find_method_calls_by_name(body_node, component[:name]).to_a
      when :block_call
        find_blocks(body_node, component[:name]).to_a
      when :method_definition
        find_method_def(body_node, component[:name])
      end
    end.compact
  end

  # Check if each present_components is above rest of the present_components
  offensive_nodes = T.let(nil, T.nilable(T::Array[RuboCop::AST::Node]))
  present_components.take(present_components.size - 1).each_with_index do |preceding_component, p_idx|
    next if preceding_component.empty?

    present_components.drop(p_idx + 1).each do |succeeding_component|
      next if succeeding_component.empty?

      offensive_nodes = check_precedence(preceding_component, succeeding_component)
      return [present_components, offensive_nodes] if offensive_nodes
    end
  end
  nil
end

261
262
263
264
265
266
267
268
269

# File 'rubocops/components_order.rb', line 261

def component_problem(component1, component2)
  return if tap_style_exception? :components_order_exceptions

  problem "`#{format_component(component1)}` (line #{line_number(component1)}) " \
          "should be put before `#{format_component(component2)}` " \
          "(line #{line_number(component2)})" do |corrector|
    reorder_components(corrector, component1, component2)
  end
end

10

# File 'sorbet/rbi/dsl/rubo_cop/cop/formula_audit/components_order.rbi', line 10

def depends_on_node?(node, **kwargs, &block); end

217
218
219
220
221
222

# File 'rubocops/components_order.rb', line 217

def get_state(node1)
  T.must(@present_components).each_with_index do |comp, idx|
    return [idx, T.must(comp.index(node1)), comp] if comp.member?(node1)
  end
  raise "Could not find node1 in present_components"
end

194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213

# File 'rubocops/components_order.rb', line 194

def reorder_components(corrector, node1, node2)
  # order_idx : node1's index in component_precedence_list
  # curr_p_idx: node1's index in preceding_comp_arr
  # preceding_comp_arr: array containing components of same type
  order_idx, curr_p_idx, preceding_comp_arr = get_state(node1)

  # curr_p_idx.positive? means node1 needs to be grouped with its own kind
  if curr_p_idx.positive?
    node2 = preceding_comp_arr.fetch(curr_p_idx - 1)
    indentation = "" * (start_column(node2) - line_start_column(node2))
    line_breaks = node2.multiline? ? "\n\n" : "\n"
    corrector.insert_after(node2.source_range, line_breaks + indentation + node1.source)
  else
    indentation = "" * (start_column(node2) - line_start_column(node2))
    # No line breaks up to version_scheme, order_idx == 8
    line_breaks = (order_idx > 8) ? "\n\n" : "\n"
    corrector.insert_before(node2.source_range, node1.source + line_breaks + indentation)
  end
  corrector.remove(range_with_surrounding_space(range: node1.source_range, side: :left))
end