solargraph 0.58.1 → 0.58.3

data/lib/solargraph/convention.rb

@@ -1,78 +1,78 @@
-# frozen_string_literal: true
-
-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 :Gemspec, 'solargraph/convention/gemspec'
-    autoload :Rakefile, 'solargraph/convention/rakefile'
-    autoload :StructDefinition, 'solargraph/convention/struct_definition'
-    autoload :DataDefinition,   'solargraph/convention/data_definition'
-    autoload :ActiveSupportConcern, 'solargraph/convention/active_support_concern'
-
-    # @type [Set<Convention::Base>]
-    @@conventions = Set.new
-
-    # @param convention [Class<Convention::Base>]
-    # @return [void]
-    def self.register convention
-      @@conventions.add convention.new
-    end
-
-    # @param convention [Class<Convention::Base>]
-    # @return [void]
-    def self.unregister convention
-      @@conventions.delete_if { |c| c.is_a?(convention) }
-    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 doc_map [DocMap]
-    # @return [Environ]
-    def self.for_global(doc_map)
-      result = Environ.new
-      @@conventions.each do |conv|
-        result.merge conv.global(doc_map)
-      end
-      result
-    end
-
-    # Provides any additional method pins based on the described object.
-    #
-    # @param api_map [ApiMap]
-    # @param rooted_tag [String] A fully qualified namespace, with
-    #   generic parameter values if applicable
-    # @param scope [Symbol] :class or :instance
-    # @param visibility [Array<Symbol>] :public, :protected, and/or :private
-    # @param deep [Boolean]
-    # @param skip [Set<String>]
-    # @param no_core [Boolean] Skip core classes if true
-    #
-    # @return [Environ]
-    def self.for_object api_map, rooted_tag, scope, visibility,
-                        deep, skip, no_core
-      result = Environ.new
-      @@conventions.each do |conv|
-        result.merge conv.object(api_map, rooted_tag, scope, visibility,
-                                 deep, skip, no_core)
-      end
-      result
-    end
-
-    register Gemfile
-    register Gemspec
-    register Rakefile
-    register ActiveSupportConcern
-  end
-end
+# frozen_string_literal: true
+
+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 :Gemspec, 'solargraph/convention/gemspec'
+    autoload :Rakefile, 'solargraph/convention/rakefile'
+    autoload :StructDefinition, 'solargraph/convention/struct_definition'
+    autoload :DataDefinition,   'solargraph/convention/data_definition'
+    autoload :ActiveSupportConcern, 'solargraph/convention/active_support_concern'
+
+    # @type [Set<Convention::Base>]
+    @@conventions = Set.new
+
+    # @param convention [Class<Convention::Base>]
+    # @return [void]
+    def self.register convention
+      @@conventions.add convention.new
+    end
+
+    # @param convention [Class<Convention::Base>]
+    # @return [void]
+    def self.unregister convention
+      @@conventions.delete_if { |c| c.is_a?(convention) }
+    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 doc_map [DocMap]
+    # @return [Environ]
+    def self.for_global(doc_map)
+      result = Environ.new
+      @@conventions.each do |conv|
+        result.merge conv.global(doc_map)
+      end
+      result
+    end
+
+    # Provides any additional method pins based on the described object.
+    #
+    # @param api_map [ApiMap]
+    # @param rooted_tag [String] A fully qualified namespace, with
+    #   generic parameter values if applicable
+    # @param scope [Symbol] :class or :instance
+    # @param visibility [Array<Symbol>] :public, :protected, and/or :private
+    # @param deep [Boolean]
+    # @param skip [Set<String>]
+    # @param no_core [Boolean] Skip core classes if true
+    #
+    # @return [Environ]
+    def self.for_object api_map, rooted_tag, scope, visibility,
+                        deep, skip, no_core
+      result = Environ.new
+      @@conventions.each do |conv|
+        result.merge conv.object(api_map, rooted_tag, scope, visibility,
+                                 deep, skip, no_core)
+      end
+      result
+    end
+
+    register Gemfile
+    register Gemspec
+    register Rakefile
+    register ActiveSupportConcern
+  end
+end

data/lib/solargraph/converters/dd.rb

@@ -1,17 +1,17 @@
-require 'nokogiri'
-
-module ReverseMarkdown
-  module Converters
-    class Dd < Base
-      # @return [String]
-      # @param node [Nokogiri::XML::Element]
-      # @param state [Hash]
-      def convert node, state = {}
-        content = treat_children(node, state)
-        ": #{content.strip}\n"
-      end
-    end
-  end
-end
-
-ReverseMarkdown::Converters.register :dd, ReverseMarkdown::Converters::Dd.new
+require 'nokogiri'
+
+module ReverseMarkdown
+  module Converters
+    class Dd < Base
+      # @return [String]
+      # @param node [Nokogiri::XML::Element]
+      # @param state [Hash]
+      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,15 +1,15 @@
-module ReverseMarkdown
-  module Converters
-    class Dl < Base
-      # @return [String]
-      # @param node [Nokogiri::XML::Element]
-      # @param state [Hash]
-      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
+      # @return [String]
+      # @param node [Nokogiri::XML::Element]
+      # @param state [Hash]
+      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,15 +1,15 @@
-module ReverseMarkdown
-  module Converters
-    class Dt < Base
-      # @return [String]
-      # @param node [Nokogiri::XML::Element]
-      # @param state [Hash]
-      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
+      # @return [String]
+      # @param node [Nokogiri::XML::Element]
+      # @param state [Hash]
+      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/require_not_found.rb

@@ -1,53 +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.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 = {}
+        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,118 @@
-# 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
+      }
+
+      # @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