Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module RSpec
      # Checks for `expect(...)` calls containing literal values.
      #
      # @example
      #   # bad
      #   expect(5).to eq(price)
      #   expect(/foo/).to eq(pattern)
      #   expect("John").to eq(name)
      #
      #   # good
      #   expect(price).to eq(5)
      #   expect(pattern).to eq(/foo/)
      #   expect(name).to eq("John")
      #
      class ExpectActual < Cop
        include RuboCop::RSpec::SpecOnly

        MSG = 'Provide the actual you are testing to `expect(...)`'.freeze

        SIMPLE_LITERALS = %i(
          true
          false
          nil
          int
          float
          str
          sym
          complex
          rational
          regopt
        ).freeze

        COMPLEX_LITERALS = %i(
          array
          hash
          pair
          irange
          erange
          regexp
        ).freeze

        def_node_matcher :expect, '(send _ :expect $_)'

        def on_send(node)
          expect_literal(node) do |argument|
            add_offense(argument, :expression)
          end
        end

        private

        # This is not implement using a NodePattern because it seems
        # to not be able to match against an explicit (nil) sexp
        def expect_literal(node)
          return unless (argument = expect(node))

          yield(argument) if literal?(argument)
        end

        def literal?(node)
          simple_literal?(node) || complex_literal?(node)
        end

        def simple_literal?(node)
          SIMPLE_LITERALS.include?(node.type)
        end

        def complex_literal?(node)
          COMPLEX_LITERALS.include?(node.type) &&
            node.each_child_node.all?(&method(:literal?))
        end
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
rubocop-rspec-1.8.0	lib/rubocop/cop/rspec/expect_actual.rb
rubocop-rspec-1.7.0	lib/rubocop/cop/rspec/expect_actual.rb