solargraph 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de6f8c27644254cbf44fabf999b5e7d9c54361d5
-  data.tar.gz: e823050e40e151659b89be427a8039165c5a315c
+  metadata.gz: 3993f33469901ac1b7d51659d9452a48adcd0e3f
+  data.tar.gz: de8f13ed8c39b332b7837fca4bcdfd8516ca8c1f
 SHA512:
-  metadata.gz: 1312f30cabb2d18635ea4e48900226318476ac7d53022b46b72afcc2696451154e9fc9718b1f74026ceb2cae6c4afc04b2904f28d3b9c02d555ef410904c53d2
-  data.tar.gz: 2c05df4a956bdb87868e6d624c72fc232a35599d0abd8763286b0db389f559e4b160747f6c6a3c43b1a2c2d7d8659b840ddd00465a69e57f327e2b0858dd4663
+  metadata.gz: 0fdcec41d5a9b6920596d30f16a719948e74b3432b53584a0621b05f7c6d815e5bc5e69748737ef4c415db67061682babefeac0cf28c4cc73e69b8927b86b768
+  data.tar.gz: f6daf69d9d06dba1b7fea6e29ed5a2d8c336cfccbe3c33ab29cbb2fa05c79eca886f1e1474ed92ba5cc11a7eeb71ed6fbdedc5de96fc8ecd52c634fe91417209

data/lib/solargraph/api_map.rb

@@ -24,6 +24,7 @@ module Solargraph
     attr_reader :workspace
     attr_reader :required
 
+    # @param workspace [String]
     def initialize workspace = nil
       @workspace = workspace.gsub(/\\/, '/') unless workspace.nil?
       clear
@@ -38,6 +39,7 @@ module Solargraph
     end
 
     def clear
+      @file_source = {}
       @file_nodes = {}
       @file_comments = {}
       @parent_stack = {}
@@ -46,15 +48,20 @@ module Solargraph
       @required = []
     end
 
+    # @return [Solargraph::YardMap]
     def yard_map
       @yard_map ||= YardMap.new(required: required, workspace: workspace)
     end
 
+    # @param filename [String]
     def append_file filename
       append_source File.read(filename), filename
     end
 
+    # @param text [String]
+    # @param filename [String]
     def append_source text, filename = nil
+      @file_source[filename] = text
       begin
         node, comments = Parser::CurrentRuby.parse_with_comments(text)
         append_node(node, comments, filename)
@@ -107,7 +114,6 @@ module Solargraph
       @file_comments[filename][node.loc]
     end
 
-
     def self.get_keywords
       result = []
       keywords = KEYWORDS + ['attr_reader', 'attr_writer', 'attr_accessor', 'private', 'public', 'protected']
@@ -149,45 +155,6 @@ module Solargraph
       result
     end
 
-    def inner_namespaces_in name, root, skip
-      result = []
-      fqns = find_fully_qualified_namespace(name, root)
-      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))}
-        unless 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 = 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
-    end
-
     def find_fully_qualified_namespace name, root = '', skip = []
       return nil if skip.include?(root)
       skip.push root
@@ -269,22 +236,6 @@ module Solargraph
       @yardoc_files.include?(file)
     end
 
-    def inner_get_instance_variables(node, scope)
-      arr = []
-      if node.kind_of?(AST::Node)
-        node.children.each { |c|
-          if c.kind_of?(AST::Node)
-            is_inst = !find_parent(c, :def).nil?
-            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, documentation: get_comment_for(c))
-            end
-            arr += inner_get_instance_variables(c, scope) unless [:class, :module].include?(c.type)
-          end
-        }
-      end
-      arr
-    end
-
     def infer_instance_variable(var, namespace, scope = :instance)
       result = nil
       vn = nil
@@ -418,11 +369,11 @@ module Solargraph
         if c.type == :arg
           args.push c.children[0]
         elsif c.type == :optarg
-          args.push "#{c.children[0]} = _"
+          args.push "#{c.children[0]} = #{code_for(c.children[1])}"
         elsif c.type == :kwarg
           args.push "#{c.children[0]}:"
         elsif c.type == :kwoptarg
-          args.push "#{c.children[0]}: _"
+          args.push "#{c.children[0]}: #{code_for(c.children[1])}"
         end
       }
       args
@@ -607,6 +558,61 @@ module Solargraph
       meths.uniq
     end
 
