solargraph 0.17.4 → 0.18.0

data/lib/solargraph/live_map.rb

@@ -107,7 +107,7 @@ module Solargraph
     # @return [Array<Solargraph::Plugin::Base>]
     def load_runners
       result = []
-      api_map.config.plugins.each do |name|
+      api_map.workspace.config.plugins.each do |name|
         r = @@plugin_registry[name].new(api_map)
         result.push r
       end

data/lib/solargraph/page.rb

@@ -0,0 +1,61 @@
+require 'ostruct'
+require 'tilt'
+require 'redcarpet'
+require 'htmlentities'
+require 'coderay'
+
+module Solargraph
+  class Page
+    class SolargraphRenderer < Redcarpet::Render::HTML
+      def normal_text text
+        HTMLEntities.new.encode(text, :named)
+      end
+      def block_code code, language
+        CodeRay.scan(code, language || :ruby).div
+      end
+    end
+    private_constant :SolargraphRenderer
+
+    class Binder < OpenStruct
+      def initialize locals, render_method
+        super(locals)
+        define_singleton_method :render do |template, layout: false, locals: {}|
+          render_method.call(template, layout: layout, locals: locals)
+        end
+        define_singleton_method :erb do |template, layout: false, locals: {}|
+          render_method.call(template, layout: layout, locals: locals)
+        end        
+      end
+
+      def htmlify text
+        helper = Solargraph::Pin::Helper.new
+        html = helper.html_markup_rdoc(text)
+        conv = ReverseMarkdown.convert(html, github_flavored: true)
+        markdown = Redcarpet::Markdown.new(SolargraphRenderer.new(prettify: true), fenced_code_blocks: true)
+        markdown.render(conv)
+      end
+
+      def ruby_to_html code
+        code
+      end
+    end
+    private_constant :Binder
+
+    def initialize directory
+      @render_method = proc { |template, layout: false, locals: {}|
+        binder = Binder.new(locals, @render_method)
+        if layout
+          Tilt::ERBTemplate.new(File.join(directory, 'layout.erb')).render(binder) do
+            Tilt::ERBTemplate.new(File.join(directory, "#{template}.erb")).render(binder)
+          end
+        else
+          Tilt::ERBTemplate.new(File.join(directory, "#{template}.erb")).render(binder)
+        end
+      }
+    end
+
+    def render template, layout: true, locals: {}
+      @render_method.call(template, layout: layout, locals: locals)
+    end
+  end
+end

data/lib/solargraph/pin.rb

@@ -1,5 +1,7 @@
 module Solargraph
   module Pin
+    autoload :Helper,           'solargraph/pin/helper'
+    autoload :Conversions,      'solargraph/pin/conversions'
     autoload :Base,             'solargraph/pin/base'
     autoload :Method,           'solargraph/pin/method'
     autoload :Attribute,        'solargraph/pin/attribute'
@@ -12,5 +14,10 @@ module Solargraph
     autoload :Symbol,           'solargraph/pin/symbol'
     autoload :Directed,         'solargraph/pin/directed'
     autoload :Namespace,        'solargraph/pin/namespace'
+    autoload :YardObject,       'solargraph/pin/yard_object'
+    autoload :Keyword,          'solargraph/pin/keyword'
+    autoload :Parameter,        'solargraph/pin/parameter'
+    autoload :MethodParameter,  'solargraph/pin/method_parameter'
+    autoload :BlockParameter,   'solargraph/pin/block_parameter'
   end
 end

data/lib/solargraph/pin/attribute.rb

@@ -1,6 +1,7 @@
 module Solargraph
   module Pin
     class Attribute < Base
+      # @return [Symbol] :reader or :writer
       attr_reader :access
 
       def initialize source, node, namespace, access, docstring
@@ -24,6 +25,14 @@ module Solargraph
         end
         @return_type
       end
+
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::PROPERTY
+      end
+
+      def method?
+        true
+      end
     end
   end
 end

data/lib/solargraph/pin/base.rb

@@ -1,7 +1,11 @@
+require 'reverse_markdown'
+
 module Solargraph
   module Pin
     class Base
-      # @return [Solargraph::ApiMap::Source]
+      include Conversions
+
+      # @return [Solargraph::Source]
       attr_reader :source
 
       # @return [Parser::AST::Node]
@@ -16,9 +20,23 @@ module Solargraph
         @namespace = namespace
       end
 
+      def contain?(index)
+        if index >= node.loc.expression.begin_pos
+          if node.respond_to?(:end)
+            if index < node.end.end_pos
+              return true
+            end
+          elsif index < node.loc.expression.end_pos
+            return true
+          end
+        end
+        false
+      end
+
       # @return [YARD::Docstring]
       def docstring
-        @docstring ||= source.docstring_for(node)
+        @docstring ||= source.docstring_for(node) unless source.nil?
+        @docstring
       end
 
       # @return [String]
@@ -31,9 +49,17 @@ module Solargraph
         nil
       end
 
-      # @return [String]
+      # @return [Integer]
+      def completion_item_kind
+      end
+
+      # @return [Integer]
+      def symbol_kind
+      end
+
+      # @return [Integer]
       def kind
-        nil
+        completion_item_kind
       end
 
       # @return [String]
@@ -56,13 +82,57 @@ module Solargraph
         []
       end
 
+      def arguments
+        parameters
+      end
+
       # @return [String]
       def filename
-        source.filename
+        source.filename unless source.nil?
       end
 
       def location
-        "#{source.filename}:#{node.location.expression.line - 1}:#{node.location.expression.column}"
+        "#{source.filename}:#{node.location.expression.line - 1}:#{node.location.expression.column}" unless source.nil? or node.nil?
+      end
+
+      # @return [String]
+      def documentation
+        if @documentation.nil? and !docstring.nil?
+          @documentation = ReverseMarkdown.convert(helper.html_markup_rdoc(docstring), github_flavored: true)
+        end
+        @documentation
+      end
+
+      # True if the suggestion has documentation.
+      # Useful for determining whether a client should resolve a suggestion's
+      # path to retrieve more information about it.
+      #
+      # @return [Boolean]
+      def has_doc?
+        !docstring.nil? and !docstring.all.empty?
+      end
+
+      def helper
+        @helper ||= Solargraph::Pin::Helper.new
+      end
+
+      def to_s
+        name.to_s
+      end
+
+      def resolve api_map
+      end
+
+      def identifier
+        @identifier ||= "#{path || location}"
+      end
+
+      def variable?
+        false
+      end
+
+      def method?
+        false
       end
     end
   end

data/lib/solargraph/pin/base_variable.rb

@@ -3,20 +3,30 @@ module Solargraph
     class BaseVariable < Base
       include NodeMethods
 
+      def initialize source, node, namespace
+        super
+        @tried_to_detect_return_type = false
+      end
+
       def name
         node.children[0].to_s
       end
 
-      def kind
-        Solargraph::Suggestion::VARIABLE
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::VARIABLE
       end
 
       def return_type
-        if @return_type.nil? and !docstring.nil?
-          tag = docstring.tag(:type)
-          @return_type = tag.types[0] unless tag.nil?
+        if @return_type.nil? and !@tried_to_detect_return_type
+          @tried_to_detect_return_type = true
+          if docstring.nil?
+            @return_type ||= literal_from_assignment
+          else
+            tag = docstring.tag(:type)
+            @return_type = tag.types[0] unless tag.nil?
+          end
         end
-        @return_type ||= literal_from_assignment
+        @return_type
       end
 
       def assignment_node
@@ -28,7 +38,19 @@ module Solargraph
       end
 
       def signature
-        @signature ||= resolve_node_signature(node.children[(node.type == :casgn ? 2 : 1)])
+        @signature ||= resolve_node_signature(assignment_node)
+      end
+
+      # @param api_map [Solargraph::ApiMap]
+      def resolve api_map
+        if return_type.nil?
+          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)
+        end
+      end
+
+      def variable?
+        true
       end
 
       private

data/lib/solargraph/pin/block_parameter.rb

@@ -0,0 +1,53 @@
+module Solargraph
+  module Pin
+    class BlockParameter < LocalVariable
+      attr_reader :index
+
+      def initialize source, node, namespace, ancestors, index
+        super(source, node, namespace, ancestors)
+        @index = index
+        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
+
+      # @param api_map [Solargraph::ApiMap]
+      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
+        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
+          return nil if bmeth.nil?
+          subtypes = get_subtypes(bmeth.return_type)
+          @return_type = api_map.find_fully_qualified_namespace(subtypes[0], namespace)
+        else
+          unless meth.docstring.nil?
+            yps = meth.docstring.tags(:yieldparam)
+            unless yps[index].nil? or yps[index].types.nil? or yps[index].types.empty?
+              @return_type = yps[index].types[0]
+            end
+          end
+        end
+      end
+
+      private
+
+      def get_subtypes type
+        return nil if type.nil?
+        match = type.match(/<([a-z0-9_:, ]*)>/i)
+        return [] if match.nil?
+        match[1].split(',').map(&:strip)
+      end        
+    end
+  end
+end

data/lib/solargraph/pin/constant.rb

@@ -12,13 +12,17 @@ module Solargraph
         @name ||= node.children[1].to_s
       end
 
-      def kind
-        Solargraph::Suggestion::CONSTANT
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::CONSTANT
       end
 
       def value
         source.code_for(node.children[2])
       end
+
+      def path
+        "#{namespace}::#{name}"
+      end
     end
   end
 end

data/lib/solargraph/pin/conversions.rb

@@ -0,0 +1,65 @@
+module Solargraph
+  module Pin
+    module Conversions
+      # @return [Hash]
+      def completion_item
+        {
+          label: name,
+          kind: kind,
+          detail: completion_item_detail,
+          data: {
+            path: path,
+            return_type: return_type,
+            location: location
+          }
+        }
+      end
+
+      # @return [Hash]
+      def resolve_completion_item
+        extra = {}
+        alldoc = ''
+        alldoc += link_documentation(path) unless path.nil?
+        alldoc += "\n\n" unless alldoc.empty?
+        alldoc += documentation unless documentation.nil?
+        extra[:documentation] = alldoc unless alldoc.empty?
+        completion_item.merge(extra)
+      end
+
+      # @param api_map [Solargraph::ApiMap]
+      def hover
+        info = ''
+        if self.kind_of?(Solargraph::Pin::BaseVariable)
+          info.concat link_documentation(return_type) unless return_type.nil?
+        else
+          info.concat link_documentation(path) unless path.nil?
+        end
+        info.concat "\n\n#{documentation}"
+        info
+      end
+
+      # @return [Hash]
+      def signature_help
+        {
+          label: name + '(' + arguments.join(', ') + ')',
+          documentation: documentation
+        }
+      end
+
+      private
+
+      def completion_item_detail
+        detail = ''
+        detail += "(#{parameters.join(', ')}) " unless parameters.empty?
+        detail += "=> #{return_type}" unless return_type.nil?
+        return nil if detail.empty?
+        detail
+      end
+
+      def link_documentation path
+        uri = "solargraph:/document?query=" + URI.encode(path)
+        "[#{path}](#{uri})"
+      end  
+    end
+  end
+end

data/lib/solargraph/pin/directed/attribute.rb

@@ -10,6 +10,10 @@ module Solargraph
         def name
           @name
         end
+
+        def completion_item_kind
+          Solargraph::LanguageServer::CompletionItemKinds::METHOD
+        end
       end
     end
   end

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

@@ -2,15 +2,20 @@ module Solargraph
   module Pin
     module Directed
       class Method < Solargraph::Pin::Method
-        def initialize source, node, namespace, scope, visibility, docstring, name
+        def initialize source, node, namespace, scope, visibility, docstring, name, return_type = nil
           super(source, node, namespace, scope, visibility)
           @docstring = docstring
           @name = name
+          @return_type = return_type
         end
 
         def name
           @name
         end
+
+        def completion_item_kind
+          Solargraph::LanguageServer::CompletionItemKinds::METHOD
+        end
       end
     end
   end