solargraph 0.58.0 → 0.59.0.dev.1

data/lib/solargraph/equality.rb

@@ -1,34 +1,34 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # @abstract This mixin relies on these -
-  #   methods:
-  #     equality_fields()
-  module Equality
-    # @!method equality_fields
-    #   @return [Array]
-
-    # @param other [Object]
-    # @return [Boolean]
-    def eql?(other)
-      self.class.eql?(other.class) &&
-        # @sg-ignore https://github.com/castwide/solargraph/pull/1114
-        equality_fields.eql?(other.equality_fields)
-    end
-
-    # @param other [Object]
-    # @return [Boolean]
-    def ==(other)
-      self.eql?(other)
-    end
-
-    def hash
-      equality_fields.hash
-    end
-
-    def freeze
-      equality_fields.each(&:freeze)
-      super
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  # @abstract This mixin relies on these -
+  #   methods:
+  #     equality_fields()
+  module Equality
+    # @!method equality_fields
+    #   @return [Array]
+
+    # @param other [Object]
+    # @return [Boolean]
+    def eql?(other)
+      self.class.eql?(other.class) &&
+        # @sg-ignore flow sensitive typing should support .class == .class
+        equality_fields.eql?(other.equality_fields)
+    end
+
+    # @param other [Object]
+    # @return [Boolean]
+    def ==(other)
+      self.eql?(other)
+    end
+
+    def hash
+      equality_fields.hash
+    end
+
+    def freeze
+      equality_fields.each(&:freeze)
+      super
+    end
+  end
+end

data/lib/solargraph/gem_pins.rb

@@ -1,98 +1,97 @@
-# frozen_string_literal: true
-
-require 'rbs'
-
-module Solargraph
-  # A utility for building gem pins from a combination of YARD and RBS
-  # documentation.
-  #
-  module GemPins
-    class << self
-      include Logging
-    end
-
-    # @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 }
-      by_path = method_pins.group_by(&:path)
-      by_path.transform_values! do |pins|
-        GemPins.combine_method_pins(*pins)
-      end
-      by_path.values + alias_pins
-    end
-
-    # @param pins [Array<Pin::Method>]
-    # @return [Pin::Method, nil]
-    def self.combine_method_pins(*pins)
-      # @type [Pin::Method, nil]
-      combined_pin = nil
-      # @param memo [Pin::Method, nil]
-      # @param pin [Pin::Method]
-      out = pins.reduce(combined_pin) do |memo, pin|
-        next pin if memo.nil?
-        if memo == pin && memo.source != :combined
-          # @todo we should track down situations where we are handled
-          #   the same pin from the same source here and eliminate them -
-          #   this is an efficiency workaround for now
-          next memo
-        end
-        memo.combine_with(pin)
-      end
-      logger.debug { "GemPins.combine_method_pins(pins.length=#{pins.length}, pins=#{pins}) => #{out.inspect}" }
-      out
-    end
-
-    # @param yard_plugins [Array<String>] The names of YARD plugins to use.
-    # @param gemspec [Gem::Specification]
-    # @return [Array<Pin::Base>]
-    def self.build_yard_pins(yard_plugins, gemspec)
-      Yardoc.cache(yard_plugins, gemspec) unless Yardoc.cached?(gemspec)
-      return [] unless Yardoc.cached?(gemspec)
-      yardoc = Yardoc.load!(gemspec)
-      YardMap::Mapper.new(yardoc, gemspec).map
-    end
-
-    # @param yard_pins [Array<Pin::Base>]
-    # @param rbs_pins [Array<Pin::Base>]
-    #
-    # @return [Array<Pin::Base>]
-    def self.combine(yard_pins, rbs_pins)
-      in_yard = Set.new
-      rbs_api_map = Solargraph::ApiMap.new(pins: rbs_pins)
-      combined = yard_pins.map do |yard_pin|
-        in_yard.add yard_pin.path
-        rbs_pin = rbs_api_map.get_path_pins(yard_pin.path).filter { |pin| pin.is_a? Pin::Method }.first
-        next yard_pin unless rbs_pin && yard_pin.class == Pin::Method
-
-        unless rbs_pin
-          # @sg-ignore https://github.com/castwide/solargraph/pull/1114
-          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})" }
-          next yard_pin
-        end
-
-        out = combine_method_pins(rbs_pin, yard_pin)
-        logger.debug { "GemPins.combine: Combining yard.path=#{yard_pin.path} - rbs=#{rbs_pin.inspect} with yard=#{yard_pin.inspect} into #{out}" }
-        out
-      end
-      in_rbs_only = rbs_pins.select do |pin|
-        pin.path.nil? || !in_yard.include?(pin.path)
-      end
-      out = combined + in_rbs_only
-      logger.debug { "GemPins#combine: Returning #{out.length} combined pins" }
-      out
-    end
-
-    class << self
-      private
-
-      # Select the first defined type.
-      #
-      # @param choices [Array<ComplexType>]
-      # @return [ComplexType]
-      def best_return_type *choices
-        choices.find { |pin| pin.defined? } || choices.first || ComplexType::UNDEFINED
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'rbs'
+
+module Solargraph
+  # A utility for building gem pins from a combination of YARD and RBS
+  # documentation.
+  #
+  module GemPins
+    class << self
+      include Logging
+    end
+
+    # @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 }
+      by_path = method_pins.group_by(&:path)
+      by_path.transform_values! do |pins|
+        GemPins.combine_method_pins(*pins)
+      end
+      by_path.values + alias_pins
+    end
+
+    # @param pins [Array<Pin::Method>]
+    # @return [Pin::Method, nil]
+    def self.combine_method_pins(*pins)
+      # @type [Pin::Method, nil]
+      combined_pin = nil
+      # @param memo [Pin::Method, nil]
+      # @param pin [Pin::Method]
+      out = pins.reduce(combined_pin) do |memo, pin|
+        next pin if memo.nil?
+        if memo == pin && memo.source != :combined
+          # @todo we should track down situations where we are handled
+          #   the same pin from the same source here and eliminate them -
+          #   this is an efficiency workaround for now
+          next memo
+        end
+        memo.combine_with(pin)
+      end
+      logger.debug { "GemPins.combine_method_pins(pins.length=#{pins.length}, pins=#{pins}) => #{out.inspect}" }
+      out
+    end
+
+    # @param yard_pins [Array<Pin::Base>]
+    # @param rbs_pins [Array<Pin::Base>]
+    #
+    # @return [Array<Pin::Base>]
+    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|
+        in_yard.add yard_pin.path
+        rbs_pin = rbs_store.get_path_pins(yard_pin.path).filter { |pin| pin.is_a? Pin::Method }.first
+
+        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})" }
+          next yard_pin
+        end
+
+        # at this point both yard_pins and rbs_pins are methods or
+        # method aliases.  if not plain methods, prefer the YARD one
+        next yard_pin if rbs_pin.class != Pin::Method
+
+        next rbs_pin if yard_pin.class != Pin::Method
+
+        # both are method pins
+        out = combine_method_pins(rbs_pin, yard_pin)
+        logger.debug do
+          "GemPins.combine: Combining yard.path=#{yard_pin.path} - rbs=#{rbs_pin.inspect} with yard=#{yard_pin.inspect} into #{out}"
+        end
+        out
+      end
+      in_rbs_only = rbs_pins.select do |pin|
+        pin.path.nil? || !in_yard.include?(pin.path)
+      end
+      out = combined + in_rbs_only
+      logger.debug { "GemPins#combine: Returning #{out.length} combined pins" }
+      out
+    end
+
+    class << self
+      private
+
+      # Select the first defined type.
+      #
+      # @param choices [Array<ComplexType>]
+      # @return [ComplexType]
+      def best_return_type *choices
+        choices.find { |pin| pin.defined? } || choices.first || ComplexType::UNDEFINED
+      end
+    end
+  end
+end

