solargraph 0.13.0 → 0.13.1

data/lib/solargraph/server.rb

@@ -1,12 +1,13 @@
 require 'sinatra/base'
 require 'thread'
 require 'yard'
+require 'puma'
 
 module Solargraph
   class Server < Sinatra::Base
 
     set :port, 7657
-    set :server, :webrick
+    set :server, :puma
 
     @@api_hash = {}
     @@semaphore = Mutex.new
@@ -42,11 +43,13 @@ module Solargraph
       begin
         sugg = []
         workspace = params['workspace']
+        api_map = nil
         @@semaphore.synchronize {
-          code_map = CodeMap.new(code: params['text'], filename: params['filename'], api_map: @@api_hash[workspace], cursor: [params['line'].to_i, params['column'].to_i])
-          offset = code_map.get_offset(params['line'].to_i, params['column'].to_i)
-          sugg = code_map.suggest_at(offset, with_snippets: params['with_snippets'] == '1' ? true : false, filtered: (params['filtered'] || false))
+          api_map = @@api_hash[workspace]
         }
+        code_map = CodeMap.new(code: params['text'], filename: params['filename'], api_map: api_map, cursor: [params['line'].to_i, params['column'].to_i])
+        offset = code_map.get_offset(params['line'].to_i, params['column'].to_i)
+        sugg = code_map.suggest_at(offset, with_snippets: params['with_snippets'] == '1' ? true : false, filtered: true)
         { "status" => "ok", "suggestions" => sugg }.to_json
       rescue Exception => e
         STDERR.puts e
@@ -130,14 +133,15 @@ module Solargraph
     end
 
     class << self
-      def run!
-        super
-      end
+      #def run!
+      #  super
+      #end
 
       def prepare_workspace directory
         Thread.new do
           @@semaphore.synchronize do
             api_map = Solargraph::ApiMap.new(directory)
+            api_map.yard_map
             @@api_hash[directory] = api_map
           end
         end

data/lib/solargraph/shell.rb

@@ -4,6 +4,7 @@ require 'fileutils'
 require 'rubygems/package'
 require 'zlib'
 require 'net/http'
+require 'socket'
 
 module Solargraph
   class Shell < Thor
@@ -54,10 +55,14 @@ module Solargraph
     option :views, type: :string, aliases: :v, desc: 'The view template directory', default: nil
     option :files, type: :string, aliases: :f, desc: 'The public files directory', default: nil
     def server
-      Solargraph::Server.set :port, options[:port]
+      port = options[:port]
+      port = available_port if port.zero?
+      Solargraph::Server.set :port, port
       Solargraph::Server.set :views, options[:views] unless options[:views].nil?
       Solargraph::Server.set :public_folder, options[:files] unless options[:files].nil?
-      Solargraph::Server.run!
+      Solargraph::Server.run! do
+        STDERR.puts "Solargraph server pid=#{Process.pid} port=#{port}"
+      end
     end
     
     desc 'suggest', 'Get code suggestions for the provided input'
@@ -98,5 +103,15 @@ module Solargraph
       end
       STDOUT.puts "Configuration file initialized."
     end
+
+    private
+
+    def available_port
+      socket = Socket.new(:INET, :STREAM, 0)
+      socket.bind(Addrinfo.tcp("127.0.0.1", 0))
+      port = socket.local_address.ip_port
+      socket.close
+      port
+    end
   end
 end

data/lib/solargraph/suggestion.rb

@@ -3,74 +3,86 @@ require 'json'
 module Solargraph
 
   class Suggestion
-    CLASS = 'Class'
+    CLASS =    'Class'
     CONSTANT = 'Constant'
-    KEYWORD = 'Keyword'
-    MODULE = 'Module'
-    METHOD = 'Method'
-    VARIABLE = 'Variable'
+    FIELD =    'Field'
+    KEYWORD =  'Keyword'
+    METHOD =   'Method'
+    MODULE =   'Module'
     PROPERTY = 'Property'
-    FIELD = 'Field'
-    SNIPPET = 'Snippet'
+    SNIPPET =  'Snippet'
+    VARIABLE = 'Variable'
+
+    # @return [String]
+    attr_reader :label
+
+    # @return [String]
+    attr_reader :kind
+
+    # @return [String]
+    attr_reader :insert
+
+    # @return [String]
+    attr_reader :detail
+
+    # @return [YARD::CodeObjects::Base]
+    attr_reader :code_object
+
+    # @return [String]
+    attr_reader :location
 
