solargraph 0.17.4 → 0.18.0

data/lib/solargraph/pin/helper.rb

@@ -0,0 +1,35 @@
+require 'yard'
+require 'yard/templates/helpers/markup_helper'
+require 'yard/templates/helpers/html_helper'
+
+module Solargraph
+  module Pin
+    class Helper
+      include YARD::Templates::Helpers::HtmlHelper
+
+      attr_accessor :object
+      attr_accessor :serializer
+
+      def initialize object = nil
+        @object = object
+      end
+
+      def url_for(object)
+        '.'
+      end
+
+      def options
+        if @options.nil?
+          @options = YARD::Templates::TemplateOptions.new
+          @options.type = :rdoc
+        end
+        @options
+      end
+
+      # HACK: The linkify method just returns the arguments as plain text
+      def linkify *args
+        args.join(', ')
+      end
+    end
+  end
+end

data/lib/solargraph/pin/keyword.rb

@@ -0,0 +1,22 @@
+module Solargraph
+  module Pin
+    class Keyword < Base
+      def initialize name
+        @name = name
+      end
+
+      def name
+        @name
+      end
+
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::KEYWORD
+      end
+
+      def identifier
+        # HACK: A cheap way to make keyword identifiers unique
+        object_id
+      end
+    end
+  end
+end

data/lib/solargraph/pin/local_variable.rb

@@ -7,7 +7,6 @@ module Solargraph
         ancestors.each do |parent|
           if [:block, :def, :defs, :class, :module, :source].include? parent.type
             @tree.push parent
-            break unless parent.type == :block
           end
         end
       end

data/lib/solargraph/pin/method.rb

@@ -8,6 +8,11 @@ module Solargraph
         super(source, node, namespace)
         @scope = scope
         @visibility = visibility
+        # Exception for initialize methods
+        if name == 'initialize' and scope == :instance
+          @visibility = :private
+        end
+        @fully_resolved = false
       end
 
       def name
@@ -18,13 +23,17 @@ module Solargraph
         @path ||= namespace + (scope == :instance ? '#' : '.') + name
       end
 
-      def kind
-        Solargraph::Suggestion::METHOD
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::METHOD
       end
 
       def return_type
         if @return_type.nil? and !docstring.nil?
           tag = docstring.tag(:return)
+          if tag.nil?
+            ol = docstring.tag(:overload)
+            tag = ol.tag(:return) unless ol.nil?
+          end
           @return_type = tag.types[0] unless tag.nil? or tag.types.nil?
         end
         @return_type
@@ -34,10 +43,52 @@ module Solargraph
         @parameters ||= get_method_args
       end
 
+      # @todo This method was temporarily migrated directly from Suggestion
+      # @return [Array<String>]
+      def params
+        if @params.nil?
+          @params = []
+          return @params if docstring.nil?
+          param_tags = docstring.tags(:param)
+          unless param_tags.empty?
+            param_tags.each do |t|
+              txt = t.name.to_s
+              txt += " [#{t.types.join(',')}]" unless t.types.nil? or t.types.empty?
+              txt += " #{t.text}" unless t.text.nil? or t.text.empty?
+              @params.push txt
+            end
+          end
+        end
+        @params
+      end
+
+      def resolve api_map
+        if return_type.nil?
+          sc = api_map.superclass_of(namespace)
+          until sc.nil?
+            sc_path = "#{sc}#{scope == :instance ? '#' : '.'}#{name}"
+            sugg = api_map.get_path_suggestions(sc_path).first
+            break if sugg.nil?
+            @return_type = api_map.find_fully_qualified_namespace(sugg.return_type, sugg.namespace) unless sugg.return_type.nil?
+            break unless @return_type.nil?
+            sc = api_map.superclass_of(sc)
+          end
+        end
+        unless return_type.nil? or @fully_resolved
+          @fully_resolved = true
+          @return_type = api_map.find_fully_qualified_namespace(@return_type, namespace)
+        end
+      end
+
+      def method?
+        true
+      end
+
       private
 
       # @return [Array<String>]
       def get_method_args
