Contents

module RuboCop
  module RSpec
    # Helper methods for top level describe cops
    module TopLevelDescribe
      extend NodePattern::Macros

      def_node_matcher :described_constant, <<-PATTERN
        (block $(send _ :describe $(const ...)) (args) $_)
      PATTERN

      def on_send(node)
        return unless respond_to?(:on_top_level_describe)
        return unless top_level_describe?(node)

        _receiver, _method_name, *args = *node

        on_top_level_describe(node, args)
      end

      private

      def top_level_describe?(node)
        _receiver, method_name, *_args = *node
        return false unless method_name == :describe

        top_level_nodes.include?(node)
      end

      def top_level_nodes
        nodes = describe_statement_children(root_node)
        # If we have no top level describe statements, we need to check any
        # blocks on the top level (e.g. after a require).
        if nodes.empty?
          nodes = node_children(root_node).map do |child|
            describe_statement_children(child) if child.type == :block
          end.flatten.compact
        end

        nodes
      end

      def root_node
        processed_source.ast
      end

      def single_top_level_describe?
        top_level_nodes.count == 1
      end

      def describe_statement_children(node)
        node_children(node).select do |element|
          element.type == :send && element.children[1] == :describe
        end
      end

      def node_children(node)
        node.children.select { |e| e.is_a? Parser::AST::Node }
      end
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
rubocop-rspec-1.8.0	lib/rubocop/rspec/top_level_describe.rb
rubocop-rspec-1.7.0	lib/rubocop/rspec/top_level_describe.rb