123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Cop::Style::RedundantStructKeywordInit

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::TargetRubyVersion, ::RuboCop::Cop::AutoCorrector, ::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/style/redundant_struct_keyword_init.rb

Overview

Checks for redundant keyword_init option for Struct.new.

Since Ruby 3.2, keyword_init in Struct.new defaults to nil behavior. Therefore, this cop detects and autocorrects redundant keyword_init: nil and keyword_init: true in Struct.new.

Examples:

# bad
Struct.new(:foo, keyword_init: nil)
Struct.new(:foo, keyword_init: true)

# good
Struct.new(:foo)

Cop Safety Information:

  • This autocorrect is unsafe because when the value of keyword_init changes from true to nil, the return value of Struct#keyword_init? changes.

Constant Summary

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

support_autocorrect?

::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::TargetRubyVersion - Extended

maximum_target_ruby_version, minimum_target_ruby_version, required_maximum_ruby_version, required_minimum_ruby_version, support_target_ruby_version?

::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

#keyword_init?(node)

[ GitHub ] 

  


# File 'lib/rubocop/cop/style/redundant_struct_keyword_init.rb', line 40



def_node_matcher :keyword_init?, <<~PATTERN
  {#redundant_keyword_init? #keyword_init_false?}
PATTERN


  








  

    #keyword_init_false?(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/redundant_struct_keyword_init.rb', line 50



def_node_matcher :keyword_init_false?, <<~PATTERN
  (pair (sym :keyword_init) (false))
PATTERN


  








  

    #on_csend(node)  
  



  

    


Alias for #on_send.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/redundant_struct_keyword_init.rb', line 66



alias on_csend on_send


  








  

    #on_send(node)  
    Also known as: #on_csend
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/redundant_struct_keyword_init.rb', line 54



def on_send(node)
  return if !struct_new?(node) || node.arguments.none? || !node.last_argument.hash_type?

  keyword_init_nodes = select_keyword_init_nodes(node)
  return if keyword_init_nodes.any? { |node| keyword_init_false?(node) }

  redundant_keyword_init_nodes = select_redundant_keyword_init_nodes(keyword_init_nodes)

  redundant_keyword_init_nodes.each do |redundant_keyword_init|
    register_offense(redundant_keyword_init)
  end
end


  








  

    #range(redundant_keyword_init)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/redundant_struct_keyword_init.rb', line 92



def range(redundant_keyword_init)
  if redundant_keyword_init.parent.left_siblings.last.is_a?(AST::Node)
    beginning_of_range = redundant_keyword_init.parent.left_siblings.last.source_range.end

    beginning_of_range.join(redundant_keyword_init.source_range.end)
  else
    redundant_keyword_init
  end
end


  








  

    #redundant_keyword_init?(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/redundant_struct_keyword_init.rb', line 45



def_node_matcher :redundant_keyword_init?, <<~PATTERN
  (pair (sym :keyword_init) {(true) (nil)})
PATTERN


  








  

    #register_offense(keyword_init)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/redundant_struct_keyword_init.rb', line 82



def register_offense(keyword_init)
  message = format(MSG, value: keyword_init.value.source)

  add_offense(keyword_init, message: message) do |corrector|
    range = range(keyword_init)

    corrector.remove(range)
  end
end


  








  

    #select_keyword_init_nodes(node)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/redundant_struct_keyword_init.rb', line 70



def select_keyword_init_nodes(node)
  node.last_argument.pairs.select do |pair|
    keyword_init?(pair)
  end
end


  








  

    #select_redundant_keyword_init_nodes(keyword_init_nodes)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/redundant_struct_keyword_init.rb', line 76



def select_redundant_keyword_init_nodes(keyword_init_nodes)
  keyword_init_nodes.select do |keyword_init_node|
    redundant_keyword_init?(keyword_init_node)
  end
end


  








  

    #struct_new?(node)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/cop/style/redundant_struct_keyword_init.rb', line 35



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