solargraph 0.21.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 04dd49e264774d545fbdf1a7f52d0b7227ff3f11
-  data.tar.gz: cb617a8800b2eec8688c46fc89cf4ee79445dd50
+SHA256:
+  metadata.gz: f93d18c2483c24a81693e662698b7d67e86086211608d6f50a0128b95cc817b6
+  data.tar.gz: f0346ff1adf21faebba30306cc2e682cf99d83bcedf66ebfca3029dad4031025
 SHA512:
-  metadata.gz: db20a5e3053060171bf9077c1ce572de8428193b4d562c7d939c9a7003074de64f41ffe879100b7f7a31bb42f625a32e69ad7755afc68b8c31d2cc64d15be353
-  data.tar.gz: bb9a311819e91501145c05fc2045178a791933fb6f9598e6265f68efe301664cbb6bfa50170928989d1fd8543a726cd36e0079b2f650c2ded36f9ad3a66c92c6
+  metadata.gz: d87a287c2608cbd7af255684a790ab079b85821a2abf3a6051212b36a156bf3662310bf5e9e7d3857ad89338b81628e94eb270dc74db258c6cb2ff2f4f0bc852
+  data.tar.gz: ad9ae29c4d354588e383fb68926175bad72e419a2ef736f7e9f7069c701d3b94bc5ab784768be4dd1823ef1ac65201bea9e971ea554c6918f2f23d9fd1c42b92

data/lib/solargraph/api_map.rb

@@ -9,9 +9,11 @@ module Solargraph
     autoload :Completion,   'solargraph/api_map/completion'
     autoload :Probe,        'solargraph/api_map/probe'
     autoload :Store,        'solargraph/api_map/store'
+    autoload :TypeMethods,  'solargraph/api_map/type_methods'
 
     include Solargraph::ApiMap::SourceToYard
     include CoreFills
+    include TypeMethods
 
     # The workspace to analyze and process.
     #
@@ -310,7 +312,8 @@ module Solargraph
           end
         end
       end
-      filtered = result.uniq(&:identifier).select{|s| s.kind != Pin::METHOD or s.name.match(/^[a-z0-9_]*(\!|\?|=)?$/i)}.sort_by.with_index{ |x, idx| [x.name, idx] }
+      frag_start = fragment.word.to_s.downcase
+      filtered = result.uniq(&:identifier).select{|s| s.name.downcase.start_with?(frag_start) and (s.kind != Pin::METHOD or s.name.match(/^[a-z0-9_]*(\!|\?|=)?$/i))}.sort_by.with_index{ |x, idx| [x.name, idx] }
       Completion.new(filtered, fragment.whole_word_range)
     end
 
@@ -475,7 +478,7 @@ module Solargraph
           result.concat yard_map.get_methods(fqns, '', visibility: visibility)
           type = get_namespace_type(fqns)
           result.concat inner_get_methods('Class', :instance, fqns == '' ? [:public] : visibility, deep, skip) if type == :class
-          result.concat inner_get_methods('Module', :instance, fqns == '' ? [:public] : visibility, deep, skip)
+          result.concat inner_get_methods('Module', :instance, fqns == '' ? [:public] : visibility, deep, skip) if type == :module
         end
       end
       result
@@ -568,15 +571,5 @@ module Solargraph
       return yard_map.get_namespace_type(fqns) if pin.nil?
       pin.type
     end
-
-    def extract_namespace_and_scope type
-      scope = :instance
-      result = type.to_s.gsub(/<.*$/, '')
-      if (result == 'Class' or result == 'Module') and type.include?('<')
-        result = type.match(/<([a-z0-9:_]*)/i)[1]
-        scope = :class
-      end
-      [result, scope]
-    end
   end
 end

data/lib/solargraph/api_map/probe.rb

@@ -6,8 +6,13 @@ module Solargraph
         def initialize return_type
           @return_type = return_type
         end
+        def namespace
+          @namespace ||= TypeMethods.extract_namespace(@return_type)
+        end
       end
 
+      include TypeMethods
+
       # @return [Solargraph::ApiMap]
       attr_reader :api_map
 
@@ -77,8 +82,11 @@ module Solargraph
       end
 
       # Method name search is external by default
+      # @param method_name [String]
+      # @param context_pin [Solargraph::Pin::Base]
       def infer_method_name_pins method_name, context_pin, internal = false
-        namespace, scope = extract_namespace_and_scope(context_pin.return_type)
+        relname, scope = extract_namespace_and_scope(context_pin.return_type)
+        namespace = api_map.qualify(relname, context_pin.namespace)
         visibility = [:public]
         visibility.push :protected, :private if internal
         result = api_map.get_methods(namespace, scope: scope, visibility: visibility).select{|pin| pin.name == method_name}
@@ -110,35 +118,6 @@ module Solargraph
         type.sub(/<#{rns}>/, "<#{res}>")
       end
 
-      # Extract a namespace from a type.
-      #
-      # @example
-      #   extract_namespace('String') => 'String'
-      #   extract_namespace('Class<String>') => 'String'
-      #
-      # @return [String]
-      def extract_namespace type
-        extract_namespace_and_scope(type)[0]
-      end
-
-      # Extract a namespace and a scope (:instance or :class) from a type.
-      #
-      # @example
-      #   extract_namespace('String')            #=> ['String', :instance]
-      #   extract_namespace('Class<String>')     #=> ['String', :class]
-      #   extract_namespace('Module<Enumerable') #=> ['Enumberable', :class]
-      #
-      # @return [Array] The namespace (String) and scope (Symbol).
-      def extract_namespace_and_scope type
-        scope = :instance
-        result = type.to_s.gsub(/<.*$/, '')
-        if (result == 'Class' or result == 'Module') and type.include?('<')
-          result = type.match(/<([a-z0-9:_]*)/i)[1]
-          scope = :class
-        end
-        [result, scope]
-      end
-
       # Extract a namespace and a scope from a pin. For now, the pin must
       # be either a namespace, a method, or a block.
       #

data/lib/solargraph/api_map/type_methods.rb

@@ -0,0 +1,40 @@
+module Solargraph
+  class ApiMap
+    # Module functions for processing YARD types.
+    #
+    module TypeMethods
+      module_function
+
+      # Extract a namespace from a type.
+      #
+      # @example
+      #   extract_namespace('String') => 'String'
+      #   extract_namespace('Class<String>') => 'String'
+      #
+      # @param type [String]
+      # @return [String]
+      def extract_namespace type
+        extract_namespace_and_scope(type)[0]
+      end
+
+      # Extract a namespace and a scope (:instance or :class) from a type.
+      #
+      # @example
+      #   extract_namespace('String')            #=> ['String', :instance]
+      #   extract_namespace('Class<String>')     #=> ['String', :class]
+      #   extract_namespace('Module<Enumerable') #=> ['Enumberable', :class]
+      #
+      # @param type [String]
+      # @return [Array] The namespace (String) and scope (Symbol).
+      def extract_namespace_and_scope type
+        scope = :instance
+        result = type.to_s.gsub(/<.*$/, '')
+        if (result == 'Class' or result == 'Module') and type.include?('<')
+          result = type.match(/<([a-z0-9:_]*)/i)[1]
+          scope = :class
+        end
+        [result, scope]
+      end
+    end
+  end
+end

data/lib/solargraph/diagnostics.rb

@@ -1,10 +1,15 @@
 module Solargraph
+  # The Diagnostics library provides reporters for analyzing problems in code
+  # and providing the results to language server clients.
+  #
   module Diagnostics
     autoload :Base, 'solargraph/diagnostics/base'
     autoload :Severities, 'solargraph/diagnostics/severities'
     autoload :Rubocop, 'solargraph/diagnostics/rubocop'
     autoload :RequireNotFound, 'solargraph/diagnostics/require_not_found'
 
+    # Reporters identified by name for activation in .solargraph.yml files.
+    #
     REPORTERS = {
       'rubocop' => Rubocop,
       'require_not_found' => RequireNotFound

data/lib/solargraph/diagnostics/require_not_found.rb

@@ -1,5 +1,10 @@
 module Solargraph
   module Diagnostics
+    # RequireNotFound reports required paths that could not be resolved to
+    # either a file in the workspace or a gem.
+    #
+    # @todo Some stdlib paths can result in false positives.
+    #
     class RequireNotFound < Base
       def diagnose source, api_map
         result = []

data/lib/solargraph/diagnostics/rubocop.rb

@@ -3,6 +3,8 @@ require 'shellwords'
 
 module Solargraph
   module Diagnostics
+    # This reporter provides linting through RuboCop.
+    #
     class Rubocop < Base
       # The rubocop command
       #
@@ -21,6 +23,7 @@ module Solargraph
           raise DiagnosticsError, 'No command specified' if command.nil? or command.empty?
           cmd = "#{Shellwords.escape(command)} -f j -s #{Shellwords.escape(filename)}"
           o, e, s = Open3.capture3(cmd, stdin_data: text)
+          STDERR.puts e unless e.empty?
           raise DiagnosticsError, "Command '#{command}' is not available (gem exception)" if e.include?('Gem::Exception')
           raise DiagnosticsError, "RuboCop returned empty data" if o.empty?
           make_array JSON.parse(o)

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

@@ -37,14 +37,7 @@ module Solargraph
           }
         end
 
-        def response
-          response = {}
-          response[:result] = result
-          response[:error] = error unless error.nil?
-          response
-        end
-
-        def send
+        def send_response
           unless id.nil? or host.cancel?(id)
             response = {
               jsonrpc: "2.0",

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

@@ -30,6 +30,10 @@ module Solargraph
             elsif params['verbose']
               host.show_message "The Solargraph gem is up to date (version #{Solargraph::VERSION})."
             end
+            set_result({
+              installed: current,
+              available: available
+            })
           end
         end
       end

data/lib/solargraph/language_server/request.rb

@@ -9,6 +9,10 @@ module Solargraph
       def process result
         @block.call(result) unless @block.nil?
       end
+
+      def send_response
+        # noop
+      end
     end
   end
 end

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

@@ -18,13 +18,13 @@ module Solargraph
           start_timers
         end
 
-        def process message
+        def process request
           Thread.new do
-            message = @host.start(message)
-            message.send
+            message = @host.start(request)
+            message.send_response
             tmp = @host.flush
             send_data tmp unless tmp.empty?
-            GC.start unless message['method'] == 'textDocument/didChange'
+            GC.start unless request['method'] == 'textDocument/didChange'
           end
         end
 

data/lib/solargraph/plugin/runtime.rb

@@ -53,6 +53,10 @@ module Solargraph
         end
       end
 
+      def stop
+        @io.close
+      end
+
       protected
 
       def load_environment
@@ -66,8 +70,8 @@ module Solargraph
 
       def start_process
         dir = Dir.pwd
-        unless api_map.nil? or api_map.workspace.nil?
-          dir = api_map.workspace
+        unless api_map.nil? or api_map.workspace.nil? or api_map.workspace.directory.nil?
+          dir = api_map.workspace.directory
         end
         Dir.chdir(dir) do
           @io = IO.popen(executable, 'r+')

data/lib/solargraph/source/flawed_builder.rb

@@ -1,5 +1,8 @@
 module Solargraph
   class Source
+    # A custom builder for source parsers that ignores character encoding
+    # issues in literal strings.
+    #
     class FlawedBuilder < Parser::Builders::Default
       def string_value(token)
         value(token)

data/lib/solargraph/source/mapper.rb

@@ -1,11 +1,19 @@
 module Solargraph
   class Source
+    # The Mapper generates pins and other data for Sources.
+    #
+    # This class is used internally by the Source class on initialization,
+    # e.g., via Source.new or Source.load. Users should not normally need to
+    # call it directly.
+    #
     class Mapper
       include NodeMethods
 
       private_class_method :new
 
-      # @return [Array<Solargraph::Pin::Base>]
+      # Generate the data.
+      #
+      # @return [Array]
       def map filename, code, node, comments
         @filename = filename
         @code = code
@@ -37,7 +45,7 @@ module Solargraph
       end
 
       class << self
-        # @return [Array<Solargraph::Pin::Base>]
+        # @return [Array]
         def map filename, code, node, comments
           new.map filename, code, node, comments
         end
@@ -134,7 +142,6 @@ module Solargraph
                 pins.push Solargraph::Pin::GlobalVariable.new(get_node_location(c), fqn, c.children[0].to_s, docstring_for(c), resolve_node_signature(c.children[1]), infer_literal_node_type(c.children[1]), @pins.first)
               elsif c.type == :sym
                 @symbols.push Solargraph::Pin::Symbol.new(get_node_location(c), ":#{c.children[0]}")
-
               elsif c.type == :casgn
                 here = get_node_start_position(c)
                 block = get_block_pin(here)
@@ -146,12 +153,15 @@ module Solargraph
                   # @todo Smelly instance variable access.
                   pins.last.instance_variable_set(:@return_type, methpin.namespace)
                   pins.push Solargraph::Pin::Method.new(methpin.location, methpin.namespace, methpin.name, methpin.docstring, methpin.scope, :private, methpin.parameters)
+                elsif visibility == :module_function
+                  pins.push Solargraph::Pin::Method.new(methpin.location, methpin.namespace, methpin.name, methpin.docstring, :class, :public, methpin.parameters)
+                  pins.push Solargraph::Pin::Method.new(methpin.location, methpin.namespace, methpin.name, methpin.docstring, :instance, :private, methpin.parameters)
                 else
                   pins.push methpin
                 end
               elsif c.type == :defs
                 s_visi = visibility
-                s_visi = :public if scope != :class
+                s_visi = :public if s_visi == :module_function or scope != :class
                 if c.children[0].is_a?(AST::Node) and c.children[0].type == :self
                   dfqn = fqn || ''
                 else
@@ -191,6 +201,26 @@ module Solargraph
                   end
                 end
                 next
+              elsif c.type == :send and c.children[1] == :module_function
+                # @todo Handle module_function
+                if c.children[2].nil?
+                  visibility = :module_function
+                elsif c.children[2].type == :sym or c.children[2].type == :str
+                  # @todo What to do about references?
+                  c.children[2..-1].each do |x|
+                    cn = x.children[0].to_s
+                    ref = pins.select{|p| p.namespace == (fqn || '') and p.name == cn}.first
+                    unless ref.nil?
+                      pins.delete ref
+                      pins.push Solargraph::Pin::Method.new(ref.location, ref.namespace, ref.name, ref.docstring, :class, :public, ref.parameters)
+                      pins.push Solargraph::Pin::Method.new(ref.location, ref.namespace, ref.name, ref.docstring, :instance, :private, ref.parameters)
+                    end
+                  end
+                elsif c.children[2].type == :def
+                  # @todo A single function
+                  process c, tree, :module_function, :class, fqn, stack
+                  next
+                end
               elsif c.type == :send and c.children[1] == :include and c.children[0].nil?
                 last_node = get_last_in_stack_not_begin(stack)
                 if last_node.nil? or last_node.type == :class or last_node.type == :module or last_node.type == :source
@@ -207,14 +237,16 @@ module Solargraph
               elsif c.type == :send and c.children[1] == :extend and c.children[0].nil?
                 last_node = get_last_in_stack_not_begin(stack)
                 if last_node.nil? or last_node.type == :class or last_node.type == :module or last_node.type == :source
-                  if c.children[2].kind_of?(AST::Node) and c.children[2].type == :const
-                    # namespace_extends[fqn || ''] ||= []
-                    c.children[2..-1].each do |i|
-                      nspin = @pins.select{|pin| pin.kind == Pin::NAMESPACE and pin.path == fqn}.last
-                      unless nspin.nil?
+                  c.children[2..-1].each do |i|
+                    nspin = @pins.select{|pin| pin.kind == Pin::NAMESPACE and pin.path == fqn}.last
+                    unless nspin.nil?
+                      ref = nil
+                      if i.type == :self
+                        ref = Pin::Reference.new(get_node_location(c), nspin.path, nspin.path)
+                      elsif i.type == :const
                         ref = Pin::Reference.new(get_node_location(c), nspin.path, unpack_name(i))
-                        nspin.extend_references.push(ref)
                       end
+                      nspin.extend_references.push(ref) unless ref.nil?
                     end
                   end
                 end

data/lib/solargraph/source/position.rb

@@ -16,6 +16,7 @@ module Solargraph
       # Get a hash of the position. This representation is suitable for use in
       # the language server protocol.
       #
+      # @return [Hash]
       def to_hash
         {
           line: line,
@@ -23,6 +24,11 @@ module Solargraph
         }
       end
 
+      # Get a numeric offset for the specified text and position.
+      #
+      # @param text [String]
+      # @param position [Position]
+      # @return [Integer]
       def self.to_offset text, position
         result = 0
         feed = 0
@@ -41,10 +47,22 @@ module Solargraph
         result
       end
 
+      # Get a numeric offset for the specified text and a position identified
+      # by its line and character.
+      #
+      # @param text [String]
+      # @param line [Integer]
+      # @param character [Integer]
+      # @return [Integer]
       def self.line_char_to_offset text, line, character
         to_offset(text, Position.new(line, character))
       end
 
+      # Get a position for the specified text and offset.
+      #
+      # @param text [String]
+      # @param offset [Integer]
+      # @return [Position]
       def self.from_offset text, offset
         cursor = 0
         line = 0

data/lib/solargraph/source/range.rb

@@ -17,6 +17,7 @@ module Solargraph
       # Get a hash of the range. This representation is suitable for use in
       # the language server protocol.
       #
+      # @return [Hash<Symbol, Position>]
       def to_hash
         {
           start: start.to_hash,
@@ -24,6 +25,9 @@ module Solargraph
         }
       end
 
+      # True if the specified position is inside the range.
+      #
+      # @return [Boolean]
       def contain? position
         return false if position.line < start.line
         return false if position.line == start.line and position.character < start.character
@@ -38,7 +42,7 @@ module Solargraph
       # @param c1 [Integer] Starting character
       # @param l2 [Integer] Ending line
       # @param c2 [Integer] Ending character
-      # @return [Position]
+      # @return [Range]
       def self.from_to l1, c1, l2, c2
         Range.new(Position.new(l1, c1), Position.new(l2, c2))
       end

data/lib/solargraph/version.rb

@@ -1,3 +1,3 @@
 module Solargraph
-  VERSION = '0.21.0'
+  VERSION = '0.21.1'
 end

data/lib/solargraph/yard_map.rb

@@ -1,16 +1,23 @@
 require 'yard'
 
 module Solargraph
+  # The YardMap provides access to YARD documentation for the Ruby core, the
+  # stdlib, and gems.
+  #
   class YardMap
     autoload :Cache, 'solargraph/yard_map/cache'
     autoload :CoreDocs, 'solargraph/yard_map/core_docs'
 
     CoreDocs.require_minimum
     @@stdlib_yardoc = CoreDocs.yard_stdlib_file
-    @@stdlib_namespaces = []
+    @@stdlib_paths = {}
     YARD::Registry.load! @@stdlib_yardoc
     YARD::Registry.all(:class, :module).each do |ns|
-      @@stdlib_namespaces.push ns.path
+      next if ns.file.nil?
+      path = ns.file.sub(/^(ext|lib)\//, '').sub(/\.(rb|c)$/, '')
+      next if path.start_with?('-')
+      @@stdlib_paths[path] ||= []
+      @@stdlib_paths[path].push ns
     end
 
     # @return [Solargraph::Workspace]
@@ -25,6 +32,7 @@ module Solargraph
       @required = required.clone
       @namespace_yardocs = {}
       @gem_paths = {}
+      @stdlib_namespaces = []
       process_requires
       yardocs.push CoreDocs.yardoc_file
       yardocs.uniq!
@@ -99,12 +107,16 @@ module Solargraph
       result = []
       combined_namespaces(namespace, scope).each do |ns|
         yardocs_documenting(ns).each do |y|
+          # @todo Getting constants from the stdlib works slightly differently
+          #   from methods
+          next if y == @@stdlib_yardoc
           yard = load_yardoc(y)
           unless yard.nil?
             found = yard.at(ns)
             consts.concat found.children unless found.nil?
           end
         end
+        consts.concat @stdlib_namespaces.select{|ns| ns.namespace.path == namespace}
       end
       consts.each { |c|
         detail = nil
@@ -170,6 +182,8 @@ module Solargraph
             unless ns.nil?
               ns.meths(scope: :instance, visibility: visibility).each do |m|
                 n = m.to_s.split(/[\.#]/).last
+                # HACK: Exception for Module#module_function in Class
+                next if ns.name == :Class and m.path == 'Module#module_function'
                 # HACK: Special treatment for #initialize
                 next if n == 'initialize' and !visibility.include?(:private)
                 if (namespace == 'Kernel' or !m.to_s.start_with?('Kernel#')) and !m.docstring.to_s.include?(':nodoc:')
@@ -203,10 +217,12 @@ module Solargraph
         while parts.length > 0
           here = "#{parts.join('::')}::#{namespace}"
           return here unless yardocs_documenting(here).empty?
+          return here if @stdlib_namespaces.any?{|ns| ns.path == here}
           parts.pop
         end
       end
       return namespace unless yardocs_documenting(namespace).empty?
+      return namespace if @stdlib_namespaces.any?{|ns| ns.path == namespace}
       nil
     end
 
@@ -221,6 +237,9 @@ module Solargraph
           end
         end
       }
+      @stdlib_namespaces.each do |ns|
+        result.push Pin::YardObject.new(ns, object_location(ns)) if ns.path == path
+      end
       result
     end
 
@@ -266,6 +285,7 @@ module Solargraph
       tried = []
       unresolved_requires.clear
       required.each do |r|
+        next if r.nil?
         begin
           spec = Gem::Specification.find_by_path(r) || Gem::Specification.find_by_name(r.split('/').first)
           ver = spec.version.to_s
@@ -278,7 +298,12 @@ module Solargraph
           yardocs.unshift yd unless yd.nil? or yardocs.include?(yd)
         rescue Gem::LoadError => e
           next if !workspace.nil? and workspace.would_require?(r)
-          unresolved_requires.push r
+          stdnames = []
+          @@stdlib_paths.each_pair do |path, objects|
+            stdnames.concat objects if path == r or path.start_with?("#{r}/")
+          end
+          @stdlib_namespaces.concat stdnames
+          unresolved_requires.push r if stdnames.empty?
         end
       end
     end
@@ -315,7 +340,9 @@ module Solargraph
       else
         result.concat @namespace_yardocs[namespace] unless @namespace_yardocs[namespace].nil?
       end
-      result.push @@stdlib_yardoc if result.empty? and @@stdlib_namespaces.include?(namespace)
+      if @stdlib_namespaces.map(&:path).include?(namespace)
+        result.push @@stdlib_yardoc
+      end
       result
     end
 

data/lib/solargraph/yard_map/core_docs.rb

@@ -77,7 +77,7 @@ module Solargraph
 
         def download version
           FileUtils.mkdir_p cache_dir
-          uri = URI.parse("http://solargraph.org/download/#{version}.tar.gz")
+          uri = URI.parse("#{SOURCE}/#{version}.tar.gz")
           response = Net::HTTP.get_response(uri)
           zipfile = File.join(cache_dir, "#{version}.tar.gz")
           File.binwrite zipfile, response.body

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.21.1
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -226,6 +226,7 @@ files:
 - lib/solargraph/api_map/probe.rb
 - lib/solargraph/api_map/source_to_yard.rb
 - lib/solargraph/api_map/store.rb
+- lib/solargraph/api_map/type_methods.rb
 - lib/solargraph/core_fills.rb
 - lib/solargraph/diagnostics.rb
 - lib/solargraph/diagnostics/base.rb
@@ -356,7 +357,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Solargraph for Ruby