solargraph 0.29.5 → 0.30.0

data/lib/solargraph/pin/documenting.rb

@@ -16,7 +16,7 @@ module Solargraph
             entity_output: :symbolic,
             syntax_highlighter: nil
           ).to_html
-          ReverseMarkdown.convert(html, github_flavored: true)
+          ReverseMarkdown.convert(html, github_flavored: true).lines.map(&:rstrip).join("\n")
         end
       end
 

data/lib/solargraph/shell.rb

@@ -3,7 +3,7 @@ require 'json'
 require 'fileutils'
 require 'rubygems/package'
 require 'zlib'
-require 'eventmachine'
+require 'backport'
 
 module Solargraph
   class Shell < Thor
@@ -22,29 +22,28 @@ module Solargraph
     def socket
       port = options[:port]
       port = available_port if port.zero?
-      EventMachine.run do
+      Backport.run do
         Signal.trap("INT") do
-          EventMachine.stop
+          Backport.stop
         end
         Signal.trap("TERM") do
-          EventMachine.stop
+          Backport.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
+        Backport.prepare_tcp_server host: options[:host], port: port, adapter: Solargraph::LanguageServer::Transport::Adapter
         STDERR.puts "Solargraph is listening PORT=#{port} PID=#{Process.pid}"
       end
     end
 
     desc 'stdio', 'Run a Solargraph stdio server'
     def stdio
-      EventMachine.run do
+      Backport.run do
         Signal.trap("INT") do
-          EventMachine.stop
+          Backport.stop
         end
         Signal.trap("TERM") do
-          EventMachine.stop
+          Backport.stop
         end
-        Solargraph::LanguageServer::Transport::Stdio.run
+        Backport.prepare_stdio_server adapter: Solargraph::LanguageServer::Transport::Adapter
         STDERR.puts "Solargraph is listening on stdio PID=#{Process.pid}"
       end
     end

data/lib/solargraph/source.rb

@@ -205,8 +205,43 @@ module Solargraph
       Location.new(filename, range)
     end
 
+    FOLDING_NODE_TYPES = %i[
+      class sclass module def defs if str dstr array while unless kwbegin hash
+    ].freeze
+
+    # Get an array of ranges that can be folded, e.g., the range of a class
+    # definition or an if condition.
+    #
+    # See FOLDING_NODE_TYPES for the list of node types that can be folded.
+    #
+    # @return [Array<Range>]
+    def folding_ranges
+      @folding_ranges ||= begin
+        result = []
+        inner_folding_ranges node, result
+        result.concat comment_block_ranges
+        result
+      end
+    end
+
     private
 
+    # @param top [Parser::AST::Node]
+    # @param result [Array<Range>]
+    # @return [void]
+    def inner_folding_ranges top, result = []
+      return unless top.is_a?(Parser::AST::Node)
+      if FOLDING_NODE_TYPES.include?(top.type)
+        range = Range.from_node(top)
+        if result.empty? || range.start.line > result.last.start.line
+          result.push range unless range.ending.line - range.start.line < 2
+        end
+      end
+      top.children.each do |child|
+        inner_folding_ranges(child, result)
+      end
+    end
+
     # Get a hash of comments grouped by the line numbers of the associated code.
     #
     # @return [Hash{Integer => Array<Parser::Source::Comment>}]
@@ -253,11 +288,32 @@ module Solargraph
 
     # @return [Array<Range>]
     def comment_ranges
-      @comment_ranges || @comments.map do |cmnt|
+      @comment_ranges ||= @comments.map do |cmnt|
         Range.from_expr(cmnt.loc.expression)
       end
     end
 
+    def comment_block_ranges
+      result = []
+      grouped = []
+      # @param cmnt [Parser::Source::Comment]
+      @comments.each do |cmnt|
+        if cmnt.document?
+          result.push Range.from_expr(cmnt.loc.expression)
+        elsif code.lines[cmnt.loc.expression.line].strip.start_with?('#')
+          if grouped.empty? || cmnt.loc.expression.line == grouped.last.loc.expression.line + 1
+            grouped.push cmnt
+          else
+            result.push Range.from_to(grouped.first.loc.expression.line, 0, grouped.last.loc.expression.line, 0) unless grouped.empty?
+            grouped = [cmnt]
+          end
+        else
+          result.push Range.from_to(grouped.first.loc.expression.line, 0, grouped.last.loc.expression.line, 0) unless grouped.empty?
+        end
+      end
+      result
+    end
+
     def string_ranges_in n
       result = []
       if n.is_a?(Parser::AST::Node)
@@ -338,14 +394,12 @@ module Solargraph
       # @param code [String]
       # @param filename [String]
       # @return [Parser::AST::Node]
-      def parse code, filename = nil
-        buffer = Parser::Source::Buffer.new(filename, 0)
+      def parse code, filename = nil, line = 0
+        buffer = Parser::Source::Buffer.new(filename, line)
         buffer.source = code.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: '_')
         parser.parse(buffer)
       end
 
-      private
-
       # @return [Parser::Base]
       def parser
         # @todo Consider setting an instance variable. We might not need to

data/lib/solargraph/source/encoding_fixes.rb

