Class: RuboCop::Cop::Style::DataInheritance

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector, TargetRubyVersion
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/data_inheritance.rb

Overview

Checks for inheritance from ‘Data.define` to avoid creating the anonymous parent class.

Examples:

# bad
class Person < Data.define(:first_name, :last_name)
  def age
    42
  end
end

# good
Person = Data.define(:first_name, :last_name) do
  def age
    42
  end
end

Constant Summary collapse

MSG = 
"Don't extend an instance initialized by `Data.define`. " \
'Use a block to customize the class.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from TargetRubyVersion

minimum_target_ruby_version, required_minimum_ruby_version, support_target_ruby_version?

Methods inherited from Base

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

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

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Instance Method Details

#data_define?(node) ⇒ Object 



48
49
50
51
 
# File 'lib/rubocop/cop/style/data_inheritance.rb', line 48

def_node_matcher :data_define?, <<~PATTERN
  {(send (const {nil? cbase} :Data) :define ...)
   (block (send (const {nil? cbase} :Data) :define ...) ...)}
PATTERN

#on_class(node) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rubocop/cop/style/data_inheritance.rb', line 36

def on_class(node)
  return unless data_define?(node.parent_class)

  add_offense(node.parent_class) do |corrector|
    corrector.remove(range_with_surrounding_space(node.loc.keyword, newlines: false))
    corrector.replace(node.loc.operator, '=')

    correct_parent(node.parent_class, corrector)
  end
end