Class: RuboCop::Cop::Lint::ConstantDefinitionInBlock

Inherits:
Base
  • Object
show all
Includes:
AllowedMethods
Defined in:
lib/rubocop/cop/lint/constant_definition_in_block.rb

Overview

Do not define constants within a block, since the block’s scope does not isolate or namespace the constant in any way.

If you are trying to define that constant once, define it outside of the block instead, or use a variable or method if defining the constant in the outer scope would be problematic.

For meta-programming, use const_set.

Examples:

# bad
task :lint do
  FILES_TO_LINT = Dir['lib/*.rb']
end

# bad
describe 'making a request' do
  class TestRequest; end
end

# bad
module M
  extend ActiveSupport::Concern
  included do
    LIST = []
  end
end

# good
task :lint do
  files_to_lint = Dir['lib/*.rb']
end

# good
describe 'making a request' do
  let(:test_request) { Class.new }
  # see also `stub_const` for RSpec
end

# good
module M
  extend ActiveSupport::Concern
  included do
    const_set(:LIST, [])
  end
end

AllowedMethods: ['enums'] (default)

# good

# `enums` for Typed Enums via `T::Enum` in Sorbet.
# https://sorbet.org/docs/tenum
class TestEnum < T::Enum
  enums do
    Foo = new("foo")
  end
end

Constant Summary collapse

MSG = 
'Do not define constants this way within a block.'

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, autocorrect_incompatible_with, badge, #begin_investigation, callbacks_needed, #callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #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, #ready, #relevant_file?, 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

#constant_assigned_in_block?(node) ⇒ Object 



70
71
72
 
# File 'lib/rubocop/cop/lint/constant_definition_in_block.rb', line 70

def_node_matcher :constant_assigned_in_block?, <<~PATTERN
  ({^block_type? [^begin_type? ^^block_type?]} nil? ...)
PATTERN

#module_defined_in_block?(node) ⇒ Object 



75
76
77
 
# File 'lib/rubocop/cop/lint/constant_definition_in_block.rb', line 75

def_node_matcher :module_defined_in_block?, <<~PATTERN
  ({^block_type? [^begin_type? ^^block_type?]} ...)
PATTERN

#on_casgn(node) ⇒ Object 



79
80
81
82
83
 
# File 'lib/rubocop/cop/lint/constant_definition_in_block.rb', line 79

def on_casgn(node)
  return if !constant_assigned_in_block?(node) || allowed_method?(method_name(node))

  add_offense(node)
end

#on_class(node) ⇒ Object Also known as: on_module 



85
86
87
88
89
 
# File 'lib/rubocop/cop/lint/constant_definition_in_block.rb', line 85

def on_class(node)
  return if !module_defined_in_block?(node) || allowed_method?(method_name(node))

  add_offense(node)
end