@@ -9,7 +9,7 @@ module Solargraph
       # @return [String]
       def normalize string
         begin
-          string.clone.force_encoding('UTF-8')
+          string.dup.force_encoding('UTF-8')
         rescue ::Encoding::CompatibilityError, ::Encoding::UndefinedConversionError, ::Encoding::InvalidByteSequenceError => e
           # @todo Improve error handling
           STDERR.puts "Normalize error: #{e.message}"

data/lib/solargraph/source_map/mapper.rb

@@ -14,6 +14,7 @@ module Solargraph
       #
       # @return [Array]
       def map source
+        @source = source
         @filename = source.filename
         @code = source.code
         @comments = source.comments
@@ -39,11 +40,6 @@ module Solargraph
         end
       end
 
-      # @return [String]
-      def filename
-        @filename
-      end
-
       # @return [Array<Solargraph::Pin::Base>]
       def pins
         @pins ||= []
@@ -62,7 +58,7 @@ module Solargraph
 
       def process_comment position, comment
         cmnt = remove_inline_comment_hashes(comment)
-        return unless cmnt =~ /(@\!method|@\!attribute|@\!domain|@\!macro)/
+        return unless cmnt =~ /(@\!method|@\!attribute|@\!domain|@\!macro|@\!parse)/
         parse = YARD::Docstring.parser.parse(cmnt)
         parse.directives.each { |d| process_directive(position, d) }
       end
@@ -81,13 +77,23 @@ module Solargraph
         when 'attribute'
           namespace = namespace_at(position)
           t = (directive.tag.types.nil? || directive.tag.types.empty?) ? nil : directive.tag.types.flatten.join('')
-          if t.nil? or t.include?('r')
+          if t.nil? || t.include?('r')
             # location, namespace, name, docstring, access
             pins.push Solargraph::Pin::Attribute.new(location, namespace.path, directive.tag.name, docstring.all, :reader, :instance, :public)
           end
-          if t.nil? or t.include?('w')
+          if t.nil? || t.include?('w')
             pins.push Solargraph::Pin::Attribute.new(location, namespace.path, "#{directive.tag.name}=", docstring.all, :writer, :instance, :public)
           end
+        when 'parse'
+          # @todo Parse and map directive.tag.text
+          ns = namespace_at(position)
+          region = Region.new(source: @source, namespace: ns.path)
+          begin
+            node = Solargraph::Source.parse(directive.tag.text, @filename, position.line)
+            NodeProcessor.process(node, region, @pins)
+          rescue Parser::SyntaxError => e
+            # @todo Handle parser errors in !parse directives
+          end
         when 'domain'
           namespace = namespace_at(position)
           namespace.domains.push directive.tag.text

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.29.5'
+  VERSION = '0.30.0'
 end

data/lib/solargraph/views/_method.erb

@@ -8,6 +8,9 @@
     Overview:
 </h2>
 <%= htmlify object.docstring %>
+<p class="document-section">
+    <big><strong>Visibility:</strong></big> <%= object.visibility %>
+</p>
 <% unless object.tags(:param).empty? %>
     <h2>
         Parameters:

data/lib/solargraph/views/environment.erb

@@ -0,0 +1,50 @@
+<html>
+  <head>
+    <title>Solargraph Environment</title>
+  </head>
+  <h1>
+    Solargraph Environment Info
+  </h1>
+  <h2>
+    System
+  </h2>
+  <ul>
+    <li>
+      Platform: <%= RUBY_PLATFORM %>
+    </li>
+    <li>
+      Shell: <%= ENV['SHELL'] %>
+    </li>
+    <li>
+      Ruby Version: <%= RUBY_VERSION %>
+    </li>
+  </ul>
+  <h2>
+    Solargraph
+  </h2>
+  <ul>
+    <li>
+      Solargraph Version: <%= Solargraph::VERSION %>
+    </li>
+    <li>
+      Core Documentation Version: <%= Solargraph::YardMap::CoreDocs.best_match %>
+    </li>
+    <li>
+      Parser Target Version: <%= Solargraph::Source.parser.version %>
+    </li>
+    <li>
+      Using Bundler: <%= ENV.key?('BUNDLE_GEMFILE') %>
+    </li>
+  </ul>
+  <h2>
+    Project
+  </h2>
+  <ul>
+    <li>
+      Config: <%= config %>
+    </li>
+    <li>
+      Workspace folders: <%= folders %>
+    </li>
+  </ul>
+</html>

data/lib/solargraph/views/layout.erb

@@ -11,6 +11,9 @@
                 font-size: 110%;
                 margin: 1.5em 0 1em 0;
             }
+            big {
+                font-size: 110%;
+            }
             pre {
                 margin: 1em;
                 padding: 0.5em;
@@ -30,6 +33,9 @@
                 font-size: 75%;
                 font-weight: normal;
             }
+            .document-section {
+                margin: 1.5em 0 1em 0;
+            }
         </style>
     </head>
     <body>

data/lib/solargraph/yard_map.rb

@@ -178,15 +178,15 @@ module Solargraph
           ver = spec.version.to_s
           ver = ">= 0" if ver.empty?
           yd = YARD::Registry.yardoc_file_for_gem(spec.name, ver)
