solargraph 0.29.5 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef270f7fed3e6a6b8cae0214c0bcdd41e239bfe151951875895a5b6fa76b46f7
-  data.tar.gz: 5be38dd7aaee4533e5c60abe980176f30225e63393fb1858913c8fb4d9938802
+  metadata.gz: 82f40642bcf02b95ca838da6a0ed6ff66ac9d0e8ef42ee8bf8643866342ffb39
+  data.tar.gz: e1e30bd1a35dfdfd1b17d74d70ab8afef82c701fdbffb4d4f08455511df95673
 SHA512:
-  metadata.gz: 67036eaaafe01c834b8ce7ca20b7ec00cf302653b4dcc45221d15e64121477c938f36027990d2eed1e206f1d037a69aa835c84882753b55fec43dab402ead4e5
-  data.tar.gz: d30834378eab843bee9b637dcfe0809189100bedce3c9c71f575da5a9a361153eedb9a1b15b48b4907d4b3776b67e3da12b12c9777ff75ac0ee46a7d147dd3d2
+  metadata.gz: 67ace010ea2017c9d35c2d8aa8229187ff39c27f926c388eba9105e067088c31ed46a7dadaef787c5845eb838b9c347744cfc48e47dea480558a8d5f05c15ee7
+  data.tar.gz: eef1f9e7c56e8623fe44227fedd16b89a0d277ac29ac3005ade6b98387596daff15c0743deb8de8b99ff4950c72b504c4f31e0e44faf075de14fc662efa14449

data/lib/solargraph.rb

@@ -34,6 +34,7 @@ module Solargraph
   autoload :Diagnostics,      'solargraph/diagnostics'
   autoload :ComplexType,      'solargraph/complex_type'
   autoload :Bundle,           'solargraph/bundle'
+  autoload :Logging,          'solargraph/logging'
 
   dir = File.dirname(__FILE__)
   YARDOC_PATH = File.realpath(File.join(dir, '..', 'yardoc'))

data/lib/solargraph/api_map.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'set'
+require 'pathname'
 
 module Solargraph
   # An aggregate provider for information about workspaces, sources, gems, and
@@ -96,7 +97,8 @@ module Solargraph
         reqs.delete_if do |r|
           result = false
           bundle.workspace.require_paths.each do |l|
-            if new_map_hash.keys.include?(File.join(l, "#{r}.rb"))
+            pn = Pathname.new(bundle.workspace.directory).join(l, "#{r}.rb")
+            if new_map_hash.keys.include?(pn.to_s)
               result = true
               break
             end
@@ -298,13 +300,27 @@ module Solargraph
       result
     end
 
-    # Get an array of public methods for a complex type.
+    # Get an array of method pins for a complex type.
     #
-    # @param type [Solargraph::ComplexType]
-    # @param context [String]
+    # The type's namespace and the context should be fully qualified. If the
+    # context matches the namespace type or is a subclass of the type,
+    # protected methods are included in the results. If protected methods are
+    # included and internal is true, private methods are also included.
+    #
+    # @example
+    #   api_map = Solargraph::ApiMap.new
+    #   type = Solargraph::ComplexType.parse('String')
+    #   api_map.get_complex_type_methods(type)
+    #
+    # @param type [Solargraph::ComplexType] The complex type of the namespace
+    # @param context [String] The context from which the type is referenced
     # @param internal [Boolean] True to include private methods
     # @return [Array<Solargraph::Pin::Base>]
     def get_complex_type_methods type, context = '', internal = false
+      # This method does not qualify the complex type's namespace because
+      # it can cause conflicts between similar names, e.g., `Foo` vs.
+      # `Other::Foo`. It still takes a context argument to determine whether
+      # protected and private methods are visible.
       return [] if type.undefined? || type.void?
       result = []
       if type.duck_type?
@@ -314,19 +330,12 @@ module Solargraph
         result.concat get_methods('Object')
       else
         unless type.nil? || type.name == 'void'
