solargraph 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e52db6d5b84e35fa182015ad0178c8fde5433534
-  data.tar.gz: 4cb0dbfa89392f8fb4b9b04b506114d1b975fcb9
+  metadata.gz: 9f759172a51025a8b3000009fd8a0495ed8b4e09
+  data.tar.gz: 45599c0d4f5f61d08e5f1e9ef58ff383e14500c9
 SHA512:
-  metadata.gz: 9f4d6d1f77fb88afb992b1a32eb12e017f74a310e090c0b275d4f5d6546313455c7e5d9230322007d1e15acc9686bc88f744e3cb18512b2ba6be5d356adb147e
-  data.tar.gz: 74cd777945f475843b629de0613cd10949b9aed887a30f5a1423825bac943df4c4491f9caf98b8d3f231df12f22a4e09cb6c62836cc5047003a4a665a2f5a8fd
+  metadata.gz: ac26b06145aa273f6601808a83cfe19ede6cc97eb744514f7435aa0b4780cc8c7e33482662930838a20d3bc13008f976e6caa4460319c4637b72873b615e7f91
+  data.tar.gz: e5ae9a35a4ac2fccec2450ab6c96f790bed7173de95395fc7978357b5320abef3c47d95ceb3386d0e33b3178abc07ce39b0b76ae9702c54f72b92f85109c176c

data/lib/solargraph/api_map.rb

@@ -39,7 +39,7 @@ module Solargraph
           files -= Dir[File.join @workspace, glob]
         }
         files.uniq.each { |f|
-          append_file f #unless yardoc_has_file?(f)
+          append_file f if File.file?(f)
         }
       end
     end
@@ -373,6 +373,10 @@ module Solargraph
       type
     end
 
+    # Get an array of singleton methods that are available in the specified
+    # namespace.
+    #
+    # @return [Array<Solargraph::Suggestion>]
     def get_methods(namespace, root = '', visibility: [:public])
       meths = []
       meths += inner_get_methods(namespace, root, []) #unless has_yardoc?
@@ -410,6 +414,10 @@ module Solargraph
       args
     end
 
+    # Get an array of instance methods that are available in the specified
+    # namespace.
+    #
+    # @return [Array<Solargraph::Suggestion>]
     def get_instance_methods(namespace, root = '', visibility: [:public])
       meths = []
       meths += inner_get_instance_methods(namespace, root, []) #unless has_yardoc?
@@ -461,6 +469,8 @@ module Solargraph
       arr
     end
     
+    # Update the YARD documentation for the current workspace.
+    #
     def update_yardoc
       if workspace.nil?
         STDERR.puts "No workspace specified for yardoc update."

data/lib/solargraph/code_map.rb

@@ -24,7 +24,10 @@ module Solargraph
       tries = 0
       tmp = @code
       begin
-        node, comments = Parser::CurrentRuby.parse_with_comments(tmp)
+        # HACK: The current file is parsed with a trailing underscore to fix
+        # incomplete trees resulting from short scripts (e.g., a lone variable
+        # assignment).
+        node, comments = Parser::CurrentRuby.parse_with_comments(tmp + "\n_")
         @node = self.api_map.append_node(node, comments, filename)
         @parsed = tmp
         @code.freeze
@@ -83,6 +86,12 @@ module Solargraph
       result
     end
 
+    # Get the offset of the specified line and column.
+    # The offset (also called the "index") is typically used to identify the
+    # cursor's location in the code when generating suggestions.
+    # The line and column numbers should start at zero.
+    #
+    # @return [Integer]
     def get_offset line, col
       offset = 0
       if line > 0
@@ -93,10 +102,6 @@ module Solargraph
       offset + col
     end
 
-    def merge node
-      api_map.merge node
-    end
-
     def tree_at(index)
       arr = []
       arr.push @node
@@ -126,6 +131,11 @@ module Solargraph
       @node
     end
 
+    # Get the namespace at the specified location. For example, given the code
+    # `class Foo; def bar; end; end`, index 14 (the center) is in the
+    # "Foo" namespace.
+    #
+    # @return [String]
     def namespace_at(index)
       tree = tree_at(index)
       return nil if tree.length == 0
@@ -140,11 +150,16 @@ module Solargraph
       parts.join("::")
     end
 
+    # Get the namespace for the specified node. For example, given the code
+    # `class Foo; def bar; end; end`, the node for `def bar` is in the "Foo"
+    # namespace.
+    #
+    # @return [String]
     def namespace_from(node)
       if node.respond_to?(:loc)
         namespace_at(node.loc.expression.begin_pos)
       else
-        namespace_at(0)
+        ''
       end
     end
 
@@ -180,6 +195,10 @@ module Solargraph
       api_map.get_instance_variables(ns, (node.type == :def ? :instance : :class))
     end
 
+    # Get suggestions for code completion at the specified location in the
+    # source.
+    #
+    # @return [Array<Suggestions>] The completion suggestions
     def suggest_at index, filtered: false, with_snippets: false
       return [] if string_at?(index) or string_at?(index - 1)
       result = []
@@ -236,7 +255,7 @@ module Solargraph
         #end
       end
       result = reduce_starting_with(result, word_at(index)) if filtered
-      result.uniq{|s| s.path}
+      result.uniq{|s| s.path}.sort{|a,b| a.label <=> b.label}
     end
 
     def signatures_at index
@@ -307,7 +326,8 @@ module Solargraph
       var = find_local_variable_node(start, node)
       if var.nil?
         if start.start_with?('@')
-          type = api_map.infer_instance_variable(start, ns_here, (node.type == :def ? :instance : :class))
+          scope2 = (node.type == :def ? :instance : :class)
+          type = api_map.infer_instance_variable(start, ns_here, scope2)
         else
           if node.type == :def or node.type == :defs
             args = get_method_arguments_from(node).keep_if{|a| a.label == start}
@@ -323,11 +343,15 @@ module Solargraph
               end
             else
               cmnt = api_map.get_comment_for(node)
-              params = cmnt.tags(:param)
-              params.each do |p|
-                if p.name == args[0].label
-                  type = p.types[0]
-                  break
+              unless cmnt.nil?
+                params = cmnt.tags(:param)
+                unless params.nil?
+                  params.each do |p|
+                    if p.name == args[0].label
+                      type = p.types[0]
+                      break
+                    end
+                  end
                 end
               end
             end
@@ -375,6 +399,17 @@ module Solargraph
       obj
     end
 
+    # Get the signature at the specified index.
+    # A signature is a method call that can start with a constant, method, or
+    # variable and does not include any method arguments. Examples:
+    #
+    # Code                  Signature
+    # -----------------------------------------
+    # String.new            String.new
+    # @x.bar                @x.bar
+    # y.split(', ').length  y.split.length
+    #
+    # @return [String]
     def get_signature_at index
       brackets = 0
       squares = 0
@@ -407,6 +442,10 @@ module Solargraph
       signature
     end
 
+    # Build a signature from the specified node. This method returns the node
+    # as an array of strings.
+    #
+    # @return [Array<String>]
     def build_signature(node, parts)
       if node.kind_of?(AST::Node)
         if node.type == :send
@@ -437,6 +476,10 @@ module Solargraph
       result
     end
 
+    # Get an array of local variables and methods that can be accessed from
+    # the specified location in the code.
+    #
+    # @return [Array<Solargraph::Suggestion>]
     def get_local_variables_and_methods_at(index)
       result = []
       local = parent_node_from(index, :class, :module, :def, :defs) || @node

data/lib/solargraph/node_methods.rb

@@ -39,27 +39,6 @@ module Solargraph
       end
     end
 
-    def drill_signature node, signature
-      return signature unless node.kind_of?(AST::Node)
-      if node.type == :const or node.type == :cbase
-        unless node.children[0].nil?
-          signature += drill_signature(node.children[0], signature)
-        end
-        signature += '::' unless signature.empty?
-        signature += node.children[1].to_s
-      elsif node.type == :lvar
-        signature += '.' unless signature.empty?
-        signature += node.children[0].to_s
-      elsif node.type == :send
-        unless node.children[0].nil?
-          signature += drill_signature(node.children[0], signature)
-        end
-        signature += '.' unless signature.empty?
-        signature += node.children[1].to_s
-      end
-      signature
-    end
-
     def infer node
       if node.type == :str
         return 'String'
@@ -127,5 +106,28 @@ module Solargraph
       end
       @yard_options
     end
+
+    private
+
+    def drill_signature node, signature
+      return signature unless node.kind_of?(AST::Node)
+      if node.type == :const or node.type == :cbase
+        unless node.children[0].nil?
+          signature += drill_signature(node.children[0], signature)
+        end
+        signature += '::' unless signature.empty?
+        signature += node.children[1].to_s
+      elsif node.type == :lvar
+        signature += '.' unless signature.empty?
+        signature += node.children[0].to_s
+      elsif node.type == :send
+        unless node.children[0].nil?
+          signature += drill_signature(node.children[0], signature)
+        end
+        signature += '.' unless signature.empty?
+        signature += node.children[1].to_s
+      end
+      signature
+    end
   end
 end

data/lib/solargraph/server.rb

@@ -25,7 +25,7 @@ module Solargraph
         @@semaphore.synchronize {
           code_map = CodeMap.new(code: params['text'], filename: params['filename'], api_map: @@api_hash[workspace])
           offset = code_map.get_offset(params['line'].to_i, params['column'].to_i)
-          sugg = code_map.suggest_at(offset, with_snippets: params['with_snippets'] == '1' ? true : false)
+          sugg = code_map.suggest_at(offset, with_snippets: params['with_snippets'] == '1' ? true : false, filtered: (params['filtered'] || false))
         }
         { "status" => "ok", "suggestions" => sugg }.to_json
       rescue Exception => e

data/lib/solargraph/suggestion.rb

@@ -15,12 +15,13 @@ module Solargraph
     attr_reader :label, :kind, :insert, :detail, :documentation, :code_object, :location, :arguments
 
     def initialize label, kind: KEYWORD, insert: nil, detail: nil, documentation: nil, code_object: nil, location: nil, arguments: []
+      @helper = Server::Helpers.new
       @label = label.to_s
       @kind = kind
       @insert = insert || @label
       @detail = detail
       @code_object = code_object
-      @documentation = documentation
+      @documentation = @helper.html_markup_rdoc(documentation.to_s) unless documentation.nil?
       @location = location
       @arguments = arguments
     end
@@ -36,7 +37,7 @@ module Solargraph
     def return_type
       if code_object.nil?
         unless documentation.nil?
-          match = documentation.all.match(/@return \[([a-z0-9:_]*)/i)
+          match = documentation.match(/@return \[([a-z0-9:_]*)/i)
           return match[1] unless match.nil?
         end
       else
@@ -51,6 +52,15 @@ module Solargraph
       nil
     end
 
+    def documentation
+      if @documentation.nil?
+        unless @code_object.nil?
+          @documentation = @helper.html_markup_rdoc(@code_object.docstring.to_s) unless @code_object.docstring.nil?
+        end
+      end
+      @documentation.to_s
+    end
+
     def to_json args={}
       obj = {
         label: @label,
@@ -59,13 +69,10 @@ module Solargraph
         detail: @detail,
         path: path,
         location: (@location.nil? ? nil : @location.to_s),
-        arguments: @arguments
+        arguments: @arguments,
+        return_type: return_type,
+        documentation: documentation
       }
-      if @code_object.nil?
-        obj[:documentation] = @documentation.to_s unless @documentation.nil?
-      else
-        obj[:documentation] = @code_object.docstring.to_s unless @code_object.docstring.nil?
-      end
       obj.to_json(args)
     end
   end

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.8.3'
+  VERSION = '0.8.4'
 end

data/lib/solargraph/yard_map.rb

@@ -197,10 +197,14 @@ module Solargraph
               end
             }
             if ns.kind_of?(YARD::CodeObjects::ClassObject) and namespace != 'Object'
-              if ns.superclass.kind_of?(YARD::CodeObjects::Proxy)
+              #if ns.superclass.kind_of?(YARD::CodeObjects::Proxy)
+              unless ns.nil?
                 meths += get_instance_methods(ns.superclass.to_s)
               end
             end
+            ns.instance_mixins.each do |m|
+              meths += get_instance_methods(m.to_s)
+            end
           end
         end
       }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-08 00:00:00.000000000 Z
+date: 2017-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -137,7 +137,6 @@ files:
 - lib/solargraph.rb
 - lib/solargraph/api_map.rb
 - lib/solargraph/code_map.rb
-- lib/solargraph/live_parser.rb
 - lib/solargraph/mapper.rb
 - lib/solargraph/node_methods.rb
 - lib/solargraph/server.rb
@@ -145,7 +144,6 @@ files:
 - lib/solargraph/snippets.rb
 - lib/solargraph/suggestion.rb
 - lib/solargraph/version.rb
-- lib/solargraph/views/foo.erb
 - lib/solargraph/views/layout.erb
 - lib/solargraph/views/search.erb
 - lib/solargraph/yard_map.rb

data/lib/solargraph/live_parser.rb

@@ -1,265 +0,0 @@
-# Solargraph Ruby Parser
-# Copyright (c) 2015 by Fred Snyder for Castwide Technologies LLC
-#
-# Solargraph::Parser builds a code representation of existing Ruby interfaces
-# for use in the Solargraph IDE.
-#
-# Example use:
-#
-#    parser = Solargraph::Parser.new
-#    parser.parse            #=> String with the entire Ruby interface
-#    parser.parse("Fixnum")  #=> String with the Fixnum interface
-#require 'yard'
-#require 'yard/registry'
-
-module Solargraph
-  class LiveParser
-    def get_yard_return(path)
-      objects = []
-      yardocs = ['yard/2.2.0/.yardoc', 'ruby/yard/2.2.0/.yardoc-stdlib']
-      yardocs.each { |y|
-        YARD::Registry.load!(y)
-        o = YARD::Registry.at(path)
-        if !o.nil?
-          objects.push o
-        end
-      }
-      result = nil
-      objects.each { |x|
-        meth = x
-        if !meth.tag(:return) and meth.tag(:overload) and meth.tag(:overload).tag(:return)
-          meth = meth.tag(:overload)
-        end
-        meth.tags(:return).each { |r|
-          result = "#{r.types[0]}"
-          break
-        }
-        break if !result.nil?
-      }
-      result
-    end
-    def initialize
-
-    end
-    def parse namespace = nil
-      #puts "Namespace: #{namespace}"
-      @parsed = []
-      code = ""
-      fqns = namespace
-      if fqns.nil?
-        #code += parse("BasicObject")
-        #code += parse("Object")
-        #code += parse("Kernel")
-        code += parse("Module")
-        return code
-      end
-      mod = eval("#{fqns}")
-      if !mod.nil?
-        if mod.instance_of?(Class)
-          #puts "Parsing class #{mod} to #{fqns}"
-          code += parse_class mod, fqns
-        elsif mod.instance_of?(Module)
-          #puts "Parsing module #{mod} to #{fqns}"
-          code += parse_module mod, fqns
-        else
-          #raise "I don't know what a #{fqns} is."
-          code += "#{fqns} = nil\n"
-        end
-      else
-        #puts "NIL!"
-      end
-      code
-    end
-    def self.parse n
-      LiveParser.new.parse(n)
-    end
-    private
-    def parse_class cls, rel_name
-      return "" if @parsed.include?(cls)
-      @parsed.push cls
-      code = ""
-      #code += "class #{rel_name}"
-      code += "class #{cls}"
-      if !cls.superclass.nil? && cls.superclass != cls
-        code += " < #{cls.superclass}"
-      end
-      code += "\n"
-      code += parse_class_internals(cls)
-      code += "end\n"
-      cls.constants().each { |c|
-        #obj = cls.class_eval(c.to_s)
-        begin
-          obj = cls.const_get(c)
-          if obj.kind_of?(Class)
-            code += parse_class(obj, c)
-          elsif obj.kind_of?(Module)
-            code += parse_module(obj, c)
-          else
-            #code += subparse(obj)
-          end
-        #rescue NameError => e
-        #  #puts "NOPE! NOT #{c}"
-        #end
-        rescue Exception => e
-          # TODO: Ignoring all exceptions for now
-        end
-      }
-      code
-    end
-    def parse_module mod, rel_name
-      return "" if @parsed.include?(mod) or mod == Solargraph
-      @parsed.push mod
-      code = ""
-      #if (mod.to_s != "Kernel")
-        code = "module #{mod}\n"
-      #end
-      code += parse_module_internals(mod)
-      #if (mod.to_s != "Kernel")
-        code += "end\n"
-      #end
-      mod.constants().each { |c|
-        #obj = mod.class_eval(c.to_s)
-        begin
-          obj = mod.const_get(c)
-        rescue LoadError => e
-          code += "# @todo Failed to load #{c} from #{mod}\n"
-        end
-        if obj.kind_of?(Class)
-          code += parse_class(obj, c)
-        elsif obj.kind_of?(Module)
-          code += parse_module(obj, c)
-        else
-          #code += subparse(obj)
-        end
-      }
-      code
-    end
-    def parse_class_internals obj
-      code = ""
-      obj.included_modules.each { |inc|
-        #if (inc.to_s != "Kernel")
-          code += "include #{inc}\n"
-        #end
-      }
-      obj.public_methods(false).each { |m|
-        if !can_ignore?(obj, m)
-          args = build_args obj.method(m)
-          #ret = get_yard_return "#{obj}::#{m}"
-          #if !ret.nil?
-          #   code += "# @return [#{ret}]\n"
-          #end
-          code += "def self.#{m}#{args};end\n"
-        end
-      }
-      alloc = obj
-      obj.singleton_methods(false).each { |m|
-        if !can_ignore?(obj, m)
-          args = build_args obj.method(m)
-          #ret = get_yard_return "#{obj}::#{m}"
-          #if !ret.nil?
-          #   code += "# @return [#{ret}]\n"
-          #end
-          code += "def self.#{m}#{args};end\n"
-        end
-      }
-      obj.public_instance_methods(false).each { |m|
-        if !can_ignore?(obj, m)
-          begin
-            args = build_args obj.public_instance_method(m)
-          rescue TypeError => e
-            args = ""
-          end
-          #ret = get_yard_return "#{obj}##{m}"
-          #if !ret.nil?
-          #   code += "# @return [#{ret}]\n"
-          #end
-          code += "def #{m}#{args};end\n"
-        end
-      }
-      code
-    end
-    def parse_module_internals obj
-      code = ""
-      obj.included_modules.each { |inc|
-        #if (inc.to_s != "Kernel")
-          code += "include #{inc}\n"
-        #end
-      }
-      obj.public_methods(false).each { |m|
-        if obj == Kernel #and obj.singleton_methods.include?(m)
-          next
-        end
-        if !can_ignore?(obj, m)
-          args = build_args obj.method(m)
-          #ret = get_yard_return "#{obj}##{m}"
-          #if !ret.nil?
-          #   code += "# @return [#{ret}]\n"
-          #end
-          code += "def #{m}#{args};end\n"
-        end
-      }
-      obj.singleton_methods(false).each { |m|
-        if !can_ignore?(obj, m)
-          args = build_args obj.method(m)
-          #ret = get_yard_return "#{obj}::#{m}"
-          #if !ret.nil?
-          #   code += "# @return [#{ret}]\n"
-          #end
-          code += "def self.#{m}#{args};end\n"
-        end
-      }
-      #obj.public_instance_methods(false).each { |m|
-      obj.public_instance_methods(false).each { |m|
-        #if !can_ignore?(obj, m)
-          args = build_args obj.public_instance_method(m)
-          #ret = get_yard_return "#{obj}##{m}"
-          #if !ret.nil?
-          #   code += "# @return [#{ret}]\n"
-          #end
-          code += "def #{m}#{args};end\n"
-        #end
-      }
-      code
-    end
-    def can_ignore?(obj, sym)
-      #return false
-      basics = [Kernel, Module, Object, BasicObject]
-      return false if basics.include?(obj)
-      result = false
-      basics.each { |b|
-        if b.respond_to?(sym)
-          result = true
-          break
-        end
-      }
-      return result
-    end
-    def build_args method
-      args = ""
-      if (method.arity == -1)
-        args = "(*args)"
-      else
-        arr = []
-        num = 0
-        method.parameters.each { |p|
-          n = p[1]
-          if n.to_s == ""
-           n = "arg#{num}"
-          end
-          if p[0] == :req
-            arr.push "#{n}"
-          elsif p[0] == :opt
-            arr.push "#{n} = nil"
-          elsif p[0] == :rest
-            arr.push "*#{n}"
-          elsif p[0] == :block
-            arr.push "&#{n}"
-          end
-          num += 1
-        }
-        args = "(" + arr.join(", ") + ")"
-      end
-      args
-    end
-  end
-end

data/lib/solargraph/views/foo.erb

@@ -1 +0,0 @@
-<p>Foo!</p>