Class: RuboCop::Cop::Style::MethodDefParentheses
- Includes:
- ConfigurableEnforcedStyle, RangeHelp
- Defined in:
- lib/rubocop/cop/style/method_def_parentheses.rb
Overview
This cop checks for parentheses around the arguments in method definitions. Both instance and class/singleton methods are checked.
Constant Summary collapse
- MSG_PRESENT =
'Use def without parentheses.'
- MSG_MISSING =
'Use def with parentheses when there are ' \ 'parameters.'
Constants included from Util
Instance Attribute Summary
Attributes inherited from Cop
#config, #corrections, #offenses, #processed_source
Instance Method Summary collapse
- #autocorrect(node) ⇒ Object
- #on_def(node) ⇒ Object (also: #on_defs)
Methods included from ConfigurableEnforcedStyle
#alternative_style, #alternative_styles, #ambiguous_style_detected, #correct_style_detected, #detected_style, #detected_style=, #no_acceptable_style!, #no_acceptable_style?, #opposite_style_detected, #style, #style_detected, #style_parameter_name, #supported_styles, #unexpected_style_detected
Methods inherited from Cop
#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version
Methods included from AST::Sexp
Methods included from NodePattern::Macros
#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first
Methods included from AutocorrectLogic
#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?
Methods included from IgnoredNode
#ignore_node, #ignored_node?, #part_of_ignored_node?
Methods included from Util
begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character
Methods included from PathUtil
absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path
Constructor Details
This class inherits a constructor from RuboCop::Cop::Cop
Instance Method Details
#autocorrect(node) ⇒ Object
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/rubocop/cop/style/method_def_parentheses.rb', line 112 def autocorrect(node) lambda do |corrector| if node.args_type? # offense is registered on args node when parentheses are unwanted corrector.replace(node.loc.begin, ' ') corrector.remove(node.loc.end) else args_expr = node.arguments.source_range args_with_space = range_with_surrounding_space(range: args_expr, side: :left) just_space = range_between(args_with_space.begin_pos, args_expr.begin_pos) corrector.replace(just_space, '(') corrector.insert_after(args_expr, ')') end end end |
#on_def(node) ⇒ Object Also known as: on_defs
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 |
# File 'lib/rubocop/cop/style/method_def_parentheses.rb', line 95 def on_def(node) args = node.arguments if require_parentheses?(args) if arguments_without_parentheses?(node) missing_parentheses(node) else correct_style_detected end elsif parentheses?(args) unwanted_parentheses(args) else correct_style_detected end end |