solargraph 0.31.3 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a18d1986bcaf5c2f39fb6f7adf604a2275382a87eaa7d292d0a48ee4d65bf40e
-  data.tar.gz: 8bd096eb42b1b573b1433b6fa1bad9adbbda95c24cde405422a489f69ead949c
+  metadata.gz: 5509f89d971f0a22e8256a0492ce0acd036c2bc1fa01f55b3ca9fb08ff358030
+  data.tar.gz: 53f76eccd7206efdb918507752201c4a61aeabd2c67d69ad64686e6bae4bec41
 SHA512:
-  metadata.gz: 3b0c25b798781b5ff29c16d1728e1b03108a8bbcc55cc20d407fd6b1e4f16fe0e45d1f730b1de6c6ba1cc661091cd0f4e8e993186cca721e68d9e341ec2f12ed
-  data.tar.gz: e711f3d5b03207e7a6bff18fa68768ae3d9d8efc6a54e2225d25b4f37033bcbba916c60ce3a379e4d2e1fe20d1c03cad294fc3cfe3411f6568c13bbe4681c52e
+  metadata.gz: 140976ad7f59ab810812bcc7ebc6ea141c07337effd78e025c3fda5112e4b130996b7697835b64fc16aca8e4457b0255a55cd3c1c8906479af08af6c78e29ec2
+  data.tar.gz: 1af8ccbb0d7e16bb8a49e2f8c5214deb0bbcd33164e704434bd33b6be8b909397385e615b1d2bad34a179303aa2c258f642bf28d2790018b60d00de519955817

data/lib/solargraph/api_map.rb

@@ -580,22 +580,24 @@ module Solargraph
           return inner_qualify(root, '', skip)
         end
       else
-        if root == ''
-          return name if store.namespace_exists?(name)
-        else
-          roots = root.to_s.split('::')
-          while roots.length > 0
-            fqns = roots.join('::') + '::' + name
-            return fqns if store.namespace_exists?(fqns)
-            incs = store.get_includes(roots.join('::'))
-            incs.each do |inc|
-              foundinc = inner_qualify(name, inc, skip)
-              return foundinc unless foundinc.nil?
-            end
-            roots.pop
+        return name if root == '' && store.namespace_exists?(name)
+        roots = root.to_s.split('::')
+        while roots.length > 0
+          fqns = roots.join('::') + '::' + name
+          return fqns if store.namespace_exists?(fqns)
+          incs = store.get_includes(roots.join('::'))
+          incs.each do |inc|
+            foundinc = inner_qualify(name, inc, skip)
+            return foundinc unless foundinc.nil?
           end
-          return name if store.namespace_exists?(name)
+          roots.pop
+        end
+        incs = store.get_includes('')
+        incs.each do |inc|
+          foundinc = inner_qualify(name, inc, skip)
+          return foundinc unless foundinc.nil?
         end
+        return name if store.namespace_exists?(name)
       end
       # live_map.get_fqns(name, root)
     end

data/lib/solargraph/core_fills.rb

@@ -11,7 +11,7 @@ module Solargraph
     METHODS_RETURNING_SELF = %w[
       Array#select Array#reject Array#keep_if Array#delete_if
       Enumerable#select
-      Object#clone Object#dup Object#freeze Object#taint Object#untaint
+      Object#clone Object#dup Object#freeze Object#taint Object#untaint Object#tap
       String#freeze
     ].freeze
 
@@ -19,6 +19,10 @@ module Solargraph
       Array#[] Array#first Array#last
     ].freeze
 
+    METHODS_WITH_YIELDPARAM_SELF = %w[
+      Object#tap
+    ].freeze
+
     METHODS_WITH_YIELDPARAM_SUBTYPES = %w[
       Array#each Array#map Array#any? Array#all? Array#index
       Enumerable#each_entry Enumerable#map Enumerable#any? Enumerable#all?

data/lib/solargraph/language_server/host.rb

@@ -660,7 +660,7 @@ module Solargraph
             referencesProvider: true
           },
           'textDocument/rename' => {
-            renameProvider: true
+            renameProvider: {prepareProvider: true}
           },
           'textDocument/documentSymbol' => {
             documentSymbolProvider: true

data/lib/solargraph/language_server/message.rb

@@ -70,6 +70,7 @@ module Solargraph
       register 'textDocument/documentSymbol',      TextDocument::DocumentSymbol
       register 'textDocument/references',          TextDocument::References
       register 'textDocument/rename',              TextDocument::Rename
+      register 'textDocument/prepareRename',       TextDocument::PrepareRename
       register 'textDocument/foldingRange',        TextDocument::FoldingRange
       register 'workspace/didChangeWatchedFiles',  Workspace::DidChangeWatchedFiles
       register 'workspace/didChangeConfiguration', Workspace::DidChangeConfiguration

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

@@ -21,7 +21,16 @@ module Solargraph
                    .map { |pin| pin.resolve_completion_item[:documentation] }
             params
               .merge(pins.first.resolve_completion_item)
-              .merge(documentation: docs.join("\n\n"))
+              .merge(documentation: markup_content(docs.join("\n\n")))
+          end
+
+          # @param text [String]
+          # @return [Hash{Symbol => String}]
+          def markup_content text
+            {
+              kind: 'markdown',
+              value: text
+            }
           end
         end
       end

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

@@ -108,7 +108,7 @@ module Solargraph
 
         def static_rename
           {
-            renameProvider: true
+            renameProvider: {prepareProvider: true}
           }
         end
 

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

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

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 :PrepareRename,    'solargraph/language_server/message/text_document/prepare_rename'
         autoload :FoldingRange,     'solargraph/language_server/message/text_document/folding_range'
       end
     end

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

@@ -0,0 +1,9 @@
+module Solargraph::LanguageServer::Message::TextDocument
+  class PrepareRename < Base
+    def process
+      line = params['position']['line']
+      col = params['position']['character']
+      set_result host.sources.find(params['textDocument']['uri']).cursor_at(Solargraph::Position.new(line, col)).range.to_hash
+    end
+  end
+end

data/lib/solargraph/language_server/transport/adapter.rb

@@ -21,9 +21,12 @@ module Solargraph
         end
 
         # @param data [String]
-        def sending data
+        def receiving data
           @data_reader.receive data
         end
+        # @todo Temporary alias to avoid problems due to a breaking change in
+        #   the Backport API
+        alias sending receiving
 
         private
 

data/lib/solargraph/pin/base.rb

@@ -111,7 +111,7 @@ module Solargraph
       # @return [YARD::Docstring]
       def docstring
         parse_comments unless defined?(@docstring)
-        @docstring ||= YARD::Docstring.parser.parse('').to_docstring
+        @docstring ||= Solargraph::Source.parse_docstring('').to_docstring
       end
 
       # @return [Array<YARD::Tags::Directive>]
@@ -225,7 +225,9 @@ module Solargraph
           @docstring = nil
           @directives = []
         else
-          parse = YARD::Docstring.parser.parse(comments)
+          # HACK: Pass a dummy code object to the parser for plugins that
+          # expect it not to be nil
+          parse = Solargraph::Source.parse_docstring(comments)
           @docstring = parse.to_docstring
           @directives = parse.directives
         end
@@ -270,7 +272,7 @@ module Solargraph
       # @return [Array<YARD::Tags::Handlers::Directive>]
       def collect_macros
         return [] unless maybe_directives?
-        parse = YARD::Docstring.parser.parse(comments)
+        parse = Solargraph::Source.parse_docstring(comments)
         parse.directives.select{ |d| d.tag.tag_name == 'macro' }
       end
     end

data/lib/solargraph/pin/base_method.rb

@@ -34,23 +34,40 @@ module Solargraph
         ComplexType.try_parse *tag.types
       end
 
-      # @param [ApiMap]
+      # @param api_map [ApiMap]
+      # @return [ComplexType]
       def see_reference api_map
         docstring.ref_tags.each do |ref|
           next unless ref.tag_name == 'return' && ref.owner
-          parts = ref.owner.to_s.split(/[\.#]/)
-          if parts.first.empty?
-            path = "#{namespace}#{ref.owner.to_s}"
-          else
-            fqns = api_map.qualify(parts.first, namespace)
-            return ComplexType::UNDEFINED if fqns.nil?
-            path = fqns + ref.owner.to_s[parts.first.length] + parts.last
-          end
-          pins = api_map.get_path_pins(path)
-          pins.each do |pin|
-            type = pin.typify(api_map)
-            return type unless type.undefined?
-          end
+          result = resolve_reference(ref.owner.to_s, api_map)
+          return result unless result.nil?
+        end
+        match = comments.match(/\(see (.*)\)/)
+        return nil if match.nil?
+        resolve_reference match[1], api_map
+      end
+
+      # @param ref [String]
+      # @param api_map [ApiMap]
+      # @return [ComplexType]
+      def resolve_reference ref, api_map
+        parts = ref.split(/[\.#]/)
+        if parts.first.empty?
+          path = "#{namespace}#{ref}"
+        else
+          fqns = api_map.qualify(parts.first, namespace)
+          return ComplexType::UNDEFINED if fqns.nil?
+          path = fqns + ref[parts.first.length] + parts.last
+        end
+        pins = api_map.get_path_pins(path)
+        pins.each do |pin|
+          type = pin.typify(api_map)
+          return type unless type.undefined?
+        end
+        pins = api_map.get_path_pins(path)
+        pins.each do |pin|
+          type = pin.typify(api_map)
+          return type unless type.undefined?
         end
         nil
       end

data/lib/solargraph/pin/block_parameter.rb

@@ -85,6 +85,10 @@ module Solargraph
             bmeth = chain.base.define(api_map, context, locals).first
             return ComplexType::UNDEFINED if bmeth.nil? or bmeth.return_complex_type.undefined? or bmeth.return_complex_type.subtypes.empty?
             return bmeth.return_complex_type.subtypes.first.qualify(api_map, bmeth.context.namespace)
+          elsif (Solargraph::CoreFills::METHODS_WITH_YIELDPARAM_SELF.include?(meth.path))
+            bmeth = chain.base.define(api_map, context, locals).first
+            return ComplexType::UNDEFINED if bmeth.nil?
+            return bmeth.typify(api_map)
           else
             yps = meth.docstring.tags(:yieldparam)
             unless yps[index].nil? or yps[index].types.nil? or yps[index].types.empty?

data/lib/solargraph/source.rb

@@ -1,4 +1,5 @@
 require 'parser/current'
+require 'yard'
 
 module Solargraph
   # A Ruby file that has been parsed into an AST.
@@ -327,7 +328,7 @@ module Solargraph
       last_line = nil
       comments.each { |l|
         # Trim the comment and minimum leading whitespace
-        p = l.text.gsub(/^#/, '')
+        p = l.text.gsub(/^#+/, '')
         if num.nil? and !p.strip.empty?
           num = p.index(/[^ ]/)
           started = true
@@ -465,7 +466,7 @@ module Solargraph
       # @param filename [String]
       # @return [Solargraph::Source]
       def load filename
-        file = File.open(filename, 'rb')
+        file = File.open(filename)
         code = file.read
         file.close
         Source.load_string(code, filename)
@@ -484,7 +485,7 @@ module Solargraph
       # @return [Array(Parser::AST::Node, Array<Parser::Source::Comment>)]
       def parse_with_comments code, filename = nil
         buffer = Parser::Source::Buffer.new(filename, 0)
-        buffer.source = code.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '_')
+        buffer.source = code
         parser.parse_with_comments(buffer)
       end
 
@@ -494,7 +495,7 @@ module Solargraph
       # @return [Parser::AST::Node]
       def parse code, filename = nil, line = 0
         buffer = Parser::Source::Buffer.new(filename, line)
-        buffer.source = code.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '_')
+        buffer.source = code
         parser.parse(buffer)
       end
 
@@ -507,6 +508,14 @@ module Solargraph
         parser.diagnostics.ignore_warnings      = true
         parser
       end
+
+      # @param comments [String]
+      # @return [YARD::DocstringParser]
+      def parse_docstring comments
+        # HACK: Pass a dummy code object to the parser for plugins that
+        # expect it not to be nil
+        YARD::Docstring.parser.parse(comments, YARD::CodeObjects::Base.new(:root, 'stub'))
+      end
     end
   end
 end

data/lib/solargraph/source/chain/call.rb

@@ -94,7 +94,7 @@ module Solargraph
             txt.gsub!(/\$#{i}/, v.context.namespace)
             i += 1
           end
-          docstring = YARD::Docstring.parser.parse(txt).to_docstring
+          docstring = Solargraph::Source.parse_docstring(txt).to_docstring
           tag = docstring.tag(:return)
           unless tag.nil? || tag.types.nil?
             return Pin::ProxyType.anonymous(ComplexType.try_parse(*tag.types))

data/lib/solargraph/source/source_chainer.rb

@@ -157,6 +157,7 @@ module Solargraph
               end
               if brackets.zero? and parens.zero? and squares.zero?
                 break if ['"', "'", ',', ';', '%'].include?(char)
+                break if !signature.empty? && ['!', '?'].include?(char)
                 signature = char + signature if char.match(/[a-z0-9:\._@\$\?\!]/i) and @source.code[index - 1] != '%'
                 break if char == '$'
                 if char == '@'

data/lib/solargraph/source_map/mapper.rb

@@ -21,10 +21,14 @@ module Solargraph
         @filename = source.filename
         @code = source.code
         @comments = source.comments
-        @pins = Solargraph::SourceMap::NodeProcessor.process(source.node, Solargraph::SourceMap::Region.new(source: source), [])
+        @pins = NodeProcessor.process(source.node, Region.new(source: source))
         process_comment_directives
         locals = @pins.select{|p| [Pin::LocalVariable, Pin::MethodParameter, Pin::BlockParameter].include?(p.class)}
         [@pins - locals, locals]
+      rescue Exception => e
+        Solargraph.logger.warn "Error mapping #{source.filename}: [#{e.class}] #{e.message}"
+        Solargraph.logger.warn e.backtrace
+        [[], []]
       end
 
       def unmap filename, code
@@ -62,14 +66,14 @@ module Solargraph
       def process_comment source_position, comment_position, comment
         return unless comment =~ MACRO_REGEXP
         cmnt = remove_inline_comment_hashes(comment)
-        parse = YARD::Docstring.parser.parse(cmnt)
+        parse = Solargraph::Source.parse_docstring(cmnt)
         parse.directives.each { |d| process_directive(source_position, comment_position, d) }
       end
 
       # @param position [Position]
       # @param directive [YARD::Tags::Directive]
       def process_directive source_position, comment_position, directive
-        docstring = YARD::Docstring.parser.parse(directive.tag.text).to_docstring
+        docstring = Solargraph::Source.parse_docstring(directive.tag.text).to_docstring
         location = Location.new(@filename, Range.new(comment_position, comment_position))
         case directive.tag.tag_name
         when 'method'

data/lib/solargraph/source_map/node_processor/send_node.rb

@@ -147,8 +147,8 @@ module Solargraph
           if node.children[2].type == :sym || node.children[2].type == :str
             ref = pins.select{|p| [Solargraph::Pin::Method, Solargraph::Pin::Attribute].include?(p.class) && p.namespace == region.namespace && p.name == node.children[2].children[0].to_s}.first
             unless ref.nil?
-              pins.delete ref
-              pins.push Solargraph::Pin::Method.new(ref.location, ref.namespace, ref.name, ref.comments, ref.scope, :private, ref.parameters, ref.node)
+              # HACK: Smelly instance variable access
+              ref.instance_variable_set(:@visibility, :private)
             end
             false
           else

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.31.3'
+  VERSION = '0.32.0'
 end

data/lib/solargraph/yard_map.rb

@@ -123,9 +123,9 @@ module Solargraph
 
     # @param code_object [YARD::CodeObjects::Base]
     # @return [Solargraph::Pin::Base]
-    def generate_pins code_object
+    def generate_pins code_object, spec = nil
       result = []
-      location = object_location(code_object)
+      location = object_location(code_object, spec)
       if code_object.is_a?(YARD::CodeObjects::NamespaceObject)
         result.push Solargraph::Pin::YardPin::Namespace.new(code_object, location)
         if code_object.is_a?(YARD::CodeObjects::ClassObject) and !code_object.superclass.nil?
@@ -186,7 +186,7 @@ module Solargraph
           @gem_paths[spec.name] = spec.full_gem_path
           unless yardocs.include?(yd)
             yardocs.unshift yd
-            result.concat process_yardoc yd
+            result.concat process_yardoc yd, spec
             result.concat add_gem_dependencies(spec) if with_dependencies?
           end
         rescue Gem::LoadError => e
@@ -248,7 +248,7 @@ module Solargraph
           else
             next if yardocs.include?(gy)
             yardocs.unshift gy
-            result.concat process_yardoc gy
+            result.concat process_yardoc gy, depspec
             result.concat add_gem_dependencies(depspec)
           end
         rescue Gem::LoadError
@@ -261,7 +261,7 @@ module Solargraph
 
     # @param y [String, nil]
     # @return [Array<Pin::Base>]
-    def process_yardoc y
+    def process_yardoc y, spec = nil
       return [] if y.nil?
       size = Dir.glob(File.join(y, '**', '*'))
         .map{ |f| File.size(f) }
@@ -273,20 +273,26 @@ module Solargraph
       result = []
       load_yardoc y
       YARD::Registry.each do |o|
-        result.concat generate_pins(o)
+        result.concat generate_pins(o, spec)
       end
       result
     end
 
     # @param obj [YARD::CodeObjects::Base]
     # @return [Solargraph::Location]
-    def object_location obj
-      return nil if obj.file.nil? or obj.line.nil?
-      @gem_paths.values.each do |path|
-        file = File.join(path, obj.file)
-        return Solargraph::Location.new(file, Solargraph::Range.from_to(obj.line, 0, obj.line, 0)) if File.exist?(file)
+    def object_location obj, spec = nil
+      @object_file_cache ||= {}
+      return nil if spec.nil? || obj.file.nil? || obj.line.nil?
+      file = nil
+      if @object_file_cache.key?(obj.file)
+        file = @object_file_cache[obj.file]
+      else
+        tmp = File.join(spec.full_gem_path, obj.file)
+        file = tmp if File.exist?(tmp)
+        @object_file_cache[obj.file] = file
       end
-      nil
+      return nil if file.nil?
+      Solargraph::Location.new(file, Solargraph::Range.from_to(obj.line - 1, 0, obj.line - 1, 0))
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.31.3
+  version: 0.32.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2019-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.17.2
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -286,6 +300,7 @@ files:
 - lib/solargraph/language_server/message/text_document/formatting.rb
 - lib/solargraph/language_server/message/text_document/hover.rb
 - lib/solargraph/language_server/message/text_document/on_type_formatting.rb
+- lib/solargraph/language_server/message/text_document/prepare_rename.rb
 - lib/solargraph/language_server/message/text_document/references.rb
 - lib/solargraph/language_server/message/text_document/rename.rb
 - lib/solargraph/language_server/message/text_document/signature_help.rb