solargraph 0.59.0.dev.1 → 0.59.0.dev.2

data/lib/solargraph/convention/struct_definition.rb

@@ -142,7 +142,7 @@ module Solargraph
           # @param tag [YARD::Tags::Tag, nil] The param tag for this attribute.xtract_
           #
           # @return [String]
-          def tag_string(tag)
+          def tag_string tag
             tag&.types&.join(',') || 'undefined'
           end
 
@@ -150,8 +150,8 @@ module Solargraph
           # @param for_setter [Boolean] If true, will return a @param tag instead of a @return tag
           #
           # @return [String] The formatted comment for the attribute
-          def attribute_comment(tag, for_setter)
-            return "" if tag.nil?
+          def attribute_comment tag, for_setter
+            return '' if tag.nil?
 
             suffix = "[#{tag_string(tag)}] #{tag.text}"
 

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,19 @@
-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
+# frozen_string_literal: true
+
+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,17 @@
-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
+# frozen_string_literal: true
+
+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,17 @@
-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
+# frozen_string_literal: true
+
+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,3 @@
-ReverseMarkdown::Converters.register :tt, ReverseMarkdown::Converters::Code.new
+# frozen_string_literal: true
+
+ReverseMarkdown::Converters.register :tt, ReverseMarkdown::Converters::Code.new

data/lib/solargraph/diagnostics/rubocop.rb

@@ -17,7 +17,7 @@ module Solargraph
         'warning' => Severities::WARNING,
         'error' => Severities::ERROR,
         'fatal' => Severities::ERROR
-      }
+      }.freeze
 
       # @param source [Solargraph::Source]
       # @param _api_map [Solargraph::ApiMap]
@@ -33,7 +33,7 @@ module Solargraph
         # 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) }
+          redirect_stdout { runner.run(paths) }
         end
 
         return [] if result.empty?
@@ -77,7 +77,7 @@ module Solargraph
           severity: SEVERITIES[off['severity']],
           source: 'rubocop',
           code: off['cop_name'],
-          message: off['message'].gsub(/^#{off['cop_name']}\:/, '')
+          message: off['message'].gsub(/^#{off['cop_name']}:/, '')
         }
       end
 
@@ -96,22 +96,22 @@ module Solargraph
       # @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
+        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
+                      1
+                    else
+                      0
+                    end
 
           Position.new(
             start_line, last_column - col_off
           )
+        else
+          Position.new(off['location']['start_line'], 0)
         end
       end
     end

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -13,7 +13,7 @@ module Solargraph
       # @param version [String, nil]
       # @raise [InvalidRubocopVersionError] if _version_ is not installed
       # @return [void]
-      def require_rubocop(version = nil)
+      def require_rubocop version = nil
         begin
           # @type [String]
           gem_path = Gem::Specification.find_by_name('rubocop', version).full_gem_path
@@ -24,7 +24,7 @@ module Solargraph
           # @type [Array<Gem::Specification>]
           specs = e.specs
           raise InvalidRubocopVersionError,
-                "could not find '#{e.name}' (#{e.requirement}) - "\
+                "could not find '#{e.name}' (#{e.requirement}) - " \
                 "did find: [#{specs.map { |s| s.version.version }.join(', ')}]"
         end
         require 'rubocop'
@@ -52,7 +52,7 @@ module Solargraph
       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..-1]
+        path[0].upcase + path[1..]
       end
 
       # @todo This is a smelly way to redirect output, but the RuboCop specs do

data/lib/solargraph/diagnostics/type_check.rb

@@ -10,19 +10,19 @@ module Solargraph
       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
+        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
+               .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

data/lib/solargraph/diagnostics/update_errors.rb

@@ -1,41 +1,37 @@
-# 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
+        combine_ranges(source.code, source.error_ranges).map do |range|
+          { range: range.to_hash,
+            severity: Diagnostics::Severities::ERROR,
+            source: 'Solargraph',
+            message: 'Syntax error' }
+        end
+      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/doc_map.rb

@@ -98,12 +98,12 @@ module Solargraph
       @dependencies ||=
         begin
           gem_deps = gemspecs
-                       .flat_map { |spec| workspace.fetch_dependencies(spec, out: out) }
-                       .uniq(&:name)
+                     .flat_map { |spec| workspace.fetch_dependencies(spec, out: out) }
+                     .uniq(&:name)
           stdlib_deps = gemspecs
-                          .flat_map { |spec| workspace.stdlib_dependencies(spec.name) }
-                          .flat_map { |dep_name| workspace.resolve_require(dep_name) }
-                          .compact
+                        .flat_map { |spec| workspace.stdlib_dependencies(spec.name) }
+                        .flat_map { |dep_name| workspace.resolve_require(dep_name) }
+                        .compact
           existing_gems = gemspecs.map(&:name)
           (gem_deps + stdlib_deps).reject { |gemspec| existing_gems.include? gemspec.name }
         end
@@ -134,11 +134,10 @@ module Solargraph
     def load_serialized_gem_pins out: @out
       serialized_pins = []
       with_gemspecs, without_gemspecs = required_gems_map.partition { |_, v| v }
-      # @sg-ignore Need better typing for Hash[]
       # @type [Array<String>]