-    attr_reader :label, :kind, :insert, :detail, :documentation, :code_object, :location, :arguments
+    # @return [Array<String>]
+    attr_reader :arguments
 
-    def initialize label, kind: KEYWORD, insert: nil, detail: nil, documentation: nil, code_object: nil, location: nil, arguments: [], return_type: nil, path: nil
+    def initialize label, kind: KEYWORD, insert: nil, detail: nil, docstring: nil, code_object: nil, location: nil, arguments: [], return_type: nil, path: nil
       @helper = Server::Helpers.new
       @label = label.to_s
       @kind = kind
       @insert = insert || @label
       @detail = detail
       @code_object = code_object
-      @documentation = documentation
+      @docstring = docstring
       @location = location
       @arguments = arguments
       @return_type = return_type
       @path = path
     end
-    
+
+    # @return [String]
     def path
       @path ||= (code_object.nil? ? label : code_object.path)
     end
 
+    # @return [String]
     def to_s
       label
     end
 
+    # @return [String]
     def return_type
-      if @return_type.nil?
-        if code_object.nil?
-          if documentation.kind_of?(YARD::Docstring)
-            t = documentation.tag(:return)
-            @return_type = t.types[0] unless t.nil? or t.types.nil?
-          end
-        else
-          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
+      if @return_type.nil? and !docstring.nil?
+        t = docstring.tag(:overload)&.tag(:return) || docstring.tag(:return)
+        @return_type = t.types[0] unless t.nil? or t.types.nil?
       end
       @return_type
     end
 
+    # @return [YARD::Docstring]
+    def docstring
+      @docstring ||= @code_object&.docstring
+    end
+
+    # @return [String]
     def documentation
-      if @documentation.nil?
-        unless @code_object.nil? or @code_object.docstring.nil?
-          @documentation = @code_object.docstring
-        end
-      end
-      @documentation
+      @documentation ||= (docstring.nil? ? '' : @helper.html_markup_rdoc(docstring))
     end
 
+    # @return [Array<String>]
     def params
       if @params.nil?
         @params = []
-        return @params if documentation.nil?
-        param_tags = documentation.tags(:param)
+        return @params if docstring.nil?
+        param_tags = docstring.tags(:param)
         unless param_tags.empty?
           param_tags.each do |t|
             txt = t.name.to_s
@@ -94,13 +106,13 @@ module Solargraph
         arguments: @arguments,
         params: params,
         return_type: return_type,
-        documentation: documentation.nil? ? nil : @helper.html_markup_rdoc(documentation)
+        documentation: documentation
       }
       obj.to_json(args)
     end
 
     def self.pull pin, return_type = nil
-      Suggestion.new(pin.name, insert: pin.name.gsub(/=/, ' = '), kind: pin.kind, documentation: pin.docstring, detail: pin.namespace, arguments: pin.parameters, path: pin.path, return_type: return_type)
+      Suggestion.new(pin.name, insert: pin.name.gsub(/=/, ' = '), kind: pin.kind, docstring: pin.docstring, detail: pin.namespace, arguments: pin.parameters, path: pin.path, return_type: return_type)
     end
   end
 

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.13.0'
+  VERSION = '0.13.1'
 end

data/lib/solargraph/yard_map/cache.rb

@@ -15,7 +15,7 @@ module Solargraph
     end
 
     def set_methods namespace, scope, visibility, suggestions
-      @methods[[namespace, scope, visibility]] = suggestions
+      @methods[[namespace, scope, visibility]] = suggestions.uniq{|s| s.path}
     end
 
     def get_methods namespace, scope, visibility
@@ -23,7 +23,7 @@ module Solargraph
     end
 
     def set_instance_methods namespace, scope, visibility, suggestions
-      @instance_methods[[namespace, scope, visibility]] = suggestions
+      @instance_methods[[namespace, scope, visibility]] = suggestions.uniq{|s| s.path}
     end
 
     def get_instance_methods namespace, scope, visibility

data/lib/solargraph/yard_map.rb

@@ -1,5 +1,6 @@
 require 'parser/current'
 require 'yard'
+require 'bundler'
 
 module Solargraph
 
@@ -7,32 +8,43 @@ module Solargraph
     autoload :Cache, 'solargraph/yard_map/cache'
 
     attr_reader :workspace
+    attr_reader :required
 
     def initialize required: [], workspace: nil
       @workspace = workspace
-      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")
-          g = r.split('/').first
-          unless used.include?(g)
-            used.push g
-            gy = YARD::Registry.yardoc_file_for_gem(g)
-            if gy.nil?
-              STDERR.puts "Required path not found: #{r}"
-            else
-              STDERR.puts "Adding #{gy}"
-              yardocs.unshift gy
+      @required = required
+      @namespace_yardocs = {}
+      if @required.include?('bundler/setup')
+        yardocs.concat bundled_gem_yardocs
+      else
+        @required.each do |r|
+          if workspace.nil? or !File.exist?(File.join workspace, 'lib', "#{r}.rb")
+            g = r.split('/').first
+            unless used.include?(g)
+              used.push g
+              gy = YARD::Registry.yardoc_file_for_gem(g)
+              if gy.nil?
+                STDERR.puts "Required path not found: #{r}"
+              else
+                STDERR.puts "Adding #{gy}"
+                yardocs.unshift gy
+                add_gem_dependencies g
+              end
             end
           end
         end
-      }
+      end
       yardocs.push File.join(Dir.home, '.solargraph', 'cache', '2.0.0', 'yardoc')
       yardocs.uniq!
-      cache_core
+      yardocs.each do |y|
+        load_yardoc y
+        YARD::Registry.all(:class, :module).each do |ns|
+          @namespace_yardocs[ns.path] ||= []
+          @namespace_yardocs[ns.path].push y
+        end
+      end
+      #cache_core
     end
 
     # @return [Array<String>]
@@ -82,23 +94,20 @@ module Solargraph
     end
 
     # @return [Array<Suggestion>]
-    def get_constants namespace, scope = ''
+    def get_constants namespace , scope = ''
       cached = cache.get_constants(namespace, scope)
       return cached unless cached.nil?
       consts = []
       result = []
-      yardocs.each { |y|
-        yard = load_yardoc(y)
-        unless yard.nil?
-          ns = nil
-          if scope == ''
-            ns = yard.at(namespace)
-          else
-            ns = yard.resolve(P(scope), namespace)
+      combined_namespaces(namespace, scope).each do |ns|
+        yardocs_documenting(ns).each do |y|
+          yard = load_yardoc(y)
+          unless yard.nil?
+            found = yard.at(ns)
+            consts.concat found.children unless found.nil?
           end
-          consts += ns.children unless ns.nil?
         end
-      }
+      end
       consts.each { |c|
         detail = nil
         kind = nil
@@ -114,7 +123,7 @@ module Solargraph
         else
           next
         end
-        result.push Suggestion.new(c.to_s.split('::').last, detail: detail, kind: kind, documentation: c.docstring)
+        result.push Suggestion.new(c.to_s.split('::').last, detail: detail, kind: kind, docstring: c.docstring)
       }
       cache.set_constants(namespace, scope, result)
       result
@@ -125,48 +134,39 @@ module Solargraph
       cached = cache.get_methods(namespace, scope, visibility)
       return cached unless cached.nil?
       meths = []
-      binds = []
-      yardocs.each { |y|
-        yard = load_yardoc(y)
-        unless yard.nil?
-          ns = nil
-          ns = find_first_resolved_namespace(yard, namespace, scope)
-          if namespace == '' and scope == ''
-            # Check for a bind tag in the yardoc root. If it exists, treat
-            # workspace code as a DSL that uses public instance methods in the
-            # specified namespaces.
-            b = yard.root.tag(:bind)
-            binds.concat b.types unless b.nil?
-          end
-          unless ns.nil?
-            ns.meths(scope: :class, visibility: visibility).each { |m|
-              n = m.to_s.split(/[\.#]/).last.gsub(/=/, ' = ')
-              label = "#{n}"
-              args = get_method_args(m)
-              kind = (m.is_attribute? ? Suggestion::FIELD : Suggestion::METHOD)
-              meths.push Suggestion.new(label, insert: "#{n.gsub(/=/, ' = ')}", kind: kind, documentation: m.docstring, code_object: m, detail: "#{ns}", location: "#{m.file}:#{m.line}", arguments: args)
-            }
-            # Collect superclass methods
-            if ns.kind_of?(YARD::CodeObjects::ClassObject) and !ns.superclass.nil?
-              meths += get_methods ns.superclass.to_s, '', visibility: [:public, :protected] unless ['Object', 'BasicObject', ''].include?(ns.superclass.to_s)
-            end
-            if ns.kind_of?(YARD::CodeObjects::ClassObject) and namespace != 'Class'
-              meths += get_instance_methods('Class')
-              yard = load_yardoc(y)
-              i = yard.at("#{ns}#initialize")
-              unless i.nil?
-                meths.delete_if{|m| m.label == 'new'}
-                label = "#{i}"
-                args = get_method_args(i)
-                meths.push Suggestion.new('new', kind: Suggestion::METHOD, documentation: i.docstring, code_object: i, detail: "#{ns}", location: "#{i.file}:#{i.line}", arguments: args)
+      combined_namespaces(namespace, scope).each do |ns|
+        yardocs_documenting(ns).each do |y|
+          yard = load_yardoc(y)
+          unless yard.nil?
+            ns = nil
+            ns = find_first_resolved_namespace(yard, namespace, scope)
+            unless ns.nil?
+              ns.meths(scope: :class, visibility: visibility).each { |m|
+                n = m.to_s.split(/[\.#]/).last.gsub(/=/, ' = ')
+                label = "#{n}"
+                args = get_method_args(m)
+                kind = (m.is_attribute? ? Suggestion::FIELD : Suggestion::METHOD)
+                meths.push Suggestion.new(label, insert: "#{n.gsub(/=/, ' = ')}", kind: kind, docstring: m.docstring, code_object: m, detail: "#{ns}", location: "#{m.file}:#{m.line}", arguments: args)
+              }
+              # Collect superclass methods
+              if ns.kind_of?(YARD::CodeObjects::ClassObject) and !ns.superclass.nil?
+                meths += get_methods ns.superclass.to_s, '', visibility: [:public, :protected] unless ['Object', 'BasicObject', ''].include?(ns.superclass.to_s)
+              end
+              if ns.kind_of?(YARD::CodeObjects::ClassObject) and namespace != 'Class'
+                meths += get_instance_methods('Class')
+                yard = load_yardoc(y)
+                i = yard.at("#{ns}#initialize")
+                unless i.nil?
+                  meths.delete_if{|m| m.label == 'new'}
+                  label = "#{i}"
+                  args = get_method_args(i)
+                  meths.push Suggestion.new('new', kind: Suggestion::METHOD, docstring: i.docstring, code_object: i, detail: "#{ns}", location: "#{i.file}:#{i.line}", arguments: args)
+                end
               end
             end
           end
         end
-      }
-      binds.each { |b|
-        meths += get_instance_methods(b, scope, visibility: [:public])
-      }
+      end
       cache.set_methods(namespace, scope, visibility, meths)
       meths
     end
@@ -176,32 +176,34 @@ module Solargraph
       cached = cache.get_instance_methods(namespace, scope, visibility)
       return cached unless cached.nil?
       meths = []
-      yardocs.each { |y|
-        yard = load_yardoc(y)
-        unless yard.nil?
-          ns = nil
-          ns = find_first_resolved_namespace(yard, namespace, scope)
-          unless ns.nil?
-            ns.meths(scope: :instance, visibility: visibility).each { |m|
-              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}"
-                args = get_method_args(m)
-                kind = (m.is_attribute? ? Suggestion::FIELD : Suggestion::METHOD)
-                meths.push Suggestion.new(label, insert: "#{n.gsub(/=/, ' = ')}", kind: kind, documentation: m.docstring, code_object: m, detail: m.namespace, location: "#{m.file}:#{m.line}", arguments: args)
+      combined_namespaces(namespace, scope).each do |ns|
+        yardocs_documenting(ns).each do |y|
+          yard = load_yardoc(y)
+          unless yard.nil?
+            ns = nil
+            ns = find_first_resolved_namespace(yard, namespace, scope)
+            unless ns.nil?
+              ns.meths(scope: :instance, visibility: visibility).each { |m|
+                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}"
+                  args = get_method_args(m)
+                  kind = (m.is_attribute? ? Suggestion::FIELD : Suggestion::METHOD)
+                  meths.push Suggestion.new(label, insert: "#{n.gsub(/=/, ' = ')}", kind: kind, docstring: m.docstring, code_object: m, detail: m.namespace, location: "#{m.file}:#{m.line}", arguments: args)
+                end
+              }
+              if ns.kind_of?(YARD::CodeObjects::ClassObject) and namespace != 'Object'
+                unless ns.nil?
+                  meths += get_instance_methods(ns.superclass.to_s)
+                end
               end
-            }
-            if ns.kind_of?(YARD::CodeObjects::ClassObject) and namespace != 'Object'
-              unless ns.nil?
-                meths += get_instance_methods(ns.superclass.to_s)
+              ns.instance_mixins.each do |m|
+                meths += get_instance_methods(m.to_s) unless m.to_s == 'Kernel'
               end
             end
-            ns.instance_mixins.each do |m|
-              meths += get_instance_methods(m.to_s) unless m.to_s == 'Kernel'
-            end
           end
         end
-      }
+      end
       cache.set_instance_methods(namespace, scope, visibility, meths)
       meths
     end
@@ -232,10 +234,10 @@ module Solargraph
             obj = yard.at(parts[0])
             unless obj.nil?
               meths = obj.meths(scope: [:instance]).keep_if{|m| m.name.to_s == parts[1]}
-              meths.each { |m|
+              meths.each do |m|
                 args = get_method_args(m)
                 result.push Solargraph::Suggestion.new(m.name, kind: 'Method', detail: m.path, code_object: m, arguments: args)
-              }
+              end
             end
           else
             unless obj.nil?
@@ -250,6 +252,25 @@ module Solargraph
       result
     end
 
+    def bundled_gem_yardocs
+      result = []
+      unless workspace.nil?
+        gl = File.join(workspace, 'Gemfile.lock')
+        if File.file?(gl)
+          lockfile = Bundler::LockfileParser.new(Bundler.read_file(gl))
+          lockfile.specs.each do |s|
+            y = YARD::Registry.yardoc_file_for_gem(s.name, s.version.to_s)
+            if y.nil?
+              STDERR.puts "Bundled gem not found: #{s.name} #{s.version}"
+            else
+              result.push y
+            end
+          end
+        end
+      end
+      result.uniq
+    end
+
     private
 
     def cache
@@ -296,6 +317,40 @@ module Solargraph
         nil
       end
     end
-  end
 
+    def add_gem_dependencies gem_name
+      spec = Gem::Specification.find_by_name(gem_name)
+      spec.nondevelopment_dependencies.each do |dep|
+        gy = YARD::Registry.yardoc_file_for_gem(dep.name)
+        if gy.nil?
+          STDERR.puts "Required path not found: #{r}"
+        else
+          STDERR.puts "Adding #{gy}"
+          yardocs.unshift gy
+        end
+      end
+    end
+
+    def combined_namespaces namespace, scope = ''
+      combined = [namespace]
+      unless scope.empty?
+        parts = scope.split('::')
+        until parts.empty?
+          combined.unshift parts.join('::') + '::' + namespace
+          parts.pop
+        end
+      end
+      combined
+    end
+
+    def yardocs_documenting namespace
+      result = []
+      if namespace == ''
+        result.concat yardocs
+      else
+        result.concat @namespace_yardocs[namespace] unless @namespace_yardocs[namespace].nil?
+      end
+      result
+    end
+  end
 end

data/lib/yard-solargraph.rb

@@ -1,27 +1,4 @@
 require 'yard'
-require 'yard/handlers/ruby/base'
-
-class YardHandlerExtension < YARD::Handlers::Ruby::HandlesExtension
-  def matches? node
-    if node.docstring and node.docstring.include?(name)
-      true
-    else
-      false
-    end
-  end
-end
-
-class MyHandler < YARD::Handlers::Ruby::CommentHandler
-  handles YardHandlerExtension.new("@bind")
-
-  process do
-    if owner.type == :root
-      d = YARD::Docstring.new(statement.docstring)
-      owner.add_tag d.tag(:bind)
-    end
-  end
-end
 
 # Define a @type tag to be used for documenting variables
 YARD::Tags::Library.define_tag("Type", :type, :with_types_and_name)
-YARD::Tags::Library.define_tag("Bind", :bind, :with_types)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.13.1
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-04 00:00:00.000000000 Z
+date: 2017-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -72,6 +72,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -169,7 +197,9 @@ files:
 - lib/solargraph/pin/base_variable.rb
 - lib/solargraph/pin/class_variable.rb
 - lib/solargraph/pin/constant.rb
+- lib/solargraph/pin/global_variable.rb
 - lib/solargraph/pin/instance_variable.rb
+- lib/solargraph/pin/local_variable.rb
 - lib/solargraph/pin/method.rb
 - lib/solargraph/pin/symbol.rb
 - lib/solargraph/server.rb