solargraph 0.18.2 → 0.18.3

data/lib/solargraph/pin.rb

@@ -19,5 +19,6 @@ module Solargraph
     autoload :Parameter,        'solargraph/pin/parameter'
     autoload :MethodParameter,  'solargraph/pin/method_parameter'
     autoload :BlockParameter,   'solargraph/pin/block_parameter'
+    autoload :Reference,        'solargraph/pin/reference'
   end
 end

data/lib/solargraph/pin/base.rb

@@ -99,6 +99,7 @@ module Solargraph
       def documentation
         if @documentation.nil? and !docstring.nil?
           @documentation = ReverseMarkdown.convert(helper.html_markup_rdoc(docstring), github_flavored: true)
+          @documentation.strip!
         end
         @documentation
       end
@@ -124,7 +125,7 @@ module Solargraph
       end
 
       def identifier
-        @identifier ||= "#{path || location}"
+        @identifier ||= "#{path}|#{name}"
       end
 
       def variable?

data/lib/solargraph/pin/base_variable.rb

@@ -6,6 +6,7 @@ module Solargraph
       def initialize source, node, namespace
         super
         @tried_to_detect_return_type = false
+        @tried_to_resolve_return_type = false
       end
 
       def name
@@ -20,7 +21,7 @@ module Solargraph
         if @return_type.nil? and !@tried_to_detect_return_type
           @tried_to_detect_return_type = true
           if docstring.nil?
-            @return_type ||= literal_from_assignment
+            @return_type ||= infer_literal_node_type(assignment_node)
           else
             tag = docstring.tag(:type)
             @return_type = tag.types[0] unless tag.nil?
@@ -41,11 +42,29 @@ module Solargraph
         @signature ||= resolve_node_signature(assignment_node)
       end
 
+      def calculated_signature
+        if @calculated_signature.nil?
+          if signature.empty?
+            type = infer_literal_node_type(assignment_node)
+            @calculated_signature = "#{type}.new" unless type.nil?
+          end
+          @calculated_signature ||= signature
+        end
+        @calculated_signature
+      end
+
       # @param api_map [Solargraph::ApiMap]
       def resolve api_map
-        if return_type.nil?
+        if return_type.nil? and !@tried_to_resolve_return_type
+          @tried_to_detect_return_type = true
           return nil if signature.nil? or signature.empty? or signature == name or signature.split('.').first.strip == name
-          @return_type = api_map.infer_signature_type(signature, namespace, call_node: node)
+          # @todo This should be able to resolve signatures that start with local variables
+          macro_type = nil
+          # pin = api_map.tail_pin(signature, namespace, :class, [:public, :private, :protected])
+          # unless pin.nil? or !pin.method?
+          #   macro_type = get_return_type_from_macro(pin, assignment_node)
+          # end
+          @return_type = macro_type || api_map.infer_type(signature, namespace, scope: :class)
         end
       end
 
@@ -55,8 +74,29 @@ module Solargraph
 
       private
 
-      def literal_from_assignment
-        infer_literal_node_type(assignment_node)
+      def get_call_arguments node
+        return get_call_arguments(node.children[1]) if [:ivasgn, :cvasgn, :lvasgn].include?(node.type)
+        return [] unless node.type == :send
+        result = []
+        node.children[2..-1].each do |c|
+          result.push unpack_name(c)
+        end
+        result
+      end
+
+      def get_return_type_from_macro method_pin, call_node
+        return nil if method_pin.docstring.nil?
+        type = nil
+        all = YARD::Docstring.parser.parse(method_pin.docstring.all).directives
+        macro = all.select{|m| m.tag.tag_name == 'macro'}.first
+        return nil if macro.nil?
+        macstring = YARD::Docstring.parser.parse(macro.tag.text).to_docstring
+        rt = macstring.tag(:return)
+        unless rt.nil? or rt.types.nil?
+          args = get_call_arguments(call_node)
+          type = "#{args[rt.types[0][1..-1].to_i-1]}"
+        end
+        type
       end
     end
   end

data/lib/solargraph/pin/block_parameter.rb

@@ -21,12 +21,15 @@ module Solargraph
       def resolve api_map
         return unless return_type.nil?
         signature = resolve_node_signature(@tree[0].children[0])
-        meth = api_map.infer_signature_pins(signature, namespace, :class, node).first
+        # @todo Hardcoding :class scope might not be appropriate
+        # meth = api_map.infer_pin(signature, namespace, :class, [:public, :private, :protected], true)
+        meth = api_map.tail_pin(signature, namespace, :class, [:public, :private, :protected])
         return nil if meth.nil?
         if (Solargraph::CoreFills::METHODS_WITH_YIELDPARAM_SUBTYPES.include?(meth.path))
           base = signature.split('.')[0..-2].join('.')
           return nil if base.nil? or base.empty?