-      missing_paths = Hash[without_gemspecs].keys
+      missing_paths = without_gemspecs.to_h.keys
       # @type [Array<Gem::Specification>]
-      gemspecs = Hash[with_gemspecs].values.flatten.compact + dependencies(out: out).to_a
+      gemspecs = with_gemspecs.to_h.values.flatten.compact + dependencies(out: out).to_a
 
       # if we are type checking a gem project, we should not include
       # pins from rbs or yard from that gem here - we use our own
@@ -167,7 +166,7 @@ module Solargraph
         end
       end
 
-      existing_pin_count = serialized_pins.length
+      serialized_pins.length
       time = Benchmark.measure do
         gemspecs.each do |gemspec|
           # only deserializes already-cached gems
@@ -179,7 +178,7 @@ module Solargraph
           end
         end
       end
-      pins_processed = serialized_pins.length - existing_pin_count
+      serialized_pins.length
       milliseconds = (time.real * 1000).round
       if (milliseconds > 500) && out && gemspecs.any?
         out.puts "Deserialized #{serialized_pins.length} gem pins from #{PinCache.base_dir} in #{milliseconds} ms"

data/lib/solargraph/equality.rb

@@ -10,7 +10,7 @@ module Solargraph
 
     # @param other [Object]
     # @return [Boolean]
-    def eql?(other)
+    def eql? other
       self.class.eql?(other.class) &&
         # @sg-ignore flow sensitive typing should support .class == .class
         equality_fields.eql?(other.equality_fields)
@@ -18,8 +18,8 @@ module Solargraph
 
     # @param other [Object]
     # @return [Boolean]
-    def ==(other)
-      self.eql?(other)
+    def == other
+      eql?(other)
     end
 
     def hash

data/lib/solargraph/gem_pins.rb

@@ -13,8 +13,8 @@ module Solargraph
 
     # @param pins [Array<Pin::Base>]
     # @return [Array<Pin::Base>]
-    def self.combine_method_pins_by_path(pins)
-      method_pins, alias_pins = pins.partition { |pin| pin.class == Pin::Method }
+    def self.combine_method_pins_by_path pins
+      method_pins, alias_pins = pins.partition { |pin| pin.instance_of?(Pin::Method) }
       by_path = method_pins.group_by(&:path)
       by_path.transform_values! do |pins|
         GemPins.combine_method_pins(*pins)
@@ -47,7 +47,7 @@ module Solargraph
     # @param rbs_pins [Array<Pin::Base>]
     #
     # @return [Array<Pin::Base>]
-    def self.combine(yard_pins, rbs_pins)
+    def self.combine yard_pins, rbs_pins
       in_yard = Set.new
       rbs_store = Solargraph::ApiMap::Store.new(rbs_pins)
       combined = yard_pins.map do |yard_pin|
@@ -57,7 +57,9 @@ module Solargraph
         next yard_pin unless rbs_pin && yard_pin.is_a?(Pin::Method)
 
         unless rbs_pin
-          logger.debug { "GemPins.combine: No rbs pin for #{yard_pin.path} - using YARD's '#{yard_pin.inspect} (return_type=#{yard_pin.return_type}; signatures=#{yard_pin.signatures})" }
+          logger.debug do
+            "GemPins.combine: No rbs pin for #{yard_pin.path} - using YARD's '#{yard_pin.inspect} (return_type=#{yard_pin.return_type}; signatures=#{yard_pin.signatures})"
+          end
           next yard_pin
         end
 
@@ -90,7 +92,7 @@ module Solargraph
       # @param choices [Array<ComplexType>]
       # @return [ComplexType]
       def best_return_type *choices
-        choices.find { |pin| pin.defined? } || choices.first || ComplexType::UNDEFINED
+        choices.find(&:defined?) || choices.first || ComplexType::UNDEFINED
       end
     end
   end

data/lib/solargraph/language_server/error_codes.rb

@@ -1,20 +1,20 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    # The ErrorCode constants for the language server protocol.
-    #
-    module ErrorCodes
-      PARSE_ERROR =            -32700
-      INVALID_REQUEST =        -32600
-      METHOD_NOT_FOUND =       -32601
-      INVALID_PARAMS =         -32602
-      INTERNAL_ERROR =         -32603
-      SERVER_ERROR_START =     -32099
-      SERVER_ERROR_END =       -32000
-      SERVER_NOT_INITIALIZED = -32002
-      UNKNOWN_ERROR_CODE =     -32001
-      REQUEST_CANCELLED =      -32800
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    # The ErrorCode constants for the language server protocol.
+    #
+    module ErrorCodes
+      PARSE_ERROR =            -32_700
+      INVALID_REQUEST =        -32_600
+      METHOD_NOT_FOUND =       -32_601
+      INVALID_PARAMS =         -32_602
+      INTERNAL_ERROR =         -32_603
+      SERVER_ERROR_START =     -32_099
+      SERVER_ERROR_END =       -32_000
+      SERVER_NOT_INITIALIZED = -32_002
+      UNKNOWN_ERROR_CODE =     -32_001
+      REQUEST_CANCELLED =      -32_800
+    end
+  end
+end