lib/rspec/support/source.rb



RSpec::Support.require_rspec_support 'encoded_string'
RSpec::Support.require_rspec_support 'ruby_features'

module RSpec
  module Support
    # @private
    # Represents a Ruby source file and provides access to AST and tokens.
    class Source
      attr_reader :source, :path

      # This class protects us against having File read and expand_path
      # stubbed out within tests.
      class File
        class << self
          [:read, :expand_path].each do |method_name|
            define_method(method_name, &::File.method(method_name))
          end
        end
      end

      def self.from_file(path)
        source = File.read(path)
        new(source, path)
      end

      if String.method_defined?(:encoding)
        def initialize(source_string, path=nil)
          @source = RSpec::Support::EncodedString.new(source_string, Encoding.default_external)
          @path = path ? File.expand_path(path) : '(string)'
        end
      else # for 1.8.7
        # :nocov:
        def initialize(source_string, path=nil)
          @source = RSpec::Support::EncodedString.new(source_string)
          @path = path ? File.expand_path(path) : '(string)'
        end
        # :nocov:
      end

      def lines
        @lines ||= source.split("\n")
      end

      def inspect
        "#<#{self.class} #{path}>"
      end

      if RSpec::Support::RubyFeatures.ripper_supported?
        RSpec::Support.require_rspec_support 'source/node'
        RSpec::Support.require_rspec_support 'source/token'

        def ast
          @ast ||= begin
            require 'ripper'
            sexp = Ripper.sexp(source)
            raise SyntaxError unless sexp
            Node.new(sexp)
          end
        end

        def tokens
          @tokens ||= begin
            require 'ripper'
            tokens = Ripper.lex(source)
            Token.tokens_from_ripper_tokens(tokens)
          end
        end

        def nodes_by_line_number
          @nodes_by_line_number ||= begin
            nodes_by_line_number = ast.select(&:location).group_by { |node| node.location.line }
            Hash.new { |hash, key| hash[key] = [] }.merge(nodes_by_line_number)
          end
        end

        def tokens_by_line_number
          @tokens_by_line_number ||= begin
            nodes_by_line_number = tokens.group_by { |token| token.location.line }
            Hash.new { |hash, key| hash[key] = [] }.merge(nodes_by_line_number)
          end
        end
      end
    end
  end
end