solargraph 0.45.0 → 0.46.0

data/lib/solargraph/convention.rb

@@ -1,47 +1,47 @@
-# frozen_string_literal: true
-
-require 'set'
-
-module Solargraph
-  # Conventions provide a way to modify an ApiMap based on expectations about
-  # one of its sources.
-  #
-  module Convention
-    autoload :Base,    'solargraph/convention/base'
-    autoload :Gemfile, 'solargraph/convention/gemfile'
-    autoload :Rspec,   'solargraph/convention/rspec'
-    autoload :Gemspec, 'solargraph/convention/gemspec'
-
-    @@conventions = Set.new
-
-    # @param convention [Class<Convention::Base>]
-    # @return [void]
-    def self.register convention
-      @@conventions.add convention.new
-    end
-
-    # @param source_map [SourceMap]
-    # @return [Environ]
-    def self.for_local(source_map)
-      result = Environ.new
-      @@conventions.each do |conv|
-        result.merge conv.local(source_map)
-      end
-      result
-    end
-
-    # @param yard_map [YardMap]
-    # @return [Environ]
-    def self.for_global(yard_map)
-      result = Environ.new
-      @@conventions.each do |conv|
-        result.merge conv.global(yard_map)
-      end
-      result
-    end
-
-    register Gemfile
-    register Gemspec
-    register Rspec
-  end
-end
+# frozen_string_literal: true
+
+require 'set'
+
+module Solargraph
+  # Conventions provide a way to modify an ApiMap based on expectations about
+  # one of its sources.
+  #
+  module Convention
+    autoload :Base,    'solargraph/convention/base'
+    autoload :Gemfile, 'solargraph/convention/gemfile'
+    autoload :Rspec,   'solargraph/convention/rspec'
+    autoload :Gemspec, 'solargraph/convention/gemspec'
+
+    @@conventions = Set.new
+
+    # @param convention [Class<Convention::Base>]
+    # @return [void]
+    def self.register convention
+      @@conventions.add convention.new
+    end
+
+    # @param source_map [SourceMap]
+    # @return [Environ]
+    def self.for_local(source_map)
+      result = Environ.new
+      @@conventions.each do |conv|
+        result.merge conv.local(source_map)
+      end
+      result
+    end
+
+    # @param yard_map [YardMap]
+    # @return [Environ]
+    def self.for_global(yard_map)
+      result = Environ.new
+      @@conventions.each do |conv|
+        result.merge conv.global(yard_map)
+      end
+      result
+    end
+
+    register Gemfile
+    register Gemspec
+    register Rspec
+  end
+end

data/lib/solargraph/converters/dd.rb

@@ -1,12 +1,12 @@
-module ReverseMarkdown
-  module Converters
-    class Dd < Base
-      def convert node, state = {}
-        content = treat_children(node, state)
-        ": #{content.strip}\n"
-      end
-    end
-  end
-end
-
-ReverseMarkdown::Converters.register :dd, ReverseMarkdown::Converters::Dd.new
+module ReverseMarkdown
+  module Converters
+    class Dd < Base
+      def convert node, state = {}
+        content = treat_children(node, state)
+        ": #{content.strip}\n"
+      end
+    end
+  end
+end
+
+ReverseMarkdown::Converters.register :dd, ReverseMarkdown::Converters::Dd.new

data/lib/solargraph/converters/dl.rb

@@ -1,12 +1,12 @@
-module ReverseMarkdown
-  module Converters
-    class Dl < Base
-      def convert node, state = {}
-        content = treat_children(node, state).strip
-        "\n\n#{content}\n"
-      end
-    end
-  end
-end
-
-ReverseMarkdown::Converters.register :dl, ReverseMarkdown::Converters::Dl.new
+module ReverseMarkdown
+  module Converters
+    class Dl < Base
+      def convert node, state = {}
+        content = treat_children(node, state).strip
+        "\n\n#{content}\n"
+      end
+    end
+  end
+end
+
+ReverseMarkdown::Converters.register :dl, ReverseMarkdown::Converters::Dl.new

data/lib/solargraph/converters/dt.rb

@@ -1,12 +1,12 @@
-module ReverseMarkdown
-  module Converters
-    class Dt < Base
-      def convert node, state = {}
-        content = treat_children(node, state)
-        "\n#{content.strip}\n"
-      end
-    end
-  end
-end
-
-ReverseMarkdown::Converters.register :dt, ReverseMarkdown::Converters::Dt.new
+module ReverseMarkdown
+  module Converters
+    class Dt < Base
+      def convert node, state = {}
+        content = treat_children(node, state)
+        "\n#{content.strip}\n"
+      end
+    end
+  end
+end
+
+ReverseMarkdown::Converters.register :dt, ReverseMarkdown::Converters::Dt.new

