solargraph 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28954a2882b95c72c093ab8e9f8a56d36581353e
-  data.tar.gz: c49221b919b8f14239eea72d8f7a1ba59ac42c87
+  metadata.gz: ef9da7f38a0665ebb95d8e779b511d54da955619
+  data.tar.gz: 4715dd2076a1497cf00cebb8456510a33f5ca43e
 SHA512:
-  metadata.gz: ebe9048897e96e214df878cdb6d8e596e9a3d56b15fa269ee885a966991c62f930ebbe821e54b2d43c1a2ac2119eadfaad40778e99ac1254ad658147df54ebb3
-  data.tar.gz: 5a8b6875aced160a813b3285e45604aada791663f4e4581d3d007828f304db717619c4a5c92682366bd7754e8e50c8a5faa4f4ab737c49ca57910a5cff7b5625
+  metadata.gz: 7999e6032efaf061fbf36a7e9ae2b6f1b81955324c68c465bd8b17039a740cdb2015fbb71207df9ebce2235d60847a07dfca118296dcb6b7b4a05b9abe9049d2
+  data.tar.gz: 9a8632ccc9e26c082df9162f945257414562558fb65629b33b07e218399c76e7c93d43a9b31ef38465ac331f58acc1b172948245fdae10e076ebe40443300bb7

data/lib/solargraph/api_map.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'parser/current'
 require 'yard'
+require 'yaml'
 
 module Solargraph
   class ApiMap
@@ -25,9 +26,16 @@ module Solargraph
       @workspace = workspace
       clear
       unless @workspace.nil?