+    def inner_namespaces_in name, root, skip
+      result = []
+      fqns = find_fully_qualified_namespace(name, root)
+      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))}
+        unless 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 = 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
+    end
+
+    def inner_get_instance_variables(node, scope)
+      arr = []
+      if node.kind_of?(AST::Node)
+        node.children.each { |c|
+          if c.kind_of?(AST::Node)
+            is_inst = !find_parent(c, :def).nil?
+            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, documentation: get_comment_for(c))
+            end
+            arr += inner_get_instance_variables(c, scope) unless [:class, :module].include?(c.type)
+          end
+        }
+      end
+      arr
+    end
+
     def mappable?(node)
       return true if node.kind_of?(AST::Node) and [:array, :hash, :str, :int, :float].include?(node.type)
       # TODO Add node.type :casgn (constant assignment)
@@ -728,5 +734,13 @@ module Solargraph
         }
       end
     end
+
+    def code_for node
+      src = @file_source[get_filename_for(node)]
+      return nil if src.nil?
+      b = node.location.expression.begin.begin_pos
+      e = node.location.expression.end.end_pos
+      src[b..e].strip.gsub(/,$/, '')
+    end
   end
 end

data/lib/solargraph/code_map.rb

@@ -23,8 +23,8 @@ module Solargraph
         # 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)
+        node, @comments = Parser::CurrentRuby.parse_with_comments(tmp + "\n_")
+        @node = self.api_map.append_node(node, @comments, filename)
         @parsed = tmp
         @code.freeze
         @parsed.freeze
@@ -99,6 +99,16 @@ module Solargraph
       n.kind_of?(AST::Node) and n.type == :str
     end
 