data/lib/solargraph/converters/misc.rb

@@ -1 +1 @@
-ReverseMarkdown::Converters.register :tt, ReverseMarkdown::Converters::Code.new
+ReverseMarkdown::Converters.register :tt, ReverseMarkdown::Converters::Code.new

data/lib/solargraph/diagnostics/base.rb

@@ -1,29 +1,29 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Diagnostics
-    # The base class for diagnostics reporters.
-    #
-    class Base
-      # @return [Array<String>]
-      attr_reader :args
-
-      def initialize *args
-        @args = args
-      end
-
-      # Perform a diagnosis on a Source within the context of an ApiMap.
-      # The result is an array of hash objects that conform to the LSP's
-      # Diagnostic specification.
-      #
-      # Subclasses should override this method.
-      #
-      # @param source [Solargraph::Source]
-      # @param api_map [Solargraph::ApiMap]
-      # @return [Array<Hash>]
-      def diagnose source, api_map
-        []
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Diagnostics
+    # The base class for diagnostics reporters.
+    #
+    class Base
+      # @return [Array<String>]
+      attr_reader :args
+
+      def initialize *args
+        @args = args
+      end
+
+      # Perform a diagnosis on a Source within the context of an ApiMap.
+      # The result is an array of hash objects that conform to the LSP's
+      # Diagnostic specification.
+      #
+      # Subclasses should override this method.
+      #
+      # @param source [Solargraph::Source]
+      # @param api_map [Solargraph::ApiMap]
+      # @return [Array<Hash>]
+      def diagnose source, api_map
+        []
+      end
+    end
+  end
+end

data/lib/solargraph/diagnostics/require_not_found.rb

@@ -1,37 +1,53 @@
-# 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.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 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 = {}
+        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,98 +1,98 @@
-# 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 = {
-        '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
-        require_rubocop(rubocop_version)
-        options, paths = generate_options(source.filename, source.code)
-        store = RuboCop::ConfigStore.new
-        runner = RuboCop::Runner.new(options, store)
-        result = redirect_stdout{ runner.run(paths) }
-        make_array JSON.parse(result)
-      rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
-        raise DiagnosticsError, "Error in RuboCop configuration: #{e.message}"
-      rescue JSON::ParserError
-        raise DiagnosticsError, 'RuboCop returned invalid data'
-      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]
-      # @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] Offense received from Rubocop
-      # @return [Hash] 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]
-      # @return [Position]
-      def offense_start_position off
-        Position.new(off['location']['start_line'] - 1, off['location']['start_column'] - 1)
-      end
-
-      # @param off [Hash]
-      # @return [Position]
-      def offense_ending_position off
-        if off['location']['start_line'] != off['location']['last_line']
-          Position.new(off['location']['start_line'], 0)
-        else
-          Position.new(
-            off['location']['start_line'] - 1, off['location']['last_column']
-          )
-        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 = {
+        '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
+        require_rubocop(rubocop_version)
+        options, paths = generate_options(source.filename, source.code)
+        store = RuboCop::ConfigStore.new
+        runner = RuboCop::Runner.new(options, store)
+        result = redirect_stdout{ runner.run(paths) }
+        make_array JSON.parse(result)
+      rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
+        raise DiagnosticsError, "Error in RuboCop configuration: #{e.message}"
+      rescue JSON::ParserError
+        raise DiagnosticsError, 'RuboCop returned invalid data'
+      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]
+      # @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] Offense received from Rubocop
+      # @return [Hash] 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]
+      # @return [Position]
+      def offense_start_position off
+        Position.new(off['location']['start_line'] - 1, off['location']['start_column'] - 1)
+      end
+
+      # @param off [Hash]
+      # @return [Position]
+      def offense_ending_position off
+        if off['location']['start_line'] != off['location']['last_line']
+          Position.new(off['location']['start_line'], 0)
+        else
+          Position.new(
+            off['location']['start_line'] - 1, off['location']['last_column']
+          )
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -1,63 +1,63 @@
-# 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]
-      # @raise [InvalidRubocopVersionError] if _version_ is not installed
-      def require_rubocop(version = nil)
-        begin
-          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
-          raise InvalidRubocopVersionError,
-                "could not find '#{e.name}' (#{e.requirement}) - "\
-                "did find: [#{e.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)
-        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]
+      # @raise [InvalidRubocopVersionError] if _version_ is not installed
+      def require_rubocop(version = nil)
+        begin
+          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
+          raise InvalidRubocopVersionError,
+                "could not find '#{e.name}' (#{e.requirement}) - "\
+                "did find: [#{e.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)
+        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