123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Lint::StructNewOverride

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
self, ::RuboCop::Cop::Base, ::RuboCop::Cop::AutocorrectLogic, ::RuboCop::Cop::IgnoredNode, ::RuboCop::Util, RuboCop::AST::Sexp
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/lint/struct_new_override.rb

Overview

Checks unexpected overrides of the Struct built-in methods via Struct.new.

Examples:

# bad
Bad = Struct.new(:members, :clone, :count)
b = Bad.new([], true, 1)
b.members #=> [] (overriding {Struct#members})
b.clone #=> true (overriding {Object#clone})
b.count #=> 1 (overriding {Enumerable#count})

# good
Good = Struct.new(:id, :name)
g = Good.new(1, "foo")
g.members #=> [:id, :name]
g.clone #=> #<struct Good id=1, name="foo">
g.count #=> 2

Constant Summary

  • MSG =
    # File 'lib/rubocop/cop/lint/struct_new_override.rb', line 25 
    '`%<member_name>s` member overrides `Struct#%<method_name>s` ' \
'and it may be unexpected.'
  • RESTRICT_ON_SEND =
    # File 'lib/rubocop/cop/lint/struct_new_override.rb', line 27 
    %i[new].freeze
  • STRUCT_MEMBER_NAME_TYPES =
    # File 'lib/rubocop/cop/lint/struct_new_override.rb', line 46 
    %i[sym str].freeze
  • STRUCT_METHOD_NAMES =

    This is based on Struct.instance_methods.sort in Ruby 4.0.0.

    # File 'lib/rubocop/cop/lint/struct_new_override.rb', line 30 
    %i[
  ! != !~ <=> == === [] []= __id__ __send__ all? any? chain chunk chunk_while class clone
  collect collect_concat compact count cycle deconstruct deconstruct_keys
  define_singleton_method detect dig display drop drop_while dup each each_cons each_entry
  each_pair each_slice each_with_index each_with_object entries enum_for eql? equal? extend
  filter filter_map find find_all find_index first flat_map freeze frozen? grep grep_v
  group_by hash include? inject inspect instance_eval instance_exec instance_of?
  instance_variable_defined? instance_variable_get instance_variable_set instance_variables
  is_a? itself kind_of? lazy length map max max_by member? members method methods
  min min_by minmax minmax_by nil? none? object_id one? partition private_methods
  protected_methods public_method public_methods public_send reduce reject
  remove_instance_variable respond_to? reverse_each select send singleton_class
  singleton_method singleton_methods size slice_after slice_before slice_when sort sort_by
  sum take take_while tally tap then to_a to_enum to_h to_s to_set uniq values values_at
  yield_self zip
].freeze

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::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 on_investigation_end, the result of processed_source will remain constant.

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

#active_support_extensions_enabled?, #always_autocorrect?, #config, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #processed_source, #string_literals_frozen_by_default?, #target_satisfies_all_gem_version_requirements?

::RuboCop::Cop::AutocorrectLogic - Included

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #autocorrect_with_disable_uncorrectable?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Instance Method Summary

::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 add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.
#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_gem_version

Returns a gems locked versions (i.e.
#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, #eol_comment, #eol_comment_would_be_inside_literal?, #heredoc_range, #line_with_eol_comment_too_long?, #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, #string_continuation?, #surrounding_heredoc?, #surrounding_percent_array?

::RuboCop::Cop::IgnoredNode - Included

#ignore_node, #ignored_node?, #part_of_ignored_node?, #ignored_nodes

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#on_send(node)

[ GitHub ] 

  


# File 'lib/rubocop/cop/lint/struct_new_override.rb', line 54



def on_send(node)
  return unless struct_new(node)

  node.arguments.each_with_index do |arg, index|
    # Ignore if the first argument is a class name
    next if index.zero? && arg.str_type?

    # Ignore if the argument is not a member name
    next unless STRUCT_MEMBER_NAME_TYPES.include?(arg.type)

    member_name = arg.value

    next unless STRUCT_METHOD_NAMES.include?(member_name.to_sym)

    message = format(MSG, member_name: member_name.inspect, method_name: member_name.to_s)
    add_offense(arg, message: message)
  end
end


  








  

    #struct_new(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/lint/struct_new_override.rb', line 49



def_node_matcher :struct_new, <<~PATTERN
  (send
    (const {nil? cbase} :Struct) :new ...)
PATTERN