-        files = Dir[File.join @workspace, 'lib', '**', '*.rb'] + Dir[File.join @workspace, 'app', '**', '*.rb']
-        files.each { |f|
-          append_file f unless yardoc_has_file?(f)
+        files = []
+        opts = options
+        (opts[:include] - opts[:exclude]).each { |glob|
+          files += Dir[File.join @workspace, glob]
+        }
+        opts[:exclude].each { |glob|
+          files -= Dir[File.join @workspace, glob]
+        }
+        files.uniq.each { |f|
+          append_file f #unless yardoc_has_file?(f)
         }
       end
     end
@@ -41,17 +49,18 @@ module Solargraph
       @required = []
     end
 
-    def has_yardoc?
-      workspace and File.exist?(File.join(workspace, '.yardoc'))
-    end
-
-    def yardoc_has_file?(filename)
-      return false unless has_yardoc?
-      return false if filename.nil?
-      if filename.start_with?(File.join(workspace, 'lib/'), File.join(workspace, 'app/'))
-        return true
+    def options
+      o = {
+        include: ['app/**/*.rb', 'lib/**/*.rb'],
+        exclude: []
+      }
+      yaml = File.join(workspace, '.solargraph.yml')
+      if workspace && File.exist?(yaml)
+        l = YAML.load_file(yaml)
+        o[:include].concat l['include'] unless l['include'].nil?
+        o[:exclude].concat l[:exclude] unless l['exclude'].nil?
       end
-      false
+      o
     end
 
     def append_file filename
@@ -67,9 +76,7 @@ module Solargraph
       @file_comments[filename] = associate_comments(node, comments)
       mapified = reduce(node, @file_comments[filename])
       root = AST::Node.new(:begin, [filename])
-      mapified.children.each { |c|
-        root = root.append c
-      }
+      root = root.append mapified
       @file_nodes[filename] = root
       @required.uniq!
       process_maps
@@ -110,20 +117,20 @@ module Solargraph
       @namespace_map = {}
       @namespace_tree = {}
       @file_nodes.values.each { |f|
-        map_parents f #AST::Node.new(:tmp, @file_nodes.values)
-        map_namespaces f #AST::Node.new(:tmp, @file_nodes.values)
+        map_parents f
+        map_namespaces f
       }
     end
-    
+
     def namespaces
       @namespace_map.keys
     end
-    
+
     def namespace_exists? name, root = ''
       !find_fully_qualified_namespace(name, root).nil?
     end
-    
-    def namespaces_in name, root = '' #, skip = []
+
+    def namespaces_in name, root = ''
       result = []
       result += inner_namespaces_in(name, root, [])
       yard = YardMap.new(required: @required, workspace: @workspace)
@@ -137,43 +144,41 @@ module Solargraph
       end
       result
     end
-    
+
     def inner_namespaces_in name, root, skip
       result = []
       fqns = find_fully_qualified_namespace(name, root)
-      if fqns.nil?
-        return result
-      else
-        return result if skip.include?(fqns)
+      unless fqns.nil? or skip.include?(fqns)
         skip.push fqns
         nodes = get_namespace_nodes(fqns)
-        nodes.delete_if { |n| yardoc_has_file?(get_filename_for(n))}
-        return result if nodes.empty?
-        cursor = @namespace_tree
-        parts = fqns.split('::')
-        parts.each { |p|
-          cursor = cursor[p]
-        }
-        unless cursor.nil?
-          cursor.keys.each { |k|
-            type = get_namespace_type(k, fqns)
-            kind = nil
-            detail = nil
-            if type == :class
-              kind = Suggestion::CLASS
-              detail = 'Class'
-            elsif type == :module
-              kind = Suggestion::MODULE
-              detail = 'Module'
-            end
-            result.push Suggestion.new(k, kind: kind, detail: detail)
+        #nodes.delete_if { |n| yardoc_has_file?(get_filename_for(n))}
+        unless nodes.empty?
+          cursor = @namespace_tree
+          parts = fqns.split('::')
+          parts.each { |p|
+            cursor = cursor[p]
           }
-          nodes = get_namespace_nodes(fqns)
-          nodes.each { |n|
-            get_include_strings_from(n).each { |i|
-              result += inner_namespaces_in(i, fqns, skip)
+          unless cursor.nil?
+            cursor.keys.each { |k|
+              type = get_namespace_type(k, fqns)
+              kind = nil
+              detail = nil
+              if type == :class
+                kind = Suggestion::CLASS
+                detail = 'Class'
+              elsif type == :module
+                kind = Suggestion::MODULE
+                detail = 'Module'
+              end
+              result.push Suggestion.new(k, kind: kind, detail: detail)
             }
-          }
+            nodes = get_namespace_nodes(fqns)
+            nodes.each { |n|
+              get_include_strings_from(n).each { |i|
+                result += inner_namespaces_in(i, fqns, skip)
+              }
+            }
+          end
         end
       end
       result
@@ -217,7 +222,7 @@ module Solargraph
       return @file_nodes.values if fqns == ''
       @namespace_map[fqns] || []
     end
-    
+
     def get_instance_variables(namespace, scope = :instance)
       nodes = get_namespace_nodes(namespace) || @file_nodes.values
       arr = []
@@ -226,7 +231,7 @@ module Solargraph
       }
       arr
     end
-    
+
     def find_parent(node, *types)
       parents = @parent_stack[node]
       parents.each { |p|
@@ -234,7 +239,7 @@ module Solargraph
       }
       nil
     end
-    
+
     def get_root_for(node)
       s = @parent_stack[node]
       return nil if s.nil?
@@ -253,7 +258,7 @@ module Solargraph
         node.children.each { |c|
           if c.kind_of?(AST::Node)
             is_inst = !find_parent(c, :def).nil?
-            if c.type == :ivasgn and ( (scope == :instance and is_inst) or (scope != :instance and !is_inst) )
+            if c.type == :ivasgn and c.children[0] and ( (scope == :instance and is_inst) or (scope != :instance and !is_inst) )
               arr.push Suggestion.new(c.children[0], kind: Suggestion::VARIABLE)
             end
             arr += inner_get_instance_variables(c, scope) unless [:class, :module].include?(c.type)
@@ -409,7 +414,7 @@ module Solargraph
       return meths if fqns.nil?
       nodes = get_namespace_nodes(fqns)
       nodes.each { |n|
-        unless yardoc_has_file?(get_filename_for(n))
+        #unless yardoc_has_file?(get_filename_for(n))
           if n.kind_of?(AST::Node)
             if n.type == :class and !n.children[1].nil?
               s = unpack_name(n.children[1])
@@ -430,7 +435,7 @@ module Solargraph
               end
             }
           end
-        end
+        #end
       }
       meths.uniq
     end
@@ -442,7 +447,7 @@ module Solargraph
       skip.push fqns
       nodes = get_namespace_nodes(fqns)
       nodes.each { |n|
-        unless yardoc_has_file?(get_filename_for(n))
+        #unless yardoc_has_file?(get_filename_for(n))
           if n.kind_of?(AST::Node)
             if n.type == :class and !n.children[1].nil?
               s = unpack_name(n.children[1])
@@ -481,7 +486,7 @@ module Solargraph
               }
             }
           end
-        end
+        #end
       }
       meths.uniq
     end
