Class: RuboCop::Cop::FormulaAudit::DeprecateDisableReason
- Inherits:
-
RuboCop::Cop::FormulaCop
- Object
- Base
- RuboCop::Cop::FormulaCop
- RuboCop::Cop::FormulaAudit::DeprecateDisableReason
- Extended by:
- AutoCorrector
- Defined in:
- rubocops/deprecate_disable.rb
Overview
This cop audits deprecate!
and disable!
reasons.
Constant Summary collapse
- PUNCTUATION_MARKS =
%w[. ! ?].freeze
Instance Attribute Summary
Attributes inherited from RuboCop::Cop::FormulaCop
Instance Method Summary collapse
Methods inherited from RuboCop::Cop::FormulaCop
#audit_comments, #audit_urls, #caveats_strings, #depends_on?, #depends_on_name_type?, #formula_tap, #get_checksum_node, #on_class, #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(_node, _class_node, _parent_class_node, body_node) ⇒ Object
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 |
# File 'rubocops/deprecate_disable.rb', line 42 def audit_formula(_node, _class_node, _parent_class_node, body_node) [:deprecate!, :disable!].each do |method| node = find_node_method_by_name(body_node, method) next if node.nil? reason_found = T.let(false, T::Boolean) reason(node) do |reason_node| reason_found = true next if reason_node.sym_type? offending_node(reason_node) reason_string = string_content(reason_node) if reason_string.start_with?("it ") problem "Do not start the reason with `it`" do |corrector| corrector.replace(@offensive_node.source_range, "\"#{reason_string[3..]}\"") end end if PUNCTUATION_MARKS.include?(reason_string[-1]) problem "Do not end the reason with a punctuation mark" do |corrector| corrector.replace(@offensive_node.source_range, "\"#{reason_string.chop}\"") end end end next if reason_found case method when :deprecate! problem 'Add a reason for deprecation: `deprecate! because: "..."`' when :disable! problem 'Add a reason for disabling: `disable! because: "..."`' end end end |