solargraph 0.58.3 → 0.59.2

data/lib/solargraph/convention/active_support_concern.rb

@@ -1,111 +1,111 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Convention
-    # ActiveSupport::Concern is syntactic sugar for a common
-    # pattern to include class methods while mixing-in a Module
-    # See https://api.rubyonrails.org/classes/ActiveSupport/Concern.html
-    class ActiveSupportConcern < Base
-      include Logging
-
-      # @return [Array<Pin::Base>]
-      attr_reader :pins
-
-      # @param api_map [ApiMap]
-      # @param rooted_tag [String]
-      # @param scope [Symbol] :class or :instance
-      # @param visibility [Array<Symbol>] :public, :protected, and/or :private
-      # @param deep [Boolean] whether to include methods from included modules
-      # @param skip [Set<String>]
-      # @param _no_core [Boolean]n whether to skip core methods
-      def object api_map, rooted_tag, scope, visibility, deep, skip, _no_core
-        moo = ObjectProcessor.new(api_map, rooted_tag, scope, visibility, deep, skip)
-        moo.environ
-      end
-
-      # yard-activesupport-concern pulls methods inside
-      # 'class_methods' blocks into main class visible from YARD
-      #
-      # @param _doc_map [DocMap]
-      def global _doc_map
-        Environ.new(yard_plugins: ['activesupport-concern'])
-      end
-
-      # Process an object to add any class methods brought in via
-      # ActiveSupport::Concern
-      class ObjectProcessor
-        include Logging
-
-        attr_reader :environ
-
-        # @param api_map [ApiMap]
-        # @param rooted_tag [String] the tag of the class or module being processed
-        # @param scope [Symbol] :class or :instance
-        # @param visibility [Array<Symbol>] :public, :protected, and/or :private
-        # @param deep [Boolean] whether to include methods from included modules
-        # @param skip [Set<String>] a set of tags to skip
-        def initialize api_map, rooted_tag, scope, visibility, deep, skip
-          @api_map = api_map
-          @rooted_tag = rooted_tag
-          @scope = scope
-          @visibility = visibility
-          @deep = deep
-          @skip = skip
-
-          @environ = Environ.new
-          return unless scope == :class
-
-          @rooted_type = ComplexType.parse(rooted_tag).force_rooted
-          @fqns = rooted_type.namespace
-          @namespace_pin = api_map.get_path_pins(fqns).select { |p| p.is_a?(Pin::Namespace) }.first
-
-          api_map.get_includes(fqns).reverse.each do |include_tag|
-            process_include include_tag
-          end
-        end
-
-        private
-
-        attr_reader :api_map, :rooted_tag, :rooted_type, :scope,
-                    :visibility, :deep, :skip, :namespace_pin,
-                    :fqns
-
-        # @param include_tag [Pin::Reference::Include] the include reference pin
-        #
-        # @return [void]
-        def process_include include_tag
-          rooted_include_tag = api_map.dereference(include_tag)
-          return if rooted_include_tag.nil?
-          logger.debug do
-            "ActiveSupportConcern#object(#{fqns}, #{scope}, #{visibility}, #{deep}) - " \
-              "Handling class include include_tag=#{include_tag}"
-          end
-          module_extends = api_map.get_extends(rooted_include_tag).map(&:type).map(&:to_s)
-          logger.debug do
-            "ActiveSupportConcern#object(#{fqns}, #{scope}, #{visibility}, #{deep}) - " \
-              "found module extends of #{rooted_include_tag}: #{module_extends}"
-          end
-          return unless module_extends.include? 'ActiveSupport::Concern'
-          included_class_pins = api_map.inner_get_methods_from_reference(rooted_include_tag, namespace_pin, rooted_type,
-                                                                         :class, visibility, deep, skip, true)
-          logger.debug do
-            "ActiveSupportConcern#object(#{fqns}, #{scope}, #{visibility}, #{deep}) - " \
-              "Found #{included_class_pins.length} inluded class methods for #{rooted_include_tag}"
-          end
-          environ.pins.concat included_class_pins
-          # another pattern is to put class methods inside a submodule
-          classmethods_include_tag = "#{rooted_include_tag}::ClassMethods"
-          included_classmethods_pins =
-            api_map.inner_get_methods_from_reference(classmethods_include_tag, namespace_pin, rooted_type,
-                                                     :instance, visibility, deep, skip, true)
-          logger.debug do
-            "ActiveSupportConcern#object(#{fqns}, #{scope}, #{visibility}, #{deep}) - " \
-              "Found #{included_classmethods_pins.length} included classmethod " \
-              "class methods for #{classmethods_include_tag}"
-          end
-          environ.pins.concat included_classmethods_pins
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Convention
+    # ActiveSupport::Concern is syntactic sugar for a common
+    # pattern to include class methods while mixing-in a Module
+    # See https://api.rubyonrails.org/classes/ActiveSupport/Concern.html
+    class ActiveSupportConcern < Base
+      include Logging
+
+      # @return [Array<Pin::Base>]
+      attr_reader :pins
+
+      # @param api_map [ApiMap]
+      # @param rooted_tag [String]
+      # @param scope [Symbol] :class or :instance
+      # @param visibility [Array<Symbol>] :public, :protected, and/or :private
+      # @param deep [Boolean] whether to include methods from included modules
+      # @param skip [Set<String>]
+      # @param _no_core [Boolean]n whether to skip core methods
+      def object api_map, rooted_tag, scope, visibility, deep, skip, _no_core
+        moo = ObjectProcessor.new(api_map, rooted_tag, scope, visibility, deep, skip)
+        moo.environ
+      end
+
+      # yard-activesupport-concern pulls methods inside
+      # 'class_methods' blocks into main class visible from YARD
+      #
+      # @param _doc_map [DocMap]
+      def global _doc_map
+        Environ.new(yard_plugins: ['activesupport-concern'])
+      end
+
+      # Process an object to add any class methods brought in via
+      # ActiveSupport::Concern
+      class ObjectProcessor
+        include Logging
+
+        attr_reader :environ
+
+        # @param api_map [ApiMap]
+        # @param rooted_tag [String] the tag of the class or module being processed
+        # @param scope [Symbol] :class or :instance
+        # @param visibility [Array<Symbol>] :public, :protected, and/or :private
+        # @param deep [Boolean] whether to include methods from included modules
+        # @param skip [Set<String>] a set of tags to skip
+        def initialize api_map, rooted_tag, scope, visibility, deep, skip
+          @api_map = api_map
+          @rooted_tag = rooted_tag
+          @scope = scope
+          @visibility = visibility
+          @deep = deep
+          @skip = skip
+
+          @environ = Environ.new
+          return unless scope == :class
+
+          @rooted_type = ComplexType.parse(rooted_tag).force_rooted
+          @fqns = rooted_type.namespace
+          @namespace_pin = api_map.get_path_pins(fqns).select { |p| p.is_a?(Pin::Namespace) }.first
+
+          api_map.get_includes(fqns).reverse.each do |include_tag|
+            process_include include_tag
+          end
+        end
+
+        private
+
+        attr_reader :api_map, :rooted_tag, :rooted_type, :scope,
+                    :visibility, :deep, :skip, :namespace_pin,
+                    :fqns
+
+        # @param include_tag [Pin::Reference::Include] the include reference pin
+        #
+        # @return [void]
+        def process_include include_tag
+          rooted_include_tag = api_map.dereference(include_tag)
+          return if rooted_include_tag.nil?
+          logger.debug do
+            "ActiveSupportConcern#object(#{fqns}, #{scope}, #{visibility}, #{deep}) - " \
+              "Handling class include include_tag=#{include_tag}"
+          end
+          module_extends = api_map.get_extends(rooted_include_tag).map(&:type).map(&:to_s)
+          logger.debug do
+            "ActiveSupportConcern#object(#{fqns}, #{scope}, #{visibility}, #{deep}) - " \
+              "found module extends of #{rooted_include_tag}: #{module_extends}"
+          end
+          return unless module_extends.include? 'ActiveSupport::Concern'
+          included_class_pins = api_map.inner_get_methods_from_reference(rooted_include_tag, namespace_pin, rooted_type,
+                                                                         :class, visibility, deep, skip, true)
+          logger.debug do
+            "ActiveSupportConcern#object(#{fqns}, #{scope}, #{visibility}, #{deep}) - " \
+              "Found #{included_class_pins.length} inluded class methods for #{rooted_include_tag}"
+          end
+          environ.pins.concat included_class_pins
+          # another pattern is to put class methods inside a submodule
+          classmethods_include_tag = "#{rooted_include_tag}::ClassMethods"
+          included_classmethods_pins =
+            api_map.inner_get_methods_from_reference(classmethods_include_tag, namespace_pin, rooted_type,
+                                                     :instance, visibility, deep, skip, true)
+          logger.debug do
+            "ActiveSupportConcern#object(#{fqns}, #{scope}, #{visibility}, #{deep}) - " \
+              "Found #{included_classmethods_pins.length} included classmethod " \
+              "class methods for #{classmethods_include_tag}"
+          end
+          environ.pins.concat included_classmethods_pins
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/convention/base.rb

@@ -1,50 +1,50 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Convention
-    # The base class for Conventions.
-    #
-    # A Convention provides Environs that customize ApiMaps with additional
-    # pins and other information. Subclasses should implement the `local` and
-    # `global` methods as necessary.
-    #
-    class Base
-      EMPTY_ENVIRON = Environ.new
-
-      # The Environ for a source map.
-      # Subclasses can override this method.
-      #
-      # @param source_map [SourceMap]
-      # @return [Environ]
-      def local source_map
-        EMPTY_ENVIRON
-      end
-
-      # The Environ for a DocMap.
-      # Subclasses can override this method.
-      #
-      # @param doc_map [DocMap]
-      # @return [Environ]
-      def global doc_map
-        EMPTY_ENVIRON
-      end
-
-      # Provides any additional method pins based on e 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 object api_map, rooted_tag, scope, visibility,
-                 deep, skip, no_core
-        EMPTY_ENVIRON
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Convention
+    # The base class for Conventions.
+    #
+    # A Convention provides Environs that customize ApiMaps with additional
+    # pins and other information. Subclasses should implement the `local` and
+    # `global` methods as necessary.
+    #
+    class Base
+      EMPTY_ENVIRON = Environ.new
+
+      # The Environ for a source map.
+      # Subclasses can override this method.
+      #
+      # @param source_map [SourceMap]
+      # @return [Environ]
+      def local source_map
+        EMPTY_ENVIRON
+      end
+
+      # The Environ for a DocMap.
+      # Subclasses can override this method.
+      #
+      # @param doc_map [DocMap]
+      # @return [Environ]
+      def global doc_map
+        EMPTY_ENVIRON
+      end
+
+      # Provides any additional method pins based on e 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 object api_map, rooted_tag, scope, visibility,
+                 deep, skip, no_core
+        EMPTY_ENVIRON
+      end
+    end
+  end
+end

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

@@ -23,7 +23,7 @@ module Solargraph
           #       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/data_definition/data_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
 
             data_definition_node?(node.children[1])
@@ -37,7 +37,7 @@ module Solargraph
 
           # @param data_node [Parser::AST::Node]
           # @return [Boolean]
-          def data_definition_node?(data_node)
+          def data_definition_node? data_node
             return false unless data_node.is_a?(::Parser::AST::Node)
             return false unless data_node&.type == :send
             return false unless data_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
 
@@ -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,9 +81,11 @@ module Solargraph
           node.children[1]
         end
 
+        # @sg-ignore Need to add nil check here
         # @return [Array<Parser::AST::Node>]
         def data_attribute_nodes
-          data_node.children[2..-1]
+          # @sg-ignore Need to add nil check here
+          data_node.children[2..]
         end
       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)
@@ -90,7 +93,7 @@ module Solargraph
           # @param attribute_node [Parser::AST::Node]
           # @param attribute_name [String]
           # @return [String, nil]
-          def attribute_comments(attribute_node, attribute_name)
+          def attribute_comments attribute_node, attribute_name
             data_comments = comments_for(attribute_node)
             return if data_comments.nil? || data_comments.empty?
 

data/lib/solargraph/convention/gemfile.rb

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

data/lib/solargraph/convention/gemspec.rb

@@ -5,7 +5,7 @@ module Solargraph
     class Gemspec < Base
       def local source_map
         return Convention::Base::EMPTY_ENVIRON unless File.basename(source_map.filename).end_with?('.gemspec')
-        @environ ||= Environ.new(
+        @local ||= Environ.new(
           requires: ['rubygems'],
           pins: [
             Solargraph::Pin::Reference::Override.from_comment(

data/lib/solargraph/convention/rakefile.rb

@@ -7,7 +7,7 @@ module Solargraph
         basename = File.basename(source_map.filename)
         return EMPTY_ENVIRON unless basename.end_with?('.rake') || basename == 'Rakefile'
 
-        @environ ||= Environ.new(
+        @local ||= Environ.new(
           requires: ['rake'],
           domains: ['Rake::DSL']
         )

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

@@ -30,7 +30,7 @@ module Solargraph
 
     # @param source_map [SourceMap]
     # @return [Environ]
-    def self.for_local(source_map)
+    def self.for_local source_map
       result = Environ.new
       @@conventions.each do |conv|
         result.merge conv.local(source_map)
@@ -40,7 +40,7 @@ module Solargraph
 
     # @param doc_map [DocMap]
     # @return [Environ]
-    def self.for_global(doc_map)
+    def self.for_global doc_map
       result = Environ.new
       @@conventions.each do |conv|
         result.merge conv.global(doc_map)

data/lib/solargraph/converters/dd.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'nokogiri'
 
 module ReverseMarkdown

data/lib/solargraph/converters/dl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ReverseMarkdown
   module Converters
     class Dl < Base

data/lib/solargraph/converters/dt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ReverseMarkdown
   module Converters
     class Dt < Base

data/lib/solargraph/converters/misc.rb

@@ -1 +1,3 @@
+# 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|