# frozen_string_literal: true module RuboCop module Cop module RSpec # Checks for `let` definitions that come after an example. # # @example # # Bad # let(:foo) { bar } # # it 'checks what foo does' do # expect(foo).to be # end # # let(:some) { other } # # it 'checks what some does' do # expect(some).to be # end # # # Good # let(:foo) { bar } # let(:some) { other } # # it 'checks what foo does' do # expect(foo).to be # end # # it 'checks what some does' do # expect(some).to be # end class LetBeforeExamples < Cop MSG = 'Move `let` before the examples in the group.'.freeze def_node_matcher :let?, '(block (send nil? {:let :let!} ...) ...)' def_node_matcher :example_or_group?, <<-PATTERN { #{(Examples::ALL + ExampleGroups::ALL).block_pattern} #{Includes::EXAMPLES.send_pattern} } PATTERN def on_block(node) return unless example_group_with_body?(node) check_let_declarations(node.body) if multiline_block?(node.body) end def autocorrect(node) lambda do |corrector| first_example = find_first_example(node.parent) first_example_pos = first_example.loc.expression indent = "\n" + ' ' * first_example.loc.column corrector.insert_before(first_example_pos, source(node) + indent) corrector.remove(node_range_with_surrounding_space(node)) end end private def multiline_block?(block) block.begin_type? end def check_let_declarations(node) first_example = find_first_example(node) return unless first_example node.each_child_node do |child| next if child.sibling_index < first_example.sibling_index add_offense(child, location: :expression) if let?(child) end end def find_first_example(node) node.children.find { |sibling| example_or_group?(sibling) } end def node_range_with_surrounding_space(node) range = node_range(node) range_by_whole_lines(range, include_final_newline: true) end def source(node) node_range(node).source end def node_range(node) range_between(node.loc.expression.begin_pos, last_node_loc(node)) end def last_node_loc(node) heredoc = heredoc_lines(node).last if heredoc heredoc.loc.heredoc_end.end_pos else node.loc.end.end_pos end end def heredoc_lines(node) node.body.child_nodes.select { |n| n.loc.respond_to?(:heredoc_end) } end end end end end