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

data/lib/solargraph/complex_type.rb

@@ -4,7 +4,7 @@ module Solargraph
   # A container for type data based on YARD type tags.
   #
   class ComplexType
-    GENERIC_TAG_NAME = 'generic'.freeze
+    GENERIC_TAG_NAME = 'generic'
     # @!parse
     #   include TypeMethods
     include Equality
@@ -19,7 +19,7 @@ module Solargraph
       # @type [Array<UniqueType>]
       items = types.flat_map(&:items).uniq(&:to_s)
       if items.any? { |i| i.name == 'false' } && items.any? { |i| i.name == 'true' }
-        items.delete_if { |i| i.name == 'false' || i.name == 'true' }
+        items.delete_if { |i| %w[false true].include?(i.name) }
         items.unshift(UniqueType::BOOLEAN)
       end
       # @type [Array<UniqueType>]
@@ -29,17 +29,14 @@ module Solargraph
       @items = items
     end
 
-    protected def equality_fields
-      [self.class, items]
-    end
-
     # @param api_map [ApiMap]
-    # @param context [String]
+    # @param gates [Array<String>]
+    #
     # @return [ComplexType]
     def qualify api_map, *gates
       red = reduce_object
       types = red.items.map do |t|
-        next t if ['nil', 'void', 'undefined'].include?(t.name)
+        next t if %w[nil void undefined].include?(t.name)
         next t if ['::Boolean'].include?(t.rooted_name)
         t.qualify api_map, *gates
       end
@@ -53,7 +50,10 @@ module Solargraph
     def resolve_generics_from_context generics_to_resolve, context_type, resolved_generic_values: {}
       return self unless generic?
 
-      ComplexType.new(@items.map { |i| i.resolve_generics_from_context(generics_to_resolve, context_type, resolved_generic_values: resolved_generic_values) })
+      ComplexType.new(@items.map do |i|
+        i.resolve_generics_from_context(generics_to_resolve, context_type,
+                                        resolved_generic_values: resolved_generic_values)
+      end)
     end
 
     # @return [UniqueType]
@@ -84,14 +84,14 @@ module Solargraph
     # @sg-ignore Declared return type
     #   ::Array<::Solargraph::ComplexType::UniqueType> does not match
     #   inferred type ::Array<::Proc> for Solargraph::ComplexType#map
-    def map(&block)
+    def map &block
       @items.map(&block)
     end
 
     # @yieldparam [UniqueType]
     # @return [Enumerable<UniqueType>]
     def each &block
-      @items.each &block
+      @items.each(&block)
     end
 
     # @yieldparam [UniqueType]
@@ -102,17 +102,17 @@ module Solargraph
       return enum_for(__method__) unless block_given?
 
       @items.each do |item|
-        item.each_unique_type &block
+        item.each_unique_type(&block)
       end
     end
 
     # @param new_name [String, nil]
     # @param make_rooted [Boolean, nil]
     # @param new_key_types [Array<ComplexType>, nil]
-    # @param rooted [Boolean, nil]
+    # @param make_rooted [Boolean, nil]
     # @param new_subtypes [Array<ComplexType>, nil]
     # @return [self]
-    def recreate(new_name: nil, make_rooted: nil, new_key_types: nil, new_subtypes: nil)
+    def recreate new_name: nil, make_rooted: nil, new_key_types: nil, new_subtypes: nil
       ComplexType.new(map do |ut|
                         ut.recreate(new_name: new_name,
                                     make_rooted: make_rooted,
@@ -133,13 +133,13 @@ module Solargraph
 
     # @param index [Integer]
     # @return [UniqueType]
-    def [](index)
+    def [] index
       @items[index]
     end
 
     # @return [Array<UniqueType>]
     def select &block
-      @items.select &block
+      @items.select(&block)
     end
 
     # @return [String]
@@ -154,7 +154,9 @@ module Solargraph
     end
 
     # @param name [Symbol]
+    #
     # @return [Object, nil]
+    # @param [Array<Object>] args
     def method_missing name, *args, &block
       return if @items.first.nil?
       return @items.first.send(name, *args, &block) if respond_to_missing?(name)
@@ -163,7 +165,7 @@ module Solargraph
 
     # @param name [Symbol]
     # @param include_private [Boolean]
-    def respond_to_missing?(name, include_private = false)
+    def respond_to_missing? name, include_private = false
       TypeMethods.public_instance_methods.include?(name) || super
     end
 
@@ -198,24 +200,29 @@ module Solargraph
     # @param api_map [ApiMap]
     # @param expected [ComplexType, ComplexType::UniqueType]
     # @param situation [:method_call, :return_type, :assignment]
-    # @param allow_subtype_skew [Boolean] if false, check if any
-    #   subtypes of the expected type match the inferred type
-    # @param allow_reverse_match [Boolean] if true, check if any subtypes
-    #   of the expected type match the inferred type
-    # @param allow_empty_params [Boolean] if true, allow a general
-    #   inferred type without parameters to conform to a more specific
-    #   expected type
-    # @param allow_any_match [Boolean] if true, any unique type
-    #   matched in the inferred qualifies as a match
-    # @param allow_undefined [Boolean] if true, treat undefined as a
-    #   wildcard that matches anything
     # @param rules [Array<:allow_subtype_skew, :allow_empty_params, :allow_reverse_match, :allow_any_match, :allow_undefined, :allow_unresolved_generic, :allow_unmatched_interface>]
+    #
+    #   allow_subtype_skew: if not provided, check if any subtypes of
+    #     the expected type match the inferred type
+    #
+    #   allow_reverse_match: check if any subtypes
+    #     of the expected type match the inferred type
+    #
+    #   allow_empty_params: allow a general inferred type without
+    #     parameters to conform to a more specific expected type
+    #
+    #   allow_any_match: any unique type matched in the inferred
+    #     qualifies as a match
+    #
+    #   allow_undefined: treat undefined as a wildcard that matches
+    #     anything
+    #
     # @param variance [:invariant, :covariant, :contravariant]
     # @return [Boolean]
-    def conforms_to?(api_map, expected,
+    def conforms_to? api_map, expected,
                      situation,
                      rules = [],
-                     variance: erased_variance(situation))
+                     variance: erased_variance(situation)
       expected = expected.downcast_to_literal_if_possible
       inferred = downcast_to_literal_if_possible
 
@@ -256,14 +263,14 @@ module Solargraph
 
     # @yieldparam [UniqueType]
     def all? &block
-      @items.all? &block
+      @items.all?(&block)
     end
 
     # @yieldparam [UniqueType]
     # @yieldreturn [Boolean]
     # @return [Boolean]
     def any? &block
-      @items.compact.any? &block
+      @items.compact.any?(&block)
     end
 
     def selfy?
@@ -283,8 +290,10 @@ module Solargraph
     # @yieldparam t [UniqueType]
     # @yieldreturn [UniqueType]
     # @return [ComplexType]
-    def transform(new_name = nil, &transform_type)
-      raise "Please remove leading :: and set rooted with recreate() instead - #{new_name}" if new_name&.start_with?('::')
+    def transform new_name = nil, &transform_type
+      if new_name&.start_with?('::')
+        raise "Please remove leading :: and set rooted with recreate() instead - #{new_name}"
+      end
       ComplexType.new(map { |ut| ut.transform(new_name, &transform_type) })
     end
 
@@ -322,7 +331,7 @@ module Solargraph
     # @return [ComplexType]
     def reduce_class_type
       new_items = items.flat_map do |type|
-        next type unless ['Module', 'Class'].include?(type.name)
+        next type unless %w[Module Class].include?(type.name)
         next type if type.all_params.empty?
 
         type.all_params
@@ -337,7 +346,7 @@ module Solargraph
     end
 
     # @param other [ComplexType, UniqueType]
-    def erased_version_of?(other)
+    def erased_version_of? other
       return false if items.length != 1 || other.items.length != 1
 
       @items.first.erased_version_of?(other.items.first)
@@ -351,10 +360,6 @@ module Solargraph
 
     attr_reader :items
 
-    def rooted?
-      @items.all?(&:rooted?)
-    end
-
     # @param exclude_types [ComplexType, nil]
     # @param api_map [ApiMap]
     # @return [ComplexType, self]
@@ -391,6 +396,10 @@ module Solargraph
 
     protected
 
+    def equality_fields
+      [self.class, items]
+    end
+
     # @return [ComplexType]
     def reduce_object
       new_items = items.flat_map do |ut|
@@ -410,13 +419,11 @@ module Solargraph
       # @example
       #   ComplexType.parse 'String', 'Foo', 'nil' #=> [String, Foo, nil]
       #
-      # @note
-      #   The `partial` parameter is used to indicate that the method is
-      #   receiving a string that will be used inside another ComplexType.
-      #   It returns arrays of ComplexTypes instead of a single cohesive one.
-      #   Consumers should not need to use this parameter; it should only be
-      #   used internally.
-      #
+      # @param partial [Boolean] if true, method is receiving a string
+      #   that will be used inside another ComplexType.  It returns
+      #   arrays of ComplexTypes instead of a single cohesive one.
+      #   Consumers should not need to use this parameter; it should
+      #   only be used internally.
       # @param strings [Array<String>] The type definitions to parse
       # @return [ComplexType]
       # # @overload parse(*strings, partial: false)
@@ -446,14 +453,14 @@ module Solargraph
           # @param char [String]
           type_string&.each_char do |char|
             if char == '='
-              #raise ComplexTypeError, "Invalid = in type #{type_string}" unless curly_stack > 0
+              # raise ComplexTypeError, "Invalid = in type #{type_string}" unless curly_stack > 0
             elsif char == '<'
               point_stack += 1
             elsif char == '>'
-              if subtype_string.end_with?('=') && curly_stack > 0
+              if subtype_string.end_with?('=') && curly_stack.positive?
                 subtype_string += char
               elsif base.end_with?('=')
-                raise ComplexTypeError, "Invalid hash thing" unless key_types.nil?
+                raise ComplexTypeError, 'Invalid hash thing' unless key_types.nil?
                 # types.push ComplexType.new([UniqueType.new(base[0..-2].strip)])
                 # @sg-ignore Need to add nil check here
                 types.push UniqueType.parse(base[0..-2].strip, subtype_string)
@@ -466,7 +473,7 @@ module Solargraph
                 subtype_string.clear
                 next
               else
-                raise ComplexTypeError, "Invalid close in type #{type_string}" if point_stack == 0
+                raise ComplexTypeError, "Invalid close in type #{type_string}" if point_stack.zero?
                 point_stack -= 1
                 subtype_string += char
               end
@@ -476,34 +483,37 @@ module Solargraph
             elsif char == '}'
               curly_stack -= 1
               subtype_string += char
-              raise ComplexTypeError, "Invalid close in type #{type_string}" if curly_stack < 0
+              raise ComplexTypeError, "Invalid close in type #{type_string}" if curly_stack.negative?
               next
             elsif char == '('
               paren_stack += 1
             elsif char == ')'
               paren_stack -= 1
               subtype_string += char
-              raise ComplexTypeError, "Invalid close in type #{type_string}" if paren_stack < 0
+              raise ComplexTypeError, "Invalid close in type #{type_string}" if paren_stack.negative?
               next
-            elsif char == ',' && point_stack == 0 && curly_stack == 0 && paren_stack == 0
+            elsif char == ',' && point_stack.zero? && curly_stack.zero? && paren_stack.zero?
               # types.push ComplexType.new([UniqueType.new(base.strip, subtype_string.strip)])
               types.push UniqueType.parse(base.strip, subtype_string.strip)
               base.clear
               subtype_string.clear
               next
             end
-            if point_stack == 0 && curly_stack == 0 && paren_stack == 0
+            if point_stack.zero? && curly_stack.zero? && paren_stack.zero?
               base.concat char
             else
               subtype_string.concat char
             end
           end
-          raise ComplexTypeError, "Unclosed subtype in #{type_string}" if point_stack != 0 || curly_stack != 0 || paren_stack != 0
+          if point_stack != 0 || curly_stack != 0 || paren_stack != 0
+            raise ComplexTypeError,
+                  "Unclosed subtype in #{type_string}"
+          end
           # types.push ComplexType.new([UniqueType.new(base, subtype_string)])
           types.push UniqueType.parse(base.strip, subtype_string.strip)
         end
         unless key_types.nil?
-          raise ComplexTypeError, "Invalid use of key/value parameters" unless partial
+          raise ComplexTypeError, 'Invalid use of key/value parameters' unless partial
           return key_types if types.empty?
           return [key_types, types]
         end
@@ -515,7 +525,7 @@ module Solargraph
       # @param strings [Array<String>]
       # @return [ComplexType]
       def try_parse *strings
-        parse *strings
+        parse(*strings)
       rescue ComplexTypeError => e
         Solargraph.logger.info "Error parsing complex type `#{strings.join(', ')}`: #{e.message}"
         ComplexType::UNDEFINED
@@ -540,9 +550,7 @@ module Solargraph
     # @param dst [String]
     # @return [String]
     def reduce_class dst
-      while dst =~ /^(Class|Module)\<(.*?)\>$/
-        dst = dst.sub(/^(Class|Module)\</, '').sub(/\>$/, '')
-      end
+      dst = dst.sub(/^(Class|Module)</, '').sub(/>$/, '') while dst =~ /^(Class|Module)<(.*?)>$/
       dst
     end
   end

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

@@ -1,61 +1,61 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Convention
-    module DataDefinition
-      # A node wrapper for a Data definition via const assignment.
-      # @example
-      #   MyData = Data.new(:bar, :baz) do
-      #     def foo
-      #     end
-      #   end
-      class DataAssignmentNode < DataDefintionNode
-        class << self
-          # @example
-          # s(:casgn, nil, :Foo,
-          #   s(:block,
-          #     s(:send,
-          #       s(:const, nil, :Data), :define,
-          #       s(:sym, :bar),
-          #       s(:sym, :baz)),
-          #     s(:args),
-          #     s(:def, :foo,
-          #       s(:args),
-          #       s(:send, nil, :bar))))
-          # @param node [::Parser::AST::Node]
-          def match?(node)
-            return false unless node&.type == :casgn
-            return false if node.children[2].nil?
-
-            data_node = if node.children[2].type == :block
-                          node.children[2].children[0]
-                        else
-                          node.children[2]
-                        end
-
-            data_definition_node?(data_node)
-          end
-        end
-
-        def class_name
-          if node.children[0]
-            Parser::NodeMethods.unpack_name(node.children[0]) + "::#{node.children[1]}"
-          else
-            node.children[1].to_s
-          end
-        end
-
-        private
-
-        # @return [Parser::AST::Node]
-        def data_node
-          if node.children[2].type == :block
-            node.children[2].children[0]
-          else
-            node.children[2]
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Convention
+    module DataDefinition
+      # A node wrapper for a Data definition via const assignment.
+      # @example
+      #   MyData = Data.new(:bar, :baz) do
+      #     def foo
+      #     end
+      #   end
+      class DataAssignmentNode < DataDefintionNode
+        class << self
+          # @example
+          # s(:casgn, nil, :Foo,
+          #   s(:block,
+          #     s(:send,
+          #       s(:const, nil, :Data), :define,
+          #       s(:sym, :bar),
+          #       s(:sym, :baz)),
+          #     s(:args),
+          #     s(:def, :foo,
+          #       s(:args),
+          #       s(:send, nil, :bar))))
+          # @param node [::Parser::AST::Node]
+          def match? node
+            return false unless node&.type == :casgn
+            return false if node.children[2].nil?
+
+            data_node = if node.children[2].type == :block
+                          node.children[2].children[0]
+                        else
+                          node.children[2]
+                        end
+
+            data_definition_node?(data_node)
+          end
+        end
+
+        def class_name
+          if node.children[0]
+            Parser::NodeMethods.unpack_name(node.children[0]) + "::#{node.children[1]}"
+          else
+            node.children[1].to_s
+          end
+        end
+
+        private
+
+        # @return [Parser::AST::Node]
+        def data_node
+          if node.children[2].type == :block
+            node.children[2].children[0]
+          else
+            node.children[2]
+          end
+        end
+      end
+    end
+  end
+end

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
 
@@ -85,7 +85,7 @@ module Solargraph
         # @return [Array<Parser::AST::Node>]
         def data_attribute_nodes
           # @sg-ignore Need to add nil check here
-          data_node.children[2..-1]
+          data_node.children[2..]
         end
       end
     end

data/lib/solargraph/convention/data_definition.rb

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

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

@@ -24,7 +24,7 @@ module Solargraph
           #       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