solargraph 0.18.3 → 0.19.0

data/lib/solargraph/pin/block_parameter.rb

@@ -1,56 +1,42 @@
 module Solargraph
   module Pin
-    class BlockParameter < LocalVariable
+    class BlockParameter < Base
+      include Localized
+
       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
+      attr_reader :block
+
+      def initialize location, namespace, name, docstring, block
+        super(location, namespace, name, docstring)
+        @block = block
+        @presence = block.location.range
       end
 
-      # @param api_map [Solargraph::ApiMap]
-      def resolve api_map
-        return unless return_type.nil?
-        signature = resolve_node_signature(@tree[0].children[0])
-        # @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?
-          # @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)
-        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
+      def kind
+        Pin::BLOCK_PARAMETER
       end
 
-      private
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::VARIABLE
+      end
+
+      def index
+        block.parameters.index(self)
+      end
 
-      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        
+      def return_type
+        if @return_type.nil? and !block.docstring.nil?
+          found = nil
+          params = block.docstring.tags(:param)
+          params.each do |p|
+            next unless p.name == name
+            found = p
+          end
+          @return_type = found.types[0] unless found.nil? or found.types.nil?
+        end
+        @return_type
+      end
     end
   end
 end

data/lib/solargraph/pin/class_variable.rb

@@ -1,6 +1,9 @@
 module Solargraph
   module Pin
     class ClassVariable < BaseVariable
+      def kind
+        Pin::CLASS_VARIABLE
+      end
     end
   end
 end

data/lib/solargraph/pin/constant.rb

@@ -3,23 +3,19 @@ module Solargraph
     class Constant < BaseVariable
       attr_reader :visibility
 
-      def initialize source, node, namespace, visibility
-        super(source, node, namespace)
+      def initialize location, namespace, name, docstring, signature, literal, context, visibility
+        super(location, namespace, name, docstring, signature, literal, context)
         @visibility = visibility
       end
 
-      def name
-        @name ||= node.children[1].to_s
+      def kind
+        Pin::CONSTANT
       end
 
       def completion_item_kind
         Solargraph::LanguageServer::CompletionItemKinds::CONSTANT
       end
 
-      def value
-        source.code_for(node.children[2])
-      end
-
       def path
         "#{namespace}::#{name}"
       end

data/lib/solargraph/pin/conversions.rb

@@ -1,11 +1,12 @@
 module Solargraph
   module Pin