data/lib/solargraph/language_server/host/dispatch.rb

@@ -1,130 +1,131 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module LanguageServer
-    class Host
-      # Methods for associating sources with libraries via URIs.
-      #
-      module Dispatch
-        # @abstract
-        # @return [Host::Diagnoser]
-        def diagnoser
-          raise NotImplementedError, 'Host::Dispatch requires a diagnoser method'
-        end
-
-        # @return [Sources]
-        def sources
-          @sources ||= begin
-            src = Sources.new
-            src.add_observer self, :update_libraries
-            src
-          end
-        end
-
-        # @return [::Array<Library>]
-        def libraries
-          @libraries ||= []
-        end
-
-        # The Sources observer callback that merges a source into the host's
-        # libraries when it gets updated.
-        #
-        # @param uri [String]
-        # @return [void]
-        def update_libraries uri
-          src = sources.find(uri)
-          using = libraries.select { |lib| lib.contain?(src.filename) }
-          using.push library_for(uri) if using.empty?
-          using.each { |lib| lib.merge src }
-          diagnoser.schedule uri
-        end
-
-        # Find the best libary match for the given URI.
-        #
-        # @param uri [String]
-        # @return [Library]
-        def library_for uri
-          result = explicit_library_for(uri) ||
-            implicit_library_for(uri) ||
-            generic_library_for(uri)
-          # previous library for already call attach. avoid call twice
-          # result.attach sources.find(uri) if sources.include?(uri)
-          result
-        end
-
-        # Find an explicit library match for the given URI. An explicit match
-        # means the libary's workspace includes the file.
-        #
-        # If a matching library is found, the source corresponding to the URI
-        # gets attached to it.
-        #
-        # @raise [FileNotFoundError] if the source could not be attached.
-        #
-        # @param uri [String]
-        # @return [Library, nil]
-        def explicit_library_for uri
-          filename = UriHelpers.uri_to_file(uri)
-          libraries.each do |lib|
-            if lib.contain?(filename)
-              lib.attach sources.find(uri) if sources.include?(uri)
-              return lib
-            end
-          end
-          nil
-        end
-
-        # Find an implicit library match for the given URI. An implicit match
-        # means the file is located inside the library's workspace directory,
-        # regardless of whether the workspace is configured to include it.
-        #
-        # If a matching library is found, the source corresponding to the URI
-        # gets attached to it.
-        #
-        # @raise [FileNotFoundError] if the source could not be attached.
-        #
-        # @param uri [String]
-        # @return [Library, nil]
-        def implicit_library_for uri
-          filename = UriHelpers.uri_to_file(uri)
-          libraries.each do |lib|
-            if filename.start_with?(lib.workspace.directory)
-              lib.attach sources.find(uri)
-              return lib
-            end
-          end
-          nil
-        end
-
-        # @return [Hash{String => undefined}]
-        def options
-          @options ||= {}.freeze
-        end
-
-        # Get a generic library for the given URI and attach the corresponding
-        # source.
-        #
-        # @raise [FileNotFoundError] if the source could not be attached.
-        #
-        # @param uri [String]
-        # @return [Library]
-        def generic_library_for uri
-          generic_library.attach sources.find(uri)
-          generic_library
-        end
-
-        # @return [Library]
-        def generic_library
-          @generic_library ||= Solargraph::Library.new(Solargraph::Workspace.new('', nil, options), nil)
-                                                  .tap { |lib| lib.add_observer self }
-        end
-
-        # @param library [Solargraph::Library]
-        # @param progress [Solargraph::LanguageServer::Progress, nil]
-        # @return [void]
-        def update progress
-          progress&.send(self)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module LanguageServer
+    class Host
+      # Methods for associating sources with libraries via URIs.
+      #
+      module Dispatch
+        # @abstract
+        # @return [Host::Diagnoser]
+        def diagnoser
+          raise NotImplementedError, 'Host::Dispatch requires a diagnoser method'
+        end
+
+        # @return [Sources]
+        def sources
+          @sources ||= begin
+            src = Sources.new
+            src.add_observer self, :update_libraries
+            src
+          end
+        end
+
+        # @return [::Array<Library>]
+        def libraries
+          @libraries ||= []
+        end
+
+        # The Sources observer callback that merges a source into the host's
+        # libraries when it gets updated.
+        #
+        # @param uri [String]
+        # @return [void]
+        def update_libraries uri
+          src = sources.find(uri)
+          # @sg-ignore Need to add nil check here
+          using = libraries.select { |lib| lib.contain?(src.filename) }
+          using.push library_for(uri) if using.empty?
+          using.each { |lib| lib.merge src }
+          diagnoser.schedule uri
+        end
+
+        # Find the best libary match for the given URI.
+        #
+        # @param uri [String]
+        # @return [Library]
+        def library_for uri
+          result = explicit_library_for(uri) ||
+            implicit_library_for(uri) ||
+            generic_library_for(uri)
+          # previous library for already call attach. avoid call twice
+          # result.attach sources.find(uri) if sources.include?(uri)
+          result
+        end
+
+        # Find an explicit library match for the given URI. An explicit match
+        # means the libary's workspace includes the file.
+        #
+        # If a matching library is found, the source corresponding to the URI
+        # gets attached to it.
+        #
+        # @raise [FileNotFoundError] if the source could not be attached.
+        #
+        # @param uri [String]
+        # @return [Library, nil]
+        def explicit_library_for uri
+          filename = UriHelpers.uri_to_file(uri)
+          libraries.each do |lib|
+            if lib.contain?(filename)
+              lib.attach sources.find(uri) if sources.include?(uri)
+              return lib
+            end
+          end
+          nil
+        end
+
+        # Find an implicit library match for the given URI. An implicit match
+        # means the file is located inside the library's workspace directory,
+        # regardless of whether the workspace is configured to include it.
+        #
+        # If a matching library is found, the source corresponding to the URI
+        # gets attached to it.
+        #
+        # @raise [FileNotFoundError] if the source could not be attached.
+        #
+        # @param uri [String]
+        # @return [Library, nil]
+        def implicit_library_for uri
+          filename = UriHelpers.uri_to_file(uri)
+          libraries.each do |lib|
+            if filename.start_with?(lib.workspace.directory)
+              lib.attach sources.find(uri)
+              return lib
+            end
+          end
+          nil
+        end
+
+        # @return [Hash{String => undefined}]
+        def options
+          @options ||= {}.freeze
+        end
+
+        # Get a generic library for the given URI and attach the corresponding
+        # source.
+        #
+        # @raise [FileNotFoundError] if the source could not be attached.
+        #
+        # @param uri [String]
+        # @return [Library]
+        def generic_library_for uri
+          generic_library.attach sources.find(uri)
+          generic_library
+        end
+
+        # @return [Library]
+        def generic_library
+          @generic_library ||= Solargraph::Library.new(Solargraph::Workspace.new('', nil, options), nil)
+                                                  .tap { |lib| lib.add_observer self }
+        end
+
+        # @param library [Solargraph::Library]
+        # @param progress [Solargraph::LanguageServer::Progress, nil]
+        # @return [void]
+        def update progress
+          progress&.send(self)
+        end
+      end
+    end
+  end
+end