cosmicgraph 0.49.0

data/lib/solargraph/library.rb

@@ -0,0 +1,547 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Solargraph
+  # A Library handles coordination between a Workspace and an ApiMap.
+  #
+  class Library
+    include Logging
+
+    # @return [Solargraph::Workspace]
+    attr_reader :workspace
+
+    # @return [String, nil]
+    attr_reader :name
+
+    # @return [Source, nil]
+    attr_reader :current
+
+    # @param workspace [Solargraph::Workspace]
+    # @param name [String, nil]
+    def initialize workspace = Solargraph::Workspace.new, name = nil
+      @workspace = workspace
+      @name = name
+      @synchronized = false
+    end
+
+    def inspect
+      # Let's not deal with insane data dumps in spec failures
+      to_s
+    end
+
+    # True if the ApiMap is up to date with the library's workspace and open
+    # files.
+    #
+    # @return [Boolean]
+    def synchronized?
+      @synchronized
+    end
+
+    # Attach a source to the library.
+    #
+    # The attached source does not need to be a part of the workspace. The
+    # library will include it in the ApiMap while it's attached. Only one
+    # source can be attached to the library at a time.
+    #
+    # @param source [Source, nil]
+    # @return [void]
+    def attach source
+      mutex.synchronize do
+        if @current && (!source || @current.filename != source.filename) && source_map_hash.key?(@current.filename) && !workspace.has_file?(@current.filename)
+          source_map_hash.delete @current.filename
+          source_map_external_require_hash.delete @current.filename
+          @external_requires = nil
+          @synchronized = false
+        end
+        @current = source
+        maybe_map @current
+        catalog_inlock
+      end
+    end
+
+    # True if the specified file is currently attached.
+    #
+    # @param filename [String]
+    # @return [Boolean]
+    def attached? filename
+      !@current.nil? && @current.filename == filename
+    end
+    alias open? attached?
+
+    # Detach the specified file if it is currently attached to the library.
+    #
+    # @param filename [String]
+    # @return [Boolean] True if the specified file was detached
+    def detach filename
+      return false if @current.nil? || @current.filename != filename
+      attach nil
+      true
+    end
+
+    # True if the specified file is included in the workspace (but not
+    # necessarily open).
+    #
+    # @param filename [String]
+    # @return [Boolean]
+    def contain? filename
+      workspace.has_file?(filename)
+    end
+
+    # Create a source to be added to the workspace. The file is ignored if it is
+    # neither open in the library nor included in the workspace.
+    #
+    # @param filename [String]
+    # @param text [String] The contents of the file
+    # @return [Boolean] True if the file was added to the workspace.
+    def create filename, text
+      result = false
+      mutex.synchronize do
+        next unless contain?(filename) || open?(filename) || workspace.would_merge?(filename)
+        @synchronized = false
+        source = Solargraph::Source.load_string(text, filename)
+        workspace.merge(source)
+        result = true
+      end
+      result
+    end
+
+    # Create file sources from files on disk. A file is ignored if it is
+    # neither open in the library nor included in the workspace.
+    #
+    # @param filenames [Array<String>]
+    # @return [Boolean] True if at least one file was added to the workspace.
+    def create_from_disk *filenames
+      result = false
+      mutex.synchronize do
+        sources = filenames
+          .reject { |filename| File.directory?(filename) || !File.exist?(filename) }
+          .map { |filename| Solargraph::Source.load_string(File.read(filename), filename) }
+        result = workspace.merge(*sources)
+        sources.each { |source| maybe_map source }
+      end
+      result
+    end
+
+    # Delete files from the library. Deleting a file will make it unavailable
+    # for checkout and optionally remove it from the workspace unless the
+    # workspace configuration determines that it should still exist.
+    #
+    # @param filenames [Array<String>]
+    # @return [Boolean] True if any file was deleted
+    def delete *filenames
+      result = false
+      filenames.each do |filename|
+        detach filename
+        mutex.synchronize do
+          result ||= workspace.remove(filename)
+          @synchronized = !result if synchronized?
+        end
+      end
+      result
+    end
+
+    # Close a file in the library. Closing a file will make it unavailable for
+    # checkout although it may still exist in the workspace.
+    #
+    # @param filename [String]
+    # @return [void]
+    def close filename
+      mutex.synchronize do
+        @synchronized = false
+        @current = nil if @current && @current.filename == filename
+        catalog
+      end
+    end
+
+    # Get completion suggestions at the specified file and location.
+    #
+    # @param filename [String] The file to analyze
+    # @param line [Integer] The zero-based line number
+    # @param column [Integer] The zero-based column number
+    # @return [SourceMap::Completion]
+    # @todo Take a Location instead of filename/line/column
+    def completions_at filename, line, column
+      position = Position.new(line, column)
+      cursor = Source::Cursor.new(read(filename), position)
+      api_map.clip(cursor).complete
+    rescue FileNotFoundError => e
+      handle_file_not_found filename, e
+    end
+
+    # Get definition suggestions for the expression at the specified file and
+    # location.
+    #
+    # @param filename [String] The file to analyze
+    # @param line [Integer] The zero-based line number
+    # @param column [Integer] The zero-based column number
+    # @return [Array<Solargraph::Pin::Base>]
+    # @todo Take filename/position instead of filename/line/column
+    def definitions_at filename, line, column
+      position = Position.new(line, column)
+      cursor = Source::Cursor.new(read(filename), position)
+      if cursor.comment?
+        source = read(filename)
+        offset = Solargraph::Position.to_offset(source.code, Solargraph::Position.new(line, column))
+        lft = source.code[0..offset-1].match(/\[[a-z0-9_:<, ]*?([a-z0-9_:]*)\z/i)
+        rgt = source.code[offset..-1].match(/^([a-z0-9_]*)(:[a-z0-9_:]*)?[\]>, ]/i)
+        if lft && rgt
+          tag = (lft[1] + rgt[1]).sub(/:+$/, '')
+          clip = api_map.clip(cursor)
+          clip.translate tag
+        else
+          []
+        end
+      else
+        api_map.clip(cursor).define.map { |pin| pin.realize(api_map) }
+      end
+    rescue FileNotFoundError => e
+      handle_file_not_found(filename, e)
+    end
+
+    # Get signature suggestions for the method at the specified file and
+    # location.
+    #
+    # @param filename [String] The file to analyze
+    # @param line [Integer] The zero-based line number
+    # @param column [Integer] The zero-based column number
+    # @return [Array<Solargraph::Pin::Base>]
+    # @todo Take filename/position instead of filename/line/column
+    def signatures_at filename, line, column
+      position = Position.new(line, column)
+      cursor = Source::Cursor.new(read(filename), position)
+      api_map.clip(cursor).signify
+    end
+
+    # @param filename [String]
+    # @param line [Integer]
+    # @param column [Integer]
+    # @param strip [Boolean] Strip special characters from variable names
+    # @param only [Boolean] Search for references in the current file only
+    # @return [Array<Solargraph::Range>]
+    # @todo Take a Location instead of filename/line/column
+    def references_from filename, line, column, strip: false, only: false
+      cursor = api_map.cursor_at(filename, Position.new(line, column))
+      clip = api_map.clip(cursor)
+      pin = clip.define.first
+      return [] unless pin
+      result = []
+      files = if only
+        [api_map.source_map(filename)]
+      else
+        (workspace.sources + (@current ? [@current] : []))
+      end
+      files.uniq(&:filename).each do |source|
+        found = source.references(pin.name)
+        found.select! do |loc|
+          referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character).first
+          referenced && referenced.path == pin.path
+        end
+        # HACK: for language clients that exclude special characters from the start of variable names
+        if strip && match = cursor.word.match(/^[^a-z0-9_]+/i)
+          found.map! do |loc|
+            Solargraph::Location.new(loc.filename, Solargraph::Range.from_to(loc.range.start.line, loc.range.start.column + match[0].length, loc.range.ending.line, loc.range.ending.column))
+          end
+        end
+        result.concat(found.sort do |a, b|
+          a.range.start.line <=> b.range.start.line
+        end)
+      end
+      result.uniq
+    end
+
+    # Get the pins at the specified location or nil if the pin does not exist.
+    #
+    # @param location [Location]
+    # @return [Array<Solargraph::Pin::Base>]
+    def locate_pins location
+      api_map.locate_pins(location).map { |pin| pin.realize(api_map) }
+    end
+
+    def locate_ref location
+      map = source_map_hash[location.filename]
+      return if map.nil?
+      pin = map.requires.select { |p| p.location.range.contain?(location.range.start) }.first
+      return nil if pin.nil?
+      workspace.require_paths.each do |path|
+        full = Pathname.new(path).join("#{pin.name}.rb").to_s
+        next unless source_map_hash.key?(full)
+        return Location.new(full, Solargraph::Range.from_to(0, 0, 0, 0))
+      end
+      # api_map.yard_map.require_reference(pin.name)
+    rescue FileNotFoundError
+      nil
+    end
+
+    # Get an array of pins that match a path.
+    #
+    # @param path [String]
+    # @return [Array<Solargraph::Pin::Base>]
+    def get_path_pins path
+      api_map.get_path_suggestions(path)
+    end
+
+    # @param query [String]
+    # @return [Array<YARD::CodeObjects::Base>]
+    def document query
+      api_map.document query
+    end
+
+    # @param query [String]
+    # @return [Array<String>]
+    def search query
+      api_map.search query
+    end
+
+    # Get an array of all symbols in the workspace that match the query.
+    #
+    # @param query [String]
+    # @return [Array<Pin::Base>]
+    def query_symbols query
+      api_map.query_symbols query
+    end
+
+    # Get an array of document symbols.
+    #
+    # Document symbols are composed of namespace, method, and constant pins.
+    # The results of this query are appropriate for building the response to a
+    # textDocument/documentSymbol message in the language server protocol.
+    #
+    # @param filename [String]
+    # @return [Array<Solargraph::Pin::Base>]
+    def document_symbols filename
+      api_map.document_symbols(filename)
+    end
+
+    # @param path [String]
+    # @return [Array<Solargraph::Pin::Base>]
+    def path_pins path
+      api_map.get_path_suggestions(path)
+    end
+
+    def source_maps
+      source_map_hash.values
+    end
+
+    # Get the current text of a file in the library.
+    #
+    # @param filename [String]
+    # @return [String]
+    def read_text filename
+      source = read(filename)
+      source.code
+    end
+
+    # Get diagnostics about a file.
+    #
+    # @param filename [String]
+    # @return [Array<Hash>]
+    def diagnose filename
+      # @todo Only open files get diagnosed. Determine whether anything or
+      #   everything in the workspace should get diagnosed, or if there should
+      #   be an option to do so.
+      #
+      return [] unless open?(filename)
+      result = []
+      source = read(filename)
+      catalog
+      repargs = {}
+      workspace.config.reporters.each do |line|
+        if line == 'all!'
+          Diagnostics.reporters.each do |reporter|
+            repargs[reporter] ||= []
+          end
+        else
+          args = line.split(':').map(&:strip)
+          name = args.shift
+          reporter = Diagnostics.reporter(name)
+          raise DiagnosticsError, "Diagnostics reporter #{name} does not exist" if reporter.nil?
+          repargs[reporter] ||= []
+          repargs[reporter].concat args
+        end
+      end
+      repargs.each_pair do |reporter, args|
+        result.concat reporter.new(*args.uniq).diagnose(source, api_map)
+      end
+      result
+    end
+
+    # Update the ApiMap from the library's workspace and open files.
+    #
+    # @return [void]
+    def catalog
+      mutex.synchronize do
+        catalog_inlock
+      end
+    end
+
+    private def catalog_inlock
+        return if synchronized?
+        logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
+        api_map.catalog bench
+        @synchronized = true
+        logger.info "Catalog complete (#{api_map.source_maps.length} files, #{api_map.pins.length} pins)" if logger.info?
+    end
+
+    def bench
+      Bench.new(
+        source_maps: source_map_hash.values,
+        workspace: workspace,
+        external_requires: external_requires
+      )
+    end
+
+    # Get an array of foldable ranges for the specified file.
+    #
+    # @deprecated The library should not need to handle folding ranges. The
+    #   source itself has all the information it needs.
+    #
+    # @param filename [String]
+    # @return [Array<Range>]
+    def folding_ranges filename
+      read(filename).folding_ranges
+    end
+
+    # Create a library from a directory.
+    #
+    # @param directory [String] The path to be used for the workspace
+    # @param name [String, nil]
+    # @return [Solargraph::Library]
+    def self.load directory = '', name = nil
+      Solargraph::Library.new(Solargraph::Workspace.new(directory), name)
+    end
+
+    # Try to merge a source into the library's workspace. If the workspace is
+    # not configured to include the source, it gets ignored.
+    #
+    # @param source [Source]
+    # @return [Boolean] True if the source was merged into the workspace.
+    def merge source
+      Logging.logger.debug "Merging source: #{source.filename}"
+      result = false
+      mutex.synchronize do
+        result = workspace.merge(source)
+        maybe_map source
+      end
+      # catalog
+      result
+    end
+
+    def source_map_hash
+      @source_map_hash ||= {}
+    end
+
+    def mapped?
+      (workspace.filenames - source_map_hash.keys).empty?
+    end
+
+    def next_map
+      return false if mapped?
+      mutex.synchronize do
+        @synchronized = false
+        src = workspace.sources.find { |s| !source_map_hash.key?(s.filename) }
+        if src
+          Logging.logger.debug "Mapping #{src.filename}"
+          source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+          find_external_requires(source_map_hash[src.filename])
+          source_map_hash[src.filename]
+        else
+          false
+        end
+      end
+    end
+
+    def map!
+      workspace.sources.each do |src|
+        source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+        find_external_requires(source_map_hash[src.filename])
+      end
+      self
+    end
+
+    def pins
+      @pins ||= []
+    end
+
+    def external_requires
+      @external_requires ||= source_map_external_require_hash.values.flatten.to_set
+    end
+
+    private
+
+    def source_map_external_require_hash
+      @source_map_external_require_hash ||= {}
+    end
+
+    # @param source_map [SourceMap]
+    def find_external_requires source_map
+      new_set = source_map.requires.map(&:name).to_set
+      # return if new_set == source_map_external_require_hash[source_map.filename]
+      source_map_external_require_hash[source_map.filename] = new_set.reject do |path|
+        workspace.require_paths.any? do |base|
+          full = Pathname.new(base).join("#{path}.rb").to_s
+          workspace.filenames.include?(full)
+        end
+      end
+      @external_requires = nil
+    end
+
+    # @return [Mutex]
+    def mutex
+      @mutex ||= Mutex.new
+    end
+
+    # @return [ApiMap]
+    def api_map
+      @api_map ||= Solargraph::ApiMap.new
+    end
+
+    # Get the source for an open file or create a new source if the file
+    # exists on disk. Sources created from disk are not added to the open
+    # workspace files, i.e., the version on disk remains the authoritative
+    # version.
+    #
+    # @raise [FileNotFoundError] if the file does not exist
+    # @param filename [String]
+    # @return [Solargraph::Source]
+    def read filename
+      return @current if @current && @current.filename == filename
+      raise FileNotFoundError, "File not found: #{filename}" unless workspace.has_file?(filename)
+      workspace.source(filename)
+    end
+
+    def handle_file_not_found filename, error
+      if workspace.source(filename)
+        Solargraph.logger.debug "#{filename} is not cataloged in the ApiMap"
+        nil
+      else
+        raise error
+      end
+    end
+
+    def maybe_map source
+      return unless source
+      return unless @current == source || workspace.has_file?(source.filename)
+      if source_map_hash.key?(source.filename)
+        return if source_map_hash[source.filename].code == source.code &&
+          source_map_hash[source.filename].source.synchronized? &&
+          source.synchronized?
+        if source.synchronized?
+          new_map = Solargraph::SourceMap.map(source)
+          unless source_map_hash[source.filename].try_merge!(new_map)
+            source_map_hash[source.filename] = new_map
+            find_external_requires(source_map_hash[source.filename])
+            @synchronized = false
+          end
+        else
+          # @todo Smelly instance variable access
+          source_map_hash[source.filename].instance_variable_set(:@source, source)
+        end
+      else
+        source_map_hash[source.filename] = Solargraph::SourceMap.map(source)
+        find_external_requires(source_map_hash[source.filename])
+        @synchronized = false
+      end
+    end
+  end
+end