+        return [] if node.nil?
         list = nil
         args = []
         node.children.each { |c|
@@ -58,6 +109,8 @@ module Solargraph
             args.push "#{c.children[0]}:"
           elsif c.type == :kwoptarg
             args.push "#{c.children[0]}: #{source.code_for(c.children[1])}"
+          elsif c.type == :blockarg
+            args.push "&#{c.children[0]}"
           end
         }
         args

data/lib/solargraph/pin/method_parameter.rb

@@ -0,0 +1,19 @@
+module Solargraph
+  module Pin
+    class MethodParameter < LocalVariable
+      def initialize source, node, namespace, ancestors
+        super
+        # Look for the return type in the method's @param tags
+        docstring = source.docstring_for(ancestors.first)
+        unless docstring.nil?
+          tags = docstring.tags(:param)
+          tags.each do |tag|
+            if tag.name == name and !tag.types.nil? and !tag.types.empty?
+              @return_type = tag.types[0]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/pin/namespace.rb

@@ -18,8 +18,13 @@ module Solargraph
         @path ||= (namespace.empty? ? '' : "#{namespace}::") + name
       end
 
-      def kind
-        @kind ||= (node.type == :class ? Solargraph::Suggestion::CLASS : Solargraph::Suggestion::MODULE)
+      def completion_item_kind
+        @kind ||= (node.type == :class ? Solargraph::LanguageServer::CompletionItemKinds::CLASS : Solargraph::LanguageServer::CompletionItemKinds::MODULE)
+      end
+
+      # @return [Symbol] :class or :module
+      def type
+        node.type
       end
 
       def return_type

data/lib/solargraph/pin/parameter.rb

@@ -0,0 +1,23 @@
+module Solargraph
+  module Pin
+    class Parameter < Base
+      def initialize source, node, namespace, name, return_type
+        super(source, node, namespace)
+        @name = name
+        @return_type = return_type
+      end
+
+      def name
+        @name
+      end
+
+      def return_type
+        @return_type
+      end
+
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::PROPERTY
+      end
+    end
+  end
+end

data/lib/solargraph/pin/plugin/method.rb

@@ -16,8 +16,9 @@ module Solargraph
           @parameters = parameters
         end
 
-        def kind
-          Solargraph::Suggestion::METHOD
+        def completion_item_kind
+          # Solargraph::Suggestion::METHOD
+          Solargraph::LanguageServer::CompletionItemKinds::METHOD
         end
       end
     end

data/lib/solargraph/pin/yard_object.rb

@@ -0,0 +1,101 @@
+module Solargraph
+  module Pin
+    class YardObject < Base
+      COMPLETION_ITEM_KIND_MAP = {
+        YARD::CodeObjects::ClassObject => Solargraph::LanguageServer::CompletionItemKinds::CLASS,
+        YARD::CodeObjects::ModuleObject => Solargraph::LanguageServer::CompletionItemKinds::MODULE,
+        YARD::CodeObjects::MethodObject => Solargraph::LanguageServer::CompletionItemKinds::METHOD,
+        YARD::CodeObjects::ConstantObject => Solargraph::LanguageServer::CompletionItemKinds::CONSTANT
+      }
+
+      # @return [YARD::CodeObjects::Base]
+      attr_reader :code_object
+
+      def initialize code_object, location
+        # (c.to_s.split('::').last, detail: c.to_s, kind: kind, docstring: c.docstring, return_type: return_type, location: object_location(c))
+        @code_object = code_object
+        @location = location
+      end
+
+      def name
+        # @name ||= code_object.to_s.split('::').last
+        @name ||= code_object.name.to_s
+      end
+
+      def completion_item_kind
+        @completion_item_kind ||= COMPLETION_ITEM_KIND_MAP[code_object.class] || Solargraph::LanguageServer::CompletionItemKinds::KEYWORD
+      end
+
+      def docstring
+        code_object.docstring
+      end
+
+      def return_type
+        # @todo Get the return type
+        if @return_type.nil?
+          if code_object.kind_of?(YARD::CodeObjects::ClassObject)
+            @return_type ||= "Class<#{path}>"
+            return @return_type
+          end
+          if code_object.kind_of?(YARD::CodeObjects::ModuleObject)
+            @return_type ||= "Module<#{path}>"
+            return @return_type
+          end        
+          if Solargraph::CoreFills::CUSTOM_RETURN_TYPES.has_key?(path)
+            @return_type = Solargraph::CoreFills::CUSTOM_RETURN_TYPES[path]
+          else
+            return nil if docstring.nil?
+            tags = docstring.tags(:return)
+            if tags.empty?
+              overload = docstring.tag(:overload)
+              return nil if overload.nil?
+              tags = overload.tags(:return)
+            end
+            return nil if tags.empty?
+            return nil if tags[0].types.nil?
+            @return_type = tags[0].types[0]
+          end
+        end
+        @return_type
+      end
+
+      def location
+        # @todo Get the location
+        @location
+      end
+
+      def path
+        code_object.path
+      end
+      
+      def namespace
+        # @todo Is this right?
+        code_object.namespace.to_s
+      end
+
+      def parameters
+        @parameters ||= get_method_args
+      end
+
+      def method?
+        completion_item_kind == Solargraph::LanguageServer::CompletionItemKinds::METHOD
+      end
+
+      private
+
+      def get_method_args
+        return [] unless code_object.kind_of?(YARD::CodeObjects::MethodObject)
+        args = []
+        code_object.parameters.each { |a|
+          p = a[0]
+          unless a[1].nil?
+            p += ' =' unless p.end_with?(':')
+            p += " #{a[1]}"
+          end
+          args.push p
+        }
+        args
+      end  
+    end
+  end
+end

