Class: RuboCop::Cop::Style::OpenStructUse

Inherits:
Base
  • Object
show all
Defined in:
lib/rubocop/cop/style/open_struct_use.rb

Overview

Flags uses of OpenStruct, as it is now officially discouraged to be used for performance, version compatibility, and potential security issues.

Examples:


# bad
point = OpenStruct.new(x: 0, y: 1)

# good
Point = Struct.new(:x, :y)
point = Point.new(0, 1)

# also good
point = { x: 0, y: 1 }

# bad
test_double = OpenStruct.new(a: 'b')

# good (assumes test using rspec-mocks)
test_double = double
allow(test_double).to receive(:a).and_return('b')

Constant Summary collapse

MSG = 
'Avoid using `OpenStruct`; use `Struct`, `Hash`, a class or test doubles instead.'

Constants inherited from Base

Base::RESTRICT_ON_SEND

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

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

#on_const(node) ⇒ Object 



52
53
54
55
56
57
 
# File 'lib/rubocop/cop/style/open_struct_use.rb', line 52

def on_const(node)
  return unless uses_open_struct?(node)
  return if custom_class_or_module_definition?(node)

  add_offense(node)
end

#uses_open_struct?(node) ⇒ Object 



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

def_node_matcher :uses_open_struct?, <<~PATTERN
  (const {nil? (cbase)} :OpenStruct)
PATTERN