solargraph 0.19.1 → 0.20.0

data/lib/solargraph/language_server/message.rb

@@ -63,6 +63,8 @@ module Solargraph
       register '$/cancelRequest',                  CancelRequest
       register '$/solargraph/document',            Extended::Document
       register '$/solargraph/search',              Extended::Search
+      register '$/solargraph/checkGemVersion',     Extended::CheckGemVersion
+      register '$/solargraph/documentGems',        Extended::DocumentGems
       register 'shutdown',                         Shutdown
       register 'exit',                             ExitNotification
     end

data/lib/solargraph/language_server/message/base.rb

@@ -16,7 +16,7 @@ module Solargraph
           @id = request['id'].freeze
           @request = request.freeze
           @method = request['method'].freeze
-          @params = request['params'].freeze
+          @params = (request['params'] || {}).freeze
           post_initialize
         end
 

data/lib/solargraph/language_server/message/extended.rb

@@ -9,6 +9,8 @@ module Solargraph
       module Extended
         autoload :Document, 'solargraph/language_server/message/extended/document'
         autoload :Search, 'solargraph/language_server/message/extended/search'
+        autoload :CheckGemVersion, 'solargraph/language_server/message/extended/check_gem_version'
+        autoload :DocumentGems, 'solargraph/language_server/message/extended/document_gems'
       end
     end
   end

data/lib/solargraph/language_server/message/extended/check_gem_version.rb

@@ -0,0 +1,38 @@
+require 'open3'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        # Check if a more recent version of the Solargraph gem is available.
+        # Notify the client when an update exists. If the `verbose` parameter
+        # is true, notify the client when the gem is up to date.
+        #
+        class CheckGemVersion < Base
+          def process
+            o, s = Open3.capture2("gem search solargraph")
+            match = o.match(/solargraph \([0-9\.]*?\)/)
+            # @todo Error if no match or status code != 0
+            available = Gem::Version.new(match[1])
+            current = Gem::Version.new(Solargraph::VERSION)
+            if available > current
+              host.show_message_request "Solagraph gem version #{available} is available.",
+                                        LanguageServer::MessageTypes::INFO,
+                                        ['Update now'] do |result|
+                                          break unless result == 'Update now'
+                                          o, s = Open3.capture2("gem update solargraph")
+                                          if s == 0
+                                            host.show_message 'Successfully updated the Solargraph gem.', LanguageServer::MessageTypes::INFO
+                                          else
+                                            host.show_message 'An error occurred while updating the gem.', LanguageServer::MessageTypes::ERROR
+                                          end
+                                        end
+            elsif params['verbose']
+              host.show_message "The Solargraph gem is up to date (version #{Solargraph::VERSION})."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/extended/document_gems.rb

@@ -0,0 +1,23 @@
+require 'open3'
+
+module Solargraph
+  module LanguageServer
+    module Message
+      module Extended
+        # Update YARD documentation for installed gems. If the `rebuild`
+        # parameter is true, rebuild existing yardocs.
+        #
+        class DocumentGems < Base
+          def process
+            cmd = "yard gems"
+            cmd += " --rebuild" if params['rebuild']
+            o, s = Open3.capture2(cmd)
+            if s != 0
+              host.show_message "An error occurred while building gem documentation.", LanguageServer::MessageTypes::ERROR
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/message/text_document/on_type_formatting.rb

@@ -4,12 +4,10 @@ module Solargraph
       module TextDocument
         class OnTypeFormatting < Base
           def process
-            # @todo Temporarily disabled
-            set_result nil
-            return
-            src = host.library.checkout(uri_to_file(params['textDocument']['uri']))
-            offset = src.get_offset(params['position']['line'], params['position']['character'])
-            if src.string_at?(offset-1) and params['ch'] == '{' and src.code[offset-2,2] == '#{'
+            src = host.send(:library).checkout(uri_to_file(params['textDocument']['uri']))
+            fragment = src.fragment_at(params['position']['line'], params['position']['character'] - 1)
+            offset = fragment.send(:offset)
+            if fragment.string? and params['ch'] == '{' and src.code[offset-1,2] == '#{'
               set_result(
                 [
                   {
@@ -22,7 +20,8 @@ module Solargraph
                 ]
               )
             else
-              set_result []
+              # @todo Is `nil` or `[]` more appropriate here?
+              set_result nil
             end
           end
         end

data/lib/solargraph/language_server/request.rb

@@ -0,0 +1,14 @@
+module Solargraph
+  module LanguageServer
+    class Request
+      def initialize id, &block
+        @id = id
+        @block = block
+      end
+
+      def process result
+        @block.call(result)
+      end
+    end
+  end
+end

data/lib/solargraph/library.rb

@@ -31,7 +31,16 @@ module Solargraph
       source_hash.has_key? filename
     end
 
-    # Create a file source to be added to the workspace. The source is ignored
+    # True if the specified file is included in the workspace (but not
+    # necessarily open).
+    #
+    # @param filename [String]
+    # @return [Boolean]
+    def contain? filename
+      workspace.has_file?(filename)
+    end
+
+    # Create a file source to be added to the workspace. The file is ignored
     # if the workspace is not configured to include the file.
     #
     # @param filename [String]
@@ -45,12 +54,18 @@ module Solargraph
       true
     end
 
+    # Create a file source from a file on disk. The file is ignored if the
+    # workspace is not configured to include the file.
+    #
+    # @param filename [String]
+    # @return [Boolean] True if the file was added to the workspace.
     def create_from_disk filename
-      return if File.directory?(filename) or !File.exist?(filename)
-      return unless workspace.would_merge?(filename)
+      return false if File.directory?(filename) or !File.exist?(filename)
+      return false unless workspace.would_merge?(filename)
       source = Solargraph::Source.load_string(File.read(filename), filename)
       workspace.merge(source)
       api_map.refresh
+      true
     end
 
     # Delete a file from the library. Deleting a file will make it unavailable
@@ -198,6 +213,24 @@ module Solargraph
       source.code
     end
 
+    # Get diagnostics about a file.
+    #
+    # @return [Array<Hash>]
+    def diagnose filename
+      # @todo Only open files get diagnosed. Determine whether anything or
+      #   everything in the workspace should get diagnosed, or if there should
+      #   be an option to do so.
+      return [] unless open?(filename)
+      result = []
+      source = read(filename)
+      workspace.config.reporters.each do |name|
+        reporter = Diagnostics::REPORTERS[name]
+        raise DiagnosticsError, "Diagnostics reporter #{name} does not exist" if reporter.nil?
+        result.concat reporter.new.diagnose(source, api_map)
+      end
+      result
+    end
+
     # Create a library from a directory.
     #
     # @param directory [String] The path to be used for the workspace
@@ -223,6 +256,7 @@ module Solargraph
       @workspace
     end
 
+    # @raise [FileNotFoundError] if the file is not open
     # @param filename [String]
     # @return [Solargraph::Source]
     def read filename

data/lib/solargraph/page.rb

@@ -1,21 +1,11 @@
 require 'ostruct'
 require 'tilt'
-require 'redcarpet'
+require 'kramdown'
 require 'htmlentities'
 require 'coderay'
 
 module Solargraph
   class Page
-    class SolargraphRenderer < Redcarpet::Render::HTML
-      def normal_text text
-        HTMLEntities.new.encode(text, :named)
-      end
-      def block_code code, language
-        CodeRay.scan(code, language || :ruby).div
-      end
-    end
-    private_constant :SolargraphRenderer
-
     class Binder < OpenStruct
       def initialize locals, render_method
         super(locals)
@@ -31,8 +21,17 @@ module Solargraph
         helper = Solargraph::Pin::Helper.new
         html = helper.html_markup_rdoc(text)
         conv = ReverseMarkdown.convert(html, github_flavored: true)
-        markdown = Redcarpet::Markdown.new(SolargraphRenderer.new(prettify: true), fenced_code_blocks: true)
-        markdown.render(conv)
+        Kramdown::Document.new(
+          conv,
+          input: 'GFM',
+          entity_output: :symbolic,
+          syntax_highlighter_opts: {
+            block: {
+              line_numbers: false,
+            },
+            default_lang: :ruby
+          },
+        ).to_html
       end
 
       def ruby_to_html code

data/lib/solargraph/pin/helper.rb

@@ -1,6 +1,4 @@
 require 'yard'
-require 'yard/templates/helpers/markup_helper'
-require 'yard/templates/helpers/html_helper'
 
 module Solargraph
   module Pin
@@ -18,10 +16,18 @@ module Solargraph
         '.'
       end
 
+      def html_markup_rdoc(text)
+        # @todo The :rdoc markup class might not be immediately available.
+        #   If not, return nil for now under the assumption that the problem
+        #   will eventually fix itself.
+        return nil if markup_class(:rdoc).nil?
+        super
+      end
+
       def options
         if @options.nil?
           @options = YARD::Templates::TemplateOptions.new
-          @options.type = :rdoc
+          @options[:type] = :rdoc
         end
         @options
       end

data/lib/solargraph/pin/localized.rb

@@ -2,10 +2,17 @@ module Solargraph
   module Pin
     module Localized
       attr_reader :block
+
+      # @return [Source::Range]
       attr_reader :presence
 
-      def visible_from?(block, position)
-        self.block == block and presence.contain?(position)
+      # @param other [Pin::Block] The caller's block
+      # @param position [Source::Position] The caller's position
+      # @return [Boolean]
+      def visible_from?(other, position)
+        other.filename == filename and
+          (other == block or other.named_context == named_context) and
+          presence.contain?(position)
       end
     end
   end

data/lib/solargraph/pin/yard_object.rb

@@ -71,14 +71,13 @@ module Solargraph
       end
 
       def location
-        # @todo Get the location
         @location
       end
 
       def path
         code_object.path
       end
-      
+
       def namespace
         # @todo Is this right?
         code_object.namespace.to_s
@@ -111,7 +110,7 @@ module Solargraph
           args.push p
         }
         args
-      end  
+      end
     end
   end
 end

data/lib/solargraph/shell.rb

@@ -54,6 +54,7 @@ module Solargraph
           EventMachine.stop
         end
         EventMachine.start_server options[:host], port, Solargraph::LanguageServer::Transport::Socket
+        # Emitted for the benefit of clients that start the process on port 0
         STDERR.puts "Solargraph is listening PORT=#{port} PID=#{Process.pid}"
       end
     end
@@ -132,5 +133,10 @@ module Solargraph
     def clear_cores
       Solargraph::YardMap::CoreDocs.clear
     end
+
+    desc 'reporters', 'Get a list of diagnostics reporters'
+    def reporters
+      puts Solargraph::Diagnostics::REPORTERS.keys.sort
+    end
   end
 end

data/lib/solargraph/source.rb

@@ -44,6 +44,8 @@ module Solargraph
 
     attr_reader :requires
 
+    attr_reader :domains
+
     attr_reader :locals
 
     include NodeMethods
@@ -282,7 +284,8 @@ module Solargraph
 
     def all_symbols
       result = []
-      result.concat namespace_pin_map.values.flatten
+      # result.concat namespace_pin_map.values.flatten
+      result.concat namespace_pins.reject{ |pin| pin.name.empty? }
       result.concat method_pins
       result.concat constant_pins
       result
@@ -339,7 +342,7 @@ module Solargraph
     end
 
     def process_parsed node, comments
-      @pins, @locals, @requires, @symbols, @path_macros = Mapper.map filename, code, node, comments
+      @pins, @locals, @requires, @symbols, @path_macros, @domains = Mapper.map filename, code, node, comments
       @stime = Time.now
     end
 

data/lib/solargraph/source/fragment.rb

@@ -9,6 +9,8 @@ module Solargraph
 
       attr_reader :column
 
+      attr_reader :source
+
       # @param source [Solargraph::Source]
       # @param line [Integer]
       # @param column [Integer]
@@ -216,10 +218,16 @@ module Solargraph
         @locals ||= @source.locals.select{|pin| pin.visible_from?(block, position)}
       end
 
+      # True if the fragment is a signature that stems from a literal value.
+      #
+      # @return [Boolean]
       def base_literal?
         !base_literal.nil?
       end
 
+      # The type of literal value at the root of the signature (or nil).
+      #
+      # @return [String]
       def base_literal
         if @base_literal.nil? and !@calculated_literal
           @calculated_literal = true

data/lib/solargraph/source/mapper.rb

@@ -19,6 +19,7 @@ module Solargraph
         # @todo Stuff that needs to be resolved
         @variables = []
         @path_macros = {}
+        @domains = []
 
         @pins = []
         @requires = []
@@ -32,7 +33,7 @@ module Solargraph
         @pins.push Pin::Namespace.new(get_node_location(nil), '', '', nil, :class, :public, nil)
         process root
         process_directives
-        [@pins, @locals, @requires, @symbols, @path_macros]
+        [@pins, @locals, @requires, @symbols, @path_macros, @domains]
       end
 
       class << self
@@ -231,7 +232,8 @@ module Solargraph
                 next
               elsif c.type == :send and c.children[1] == :require
                 if c.children[2].kind_of?(AST::Node) and c.children[2].type == :str
-                  @requires.push c.children[2].children[0].to_s
+                  # @requires.push c.children[2].children[0].to_s
+                  @requires.push Solargraph::Pin::Reference.new(get_node_location(c), fqn, c.children[2].children[0].to_s)
                 end
               elsif c.type == :args
                 if @node_stack.first.type == :block
@@ -263,15 +265,6 @@ module Solargraph
         stack.pop
       end
 
-      # def path_for node
-      #   path = namespace_for(node) || ''
-      #   mp = (method_pins + attribute_pins).select{|p| p.node == node}.first
-      #   unless mp.nil?
-      #     path += (mp.scope == :instance ? '#' : '.') + mp.name
-      #   end
-      #   path
-      # end
-  
       def get_last_in_stack_not_begin stack
         index = stack.length - 1
         last = stack[index]
@@ -379,6 +372,8 @@ module Solargraph
               here = get_node_start_position(k.node)
               pin = @pins.select{|pin| [Pin::NAMESPACE, Pin::METHOD].include?(pin.kind) and pin.location.range.contain?(here)}.first
               @path_macros[pin.path] = v
+            elsif d.tag.tag_name == 'domain'
+              @domains.push d.tag.text
             else
               # STDERR.puts "Nothing to do for directive: #{d}"
             end