-          bmeth = api_map.infer_signature_pins(base, namespace, :class, node).first
+          # @todo Maybe use a fragment so this picks up local variables
+          bmeth = api_map.tail_pin(base, namespace, :class, [:public, :private, :protected])
           return nil if bmeth.nil?
           subtypes = get_subtypes(bmeth.return_type)
           @return_type = api_map.find_fully_qualified_namespace(subtypes[0], namespace)

data/lib/solargraph/pin/method.rb

@@ -43,6 +43,28 @@ module Solargraph
         @parameters ||= get_method_args
       end
 
+      def documentation
+        if @documentation.nil?
+          @documentation ||= super || ''
+          unless docstring.nil?
+            param_tags = docstring.tags(:param)
+            unless param_tags.nil? or param_tags.empty?
+              @documentation += "\n\n"
+              @documentation += "Params:\n"
+              lines = []
+              param_tags.each do |p|
+                l = "* #{p.name}"
+                l += " [#{p.types.join(', ')}]" unless p.types.empty?
+                l += " #{p.text}"
+                lines.push l
+              end
+              @documentation += lines.join("\n")
+            end
+          end
+        end
+        @documentation
+      end
+
       # @todo This method was temporarily migrated directly from Suggestion
       # @return [Array<String>]
       def params

data/lib/solargraph/pin/namespace.rb

@@ -5,13 +5,26 @@ module Solargraph
 
       attr_reader :visibility
 
-      def initialize source, node, namespace, visibility
+      def initialize source, node, namespace, visibility, superclass = nil
         super(source, node, namespace)
         @visibility = visibility
+        @superclass_reference = Reference.new(self, superclass) unless superclass.nil?
+      end
+
+      def reference_include name
+        include_references.push Reference.new(self, name)
+      end
+
+      def reference_extend name
+        extend_references.push Reference.new(self, name)
+      end
+
+      def reference_superclass name
+        @superclass_reference = Reference.new(self, name)
       end
 
       def name
-        @name ||= pack_name(node.children[0]).last.to_s
+        @name ||= (node.type == :source ? '' : pack_name(node.children[0]).last.to_s)
       end
 
       def path
@@ -22,11 +35,28 @@ module Solargraph
         @kind ||= (node.type == :class ? Solargraph::LanguageServer::CompletionItemKinds::CLASS : Solargraph::LanguageServer::CompletionItemKinds::MODULE)
       end
 
+      def include_references
+        @include_references ||= []
+      end
+
+      def extend_references
+        @extend_references ||= []
+      end
+
+      def superclass_reference
+        @superclass_reference
+      end
+
       # @return [Symbol] :class or :module
       def type
         node.type
       end
 
+      def location
+        return "#{source.filename}:0" if name.empty?
+        super
+      end
+
       def return_type
         @return_type ||= (node.type == :class ? 'Class' : 'Module') + "<#{path}>"
       end

data/lib/solargraph/pin/reference.rb

@@ -0,0 +1,21 @@
+module Solargraph
+  module Pin
+    class Reference
+      attr_reader :pin
+      attr_reader :name
+
+      def initialize pin, name
+        @pin = pin
+        @name = name
+        @resolved = false
+      end
+
+      def resolve api_map
+        unless @resolved
+          @resolved = true
+          @name = api_map.find_fully_qualified_namespace(@name, pin.namespace)
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/pin/yard_object.rb

@@ -81,6 +81,15 @@ module Solargraph
         completion_item_kind == Solargraph::LanguageServer::CompletionItemKinds::METHOD
       end
 
+      def visibility
+        :public #@todo Resolve this
+      end
+
+      def scope
+        return nil unless code_object.is_a?(YARD::CodeObjects::MethodObject)
+        code_object.scope
+      end
+
       private
 
       def get_method_args

data/lib/solargraph/shell.rb

