solargraph 0.30.0 → 0.30.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82f40642bcf02b95ca838da6a0ed6ff66ac9d0e8ef42ee8bf8643866342ffb39
-  data.tar.gz: e1e30bd1a35dfdfd1b17d74d70ab8afef82c701fdbffb4d4f08455511df95673
+  metadata.gz: f109fbce413be0100575d4375ff3bd0592626852334dfcb41161f7d7bbe6e67f
+  data.tar.gz: 5fa2251f2b60f03c627add65eef3e42adf16e75cc579c36e581dc7972312b750
 SHA512:
-  metadata.gz: 67ace010ea2017c9d35c2d8aa8229187ff39c27f926c388eba9105e067088c31ed46a7dadaef787c5845eb838b9c347744cfc48e47dea480558a8d5f05c15ee7
-  data.tar.gz: eef1f9e7c56e8623fe44227fedd16b89a0d277ac29ac3005ade6b98387596daff15c0743deb8de8b99ff4950c72b504c4f31e0e44faf075de14fc662efa14449
+  metadata.gz: 2017a0eaea2090e26a3f99f0e8d9734e40b6f9692dfcdef8bcb2c424ba3180604807c3cceb49f029fc87fa25e17e6212a79e97e62f6fd570fc2a8f6a8a75652b
+  data.tar.gz: e386dcd357c431214a64e1774097a61827c9d54f70b290313868250a392095a520d87788c0741bc660ceb1ceb114f16c71a54923fbfe3755dd84776c9c64e6a0

data/lib/solargraph/language_server/host.rb

@@ -176,6 +176,8 @@ module Solargraph
         library = library_for(params['textDocument']['uri'])
         updater = generate_updater(params)
         library.update updater
+        # @todo Since Library#checkout already catalogs, this cataloging
+        #   might not be necessary.
         cataloger.ping(library) unless library.synchronized?
         diagnoser.schedule params['textDocument']['uri']
       end
@@ -342,6 +344,8 @@ module Solargraph
         end
       end
 
+      # True if the specified LSP method can be dynamically registered.
+      #
       # @param method [String]
       # @return [Boolean]
       def can_register? method
@@ -370,26 +374,42 @@ module Solargraph
         @stopped
       end
 
+      # Locate a pin based on the location of a completion item, or nil if the
+      # library does not have a source at that location.
+      #
+      # @param params [Hash] A hash representation of a completion item
+      # @return [Pin::Base, nil]
       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(
-              params['data']['location']['range']['start']['line'],
-              params['data']['location']['range']['start']['character'],
-              params['data']['location']['range']['end']['line'],
-              params['data']['location']['range']['end']['character']
-            )
+        return nil unless params['data'] && params['data']['uri'] && params['data']['location']
+        library = library_for(params['data']['uri'])
+        location = Location.new(
+          params['data']['location']['filename'],
+          Range.from_to(
+            params['data']['location']['range']['start']['line'],
+            params['data']['location']['range']['start']['character'],
+            params['data']['location']['range']['end']['line'],
+            params['data']['location']['range']['end']['character']
           )
-          pin = library.locate_pin(location)
+        )
+        library.locate_pin(location)
+      end
+
+      # Locate multiple pins that match a completion item. The first match is
+      # based on the corresponding location in a library source if available
+      # (see #locate_pin). Subsequent matches are based on path.
+      #
+      # @param params [Hash] A hash representation of a completion item
+      # @return [Array<Pin::Base>]
+      def locate_pins params
+        return [] unless params['data'] && params['data']['uri']
+        exact = locate_pin(params)
+        library = library_for(params['data']['uri'])
+        result = []
+        unless params['data']['path'].nil?
+          result.concat library.path_pins(params['data']['path']).reject{|pin| pin == exact}
         end
-        # @todo Improve pin location
-        # if pin.nil? or pin.path != params['data']['path']
-        #   pin = library.path_pins(params['data']['path']).first
-        # end
-        pin
+        result.unshift exact unless exact.nil?
+        result
       end
 
       # @param uri [String]

data/lib/solargraph/language_server/message/completion_item/resolve.rb

@@ -6,14 +6,22 @@ module Solargraph
         #
         class Resolve < Base
           def process
-            pin = host.locate_pin params
-            if pin.nil?
-              set_result params
-            else
-              set_result(
-                params.merge(pin.resolve_completion_item)
-              )
-            end
+            pins = host.locate_pins(params)
+            set_result merge(pins)
+          end
+
+          private
+
+          # @param pins [Array<Pin::Base>]
+          # @return [Hash]
+          def merge pins
+            return params if pins.empty?
+            docs = pins
+                   .reject { |pin| pin.documentation.empty? }
+                   .map { |pin| pin.resolve_completion_item[:documentation] }
+            params
+              .merge(pins.first.resolve_completion_item)
+              .merge(documentation: docs.join("\n\n"))
           end
         end
       end

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

@@ -1,5 +1,3 @@
-require 'time'
-
 module Solargraph
   module LanguageServer
     module Message
@@ -33,6 +31,7 @@ module Solargraph
                   },
                   sortText: "#{idx.to_s.rjust(4, '0')}#{pin.name}"
                 })
+                items.last[:data][:uri] = params['textDocument']['uri']
                 last_context = pin.context
               end
               set_result(

data/lib/solargraph/library.rb

@@ -16,6 +16,7 @@ module Solargraph
       @name = name
       api_map.catalog bundle
       @synchronized = true
+      @catalog_mutex = Mutex.new
     end
 
     # True if the ApiMap is up to date with the library's workspace and open
@@ -35,21 +36,21 @@ module Solargraph
     # @return [void]
     def open filename, text, version
       mutex.synchronize do
+        @synchronized = false
         source = Solargraph::Source.load_string(text, filename, version)
         workspace.merge source
         open_file_hash[filename] = source
         checkout filename
-        catalog
       end
     end
 
     def open_from_disk filename
       mutex.synchronize do
+        @synchronized = false
         source = Solargraph::Source.load(filename)
         workspace.merge source
         open_file_hash[filename] = source
         checkout filename
-        catalog
       end
     end
 
@@ -80,6 +81,7 @@ module Solargraph
       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)
         catalog
@@ -98,6 +100,7 @@ module Solargraph
       mutex.synchronize do
         next if File.directory?(filename) || !File.exist?(filename)
         next unless contain?(filename) || open?(filename) || workspace.would_merge?(filename)
+        @synchronized = false
         source = Solargraph::Source.load_string(File.read(filename), filename)
         workspace.merge(source)
         open_file_hash[filename] = source if open_file_hash.key?(filename)
@@ -116,6 +119,7 @@ module Solargraph
     # @return [void]
     def delete filename
       mutex.synchronize do
+        @synchronized = false
         open_file_hash.delete filename
         workspace.remove filename
         catalog
@@ -129,6 +133,7 @@ module Solargraph
     # @return [void]
     def close filename
       mutex.synchronize do
+        @synchronized = false
         open_file_hash.delete filename
         catalog
       end
@@ -182,6 +187,7 @@ module Solargraph
     # @return [Array<Solargraph::Range>]
     # @todo Take a Location instead of filename/line/column
     def references_from filename, line, column, strip: false
+      checkout filename
       cursor = api_map.cursor_at(filename, Position.new(line, column))
       clip = api_map.clip(cursor)
       pins = clip.define
@@ -235,7 +241,9 @@ module Solargraph
     # @param filename [String]
     # @return [Source]
     def checkout filename
-      @current = read(filename)
+      checked = read(filename)
+      @synchronized = (checked.filename == @current.filename) if synchronized?
+      @current = checked
       catalog
       @current
     end
@@ -243,12 +251,14 @@ module Solargraph
     # @param query [String]
     # @return [Array<YARD::CodeObject::Base>]
     def document query
+      catalog
       api_map.document query
     end
 
     # @param query [String]
     # @return [Array<String>]
     def search query
+      catalog
       api_map.search query
     end
 
@@ -257,6 +267,7 @@ module Solargraph
     # @param query [String]
     # @return [Array<Pin::Base>]
     def query_symbols query
+      catalog
       api_map.query_symbols query
     end
 
@@ -269,6 +280,7 @@ module Solargraph
     # @param filename [String]
     # @return [Array<Solargraph::Pin::Base>]
     def document_symbols filename
+      checkout filename
       return [] unless open_file_hash.key?(filename)
       api_map.document_symbols(filename)
     end
@@ -276,13 +288,14 @@ module Solargraph
     # @param path [String]
     # @return [Array<Solargraph::Pin::Base>]
     def path_pins path
+      catalog
       api_map.get_path_suggestions(path)
     end
 
     # Update a source in the library from the provided updater.
     #
     # @note This method will not update the library's ApiMap. See
-    #   Library#ynchronized? and Library#catalog for more information.
+    #   Library#synchronized? and Library#catalog for more information.
     #
     #
     # @raise [FileNotFoundError] if the updater's file is not available.
@@ -334,9 +347,12 @@ module Solargraph
     #
     # @return [void]
     def catalog
-      logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
-      api_map.catalog bundle
-      @synchronized = true
+      @catalog_mutex.synchronize do
+        break if synchronized?
+        logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
+        api_map.catalog bundle
+        @synchronized = true
+      end
     end
 
     def folding_ranges filename

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.30.0'
+  VERSION = '0.30.1'
 end

data/lib/solargraph/views/_namespace.erb

@@ -8,8 +8,7 @@
 <ul class="doc-list">
     <% object.meths(scope: :class).sort{|a, b| a.name <=> b.name}.each do |meth| %>
         <li>
-            <% esc = URI.escape("\"solargraph:/document?query=#{meth.path}\"").gsub('%23', URI.escape('%23')) %>
-            <a href="command:solargraph._openDocument?<%= esc %>"><%= meth.name %></a>
+            <a href="solargraph:/document?query=<%= URI.escape(meth.path) %>"><%= meth.name %></a>
         </li>
     <% end %>
 </ul>
@@ -19,8 +18,7 @@
 <ul class="doc-list">
     <% object.meths(scope: :instance).sort{|a, b| a.name <=> b.name}.each do |meth| %>
         <li>
-            <% esc = URI.escape("\"solargraph:/document?query=#{meth.path}\"").gsub('%23', URI.escape('%23')) %>
-            <a href="command:solargraph._openDocument?<%= esc %>"><%= meth.name %></a>
+            <a href="solargraph:/document?query=<%= URI.escape(meth.path) %>"><%= meth.name %></a>
         </li>
     <% end %>
 </ul>

data/lib/solargraph/views/search.erb

@@ -4,8 +4,7 @@
     <ul class="doc-list">
     <% results.each do |result| %>
         <li>
-            <%# esc = URI.escape("\"solargraph:/document?query=#{result}\"").gsub('%23', URI.escape('%23')) %>
-            <a href="solargraph:/document?query=<%= URI.escape(result) %>"><%= result %></a>
+            <a href="solargraph:/document?query=<%= CGI.escape(result) %>"><%= result %></a>
         </li>
     <% end %>
     </ul>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.30.0
+  version: 0.30.1
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-26 00:00:00.000000000 Z
+date: 2018-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport