solargraph 0.58.0 → 0.59.0

data/lib/solargraph/diagnostics/require_not_found.rb

@@ -1,53 +1,54 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Diagnostics
-    # RequireNotFound reports required paths that could not be resolved to
-    # either a file in the workspace or a gem.
-    #
-    class RequireNotFound < Base
-      def diagnose source, api_map
-        return [] unless source.parsed? && source.synchronized?
-        result = []
-        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)
-        end
-        result
-      end
-
-      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]
-      def require_error path, location
-        {
-          range: location.range.to_hash,
-          severity: Diagnostics::Severities::WARNING,
-          source: 'RequireNotFound',
-          message: "Required path #{path} could not be resolved."
-        }
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Diagnostics
+    # RequireNotFound reports required paths that could not be resolved to
+    # either a file in the workspace or a gem.
+    #
+    class RequireNotFound < Base
+      def diagnose source, api_map
+        return [] unless source.parsed? && source.synchronized?
+        result = []
+        refs = {}
+        # @sg-ignore Need to add nil check here
+        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)
+        end
+        result
+      end
+
+      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]
+      def require_error path, location
+        {
+          range: location.range.to_hash,
+          severity: Diagnostics::Severities::WARNING,
+          source: 'RequireNotFound',
+          message: "Required path #{path} could not be resolved."
+        }
+      end
+    end
+  end
+end

data/lib/solargraph/diagnostics/rubocop.rb

@@ -1,118 +1,119 @@
-# frozen_string_literal: true
-
-require 'stringio'
-
-module Solargraph
-  module Diagnostics
-    # This reporter provides linting through RuboCop.
-    #
-    class Rubocop < Base
-      include RubocopHelpers
-
-      # Conversion of RuboCop severity names to LSP constants
-      SEVERITIES = {
-        'info' => Severities::HINT,
-        'refactor' => Severities::HINT,
-        'convention' => Severities::INFORMATION,
-        'warning' => Severities::WARNING,
-        'error' => Severities::ERROR,
-        'fatal' => Severities::ERROR
-      }
-
-      # @param source [Solargraph::Source]
-      # @param _api_map [Solargraph::ApiMap]
-      # @return [Array<Hash>]
-      def diagnose source, _api_map
-        @source = source
-        require_rubocop(rubocop_version)
-        options, paths = generate_options(source.filename, source.code)
-        store = RuboCop::ConfigStore.new
-        runner = RuboCop::Runner.new(options, store)
-        # Ensure only one instance of RuboCop::Runner is running at
-        # a time - it uses 'chdir' to read config files with ERB,
-        # which can conflict with other chdirs.
-        result = Solargraph::CHDIR_MUTEX.synchronize do
-          redirect_stdout{ runner.run(paths) }
-        end
-
-        return [] if result.empty?
-
-        make_array JSON.parse(result)
-      rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
-        raise DiagnosticsError, "Error in RuboCop configuration: #{e.message}"
-      rescue JSON::ParserError => e
-        raise DiagnosticsError, "RuboCop returned invalid data: #{e.message}"
-      end
-
-      private
-
-      # Extracts the rubocop version from _args_
-      #
-      # @return [String]
-      def rubocop_version
-        args.find { |a| a =~ /version=/ }.to_s.split('=').last
-      end
-
-      # @param resp [Hash{String => Array<Hash{String => Array<Hash{String => undefined}>}>}]
-      # @return [Array<Hash>]
-      def make_array resp
-        diagnostics = []
-        resp['files'].each do |file|
-          file['offenses'].each do |off|
-            diagnostics.push offense_to_diagnostic(off)
-          end
-        end
-        diagnostics
-      end
-
-      # Convert a RuboCop offense to an LSP diagnostic
-      #
-      # @param off [Hash{String => unknown}] Offense received from Rubocop
-      # @return [Hash{Symbol => Hash, String, Integer}] LSP diagnostic
-      def offense_to_diagnostic off
-        {
-          range: offense_range(off).to_hash,
-          # 1 = Error, 2 = Warning, 3 = Information, 4 = Hint
-          severity: SEVERITIES[off['severity']],
-          source: 'rubocop',
-          code: off['cop_name'],
-          message: off['message'].gsub(/^#{off['cop_name']}\:/, '')
-        }
-      end
-
-      # @param off [Hash]
-      # @return [Range]
-      def offense_range off
-        Range.new(offense_start_position(off), offense_ending_position(off))
-      end
-
-      # @param off [Hash{String => Hash{String => Integer}}]
-      # @return [Position]
-      def offense_start_position off
-        Position.new(off['location']['start_line'] - 1, off['location']['start_column'] - 1)
-      end
-
-      # @param off [Hash{String => Hash{String => Integer}}]
-      # @return [Position]
-      def offense_ending_position off
-        if off['location']['start_line'] != off['location']['last_line']
-          Position.new(off['location']['start_line'], 0)
-        else
-          start_line = off['location']['start_line'] - 1
-          # @type [Integer]
-          last_column = off['location']['last_column']
-          line = @source.code.lines[start_line]
-          col_off = if line.nil? || line.empty?
-            1
-          else
-            0
-          end
-
-          Position.new(
-            start_line, last_column - col_off
-          )
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'stringio'
+
+module Solargraph
+  module Diagnostics
+    # This reporter provides linting through RuboCop.
+    #
+    class Rubocop < Base
+      include RubocopHelpers
+
+      # Conversion of RuboCop severity names to LSP constants
+      SEVERITIES = {
+        'info' => Severities::HINT,
+        'refactor' => Severities::HINT,
+        'convention' => Severities::INFORMATION,
+        'warning' => Severities::WARNING,
+        'error' => Severities::ERROR,
+        'fatal' => Severities::ERROR
+      }.freeze
+
+      # @param source [Solargraph::Source]
+      # @param _api_map [Solargraph::ApiMap]
+      # @return [Array<Hash>]
+      def diagnose source, _api_map
+        @source = source
+        require_rubocop(rubocop_version)
+        # @sg-ignore Need to add nil check here
+        options, paths = generate_options(source.filename, source.code)
+        store = RuboCop::ConfigStore.new
+        runner = RuboCop::Runner.new(options, store)
+        # Ensure only one instance of RuboCop::Runner is running at
+        # a time - it uses 'chdir' to read config files with ERB,
+        # which can conflict with other chdirs.
+        result = Solargraph::CHDIR_MUTEX.synchronize do
+          redirect_stdout { runner.run(paths) }
+        end
+
+        return [] if result.empty?
+
+        make_array JSON.parse(result)
+      rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
+        raise DiagnosticsError, "Error in RuboCop configuration: #{e.message}"
+      rescue JSON::ParserError => e
+        raise DiagnosticsError, "RuboCop returned invalid data: #{e.message}"
+      end
+
+      private
+
+      # Extracts the rubocop version from _args_
+      #
+      # @return [String]
+      def rubocop_version
+        args.find { |a| a =~ /version=/ }.to_s.split('=').last
+      end
+
+      # @param resp [Hash{String => Array<Hash{String => Array<Hash{String => undefined}>}>}]
+      # @return [Array<Hash>]
+      def make_array resp
+        diagnostics = []
+        resp['files'].each do |file|
+          file['offenses'].each do |off|
+            diagnostics.push offense_to_diagnostic(off)
+          end
+        end
+        diagnostics
+      end
+
+      # Convert a RuboCop offense to an LSP diagnostic
+      #
+      # @param off [Hash{String => unknown}] Offense received from Rubocop
+      # @return [Hash{Symbol => Hash, String, Integer}] LSP diagnostic
+      def offense_to_diagnostic off
+        {
+          range: offense_range(off).to_hash,
+          # 1 = Error, 2 = Warning, 3 = Information, 4 = Hint
+          severity: SEVERITIES[off['severity']],
+          source: 'rubocop',
+          code: off['cop_name'],
+          message: off['message'].gsub(/^#{off['cop_name']}:/, '')
+        }
+      end
+
+      # @param off [Hash]
+      # @return [Range]
+      def offense_range off
+        Range.new(offense_start_position(off), offense_ending_position(off))
+      end
+
+      # @param off [Hash{String => Hash{String => Integer}}]
+      # @return [Position]
+      def offense_start_position off
+        Position.new(off['location']['start_line'] - 1, off['location']['start_column'] - 1)
+      end
+
+      # @param off [Hash{String => Hash{String => Integer}}]
+      # @return [Position]
+      def offense_ending_position off
+        if off['location']['start_line'] == off['location']['last_line']
+          start_line = off['location']['start_line'] - 1
+          # @type [Integer]
+          last_column = off['location']['last_column']
+          line = @source.code.lines[start_line]
+          col_off = if line.nil? || line.empty?
+                      1
+                    else
+                      0
+                    end
+
+          Position.new(
+            start_line, last_column - col_off
+          )
+        else
+          Position.new(off['location']['start_line'], 0)
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -1,68 +1,70 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Diagnostics
-    # Utility methods for the RuboCop diagnostics reporter.
-    #
-    module RubocopHelpers
-      module_function
-
-      # Requires a specific version of rubocop, or the latest installed version
-      # if _version_ is `nil`.
-      #
-      # @param version [String, nil]
-      # @raise [InvalidRubocopVersionError] if _version_ is not installed
-      # @return [void]
-      def require_rubocop(version = nil)
-        begin
-          # @type [String]
-          gem_path = Gem::Specification.find_by_name('rubocop', version).full_gem_path
-          gem_lib_path = File.join(gem_path, 'lib')
-          $LOAD_PATH.unshift(gem_lib_path) unless $LOAD_PATH.include?(gem_lib_path)
-        rescue Gem::MissingSpecVersionError => e
-          # @type [Array<Gem::Specification>]
-          specs = e.specs
-          raise InvalidRubocopVersionError,
-                "could not find '#{e.name}' (#{e.requirement}) - "\
-                "did find: [#{specs.map { |s| s.version.version }.join(', ')}]"
-        end
-        require 'rubocop'
-      end
-
-      # Generate command-line options for the specified filename and code.
-      #
-      # @param filename [String]
-      # @param code [String]
-      # @return [Array(Array<String>, Array<String>)]
-      def generate_options filename, code
-        args = ['-f', 'j', '--force-exclusion', filename]
-        base_options = RuboCop::Options.new
-        options, paths = base_options.parse(args)
-        # @sg-ignore
-        options[:stdin] = code
-        [options, paths]
-      end
-
-      # RuboCop internally uses capitalized drive letters for Windows paths,
-      # so we need to convert the paths provided to the command.
-      #
-      # @param path [String]
-      # @return [String]
-      def fix_drive_letter path
-        return path unless path.match(/^[a-z]:/)
-        path[0].upcase + path[1..-1]
-      end
-
-      # @todo This is a smelly way to redirect output, but the RuboCop specs do
-      #   the same thing.
-      # @return [String]
-      def redirect_stdout
-        redir = StringIO.new
-        $stdout = redir
-        yield if block_given?
-        $stdout = STDOUT
-        redir.string
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Diagnostics
+    # Utility methods for the RuboCop diagnostics reporter.
+    #
+    module RubocopHelpers
+      module_function
+
+      # Requires a specific version of rubocop, or the latest installed version
+      # if _version_ is `nil`.
+      #
+      # @param version [String, nil]
+      # @raise [InvalidRubocopVersionError] if _version_ is not installed
+      # @return [void]
+      def require_rubocop version = nil
+        begin
+          # @type [String]
+          gem_path = Gem::Specification.find_by_name('rubocop', version).full_gem_path
+          gem_lib_path = File.join(gem_path, 'lib')
+          # @sg-ignore Should better support meaning of '&' in RBS
+          $LOAD_PATH.unshift(gem_lib_path) unless $LOAD_PATH.include?(gem_lib_path)
+        rescue Gem::MissingSpecVersionError => e
+          # @type [Array<Gem::Specification>]
+          specs = e.specs
+          raise InvalidRubocopVersionError,
+                "could not find '#{e.name}' (#{e.requirement}) - " \
+                "did find: [#{specs.map { |s| s.version.version }.join(', ')}]"
+        end
+        require 'rubocop'
+      end
+
+      # Generate command-line options for the specified filename and code.
+      #
+      # @param filename [String]
+      # @param code [String]
+      # @return [Array(Array<String>, Array<String>)]
+      def generate_options filename, code
+        args = ['-f', 'j', '--force-exclusion', filename]
+        base_options = RuboCop::Options.new
+        options, paths = base_options.parse(args)
+        # @sg-ignore
+        options[:stdin] = code
+        [options, paths]
+      end
+
+      # RuboCop internally uses capitalized drive letters for Windows paths,
+      # so we need to convert the paths provided to the command.
+      #
+      # @param path [String]
+      # @return [String]
+      def fix_drive_letter path
+        return path unless path.match(/^[a-z]:/)
+        # @sg-ignore Need to add nil check here
+        path[0].upcase + path[1..]
+      end
+
+      # @todo This is a smelly way to redirect output, but the RuboCop specs do
+      #   the same thing.
+      # @return [String]
+      def redirect_stdout
+        redir = StringIO.new
+        $stdout = redir
+        yield if block_given?
+        $stdout = STDOUT
+        redir.string
+      end
+    end
+  end
+end

data/lib/solargraph/diagnostics/type_check.rb

@@ -1,55 +1,56 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Diagnostics
-    # TypeCheck reports methods with undefined return types, untagged
-    # parameters, and invalid param tags.
-    #
-    class TypeCheck < Base
-      # @return [Array<Hash>]
-      def diagnose source, api_map
-        # return [] unless args.include?('always') || api_map.workspaced?(source.filename)
-        severity = Diagnostics::Severities::ERROR
-        level = (args.reverse.find { |a| ['normal', 'typed', 'strict', 'strong'].include?(a) }) || :normal
-        checker = Solargraph::TypeChecker.new(source.filename, api_map: api_map, level: level.to_sym)
-        checker.problems
-          .sort { |a, b| a.location.range.start.line <=> b.location.range.start.line }
-          .map do |problem|
-            {
-              range: extract_first_line(problem.location, source),
-              severity: severity,
-              source: 'Typecheck',
-              message: problem.message
-            }
-          end
-      end
-
-      private
-
-      # @param location [Location]
-      # @param source [Source]
-      # @return [Hash]
-      def extract_first_line location, source
-        return location.range.to_hash if location.range.start.line == location.range.ending.line
-        {
-          start: {
-            line: location.range.start.line,
-            character: location.range.start.character
-          },
-          end: {
-            line: location.range.start.line,
-            character: last_character(location.range.start, source)
-          }
-        }
-      end
-
-      # @param position [Solargraph::Position]
-      # @param source [Solargraph::Source]
-      # @return [Integer]
-      def last_character position, source
-        cursor = Position.to_offset(source.code, position)
-        source.code.index(/[\r\n]/, cursor) || source.code.length
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Diagnostics
+    # TypeCheck reports methods with undefined return types, untagged
+    # parameters, and invalid param tags.
+    #
+    class TypeCheck < Base
+      # @return [Array<Hash>]
+      def diagnose source, api_map
+        # return [] unless args.include?('always') || api_map.workspaced?(source.filename)
+        severity = Diagnostics::Severities::ERROR
+        level = args.reverse.find { |a| %w[normal typed strict strong].include?(a) } || :normal
+        # @sg-ignore sensitive typing needs to handle || on nil types
+        checker = Solargraph::TypeChecker.new(source.filename, api_map: api_map, level: level.to_sym)
+        checker.problems
+               .sort { |a, b| a.location.range.start.line <=> b.location.range.start.line }
+               .map do |problem|
+          {
+            range: extract_first_line(problem.location, source),
+            severity: severity,
+            source: 'Typecheck',
+            message: problem.message
+          }
+        end
+      end
+
+      private
+
+      # @param location [Location]
+      # @param source [Source]
+      # @return [Hash]
+      def extract_first_line location, source
+        return location.range.to_hash if location.range.start.line == location.range.ending.line
+        {
+          start: {
+            line: location.range.start.line,
+            character: location.range.start.character
+          },
+          end: {
+            line: location.range.start.line,
+            character: last_character(location.range.start, source)
+          }
+        }
+      end
+
+      # @param position [Solargraph::Position]
+      # @param source [Solargraph::Source]
+      # @return [Integer]
+      def last_character position, source
+        cursor = Position.to_offset(source.code, position)
+        source.code.index(/[\r\n]/, cursor) || source.code.length
+      end
+    end
+  end
+end