solargraph 0.45.0 → 0.46.0

data/lib/solargraph/diagnostics/severities.rb

@@ -1,15 +1,15 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Diagnostics
-    # These severity constants match the DiagnosticSeverity constants in the
-    # language server protocol.
-    #
-    module Severities
-      ERROR = 1
-      WARNING = 2
-      INFORMATION = 3
-      HINT = 4
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Diagnostics
+    # These severity constants match the DiagnosticSeverity constants in the
+    # language server protocol.
+    #
+    module Severities
+      ERROR = 1
+      WARNING = 2
+      INFORMATION = 3
+      HINT = 4
+    end
+  end
+end

data/lib/solargraph/diagnostics/type_check.rb

@@ -1,54 +1,54 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Diagnostics
-    # TypeCheck reports methods with undefined return types, untagged
-    # parameters, and invalid param tags.
-    #
-    class TypeCheck < Base
-      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
+      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

data/lib/solargraph/diagnostics/update_errors.rb

@@ -1,41 +1,41 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Diagnostics
-    class UpdateErrors < Base
-      def diagnose source, api_map
-        result = []
-        combine_ranges(source.code, source.error_ranges).each do |range|
-          result.push(
-            range: range.to_hash,
-            severity: Diagnostics::Severities::ERROR,
-            source: 'Solargraph',
-            message: 'Syntax error'
-          )
-        end
-        result
-      end
-
-      private
-
-      # Combine an array of ranges by their starting lines.
-      #
-      # @param code [String]
-      # @param ranges [Array<Range>]
-      # @return [Array<Range>]
-      def combine_ranges code, ranges
-        result = []
-        lines = []
-        ranges.sort{|a, b| a.start.line <=> b.start.line}.each do |rng|
-          next if rng.nil? || lines.include?(rng.start.line)
-          lines.push rng.start.line
-          next if rng.start.line >= code.lines.length
-          scol = code.lines[rng.start.line].index(/[^\s]/) || 0
-          ecol = code.lines[rng.start.line].length
-          result.push Range.from_to(rng.start.line, scol, rng.start.line, ecol)
-        end
-        result
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Diagnostics
+    class UpdateErrors < Base
+      def diagnose source, api_map
+        result = []
+        combine_ranges(source.code, source.error_ranges).each do |range|
+          result.push(
+            range: range.to_hash,
+            severity: Diagnostics::Severities::ERROR,
+            source: 'Solargraph',
+            message: 'Syntax error'
+          )
+        end
+        result
+      end
+
+      private
+
+      # Combine an array of ranges by their starting lines.
+      #
+      # @param code [String]
+      # @param ranges [Array<Range>]
+      # @return [Array<Range>]
+      def combine_ranges code, ranges
+        result = []
+        lines = []
+        ranges.sort{|a, b| a.start.line <=> b.start.line}.each do |rng|
+          next if rng.nil? || lines.include?(rng.start.line)
+          lines.push rng.start.line
+          next if rng.start.line >= code.lines.length
+          scol = code.lines[rng.start.line].index(/[^\s]/) || 0
+          ecol = code.lines[rng.start.line].length
+          result.push Range.from_to(rng.start.line, scol, rng.start.line, ecol)
+        end
+        result
+      end
+    end
+  end
+end

data/lib/solargraph/diagnostics.rb

@@ -1,55 +1,55 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # The Diagnostics library provides reporters for analyzing problems in code
-  # and providing the results to language server clients.
-  #
-  module Diagnostics
-    autoload :Base,            'solargraph/diagnostics/base'
-    autoload :Severities,      'solargraph/diagnostics/severities'
-    autoload :Rubocop,         'solargraph/diagnostics/rubocop'
-    autoload :RubocopHelpers,  'solargraph/diagnostics/rubocop_helpers'
-    autoload :RequireNotFound, 'solargraph/diagnostics/require_not_found'
-    autoload :UpdateErrors,    'solargraph/diagnostics/update_errors'
-    autoload :TypeCheck,       'solargraph/diagnostics/type_check'
-
-    class << self
-      # Add a reporter with a name to identify it in .solargraph.yml files.
-      #
-      # @param name [String] The name
-      # @param klass [Class<Solargraph::Diagnostics::Base>] The class implementation
-      # @return [void]
-      def register name, klass
-        reporter_hash[name] = klass
-      end
-
-      # Get an array of reporter names.
-      #
-      # @return [Array<String>]
-      def reporters
-        reporter_hash.keys - ['type_not_defined'] # @todo Hide type_not_defined for now
-      end
-
-      # Find a reporter by name.
-      #
-      # @param name [String] The name with which the reporter was registered
-      # @return [Class<Solargraph::Diagnostics::Base>]
-      def reporter name
-        reporter_hash[name]
-      end
-
-      private
-
-      # @return [Hash]
-      def reporter_hash
-        @reporter_hash ||= {}
-      end
-    end
-
-    register 'rubocop', Rubocop
-    register 'require_not_found', RequireNotFound
-    register 'typecheck', TypeCheck
-    register 'update_errors', UpdateErrors
-    register 'type_not_defined', TypeCheck # @todo Retained for backwards compatibility
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  # The Diagnostics library provides reporters for analyzing problems in code
+  # and providing the results to language server clients.
+  #
+  module Diagnostics
+    autoload :Base,            'solargraph/diagnostics/base'
+    autoload :Severities,      'solargraph/diagnostics/severities'
+    autoload :Rubocop,         'solargraph/diagnostics/rubocop'
+    autoload :RubocopHelpers,  'solargraph/diagnostics/rubocop_helpers'
+    autoload :RequireNotFound, 'solargraph/diagnostics/require_not_found'
+    autoload :UpdateErrors,    'solargraph/diagnostics/update_errors'
+    autoload :TypeCheck,       'solargraph/diagnostics/type_check'
+
+    class << self
+      # Add a reporter with a name to identify it in .solargraph.yml files.
+      #
+      # @param name [String] The name
+      # @param klass [Class<Solargraph::Diagnostics::Base>] The class implementation
+      # @return [void]
+      def register name, klass
+        reporter_hash[name] = klass
+      end
+
+      # Get an array of reporter names.
+      #
+      # @return [Array<String>]
+      def reporters
+        reporter_hash.keys - ['type_not_defined'] # @todo Hide type_not_defined for now
+      end
+
+      # Find a reporter by name.
+      #
+      # @param name [String] The name with which the reporter was registered
+      # @return [Class<Solargraph::Diagnostics::Base>]
+      def reporter name
+        reporter_hash[name]
+      end
+
+      private
+
+      # @return [Hash]
+      def reporter_hash
+        @reporter_hash ||= {}
+      end
+    end
+
+    register 'rubocop', Rubocop
+    register 'require_not_found', RequireNotFound
+    register 'typecheck', TypeCheck
+    register 'update_errors', UpdateErrors
+    register 'type_not_defined', TypeCheck # @todo Retained for backwards compatibility
+  end
+end

data/lib/solargraph/documentor.rb