+    # Determine if the specified index is inside a comment.
+    #
+    # @return [Boolean]
+    def comment_at?(index)
+      @comments.each do |c|
+        return true if index > c.location.expression.begin_pos and index <= c.location.expression.end_pos
+      end
+      false
+    end
+
     def parent_node_from(index, *types)
       arr = tree_at(index)
       arr.each { |a|
@@ -178,7 +188,7 @@ module Solargraph
     #
     # @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)
+      return [] if string_at?(index) or string_at?(index - 1) or comment_at?(index)
       result = []
       phrase = phrase_at(index)
       signature = get_signature_at(index)
@@ -387,6 +397,7 @@ module Solargraph
     # @x.bar                @x.bar
     # y.split(', ').length  y.split.length
     #
+    # @param index [Integer]
     # @return [String]
     def get_signature_at index
       brackets = 0
@@ -478,15 +489,25 @@ module Solargraph
     private
 
     def get_method_arguments_from node
+      param_hash = {}
+      cmnt = api_map.get_comment_for(node)
+      unless cmnt.nil?
+        tags = cmnt.tags(:param)
+        tags.each do |tag|
+          param_hash[tag.name] = tag.types[0]
+        end
+      end
       result = []
       args = node.children[1]
       args.children.each do |arg|
         name = arg.children[0].to_s
-        result.push Suggestion.new(name, kind: Suggestion::PROPERTY, insert: name)
+        result.push Suggestion.new(name, kind: Suggestion::PROPERTY, insert: name, return_type: param_hash[name])
       end
       result
     end
 
+    # @param suggestions [Array<Solargraph::Suggestion>]
+    # @param word [String]
     def reduce_starting_with(suggestions, word)
       suggestions.reject { |s|
         !s.label.start_with?(word)

data/lib/solargraph/server.rb

@@ -132,12 +132,19 @@ module Solargraph
     end
 
     class Helpers
+      include YARD::Templates::Helpers::HtmlHelper
+
       attr_accessor :object
       attr_accessor :serializer
-      include YARD::Templates::Helpers::HtmlHelper
+
+      def url_for(object)
+        '.'
+      end
+
       def options
         @options ||= YARD::Templates::TemplateOptions.new
       end
+
       # HACK: The linkify method just returns the arguments as plain text
       def linkify *args
         args.join(', ')

data/lib/solargraph/shell.rb

@@ -82,7 +82,7 @@ module Solargraph
 
     desc 'config [DIRECTORY]', 'Create or overwrite a default configuration file'
     def config(directory = '.')
-      File.open(File.join(directory, '.solargraph'), 'w') do |file|
+      File.open(File.join(directory, '.solargraph.yml'), 'w') do |file|
         file.puts "include:",
           "  - ./**/*.rb",
           "exclude:",

data/lib/solargraph/suggestion.rb

@@ -14,7 +14,7 @@ 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: []
+    def initialize label, kind: KEYWORD, insert: nil, detail: nil, documentation: nil, code_object: nil, location: nil, arguments: [], return_type: nil
       @helper = Server::Helpers.new
       @label = label.to_s
       @kind = kind
@@ -24,6 +24,7 @@ module Solargraph
       @documentation = documentation
       @location = location
       @arguments = arguments
+      @return_type = return_type
     end
     
     def path
@@ -35,27 +36,28 @@ module Solargraph
     end
 
     def return_type
-      if code_object.nil?
-        unless documentation.nil?
-          if documentation.kind_of?(YARD::Docstring)
-            t = documentation.tag(:return)
-            return nil if t.nil?
-            return t.types[0]
-          else
-            match = documentation.match(/@return \[([a-z0-9:_]*)/i)
-            return match[1] unless match.nil?
+      if @return_type.nil?
+        if code_object.nil?
+          unless documentation.nil?
+            if documentation.kind_of?(YARD::Docstring)
+              t = documentation.tag(:return)
+              @return_type = t.types[0] unless t.nil? or t.types.nil?
+            else
+              match = documentation.match(/@return \[([a-z0-9:_]*)/i)
+              @return_type = match[1] unless match.nil?
+            end
           end
-        end
-      else
-        o = code_object.tag(:overload)
-        if o.nil?
-          r = code_object.tag(:return)
         else
-          r = o.tag(:return)
+          o = code_object.tag(:overload)
+          if o.nil?
+            r = code_object.tag(:return)
+          else
+            r = o.tag(:return)
+          end
+          @return_type = r.types[0] unless r.nil? or r.types.nil?
         end
-        return r.types[0] unless r.nil?
       end
-      nil
+      @return_type
     end
 
     def documentation
@@ -67,6 +69,23 @@ module Solargraph
       @documentation
     end
 
+    def params
+      if @params.nil?
+        @params = []
+        return @params if documentation.nil?
+        param_tags = documentation.tags(:param)
+        unless param_tags.empty?
+          param_tags.each do |t|
+            txt = t.name
+            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 to_json args={}
       obj = {
         label: @label,
@@ -76,6 +95,7 @@ module Solargraph
         path: path,
         location: (@location.nil? ? nil : @location.to_s),
         arguments: @arguments,
+        params: params,
         return_type: return_type,
         documentation: @helper.html_markup_rdoc(documentation.to_s)
       }

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

data/lib/solargraph/yard_map.rb

@@ -1,13 +1,17 @@
 require 'rubygems'
 require 'parser/current'
 require 'yard'
+require 'bundler'
 
 module Solargraph
 
   class YardMap
     autoload :Cache, 'solargraph/yard_map/cache'
 
-    def initialize required: [], workspace: nil
+    attr_reader :workspace
+
+    def initialize required: [], workspace: nil, with_bundled: false
+      @workspace = workspace
       unless workspace.nil?
         wsy = File.join(workspace, '.yardoc')
         yardocs.push wsy if File.exist?(wsy)
@@ -22,16 +26,35 @@ module Solargraph
             if gy.nil?
               STDERR.puts "Required path not found: #{r}"
             else
-              yardocs.push gy
+              STDERR.puts "Adding #{gy}"
+              yardocs.unshift gy
             end
           end
         end
       }
       yardocs.push File.join(Dir.home, '.solargraph', 'cache', '2.0.0', 'yardoc')
       yardocs.uniq!
+      include_bundled_gems if with_bundled
       cache_core
     end
 
+    def include_bundled_gems
+      return if workspace.nil?
+      lockfile = File.join(workspace, 'Gemfile.lock')
+      return unless File.file?(lockfile)
+      parser = Bundler::LockfileParser.new(Bundler.read_file(lockfile))
+      parser.specs.each do |s|
+        STDERR.puts "Specs include #{s.name}"
+        gy = YARD::Registry.yardoc_file_for_gem(s.name)
+        if gy.nil?
+          STDERR.puts "Bundled gem not found: #{s.name}"
+        else
+          yardocs.unshift gy unless yardocs.include?(gy)
+        end
+      end
+    end
+
+    # @return [Array<String>]
     def yardocs
       @yardocs ||= []
     end
@@ -50,6 +73,7 @@ module Solargraph
       end
     end
 
+    # @param query [String]
     def search query
       found = []
       yardocs.each { |y|
@@ -63,6 +87,7 @@ module Solargraph
       found.sort
     end
 
+    # @param query [String]
     def document query
       found = []
       yardocs.each { |y|
@@ -109,6 +134,7 @@ module Solargraph
       result
     end
 
+    # @param signature [String]
     def at signature
       yardocs.each { |y|
         yard = load_yardoc(y)
@@ -120,6 +146,8 @@ module Solargraph
       nil
     end
 
+    # @param signature [String]
+    # @param scope [String]
     def resolve signature, scope
       yardocs.each { |y|
         yard = load_yardoc(y)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-06 00:00:00.000000000 Z
+date: 2017-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser