solargraph 0.58.3 → 0.59.0.dev.1

data/lib/solargraph/convention/data_definition/data_definition_node.rb

@@ -66,7 +66,7 @@ module Solargraph
           end.compact
         end
 
-        # @return [Parser::AST::Node]
+        # @return [Parser::AST::Node, nil]
         def body_node
           node.children[2]
         end
@@ -81,8 +81,10 @@ module Solargraph
           node.children[1]
         end
 
+        # @sg-ignore Need to add nil check here
         # @return [Array<Parser::AST::Node>]
         def data_attribute_nodes
+          # @sg-ignore Need to add nil check here
           data_node.children[2..-1]
         end
       end

data/lib/solargraph/convention/data_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: data_definition_node.class_name,
               comments: comments_for(node),
               visibility: :public,
@@ -39,6 +40,7 @@ module Solargraph
             # Solargraph::SourceMap::Clip#complete_keyword_parameters does not seem to currently take into account [Pin::Method#signatures] hence we only one for :kwarg
             pins.push initialize_method_pin
 
+            # @sg-ignore flow sensitive typing needs to handle attrs
             data_definition_node.attributes.map do |attribute_node, attribute_name|
               initialize_method_pin.parameters.push(
                 Pin::Parameter.new(
@@ -51,6 +53,7 @@ module Solargraph
             end
 
             # define attribute readers and instance variables
+            # @sg-ignore flow sensitive typing needs to handle attrs
             data_definition_node.attributes.each do |attribute_node, attribute_name|
               name = attribute_name.to_s
               method_pin = Pin::Method.new(
@@ -78,7 +81,7 @@ module Solargraph
 
           private
 
-          # @return [DataDefintionNode, nil]
+          # @return [DataDefinition::DataDefintionNode, DataDefinition::DataAssignmentNode, nil]
           def data_definition_node
             @data_definition_node ||= if DataDefintionNode.match?(node)
                                         DataDefintionNode.new(node)

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'
+        @environ ||= 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')
+        @environ ||= 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'
+
+        @environ ||= Environ.new(
+          requires: ['rake'],
+          domains: ['Rake::DSL']
+        )
+      end
+    end
+  end
+end

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

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

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

@@ -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?

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

@@ -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

@@ -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)

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -18,6 +18,7 @@ module Solargraph
           # @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>]
@@ -50,6 +51,7 @@ module Solargraph
       # @return [String]
       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]
       end
 

data/lib/solargraph/diagnostics/type_check.rb

@@ -11,6 +11,7 @@ module Solargraph
         # 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
+        # @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 }

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