solargraph 0.28.4 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0fd24fe0b737e17e14772aa13d7b948b5721ba99f3a0855682e78503ca337816
-  data.tar.gz: 1e907c9e1f5fa10537c406fdd512574da4dce74354d0d16accb04d91794c29a4
+  metadata.gz: c715438f197d1c368427a61e4b745993ce0cca12b3db96d647f922be67c39e90
+  data.tar.gz: 1b82249c56fdb3014c69ec43e12cdac30b9f029cffb8d09896c4e19da7e24a81
 SHA512:
-  metadata.gz: 77d273f6d65def59c5d4661a3479948fffce730fe9aebdff94cdc24dbefed1be8d60633e469a2d3f8c9941d1463980ed0db71eef7bdffe1182b6d9abc1835af6
-  data.tar.gz: e836999b24c652aa457a32db9f29a46264b91401c1fe6f4a86dc62baf9fce78e49f8795b6e957919ddcca21924c7ccc57a54d030f6183095dfa5d1663ab650d6
+  metadata.gz: d9b8ed3db0337ef27ff07e1bb28c6bdac6e37bee655333b8465366a0ed3bf01c614dca4dcbaed4ddb1f535abd32639bd53553b3ab044fcb0b4311aa73778d732
+  data.tar.gz: 83f8266b77ff13d9750a889f04bbda44b15c39d2a2dbe0dca975f5a5af1835d3d78ee06e806906b65d7fb66dba08a7d09756df0ecbc7e69a9bc13fab29340e47

data/lib/solargraph/api_map.rb

@@ -21,7 +21,6 @@ module Solargraph
     attr_reader :unresolved_requires
 
     # @param pins [Array<Solargraph::Pin::Base>]
-    # def initialize workspace = Solargraph::Workspace.new(nil)
     def initialize pins: []
       # @todo Extensions don't work yet
       # require_extensions
@@ -40,9 +39,15 @@ module Solargraph
         @store = Store.new(pins + YardMap.new.pins)
         @unresolved_requires = []
       }
+      resolved = resolve_method_aliases
+      unless resolved.nil?
+        @mutex.synchronize { @store = Store.new(resolved) }
+      end
       self
     end
 
+    # Map a single source.
+    #
     # @param source [Source]
     # @return [self]
     def map source
@@ -50,8 +55,11 @@ module Solargraph
       self
     end
 
-    # Catalog a workspace. Additional sources that need to be mapped can be
-    # included in an optional array.
+    def named_macro name
+      store.named_macros[name]
+    end
+
+    # Catalog a bundle.
     #
     # @param bundle [Bundle]
     # @return [self]
@@ -106,6 +114,10 @@ module Solargraph
         @store = new_store
         @unresolved_requires = yard_map.unresolved_requires
       }
+      resolved = resolve_method_aliases
+      unless resolved.nil?
+        @mutex.synchronize { @store = Store.new(resolved) }
+      end
       self
     end
 
@@ -143,7 +155,7 @@ module Solargraph
       store.pins
     end
 
-    # An array of suggestions based on Ruby keywords (`if`, `end`, etc.).
+    # An array of pins based on Ruby keywords (`if`, `end`, etc.).
     #
     # @return [Array<Solargraph::Pin::Keyword>]
     def self.keywords
@@ -305,7 +317,13 @@ module Solargraph
         result.concat get_methods('Object')
       else
         unless type.nil? || type.name == 'void'
-          namespace = qualify(type.namespace, context)
+          # @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)
             visibility.push :protected
@@ -330,12 +348,13 @@ module Solargraph
     # @param scope [Symbol] :instance or :class
     # @return [Array<Solargraph::Pin::Base>]
     def get_method_stack fqns, name, scope: :instance
-      # @todo This cache is still causing problems.
-      cached = cache.get_method_stack(fqns, name, scope)
-      return cached unless cached.nil?
+      # @todo This cache is still causing problems, but only when using
+      #   Solargraph on Solargraph itself.
+      # cached = cache.get_method_stack(fqns, name, scope)
+      # return cached unless cached.nil?
       result = get_methods(fqns, scope: scope, visibility: [:private, :protected, :public]).select{|p| p.name == name}
-      cache.set_method_stack(fqns, name, scope, result)
-      result
+      # cache.set_method_stack(fqns, name, scope, result)
+      # result
     end
 
     # Get an array of all suggestions that match the specified path.
@@ -621,5 +640,19 @@ module Solargraph
       end
       false
     end
+
+    # @return [Array<Pin::Base>, nil]
+    def resolve_method_aliases
+      aliased = false
+      result = pins.map do |pin|
+        next pin unless pin.is_a?(Pin::MethodAlias)
+        origin = get_method_stack(pin.namespace, pin.original, scope: pin.scope).select{|pin| pin.class == Pin::Method}.first
+        next pin if origin.nil?
+        aliased = true
+        Pin::Method.new(pin.location, pin.namespace, pin.name, origin.comments, origin.scope, origin.visibility, origin.parameters)
+      end
+      return nil unless aliased
+      result
+    end
   end
 end

data/lib/solargraph/api_map/store.rb

@@ -109,6 +109,19 @@ module Solargraph
         result
       end
 
+      def named_macros
+        @named_macros ||= begin
+          result = {}
+          pins.each do |pin|
+            pin.macros.select{|m| m.tag.tag_name == 'macro'}.each do |macro|
+              next if macro.tag.name.nil? || macro.tag.name.empty?
+              result[macro.tag.name] = macro
+            end
+          end
+          result
+        end
+      end
+
       private
 
       # @param fqns [String]

data/lib/solargraph/bundle.rb

@@ -1,4 +1,7 @@
 module Solargraph
+  # An aggregation of a workspace and additional sources to be cataloged in an
+  # ApiMap.
+  #
   class Bundle
     # @return [Workspace]
     attr_reader :workspace

data/lib/solargraph/complex_type.rb

@@ -28,6 +28,7 @@ module Solargraph
     end
 
     def method_missing name, *args, &block
+      return if first.nil?
       return first.send(name, *args, &block) if respond_to_missing?(name)
       super
     end
@@ -76,7 +77,7 @@ module Solargraph
             elsif char == '<'
               point_stack += 1
             elsif char == '>'
-              if subtype_string.end_with?('=') and curly_stack > 0
+              if subtype_string.end_with?('=') && curly_stack > 0
                 subtype_string += char
               elsif base.end_with?('=')
                 raise ComplexTypeError, "Invalid hash thing" unless key_types.nil?
@@ -106,13 +107,13 @@ module Solargraph
               subtype_string += char if paren_stack == 0
               raise ComplexTypeError, "Invalid close in type #{type_string}" if paren_stack < 0
               next
-            elsif char == ',' and point_stack == 0 and curly_stack == 0 and paren_stack == 0
+            elsif char == ',' && point_stack == 0 && curly_stack == 0 && paren_stack == 0
               types.push ComplexType.new([UniqueType.new(base.strip, subtype_string.strip)])
               base = ''
               subtype_string = ''
               next
             end
-            if point_stack == 0 and curly_stack == 0 and paren_stack == 0
+            if point_stack == 0 && curly_stack == 0 && paren_stack == 0
               base += char 
             else
               subtype_string += char
@@ -120,7 +121,7 @@ module Solargraph
           end
           base.strip!
           subtype_string.strip!
-          raise ComplexTypeError, "Unclosed subtype in #{type_string}" if point_stack != 0 or curly_stack != 0 or paren_stack != 0
+          raise ComplexTypeError, "Unclosed subtype in #{type_string}" if point_stack != 0 || curly_stack != 0 || paren_stack != 0
           types.push ComplexType.new([UniqueType.new(base, subtype_string)])
         end
         unless key_types.nil?

data/lib/solargraph/core_fills.rb

@@ -20,13 +20,14 @@ module Solargraph
     ].freeze
 
     METHODS_WITH_YIELDPARAM_SUBTYPES = %w[
-      Array#each Array#map Array#any? Array#all?
+      Array#each Array#map Array#any? Array#all? Array#index
       Enumerable#each_entry Enumerable#map Enumerable#any? Enumerable#all?
       Set#each
     ].freeze
 
     CUSTOM_RETURN_TYPES = {
-      'String#split' => 'Array<String>'
+      'String#split' => 'Array<String>',
+      'String#lines' => 'Array<String>'
     }.freeze
   end
 end

