solargraph 0.16.0 → 0.17.0

data/lib/solargraph/server.rb

@@ -27,25 +27,22 @@ module Solargraph
         Server.prepare_workspace params['workspace']
         { "status" => "ok"}.to_json
       rescue Exception => e
-        STDERR.puts e
-        STDERR.puts e.backtrace.join("\n")
-        { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
+        send_exception e
       end
     end
 
     post '/update' do
       content_type :json
       begin
+        workspace = find_local_workspace(params['filename'], params['workspace'])
         # @type [Solargraph::ApiMap]
-        api_map = get_api_map(params['workspace'])
+        api_map = get_api_map(workspace)
         unless api_map.nil?
           api_map.update params['filename']
         end
         { "status" => "ok"}.to_json
       rescue Exception => e
-        STDERR.puts e
-        STDERR.puts e.backtrace.join("\n")
-        { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
+        send_exception e
       end
     end
 
@@ -53,17 +50,15 @@ module Solargraph
       content_type :json
       begin
         sugg = []
-        workspace = params['workspace']
+        workspace = find_local_workspace(params['filename'], params['workspace'])
         api_map = get_api_map(workspace)
         with_all = params['all'] == '1' ? true : false
         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)
+        sugg = code_map.suggest_at(offset, filtered: true)
         JSON.generate({ "status" => "ok", "suggestions" => sugg.map{|s| s.as_json(all: with_all)} })
       rescue Exception => e
-        STDERR.puts e
-        STDERR.puts e.backtrace.join("\n")
-        { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
+        send_exception e
       end
     end
 
@@ -71,23 +66,21 @@ module Solargraph
       content_type :json
       begin
         sugg = []
-        workspace = params['workspace'] || nil
+        workspace = find_local_workspace(params['filename'], params['workspace'])
         api_map = get_api_map(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.signatures_at(offset)
         { "status" => "ok", "suggestions" => sugg.map{|s| s.as_json(all: true)} }.to_json
       rescue Exception => e
-        STDERR.puts e
-        STDERR.puts e.backtrace.join("\n")
-        { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
+        send_exception e
       end
     end
 
     post '/resolve' do
       content_type :json
       begin
-        workspace = params['workspace'] || nil
+        workspace = find_local_workspace(params['filename'], params['workspace'])
         result = []
         api_map = get_api_map(workspace)
         unless api_map.nil?
@@ -96,26 +89,38 @@ module Solargraph
         end
         { "status" => "ok", "suggestions" => result.map{|s| s.as_json(all: true)} }.to_json
       rescue Exception => e
-        STDERR.puts e
-        STDERR.puts e.backtrace.join("\n")
-        { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
+        send_exception e
+      end
+    end
+
+    post '/define' do
+      content_type :json
+      begin
+        sugg = []
+        workspace = find_local_workspace(params['filename'], params['workspace'])
+        api_map = get_api_map(workspace)
+        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.define_symbol_at(offset)
+        { "status" => "ok", "suggestions" => sugg }.to_json
+      rescue Exception => e
+        send_exception e
       end
     end
 
+    # @deprecated Use /define instead.
     post '/hover' do
       content_type :json
       begin
         sugg = []
-        workspace = params['workspace'] || nil
+        workspace = find_local_workspace(params['filename'], params['workspace'])
         api_map = get_api_map(workspace)
         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.resolve_object_at(offset)
         { "status" => "ok", "suggestions" => sugg }.to_json
       rescue Exception => e
-        STDERR.puts e
-        STDERR.puts e.backtrace.join("\n")
-        { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
+        send_exception e
       end
     end
 
@@ -128,6 +133,7 @@ module Solargraph
 
     get '/document' do
       workspace = params['workspace']
+      workspace.gsub!(/\\/, '/') unless workspace.nil?
       api_map = get_api_map(workspace) || Solargraph::ApiMap.new
       @objects = api_map.document(params['query'])
       erb :document
@@ -161,28 +167,61 @@ module Solargraph
       h.html_markup_ruby(code)
     end
 
+    def send_exception e
+      STDERR.puts e
+      STDERR.puts e.backtrace.join("\n")
+      { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
+    end
+
+    def find_local_workspace file, workspace
+      workspace.gsub!(/\\/, '/') unless workspace.nil?
+      unless file.nil? or workspace.nil?
+        file.gsub!(/\\/, '/') unless file.nil?
+        return nil unless file.start_with?(workspace)
+        dir = File.dirname(file)
+        while dir.start_with?(workspace)
+          return dir if @@api_hash.has_key?(dir)
+          dir = File.dirname(dir)
+        end
+      end
+      workspace
+    end
+
     class << self
       def prepare_workspace directory
+        return if directory.nil?
         Thread.new do
-          api_map = Solargraph::ApiMap.new(directory)
-          api_map.yard_map
-          @@semaphore.synchronize do
-            @@api_hash[directory] = api_map
+          directory.gsub!(/\\/, '/') unless directory.nil?
+          configs = Dir[File.join(directory, '**', '.solargraph.yml')]
+          resolved = []
+          configs.each do |cf|
+            dir = File.dirname(cf)
+            generate_api_map dir
+            resolved.push dir
           end
+          generate_api_map directory unless resolved.include?(directory)
+        end
+      end
+
+      def generate_api_map(directory)
+        api_map = Solargraph::ApiMap.new(directory)
+        api_map.yard_map
+        @@semaphore.synchronize do
+          @@api_hash[directory] = api_map
         end
       end
 
       def run!
         Thread.new do
           while true
-            watch_workspaces
+            check_workspaces
             sleep 1
           end
         end
         super
       end
 
-      def watch_workspaces
+      def check_workspaces
         @@semaphore.synchronize do
           changed = {}
           @@api_hash.each_pair do |w, a|

data/lib/solargraph/shell.rb

@@ -56,7 +56,7 @@ module Solargraph
       begin
         code_map = CodeMap.new(code: text, filename: filename)
         offset = code_map.get_offset(options[:line], options[:column])
-        sugg = code_map.suggest_at(offset, with_snippets: true, filtered: true)
+        sugg = code_map.suggest_at(offset, filtered: true)
         result = { "status" => "ok", "suggestions" => sugg }.to_json
         STDOUT.puts result
       rescue Exception => e

data/lib/solargraph/suggestion.rb

@@ -11,7 +11,6 @@ module Solargraph
     METHOD   = 'Method'
     MODULE   = 'Module'
     PROPERTY = 'Property'
-    SNIPPET  = 'Snippet'
     VARIABLE = 'Variable'
 
     # @return [String]
@@ -65,6 +64,10 @@ module Solargraph
       @path ||= (code_object.nil? ? label : code_object.path)
     end
 
+    def namespace
+      @namespace ||= path.split(/[#\.]/)[0]
+    end
+
     # @return [String]
     def to_s
       label
@@ -114,7 +117,8 @@ module Solargraph
     #
     # @return [Boolean]
     def has_doc?
-      !documentation.empty?
+      #!documentation.empty?
+      !docstring.nil? and !docstring.all.empty?
     end
 
     def as_json args = {}
@@ -142,7 +146,7 @@ module Solargraph
     #
     # @param pin [Solargraph::Pin::Base]
     def self.pull pin, return_type = nil
-      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 || pin.return_type, location: pin.location)
+      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 || pin.return_type, location: pin.location)
     end
   end
 end

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.16.0'
+  VERSION = '0.17.0'
 end

data/lib/solargraph/yard_map/core_docs.rb

@@ -8,7 +8,7 @@ module Solargraph
     module CoreDocs
       class SourceNotAvailableError < StandardError;end
       
-      SOURCE = 'http://solargraph.org/download'
+      SOURCE = 'https://solargraph.org/download'
 
       class << self
         def cache_dir

data/lib/solargraph/yard_map.rb

@@ -1,4 +1,5 @@
 require 'yard'
+require 'bundler'
 
 module Solargraph
   class YardMap
@@ -18,24 +19,17 @@ module Solargraph
 
     def initialize required: [], workspace: nil
       @workspace = workspace
-      used = []
       # HACK: YardMap needs its own copy of this array
       @required = required.clone
       @namespace_yardocs = {}
-      @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
-              yardocs.unshift gy
-              add_gem_dependencies g
-            end
+      if !workspace.nil? and File.exist?(File.join workspace, 'Gemfile')
+        Bundler.with_clean_env do
+          Bundler.environment.chdir(workspace) do
+            process_requires
           end
         end
+      else
+        process_requires
       end
       yardocs.push CoreDocs.yardoc_file
       yardocs.uniq!
@@ -154,11 +148,11 @@ module Solargraph
             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(/=/, ' = ')
+                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)
+                meths.push Suggestion.new(label, insert: n, kind: kind, docstring: m.docstring, code_object: m, detail: "#{ns}", location: object_location(m), arguments: args)
               }
               # Collect superclass methods
               if ns.kind_of?(YARD::CodeObjects::ClassObject) and !ns.superclass.nil?
@@ -172,7 +166,7 @@ module Solargraph
                   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)
+                  meths.push Suggestion.new('new', kind: Suggestion::METHOD, docstring: i.docstring, code_object: i, detail: "#{ns}", location: object_location(i), arguments: args)
                 end
               end
             end
@@ -197,11 +191,13 @@ module Solargraph
             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:')
+                # @todo Return method names like []?
+                #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:')
+                if (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)
+                  meths.push Suggestion.new(label, insert: "#{n.gsub(/=$/, ' = ')}", kind: kind, docstring: m.docstring, code_object: m, detail: m.namespace, location: object_location(m), arguments: args)
                 end
               }
               if ns.kind_of?(YARD::CodeObjects::ClassObject) and namespace != 'Object'
@@ -361,6 +357,53 @@ module Solargraph
       end
     end
 
+    def process_requires
+      used = []
+      @required.each do |r|
+        if workspace.nil? or !File.exist?(File.join workspace, 'lib', "#{r}.rb")
+          unless used.include?(r)
+            used.push r
+            result = find_yardoc(r)
+            if result.nil?
+              STDERR.puts "Required path not found: #{r}"
+            else
+              yardocs.unshift result unless yardocs.include?(result)
+            end
+          end
+        end
+      end
+    end
+
+    def find_yardoc path
+      result = nil
+      spec = Gem::Specification.find_by_path(path)
+      result = YARD::Registry.yardoc_file_for_gem(spec.name) unless spec.nil?
+      if result.nil?
+        $LOAD_PATH.each do |base|
+          source_file = File.join(base, "#{path}.rb")
+          if File.exist?(source_file)
+            if base.start_with?(Bundler.bundle_path.to_s)
+              match = File.dirname(base).split('/').last.match(/^([a-z0-9\-_]*?)-([0-9]+\.[0-9]+\.[0-9]+)/i)
+              unless match.nil? or match[1].nil?
+                result = YARD::Registry.yardoc_file_for_gem(match[1])
+                add_gem_dependencies match[1]
+                break
+              end
+            end
+            yp = File.join(File.dirname(base), '.yardoc')
+            if File.exist?(yp)
+              result = yp
+              break
+            else
+              # @todo Keep trying?
+            end
+            break
+          end
+        end
+      end
+      result
+    end
+
     def add_gem_dependencies gem_name
       spec = Gem::Specification.find_by_name(gem_name)
       (spec.dependencies - spec.development_dependencies).each do |dep|
@@ -368,8 +411,7 @@ module Solargraph
         if gy.nil?
           STDERR.puts "Required path not found: #{dep.name}"
         else
-          #STDERR.puts "Adding #{gy}"
-          yardocs.unshift gy
+          yardocs.unshift gy unless yardocs.include?(gy)
         end
       end
     end
@@ -396,5 +438,14 @@ module Solargraph
       result.push @@stdlib_yardoc if result.empty? and @@stdlib_namespaces.include?(namespace)
       result
     end
+
+    # @param obj [YARD::CodeObjects::Base]
+    def object_location obj
+      # @todo Locations from YardMaps are temporarily disabled pending a
+      # method for resolving the source file's absolute path.
+      return nil
+      return nil if obj.file.nil? or obj.line.nil?
+      "#{obj.file}:#{obj.line - 1}:0"
+    end
   end
 end

data/lib/solargraph.rb

@@ -8,13 +8,13 @@ module Solargraph
   autoload :CodeMap,       'solargraph/code_map'
   autoload :NodeMethods,   'solargraph/node_methods'
   autoload :Suggestion,    'solargraph/suggestion'
-  autoload :Snippets,      'solargraph/snippets'
   autoload :Server,        'solargraph/server'
   autoload :YardMap,       'solargraph/yard_map'
   autoload :Pin,           'solargraph/pin'
   autoload :LiveMap,       'solargraph/live_map'
   autoload :ServerMethods, 'solargraph/server_methods'
   autoload :Plugin,        'solargraph/plugin'
+  autoload :CoreFills,     'solargraph/core_fills'
 
   YARDOC_PATH = File.join(File.realpath(File.dirname(__FILE__)), '..', 'yardoc')
   YARD_EXTENSION_FILE = File.join(File.realpath(File.dirname(__FILE__)), 'yard-solargraph.rb')

data/lib/yard-solargraph.rb

@@ -1,4 +1,6 @@
 require 'yard'
 
-# Define a @type tag to be used for documenting variables
+# Define a @type tag for documenting variables
 YARD::Tags::Library.define_tag("Type", :type, :with_types_and_name)
+# Define a @yieldself tag for documenting block contexts
+YARD::Tags::Library.define_tag("Yieldself", :yieldself, :with_types)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2018-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -170,6 +170,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - bin/solargraph
 - bin/solargraph-runtime
 - lib/solargraph.rb
@@ -179,6 +180,7 @@ files:
 - lib/solargraph/api_map/source.rb
 - lib/solargraph/api_map/source_to_yard.rb
 - lib/solargraph/code_map.rb
+- lib/solargraph/core_fills.rb
 - lib/solargraph/live_map.rb
 - lib/solargraph/live_map/cache.rb
 - lib/solargraph/node_methods.rb
@@ -206,7 +208,6 @@ files:
 - lib/solargraph/server.rb
 - lib/solargraph/server_methods.rb
 - lib/solargraph/shell.rb
-- lib/solargraph/snippets.rb
 - lib/solargraph/suggestion.rb
 - lib/solargraph/version.rb
 - lib/solargraph/views/_method.erb

data/lib/solargraph/snippets.rb

@@ -1,186 +0,0 @@
-require 'json'
-
-module Solargraph
-  module Snippets
-    def self.definitions
-      @definitions ||= JSON.parse('{
-        "Exception block": {
-          "prefix": "begin",
-          "body": [
-            "begin",
-            "\t$1",
-            "rescue => exception",
-            "\t",
-            "end"
-          ]
-        },
-        "Exception block with ensure": {
-          "prefix": "begin ensure",
-          "body": [
-            "begin",
-            "\t$1",
-            "rescue => exception",
-            "\t",
-            "ensure",
-            "\t",
-            "end"
-          ]
-        },
-        "Exception block with else": {
-          "prefix": "begin else",
-          "body": [
-            "begin",
-            "\t$1",
-            "rescue => exception",
-            "\t",
-            "else",
-            "\t",
-            "end"
-          ]
-        },
-        "Exception block with else and ensure": {
-          "prefix": "begin else ensure",
-          "body": [
-            "begin",
-            "\t$1",
-            "rescue => exception",
-            "\t",
-            "else",
-            "\t",
-            "ensure",
-            "\t",
-            "end"
-          ]
-        },
-        "Class definition with initialize": {
-          "prefix": "class init",
-          "body": [
-            "class ${ClassName}",
-            "\tdef initialize",
-            "\t\t$0",
-            "\tend",
-            "end"
-          ]
-        },
-        "Class definition": {
-          "prefix": "class",
-          "body": [
-            "class ${ClassName}",
-            "\t$0",
-            "end"
-          ]
-        },
-        "for loop": {
-          "prefix": "for",
-          "body": [
-            "for ${value} in ${enumerable} do",
-            "\t$0",
-            "end"
-          ]
-        },
-        "if": {
-          "prefix": "if",
-          "body": [
-            "if ${test}",
-            "\t$0",
-            "end"
-          ]
-        },
-        "if else": {
-          "prefix": "if else",
-          "body": [
-            "if ${test}",
-            "\t$0",
-            "else",
-            "\t",
-            "end"
-          ]
-        },
-        "if elsif": {
-          "prefix": "if elsif",
-          "body": [
-            "if ${test}",
-            "\t$0",
-            "elsif ",
-            "\t",
-            "end"
-          ]
-        },
-        "if elsif else": {
-          "prefix": "if elsif else",
-          "body": [
-            "if ${test}",
-            "\t$0",
-            "elsif ",
-            "\t",
-            "else",
-            "\t",
-            "end"
-          ]
-        },
-        "forever loop": {
-          "prefix": "loop",
-          "body": [
-            "loop do",
-            "\t$0",
-            "end"
-          ]
-        },
-        "Module definition": {
-          "prefix": "module",
-          "body": [
-            "module ${ModuleName}",
-            "\t$0",
-            "end"
-          ]
-        },
-        "unless": {
-          "prefix": "unless",
-          "body": [
-            "unless ${test}",
-            "\t$0",
-            "end"
-          ]
-        },
-        "until loop": {
-          "prefix": "until",
-          "body": [
-            "until ${test}",
-            "\t$0",
-            "end"
-          ]
-        },
-        "while loop": {
-          "prefix": "while",
-          "body": [
-            "while ${test}",
-            "\t$0",
-            "end"
-          ]
-        },
-        "method definition": {
-          "prefix": "def",
-          "body": [
-            "def ${method_name}",
-            "\t$0",
-            "end"
-          ],
-          "description": "Snippet for method definitions"
-        },
-        "defined?": {
-          "prefix": "defined?",
-          "body": [
-            "defined?"
-          ],
-          "description": "Something silly"
-        }
-      }')
-    end
-
-    def self.keywords
-      @keywords ||= [
-        'begin', 'class', 'for', 'if', 'module', 'unless', 'until', 'while', 'def', 'defined?'
-      ]
-    end
-  end
-end