Class: RuboCop::Cop::Metrics::BlockLength

Inherits:
Base
  • Object
show all
Includes:
CodeLength, IgnoredMethods
Defined in:
lib/rubocop/cop/metrics/block_length.rb

Overview

This cop checks if the length of a block exceeds some maximum value. Comment lines can optionally be ignored. The maximum allowed length is configurable. The cop can be configured to ignore blocks passed to certain methods.

You can set literals you want to fold with ‘CountAsOne`. Available are: ’array’, ‘hash’, and ‘heredoc’. Each literal will be counted as one line regardless of its actual size.

NOTE: The ‘ExcludedMethods` configuration is deprecated and only kept for backwards compatibility. Please use `IgnoredMethods` instead.

NOTE: This cop does not apply for ‘Struct` definitions.

Examples:

CountAsOne: [‘array’, ‘heredoc’]


something do
  array = [         # +1
    1,
    2
  ]

  hash = {          # +3
    key: 'value'
  }

  msg = "    Heredoc\n    content.\n  HEREDOC\nend                 # 5 points\n"  # +1

Constant Summary collapse

LABEL = 
'Block'

Constants included from CodeLength

CodeLength::MSG

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 IgnoredMethods

#ignored_method?, #ignored_methods, included

Methods included from ExcludeLimit

#exclude_limit

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #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, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #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_block(node) ⇒ Object 



46
47
48
49
50
51
52
 
# File 'lib/rubocop/cop/metrics/block_length.rb', line 46

def on_block(node)
  return if ignored_method?(node.method_name)
  return if method_receiver_excluded?(node)
  return if node.class_constructor? || node.struct_constructor?

  check_code_length(node)
end