solargraph 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b294bc8ca569c676481b4ae6e7278a751efb3948
-  data.tar.gz: 362d7969bffa45dcc69750cdd5ad0ce2553e896c
+  metadata.gz: 41e2a41af1ef29061e085cd34a1666aa8e962327
+  data.tar.gz: 8f785cd7a3a8113b47633c07e5b3816f028e1618
 SHA512:
-  metadata.gz: d194a846f91e5d8ac0f148068a7d95816675ba8d2a8a086546ebb84cf742ff7934ee4151086ffa19e24a083bde32072314ef987b363404f4207110198ef48950
-  data.tar.gz: 1bec252ba431ee8489f931195c9d9527985ca261596d99fe07b549d5e94bfa43e82ebf87669230ad9ed2688022af704e62ef1be28b59717e8f1e55459b1f99d5
+  metadata.gz: adcca5889793480021d29af723d2d83062b5578ccf083f36555b6bd311d620981d671999c6df52a57618a22fa18842ac7d5b0dacb3fd7880efd38c27a2752456
+  data.tar.gz: 630beb7fabb5a5c7d59ab30da28f72863f36d1111eca3f7a4b6f65e5d2cd91d3573f495b669964e77e02bac67ae95bb741b9f37a6ac08f109c00e3f2812f594c

data/lib/solargraph/api_map.rb

@@ -89,32 +89,6 @@ module Solargraph
       root
     end
 