@@ -1,136 +1,136 @@
-require 'thor'
-require 'json'
-require 'fileutils'
-require 'rubygems/package'
-require 'zlib'
-require 'eventmachine'
-
-module Solargraph
-  class Shell < Thor
-    include Solargraph::ServerMethods
-
-    map %w[--version -v] => :version
-
-    desc "--version, -v", "Print the version"
-    def version
-      puts Solargraph::VERSION
-    end
-
-    desc 'server', 'Start a Solargraph server'
-    option :port, type: :numeric, aliases: :p, desc: 'The server port', default: 7657
-    option :views, type: :string, aliases: :v, desc: 'The view template directory', default: nil
-    option :files, type: :string, aliases: :f, desc: 'The public files directory', default: nil
-    def server
-      port = options[:port]
-      port = available_port if port.zero?
-      Solargraph::Server.set :port, port
-      Solargraph::Server.set :views, options[:views] unless options[:views].nil?
-      Solargraph::Server.set :public_folder, options[:files] unless options[:files].nil?
-      my_pid = nil
-      Solargraph::Server.run! do
-        # This line should not be necessary with WEBrick
-        #STDERR.puts "Solargraph server pid=#{Process.pid} port=#{port}"
-        my_pid = Process.pid
-        Signal.trap("INT") do
-          Solargraph::Server.stop!
-        end
-        Signal.trap("TERM") do
-          Solargraph::Server.stop!
-        end
-      end
-    end
-
-    desc 'socket', 'Run a Solargraph socket server'
-    option :host, type: :string, aliases: :h, desc: 'The server host', default: '127.0.0.1'
-    option :port, type: :numeric, aliases: :p, desc: 'The server port', default: 7658
-    def socket
-      port = options[:port]
-      port = available_port if port.zero?
-      EventMachine.run do
-        Signal.trap("INT") do
-          EventMachine.stop
-        end
-        Signal.trap("TERM") do
-          EventMachine.stop
-        end
-        EventMachine.start_server options[:host], port, Solargraph::LanguageServer::Transport::Socket
-        STDERR.puts "Solargraph is listening PORT=#{port} PID=#{Process.pid}"
-      end
-    end
-
-    desc 'suggest', 'Get code suggestions for the provided input'
-    long_desc <<-LONGDESC
-      Analyze a Ruby file and output a list of code suggestions in JSON format.
-    LONGDESC
-    option :line, type: :numeric, aliases: :l, desc: 'Zero-based line number', required: true
-    option :column, type: :numeric, aliases: [:c, :col], desc: 'Zero-based column number', required: true
-    option :filename, type: :string, aliases: :f, desc: 'File name', required: false
-    def suggest(*filenames)
-      STDERR.puts "WARNING: The `solargraph suggest` command is a candidate for deprecation. It will either change drastically or not exist in a future version."
-      # HACK: The ARGV array needs to be manipulated for ARGF.read to work
-      ARGV.clear
-      ARGV.concat filenames
-      text = ARGF.read
-      filename = options[:filename] || filenames[0]
-      begin
-        code_map = CodeMap.new(code: text, filename: filename)
-        offset = code_map.get_offset(options[:line], options[:column])
-        sugg = code_map.suggest_at(offset, filtered: true)
-        result = { "status" => "ok", "suggestions" => sugg }.to_json
-        STDOUT.puts result
-      rescue Exception => e
-        STDERR.puts e
-        STDERR.puts e.backtrace.join("\n")
-        result = { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
-        STDOUT.puts result
-      end
-    end
-
-    desc 'config [DIRECTORY]', 'Create or overwrite a default configuration file'
-    option :extensions, type: :boolean, aliases: :e, desc: 'Add installed extensions', default: true
-    def config(directory = '.')
-      matches = []
-      if options[:extensions]
-        Gem::Specification.each do |g|
-          puts g.name
-          if g.name.match(/^solargraph\-[A-Za-z0-9_\-]*?\-ext/)
-            require g.name
-            matches.push g.name
-          end
-        end
-      end
-      conf = Solargraph::Workspace::Config.new.raw_data
-      unless matches.empty?
-        matches.each do |m|
-          conf['extensions'].push m
-        end
-      end
-      File.open(File.join(directory, '.solargraph.yml'), 'w') do |file|
-        file.puts conf.to_yaml
-      end
-      STDOUT.puts "Configuration file initialized."
-    end
-
-    desc 'download-core [VERSION]', 'Download core documentation'
-    def download_core version = nil
-      ver = version || Solargraph::YardMap::CoreDocs.best_download
-      puts "Downloading docs for #{ver}..."
-      Solargraph::YardMap::CoreDocs.download ver
-    end
-
-    desc 'list-cores', 'List the local documentation versions'
-    def list_cores
-      puts Solargraph::YardMap::CoreDocs.versions.join("\n")
-    end
-
-    desc 'available-cores', 'List available documentation versions'
-    def available_cores
-      puts Solargraph::YardMap::CoreDocs.available.join("\n")
-    end
-
-    desc 'clear-cores', 'Clear the cached core documentation'
-    def clear_cores
-      Solargraph::YardMap::CoreDocs.clear
-    end
-  end
-end
+require 'thor'
+require 'json'
+require 'fileutils'
+require 'rubygems/package'
+require 'zlib'
+require 'eventmachine'
+
+module Solargraph
+  class Shell < Thor
+    include Solargraph::ServerMethods
+
+    map %w[--version -v] => :version
+
+    desc "--version, -v", "Print the version"
+    def version
+      puts Solargraph::VERSION
+    end
+
+    desc 'server', 'Start a Solargraph server'
+    option :port, type: :numeric, aliases: :p, desc: 'The server port', default: 7657
+    option :views, type: :string, aliases: :v, desc: 'The view template directory', default: nil
+    option :files, type: :string, aliases: :f, desc: 'The public files directory', default: nil
+    def server
+      port = options[:port]
+      port = available_port if port.zero?
+      Solargraph::Server.set :port, port
+      Solargraph::Server.set :views, options[:views] unless options[:views].nil?
+      Solargraph::Server.set :public_folder, options[:files] unless options[:files].nil?
+      my_pid = nil
+      Solargraph::Server.run! do
+        # This line should not be necessary with WEBrick
+        #STDERR.puts "Solargraph server pid=#{Process.pid} port=#{port}"
+        my_pid = Process.pid
+        Signal.trap("INT") do
+          Solargraph::Server.stop!
+        end
+        Signal.trap("TERM") do
+          Solargraph::Server.stop!
+        end
+      end
+    end
+
+    desc 'socket', 'Run a Solargraph socket server'
+    option :host, type: :string, aliases: :h, desc: 'The server host', default: '127.0.0.1'
+    option :port, type: :numeric, aliases: :p, desc: 'The server port', default: 7658
+    def socket
+      port = options[:port]
+      port = available_port if port.zero?
+      EventMachine.run do
+        Signal.trap("INT") do
+          EventMachine.stop
+        end
+        Signal.trap("TERM") do
+          EventMachine.stop
+        end
+        EventMachine.start_server options[:host], port, Solargraph::LanguageServer::Transport::Socket
+        STDERR.puts "Solargraph is listening PORT=#{port} PID=#{Process.pid}"
+      end
+    end
+
+    desc 'suggest', 'Get code suggestions for the provided input'
+    long_desc <<-LONGDESC
+      Analyze a Ruby file and output a list of code suggestions in JSON format.
+    LONGDESC
+    option :line, type: :numeric, aliases: :l, desc: 'Zero-based line number', required: true
+    option :column, type: :numeric, aliases: [:c, :col], desc: 'Zero-based column number', required: true
+    option :filename, type: :string, aliases: :f, desc: 'File name', required: false
+    def suggest(*filenames)
+      STDERR.puts "WARNING: The `solargraph suggest` command is a candidate for deprecation. It will either change drastically or not exist in a future version."
+      # HACK: The ARGV array needs to be manipulated for ARGF.read to work
+      ARGV.clear
+      ARGV.concat filenames
+      text = ARGF.read
+      filename = options[:filename] || filenames[0]
+      begin
+        code_map = CodeMap.new(code: text, filename: filename)
+        offset = code_map.get_offset(options[:line], options[:column])
+        sugg = code_map.suggest_at(offset, filtered: true)
+        result = { "status" => "ok", "suggestions" => sugg }.to_json
+        STDOUT.puts result
+      rescue Exception => e
+        STDERR.puts e
+        STDERR.puts e.backtrace.join("\n")
+        result = { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
+        STDOUT.puts result
+      end
+    end
+
+    desc 'config [DIRECTORY]', 'Create or overwrite a default configuration file'
+    option :extensions, type: :boolean, aliases: :e, desc: 'Add installed extensions', default: true
+    def config(directory = '.')
+      matches = []
+      if options[:extensions]
+        Gem::Specification.each do |g|
+          puts g.name
+          if g.name.match(/^solargraph\-[A-Za-z0-9_\-]*?\-ext/)
+            require g.name
+            matches.push g.name
+          end
+        end
+      end
+      conf = Solargraph::Workspace::Config.new.raw_data
+      unless matches.empty?
+        matches.each do |m|
+          conf['extensions'].push m
+        end
+      end
+      File.open(File.join(directory, '.solargraph.yml'), 'w') do |file|
+        file.puts conf.to_yaml
+      end
+      STDOUT.puts "Configuration file initialized."
+    end
+
+    desc 'download-core [VERSION]', 'Download core documentation'
+    def download_core version = nil
+      ver = version || Solargraph::YardMap::CoreDocs.best_download
+      puts "Downloading docs for #{ver}..."
+      Solargraph::YardMap::CoreDocs.download ver
+    end
+
+    desc 'list-cores', 'List the local documentation versions'
+    def list_cores
+      puts Solargraph::YardMap::CoreDocs.versions.join("\n")
+    end
+
+    desc 'available-cores', 'List available documentation versions'
+    def available_cores
+      puts Solargraph::YardMap::CoreDocs.available.join("\n")
+    end
+
+    desc 'clear-cores', 'Clear the cached core documentation'
+    def clear_cores
+      Solargraph::YardMap::CoreDocs.clear
+    end
+  end
+end