+          # YARD detects gems for certain libraries that do not have a yardoc
+          # but exist in the stdlib. `fileutils` is an example. Treat those
+          # cases as errors and check the stdlib yardoc.
+          raise Gem::LoadError if yd.nil?
           @gem_paths[spec.name] = spec.full_gem_path
-          if yd.nil?
-            unresolved_requires.push r
-          else
-            unless yardocs.include?(yd)
-              yardocs.unshift yd
-              result.concat process_yardoc yd
-              result.concat add_gem_dependencies(spec) if with_dependencies?
-            end
+          unless yardocs.include?(yd)
+            yardocs.unshift yd
+            result.concat process_yardoc yd
+            result.concat add_gem_dependencies(spec) if with_dependencies?
           end
         rescue Gem::LoadError => e
           stdtmp = []

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.29.5
+  version: 0.30.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-18 00:00:00.000000000 Z
+date: 2018-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: eventmachine
+  name: backport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.5
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.2.5
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -255,6 +249,7 @@ files:
 - lib/solargraph/language_server/message/extended/document.rb
 - lib/solargraph/language_server/message/extended/document_gems.rb
 - lib/solargraph/language_server/message/extended/download_core.rb
+- lib/solargraph/language_server/message/extended/environment.rb
 - lib/solargraph/language_server/message/extended/search.rb
 - lib/solargraph/language_server/message/initialize.rb
 - lib/solargraph/language_server/message/initialized.rb
@@ -270,6 +265,7 @@ files:
 - lib/solargraph/language_server/message/text_document/did_open.rb
 - lib/solargraph/language_server/message/text_document/did_save.rb
 - lib/solargraph/language_server/message/text_document/document_symbol.rb
+- lib/solargraph/language_server/message/text_document/folding_range.rb
 - lib/solargraph/language_server/message/text_document/formatting.rb
 - lib/solargraph/language_server/message/text_document/hover.rb
 - lib/solargraph/language_server/message/text_document/on_type_formatting.rb
@@ -279,19 +275,20 @@ files:
 - lib/solargraph/language_server/message/workspace.rb
 - lib/solargraph/language_server/message/workspace/did_change_configuration.rb
 - lib/solargraph/language_server/message/workspace/did_change_watched_files.rb
+- lib/solargraph/language_server/message/workspace/did_change_workspace_folders.rb
 - lib/solargraph/language_server/message/workspace/workspace_symbol.rb
 - lib/solargraph/language_server/message_types.rb
 - lib/solargraph/language_server/request.rb
 - lib/solargraph/language_server/symbol_kinds.rb
 - lib/solargraph/language_server/transport.rb
+- lib/solargraph/language_server/transport/adapter.rb
 - lib/solargraph/language_server/transport/data_reader.rb
-- lib/solargraph/language_server/transport/socket.rb
-- lib/solargraph/language_server/transport/stdio.rb
 - lib/solargraph/language_server/uri_helpers.rb
 - lib/solargraph/library.rb
 - lib/solargraph/live_map.rb
 - lib/solargraph/live_map/cache.rb
 - lib/solargraph/location.rb
+- lib/solargraph/logging.rb
 - lib/solargraph/page.rb
 - lib/solargraph/pin.rb
 - lib/solargraph/pin/attribute.rb
@@ -383,6 +380,7 @@ files:
 - lib/solargraph/views/_name_type_tag.erb
 - lib/solargraph/views/_namespace.erb
 - lib/solargraph/views/document.erb
+- lib/solargraph/views/environment.erb
 - lib/solargraph/views/layout.erb
 - lib/solargraph/views/search.erb
 - lib/solargraph/workspace.rb

data/lib/solargraph/language_server/transport/stdio.rb

@@ -1,63 +0,0 @@
-require 'thread'
-
-module Solargraph
-  module LanguageServer
-    module Transport
-      class Stdio
-        def initialize
-          # binmode is necessary to avoid EOL conversions
-          STDOUT.binmode
-          @host = Solargraph::LanguageServer::Host.new
-          @data_reader = Solargraph::LanguageServer::Transport::DataReader.new
-          @data_reader.set_message_handler do |message|
-            process message
-          end
-        end
-
-        def run
-          start_reader
-          start_timers
-        end
-
-        def self.run
-          std = Stdio.new
-          std.run
-          std
-        end
-
-        private
-
-        def start_reader
-          Thread.new do
-            until @host.stopped?
-              char = STDIN.sysread(1)
-              break if char.nil?
-              @data_reader.receive char
-              STDIN.flush
-            end
-          end
-        end
-
-        def send_data message
-          STDOUT.write message
-          STDOUT.flush
-        end
-
-        def process request
-          message = @host.start(request)
-          message.send_response
-          tmp = @host.flush
-          send_data tmp unless tmp.empty?
-        end
-
-        def start_timers
-          EventMachine.add_periodic_timer 0.1 do
-            tmp = @host.flush
-            send_data tmp unless tmp.empty?
-            EventMachine.stop if @host.stopped?
-          end
-        end
-      end
-    end
-  end
-end