@@ -498,6 +503,7 @@ module Solargraph
     end
     
     def reduce node, comment_hash
+      return node unless node.kind_of?(AST::Node)
       mappable = get_mappable_nodes(node.children, comment_hash)
       result = node.updated nil, mappable
       result
@@ -575,7 +581,7 @@ module Solargraph
     def map_namespaces node, tree = []
       if node.kind_of?(AST::Node)
         if node.type == :class or node.type == :module
-          if node.children[0].children[0].kind_of?(AST::Node) and node.children[0].children[0].type == :cbase
+          if node.children[0].kind_of?(AST::Node) and node.children[0].children[0].kind_of?(AST::Node) and node.children[0].children[0].type == :cbase
             tree = pack_name(node.children[0])
           else
             tree = tree + pack_name(node.children[0])

data/lib/solargraph/code_map.rb

@@ -207,6 +207,7 @@ module Solargraph
       scope = parent_node_from(index, :class, :module, :def, :defs) || @node
       var = find_local_variable_node(first, scope)
       if var.nil?
+        # It's not a locally assigned variable.
         if ['STDERR','STDOUT','STDIN'].include?(first)
           obj = 'IO'
           if parts.length == 0
@@ -214,13 +215,32 @@ module Solargraph
           end
         else
           if parts.length == 0