data/lib/solargraph/server.rb

@@ -1,6 +1,8 @@
 require 'sinatra/base'
 require 'thread'
 require 'yard'
+require 'open3'
+require 'shellwords'
 
 module Solargraph
   class Server < Sinatra::Base
@@ -8,9 +10,11 @@ module Solargraph
     set :port, 7657
     set :server, :webrick
 
-    @@api_hash = {}
+    # @@api_hash = {}
     @@semaphore = Mutex.new
 
+    @@library = Solargraph::Library.new
+
     after do
       GC.start
     end
@@ -20,10 +24,57 @@ module Solargraph
       @@semaphore.unlock
     end
 
+    post '/diagnostics' do
+      content_type :json
+      severities = {
+        'refactor' => 4,
+        'convention' => 3,
+        'warning' => 2,
+        'error' => 1,
+        'fatal' => 1
+      }
+      begin
+        filename = params['filename']
+        text = params['text']
+        o, e, s = Open3.capture3("bundle exec rubocop -f j -s #{Shellwords.escape(filename)}", stdin_data: text)
+        STDERR.puts e unless e.nil? or e.empty?
+        resp = JSON.parse(o)
+        diagnostics = []
+        if resp['summary']['offense_count'] > 0
+          resp['files'].each do |file|
+            file['offenses'].each do |off|
+              diag = {
+                range: {
+                  start: {
+                    line: off['location']['start_line'] - 1,
+                    character: off['location']['start_column'] - 1
+                  },
+                  end: {
+                    line: off['location']['last_line'] - 1,
+                    character: off['location']['last_column']
+                  }
+                },
+                # 1 = Error, 2 = Warning, 3 = Information, 4 = Hint
+                severity: severities[off['severity']],
+                source: off['cop_name'],
+                message: off['message'].gsub(/^#{off['cop_name']}\:/, '')
+              }
+              diagnostics.push diag
+            end
+          end
+        end
+        { "status" => "ok", "data" => diagnostics }.to_json
+      rescue Exception => e
+        send_exception e
+      end
+    end
+
     post '/prepare' do
       content_type :json
       begin
-        Server.prepare_workspace params['workspace']
+        workspace = params['workspace'].to_s.gsub(/\\/, '/')
+        STDERR.puts "Preparing #{workspace}"
+        @@library = Solargraph::Library.load(workspace) unless workspace.empty?
         { "status" => "ok"}.to_json
       rescue Exception => e
         send_exception e
@@ -33,12 +84,8 @@ module Solargraph
     post '/update' do
       content_type :json
       begin
-        workspace = find_local_workspace(params['filename'], params['workspace'])
-        # @type [Solargraph::ApiMap]
-        api_map = get_api_map(workspace)
-        unless api_map.nil?
-          api_map.update params['filename']
-        end
+        filename = params['filename'].to_s.gsub(/\\/, '/')
+        @@library.open filename, File.read(filename), 0
         { "status" => "ok"}.to_json
       rescue Exception => e
         send_exception e
@@ -48,14 +95,13 @@ module Solargraph
     post '/suggest' do
       content_type :json
       begin
-        sugg = []
-        workspace = find_local_workspace(params['filename'], params['workspace'])
-        api_map = get_api_map(workspace)
+        filename = params['filename'].to_s.gsub(/\\/, '/')
+        @@library.open filename, params['text'], 0
+        @@library.checkout filename
+        @@library.refresh
         with_all = params['all'] == '1' ? true : false
-        code_map = CodeMap.new(code: params['text'], filename: params['filename'], api_map: api_map, cursor: [params['line'].to_i, params['column'].to_i])
-        offset = code_map.get_offset(params['line'].to_i, params['column'].to_i)
-        sugg = code_map.suggest_at(offset, filtered: true)
-        JSON.generate({ "status" => "ok", "suggestions" => sugg.map{|s| s.as_json(all: with_all)} })
+        completion = @@library.completions_at(filename, params['line'].to_i, params['column'].to_i)
+        JSON.generate({ "status" => "ok", "suggestions" => completion.pins.map{|s| Suggestion.pull(s).as_json(all: with_all)} })
       rescue Exception => e
         send_exception e
       end
@@ -64,13 +110,12 @@ module Solargraph
     post '/signify' do
       content_type :json
       begin
-        sugg = []
-        workspace = find_local_workspace(params['filename'], params['workspace'])
-        api_map = get_api_map(workspace)
-        code_map = CodeMap.new(code: params['text'], filename: params['filename'], api_map: api_map, cursor: [params['line'].to_i, params['column'].to_i])
-        offset = code_map.get_offset(params['line'].to_i, params['column'].to_i)
-        sugg = code_map.signatures_at(offset)
-        { "status" => "ok", "suggestions" => sugg.map{|s| s.as_json(all: true)} }.to_json
+        filename = params['filename'].to_s.gsub(/\\/, '/')
+        @@library.open filename, params['text'], 0
+        @@library.checkout filename
+        @@library.refresh
+        sugg = @@library.signatures_at(filename, params['line'].to_i, params['column'].to_i)
+        { "status" => "ok", "suggestions" => sugg.map{|s| Suggestion.pull(s).as_json(all: true)} }.to_json
       rescue Exception => e
         send_exception e
       end
@@ -79,14 +124,8 @@ module Solargraph
     post '/resolve' do
       content_type :json
       begin
-        workspace = find_local_workspace(params['filename'], params['workspace'])
-        result = []
-        api_map = get_api_map(workspace)
-        unless api_map.nil?
-          # @todo Get suggestions that match the path
-          result.concat api_map.get_path_suggestions(params['path'])
-        end
-        { "status" => "ok", "suggestions" => result.map{|s| s.as_json(all: true)} }.to_json
+        result = @@library.get_path_pins(params['path'])
+        { "status" => "ok", "suggestions" => result.map{|s| Suggestion.pull(s).as_json(all: true)} }.to_json
       rescue Exception => e
         send_exception e
       end
@@ -95,13 +134,11 @@ module Solargraph
     post '/define' do
       content_type :json
       begin
-        sugg = []
-        workspace = find_local_workspace(params['filename'], params['workspace'])
-        api_map = get_api_map(workspace)
-        code_map = CodeMap.new(code: params['text'], filename: params['filename'], api_map: api_map, cursor: [params['line'].to_i, params['column'].to_i])
-        offset = code_map.get_offset(params['line'].to_i, params['column'].to_i)
-        sugg = code_map.define_symbol_at(offset)
-        { "status" => "ok", "suggestions" => sugg }.to_json
+        filename = params['filename'].to_s.gsub(/\\/, '/')
+        @@library.open filename, params['text'], 0
+        @@library.checkout filename
+        sugg = @@library.definitions_at(filename, params['line'].to_i, params['column'].to_i)
+        { "status" => "ok", "suggestions" => sugg.map{|s| Suggestion.pull(s).as_json(all: true)} }.to_json
       rescue Exception => e
         send_exception e
       end
@@ -111,48 +148,27 @@ module Solargraph
     post '/hover' do
       content_type :json
       begin
-        sugg = []
-        workspace = find_local_workspace(params['filename'], params['workspace'])
-        api_map = get_api_map(workspace)
-        code_map = CodeMap.new(code: params['text'], filename: params['filename'], api_map: @@api_hash[workspace], cursor: [params['line'].to_i, params['column'].to_i])
-        offset = code_map.get_offset(params['line'].to_i, params['column'].to_i)
-        sugg = code_map.resolve_object_at(offset)
-        { "status" => "ok", "suggestions" => sugg }.to_json
+        filename = params['filename'].to_s.gsub(/\\/, '/')
+        @@library.open filename, params['text'], 0
+        @@library.refresh
+        @@library.checkout filename
+        sugg = @@library.definitions_at(filename, params['line'].to_i, params['column'].to_i)
+        { "status" => "ok", "suggestions" => sugg.map{|s| Suggestion.pull(s).as_json(all: true)} }.to_json
       rescue Exception => e
         send_exception e
       end
     end
 
     get '/search' do
-      workspace = params['workspace']
-      api_map = get_api_map(workspace) || Solargraph::ApiMap.new
-      @results = api_map.search(params['query'])
+      @results = @@library.search(params['query'])
       erb :search
     end
 
     get '/document' do
-      workspace = params['workspace']
-      workspace.gsub!(/\\/, '/') unless workspace.nil?
-      api_map = get_api_map(workspace) || Solargraph::ApiMap.new
-      @objects = api_map.document(params['query'])
+      @objects = @@library.document(params['query'])
       erb :document
     end
 
-    # @return [Solargraph::ApiMap]
-    def self.get_api_map workspace
-      api_map = nil
-      @@semaphore.synchronize {
-        @@api_hash[nil] ||= Solargraph::ApiMap.new if workspace.nil?
-        api_map = @@api_hash[workspace]
-      }
-      api_map
-    end
-
-    # @return [Solargraph::ApiMap]
-    def get_api_map workspace
-      Server.get_api_map workspace
-    end
-
     def htmlify text
       rdoc_to_html text
     end
@@ -173,75 +189,6 @@ module Solargraph
       { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
     end
 
-    def find_local_workspace file, workspace
-      return nil if workspace.nil? or workspace.empty?
-      workspace.gsub!(/\\/, '/') unless workspace.nil?
-      unless file.nil? or workspace.nil?
-        file.gsub!(/\\/, '/') unless file.nil?
-        return nil unless file.start_with?(workspace)
-        dir = File.dirname(file)
-        while dir.start_with?(workspace)
-          return dir if @@api_hash.has_key?(dir)
-          dir = File.dirname(dir)
-        end
-      end
-      workspace
-    end
-
-    class << self
-      def prepare_workspace directory
-        return if directory.nil?
-        #Thread.new do
-          directory.gsub!(/\\/, '/')
-          STDERR.puts "Preparing #{directory}"
-          configs = Dir[File.join(directory, '**', '.solargraph.yml')]
-          resolved = []
-          configs.each do |cf|
-            dir = File.dirname(cf)
-            generate_api_map dir
-            resolved.push dir
-          end
-          generate_api_map directory unless resolved.include?(directory)
-        #end
-      end
-
-      def generate_api_map(directory)
-        api_map = Solargraph::ApiMap.new(directory)
-        @@semaphore.synchronize do
-          @@api_hash[directory] = api_map
-        end
-      end
-
-      def run!
-        # @todo The thread for checking workspaces is temporarily disabled due
-        #   to high CPU cost. We need to determine whether the process should
-        #   be optimized or eliminated altogether.
-        #
-        # Thread.new do
-        #   while true
-        #     check_workspaces
-        #     sleep 1
-        #   end
-        # end
-        super
-      end
-
-      def check_workspaces
-        @@semaphore.synchronize do
-          changed = {}
-          @@api_hash.each_pair do |w, a|
-            next unless a.changed?
-            STDERR.puts "Reloading changed workspace #{w}"
-            n = Solargraph::ApiMap.new(w)
-            changed[w] = n
-          end
-          changed.each_pair do |w, a|
-            @@api_hash[w] = a
-          end
-        end
-      end
-    end
-
     class Helpers
       include YARD::Templates::Helpers::HtmlHelper