Class: RuboCop::Cop::Style::TopLevelMethodDefinition

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

Overview

Newcomers to ruby applications may write top-level methods, when ideally they should be organized in appropriate classes or modules. This cop looks for definitions of top-level methods and warns about them.

However for ruby scripts it is perfectly fine to use top-level methods. Hence this cop is disabled by default.

Examples:

# bad
def some_method
end

# bad
def self.some_method
end

# bad
define_method(:foo) { puts 1 }

# good
module Foo
  def some_method
  end
end

# good
class Foo
  def self.some_method
  end
end

# good
Struct.new do
  def some_method
  end
end

# good
class Foo
  define_method(:foo) { puts 1 }
end

Constant Summary collapse

MSG = 
'Do not define methods at the top-level.'
RESTRICT_ON_SEND = 
%i[define_method].freeze

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_block(node) ⇒ Object Also known as: on_numblock 



60
61
62
63
64
 
# File 'lib/rubocop/cop/style/top_level_method_definition.rb', line 60

def on_block(node)
  return unless define_method_block?(node) && top_level_method_definition?(node)

  add_offense(node)
end

#on_def(node) ⇒ Object Also known as: on_defs, on_send 



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

def on_def(node)
  return unless top_level_method_definition?(node)

  add_offense(node)
end