-            return @api_map.get_methods(first, ns_here)
+            # HACK: Assume that it's a constant (class or module) if it starts with an uppercase letter
+            if first[0] == first[0].upcase
+              return @api_map.get_methods(first, ns_here)
+            else
+              if scope.type == :def
+                meths = @api_map.get_instance_methods(ns_here).delete_if{|m| m.insert != first}
+                return [] if meths.empty?
+                return [] if meths[0].documentation.nil?
+                match = meths[0].documentation.all.match(/@return \[([a-z0-9:_]*)/i)
+                return [] if match[1].nil?
+                return @api_map.get_instance_methods(match[1], ns_here)
+              else
+                meths = @api_map.get_methods(ns_here).delete_if{|m| m.insert != first}
+                return [] if meths.empty?
+                return [] if meths[0].documentation.nil?
+                match = meths[0].documentation.all.match(/@return \[([a-z0-9:_]*)/i)
+                return [] if match[1].nil?
+                return @api_map.get_instance_methods(match[1], ns_here)
+              end
+            end
           end
           meth = parts.shift
           if meth == 'new'
             obj = first
           else
-            obj = get_method_return_value first, ns_here, meth
+            obj = get_method_return_value first, ns_here, meth, :class
           end
         end
         while parts.length > 0
@@ -237,27 +257,30 @@ module Solargraph
       end
     end
 
-    def get_method_return_value namespace, root, method
+    def get_method_return_value namespace, root, method, scope = :instance
       meths = @api_map.get_methods(namespace, root).delete_if{ |m| m.insert != method }
       meths.each { |m|
-        unless m.documentation.nil?
-          match = m.documentation.all.match(/@return \[([a-z0-9:_]*)/i)
-          klass = match[1]
-          return klass unless klass.nil?
-        end
+        r = get_return_tag(m)
+        return r unless r.nil?
       }
-      'Object'
+      nil
     end
 
     def get_instance_method_return_value namespace, root, method
       meths = @api_map.get_instance_methods(namespace, root).delete_if{ |m| m.insert != method }
       meths.each { |m|
-        unless m.documentation.nil?
-          match = m.documentation.all.match(/@return \[([a-z0-9:_]*)/i)
-          return match[1] unless match.nil?
-        end
+        r = get_return_tag(m)
+        return r unless r.nil?
       }
-      'Object'
+      nil
+    end
+
+    def get_return_tag suggestion
+        unless suggestion.documentation.nil?
+          match = suggestion.documentation.all.match(/@return \[([a-z0-9:_]*)/i)
+          return match[1]
+        end
+        nil
     end
 
     def get_signature_at index
@@ -339,7 +362,7 @@ module Solargraph
         result += @api_map.get_methods(scope, visibility: [:public, :private, :protected])
       end
       result += @api_map.get_methods('Kernel')
-      result    
+      result
     end
     
     private

data/lib/solargraph/node_methods.rb

@@ -6,17 +6,19 @@ module Solargraph
     
     def pack_name(node)
       parts = []
-      node.children.each { |n|
-        if n.kind_of?(AST::Node)
-          if n.type == :cbase
-            parts = pack_name(n)
+      if node.kind_of?(AST::Node)
+        node.children.each { |n|
+          if n.kind_of?(AST::Node)
+            if n.type == :cbase
+              parts = pack_name(n)
+            else
+              parts += pack_name(n)
+            end
           else
-            parts += pack_name(n)
+            parts.push n unless n.nil?
           end
-        else
-          parts.push n unless n.nil?
-        end
-      }
+        }
+      end
       parts
     end
 

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.4.1'
+  VERSION = '0.4.2'
 end

data/lib/solargraph/yard_map.rb

@@ -6,10 +6,10 @@ module Solargraph
 
   class YardMap
     def initialize required: [], workspace: nil
-      unless workspace.nil?
-        wsy = File.join(workspace, '.yardoc')
-        yardocs.push wsy if File.exist?(wsy)
-      end
+      #unless workspace.nil?
+      #  wsy = File.join(workspace, '.yardoc')
+      #  yardocs.push wsy if File.exist?(wsy)
+      #end
       used = []
       required.each { |r|
         if workspace.nil? or !File.exist?(File.join workspace, 'lib', "#{r}.rb")
@@ -58,7 +58,11 @@ module Solargraph
         unless yard.nil?
           obj = yard.at query
           #found.push YARD::Templates::Engine.render(format: :html, object: obj) unless obj.nil?
-          found.push obj unless obj.nil?
+          unless obj.nil?
+            # HACK: Fix return tags in core documentation
+            fix_return! obj if obj.kind_of?(YARD::CodeObjects::MethodObject) and y.include?('.solargraph')
+            found.push obj
+          end
         end
       }
       found
@@ -125,15 +129,17 @@ module Solargraph
           if scope == ''
             ns = yard.at(namespace)
           else
-            ns = yard.resolve(P(scope), namespace)
+            ns = find_first_resolved_namespace(yard, namespace, scope)
           end
           unless ns.nil? or !ns.kind_of?(YARD::CodeObjects::NamespaceObject)
             ns.meths(scope: :class, visibility: visibility).each { |m|
+              # HACK: Fix return tags in core documentation
+              fix_return! m if y.include?('.solargraph')
               n = m.to_s.split(/[\.#]/).last
               label = "#{n}"
               args = get_method_args(m)
               label += " #{args.join(', ')}" unless args.empty?
-              meths.push Suggestion.new(label, insert: "#{n}", kind: Suggestion::METHOD, detail: "#{ns}") if n.to_s.match(/^[a-z]/i)
+              meths.push Suggestion.new(label, insert: "#{n}", kind: Suggestion::METHOD, documentation: m.docstring, code_object: m, detail: "#{ns}", location: "#{m.file}:#{m.line}")
             }
             if ns.kind_of?(YARD::CodeObjects::ClassObject) and namespace != 'Class'
               meths += get_instance_methods('Class')
@@ -153,10 +159,12 @@ module Solargraph
           if scope == ''
             ns = yard.at(namespace)
           else
-            ns = yard.resolve(P(scope), namespace)
+            ns = find_first_resolved_namespace(yard, namespace, scope)
           end
           unless ns.nil?
             ns.meths(scope: :instance, visibility: visibility).each { |m|
+              # HACK: Fix return tags in core documentation
+              fix_return! m if y.include?('.solargraph')
               n = m.to_s.split(/[\.#]/).last
               if n.to_s.match(/^[a-z]/i) and (namespace == 'Kernel' or !m.to_s.start_with?('Kernel#')) and !m.docstring.to_s.include?(':nodoc:')
                 label = "#{n}"
@@ -174,6 +182,10 @@ module Solargraph
       meths
     end
 
+    def gem_names
+      Gem::Specification.map{ |s| s.name }.uniq
+    end
+
     private
 
     def get_method_args meth
@@ -183,6 +195,32 @@ module Solargraph
       }
       args
     end
+
+    def fix_return! meth
+      return unless meth.tag(:return).nil?
+      return unless meth.docstring.all.include?('@return')
+      text = ''
+      meth.docstring.all.lines.each { |line|
+        if line.strip.start_with?('@return')
+          text += line.strip
+        else
+          text += line
+        end
+        text += "\n"
+      }
+      doc = YARD::Docstring.new(text, meth)
+      meth.docstring = doc
+    end
+
+    def find_first_resolved_namespace yard, namespace, scope
+      parts = scope.split('::')
+      while parts.length > 0
+        ns = yard.resolve(P(scope), namespace)
+        return ns unless ns.nil?
+        parts.pop
+      end
+      yard.at(namespace)
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser