solargraph 0.58.2 → 0.59.0.dev.2

data/lib/solargraph/convention/gemfile.rb

@@ -1,15 +1,15 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Convention
-    class Gemfile < Base
-      def local source_map
-        return EMPTY_ENVIRON unless File.basename(source_map.filename) == 'Gemfile'
-        @environ ||= Environ.new(
-          requires: ['bundler'],
-          domains: ['Bundler::Dsl']
-        )
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Convention
+    class Gemfile < Base
+      def local source_map
+        return EMPTY_ENVIRON unless File.basename(source_map.filename) == 'Gemfile'
+        @local ||= Environ.new(
+          requires: ['bundler'],
+          domains: ['Bundler::Dsl']
+        )
+      end
+    end
+  end
+end

data/lib/solargraph/convention/gemspec.rb

@@ -1,23 +1,23 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Convention
-    class Gemspec < Base
-      def local source_map
-        return Convention::Base::EMPTY_ENVIRON unless File.basename(source_map.filename).end_with?('.gemspec')
-        @environ ||= Environ.new(
-          requires: ['rubygems'],
-          pins: [
-            Solargraph::Pin::Reference::Override.from_comment(
-              'Gem::Specification.new',
-              %(
-@yieldparam [self]
-              ),
-              source: :gemspec
-            )
-          ]
-        )
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Convention
+    class Gemspec < Base
+      def local source_map
+        return Convention::Base::EMPTY_ENVIRON unless File.basename(source_map.filename).end_with?('.gemspec')
+        @local ||= Environ.new(
+          requires: ['rubygems'],
+          pins: [
+            Solargraph::Pin::Reference::Override.from_comment(
+              'Gem::Specification.new',
+              %(
+@yieldparam [self]
+              ),
+              source: :gemspec
+            )
+          ]
+        )
+      end
+    end
+  end
+end

data/lib/solargraph/convention/rakefile.rb

@@ -1,17 +1,17 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Convention
-    class Rakefile < Base
-      def local source_map
-        basename = File.basename(source_map.filename)
-        return EMPTY_ENVIRON unless basename.end_with?('.rake') || basename == 'Rakefile'
-
-        @environ ||= Environ.new(
-          requires: ['rake'],
-          domains: ['Rake::DSL']
-        )
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Convention
+    class Rakefile < Base
+      def local source_map
+        basename = File.basename(source_map.filename)
+        return EMPTY_ENVIRON unless basename.end_with?('.rake') || basename == 'Rakefile'
+
+        @local ||= Environ.new(
+          requires: ['rake'],
+          domains: ['Rake::DSL']
+        )
+      end
+    end
+  end
+end

data/lib/solargraph/convention/struct_definition/struct_assignment_node.rb

@@ -22,8 +22,9 @@ module Solargraph
           #     s(:def, :foo,
           #       s(:args),
           #       s(:send, nil, :bar))))
+          #
           # @param node [Parser::AST::Node]
-          def match?(node)
+          def match? node
             return false unless node&.type == :casgn
             return false if node.children[2].nil?
 

data/lib/solargraph/convention/struct_definition/struct_definition_node.rb

@@ -27,7 +27,7 @@ module Solargraph
           #       s(:send, nil, :bar)))
           #
           # @param node [Parser::AST::Node]
-          def match?(node)
+          def match? node
             return false unless node&.type == :class
 
             struct_definition_node?(node.children[1])
@@ -37,7 +37,7 @@ module Solargraph
 
           # @param struct_node [Parser::AST::Node]
           # @return [Boolean]
-          def struct_definition_node?(struct_node)
+          def struct_definition_node? struct_node
             return false unless struct_node.is_a?(::Parser::AST::Node)
             return false unless struct_node&.type == :send
             return false unless struct_node.children[0]&.type == :const
@@ -49,7 +49,7 @@ module Solargraph
         end
 
         # @param node [Parser::AST::Node]
-        def initialize(node)
+        def initialize node
           @node = node
         end
 
@@ -92,6 +92,7 @@ module Solargraph
           node.children[1]
         end
 
+        # @sg-ignore Need to add nil check here
         # @return [Array<Parser::AST::Node>]
         def struct_attribute_nodes
           struct_node.children[2..-1]

data/lib/solargraph/convention/struct_definition.rb

@@ -17,6 +17,7 @@ module Solargraph
               type: :class,
               location: loc,
               closure: region.closure,
+              # @sg-ignore flow sensitive typing needs to handle attrs
               name: struct_definition_node.class_name,
               docstring: docstring,
               visibility: :public,
@@ -39,6 +40,7 @@ module Solargraph
 
             pins.push initialize_method_pin
 
+            # @sg-ignore flow sensitive typing needs to handle attrs
             struct_definition_node.attributes.map do |attribute_node, attribute_name|
               initialize_method_pin.parameters.push(
                 Pin::Parameter.new(
@@ -52,6 +54,7 @@ module Solargraph
             end
 
             # define attribute accessors and instance variables
+            # @sg-ignore flow sensitive typing needs to handle attrs
             struct_definition_node.attributes.each do |attribute_node, attribute_name|
               [attribute_name, "#{attribute_name}="].each do |name|
                 docs = docstring.tags.find { |t| t.tag_name == 'param' && t.name == attribute_name }
@@ -102,7 +105,7 @@ module Solargraph
 
           private
 
-          # @return [StructDefintionNode, StructAssignmentNode, nil]
+          # @return [StructDefinition::StructDefintionNode, StructDefinition::StructAssignmentNode, nil]
           def struct_definition_node
             @struct_definition_node ||= if StructDefintionNode.match?(node)
                                           StructDefintionNode.new(node)
@@ -121,6 +124,7 @@ module Solargraph
           # @return [YARD::Docstring]
           def parse_comments
             struct_comments = comments_for(node) || ''
+            # @sg-ignore Need to add nil check here
             struct_definition_node.attributes.each do |attr_node, attr_name|
               comment = comments_for(attr_node)
               next if comment.nil?
@@ -138,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
 
@@ -146,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/require_not_found.rb

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

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]
@@ -25,6 +25,7 @@ module Solargraph
       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)
@@ -32,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?
@@ -76,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
 
@@ -95,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,17 +13,18 @@ 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
           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}) - "\
+                "could not find '#{e.name}' (#{e.requirement}) - " \
                 "did find: [#{specs.map { |s| s.version.version }.join(', ')}]"
         end
         require 'rubocop'
@@ -50,7 +51,8 @@ module Solargraph
       # @return [String]
       def fix_drive_letter path
         return path unless path.match(/^[a-z]:/)
-        path[0].upcase + path[1..-1]
+        # @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

data/lib/solargraph/diagnostics/type_check.rb

@@ -10,18 +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