solargraph 0.45.0 → 0.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99cf1c663bb1a93324ff9c860b82e60d47988a4c48e9c0e977176cb94852f29c
-  data.tar.gz: 9b10324bcf7493f9ed5f8a67a8d47e4f0a379b76ed2aeb31514d1fa06b88dbf6
+  metadata.gz: 65ba1769be95a6c7c20aa57ed559135063379214439bc7ab168a40f4bba0c698
+  data.tar.gz: 37fcbabd10f82493704e38ccb8b849a358b59c8cee568ce53b92a7493ee82dc9
 SHA512:
-  metadata.gz: a981e45a500d2469972d0fab1e4bcfdbde99dc46de7ef7b377d486a9a027ce617b8806790ed3565a673fbf3d3fd206d246408b5ce744a0b575e02ee3a3a9b699
-  data.tar.gz: 0bcb7a9957581cac9c066076938dbbdcbcc596bf7ddc8f4cd4539d71dadabab68cfdbc18f59df8daedd02dcff8f45b671a0a742c6ec1afbd39ede15fb3db381b
+  metadata.gz: '04701577441892c4f9c596873dbbdf8c841125a83b642928be5e1e22adf8d8f3293dc1fe5f2b02a468328d3ecf530b27333cbbdf0be1187777a0637004aaae4a'
+  data.tar.gz: 943f42ecf94e5c0fa26455d5974a8baa452a7382f23f215d01cd122031b65db78f2bacc90c51ad51df954f6171106377356a8ff30146c48b33f98d3e3abce96d

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 0.47.0 - September 25, 2022
+- Completion candidates for union types (#507)
+- Nullify Hover object instead of contents value (#583)
+- Mapping workspace stuck in 0 (#587)
+- Fix parsing of nested subtypes (#589)
+- Update YARD tags on Pin::Block methods (#588)
+- @!visibility directive support (#566)
+
+## 0.46.0 - August 22, 2022
+- Ignore typecheck errors with @sg-ignore tag (#419)
+- Strict checks report undefined method calls on variables (#553)
+- Infer type from method arguments (#554)
+- Return nil value for empty hover contents (#543)
+
 ## 0.45.0 - May 23, 2022
 - Basic support for RSpec #describe and #it
 - fix: domain can complete private method (#490)

data/SPONSORS.md

@@ -10,8 +10,8 @@ The following people and organizations provide funding or other resources. [Beco
 
 ## Named Sponsors
 
-- Emily Strickland
 - Tom de Grunt
 - Akira Yamada
 - Erlend Finvåg
 - Matt Massicotte
+- Oscar Rivas

data/lib/solargraph/api_map.rb

@@ -21,6 +21,9 @@ module Solargraph
     # @return [Array<String>]
     attr_reader :unresolved_requires
 
+    # @return [Array<String>]
+    attr_reader :missing_docs
+
     # @param pins [Array<Solargraph::Pin::Base>]
     def initialize pins: []
       @source_map_hash = {}
@@ -68,6 +71,7 @@ module Solargraph
       yard_map.change(external_requires, bench.workspace.directory, bench.workspace.source_gems)
       @store = Store.new(yard_map.pins + implicit.pins + pins)
       @unresolved_requires = yard_map.unresolved_requires
+      @missing_docs = yard_map.missing_docs
       @rebindable_method_names = nil
       store.block_pins.each { |blk| blk.rebind(self) }
       self
@@ -281,33 +285,33 @@ module Solargraph
     #   type = Solargraph::ComplexType.parse('String')
     #   api_map.get_complex_type_methods(type)
     #
-    # @param type [Solargraph::ComplexType] The complex type of the namespace
+    # @param complex_type [Solargraph::ComplexType] The complex type of the namespace
     # @param context [String] The context from which the type is referenced
     # @param internal [Boolean] True to include private methods
     # @return [Array<Solargraph::Pin::Base>]
-    def get_complex_type_methods type, context = '', internal = false
+    def get_complex_type_methods complex_type, context = '', internal = false
       # This method does not qualify the complex type's namespace because
       # it can cause conflicts between similar names, e.g., `Foo` vs.
       # `Other::Foo`. It still takes a context argument to determine whether
       # protected and private methods are visible.
-      return [] if type.undefined? || type.void?
-      result = []
-      if type.duck_type?
-        type.select(&:duck_type?).each do |t|
-          result.push Pin::DuckMethod.new(name: t.tag[1..-1])
-        end
-        result.concat get_methods('Object')
-      else
-        unless type.nil? || type.name == 'void'
-          visibility = [:public]
-          if type.namespace == context || super_and_sub?(type.namespace, context)
-            visibility.push :protected
-            visibility.push :private if internal
+      return [] if complex_type.undefined? || complex_type.void?
+      result = Set.new
+      complex_type.each do |type|
+        if type.duck_type?
+          result.add Pin::DuckMethod.new(name: type.to_s[1..-1])
+          result.merge get_methods('Object')
+        else
+          unless type.nil? || type.name == 'void'
+            visibility = [:public]
+            if type.namespace == context || super_and_sub?(type.namespace, context)
+              visibility.push :protected
+              visibility.push :private if internal
+            end
+            result.merge get_methods(type.namespace, scope: type.scope, visibility: visibility)
           end
-          result.concat get_methods(type.namespace, scope: type.scope, visibility: visibility)
         end
       end
-      result
+      result.to_a
     end
 
     # Get a stack of method pins for a method name in a namespace. The order
@@ -383,9 +387,10 @@ module Solargraph
     # @param query [String]
     # @return [Array<Pin::Base>]
     def query_symbols query
-      result = []
-      source_map_hash.each_value { |s| result.concat s.query_symbols(query) }
-      result
+      Pin::Search.new(
+        source_map_hash.values.flat_map(&:document_symbols),
+        query
+      ).results
     end
 
     # @param location [Solargraph::Location]

data/lib/solargraph/complex_type.rb

@@ -154,9 +154,9 @@ module Solargraph
                 subtype_string.clear
                 next
               else
+                raise ComplexTypeError, "Invalid close in type #{type_string}" if point_stack == 0
                 point_stack -= 1
-                subtype_string += char if point_stack == 0
-                raise ComplexTypeError, "Invalid close in type #{type_string}" if point_stack < 0
+                subtype_string += char
               end
               next
             elsif char == '{'

data/lib/solargraph/diagnostics/require_not_found.rb

@@ -12,6 +12,10 @@ module Solargraph
         refs = {}
         map = api_map.source_map(source.filename)
         map.requires.each { |ref| refs[ref.name] = ref }
+        api_map.missing_docs.each do |r|
+          next unless refs.key?(r)
+          result.push docs_error(r, refs[r].location)
+        end
         api_map.unresolved_requires.each do |r|
           next unless refs.key?(r)
           result.push require_error(r, refs[r].location)
@@ -21,6 +25,18 @@ module Solargraph
 
       private
 
+      # @param path [String]
+      # @param location [Location]
+      # @return [Hash]
+      def docs_error path, location
+        {
+          range: location.range.to_hash,
+          severity: Diagnostics::Severities::WARNING,
+          source: 'RequireNotFound',
+          message: "YARD docs not found for #{path}"
+        }
+      end
+
       # @param path [String]
       # @param location [Location]
       # @return [Hash]

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

@@ -27,16 +27,28 @@ module Solargraph
               last_link = this_link unless this_link.nil?
             end
             set_result(
-              contents: {
-                kind: 'markdown',
-                value: contents.join("\n\n")
-              }
+              contents_or_nil(contents)
             )
           rescue FileNotFoundError => e
             Logging.logger.warn "[#{e.class}] #{e.message}"
             Logging.logger.warn e.backtrace.join("\n")
             set_result nil
           end
+
+          private
+
+          def contents_or_nil contents
+            stripped = contents
+              .map(&:strip)
+              .reject { |c| c.empty? }
+            return nil if stripped.empty?
+            {
+              contents: {
+                kind: 'markdown',
+                value: stripped.join("\n\n")
+              }
+            }
+          end
         end
       end
     end

data/lib/solargraph/language_server/message/workspace/workspace_symbol.rb

@@ -8,7 +8,7 @@ class Solargraph::LanguageServer::Message::Workspace::WorkspaceSymbol < Solargra
     info = pins.map do |pin|
       uri = file_to_uri(pin.location.filename)
       {
-        name: pin.name,
+        name: pin.path,
         containerName: pin.namespace,
         kind: pin.symbol_kind,
         location: {

data/lib/solargraph/parser/rubyvm/class_methods.rb

@@ -87,7 +87,7 @@ module Solargraph
         end
 
         def infer_literal_node_type node
-          # NodeMethods.infer_literal_node_type node
+          NodeMethods.infer_literal_node_type node
         end
 
         def version

data/lib/solargraph/parser/rubyvm/node_processors/def_node.rb

@@ -6,7 +6,6 @@ module Solargraph
       module NodeProcessors
         class DefNode < Parser::NodeProcessor::Base
           def process
-            loc = get_node_location(node)
             methpin = Solargraph::Pin::Method.new(
               location: get_node_location(node),
               closure: region.closure,

data/lib/solargraph/parser/rubyvm/node_processors/kw_arg_node.rb

@@ -11,8 +11,8 @@ module Solargraph
               closure: region.closure,
               comments: comments_for(node),
               name: node.children[0].children[0].to_s,
-              # assignment: require_keyword?(node) ? nil : node.children[0].children[1],
-              asgn_code: require_keyword?(node) ? nil: region.code_for(node.children[0].children[1]),
+              assignment: require_keyword?(node) ? nil : node.children[0].children[1],
+              asgn_code: require_keyword?(node) ? nil : region.code_for(node.children[0].children[1]),
               presence: region.closure.location.range,
               decl: require_keyword?(node) ? :kwarg : :kwoptarg
             )

data/lib/solargraph/pin/block.rb

@@ -8,6 +8,7 @@ module Solargraph
       # @return [Parser::AST::Node]
       attr_reader :receiver
 
+      # @param args [Array<Parameter>]
       def initialize receiver: nil, args: [], context: nil, **splat
         super(**splat)
         @receiver = receiver
@@ -25,7 +26,7 @@ module Solargraph
         @binder || closure.binder
       end
 
-      # @return [Array<String>]
+      # @return [Array<Parameter>]
       def parameters
         @parameters ||= []
       end

data/lib/solargraph/pin/parameter.rb

@@ -3,8 +3,10 @@
 module Solargraph
   module Pin
     class Parameter < LocalVariable
+      # @return [Symbol]
       attr_reader :decl
 
+      # @return [String]
       attr_reader :asgn_code
 
       def initialize decl: :arg, asgn_code: nil, **splat
@@ -91,10 +93,6 @@ module Solargraph
         true
       end
 
-      def probe api_map
-        typify api_map
-      end
-
       private
 
       # @return [YARD::Tags::Tag]

data/lib/solargraph/pin/search.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'jaro_winkler'
+
+module Solargraph
+  module Pin
+    class Search
+      class Result
+        # @return [Float]
+        attr_reader :match
+
+        # @return [Pin::Base]
+        attr_reader :pin
+
+        def initialize match, pin
+          @match = match
+          @pin = pin
+        end
+      end
+
+      # @param pins [Array<Pin::Base>]
+      # @param query [String]
+      def initialize pins, query
+        @pins = pins
+        @query = query
+      end
+
+      # @return [Array<Pin::Base>]
+      def results
+        @results ||= do_query
+      end
+
+      private
+
+      # @return [Array<Pin::Base>]
+      def do_query
+        return @pins if @query.nil? || @query.empty?
+        @pins.map do |pin|
+          match = [fuzzy_string_match(pin.path, @query), fuzzy_string_match(pin.name, @query)].max
+          Result.new(match, pin) if match > 0.7
+        end
+          .compact
+          .sort { |a, b| b.match <=> a.match }
+          .map(&:pin)
+      end
+
+      # @param str1 [String]
+      # @param str2 [String]
+      # @return [Float]
+      def fuzzy_string_match str1, str2
+        return (1.0 + (str2.length.to_f / str1.length.to_f)) if str1.downcase.include?(str2.downcase)
+        JaroWinkler.distance(str1, str2, ignore_case: true)
+      end
+    end
+  end
+end

data/lib/solargraph/pin.rb

@@ -30,6 +30,7 @@ module Solargraph
     autoload :DuckMethod,       'solargraph/pin/duck_method'
     autoload :Singleton,        'solargraph/pin/singleton'
     autoload :KeywordParam,     'solargraph/pin/keyword_param'
+    autoload :Search,           'solargraph/pin/search'
 
     ROOT_PIN = Pin::Namespace.new(type: :class, name: '', closure: nil)
   end

data/lib/solargraph/shell.rb

@@ -175,7 +175,11 @@ module Solargraph
       api_map = nil
       time = Benchmark.measure {
         api_map = Solargraph::ApiMap.load(directory)
-        api_map.pins.each do |pin|
+        pins = api_map.pins
+        api_map.source_maps.each do |sm|
+          pins.concat sm.locals
+        end
+        pins.each do |pin|
           begin
             puts pin_description(pin) if options[:verbose]
             pin.typify api_map

data/lib/solargraph/source.rb

@@ -45,6 +45,8 @@ module Solargraph
         @node, @comments = Solargraph::Parser.parse_with_comments(@code, filename)
         @parsed = true
       rescue Parser::SyntaxError, EncodingError => e
+        puts "[#{e.class}] #{e.message}"
+        puts e.backtrace
         @node = nil
         @comments = {}
         @parsed = false
@@ -360,7 +362,7 @@ module Solargraph
       skip = nil
       comments.lines.each { |l|
         # Trim the comment and minimum leading whitespace
-        p = l.encode('UTF-8', invalid: :replace, replace: '?').gsub(/^#+/, '')
+        p = l.force_encoding('UTF-8').encode('UTF-8', invalid: :replace, replace: '?').gsub(/^#+/, '')
         if p.strip.empty?
           next unless started
           ctxt.concat p

data/lib/solargraph/source_map/mapper.rb

@@ -12,7 +12,7 @@ module Solargraph
 
       private_class_method :new
 
-      MACRO_REGEXP = /(@\!method|@\!attribute|@\!domain|@\!macro|@\!parse|@\!override)/.freeze
+      MACRO_REGEXP = /(@\!method|@\!attribute|@\!visibility|@\!domain|@\!macro|@\!parse|@\!override)/.freeze
 
       # Generate the data.
       #
@@ -56,8 +56,10 @@ module Solargraph
         @pins ||= []
       end
 
+      # @param position [Solargraph::Position]
+      # @return [Solargraph::Pin::Closure]
       def closure_at(position)
-        @pins.select{|pin| pin.is_a?(Pin::Closure) and pin.location.range.contain?(position)}.last
+        pins.select{|pin| pin.is_a?(Pin::Closure) and pin.location.range.contain?(position)}.last
       end
 
       def process_comment source_position, comment_position, comment
@@ -147,6 +149,27 @@ module Solargraph
               pins.last.docstring.add_tag YARD::Tags::Tag.new(:param, '', pins.last.return_type.to_s.split(', '), 'value')
             end
           end
+        when 'visibility'
+          begin
+            kind = directive.tag.text&.to_sym
+            return unless [:private, :protected, :public].include?(kind)
+
+            name = directive.tag.name
+            closure = closure_at(source_position) || @pins.first
+            if closure.location.range.start.line < comment_position.line
+              closure = closure_at(comment_position)
+            end
+            if closure.is_a?(Pin::Method) && no_empty_lines?(comment_position.line, source_position.line)
+              # @todo Smelly instance variable access
+              closure.instance_variable_set(:@visibility, kind)
+            else
+              matches = pins.select{ |pin| pin.is_a?(Pin::Method) && pin.name == name && pin.namespace == namespace && pin.context.scope == namespace.is_a?(Pin::Singleton) ? :class : :instance }
+              matches.each do |pin|
+                # @todo Smelly instance variable access
+                pin.instance_variable_set(:@visibility, kind)
+              end
+            end
+          end
         when 'parse'
           begin
             ns = closure_at(source_position)
@@ -176,6 +199,10 @@ module Solargraph
         end
       end
 
+      def no_empty_lines?(line1, line2)
+        @code.lines[line1..line2].none? { |line| line.strip.empty? }
+      end
+
       def remove_inline_comment_hashes comment
         ctxt = ''
         num = nil

data/lib/solargraph/source_map.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require 'jaro_winkler'
 require 'yard'
 require 'yard-solargraph'
 require 'set'
@@ -76,8 +75,7 @@ module Solargraph
     # @param query [String]
     # @return [Array<Pin::Base>]
     def query_symbols query
-      return document_symbols if query && query.empty?
-      document_symbols.select{ |pin| fuzzy_string_match(pin.path, query) || fuzzy_string_match(pin.name, query) }
+      Pin::Search.new(document_symbols, query).results
     end
 
     # @param position [Position]
@@ -178,12 +176,5 @@ module Solargraph
       # Assuming the root pin is always valid
       found || pins.first
     end
-
-    # @param str1 [String]
-    # @param str2 [String]
-    # @return [Boolean]
-    def fuzzy_string_match str1, str2
-      JaroWinkler.distance(str1, str2) > 0.6
-    end
   end
 end

data/lib/solargraph/type_checker.rb

@@ -40,10 +40,12 @@ module Solargraph
     # @return [Array<Problem>]
     def problems
       @problems ||= begin
-        method_tag_problems
-          .concat variable_type_tag_problems
-          .concat const_problems
-          .concat call_problems
+        without_ignored(
+          method_tag_problems
+            .concat variable_type_tag_problems
+            .concat const_problems
+            .concat call_problems
+        )
       end
     end
 
@@ -118,7 +120,12 @@ module Solargraph
     # @param pin [Pin::Base]
     # @return [Boolean]
     def resolved_constant? pin
-      api_map.get_constants('', pin.binder.tag).any? { |pin| pin.name == pin.return_type.namespace && ['Class', 'Module'].include?(pin.return_type.name) }
+      api_map.get_constants('', pin.binder.tag)
+        .select { |p| p.name == pin.return_type.namespace }
+        .any? do |p|
+          inferred = p.infer(api_map)
+          ['Class', 'Module'].include?(inferred.name)
+        end
     end
 
     def virtual_pin? pin
@@ -235,7 +242,7 @@ module Solargraph
             base = base.base
           end
           closest = found.typify(api_map) if found
-          if !found || (closest.defined? && internal_or_core?(found))
+          if !found || found.is_a?(Pin::BaseVariable) || (closest.defined? && internal_or_core?(found))
             unless ignored_pins.include?(found)
               result.push Problem.new(location, "Unresolved call to #{missing.links.last.word}")
               @marked_ranges.push rng
@@ -525,5 +532,12 @@ module Solargraph
       args.push Solargraph::Parser.chain_string('&') if with_block
       args
     end
+
+    def without_ignored problems
+      problems.reject do |problem|
+        node = source_map.source.node_at(problem.location.range.start.line, problem.location.range.start.column)
+        source_map.source.comments_for(node)&.include?('@sg-ignore')
+      end
+    end
   end
 end

data/lib/solargraph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Solargraph
-  VERSION = '0.45.0'
+  VERSION = '0.47.0'
 end

data/lib/solargraph/workspace.rb

@@ -2,6 +2,7 @@
 
 require 'open3'
 require 'rubygems'
+require 'json'
 
 module Solargraph
   # A workspace consists of the files in a project's directory and the

data/lib/solargraph/yard_map.rb

@@ -107,6 +107,11 @@ module Solargraph
       @unresolved_requires ||= []
     end
 
+    # @return [Array<String>]
+    def missing_docs
+      @missing_docs ||= []
+    end
+
     # @param y [String]
     # @return [YARD::Registry]
     def load_yardoc y
@@ -196,10 +201,11 @@ module Solargraph
       required.merge @gemset.keys if required.include?('bundler/require')
       pins.replace core_pins
       unresolved_requires.clear
+      missing_docs.clear
       stdlib_pins.clear
       environ = Convention.for_global(self)
       done = []
-      from_std = []
+      already_errored = []
       (required + environ.requires).each do |r|
         next if r.nil? || r.empty? || done.include?(r)
         done.push r
@@ -219,24 +225,18 @@ module Solargraph
           # 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?
+          if yd.nil?
+            process_error(r, result, already_errored, nil)
+            next
+          end
           @gem_paths[spec.name] = spec.full_gem_path
           unless yardocs.include?(yd)
             yardocs.unshift yd
             result.concat process_yardoc yd, spec
             result.concat add_gem_dependencies(spec) if with_dependencies?
           end
-        rescue Gem::LoadError, NoYardocError => e
-          base = r.split('/').first
-          next if from_std.include?(base)
-          from_std.push base
-          stdtmp = load_stdlib_pins(base)
-          if stdtmp.empty?
-            unresolved_requires.push r
-          else
-            stdlib_pins.concat stdtmp
-            result.concat stdtmp
-          end
+        rescue Gem::LoadError, NoYardocError
+          process_error(r, result, already_errored)
         end
         result.delete_if(&:nil?)
         unless result.empty?
@@ -253,6 +253,21 @@ module Solargraph
       pins.concat environ.pins
     end
 
+    def process_error(req, result, already_errored, yd = 1)
+      base = req.split('/').first
+      return if already_errored.include?(base)
+      already_errored.push base
+      stdtmp = load_stdlib_pins(base)
+      if yd.nil?
+        missing_docs.push req
+      elsif stdtmp.empty?
+        unresolved_requires.push req
+      else
+        stdlib_pins.concat stdtmp
+        result.concat stdtmp
+      end
+    end
+
     def process_gemsets
       return {} if directory.empty? || !File.file?(File.join(directory, 'Gemfile'))
       require_from_bundle(directory)
@@ -270,7 +285,7 @@ module Solargraph
           @gem_paths[depspec.name] = depspec.full_gem_path
           gy = yardoc_file_for_spec(depspec)
           if gy.nil?
-            unresolved_requires.push dep.name
+            missing_docs.push dep.name
           else
             next if yardocs.include?(gy)
             yardocs.unshift gy

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.45.0
+  version: 0.47.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-23 00:00:00.000000000 Z
+date: 2022-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -492,6 +492,7 @@ files:
 - lib/solargraph/pin/reference/prepend.rb
 - lib/solargraph/pin/reference/require.rb
 - lib/solargraph/pin/reference/superclass.rb
+- lib/solargraph/pin/search.rb
 - lib/solargraph/pin/singleton.rb
 - lib/solargraph/pin/symbol.rb
 - lib/solargraph/position.rb