@@ -1,76 +1,76 @@
-# frozen_string_literal: true
-
-require 'bundler'
-require 'json'
-require 'open3'
-require 'shellwords'
-require 'yard'
-require 'fileutils'
-
-module Solargraph
-  class Documentor
-    RDOC_GEMS = %w[
-      actioncable actionmailbox actionmailer actionpack actiontext actionview
-      activejob activemodel activerecord activestorage activesupport railties
-    ]
-
-    def initialize directory, rebuild: false, out: File.new(File::NULL, 'w')
-      @directory = directory
-      @rebuild = rebuild
-      @out = out
-    end
-
-    # @return [Boolean] True if all specs were found and documented.
-    def document
-      failures = 0
-      Documentor.specs_from_bundle(@directory).each_pair do |name, version|
-        yd = YARD::Registry.yardoc_file_for_gem(name, "= #{version}")
-        if !yd || @rebuild
-          FileUtils.safe_unlink File.join(YardMap::CoreDocs.cache_dir, 'gems', "#{name}-#{version}.ser")
-          @out.puts "Documenting #{name} #{version}"
-          `yard gems #{name} #{version} #{@rebuild ? '--rebuild' : ''}`
-          yd = YARD::Registry.yardoc_file_for_gem(name, "= #{version}")
-          # HACK: Ignore errors documenting bundler
-          if !yd && name != 'bundler'
-            @out.puts "#{name} #{version} YARD documentation failed"
-            failures += 1
-          end
-        end
-        if yd && RDOC_GEMS.include?(name)
-          cache = File.join(Solargraph::YardMap::CoreDocs.cache_dir, 'gems', "#{name}-#{version}", 'yardoc')
-          if !File.exist?(cache) || @rebuild
-            @out.puts "Caching custom documentation for #{name} #{version}"
-            spec = Gem::Specification.find_by_name(name, "= #{version}")
-            Solargraph::YardMap::RdocToYard.run(spec)
-          end
-        end
-      end
-      if failures > 0
-        @out.puts "#{failures} gem#{failures == 1 ? '' : 's'} could not be documented. You might need to run `bundle install`."
-      end
-      failures == 0
-    rescue Solargraph::BundleNotFoundError => e
-      @out.puts "[#{e.class}] #{e.message}"
-      @out.puts "No bundled gems are available in #{@directory}"
-      false
-    end
-
-    # @param directory [String]
-    # @return [Hash]
-    def self.specs_from_bundle directory
-      Solargraph.with_clean_env do
-        cmd = [
-          'ruby', '-e',
-          "require 'bundler'; require 'json'; Dir.chdir('#{directory}') { puts Bundler.definition.specs_for([:default]).map { |spec| [spec.name, spec.version] }.to_h.to_json }"
-        ]
-        o, e, s = Open3.capture3(*cmd)
-        if s.success?
-          o && !o.empty? ? JSON.parse(o.split("\n").last) : {}
-        else
-          Solargraph.logger.warn e
-          raise BundleNotFoundError, "Failed to load gems from bundle at #{directory}"
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'bundler'
+require 'json'
+require 'open3'
+require 'shellwords'
+require 'yard'
+require 'fileutils'
+
+module Solargraph
+  class Documentor
+    RDOC_GEMS = %w[
+      actioncable actionmailbox actionmailer actionpack actiontext actionview
+      activejob activemodel activerecord activestorage activesupport railties
+    ]
+
+    def initialize directory, rebuild: false, out: File.new(File::NULL, 'w')
+      @directory = directory
+      @rebuild = rebuild
+      @out = out
+    end
+
+    # @return [Boolean] True if all specs were found and documented.
+    def document
+      failures = 0
+      Documentor.specs_from_bundle(@directory).each_pair do |name, version|
+        yd = YARD::Registry.yardoc_file_for_gem(name, "= #{version}")
+        if !yd || @rebuild
+          FileUtils.safe_unlink File.join(YardMap::CoreDocs.cache_dir, 'gems', "#{name}-#{version}.ser")
+          @out.puts "Documenting #{name} #{version}"
+          `yard gems #{name} #{version} #{@rebuild ? '--rebuild' : ''}`
+          yd = YARD::Registry.yardoc_file_for_gem(name, "= #{version}")
+          # HACK: Ignore errors documenting bundler
+          if !yd && name != 'bundler'
+            @out.puts "#{name} #{version} YARD documentation failed"
+            failures += 1
+          end
+        end
+        if yd && RDOC_GEMS.include?(name)
+          cache = File.join(Solargraph::YardMap::CoreDocs.cache_dir, 'gems', "#{name}-#{version}", 'yardoc')
+          if !File.exist?(cache) || @rebuild
+            @out.puts "Caching custom documentation for #{name} #{version}"
+            spec = Gem::Specification.find_by_name(name, "= #{version}")
+            Solargraph::YardMap::RdocToYard.run(spec)
+          end
+        end
+      end
+      if failures > 0
+        @out.puts "#{failures} gem#{failures == 1 ? '' : 's'} could not be documented. You might need to run `bundle install`."
+      end
+      failures == 0
+    rescue Solargraph::BundleNotFoundError => e
+      @out.puts "[#{e.class}] #{e.message}"
+      @out.puts "No bundled gems are available in #{@directory}"
+      false
+    end
+
+    # @param directory [String]
+    # @return [Hash]
+    def self.specs_from_bundle directory
+      Solargraph.with_clean_env do
+        cmd = [
+          'ruby', '-e',
+          "require 'bundler'; require 'json'; Dir.chdir('#{directory}') { puts Bundler.definition.specs_for([:default]).map { |spec| [spec.name, spec.version] }.to_h.to_json }"
+        ]
+        o, e, s = Open3.capture3(*cmd)
+        if s.success?
+          o && !o.empty? ? JSON.parse(o.split("\n").last) : {}
+        else
+          Solargraph.logger.warn e
+          raise BundleNotFoundError, "Failed to load gems from bundle at #{directory}"
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/environ.rb

