solargraph 0.14.2 → 0.14.3

data/lib/solargraph/api_map/config.rb

@@ -5,50 +5,65 @@ module Solargraph
     class Config
       # @return [String]
       attr_reader :workspace
-      attr_reader :raw_data
-
-      # @return [Array<String>]
-      attr_reader :included
-
-      # @return [Array<String>]
-      attr_reader :excluded
 
-      # @return [Array<String>]
-      attr_reader :domains
+      # @return [Hash]
+      attr_reader :raw_data
 
       def initialize workspace = nil
         @workspace = workspace
         include_globs = ['**/*.rb']
         exclude_globs = ['spec/**/*', 'test/**/*']
-        @included = []
-        @excluded = []
-        @domains = []
         unless @workspace.nil?
-          include_globs = ['**/*.rb']
-          exclude_globs = ['spec/**/*', 'test/**/*']
           sfile = File.join(@workspace, '.solargraph.yml')
           if File.file?(sfile)
-            @raw_data = YAML.load(File.read(sfile))
-            conf = YAML.load(File.read(sfile))
-            include_globs = conf['include'] || include_globs
-            exclude_globs = conf['exclude'] || []
-            @domains = conf['domains'] || []
+            begin
+              @raw_data = YAML.load(File.read(sfile))
+              conf = YAML.load(File.read(sfile))
+              include_globs = conf['include'] || include_globs
+              exclude_globs = conf['exclude'] || []
+            rescue Exception => e
+              STDERR.puts "Unable to read .solargraph.yml: #{e.class} #{e.message}"
+              @raw_data = {}
+            end
           end
-          @included.concat process_globs(include_globs)
-          @excluded.concat process_globs(exclude_globs)
         end
         @raw_data ||= {}
-        @raw_data['include'] = @raw_data['include'] || include_globs
-        @raw_data['exclude'] = @raw_data['exclude'] || exclude_globs
-        # @todo If the domains config goes stable, add it to @raw_data
+        @raw_data['include'] ||= include_globs
+        @raw_data['exclude'] ||= exclude_globs
+        @raw_data['domains'] ||= []
+        @raw_data['required'] ||= []
       end
 
+      # An array of files included in the workspace (before calculating excluded files).
+      #
+      # @return [Array<String>]
       def included
-        process_globs @raw_data['include']
+        return [] if workspace.nil?
+        @included ||= process_globs(@raw_data['include'])
       end
 
+      # An array of files excluded from the workspace.
+      # 
+      # @return [Array<String>]
       def excluded
-        process_globs @raw_data['exclude']
+        return [] if workspace.nil?
+        @excluded ||= process_globs(@raw_data['exclude'])
+      end
+
+      # The calculated array of (included - excluded) files in the workspace.
+      #
+      # @return [Array<String>]
+      def calculated
+        @calculated ||= (included - excluded)
+      end
+
+      # @return [Array<String>]
+      def domains
+        raw_data['domains']
+      end
+
+      def required
+        raw_data['required']
       end
 
       private

data/lib/solargraph/api_map/source.rb

@@ -70,46 +70,63 @@ module Solargraph
         @superclasses ||= {}
       end
 
+      # @return [Array<Solargraph::Pin::Method>]
       def method_pins
         @method_pins ||= []
       end
 
+      # @return [Array<Solargraph::Pin::Attribute>]
       def attribute_pins
         @attribute_pins ||= []
       end
 
+      # @return [Array<Solargraph::Pin::InstanceVariable>]
       def instance_variable_pins
         @instance_variable_pins ||= []
       end
 
+      # @return [Array<Solargraph::Pin::ClassVariable>]
       def class_variable_pins
         @class_variable_pins ||= []
       end
 
+      # @return [Array<Solargraph::Pin::LocalVariable>]
       def local_variable_pins
         @local_variable_pins ||= []
       end
 
+      # @return [Array<Solargraph::Pin::GlobalVariable>]
       def global_variable_pins
         @global_variable_pins ||= []
       end
 
+      # @return [Array<Solargraph::Pin::Constant>]
       def constant_pins
         @constant_pins ||= []
       end
 
+      # @return [Array<Solargraph::Pin::Symbol>]
       def symbol_pins
         @symbol_pins ||= []
       end
 
+      # @return [Array<Solargraph::Pin::Namespace>]
+      def namespace_pins
+        @namespace_pins ||= []
+      end
+
+      # @return [Array<String>]
       def required
         @required ||= []
       end
 
+      # @return [YARD::Docstring]
       def docstring_for node
-        @docstring_hash[node.loc]
+        return @docstring_hash[node.loc] if node.respond_to?(:loc)
+        nil
       end
 
+      # @return [String]
       def code_for node
         b = node.location.expression.begin.begin_pos
         e = node.location.expression.end.end_pos
@@ -121,6 +138,7 @@ module Solargraph
         @node_tree[node] || []
       end
 
+      # @return [String]
       def namespace_for node
         parts = []
         ([node] + (@node_tree[node] || [])).each do |n|
@@ -188,6 +206,7 @@ module Solargraph
             fqn = tree.join('::')
             @namespace_nodes[fqn] ||= []
             @namespace_nodes[fqn].push node
+            namespace_pins.push Solargraph::Pin::Namespace.new(self, node, tree[0..-2].join('::') || '')
             if node.type == :class and !node.children[1].nil?
               sc = unpack_name(node.children[1])
               superclasses[fqn] = sc
@@ -205,6 +224,7 @@ module Solargraph
                   unless ora.nil?
                     u = c.updated(:ivasgn, c.children + ora.children[1..-1], nil)
                     @node_tree[u] = @node_stack.clone
+                    @docstring_hash[u.loc] = docstring_for(ora)
                     instance_variable_pins.push Solargraph::Pin::InstanceVariable.new(self, u, fqn || '', local_scope)
                   end
                 else
@@ -216,6 +236,7 @@ module Solargraph
                   unless ora.nil?
                     u = c.updated(:cvasgn, c.children + ora.children[1..-1], nil)
                     @node_tree[u] = @node_stack.clone
+                    @docstring_hash[u.loc] = docstring_for(ora)
                     class_variable_pins.push Solargraph::Pin::ClassVariable.new(self, u, fqn || '')
                   end
                 else
@@ -241,38 +262,34 @@ module Solargraph
               elsif c.type == :casgn
                 constant_pins.push Solargraph::Pin::Constant.new(self, c, fqn)
               else
-                #unless fqn.nil?
-                  if c.kind_of?(AST::Node)
-                    if c.type == :def and c.children[0].to_s[0].match(/[a-z]/i)
-                      method_pins.push Solargraph::Pin::Method.new(source, c, fqn || '', scope, visibility)
-                      #inner_map_node c, tree, visibility, scope, fqn, stack
-                      #next
-                    elsif c.type == :defs
-                      method_pins.push Solargraph::Pin::Method.new(source, c, fqn || '', :class, :public)
-                      inner_map_node c, tree, :public, :class, fqn, stack
-                      next
-                    elsif c.type == :send and [:public, :protected, :private].include?(c.children[1])
-                      visibility = c.children[1]
-                    elsif c.type == :send and c.children[1] == :include #and node.type == :class
-                      namespace_includes[fqn] ||= []
-                      c.children[2..-1].each do |i|
-                        namespace_includes[fqn].push unpack_name(i)
+                if c.kind_of?(AST::Node)
+                  if c.type == :def and c.children[0].to_s[0].match(/[a-z]/i)
+                    method_pins.push Solargraph::Pin::Method.new(source, c, fqn || '', scope, visibility)
+                  elsif c.type == :defs
+                    method_pins.push Solargraph::Pin::Method.new(source, c, fqn || '', :class, :public)
+                    inner_map_node c, tree, :public, :class, fqn, stack
+                    next
+                  elsif c.type == :send and [:public, :protected, :private].include?(c.children[1])
+                    visibility = c.children[1]
+                  elsif c.type == :send and c.children[1] == :include #and node.type == :class
+                    namespace_includes[fqn] ||= []
+                    c.children[2..-1].each do |i|
+                      namespace_includes[fqn].push unpack_name(i)
+                    end
+                  elsif c.type == :send and [:attr_reader, :attr_writer, :attr_accessor].include?(c.children[1])
+                    c.children[2..-1].each do |a|
+                      if c.children[1] == :attr_reader or c.children[1] == :attr_accessor
+                        attribute_pins.push Solargraph::Pin::Attribute.new(self, a, fqn || '', :reader, docstring_for(c)) #AttrPin.new(c)
                       end
-                    elsif c.type == :send and [:attr_reader, :attr_writer, :attr_accessor].include?(c.children[1])
-                      c.children[2..-1].each do |a|
-                        if c.children[1] == :attr_reader or c.children[1] == :attr_accessor
-                          attribute_pins.push Solargraph::Pin::Attribute.new(self, a, fqn || '', :reader, docstring_for(c)) #AttrPin.new(c)
-                        end
-                        if c.children[1] == :attr_writer or c.children[1] == :attr_accessor
-                          attribute_pins.push Solargraph::Pin::Attribute.new(self, a, fqn || '', :writer, docstring_for(c)) #AttrPin.new(c)
-                        end
+                      if c.children[1] == :attr_writer or c.children[1] == :attr_accessor
+                        attribute_pins.push Solargraph::Pin::Attribute.new(self, a, fqn || '', :writer, docstring_for(c)) #AttrPin.new(c)
                       end
-                    elsif c.type == :sclass and c.children[0].type == :self
-                      inner_map_node c, tree, :public, :class, fqn || '', stack
-                      next
                     end
+                  elsif c.type == :sclass and c.children[0].type == :self
+                    inner_map_node c, tree, :public, :class, fqn || '', stack
+                    next
                   end
-                #end
+                end
                 if c.type == :send and c.children[1] == :require
                   if c.children[2].kind_of?(AST::Node) and c.children[2].type == :str
                     required.push c.children[2].children[0].to_s
@@ -316,8 +333,8 @@ module Solargraph
           fixed_cursor = false
           begin
             # HACK: The current file is parsed with a trailing underscore to fix
-            # incomplete trees resulting from short scripts (e.g., a lone variable
-            # assignment).
+            # incomplete trees resulting from short scripts (e.g., an unfinished
+            # variable assignment).
             node, comments = Parser::CurrentRuby.parse_with_comments(tmp + "\n_")
             Source.new(code, node, comments, filename)
           rescue Parser::SyntaxError => e

data/lib/solargraph/code_map.rb

@@ -25,6 +25,7 @@ module Solargraph
 
     # The root directory of the project. The ApiMap will search here for
     # additional files to parse and analyze.
+    # @deprecated CodeMap will be server-agnostic in a future version.
     #
     # @return [String]
     attr_reader :workspace
@@ -32,6 +33,7 @@ module Solargraph
     include NodeMethods
 
     def initialize code: '', filename: nil, workspace: nil, api_map: nil, cursor: nil
+      STDERR.puts "WARNING: the `workspace` parameter in Solargraph::CodeMap#new is deprecated and will be removed in a future version." unless workspace.nil?
       @workspace = workspace
       # HACK: Adjust incoming filename's path separator for yardoc file comparisons
       filename = filename.gsub(File::ALT_SEPARATOR, File::SEPARATOR) unless filename.nil? or File::ALT_SEPARATOR.nil?
@@ -225,7 +227,7 @@ module Solargraph
           if signature.include?('::')
             parts = signature.split('::', -1)
             ns = parts[0..-2].join('::')
-            result = api_map.namespaces_in(ns, namespace)
+            result = api_map.get_constants(ns, namespace)
           else
             type = infer_literal_node_type(node_at(index - 2))
             if type.nil?
@@ -235,10 +237,10 @@ module Solargraph
               result += ApiMap.get_keywords
               while parts.length > 0
                 ns = parts.join('::')
-                result += api_map.namespaces_in(ns, namespace)
+                result += api_map.get_constants(ns, namespace)
                 parts.pop
               end
-              result += api_map.namespaces_in('')
+              result += api_map.get_constants('')
               result += api_map.get_instance_methods('Kernel')
               result += api_map.get_methods('')
               result += api_map.get_instance_methods('')
@@ -434,8 +436,9 @@ module Solargraph
         return type unless type.nil?
       else
         # Signature starts with a local variable
-        type = get_type_comment(var)
-        type = infer_literal_node_type(var.children[1]) if type.nil?
+        type = nil
+        lvp = source.local_variable_pins.select{|p| p.name == var.children[0].to_s and p.visible_from?(node) and (!p.nil_assignment? or p.return_type)}.first
+        type = lvp.return_type unless lvp.nil?
         if type.nil?
           vsig = resolve_node_signature(var.children[1])
           type = infer_signature_from_node vsig, node
@@ -458,16 +461,6 @@ module Solargraph
       inferred
     end
 
-    def get_type_comment node
-      obj = nil
-      cmnt = @source.docstring_for(node)
-      unless cmnt.nil?
-        tag = cmnt.tag(:type)
-        obj = tag.types[0] unless tag.nil? or tag.types.empty?
-      end
-      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:
@@ -513,7 +506,6 @@ module Solargraph
     def get_local_variables_and_methods_at(index)
       result = []
       local = parent_node_from(index, :class, :module, :def, :defs) || @node
-      #result += get_local_variables_from(local)
       result += get_local_variables_from(node_at(index))
       scope = namespace_at(index) || @node
       if local.type == :def
@@ -580,7 +572,7 @@ module Solargraph
     def get_method_arguments_from node
       return [] unless node.type == :def or node.type == :defs
       param_hash = {}
-      cmnt = api_map.get_comment_for(node)
+      cmnt = api_map.get_docstring_for(node)
       unless cmnt.nil?
         tags = cmnt.tags(:param)
         tags.each do |tag|
@@ -649,9 +641,20 @@ module Solargraph
       node ||= @node
       namespace = namespace_from(node)
       arr = []
+      nil_pins = []
+      val_names = []
       @source.local_variable_pins.select{|p| p.visible_from?(node) }.each do |pin|
-        #arr.push Suggestion.new(pin.name, kind: Suggestion::VARIABLE, return_type: api_map.infer_assignment_node_type(pin.node, namespace))
-        arr.push Suggestion.new(pin.name, kind: Suggestion::VARIABLE, location: pin.location)
+        if pin.nil_assignment? and pin.return_type.nil?
+          nil_pins.push pin
+        else
+          unless val_names.include?(pin.name)
+            arr.push Suggestion.pull(pin)
+            val_names.push pin.name
+          end
+        end
+      end
+      nil_pins.reject{|p| val_names.include?(p.name)}.each do |pin|
+        arr.push Suggestion.pull(pin)
       end
       arr
     end

data/lib/solargraph/live_map.rb

@@ -44,13 +44,14 @@ module Solargraph
       end
       suggestions = []
       result.uniq.each do |r|
+        path = (r['namespace'].empty? ? '' : "#{r['namespace']}::") + r['name']
         kind = Suggestion::CONSTANT
         if r['class'] == 'Class'
           kind = Suggestion::CLASS
         elsif r['class'] == 'Module'
           kind = Suggestion::MODULE
         end
-        suggestions.push(Suggestion.new(r['name'], kind: kind))
+        suggestions.push(Suggestion.new(r['name'], kind: kind, path: path))
       end
       cache.set_constants(namespace, root, suggestions)
       suggestions

data/lib/solargraph/pin.rb

@@ -1,15 +1,16 @@
 module Solargraph
   module Pin
-    autoload :Base, 'solargraph/pin/base'
-    autoload :Method, 'solargraph/pin/method'
-    autoload :Attribute, 'solargraph/pin/attribute'
-    autoload :BaseVariable, 'solargraph/pin/base_variable'
+    autoload :Base,             'solargraph/pin/base'
+    autoload :Method,           'solargraph/pin/method'
+    autoload :Attribute,        'solargraph/pin/attribute'
+    autoload :BaseVariable,     'solargraph/pin/base_variable'
     autoload :InstanceVariable, 'solargraph/pin/instance_variable'
-    autoload :ClassVariable, 'solargraph/pin/class_variable'
-    autoload :LocalVariable, 'solargraph/pin/local_variable'
-    autoload :GlobalVariable, 'solargraph/pin/global_variable'
-    autoload :Constant, 'solargraph/pin/constant'
-    autoload :Symbol, 'solargraph/pin/symbol'
-    autoload :Directed, 'solargraph/pin/directed'
+    autoload :ClassVariable,    'solargraph/pin/class_variable'
+    autoload :LocalVariable,    'solargraph/pin/local_variable'
+    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'
   end
 end

data/lib/solargraph/pin/base_variable.rb

@@ -19,6 +19,10 @@ module Solargraph
         @return_type ||= literal_from_assignment
       end
 
+      def nil_assignment?
+        node.children[(node.type == :casgn ? 2 : 1)].type == :nil
+      end
+
       def signature
         @signature ||= resolve_node_signature(node.children[(node.type == :casgn ? 2 : 1)])
       end

data/lib/solargraph/pin/namespace.rb

@@ -0,0 +1,23 @@
+module Solargraph
+  module Pin
+    class Namespace < Pin::Base
+      include Solargraph::NodeMethods
+
+      def name
+        @name ||= pack_name(node.children[0]).last.to_s
+      end
+
+      def path
+        @path ||= (namespace.empty? ? '' : "#{namespace}::") + name
+      end
+
+      def kind
+        @kind ||= (node.type == :class ? Solargraph::Suggestion::CLASS : Solargraph::Suggestion::MODULE)
+      end
+
+      def return_type
+        @return_type ||= (node.type == :class ? 'Class' : 'Module') + "<#{path}>"
+      end
+    end
+  end
+end

data/lib/solargraph/plugin/process.rb

@@ -32,6 +32,8 @@ module Solargraph
             end
           rescue JSON::ParserError => e
             STDOUT.puts respond_err "Error parsing input: #{e.message}"
+          rescue Exception => e
+            STDOUT.puts respond_err "Error processing input: #{e.message}"
           end
           STDOUT.flush
         end
@@ -63,15 +65,15 @@ module Solargraph
         unless con.nil?
           if (args['scope'] == 'class')
             if args['with_private']
-              result.concat con.methods
+              result.concat con.methods(false)
             else
-              result.concat con.public_methods
+              result.concat con.public_methods(false)
             end
           elsif (args['scope'] == 'instance')
             if args['with_private']
-              result.concat con.instance_methods
+              result.concat con.instance_methods(false)
             else
-              result.concat con.public_instance_methods
+              result.concat con.public_instance_methods(false)
             end
           end
         end
@@ -85,8 +87,8 @@ module Solargraph
           #result.concat con.constants
           con.constants.each do |c|
             next if c == :Solargraph and !@required.include?('solargraph')
-            item = { name: c }
             here = con.const_get(c)
+            item = { namespace: con.to_s, name: c.to_s }
             item[:class] = here.class.to_s
             result.push item
           end