data/lib/solargraph/language_server/host.rb

@@ -322,7 +322,6 @@ module Solargraph
       end
 
       def locate_pin params
-        pin = nil
         pin = nil
         unless params['data']['location'].nil?
           location = Location.new(

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

@@ -14,9 +14,9 @@ module Solargraph
               fetcher = Gem::SpecFetcher.new
               tuple = fetcher.search_for_dependency(Gem::Dependency.new('solargraph')).flatten.first
               if tuple.nil?
-                msg = "An error occurred checking the Solargraph gem version."
+                msg = 'An error occurred checking the Solargraph gem version.'
                 STDERR.puts msg
-                host.show_message(msg, MessageTypes::ERROR) if params['verbose']
+                host.show_message(msg, MessageTypes::ERROR)
               else
                 available = Gem::Version.new(tuple.version)
                 current = Gem::Version.new(Solargraph::VERSION)
@@ -24,10 +24,11 @@ module Solargraph
                   host.show_message_request "Solagraph gem version #{available} is available.",
                                             LanguageServer::MessageTypes::INFO,
                                             ['Update now'] do |result|
-                                              break unless result == 'Update now'
+                                              next unless result == 'Update now'
                                               o, s = Open3.capture2("gem update solargraph")
                                               if s == 0
                                                 host.show_message 'Successfully updated the Solargraph gem.', LanguageServer::MessageTypes::INFO
+                                                host.send_notification '$/solargraph/restart'
                                               else
                                                 host.show_message 'An error occurred while updating the gem.', LanguageServer::MessageTypes::ERROR
                                               end

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

@@ -14,6 +14,13 @@ module Solargraph
             o, s = Open3.capture2(cmd)
             if s != 0
               host.show_message "An error occurred while building gem documentation.", LanguageServer::MessageTypes::ERROR
+              set_result({
+                status: 'err'
+              })
+            else
+              set_result({
+                status: 'ok'
+              })
             end
           end
         end

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

@@ -33,7 +33,13 @@ module Solargraph
           EventMachine.add_periodic_timer 0.1 do
             tmp = @host.flush
             send_data tmp unless tmp.empty?
-            EventMachine.stop if @host.stopped?
+            if @host.stopped?
+              if @host.options['transport'] == 'external'
+                @host = Solargraph::LanguageServer::Host.new
+              else
+                EventMachine.stop
+              end
+            end
           end
         end
       end

data/lib/solargraph/library.rb

@@ -174,7 +174,7 @@ module Solargraph
             referenced.any?{|r| r == pin}
           end
           # HACK for language clients that exclude special characters from the start of variable names
-          if strip && match = cursor.word.match(/^[^a-z0-9_]+/)
+          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

data/lib/solargraph/page.rb

@@ -2,7 +2,6 @@ require 'ostruct'
 require 'tilt'
 require 'kramdown'
 require 'htmlentities'
-require 'coderay'
 require 'reverse_markdown'
 
 module Solargraph
@@ -25,7 +24,7 @@ module Solargraph
           entity_output: :symbolic,
           syntax_highlighter_opts: {
             block: {
-              line_numbers: false,
+              line_numbers: false
             },
             default_lang: :ruby
           },

data/lib/solargraph/pin.rb

@@ -5,6 +5,7 @@ module Solargraph
     autoload :Conversions,      'solargraph/pin/conversions'
     autoload :Base,             'solargraph/pin/base'
     autoload :Method,           'solargraph/pin/method'
+    autoload :MethodAlias,      'solargraph/pin/method_alias'
     autoload :Attribute,        'solargraph/pin/attribute'
     autoload :BaseVariable,     'solargraph/pin/base_variable'
     autoload :InstanceVariable, 'solargraph/pin/instance_variable'

data/lib/solargraph/pin/base.rb

@@ -124,7 +124,7 @@ module Solargraph
 
       # @return [Array<YARD::Tags::MacroDirective>]
       def macros
-        @macros ||= []
+        @macros ||= collect_macros
       end
 
       # Perform a quick check to see if this pin possibly includes YARD
@@ -220,6 +220,13 @@ module Solargraph
           t1.name == t2.name &&
           t1.types == t2.types
       end
+
+      # @return [Array<YARD::Tags::Handlers::Directive>]
+      def collect_macros
+        return [] unless maybe_directives?
+        parse = YARD::Docstring.parser.parse(comments)
+        parse.directives.select{ |d| d.tag.tag_name == 'macro' }
+      end
     end
   end
 end

data/lib/solargraph/pin/base_variable.rb

@@ -65,7 +65,7 @@ module Solargraph
 
       def generate_complex_type
         tag = docstring.tag(:type)
-        return ComplexType.parse(*tag.types) unless tag.nil?
+        return ComplexType.parse(*tag.types) unless tag.nil? || tag.types.nil? || tag.types.empty?
         return ComplexType.parse(@literal) unless @literal.nil?
         ComplexType.new
       end

data/lib/solargraph/pin/block_parameter.rb

@@ -56,9 +56,14 @@ module Solargraph
           params.each do |p|
             next unless p.name == name
             found = p
+            break
+          end
+          if found.nil? and !index.nil?
+            found = params[index] if params[index] && (params[index].name.nil? || params[index].name.empty?)
           end
           @return_complex_type = ComplexType.parse(*found.types) unless found.nil? or found.types.nil?
         end
+        super
         @return_complex_type
       end
 

data/lib/solargraph/pin/conversions.rb

@@ -70,8 +70,8 @@ module Solargraph
 
       def generate_link
         this_path = path || return_type.tag
+        return nil if this_path.nil? || this_path == 'undefined'
         return this_path if comments.empty?
-        return nil if this_path.nil? or this_path == 'undefined'
         "[#{this_path.gsub('_', '\\\\_')}](solargraph:/document?query=#{URI.encode(this_path)})"
       end
     end

data/lib/solargraph/pin/method.rb

@@ -1,6 +1,8 @@
 module Solargraph
   module Pin
     class Method < Base
+      include Source::NodeMethods
+
       # @return [Symbol] :instance or :class
       attr_reader :scope
 
@@ -10,11 +12,15 @@ module Solargraph
       # @return [Array<String>]
       attr_reader :parameters
 
-      def initialize location, namespace, name, comments, scope, visibility, args
+      # @return [Parser::AST::Node]
+      attr_reader :node
+
+      def initialize location, namespace, name, comments, scope, visibility, args, node = nil
         super(location, namespace, name, comments)
         @scope = scope
         @visibility = visibility
         @parameters = args
+        @node = node
       end
 
       # @return [Array<String>]
@@ -81,6 +87,20 @@ module Solargraph
           visibility == other.visibility
       end
 
+      def infer api_map
+        decl = super
+        return decl unless decl.undefined?
+        type = see_reference(api_map)
+        return type unless type.nil?
+        infer_from_return_nodes(api_map)
+      end
+
+      def try_merge! pin
+        return false unless super
+        @node = pin.node
+        true
+      end
+
       private
 
       # @return [ComplexType]
@@ -98,6 +118,44 @@ module Solargraph
           ComplexType::UNDEFINED
         end
       end
+
+      # @param api_map [ApiMap]
+      def infer_from_return_nodes api_map
+        return ComplexType::UNDEFINED if node.nil? ||
+          (node.type == :def && node.children[2].nil?) ||
+          (node.type == :defs && node.children[3].nil?)
+        result = []
+        nodes = node.type == :def ? returns_from(node.children[2]) : returns_from(node.children[3])
+        nodes.each do |n|
+          next if n.loc.nil?
+          clip = api_map.clip_at(location.filename, Solargraph::Position.new(n.loc.expression.last_line, n.loc.expression.last_column))
+          type = clip.infer
+          result.push type unless type.undefined?
+        end
+        return ComplexType::UNDEFINED if result.empty?
+        ComplexType.parse(*result.map(&:tag))
+      end
+
+      # @param [ApiMap]
+      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.infer(api_map)
+            return type unless type.undefined?
+          end
+        end
+        nil
+      end
     end
   end
 end