solargraph 0.29.5 → 0.30.0

data/lib/solargraph/language_server/host/cataloger.rb

@@ -12,8 +12,8 @@ module Solargraph
         # Notify the Cataloger that changes are pending.
         #
         # @return [void]
-        def ping
-          mutex.synchronize { pings.push nil }
+        def ping lib
+          mutex.synchronize { pings.push lib }
         end
 
         def synchronizing?
@@ -45,8 +45,9 @@ module Solargraph
               sleep 0.1
               next if pings.empty?
               mutex.synchronize do
-                host.catalog
-                pings.clear
+                lib = pings.shift
+                next if pings.include?(lib)
+                host.catalog lib
               end
             end
           end

data/lib/solargraph/language_server/message.rb

@@ -70,8 +70,10 @@ module Solargraph
       register 'textDocument/documentSymbol',      TextDocument::DocumentSymbol
       register 'textDocument/references',          TextDocument::References
       register 'textDocument/rename',              TextDocument::Rename
+      register 'textDocument/foldingRange',        TextDocument::FoldingRange
       register 'workspace/didChangeWatchedFiles',  Workspace::DidChangeWatchedFiles
       register 'workspace/didChangeConfiguration', Workspace::DidChangeConfiguration
+      register 'workspace/didChangeWorkspaceFolders', Workspace::DidChangeWorkspaceFolders
       register 'workspace/symbol',                 Workspace::WorkspaceSymbol
       register '$/cancelRequest',                  CancelRequest
       register '$/solargraph/document',            Extended::Document
@@ -79,6 +81,7 @@ module Solargraph
       register '$/solargraph/checkGemVersion',     Extended::CheckGemVersion
       register '$/solargraph/documentGems',        Extended::DocumentGems
       register '$/solargraph/downloadCore',        Extended::DownloadCore
+      register '$/solargraph/environment',         Extended::Environment
       register 'shutdown',                         Shutdown
       register 'exit',                             ExitNotification
     end

data/lib/solargraph/language_server/message/extended.rb

@@ -7,11 +7,12 @@ module Solargraph
       # ignore them, as per the LSP specification.
       #
       module Extended
-        autoload :Document, 'solargraph/language_server/message/extended/document'
-        autoload :Search, 'solargraph/language_server/message/extended/search'
+        autoload :Document,        'solargraph/language_server/message/extended/document'
+        autoload :Search,          'solargraph/language_server/message/extended/search'
         autoload :CheckGemVersion, 'solargraph/language_server/message/extended/check_gem_version'
-        autoload :DocumentGems, 'solargraph/language_server/message/extended/document_gems'
-        autoload :DownloadCore, 'solargraph/language_server/message/extended/download_core'
+        autoload :DocumentGems,    'solargraph/language_server/message/extended/document_gems'
+        autoload :DownloadCore,    'solargraph/language_server/message/extended/download_core'
+        autoload :Environment,     'solargraph/language_server/message/extended/environment'
       end
     end
   end

data/lib/solargraph/language_server/message/extended/document.rb

@@ -6,7 +6,7 @@ module Solargraph
           def process
             objects = host.document(params['query'])
             page = Solargraph::Page.new(host.options['viewsPath'])
-            content = page.render('document', locals: {objects: objects})
+            content = page.render('document', layout: true, locals: {objects: objects})
             set_result(
               content: content
             )

data/lib/solargraph/language_server/message/extended/environment.rb

@@ -0,0 +1,20 @@
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        # Update YARD documentation for installed gems. If the `rebuild`
+        # parameter is true, rebuild existing yardocs.
+        #
+        class Environment < Base
+          def process
+            page = Solargraph::Page.new(host.options['viewsPath'])
+            content = page.render('environment', layout: true, locals: { config: host.options, folders: host.folders })
+            set_result(
+              content: content
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/extended/search.rb

@@ -6,7 +6,7 @@ module Solargraph
           def process
             results = host.search(params['query'])
             page = Solargraph::Page.new(host.options['viewsPath'])
-            content = page.render('search', locals: {query: params['query'], results: results})
+            content = page.render('search', layout: true, locals: {query: params['query'], results: results})
             set_result(
               content: content
             )

data/lib/solargraph/language_server/message/initialize.rb

@@ -4,7 +4,10 @@ module Solargraph
       class Initialize < Base
         def process
           host.configure params['initializationOptions']
-          if params['rootUri']
+          if support_workspace_folders?
+            # @todo Prepare multiple folders
+            host.prepare_folders params['workspaceFolders']
+          elsif params['rootUri']
             host.prepare UriHelpers.uri_to_file(params['rootUri'])
           else
             host.prepare params['rootPath']
@@ -30,11 +33,18 @@ module Solargraph
           result[:capabilities].merge! static_rename unless dynamic_registration_for?('textDocument', 'rename')
           result[:capabilities].merge! static_references unless dynamic_registration_for?('textDocument', 'references')
           result[:capabilities].merge! static_workspace_symbols unless dynamic_registration_for?('workspace', 'symbol')
+          result[:capabilities].merge! static_folding_range unless dynamic_registration_for?('textDocument', 'foldingRange')
           set_result result
         end
 
         private
 
+        def support_workspace_folders?
+          params['capabilities'] &&
+            params['capabilities']['workspace'] &&
+            params['capabilities']['workspace']['workspaceFolders']
+        end
+
         def static_completion
           {
             completionProvider: {
@@ -103,11 +113,25 @@ module Solargraph
           }
         end
 
+        def static_references
+          {
+            referencesProvider: true
+          }
+        end
+
+        def static_folding_range
+          {
+            foldingRangeProvider: true
+          }
+        end
+
+        # @param section [String]
+        # @param capability [String]
         # @return [Boolean]
         def dynamic_registration_for? section, capability
-          result = (params['capabilities'] and
-            params['capabilities'][section] and
-            params['capabilities'][section][capability] and
+          result = (params['capabilities'] &&
+            params['capabilities'][section] &&
+            params['capabilities'][section][capability] &&
             params['capabilities'][section][capability]['dynamicRegistration'])
           host.allow_registration("#{section}/#{capability}") if result
           result

data/lib/solargraph/language_server/message/initialized.rb

@@ -12,6 +12,7 @@ module Solargraph
             textDocument/definition
             textDocument/references
             textDocument/rename
+            textDocument/foldingRange
             workspace/symbol
           ]
         end

data/lib/solargraph/language_server/message/text_document.rb

@@ -17,6 +17,7 @@ module Solargraph
         autoload :Formatting,       'solargraph/language_server/message/text_document/formatting'
         autoload :References,       'solargraph/language_server/message/text_document/references'
         autoload :Rename,           'solargraph/language_server/message/text_document/rename'
+        autoload :FoldingRange,     'solargraph/language_server/message/text_document/folding_range'
       end
     end
   end

data/lib/solargraph/language_server/message/text_document/folding_range.rb

@@ -0,0 +1,24 @@
+require 'open3'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module TextDocument
+        class FoldingRange < Base
+          def process
+            result = host.folding_ranges(params['textDocument']['uri']).map do |range|
+              {
+                startLine: range.start.line,
+                startCharacter: 0,
+                endLine: range.ending.line - 1,
+                endCharacter: 0,
+                kind: 'region'
+              }
+            end
+            set_result result
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/text_document/formatting.rb

@@ -1,4 +1,5 @@
 require 'open3'
+require 'shellwords'
 
 module Solargraph
   module LanguageServer

data/lib/solargraph/language_server/message/workspace.rb

@@ -2,9 +2,10 @@ module Solargraph
   module LanguageServer
     module Message
       module Workspace
-        autoload :DidChangeWatchedFiles, 'solargraph/language_server/message/workspace/did_change_watched_files'
-        autoload :WorkspaceSymbol,       'solargraph/language_server/message/workspace/workspace_symbol'
-        autoload :DidChangeConfiguration, 'solargraph/language_server/message/workspace/did_change_configuration'
+        autoload :DidChangeWatchedFiles,     'solargraph/language_server/message/workspace/did_change_watched_files'
+        autoload :WorkspaceSymbol,           'solargraph/language_server/message/workspace/workspace_symbol'
+        autoload :DidChangeConfiguration,    'solargraph/language_server/message/workspace/did_change_configuration'
+        autoload :DidChangeWorkspaceFolders, 'solargraph/language_server/message/workspace/did_change_workspace_folders'
       end
     end
   end

data/lib/solargraph/language_server/message/workspace/did_change_configuration.rb

@@ -20,6 +20,7 @@ module Solargraph::LanguageServer::Message::Workspace
       (host.options['symbols'] ? y : n).push('textDocument/documentSymbol', 'workspace/symbol')
       (host.options['definitions'] ? y : n).push('textDocument/definition')
       (host.options['references'] ? y : n).push('textDocument/references')
+      (host.options['folding'] ? y : n).push('textDocument/folding')
       host.register_capabilities y
       host.unregister_capabilities n
     end

data/lib/solargraph/language_server/message/workspace/did_change_watched_files.rb

@@ -11,14 +11,11 @@ module Solargraph::LanguageServer::Message::Workspace
     def process
       # @param change [Hash]
       params['changes'].each do |change|
+        # @todo Changes might need to be handled here even if the file is open
         if change['type'] == CREATED
-          # It's only necessary to create the file from if the file isn't open
-          # in the client
-          host.create change['uri'] unless host.open?(change['uri'])
+          host.create change['uri'] #unless host.open?(change['uri'])
         elsif change['type'] == CHANGED
-          # It's only necessary to update from here if the file isn't open in
-          # the client
-          host.create change['uri'] unless host.open?(change['uri'])
+          host.create change['uri'] #unless host.open?(change['uri'])
         elsif change['type'] == DELETED
           host.delete change['uri']
         else

data/lib/solargraph/language_server/message/workspace/did_change_workspace_folders.rb

@@ -0,0 +1,24 @@
+require 'uri'
+
+module Solargraph::LanguageServer::Message::Workspace
+  class DidChangeWorkspaceFolders < Solargraph::LanguageServer::Message::Base
+    def process
+      add_folders
+      remove_folders
+    end
+
+    private
+
+    def add_folders
+      return unless params['event'] && params['event']['added']
+      host.prepare_folders params['event']['added']
+    end
+
+    def remove_folders
+      return unless params['event'] && params['event']['removed']
+      params['event']['removed'].each do |folder|
+        host.remove_folders params['event']['removed']
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/transport.rb

@@ -4,9 +4,8 @@ module Solargraph
     # communication protocols for language servers.
     #
     module Transport
+      autoload :Adapter,    'solargraph/language_server/transport/adapter'
       autoload :DataReader, 'solargraph/language_server/transport/data_reader'
-      autoload :Socket,     'solargraph/language_server/transport/socket'
-      autoload :Stdio,      'solargraph/language_server/transport/stdio'
     end
   end
 end

data/lib/solargraph/language_server/transport/{socket.rb → adapter.rb}

@@ -1,12 +1,10 @@
-require 'thread'
-
 module Solargraph
   module LanguageServer
     module Transport
-      # A module for running language servers in EventMachine.
+      # A common module for running language servers in Backport.
       #
-      module Socket
-        def post_init
+      module Adapter
+        def opening
           @host = Solargraph::LanguageServer::Host.new
           @data_reader = Solargraph::LanguageServer::Transport::DataReader.new
           @data_reader.set_message_handler do |message|
@@ -19,25 +17,25 @@ module Solargraph
           message = @host.start(request)
           message.send_response
           tmp = @host.flush
-          send_data tmp unless tmp.empty?
+          write tmp unless tmp.empty?
         end
 
         # @param data [String]
-        def receive_data data
+        def sending data
           @data_reader.receive data
         end
 
         private
 
         def start_timers
-          EventMachine.add_periodic_timer 0.1 do
+          Backport.prepare_interval 0.1 do
             tmp = @host.flush
-            send_data tmp unless tmp.empty?
+            write tmp unless tmp.empty?
             if @host.stopped?
               if @host.options['transport'] == 'external'
                 @host = Solargraph::LanguageServer::Host.new
               else
-                EventMachine.stop
+                Backport.stop
               end
             end
           end

data/lib/solargraph/library.rb

@@ -2,12 +2,18 @@ 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
+
     # @param workspace [Solargraph::Workspace]
-    def initialize workspace = Solargraph::Workspace.new
+    def initialize workspace = Solargraph::Workspace.new, name = nil
       @workspace = workspace
+      @name = name
       api_map.catalog bundle
       @synchronized = true
     end
@@ -37,6 +43,16 @@ module Solargraph
       end
     end
 
+    def open_from_disk filename
+      mutex.synchronize do
+        source = Solargraph::Source.load(filename)
+        workspace.merge source
+        open_file_hash[filename] = source
+        checkout filename
+        catalog
+      end
+    end
+
     # True if the specified file is currently open.
     #
     # @param filename [String]
@@ -318,16 +334,26 @@ module Solargraph
     #
     # @return [void]
     def catalog
+      logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
       api_map.catalog bundle
       @synchronized = true
     end
 
+    def folding_ranges filename
+      read(filename).folding_ranges
+    end
+
+    # @return [Array<Source>]
+    def open_sources
+      open_file_hash.values
+    end
+
     # Create a library from a directory.
     #
     # @param directory [String] The path to be used for the workspace
     # @return [Solargraph::Library]
-    def self.load directory = ''
-      Solargraph::Library.new(Solargraph::Workspace.new(directory))
+    def self.load directory = '', name = nil
+      Solargraph::Library.new(Solargraph::Workspace.new(directory), name)
     end
 
     private

data/lib/solargraph/logging.rb

@@ -0,0 +1,25 @@
+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

@@ -2,7 +2,7 @@ require 'ostruct'
 require 'tilt'
 require 'kramdown'
 require 'htmlentities'
-require 'reverse_markdown'
+require 'cgi'
 
 module Solargraph
   class Page
@@ -39,14 +39,16 @@ module Solargraph
 
     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
       @render_method = proc { |template, layout: false, locals: {}|
         binder = Binder.new(locals, @render_method)
         if layout
-          Tilt::ERBTemplate.new(File.join(directory, 'layout.erb')).render(binder) do
-            Tilt::ERBTemplate.new(File.join(directory, "#{template}.erb")).render(binder)
+          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(File.join(directory, "#{template}.erb")).render(binder)
+          Tilt::ERBTemplate.new(Page.select_template(directories, template)).render(binder)
         end
       }
     end
@@ -54,5 +56,13 @@ module Solargraph
     def render template, layout: true, locals: {}
       @render_method.call(template, layout: layout, locals: locals)
     end
+
+    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