class RuboCop::Cop::RSpec::NestedGroups
Checks for nested example groups.
This cop is configurable using the `Max` option and supports `–auto-gen-config
@example
# bad context 'when using some feature' do let(:some) { :various } let(:feature) { :setup } context 'when user is signed in' do # flagged by rubocop let(:user) do UserCreate.call(user_attributes) end let(:user_attributes) do { name: 'John', age: 22, role: role } end context 'when user is an admin' do # flagged by rubocop let(:role) { 'admin' } it 'blah blah' it 'yada yada' end end end # better context 'using some feature as an admin' do let(:some) { :various } let(:feature) { :setup } let(:user) do UserCreate.call( name: 'John', age: 22, role: 'admin' ) end it 'blah blah' it 'yada yada' end
@example configuration
# .rubocop.yml # RSpec/NestedGroups: # Max: 2 context 'when using some feature' do let(:some) { :various } let(:feature) { :setup } context 'when user is signed in' do let(:user) do UserCreate.call(user_attributes) end let(:user_attributes) do { name: 'John', age: 22, role: role } end context 'when user is an admin' do # flagged by rubocop let(:role) { 'admin' } it 'blah blah' it 'yada yada' end end end
Constants
- DEPRECATED_MAX_KEY
- DEPRECATION_WARNING
- MSG
Public Instance Methods
on_top_level_describe(node, _args)
click to toggle source
# File lib/rubocop/cop/rspec/nested_groups.rb, line 102 def on_top_level_describe(node, _args) find_nested_contexts(node.parent) do |context, nesting| self.max = nesting add_offense( context.send_node, location: :expression, message: message(nesting) ) end end
Private Instance Methods
find_nested_contexts(node, nesting: 1) { |nested_context, nesting| ... }
click to toggle source
# File lib/rubocop/cop/rspec/nested_groups.rb, line 115 def find_nested_contexts(node, nesting: 1, &block) find_contexts(node) do |nested_context| yield(nested_context, nesting) if nesting > max_nesting nested_context.each_child_node do |child| find_nested_contexts(child, nesting: nesting + 1, &block) end end end
max_nesting()
click to toggle source
# File lib/rubocop/cop/rspec/nested_groups.rb, line 129 def max_nesting @max_nesting ||= Integer(max_nesting_config) end
max_nesting_config()
click to toggle source
# File lib/rubocop/cop/rspec/nested_groups.rb, line 133 def max_nesting_config if cop_config.key?(DEPRECATED_MAX_KEY) warn DEPRECATION_WARNING cop_config.fetch(DEPRECATED_MAX_KEY) else cop_config.fetch('Max', 3) end end
message(nesting)
click to toggle source
# File lib/rubocop/cop/rspec/nested_groups.rb, line 125 def message(nesting) format(MSG, total: nesting, max: max_nesting) end