+    # @todo Move this stuff. It should be the responsibility of the language server.
     module Conversions
       # @return [Hash]
       def completion_item
         {
           label: name,
-          kind: kind,
+          kind: completion_item_kind,
           detail: completion_item_detail,
           data: {
             path: path,
@@ -42,7 +43,7 @@ module Solargraph
       # @return [Hash]
       def signature_help
         {
-          label: name + '(' + arguments.join(', ') + ')',
+          label: name + '(' + parameters.join(', ') + ')',
           documentation: documentation
         }
       end
@@ -51,7 +52,7 @@ module Solargraph
 
       def completion_item_detail
         detail = ''
-        detail += "(#{parameters.join(', ')}) " unless parameters.empty?
+        detail += "(#{parameters.join(', ')}) " unless kind != Pin::METHOD or parameters.empty?
         detail += "=> #{return_type}" unless return_type.nil?
         return nil if detail.empty?
         detail

data/lib/solargraph/pin/documenting.rb

@@ -0,0 +1,27 @@
+module Solargraph
+  module Pin
+    module Documenting
+      # @return [String]
+      def documentation
+        if @documentation.nil? and !docstring.nil?
+          @documentation = ReverseMarkdown.convert(helper.html_markup_rdoc(docstring), github_flavored: true)
+          @documentation.strip!
+        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
+    end
+  end
+end

data/lib/solargraph/pin/global_variable.rb

@@ -1,6 +1,9 @@
 module Solargraph
   module Pin
     class GlobalVariable < BaseVariable
+      def kind
+        Pin::GLOBAL_VARIABLE
+      end
     end
   end
 end

data/lib/solargraph/pin/instance_variable.rb

@@ -1,11 +1,12 @@
 module Solargraph
   module Pin
     class InstanceVariable < BaseVariable
-      attr_reader :scope
+      def kind
+        Pin::INSTANCE_VARIABLE
+      end
 
-      def initialize source, node, namespace, scope
-        super(source, node, namespace)
-        @scope = scope
+      def scope
+        @scope ||= (context.kind == Pin::NAMESPACE ? :class : context.scope)
       end
     end
   end

data/lib/solargraph/pin/local_variable.rb

@@ -1,23 +1,16 @@
 module Solargraph
   module Pin
     class LocalVariable < BaseVariable
-      def initialize source, node, namespace, ancestors
-        super(source, node, namespace)
-        @tree = []
-        ancestors.each do |parent|
-          if [:block, :def, :defs, :class, :module, :source].include? parent.type
-            @tree.push parent
-          end
-        end
+      include Localized
+
+      def initialize location, namespace, name, docstring, assignment, literal, context, block, presence
+        super(location, namespace, name, docstring, assignment, literal, context)
+        @block = block
+        @presence = presence
       end
 
-      def visible_from? n
-        parents = [n] + (source.tree_for(n) || [])
-        parents.each do |p|
-          return true if @tree[0] == p
-          return false if [:def, :defs, :class, :module].include?(p.type)
-        end
-        false
+      def kind
+        Pin::LOCAL_VARIABLE
       end
     end
   end

data/lib/solargraph/pin/localized.rb

@@ -0,0 +1,12 @@
+module Solargraph
+  module Pin
+    module Localized
+      attr_reader :block
+      attr_reader :presence
+
+      def visible_from?(block, position)
+        self.block == block and presence.contain?(position)
+      end
+    end
+  end
+end

data/lib/solargraph/pin/method.rb

@@ -3,20 +3,17 @@ module Solargraph
     class Method < Base
       attr_reader :scope
       attr_reader :visibility
+      attr_reader :parameters
 
-      def initialize source, node, namespace, scope, visibility
-        super(source, node, namespace)
+      def initialize location, namespace, name, docstring, scope, visibility, args
+        super(location, namespace, name, docstring)
         @scope = scope
         @visibility = visibility
-        # Exception for initialize methods
-        if name == 'initialize' and scope == :instance
-          @visibility = :private
-        end
-        @fully_resolved = false
+        @parameters = args
       end
 
-      def name
-        @name ||= "#{node.children[(node.type == :def ? 0 : 1)]}"
+      def kind
+        Solargraph::Pin::METHOD
       end
 
       def path
@@ -39,10 +36,6 @@ module Solargraph
         @return_type
       end
 
-      def parameters
-        @parameters ||= get_method_args
-      end
-
       def documentation
         if @documentation.nil?
           @documentation ||= super || ''
@@ -83,60 +76,6 @@ module Solargraph
         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|
-          if c.kind_of?(AST::Node) and c.type == :args
-            list = c
-            break
-          end
-        }
-        return args if list.nil?
-        list.children.each { |c|
-          if c.type == :arg
-            args.push c.children[0].to_s
-          elsif c.type == :restarg
-            args.push "*#{c.children[0]}"
-          elsif c.type == :optarg
-            args.push "#{c.children[0]} = #{source.code_for(c.children[1])}"
-          elsif c.type == :kwarg
-            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
-      end
     end
   end
 end

data/lib/solargraph/pin/method_parameter.rb

@@ -1,18 +1,31 @@
 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
+    class MethodParameter < Base
+      include Localized
+
+      attr_reader :block
+
+      def initialize location, namespace, name, docstring, block
+        super(location, namespace, name, docstring)
+        @block = block
+        @presence = block.location.range
+      end
+
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::VARIABLE
+      end
+
+      def return_type
+        if @return_type.nil? and !block.docstring.nil?
+          found = nil
+          params = block.docstring.tags(:param)
+          params.each do |p|
+            next unless p.name == name
+            found = p
           end
+          @return_type = found.types[0] unless found.nil? or found.types.nil?
         end
+        @return_type
       end
     end
   end

data/lib/solargraph/pin/namespace.rb

@@ -5,60 +5,51 @@ module Solargraph
 
       attr_reader :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
+      attr_reader :type
 
-      def reference_superclass name
-        @superclass_reference = Reference.new(self, name)
-      end
-
-      def name
-        @name ||= (node.type == :source ? '' : pack_name(node.children[0]).last.to_s)
-      end
-
-      def path
-        @path ||= (namespace.empty? ? '' : "#{namespace}::") + name
-      end
+      # @return [Pin::Reference]
+      attr_reader :superclass_reference
 
-      def completion_item_kind
-        @kind ||= (node.type == :class ? Solargraph::LanguageServer::CompletionItemKinds::CLASS : Solargraph::LanguageServer::CompletionItemKinds::MODULE)
+      def initialize location, namespace, name, docstring, type, visibility, superclass
+        super(location, namespace, name, docstring)
+        @type = type
+        @visibility = visibility
+        # @superclass_reference = Reference.new(self, superclass) unless superclass.nil?
+        @superclass_reference = Pin::Reference.new(location, namespace, superclass) unless superclass.nil?
       end
 
+      # @return [Array<Pin::Reference>]
       def include_references
         @include_references ||= []
       end
 
+      # @return [Array<String>]
       def extend_references
         @extend_references ||= []
       end
 
-      def superclass_reference
-        @superclass_reference
+      def kind
+        Pin::NAMESPACE
+      end
+
+      def named_context
+        path
       end
 
-      # @return [Symbol] :class or :module
-      def type
-        node.type
+      def scope
+        :class
       end
 
-      def location
-        return "#{source.filename}:0" if name.empty?
-        super
+      def completion_item_kind
+        (type == :class ? LanguageServer::CompletionItemKinds::CLASS : LanguageServer::CompletionItemKinds::MODULE)
+      end
+
+      def path
+        @path ||= (namespace.empty? ? '' : "#{namespace}::") + name
       end
 
       def return_type
-        @return_type ||= (node.type == :class ? 'Class' : 'Module') + "<#{path}>"
+        @return_type ||= (type == :class ? 'Class' : 'Module') + "<#{path}>"
       end
     end
   end

data/lib/solargraph/pin/reference.rb

@@ -1,20 +1,27 @@
 module Solargraph
   module Pin
     class Reference
-      attr_reader :pin
+      # @return [Source::Location]
+      attr_reader :location
+
+      # @return [String]
+      attr_reader :namespace
+
+      # @return [String]
       attr_reader :name
 
-      def initialize pin, name
-        @pin = pin
+      def initialize location, namespace, name
+        @location = location
+        @namespace = namespace
         @name = name
-        @resolved = false
       end
 
+      # @todo Deprecaate
       def resolve api_map
-        unless @resolved
-          @resolved = true
-          @name = api_map.find_fully_qualified_namespace(@name, pin.namespace)
-        end
+      end
+
+      def filename
+        location.filename
       end
     end
   end

data/lib/solargraph/pin/symbol.rb

@@ -1,8 +1,39 @@
 module Solargraph
   module Pin
-    class Symbol < Base
-      def name
-        @name ||= ":#{node.children[0]}"
+    class Symbol
+      include Conversions
+
+      attr_reader :location
+
+      attr_reader :name
+
+      def initialize location, name
+        @name = name
+        @location = location
+      end
+
+      def filename
+        location.filename
+      end
+
+      def kind
+        Pin::SYMBOL
+      end
+
+      def path
+        nil
+      end
+
+      def identifier
+        name
+      end
+
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::KEYWORD
+      end
+
+      def return_type
+        'Symbol'
       end
     end
   end

data/lib/solargraph/pin/yard_object.rb

@@ -8,6 +8,13 @@ module Solargraph
         YARD::CodeObjects::ConstantObject => Solargraph::LanguageServer::CompletionItemKinds::CONSTANT
       }
 
+      KIND_MAP = {
+        YARD::CodeObjects::ClassObject => Pin::NAMESPACE,
+        YARD::CodeObjects::ModuleObject => Pin::NAMESPACE,
+        YARD::CodeObjects::MethodObject => Pin::METHOD,
+        YARD::CodeObjects::ConstantObject => Pin::CONSTANT
+      }
+
       # @return [YARD::CodeObjects::Base]
       attr_reader :code_object
 
@@ -22,6 +29,10 @@ module Solargraph
         @name ||= code_object.name.to_s
       end
 
+      def kind
+        @kind ||= KIND_MAP[code_object.class] || Pin::KEYWORD
+      end
+
       def completion_item_kind
         @completion_item_kind ||= COMPLETION_ITEM_KIND_MAP[code_object.class] || Solargraph::LanguageServer::CompletionItemKinds::KEYWORD
       end
@@ -77,10 +88,6 @@ module Solargraph
         @parameters ||= get_method_args
       end
 
-      def method?
-        completion_item_kind == Solargraph::LanguageServer::CompletionItemKinds::METHOD
-      end
-
       def visibility
         :public #@todo Resolve this
       end

data/lib/solargraph/pin.rb

@@ -12,13 +12,27 @@ module Solargraph
     autoload :GlobalVariable,   'solargraph/pin/global_variable'
     autoload :Constant,         'solargraph/pin/constant'
     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'
     autoload :Reference,        'solargraph/pin/reference'
+    autoload :Documenting,      'solargraph/pin/documenting'
+    autoload :Block,            'solargraph/pin/block'
+    autoload :Localized,        'solargraph/pin/localized'
+
+    ATTRIBUTE = 1
+    CLASS_VARIABLE = 2
+    CONSTANT = 3
+    GLOBAL_VARIABLE = 4
+    INSTANCE_VARIABLE = 5
+    KEYWORD = 6
+    LOCAL_VARIABLE = 7
+    METHOD = 8
+    NAMESPACE = 9
+    SYMBOL = 10
+    BLOCK = 11
+    BLOCK_PARAMETER = 12
   end
 end

data/lib/solargraph/server.rb

@@ -161,12 +161,12 @@ module Solargraph
 
     get '/search' do
       @results = @@library.search(params['query'])
-      erb :search
+      erb :search, locals: { query: params['query'], results: @results }
     end
 
     get '/document' do
       @objects = @@library.document(params['query'])
-      erb :document
+      erb :document, locals: { objects: @objects }
     end
 
     def htmlify text