Class: RuboCop::Cop::Style::BisectedAttrAccessor
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::RuboCop::Cop::AutoCorrector ,
::RuboCop::Cop::Base ,
::RuboCop::ExcludeLimit ,
NodePattern::Macros,
RuboCop::AST::Sexp
|
|
Instance Chain:
self,
::RuboCop::Cop::RangeHelp ,
::RuboCop::Cop::Base ,
::RuboCop::Cop::AutocorrectLogic ,
::RuboCop::Cop::IgnoredNode ,
::RuboCop::Util ,
RuboCop::AST::Sexp
|
|
Inherits: |
RuboCop::Cop::Base
|
Defined in: | lib/rubocop/cop/style/bisected_attr_accessor.rb, lib/rubocop/cop/style/bisected_attr_accessor/macro.rb |
Overview
Checks for places where attr_reader
and attr_writer
for the same method can be combined into single attr_accessor
.
Constant Summary
-
MSG =
# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 27'Combine both accessors into `attr_accessor %<name>s`.'
::RuboCop::Cop::Base
- Inherited
EMPTY_OFFENSES, RESTRICT_ON_SEND
::RuboCop::Cop::RangeHelp
- Included
Class Attribute Summary
::RuboCop::Cop::AutoCorrector
- Extended
::RuboCop::Cop::Base
- Inherited
.gem_requirements, .lint?, | |
.support_autocorrect? | Returns if class supports autocorrect. |
.support_multiple_source? | Override if your cop should be called repeatedly for multiple investigations Between calls to #on_new_investigation and |
Class Method Summary
::RuboCop::Cop::Base
- Inherited
.autocorrect_incompatible_with | List of cops that should not try to autocorrect at the same time as this cop. |
.badge | Naming. |
.callbacks_needed, .cop_name, .department, | |
.documentation_url | Returns a url to view this cops documentation online. |
.exclude_from_registry | Call for abstract Cop classes. |
.inherited, | |
.joining_forces | Override and return the Force class(es) you need to join. |
.match? | Returns true if the cop name or the cop namespace matches any of the given names. |
.new, | |
.requires_gem | Register a version requirement for the given gem name. |
.restrict_on_send |
::RuboCop::ExcludeLimit
- Extended
exclude_limit | Sets up a configuration option to have an exclude limit tracked. |
transform |
Instance Attribute Summary
::RuboCop::Cop::Base
- Inherited
::RuboCop::Cop::AutocorrectLogic
- Included
Instance Method Summary
-
#after_class(class_node)
(also: #after_sclass, #after_module)
Each offending macro is captured and registered in #on_class but correction happens in #after_class because a macro might have multiple attributes rewritten from it.
-
#after_module(class_node)
Alias for #after_class.
-
#after_sclass(class_node)
Alias for #after_class.
- #on_class(class_node) (also: #on_sclass, #on_module)
-
#on_module(class_node)
Alias for #on_class.
- #on_new_investigation
-
#on_sclass(class_node)
Alias for #on_class.
- #correct_reader(corrector, macro, node, range) private
- #correct_writer(corrector, macro, node, range) private
- #find_bisection(macros) private
- #find_macros(class_def) private
- #register_offense(attr) private
::RuboCop::Cop::RangeHelp
- Included
#add_range, #column_offset_between, | |
#contents_range | A range containing only the contents of a literal with delimiters (e.g. |
#directions, | |
#effective_column | Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value. |
#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range |
::RuboCop::Cop::Base
- Inherited
#add_global_offense | Adds an offense that has no particular location. |
#add_offense | Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense. |
#begin_investigation | Called before any investigation. |
#callbacks_needed, | |
#cop_config | Configuration Helpers. |
#cop_name, #excluded_file?, | |
#external_dependency_checksum | This method should be overridden when a cop’s behavior depends on state that lives outside of these locations: |
#inspect, | |
#message | Gets called if no message is specified when calling |
#name | Alias for Base#cop_name. |
#offenses, | |
#on_investigation_end | Called after all on_… |
#on_new_investigation | Called before all on_… |
#on_other_file | Called instead of all on_… |
#parse | There should be very limited reasons for a Cop to do it’s own parsing. |
#parser_engine, | |
#ready | Called between investigations. |
#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction, | |
#callback_argument | Reserved for Cop::Cop. |
#complete_investigation | Called to complete an investigation. |
#correct, #current_corrector, | |
#current_offense_locations | Reserved for Commissioner: |
#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range, | |
#reset_investigation | Actually private methods. |
#use_corrector |
::RuboCop::Cop::AutocorrectLogic
- Included
#disable_offense, #disable_offense_at_end_of_line, #disable_offense_before_and_after, #disable_offense_with_eol_or_surround_comment, #heredoc_range, #max_line_length, #multiline_ranges, #multiline_string?, | |
#range_by_lines | Expand the given range to include all of any lines it covers. |
#range_of_first_line, #range_overlaps_offense?, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array? |
::RuboCop::Cop::IgnoredNode
- Included
Constructor Details
This class inherits a constructor from RuboCop::Cop::Base
Instance Method Details
#after_class(class_node) Also known as: #after_sclass, #after_module
Each offending macro is captured and registered in #on_class but correction
happens in after_class
because a macro might have multiple attributes
rewritten from it
# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 55
def after_class(class_node) @macros_to_rewrite[class_node].each do |macro| node = macro.node range = range_by_whole_lines(node.source_range, include_final_newline: true) correct(range) do |corrector| if macro.writer? correct_writer(corrector, macro, node, range) else correct_reader(corrector, macro, node, range) end end end end
#after_module(class_node)
Alias for #after_class.
# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 70
alias after_module after_class
#after_sclass(class_node)
Alias for #after_class.
# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 69
alias after_sclass after_class
#correct_reader(corrector, macro, node, range) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 102
def correct_reader(corrector, macro, node, range) attr_accessor = "attr_accessor #{macro.bisected_names.join(', ')}\n" if macro.all_bisected? corrector.replace(range, "#{indent(node)}#{attr_accessor}") else correction = "#{indent(node)}attr_reader #{macro.rest.join(', ')}" corrector.insert_before(node, attr_accessor) corrector.replace(node, correction) end end
#correct_writer(corrector, macro, node, range) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 114
def correct_writer(corrector, macro, node, range) if macro.all_bisected? corrector.remove(range) else correction = "attr_writer #{macro.rest.join(', ')}" corrector.replace(node, correction) end end
#find_bisection(macros) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 91
def find_bisection(macros) # Find which attributes are defined in both readers and writers so that they # can be replaced with accessors. readers, writers = macros.partition(&:reader?) readers.flat_map(&:attr_names) & writers.flat_map(&:attr_names) end
#find_macros(class_def) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 74
def find_macros(class_def) # Find all the macros (`attr_reader`, `attr_writer`, etc.) in the class body # and turn them into `Macro` objects so that they can be processed. return {} if !class_def || class_def.def_type? send_nodes = if class_def.send_type? [class_def] else class_def.each_child_node(:send) end send_nodes.each_with_object([]) do |node, macros| macros << Macro.new(node) if Macro.macro?(node) end.group_by(&:visibility) end
#on_class(class_node) Also known as: #on_sclass, #on_module
[ GitHub ]# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 33
def on_class(class_node) @macros_to_rewrite[class_node] = Set.new find_macros(class_node.body).each_value do |macros| bisected = find_bisection(macros) next unless bisected.any? macros.each do |macro| attrs = macro.bisect(*bisected) next if attrs.none? @macros_to_rewrite[class_node] << macro attrs.each { |attr| register_offense(attr) } end end end
#on_module(class_node)
Alias for #on_class.
# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 50
alias on_module on_class
#on_new_investigation
[ GitHub ]# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 29
def on_new_investigation @macros_to_rewrite = {} end
#on_sclass(class_node)
Alias for #on_class.
# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 49
alias on_sclass on_class
#register_offense(attr) (private)
[ GitHub ]# File 'lib/rubocop/cop/style/bisected_attr_accessor.rb', line 98
def register_offense(attr) add_offense(attr, message: format(MSG, name: attr.source)) end