@@ -1,45 +1,45 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # A collection of additional data, such as map pins and required paths, that
-  # can be added to an ApiMap.
-  #
-  # Conventions are used to add Environs.
-  #
-  class Environ
-    # @return [Array<String>]
-    attr_reader :requires
-
-    # @return [Array<String>]
-    attr_reader :domains
-
-    # @return [Array<Pin::Reference::Override>]
-    attr_reader :pins
-
-    # @param requires [Array<String>]
-    # @param domains [Array<String>]
-    # @param pins [Array<Pin::Base>]
-    def initialize requires: [], domains: [], pins: []
-      @requires = requires
-      @domains = domains
-      @pins = pins
-    end
-
-    # @return [self]
-    def clear
-      domains.clear
-      requires.clear
-      pins.clear
-      self
-    end
-
-    # @param other [Environ]
-    # @return [self]
-    def merge other
-      domains.concat other.domains
-      requires.concat other.requires
-      pins.concat other.pins
-      self
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  # A collection of additional data, such as map pins and required paths, that
+  # can be added to an ApiMap.
+  #
+  # Conventions are used to add Environs.
+  #
+  class Environ
+    # @return [Array<String>]
+    attr_reader :requires
+
+    # @return [Array<String>]
+    attr_reader :domains
+
+    # @return [Array<Pin::Reference::Override>]
+    attr_reader :pins
+
+    # @param requires [Array<String>]
+    # @param domains [Array<String>]
+    # @param pins [Array<Pin::Base>]
+    def initialize requires: [], domains: [], pins: []
+      @requires = requires
+      @domains = domains
+      @pins = pins
+    end
+
+    # @return [self]
+    def clear
+      domains.clear
+      requires.clear
+      pins.clear
+      self
+    end
+
+    # @param other [Environ]
+    # @return [self]
+    def merge other
+      domains.concat other.domains
+      requires.concat other.requires
+      pins.concat other.pins
+      self
+    end
+  end
+end

data/lib/solargraph/language_server/completion_item_kinds.rb

@@ -1,35 +1,35 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    # The CompletionItemKind constants for the language server protocol.
-    #
-    module CompletionItemKinds
-      TEXT = 1
-      METHOD = 2
-      FUNCTION = 3
-      CONSTRUCTOR = 4
-      FIELD = 5
-      VARIABLE = 6
-      CLASS = 7
-      INTERFACE = 8
-      MODULE = 9
-      PROPERTY = 10
-      UNIT = 11
-      VALUE = 12
-      ENUM = 13
-      KEYWORD = 14
-      SNIPPET = 15
-      COLOR = 16
-      FILE = 17
-      REFERENCE = 18
-      FOLDER = 19
-      ENUM_MEMBER = 20
-      CONSTANT = 21
-      STRUCT = 22
-      EVENT = 23
-      OPERATOR = 24
-      TYPE_PARAMETER = 25
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    # The CompletionItemKind constants for the language server protocol.
+    #
+    module CompletionItemKinds
+      TEXT = 1
+      METHOD = 2
+      FUNCTION = 3
+      CONSTRUCTOR = 4
+      FIELD = 5
+      VARIABLE = 6
+      CLASS = 7
+      INTERFACE = 8
+      MODULE = 9
+      PROPERTY = 10
+      UNIT = 11
+      VALUE = 12
+      ENUM = 13
+      KEYWORD = 14
+      SNIPPET = 15
+      COLOR = 16
+      FILE = 17
+      REFERENCE = 18
+      FOLDER = 19
+      ENUM_MEMBER = 20
+      CONSTANT = 21
+      STRUCT = 22
+      EVENT = 23
+      OPERATOR = 24
+      TYPE_PARAMETER = 25
+    end
+  end
+end