data/lib/solargraph/location.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Solargraph
+  # A section of text identified by its filename and range.
+  #
+  class Location
+    # @return [String]
+    attr_reader :filename
+
+    # @return [Solargraph::Range]
+    attr_reader :range
+
+    # @param filename [String]
+    # @param range [Solargraph::Range]
+    def initialize filename, range
+      @filename = filename
+      @range = range
+    end
+
+    # @return [Hash]
+    def to_hash
+      {
+        filename: filename,
+        range: range.to_hash
+      }
+    end
+
+    def == other
+      return false unless other.is_a?(Location)
+      filename == other.filename and range == other.range
+    end
+
+    def inspect
+      "#<#{self.class} #{filename}, #{range.inspect}>"
+    end
+  end
+end

data/lib/solargraph/logging.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Solargraph
+  module Logging
+    DEFAULT_LOG_LEVEL = Logger::WARN
+
+    LOG_LEVELS = {
+      'warn' => Logger::WARN,
+      'info' => Logger::INFO,
+      'debug' => Logger::DEBUG
+    }
+
+    @@logger = Logger.new(STDERR, level: DEFAULT_LOG_LEVEL)
+    @@logger.formatter = proc do |severity, datetime, progname, msg|
+      "[#{severity}] #{msg}\n"
+    end
+
+    module_function
+
+    # @return [Logger]
+    def logger
+      @@logger
+    end
+  end
+end

data/lib/solargraph/page.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+require 'tilt'
+require 'yard'
+require 'cgi'
+
+module Solargraph
+  class Page
+    class Binder < OpenStruct
+      # @param locals [Hash]
+      # @param render_method [Proc]
+      def initialize locals, render_method
+        super(locals)
+        define_singleton_method :render do |template, layout: false, locals: {}|
+          render_method.call(template, layout: layout, locals: locals)
+        end
+        define_singleton_method :erb do |template, layout: false, locals: {}|
+          render_method.call(template, layout: layout, locals: locals)
+        end
+      end
+
+      # @param text [String]
+      # @return [String]
+      def htmlify text
+        YARD::Templates::Helpers::Markup::RDocMarkup.new(text).to_html
+      end
+
+      # @param text [String]
+      # @return [String]
+      def escape text
+        CGI.escapeHTML(text)
+      end
+
+      # @param code [String]
+      # @return [String]
+      def ruby_to_html code
+        code
+      end
+    end
+    private_constant :Binder
+
+    # @param directory [String]
+    def initialize directory = VIEWS_PATH
+      directory = VIEWS_PATH if directory.nil? or !File.directory?(directory)
+      directories = [directory]
+      directories.push VIEWS_PATH if directory != VIEWS_PATH
+      # @type [Proc]
+      # @param template [String]
+      # @param layout [Boolean]
+      # @param locals [Hash]
+      @render_method = proc { |template, layout: false, locals: {}|
+        binder = Binder.new(locals, @render_method)
+        if layout
+          Tilt::ERBTemplate.new(Page.select_template(directories, 'layout')).render(binder) do
+            Tilt::ERBTemplate.new(Page.select_template(directories, template)).render(binder)
+          end
+        else
+          Tilt::ERBTemplate.new(Page.select_template(directories, template)).render(binder)
+        end
+      }
+    end
+
+    # @param template [String]
+    # @param layout [Boolean]
+    # @param locals [Hash]
+    # @return [String]
+    def render template, layout: true, locals: {}
+      @render_method.call(template, layout: layout, locals: locals)
+    end
+
+    # @param directories [Array<String>]
+    # @param name [String]
+    # @return [String]
+    def self.select_template directories, name
+      directories.each do |dir|
+        path = File.join(dir, "#{name}.erb")
+        return path if File.file?(path)
+      end
+      raise FileNotFoundError, "Template not found: #{name}"
+    end
+  end
+end