-    def associate_comments node, comments
-      comment_hash = Parser::Source::Comment.associate_locations(node, comments)
-      yard_hash = {}
-      comment_hash.each_pair { |k, v|
-        ctxt = ''
-        num = nil
-        started = false
-        v.each { |l|
-          # Trim the comment and minimum leading whitespace
-          p = l.text.gsub(/^#/, '')
-          if num.nil? and !p.strip.empty?
-            num = p.index(/[^ ]/)
-            started = true
-          elsif started and !p.strip.empty?
-            cur = p.index(/[^ ]/)
-            num = cur if cur < num
-          end
-          if started
-            ctxt += "#{p[num..-1]}\n"
-          end
-        }
-        yard_hash[k] = YARD::Docstring.parser.parse(ctxt).to_docstring
-      }
-      yard_hash
-    end
-
     def get_comment_for node
       filename = get_filename_for(node)
       return nil if @file_comments[filename].nil?
@@ -378,6 +352,7 @@ module Solargraph
     #
     # @return [Array<Solargraph::Suggestion>]
     def get_methods(namespace, root = '', visibility: [:public])
+      namespace = clean_namespace_string(namespace)
       meths = []
       meths += inner_get_methods(namespace, root, []) #unless has_yardoc?
       yard_meths = yard_map.get_methods(namespace, root, visibility: visibility)
@@ -423,6 +398,7 @@ module Solargraph
     #
     # @return [Array<Solargraph::Suggestion>]
     def get_instance_methods(namespace, root = '', visibility: [:public])
+      namespace = clean_namespace_string(namespace)
       if namespace.end_with?('#class')
         return get_methods(namespace.split('#').first, root, visibility: visibility)
       end
@@ -498,6 +474,32 @@ module Solargraph
 
     private
 
+    def associate_comments node, comments
+      comment_hash = Parser::Source::Comment.associate_locations(node, comments)
+      yard_hash = {}
+      comment_hash.each_pair { |k, v|
+        ctxt = ''
+        num = nil
+        started = false
+        v.each { |l|
+          # Trim the comment and minimum leading whitespace
+          p = l.text.gsub(/^#/, '')
+          if num.nil? and !p.strip.empty?
+            num = p.index(/[^ ]/)
+            started = true
+          elsif started and !p.strip.empty?
+            cur = p.index(/[^ ]/)
+            num = cur if cur < num
+          end
+          if started
+            ctxt += "#{p[num..-1]}\n"
+          end
+        }
+        yard_hash[k] = YARD::Docstring.parser.parse(ctxt).to_docstring
+      }
+      yard_hash
+    end
+
     def inner_get_methods(namespace, root = '', skip = [])
       meths = []
       return meths if skip.include?(namespace)
@@ -850,5 +852,9 @@ module Solargraph
       e = node.location.expression.end.end_pos
       src[b..e].strip.gsub(/,$/, '')
     end
+
+    def clean_namespace_string namespace
+      namespace.to_s.gsub(/<.*$/, '')
+    end
   end
 end

data/lib/solargraph/code_map.rb

@@ -59,6 +59,8 @@ module Solargraph
       end
     end
 
+    # Get the ApiMap that was generated for this CodeMap.
+    #
     # @return [Solargraph::ApiMap]
     def api_map
       @api_map ||= ApiMap.new(workspace)
@@ -69,6 +71,8 @@ module Solargraph
     # cursor's location in the code when generating suggestions.
     # The line and column numbers should start at zero.
     #
+    # @param line [Integer]
+    # @param col [Integer]
     # @return [Integer]
     def get_offset line, col
       offset = 0
@@ -80,6 +84,11 @@ module Solargraph
       offset + col
     end
 
+    # Get an array of nodes containing the specified index, starting with the
+    # topmost node and ending with the nearest.
+    #
+    # @param index [Integer]
+    # @return [Array<AST::Node>]
     def tree_at(index)
       arr = []
       arr.push @node
@@ -87,6 +96,10 @@ module Solargraph
       arr
     end
 
+    # Get the nearest node that contains the specified index.
+    #
+    # @param index [Integer]
+    # @return [AST::Node]
     def node_at(index)
       tree_at(index).first
     end
@@ -109,6 +122,12 @@ module Solargraph
       false
     end
 
+    # Find the nearest parent node from the specified index. If one or more
+    # types are provided, find the nearest node whose type is in the list.
+    #
+    # @param index [Integer]
+    # @param types [Array<Symbol>]
+    # @return [AST::Node]
     def parent_node_from(index, *types)
       arr = tree_at(index)
       arr.each { |a|
@@ -151,6 +170,12 @@ module Solargraph
       end
     end
 
+    # Select the phrase that directly precedes the specified index.
+    # A phrase can consist of most types of characters other than whitespace,
+    # semi-colons, equal signs, parentheses, or brackets.
+    #
+    # @param index [Integer]
+    # @return [String]
     def phrase_at index
       word = ''
       cursor = index - 1
@@ -164,6 +189,11 @@ module Solargraph
       word
     end
 
+    # Select the word that directly precedes the specified index.
+    # A word can only consist of letters, numbers, and underscores.
+    #
+    # @param index [Integer]
+    # @return [String]
     def word_at index
       word = ''
       cursor = index - 1
@@ -289,19 +319,47 @@ module Solargraph
       return api_map.yard_map.objects(path, ns_here)
     end
 
+    # Infer the type of the signature located at the specified index.
+    #
+    # @example
+    #   # Given the following code:
+    #   nums = [1, 2, 3]
+    #   nums.join
+    #   # ...and given an index that points at the end of "nums.join",
+    #   # infer_signature_at will identify nums as an Array and the return
+    #   # type of Array#join as a String, so the signature's type will be
+    #   # String.
+    #
+    # @return [String]
     def infer_signature_at index
       signature = get_signature_at(index)
       node = parent_node_from(index, :class, :module, :def, :defs) || @node
       result = infer_signature_from_node signature, node
       if result.nil? or result.empty?
-        # Check for yieldparams
-        parts = signature.split('.', 2)
-        yp = get_yieldparams_at(index).keep_if{|s| s.to_s == parts[0]}.first
-        unless yp.nil?
-          if parts[1].nil? or parts[1].empty?
-            result = yp.return_type
-          else
-            result = api_map.infer_signature_type(parts[1], yp.return_type, scope: :instance)
+        arg = nil
+        if node.type == :def or node.type == :defs or node.type == :block
+          # Check for method arguments
+          parts = signature.split('.', 2)
+          # @type [Solargraph::Suggestion]
+          arg = get_method_arguments_from(node).keep_if{|s| s.to_s == parts[0] }.first
+          unless arg.nil?
+            if parts[1].nil?
+              result = arg.return_type
+            else
+              result = api_map.infer_signature_type(parts[1], parts[0], :instance)
+            end
+          end
+        end
+        if arg.nil?
+          # Check for yieldparams
+          parts = signature.split('.', 2)
+          yp = get_yieldparams_at(index).keep_if{|s| s.to_s == parts[0]}.first
+          unless yp.nil?
+            if parts[1].nil? or parts[1].empty?
+              result = yp.return_type
+            else
+              result = api_map.infer_signature_type(parts[1], yp.return_type, scope: :instance)
+            end
           end
         end
       end
@@ -367,11 +425,11 @@ module Solargraph
     # 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
+    #   Code                  Signature
+    #   -----------------------------------------
+    #   String.new            String.new
+    #   @x.bar                @x.bar
+    #   y.split(', ').length  y.split.length
     #
     # @param index [Integer]
     # @return [String]
@@ -447,6 +505,7 @@ module Solargraph
     # Get an array of local variables and methods that can be accessed from
     # the specified location in the code.
     #
+    # @param index [Integer]
     # @return [Array<Solargraph::Suggestion>]
     def get_local_variables_and_methods_at(index)
       result = []
@@ -468,7 +527,13 @@ module Solargraph
 
     private
 
+    # Get a node's arguments as an array of suggestions. The node's type must
+    # be a method (:def or :defs).
+    #
+    # @param node [AST::Node]
+    # @return [Array<Suggestion>]
     def get_method_arguments_from node
+      return [] unless node.type == :def or node.type == :defs
       param_hash = {}
       cmnt = api_map.get_comment_for(node)
       unless cmnt.nil?

data/lib/solargraph/suggestion.rb

@@ -77,7 +77,7 @@ module Solargraph
         param_tags = documentation.tags(:param)
         unless param_tags.empty?
           param_tags.each do |t|
-            txt = t.name
+            txt = t.name.to_s
             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

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.10.0'
+  VERSION = '0.10.1'
 end

data/lib/solargraph/yard_map.rb

@@ -314,11 +314,13 @@ module Solargraph
     end
 
     def find_first_resolved_namespace yard, namespace, scope
-      parts = scope.split('::')
-      while parts.length > 0
-        ns = yard.resolve(P(parts.join('::')), namespace, true)
-        return ns unless ns.nil?
-        parts.pop
+      unless scope.nil?
+        parts = scope.split('::')
+        while parts.length > 0
+          ns = yard.resolve(P(parts.join('::')), namespace, true)
+          return ns unless ns.nil?
+          parts.pop
+        end
       end
       yard.at(namespace)
     end

metadata

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