Class: RuboCop::Cop::Layout::SpaceAroundKeyword

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/layout/space_around_keyword.rb

Overview

Checks the spacing around the keywords.

Examples:


# bad
something 'test'do|x|
end

while(something)
end

something = 123if test

# good
something 'test' do |x|
end

while (something)
end

something = 123 if test

Constant Summary collapse

MSG_BEFORE = 
'Space before keyword `%<range>s` is missing.'
MSG_AFTER = 
'Space after keyword `%<range>s` is missing.'
DO = 
'do'
SAFE_NAVIGATION = 
'&.'
NAMESPACE_OPERATOR = 
'::'
ACCEPT_LEFT_PAREN = 
%w[break defined? next not rescue return super yield].freeze
ACCEPT_LEFT_SQUARE_BRACKET = 
%w[super yield].freeze
ACCEPT_NAMESPACE_OPERATOR = 
'super'

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 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_and(node) ⇒ Object 



40
41
42
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 40

def on_and(node)
  check(node, [:operator].freeze) if node.keyword?
end

#on_block(node) ⇒ Object

rubocop:disable InternalAffairs/NumblockHandler



44
45
46
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 44

def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler
  check(node, %i[begin end].freeze)
end

#on_break(node) ⇒ Object 



48
49
50
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 48

def on_break(node)
  check(node, [:keyword].freeze)
end

#on_case(node) ⇒ Object 



52
53
54
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 52

def on_case(node)
  check(node, %i[keyword else].freeze)
end

#on_case_match(node) ⇒ Object 



56
57
58
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 56

def on_case_match(node)
  check(node, %i[keyword else].freeze)
end

#on_defined?(node) ⇒ Boolean

Returns:

  • (Boolean) 


156
157
158
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 156

def on_defined?(node)
  check(node, [:keyword].freeze)
end

#on_ensure(node) ⇒ Object 



60
61
62
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 60

def on_ensure(node)
  check(node, [:keyword].freeze)
end

#on_for(node) ⇒ Object 



64
65
66
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 64

def on_for(node)
  check(node, %i[begin end].freeze)
end

#on_if(node) ⇒ Object 



68
69
70
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 68

def on_if(node)
  check(node, %i[keyword else begin end].freeze, 'then')
end

#on_if_guard(node) ⇒ Object 



72
73
74
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 72

def on_if_guard(node)
  check(node, [:keyword].freeze)
end

#on_in_pattern(node) ⇒ Object 



76
77
78
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 76

def on_in_pattern(node)
  check(node, [:keyword].freeze)
end

#on_kwbegin(node) ⇒ Object 



80
81
82
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 80

def on_kwbegin(node)
  check(node, %i[begin end].freeze, nil)
end

#on_match_pattern(node) ⇒ Object

Handle one-line pattern matching syntax (‘in`) with `Parser::Ruby27`.



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

def on_match_pattern(node)
  return if target_ruby_version >= 3.0

  check(node, [:operator].freeze)
end

#on_match_pattern_p(node) ⇒ Object

Handle one-line pattern matching syntax (‘in`) with `Parser::Ruby30`.



92
93
94
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 92

def on_match_pattern_p(node)
  check(node, [:operator].freeze)
end

#on_next(node) ⇒ Object 



96
97
98
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 96

def on_next(node)
  check(node, [:keyword].freeze)
end

#on_or(node) ⇒ Object 



100
101
102
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 100

def on_or(node)
  check(node, [:operator].freeze) if node.keyword?
end

#on_postexe(node) ⇒ Object 



104
105
106
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 104

def on_postexe(node)
  check(node, [:keyword].freeze)
end

#on_preexe(node) ⇒ Object 



108
109
110
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 108

def on_preexe(node)
  check(node, [:keyword].freeze)
end

#on_resbody(node) ⇒ Object 



112
113
114
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 112

def on_resbody(node)
  check(node, [:keyword].freeze)
end

#on_rescue(node) ⇒ Object 



116
117
118
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 116

def on_rescue(node)
  check(node, [:else].freeze)
end

#on_return(node) ⇒ Object 



120
121
122
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 120

def on_return(node)
  check(node, [:keyword].freeze)
end

#on_send(node) ⇒ Object 



124
125
126
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 124

def on_send(node)
  check(node, [:selector].freeze) if node.prefix_not?
end

#on_super(node) ⇒ Object 



128
129
130
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 128

def on_super(node)
  check(node, [:keyword].freeze)
end

#on_unless_guard(node) ⇒ Object 



136
137
138
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 136

def on_unless_guard(node)
  check(node, [:keyword].freeze)
end

#on_until(node) ⇒ Object 



140
141
142
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 140

def on_until(node)
  check(node, %i[begin end keyword].freeze)
end

#on_when(node) ⇒ Object 



144
145
146
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 144

def on_when(node)
  check(node, [:keyword].freeze)
end

#on_while(node) ⇒ Object 



148
149
150
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 148

def on_while(node)
  check(node, %i[begin end keyword].freeze)
end

#on_yield(node) ⇒ Object 



152
153
154
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 152

def on_yield(node)
  check(node, [:keyword].freeze)
end

#on_zsuper(node) ⇒ Object 



132
133
134
 
# File 'lib/rubocop/cop/layout/space_around_keyword.rb', line 132

def on_zsuper(node)
  check(node, [:keyword].freeze)
end