solargraph 0.13.3 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 613c6ae706229464a6f918aef5f093a97e0ff569
-  data.tar.gz: b68e4d8abbf2b884d78f9af364e34e5cbcde6f2f
+  metadata.gz: 0d9090bbc3094234313c93d9cbc44461426c9fd8
+  data.tar.gz: 802563c75b5edb831701442e15bb0e7715934b8a
 SHA512:
-  metadata.gz: 843ff75f0ccf680f311a3e42ba4e5ff18810ff1beb048638503c3e7b794883b1bd419c2dd2b6bb3d56bc17a3a06e8e5a7d392f9abf458c57affe0f219ae2ad7a
-  data.tar.gz: a3b5f6d57c62b1d35e940e29b6c8e9b70594a73f1f6f37021a31cfee11eefc3495cb1d09f13de70b1722a9d42bfde9ce827682df898198c6dad5b59918c76419
+  metadata.gz: f6d2eedfd1dafc0c280643b6f21401f61c4dbb2e3cd89273a6cc9892d25528412e04701a2501d63708535d5f2024d7a7b3773185dd03877dd957f938237db7d5
+  data.tar.gz: 4dca225b820a8ac799475936649673cff8f9d20bb389f719568ee9098f85fb68cfef83d215cd8ab2a84225162d1b2619bfffc71417a810ecfb2ac0d7d1975e38

data/bin/solargraph

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift '/home/fred/solargraph-ruby/lib'
 require 'solargraph'
 
 Solargraph::Shell.start(ARGV)

data/bin/solargraph-runtime

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'solargraph/plugin/process'
+
+Solargraph::Plugin::Process.new.run

data/lib/solargraph/api_map/config.rb

@@ -3,23 +3,44 @@ require 'yaml'
 module Solargraph
   class ApiMap
     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
+
       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'] || []
           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
-        @raw_data['extensions'] = @raw_data['extensions'] || []
+        # @todo If the domains config goes stable, add it to @raw_data
       end
 
       def included
@@ -30,10 +51,6 @@ module Solargraph
         process_globs @raw_data['exclude']
       end
 
-      def extensions
-        @raw_data['extensions']
-      end
-
       private
 
       def process_globs globs

data/lib/solargraph/api_map/source.rb

@@ -44,7 +44,7 @@ module Solargraph
                 attribute_pins.push Solargraph::Pin::Directed::Attribute.new(self, k.node, ns, :writer, docstring, "#{d.tag.name}=")
               end
             elsif d.tag.tag_name == 'method'
-              gen_src = Source.virtual(filename, "def #{d.tag.name};end")
+              gen_src = Source.virtual("def #{d.tag.name};end", filename)
               gen_pin = gen_src.method_pins.first
               method_pins.push Solargraph::Pin::Directed::Method.new(gen_src, gen_pin.node, ns, :instance, :public, docstring, gen_pin.name)
             else
@@ -298,17 +298,17 @@ module Solargraph
         # @return [Solargraph::ApiMap::Source]
         def load filename
           code = File.read(filename).gsub(/\r/, '')
-          Source.virtual(filename, code)
+          Source.virtual(code, filename)
         end
 
         # @return [Solargraph::ApiMap::Source]
-        def virtual filename, code
+        def virtual code, filename = nil
           node, comments = Parser::CurrentRuby.parse_with_comments(code)
           Source.new(code, node, comments, filename)
         end
 
         # @return [Solargraph::ApiMap::Source]
-        def fix filename, code, cursor = nil
+        def fix code, filename = nil, cursor = nil
           tries = 0
           code.gsub!(/\r/, '')
           tmp = code

data/lib/solargraph/api_map.rb

@@ -31,9 +31,6 @@ module Solargraph
     # @return [String]
     attr_reader :workspace
 
-    # @return [Array<String>]
-    attr_reader :required
-
     # @param workspace [String]
     def initialize workspace = nil
       @workspace = workspace.gsub(/\\/, '/') unless workspace.nil?
@@ -59,14 +56,19 @@ module Solargraph
       @virtual_source = nil
       @virtual_filename = nil
       @stale = true
-      live_map
       refresh
+      yard_map
     end
 
     def config
       @config ||= ApiMap::Config.new(@workspace)
     end
 
+    # @return [Array<String>]
+    def required
+      @required ||= []
+    end
+
     # @return [Solargraph::YardMap]
     def yard_map
       refresh
@@ -78,24 +80,25 @@ module Solargraph
 
     # @return [Solargraph::LiveMap]
     def live_map
-      @live_map ||= Solargraph::LiveMap.new(workspace)
+      @live_map ||= Solargraph::LiveMap.new(self)
     end
 
     # @return [Solargraph::ApiMap::Source]
-    def virtualize filename, code, cursor = nil
+    def virtualize code, filename = nil, cursor = nil
       unless @virtual_source.nil? or @virtual_filename == filename or @workspace_files.include?(@virtual_filename)
         eliminate @virtual_filename
       end
-      refresh
+      #refresh
       @virtual_filename = filename
-      @virtual_source = Source.fix(filename, code, cursor)
+      @virtual_source = Source.fix(code, filename, cursor)
       process_virtual
+      #@stale = true
       @virtual_source
     end
 
     # @return [Solargraph::ApiMap::Source]
     def append_source code, filename
-      virtualize filename, code
+      virtualize code, filename
     end
 
     def refresh force = false
@@ -133,6 +136,8 @@ module Solargraph
       result = []
       result += inner_namespaces_in(name, root, [])
       result += yard_map.get_constants name, root
+      strings = result.map(&:to_s)
+      result.concat live_map.get_constants(name, root)
       result
     end
 
@@ -152,7 +157,7 @@ module Solargraph
           result.push pin_to_suggestion(pin)
         end
       end
-      result.concat yard_map.get_constants(namespace, root)
+      result.concat yard_map.get_constants(fqns)
     end
 
     # @return [String]
@@ -188,7 +193,11 @@ module Solargraph
           }
         end
       end
-      yard_map.find_fully_qualified_namespace(name, root)
+      result = yard_map.find_fully_qualified_namespace(name, root)
+      if result.nil?
+        result = live_map.get_fqns(name, root)
+      end
+      result
     end
 
     def get_namespace_nodes(fqns)
@@ -354,13 +363,16 @@ module Solargraph
       result
     end
 
-    def get_namespace_type namespace, root = ''
+    def get_namespace_type fqns
+      return nil if fqns.nil?
       type = nil
-      fqns = find_fully_qualified_namespace(namespace, root)
       nodes = get_namespace_nodes(fqns)
       unless nodes.nil? or nodes.empty? or !nodes[0].kind_of?(AST::Node)
         type = nodes[0].type if [:class, :module].include?(nodes[0].type)
       end
+      if type.nil?
+        type = yard_map.get_namespace_type(fqns)
+      end
       type
     end
 
@@ -373,15 +385,16 @@ module Solargraph
       namespace = clean_namespace_string(namespace)
       fqns = find_fully_qualified_namespace(namespace, root)
       meths = []
-      meths.concat inner_get_methods(namespace, root, []) #unless has_yardoc?
-      yard_meths = yard_map.get_methods(namespace, root, visibility: visibility)
+      skip = []
+      meths.concat inner_get_methods(namespace, root, skip)
+      yard_meths = yard_map.get_methods(fqns, '', visibility: visibility)
       if yard_meths.any?
         meths.concat yard_meths
       else
-        type = get_namespace_type(namespace, root)
+        type = get_namespace_type(fqns)
         if type == :class
           meths.concat yard_map.get_instance_methods('Class')
-        elsif type == :module
+        else
           meths.concat yard_map.get_methods('Module')
         end
       end
@@ -395,12 +408,17 @@ module Solargraph
           end
         end
       end
+      if namespace == '' and root == ''
+        config.domains.each do |d|
+          meths.concat get_instance_methods(d)
+        end
+      end
       strings = meths.map(&:to_s)
-      live_map.get_methods(namespace, root, visibility.include?(:private)).each do |m|
+      live_map.get_methods(fqns, '', 'class', visibility.include?(:private)).each do |m|
         next if strings.include?(m) or !m.match(/^[a-z]/i)
-        meths.push Suggestion.new(m, kind: Suggestion::METHOD, docstring: YARD::Docstring.new('(defined at runtime)'))
+        meths.push Suggestion.new(m, kind: Suggestion::METHOD, docstring: YARD::Docstring.new('(defined at runtime)'), path: "#{fqns}.#{m}")
       end
-    meths
+      meths
     end
 
     # Get an array of instance methods that are available in the specified
@@ -420,7 +438,7 @@ module Solargraph
       if yard_meths.any?
         meths.concat yard_meths
       else
-        type = get_namespace_type(namespace, root)
+        type = get_namespace_type(fqns)
         if type == :class
           meths += yard_map.get_instance_methods('Object')
         elsif type == :module
@@ -428,9 +446,9 @@ module Solargraph
         end
       end
       strings = meths.map(&:to_s)
-      live_map.get_instance_methods(namespace, root, visibility.include?(:private)).each do |m|
+      live_map.get_methods(namespace, root, 'instance', visibility.include?(:private)).each do |m|
         next if strings.include?(m) or !m.match(/^[a-z]/i)
-        meths.push Suggestion.new(m, kind: Suggestion::METHOD)
+        meths.push Suggestion.new(m, kind: Suggestion::METHOD, docstring: YARD::Docstring.new('(defined at runtime)'), path: "#{fqns}##{m}")
       end
       meths
     end
@@ -448,8 +466,10 @@ module Solargraph
     end
 
     def update filename
-      @@source_cache[filename] ||= Source.load(filename)
-      #cache.clear
+      filename.gsub!(/\\/, '/')
+      eliminate filename
+      @@source_cache[filename] = Source.load(filename)
+      rebuild_local_yardoc #if @workspace_files.include?(filename)
       @stale = true
     end
 
@@ -467,7 +487,7 @@ module Solargraph
       elsif path.include?('.')
         # It's a class method
         parts = path.split('.')
-        result = get_instance_methods(parts[0], '', visibility: [:public, :private, :protected]).select{|s| s.label == parts[1]}
+        result = get_methods(parts[0], '', visibility: [:public, :private, :protected]).select{|s| s.label == parts[1]}
       else
         # It's a class or module
         get_namespace_nodes(path).each do |node|
@@ -496,19 +516,11 @@ module Solargraph
       @parent_stack = {}
       namespace_map.clear
       namespace_tree.clear
-      @required = []
+      required.clear
     end
 
     def process_maps
-      @sources.clear
-      @workspace_files.each do |f|
-        begin
-          @@source_cache[f] ||= Source.load(f)
-          @sources[f] = @@source_cache[f]
-        rescue
-          STDERR.puts "Failed to load #{f}"
-        end
-      end
+      process_workspace_files
       cache.clear
       @ivar_pins = {}
       @cvar_pins = {}
@@ -537,11 +549,30 @@ module Solargraph
         map_source s
       }
       @required.uniq!
-      #live_map.update self
-      live_map.reload
+      live_map.refresh
       @stale = false
     end
 
+    def rebuild_local_yardoc
+      return if workspace.nil? or !File.exist?(File.join(workspace, '.yardoc'))
+      STDERR.puts "Rebuilding local yardoc for #{workspace}"
+      Dir.chdir(workspace) { Process.spawn('yardoc') }
+    end
+
+    def process_workspace_files
+      @sources.clear
+      @workspace_files.each do |f|
+        if File.file?(f)
+          begin
+            @@source_cache[f] ||= Source.load(f)
+            @sources[f] = @@source_cache[f]
+          rescue
+            STDERR.puts "Failed to load #{f}"
+          end
+        end
+      end
+    end
+
     def process_virtual
       unless @virtual_source.nil?
         cache.clear
@@ -629,9 +660,9 @@ module Solargraph
           meths.concat inner_get_methods(sc, fqns, skip, visibility - [:private])
           meths.concat yard_map.get_methods(sc, fqns, visibility: visibility - [:private])
           strings = meths.map(&:to_s)
-          live_map.get_methods(sc, fqns, false).each do |m|
+          live_map.get_methods(sc, fqns, 'class', false).each do |m|
             next if strings.include?(m) or !m.match(/^[a-z]/i)
-            meths.push Suggestion.new(m, kind: Suggestion::METHOD, docstring: YARD::Docstring.new('(defined at runtime)'))
+            meths.push Suggestion.new(m, kind: Suggestion::METHOD, docstring: YARD::Docstring.new('(defined at runtime)'), path: "#{fqns}##{m}")
           end
         end
       end
@@ -661,7 +692,7 @@ module Solargraph
           meths.concat inner_get_instance_methods(sc, fqns, skip, visibility - [:private])
           meths.concat yard_map.get_instance_methods(sc, fqns, visibility: visibility - [:private])
           strings = meths.map(&:to_s)
-          live_map.get_instance_methods(sc, fqns, false).each do |m|
+          live_map.get_methods(sc, fqns, 'instance', false).each do |m|
             next if strings.include?(m) or !m.match(/^[a-z]/i)
             meths.push Suggestion.new(m, kind: Suggestion::METHOD, docstring: YARD::Docstring.new('(defined at runtime)'))
           end
@@ -690,7 +721,7 @@ module Solargraph
           }
           unless cursor.nil?
             cursor.keys.each { |k|
-              type = get_namespace_type(k, fqns)
+              type = get_namespace_type("#{fqns == '' ? '' : fqns + '::'}#{k}")
               kind = nil
               detail = nil
               if type == :class
@@ -755,10 +786,12 @@ module Solargraph
           visibility = [:public]
           visibility.concat [:private, :protected] if top
           if scope == :instance || namespace == ''
-            meth = get_instance_methods(namespace, visibility: visibility).select{|s| s.label == part}.first
+            tmp = get_instance_methods(namespace, visibility: visibility)
           else
-            meth = get_methods(namespace, visibility: visibility).select{|s| s.label == part}.first            
+            tmp = get_methods(namespace, visibility: visibility)
           end
+          tmp.concat get_instance_methods('Kernel', visibility: [:public]) if top
+          meth = tmp.select{|s| s.label == part}.first
           return nil if meth.nil? or meth.return_type.nil?
           type = meth.return_type
           scope = :instance

data/lib/solargraph/code_map.rb

@@ -37,7 +37,7 @@ module Solargraph
       filename = filename.gsub(File::ALT_SEPARATOR, File::SEPARATOR) unless filename.nil? or File::ALT_SEPARATOR.nil?
       @filename = filename
       @api_map = api_map
-      @source = self.api_map.virtualize filename, code, cursor
+      @source = self.api_map.virtualize code, filename, cursor
       @node = @source.node
       @code = @source.code
       @comments = @source.comments
@@ -229,8 +229,7 @@ module Solargraph
           else
             type = infer_literal_node_type(node_at(index - 2))
             if type.nil?
-              current_namespace = namespace_at(index)
-              parts = current_namespace.to_s.split('::')
+              parts = namespace.to_s.split('::')
               result += get_snippets_at(index) if with_snippets
               result += get_local_variables_and_methods_at(index)
               result += ApiMap.get_keywords
@@ -652,7 +651,7 @@ module Solargraph
       arr = []
       @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)
+        arr.push Suggestion.new(pin.name, kind: Suggestion::VARIABLE, location: pin.location)
       end
       arr
     end

data/lib/solargraph/live_map/cache.rb

@@ -3,7 +3,7 @@ module Solargraph
     class Cache
       def initialize
         @method_cache = {}
-        @instance_method_cache = {}
+        @constant_cache = {}
       end
 
       def get_methods options
@@ -14,17 +14,17 @@ module Solargraph
         @method_cache[options] = values
       end
 
-      def get_instance_methods options
-        @instance_method_cache[options]
+      def get_constants namespace, root
+        @constant_cache[[namespace, root]]
       end
 
-      def set_instance_methods options, values
-        @instance_method_cache[options] = values
+      def set_constants namespace, root, values
+        @constant_cache[[namespace, root]] = values
       end
 
       def clear
         @method_cache.clear
-        @instance_method_cache.clear
+        @constant_cache.clear
       end
     end
   end

data/lib/solargraph/live_map.rb

@@ -2,95 +2,125 @@ module Solargraph
   # The LiveMap allows extensions to add their own completion suggestions.
   #
   class LiveMap
+    autoload :Cache, 'solargraph/live_map/cache'
+
     @@plugins = []
-    
-    attr_reader :workspace
 
-    def initialize workspace
-      @workspace = workspace
-      @runners = []
-      at_exit { stop }
+    # @return [Solargraph::ApiMap]
+    attr_reader :api_map
+
+    def initialize api_map
+      @api_map = api_map
+      runners
     end
 
-    def start
-      unless workspace.nil?
-        @@plugins.each do |p|
-          r = p.new(workspace)
-          r.start
-          @runners.push r
-        end
+    def get_methods(namespace, root = '', scope = 'instance', with_private = false)
+      params = {
+        namespace: namespace, root: root, scope: scope, with_private: with_private
+      }
+      cached = cache.get_methods(params)
+      return cached unless cached.nil?
+      did_runtime = false
+      result = []
+      runners.each do |p|
+        next if did_runtime and p.runtime?
+        result.concat p.get_methods(namespace: namespace, root: root, scope: scope, with_private: with_private)
+        did_runtime = true if p.runtime?
       end
+      cache.set_methods(params, result)
+      result
     end
 
-    def reload
-      restart
+    # @return [Array<Solargraph::Suggestion>]
+    def get_constants(namespace, root = '')
+      cached = cache.get_constants(namespace, root)
+      return cached unless cached.nil?
+      did_runtime = false
+      result = []
+      runners.each do |p|
+        next if did_runtime and p.runtime?
+        result.concat p.get_constants(namespace, root)
+        did_runtime = true if p.runtime?
+      end
+      suggestions = []
+      result.uniq.each do |r|
+        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))
+      end
+      cache.set_constants(namespace, root, suggestions)
+      suggestions
     end
 
-    def restart
-      stop
-      start
+    def get_fqns(namespace, root)
+      did_runtime = false
+      runners.each do |p|
+        next if did_runtime and p.runtime?
+        result = p.get_fqns(namespace, root)
+        return result unless result.nil?
+        did_runtime = true if p.runtime?
+      end
+      nil
     end
 
-    def stop
-      @runners.each do |p|
-        p.stop
-      end
-      @runners.clear
+    # Register a plugin for LiveMap to use when generating suggestions.
+    #
+    # @param cls [Class<Solargraph::Plugin::Base>]
+    def self.install cls
+      @@plugins.push cls unless @@plugins.include?(cls)
     end
 
-    def get_instance_methods(namespace, root = '', with_private = false)
-      result = []
-      @runners.each do |p|
-        resp = p.get_methods(namespace: namespace, root: root, scope: 'instance', with_private: with_private)
-        STDERR.puts resp.message unless resp.ok?
-        result.concat(resp.data)
-      end
-      result
+    def self.uninstall cls
+      @@plugins.delete cls
     end
 
-    def get_methods(namespace, root = '', with_private = false)
-      result = []
-      @runners.each do |p|
-        resp = p.get_methods(namespace: namespace, root: root, scope: 'class', with_private: with_private)
-        STDERR.puts resp.message unless resp.ok?
-        result.concat(resp.data)
-      end
-      result
+    def self.plugins
+      @@plugins.clone
     end
 
-    def self.install cls
-      @@plugins.push cls
+    def refresh
+      changed = false
+      runners.each do |p|
+        changed ||= p.refresh
+      end
+      if changed
+        STDERR.puts "Resetting LiveMap cache"
+        cache.clear
+        get_constants('')
+        get_methods('', '', 'class')
+        get_methods('', '', 'instance')
+        get_methods('Kernel', '', 'class')
+        get_methods('Kernel', '', 'instance')
+      end
     end
 
     private
 
-    def find_constant(namespace, root)
-      result = nil
-      parts = root.split('::')
-      if parts.empty?
-        result = inner_find_constant(namespace)
-      else
-        until parts.empty?
-          result = inner_find_constant("#{parts.join('::')}::#{namespace}")
-          break unless result.nil?
-          parts.pop
-        end
-      end
-      result
+    # @return [Solargraph::LiveMap::Cache]
+    def cache
+      @cache ||= Solargraph::LiveMap::Cache.new
     end
 
-    def inner_find_constant(namespace)
-      cursor = Object
-      parts = namespace.split('::')
-      until parts.empty?
-        here = parts.shift
-        begin
-          cursor = cursor.const_get(here)
-        rescue NameError
-          return nil
-        end
+    # @return [Array<Solargraph::Plugin::Base>]
+    def runners
+      @runners ||= load_runners
+    end
+
+    # @return [Array<Solargraph::Plugin::Base>]
+    def load_runners
+      result = []
+      has_runtime = false
+      @@plugins.each do |p|
+        r = p.new(api_map)
+        result.push r if !has_runtime or !r.runtime?
+        has_runtime = true if r.runtime?
       end
-      cursor
+      result.push Solargraph::Plugin::Runtime.new(api_map) unless has_runtime
+      result
     end
   end
 end

data/lib/solargraph/pin/base.rb

@@ -60,6 +60,10 @@ module Solargraph
       def filename
         source.filename
       end
+
+      def location
+        "#{source.filename}:#{node.location.expression.begin_pos}"
+      end
     end
   end
 end