-          # @todo This method does not qualify the complex type's namespace
-          #   because it can cause namespace conflicts, e.g., `Foo` vs.
-          #   `Other::Foo`. It still takes a context argument because it
-          #   uses context to determine whether protected and private methods
-          #   are visible.
-          # namespace = qualify(type.namespace, context)
-          namespace = type.namespace
           visibility = [:public]
-          if namespace == context || super_and_sub?(namespace, context)
+          if type.namespace == context || super_and_sub?(type.namespace, context)
             visibility.push :protected
             visibility.push :private if internal
           end
-          result.concat get_methods(namespace, scope: type.scope, visibility: visibility)
+          result.concat get_methods(type.namespace, scope: type.scope, visibility: visibility)
         end
       end
       result

data/lib/solargraph/language_server/host.rb

@@ -12,6 +12,7 @@ module Solargraph
       autoload :Cataloger, 'solargraph/language_server/host/cataloger'
 
       include Solargraph::LanguageServer::UriHelpers
+      include Logging
 
       def initialize
         @cancel_semaphore = Mutex.new
@@ -31,6 +32,7 @@ module Solargraph
       def configure update
         return if update.nil?
         options.merge! update
+        logger.level = LOG_LEVELS[options['logLevel']] || DEFAULT_LOG_LEVEL
       end
 
       # @return [Hash]
@@ -70,6 +72,8 @@ module Solargraph
       # @return [Solargraph::LanguageServer::Message::Base] The message handler.
       def start request
         if request['method']
+          logger.info "Server received #{request['method']}"
+          logger.debug request
           message = Message.select(request['method']).new(self, request)
           begin
             message.process
@@ -94,14 +98,18 @@ module Solargraph
       #
       # @param uri [String] The file uri.
       def create uri
+        library = library_for(uri)
         filename = uri_to_file(uri)
-        library.create_from_disk filename
+        result = library.create_from_disk(filename)
+        diagnoser.schedule uri if open?(uri)
+        result
       end
 
       # Delete the specified file from the library.
       #
       # @param uri [String] The file uri.
       def delete uri
+        library = library_for(uri)
         filename = uri_to_file(uri)
         library.delete filename
         send_notification "textDocument/publishDiagnostics", {
@@ -116,10 +124,17 @@ module Solargraph
       # @param text [String] The contents of the file.
       # @param version [Integer] A version number.
       def open uri, text, version
+        library = library_for(uri)
         library.open uri_to_file(uri), text, version
         diagnoser.schedule uri
       end
 
+      def open_from_disk uri
+        library = library_for(uri)
+        library.open_from_disk uri_to_file(uri)
+        diagnoser.schedule uri
+      end
+
       # True if the specified file is currently open in the library.
       #
       # @param uri [String]
@@ -132,12 +147,15 @@ module Solargraph
       #
       # @param uri [String]
       def close uri
+        library = library_for(uri)
         library.close uri_to_file(uri)
         diagnoser.schedule uri
       end
 
       # @param uri [String]
       def diagnose uri
+        logger.info "Diagnosing #{uri}"
+        library = library_for(uri)
         begin
           results = library.diagnose uri_to_file(uri)
           send_notification "textDocument/publishDiagnostics", {
@@ -155,9 +173,10 @@ module Solargraph
       end
 
       def change params
+        library = library_for(params['textDocument']['uri'])
         updater = generate_updater(params)
         library.update updater
-        cataloger.ping unless library.synchronized?
+        cataloger.ping(library) unless library.synchronized?
         diagnoser.schedule params['textDocument']['uri']
       end
 
@@ -185,22 +204,53 @@ module Solargraph
       # Prepare a library for the specified directory.
       #
       # @param directory [String]
-      def prepare directory
+      # @param name [String]
+      def prepare directory, name = nil
+        logger.info "Preparing library for #{directory}"
         path = ''
         path = normalize_separators(directory) unless directory.nil?
         begin
-          @library = Solargraph::Library.load(path)
+          lib = Solargraph::Library.load(path, name)
         rescue WorkspaceTooLargeError => e
           send_notification 'window/showMessage', {
             'type' => Solargraph::LanguageServer::MessageTypes::WARNING,
             'message' => e.message
           }
-          @library = Solargraph::Library.load
+          lib = Solargraph::Library.new('', name)
         end
+        libraries.push lib
         diagnoser.start
         cataloger.start
       end
 
+      def prepare_folders array
+        array.each do |folder|
+          prepare uri_to_file(folder['uri']), folder['name']
+        end
+      end
+
+      def remove directory
+        logger.info "Removing library for #{directory}"
+        # @param lib [Library]
+        libraries.delete_if do |lib|
+          next false if lib.workspace.directory != directory
+          lib.open_sources.each do |src|
+            orphan_library.open(src.filename, src.code, src.version)
+          end
+          true
+        end
+      end
+
+      def remove_folders array
+        array.each do |folder|
+          remove uri_to_file(folder['uri'])
+        end
+      end
+
+      def folders
+        libraries.map { |lib| lib.workspace.directory }
+      end
+
       # Send a notification to the client.
       #
       # @param method [String] The message method
@@ -214,6 +264,8 @@ module Solargraph
         json = response.to_json
         envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
         queue envelope
+        logger.info "Server sent #{method}"
+        logger.debug params
       end
 
       # Send a request to the client and execute the provided block to process
@@ -236,6 +288,8 @@ module Solargraph
         envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
         queue envelope
         @next_request_id += 1
+        logger.info "Server sent #{method}"
+        logger.debug params
       end
 
       # Register the methods as capabilities with the client.
@@ -244,6 +298,7 @@ module Solargraph
       #
       # @param methods [Array<String>] The methods to register
       def register_capabilities methods
+        logger.debug "Registering capabilities: #{methods}"
         @register_semaphore.synchronize do
           send_request 'client/registerCapability', {
             registrations: methods.select{|m| can_register?(m) and !registered?(m)}.map { |m|
@@ -264,6 +319,7 @@ module Solargraph
       #
       # @param methods [Array<String>] The methods to unregister
       def unregister_capabilities methods
+        logger.debug "Unregistering capabilities: #{methods}"
         @register_semaphore.synchronize do
           send_request 'client/unregisterCapability', {
             unregisterations: methods.select{|m| registered?(m)}.map{ |m|
@@ -300,13 +356,6 @@ module Solargraph
         @registered_capabilities.include?(method)
       end
 
-      # True if the specified file is in the process of changing.
-      #
-      # @return [Boolean]
-      def changing? file_uri
-        unsafe_changing?(file_uri)
-      end
-
       def synchronizing?
         cataloger.synchronizing?
       end
@@ -324,6 +373,7 @@ module Solargraph
       def locate_pin params
         pin = nil
         unless params['data']['location'].nil?
+          library = library_for(file_to_uri(params['data']['location']['filename']))
           location = Location.new(
             params['data']['location']['filename'],
             Range.from_to(
@@ -336,15 +386,16 @@ module Solargraph
           pin = library.locate_pin(location)
         end
         # @todo Improve pin location
-        if pin.nil? or pin.path != params['data']['path']
-          pin = library.path_pins(params['data']['path']).first
-        end
+        # if pin.nil? or pin.path != params['data']['path']
+        #   pin = library.path_pins(params['data']['path']).first
+        # end
         pin
       end
 
       # @param uri [String]
       # @return [String]
       def read_text uri
+        library = library_for(uri)
         filename = uri_to_file(uri)
         library.read_text(filename)
       end
@@ -354,9 +405,8 @@ module Solargraph
       # @param column [Integer]
       # @return [Solargraph::ApiMap::Completion]
       def completions_at filename, line, column
-        result = nil
-        result = library.completions_at filename, line, column
-        result
+        library = library_for(file_to_uri(filename))
+        library.completions_at filename, line, column
       end
 
       # @param filename [String]
@@ -364,6 +414,7 @@ module Solargraph
       # @param column [Integer]
       # @return [Array<Solargraph::Pin::Base>]
       def definitions_at filename, line, column
+        library = library_for(file_to_uri(filename))
         library.definitions_at(filename, line, column)
       end
 
@@ -372,6 +423,7 @@ module Solargraph
       # @param column [Integer]
       # @return [Array<Solargraph::Pin::Base>]
       def signatures_at filename, line, column
+        library = library_for(file_to_uri(filename))
         library.signatures_at(filename, line, column)
       end
 
@@ -381,30 +433,38 @@ module Solargraph
       # @param strip [Boolean] Strip special characters from variable names
       # @return [Array<Solargraph::Range>]
       def references_from filename, line, column, strip: true
+        library = library_for(file_to_uri(filename))
         result = library.references_from(filename, line, column, strip: strip)
       end
 
       # @param query [String]
       # @return [Array<Solargraph::Pin::Base>]
       def query_symbols query
-        library.query_symbols(query)
+        result = []
+        libraries.each { |lib| result.concat lib.query_symbols(query) }
+        result
       end
 
       # @param query [String]
       # @return [Array<String>]
       def search query
-        library.search(query)
+        result = []
+        libraries.each { |lib| result.concat lib.search(query) }
+        result
       end
 
       # @param query [String]
       # @return [String]
       def document query
-        library.document(query)
+        result = []
+        libraries.each { |lib| result.concat lib.document(query) }
+        result
       end
 
       # @param uri [String]
       # @return [Array<Solargraph::Pin::Base>]
       def document_symbols uri
+        library = library_for(uri)
         library.document_symbols(uri_to_file(uri))
       end
 
@@ -453,22 +513,52 @@ module Solargraph
           'references' => true,
           'autoformat' => false,
           'diagnostics' => false,
-          'formatting' => false
+          'formatting' => false,
+          'folding' => true,
+          'logLevel' => 'warn'
         }
       end
 
       # Catalog the library.
       #
       # @return [void]
-      def catalog
-        library.catalog
+      def catalog lib
+        lib.catalog
+      end
+
+      def folding_ranges uri
+        library = library_for(uri)
+        file = uri_to_file(uri)
+        library.folding_ranges(file)
       end
 
       private
 
-      # @return [Solargraph::Library]
-      def library
-        @library ||= Solargraph::Library.new
+      # @return [Array<Library>]
+      def libraries
+        @libraries ||= []
+      end
+
+      # @param uri [String]
+      # @return [Library]
+      def library_for uri
+        return libraries.first if libraries.length == 1
+        filename = uri_to_file(uri)
+        # Find a library with an explicit reference to the file
+        libraries.each do |lib|
+          return lib if lib.contain?(filename) || lib.open?(filename)
+        end
+        # Find a library with a workspace that contains the file
+        libraries.each do |lib|
+          return lib if filename.start_with?(lib.workspace.directory)
+        end
+        return orphan_library if orphan_library.open?(filename)
+        raise "No library for #{uri}"
+      end
+
+      # @return [Library]
+      def orphan_library
+        @orphan_library ||= Solargraph::Library.new
       end
 
       # @return [Diagnoser]
@@ -481,13 +571,8 @@ module Solargraph
         @cataloger ||= Cataloger.new(self)
       end
 
-      # @param file_uri [String]
-      # @return [Boolean]
-      def unsafe_changing? file_uri
-        file = uri_to_file(file_uri)
-      end
-
       def unsafe_open? uri
+        library = library_for(uri)
         library.open?(uri_to_file(uri))
       end
 
@@ -560,6 +645,9 @@ module Solargraph
           },
           'textDocument/formatting' => {
             formattingProvider: true
+          },
+          'textDocument/foldingRange' => {
+            foldingRangeProvider: true
           }
         }
       end