solargraph 0.47.1 → 0.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d697adb07ecb0f68c08da0001decead501d9c755bf79b3870c0e3f67c062d6c
-  data.tar.gz: 191141aee5b75aa20a514bbc807df5c058823094afa99d9948bada9067c3eb8b
+  metadata.gz: 7531e9e085d6b9645a2d44a9aa020d661769a05ebe9b15377d91d0217f1cebd1
+  data.tar.gz: 63d27c2e39cac69742d77866ba7c5ef49634d8598cc10aa8427ec150bf70d12b
 SHA512:
-  metadata.gz: fa47406469782b55edc3f75d6a4474d6730153333a40ac76092ca0586a7935f9ad36b44dfb641df35b48317c0e5fffb6d722dbe0df88833130da534c33ae80b6
-  data.tar.gz: 5fb3c3e20abaa8b90375213601ec354ef936bfb7cc2f49fba44f6af3254e864ae38beaf6668186931a33fcd72d587fe5a29a67122cb3a65b2d85dd6deba6c147
+  metadata.gz: 38929be15a4be6b9995f7b471a9fed4f51541027822bd92b78b2f6ca426a9b42477491c324066ea312f31ebeb43a73a373a457454edc8c14390ab25f403c727d
+  data.tar.gz: 1c16b8046376cde3f1a1393ca12b060b708b4c5be1c1e9ee4f2be0f03b2443c6dcbc77bce3190ce47cff7fe2f7726e0963a3f05e00956dadd5628c2a437aeab3

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.48.0 - December 19, 2022
+- Add Sublime Text to README (#604)
+- Map nested constant assignments
+- Handle rest/kwrest modifiers on overload arguments (#601)
+- Make rubocop info severity Severity::HINT (#576)
+- Process non-self singleton classes (#581)
+- Fix nest gemspec dependency (#599)
+- Strip 'file ' prefix from all filenames in RdocToYard (#585)
+- Show why rubocop fails (#605)
+- Link solargraph-rails (#611)
+
+## 0.47.2 - September 30, 2022
+- Fix complex type inference (#578)
+- Off-by-one diagnostic (#595)
+
 ## 0.47.1 - September 27, 2022
 - Remove debug code from release (#600)
 

data/README.md

@@ -32,6 +32,11 @@ Plug-ins and extensions are available for the following editors:
     * Package: https://atom.io/packages/ruby-solargraph
     * GitHub: https://github.com/castwide/atom-solargraph
 
+* **Sublime Text**
+    * Extension: https://packagecontrol.io/packages/LSP
+    * GitHub: https://github.com/sublimelsp/LSP
+    * Instructions: https://lsp.sublimetext.io/language_servers/#solargraph
+
 * **Vim**
     * GitHub: `LanguageClient-neovim`, https://github.com/autozimu/LanguageClient-neovim
     * GitHub: `coc`, https://github.com/neoclide/coc-solargraph
@@ -49,6 +54,9 @@ Plug-ins and extensions are available for the following editors:
 
 Solargraph's behavior can be controlled via optional [configuration](https://solargraph.org/guides/configuration) files. The highest priority file is a `.solargraph.yml` file at the root of the project. If not present, any global configuration at `~/.config/solargraph/config.yml` will apply. The path to the global configuration can be overridden with the `SOLARGRAPH_GLOBAL_CONFIG` environment variable.
 
+### Rails Support
+For better Rails support, please consider using [solargraph-rails](https://github.com/iftheshoefritz/solargraph-rails/)
+
 ### Gem Support
 
 Solargraph is capable of providing code completion and documentation for gems that have YARD documentation. You can make sure your gems are documented by running `yard gems` from the command line. (YARD is included as one of Solargraph's gem dependencies. The first time you run it might take a while if you have a lot of gems installed).

data/lib/solargraph/complex_type/type_methods.rb

@@ -125,6 +125,13 @@ module Solargraph
           Solargraph::ComplexType.parse(fqns)
         end
       end
+
+      # @yieldparam [UniqueType]
+      # @return [Enumerator<UniqueType>]
+      def each_unique_type &block
+        return enum_for(__method__) unless block_given?
+        yield self
+      end
     end
   end
 end

data/lib/solargraph/complex_type.rb

@@ -40,6 +40,16 @@ module Solargraph
       @items.each &block
     end
 
+    # @yieldparam [UniqueType]
+    # @return [Enumerator<UniqueType>]
+    def each_unique_type &block
+      return enum_for(__method__) unless block_given?
+
+      @items.each do |item|
+        item.each_unique_type &block
+      end
+    end
+
     def length
       @items.length
     end
@@ -74,6 +84,10 @@ module Solargraph
       @items.all? &block
     end
 
+    def any? &block
+      @items.any? &block
+    end
+
     def selfy?
       @items.any?(&:selfy?)
     end

data/lib/solargraph/diagnostics/rubocop.rb

@@ -11,6 +11,7 @@ module Solargraph
 
       # Conversion of RuboCop severity names to LSP constants
       SEVERITIES = {
+        'info' => Severities::HINT,
         'refactor' => Severities::HINT,
         'convention' => Severities::INFORMATION,
         'warning' => Severities::WARNING,
@@ -31,7 +32,7 @@ module Solargraph
       rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
         raise DiagnosticsError, "Error in RuboCop configuration: #{e.message}"
       rescue JSON::ParserError
-        raise DiagnosticsError, 'RuboCop returned invalid data'
+        raise DiagnosticsError, "RuboCop returned invalid data: #{e.message}"
       end
 
       private
@@ -89,7 +90,7 @@ module Solargraph
           Position.new(off['location']['start_line'], 0)
         else
           Position.new(
-            off['location']['start_line'] - 1, off['location']['last_column']
+            off['location']['start_line'] - 1, off['location']['last_column'] - 1
           )
         end
       end

data/lib/solargraph/parser/legacy/node_processors/casgn_node.rb

@@ -8,16 +8,26 @@ module Solargraph
           include Legacy::NodeMethods
 
           def process
-            here = get_node_start_position(node)
             pins.push Solargraph::Pin::Constant.new(
               location: get_node_location(node),
               closure: region.closure,
-              name: node.children[1].to_s,
+              name: const_name,
               comments: comments_for(node),
               assignment: node.children[2]
             )
             process_children
           end
+
+          private
+
+          # @return [String]
+          def const_name
+            if node.children[0]
+              Parser::NodeMethods.unpack_name(node.children[0]) + "::#{node.children[1]}"
+            else
+              node.children[1].to_s
+            end
+          end
         end
       end
     end

data/lib/solargraph/parser/legacy/node_processors/sclass_node.rb

@@ -6,11 +6,32 @@ module Solargraph
       module NodeProcessors
         class SclassNode < Parser::NodeProcessor::Base
           def process
-            # @todo Temporarily skipping remote metaclasses
-            return unless node.children[0].is_a?(AST::Node) && node.children[0].type == :self
+            sclass = node.children[0]
+            if sclass.is_a?(AST::Node) && sclass.type == :self
+              closure = region.closure
+            elsif sclass.is_a?(AST::Node) && sclass.type == :casgn
+              names = [region.closure.namespace, region.closure.name]
+              if sclass.children[0].nil? && names.last != sclass.children[1].to_s
+                names << sclass.children[1].to_s
+              else
+                names.concat [NodeMethods.unpack_name(sclass.children[0]), sclass.children[1].to_s]
+              end
+              name = names.reject(&:empty?).join('::')
+              closure = Solargraph::Pin::Namespace.new(name: name, location: region.closure.location)
+            elsif sclass.is_a?(AST::Node) && sclass.type == :const
+              names = [region.closure.namespace, region.closure.name]
+              also = NodeMethods.unpack_name(sclass)
+              if also != region.closure.name
+                names << also
+              end
+              name = names.reject(&:empty?).join('::')
+              closure = Solargraph::Pin::Namespace.new(name: name, location: region.closure.location)
+            else
+              return
+            end
             pins.push Solargraph::Pin::Singleton.new(
               location: get_node_location(node),
-              closure: region.closure
+              closure: closure
             )
             process_children region.update(visibility: :public, scope: :class, closure: pins.last)
           end

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

@@ -9,12 +9,23 @@ module Solargraph
             pins.push Solargraph::Pin::Constant.new(
               location: get_node_location(node),
               closure: region.closure,
-              name: node.children[0].to_s,
+              name: const_name,
               comments: comments_for(node),
-              assignment: node.children[1]
+              assignment: node.children[2] || node.children[1]
             )
             process_children
           end
+
+          private
+
+          # @return [String]
+          def const_name
+            if Parser.is_ast_node?(node.children[0])
+              Parser::NodeMethods.unpack_name(node.children[0])
+            else
+              node.children[0].to_s
+            end
+          end
         end
       end
     end

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

@@ -6,11 +6,22 @@ module Solargraph
       module NodeProcessors
         class SclassNode < Parser::NodeProcessor::Base
           def process
-            # @todo Temporarily skipping remote metaclasses
-            return unless node.children[0].is_a?(RubyVM::AbstractSyntaxTree::Node) && node.children[0].type == :SELF
+            sclass = node.children[0]
+            if sclass.is_a?(RubyVM::AbstractSyntaxTree::Node) && sclass.type == :SELF
+              closure = region.closure
+            elsif sclass.is_a?(RubyVM::AbstractSyntaxTree::Node) && %i[CDECL CONST].include?(sclass.type)
+              names = [region.closure.namespace, region.closure.name]
+              if names.last != sclass.children[0].to_s
+                names << sclass.children[0].to_s
+              end
+              name = names.reject(&:empty?).join('::')
+              closure = Solargraph::Pin::Namespace.new(name: name, location: region.closure.location)
+            else
+              return
+            end
             pins.push Solargraph::Pin::Singleton.new(
               location: get_node_location(node),
-              closure: region.closure
+              closure: closure
             )
             process_children region.update(visibility: :public, scope: :class, closure: pins.last)
           end

data/lib/solargraph/pin/method.rb

@@ -124,13 +124,14 @@ module Solargraph
             closure: self,
             # args: tag.parameters.map(&:first),
             parameters: tag.parameters.map do |src|
+              name, decl = parse_overload_param(src.first)
               Pin::Parameter.new(
                 location: location,
                 closure: self,
                 comments: tag.docstring.all.to_s,
-                name: src.first,
+                name: name,
                 presence: location ? location.range : nil,
-                decl: :arg
+                decl: decl
               )
             end,
             comments: tag.docstring.all.to_s
@@ -240,6 +241,21 @@ module Solargraph
         return ComplexType::UNDEFINED if types.empty?
         ComplexType.try_parse(*types.map(&:tag).uniq)
       end
+
+      # When YARD parses an overload tag, it includes rest modifiers in the parameters names.
+      #
+      # @param arg [String]
+      # @return [Array(String, Symbol)]
+      def parse_overload_param(name)
+        if name.start_with?('**')
+          [name[2..-1], :kwrestarg]
+        elsif name.start_with?('*')
+          [name[1..-1], :restarg]
+        else
+          [name, :arg]
+        end
+      end
+
     end
   end
 end

data/lib/solargraph/source/chain/call.rb

@@ -35,7 +35,10 @@ module Solargraph
             []
           end
           return inferred_pins(found, api_map, name_pin.context, locals) unless found.empty?
-          pins = api_map.get_method_stack(name_pin.binder.namespace, word, scope: name_pin.binder.scope)
+          # @param [ComplexType::UniqueType]
+          pins = name_pin.binder.each_unique_type.flat_map do |context|
+            api_map.get_method_stack(context.namespace, word, scope: context.scope)
+          end
           return [] if pins.empty?
           inferred_pins(pins, api_map, name_pin.context, locals)
         end

data/lib/solargraph/type_checker/checks.rb

@@ -61,6 +61,19 @@ module Solargraph
         false
       end
 
+      # @param api_map [ApiMap]
+      # @param inferred [ComplexType]
+      # @param expected [ComplexType]
+      # @return [Boolean]
+      def all_types_match? api_map, inferred, expected
+        return duck_types_match?(api_map, expected, inferred) if expected.duck_type?
+        inferred.each do |inf|
+          next if inf.duck_type?
+          return false unless expected.any? { |exp| exp == inf || either_way?(api_map, inf, exp) }
+        end
+        true
+      end
+
       # @param api_map [ApiMap]
       # @param expected [ComplexType]
       # @param inferred [ComplexType]

data/lib/solargraph/type_checker.rb

@@ -105,7 +105,7 @@ module Solargraph
               result.push Problem.new(pin.location, "#{pin.path} return type could not be inferred", pin: pin)
             end
           else
-            unless (rules.rank > 1 ? types_match?(api_map, declared, inferred) : any_types_match?(api_map, declared, inferred))
+            unless (rules.rank > 1 ? all_types_match?(api_map, inferred, declared) : any_types_match?(api_map, declared, inferred))
               result.push Problem.new(pin.location, "Declared return type #{declared} does not match inferred type #{inferred} for #{pin.path}", pin: pin)
             end
           end
@@ -177,7 +177,7 @@ module Solargraph
                   result.push Problem.new(pin.location, "Variable type could not be inferred for #{pin.name}", pin: pin)
                 end
               else
-                unless (rules.rank > 1 ? types_match?(api_map, declared, inferred) : any_types_match?(api_map, declared, inferred))
+                unless any_types_match?(api_map, declared, inferred)
                   result.push Problem.new(pin.location, "Declared type #{declared} does not match inferred type #{inferred} for variable #{pin.name}", pin: pin)
                 end
               end

data/lib/solargraph/version.rb

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

data/lib/solargraph/yard_map/rdoc_to_yard.rb

@@ -129,11 +129,14 @@ module Solargraph
       end
 
       def self.find_file obj
-        if obj.respond_to?(:in_files) && !obj.in_files.empty?
-          [obj.in_files.first.to_s.sub(/^file /, ''), obj.line]
+        file = if obj.respond_to?(:in_files) && !obj.in_files.empty?
+          obj.in_files.first
         else
-          [obj.file, obj.line]
+          obj.file
         end
+
+        file = file.to_s.sub(/^file /, '') unless file.nil?
+        [file, obj.line]
       end
     end
   end

data/lib/solargraph/yard_map.rb

@@ -214,30 +214,7 @@ module Solargraph
           pins.concat cached
           next
         end
-        result = []
-        begin
-          spec = spec_for_require(r)
-          if @source_gems.include?(spec.name)
-            next
-          end
-          next if @gem_paths.key?(spec.name)
-          yd = yardoc_file_for_spec(spec)
-          # 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.
-          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
-          process_error(r, result, already_errored)
-        end
+        result = pins_for_require r, already_errored
         result.delete_if(&:nil?)
         unless result.empty?
           cache.set_path_pins r, result
@@ -273,31 +250,36 @@ module Solargraph
       require_from_bundle(directory)
     end
 
-    # @param spec [Gem::Specification]
-    # @return [void]
-    def add_gem_dependencies spec
+    # @param r [String]
+    def pins_for_require r, already_errored
       result = []
-      (spec.dependencies - spec.development_dependencies).each do |dep|
-        begin
-          next if @source_gems.include?(dep.name) || @gem_paths.key?(dep.name)
-          depspec = Gem::Specification.find_by_name(dep.name)
-          next if depspec.nil?
-          @gem_paths[depspec.name] = depspec.full_gem_path
-          gy = yardoc_file_for_spec(depspec)
-          if gy.nil?
-            missing_docs.push dep.name
-          else
-            next if yardocs.include?(gy)
-            yardocs.unshift gy
-            result.concat process_yardoc gy, depspec
-            result.concat add_gem_dependencies(depspec)
+      begin
+        name = r.split('/').first
+        return [] if @source_gems.include?(name) || @gem_paths.key?(name)
+        spec = spec_for_require(name)
+        @gem_paths[name] = spec.full_gem_path
+
+        yd = yardoc_file_for_spec(spec)
+        # 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.
+        if yd.nil?
+          process_error(r, result, already_errored, nil)
+          return []
+        end
+        unless yardocs.include?(yd)
+          yardocs.unshift yd
+          result.concat process_yardoc yd, spec
+          if with_dependencies?
+            (spec.dependencies - spec.development_dependencies).each do |dep|
+              result.concat pins_for_require dep.name, already_errored
+            end
           end
-        rescue Gem::LoadError
-          # This error probably indicates a bug in an installed gem
-          Solargraph::Logging.logger.warn "Failed to resolve #{dep.name} gem dependency for #{spec.name}"
         end
+      rescue Gem::LoadError, NoYardocError
+        process_error(r, result, already_errored)
       end
-      result
+      return result
     end
 
     # @param y [String, nil]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.47.1
+  version: 0.48.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-27 00:00:00.000000000 Z
+date: 2022-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport