Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module RSpec
      # Checks for long examples.
      #
      # A long example is usually more difficult to understand. Consider
      # extracting out some behaviour, e.g. with a `let` block, or a helper
      # method.
      #
      # @example
      #   # bad
      #   it do
      #     service = described_class.new
      #     more_setup
      #     more_setup
      #     result = service.call
      #     expect(result).to be(true)
      #   end
      #
      #   # good
      #   it do
      #     service = described_class.new
      #     result = service.call
      #     expect(result).to be(true)
      #   end
      class ExampleLength < Cop
        include CodeLength

        EXAMPLE_BLOCKS = RuboCop::RSpec::Language::Examples::ALL

        def on_block(node)
          method, _args, _body = *node
          _receiver, method_name, _object = *method
          return unless EXAMPLE_BLOCKS.include?(method_name)

          length = code_length(node)

          return unless length > max_length
          add_offense(node, :expression, message(length))
        end

        private

        def code_length(node)
          lines = node.source.lines[1..-2]

          lines.count { |line| !irrelevant_line(line) }
        end

        def message(length)
          format('Example has too many lines. [%d/%d]', length, max_length)
        end
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
rubocop-rspec-1.12.0	lib/rubocop/cop/rspec/example_length.rb
rubocop-rspec-1.11.0	lib/rubocop/cop/rspec/example_length.rb
rubocop-rspec-1.10.0	lib/rubocop/cop/rspec/example_length.rb
rubocop-rspec-1.9.1	lib/rubocop/cop/rspec/example_length.rb
rubocop-rspec-1.9.0	lib/rubocop/cop/rspec/example_length.rb