solargraph 0.58.0 → 0.59.0

data/lib/solargraph/pin/common.rb

@@ -1,79 +1,97 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    module Common
-      # @!method source
-      #   @abstract
-      #   @return [Source, nil]
-      # @type @closure [Pin::Closure, nil]
-
-      # @return [Location]
-      attr_reader :location
-
-      # @sg-ignore Solargraph::Pin::Common#closure return type could not be inferred
-      # @return [Pin::Closure, nil]
-      def closure
-        Solargraph.assert_or_log(:closure, "Closure not set on #{self.class} #{name.inspect} from #{source.inspect}") unless @closure
-        @closure
-      end
-
-      # @return [String]
-      def name
-        @name ||= ''
-      end
-
-      # @return [ComplexType]
-      def return_type
-        @return_type ||= ComplexType::UNDEFINED
-      end
-
-      # @return [ComplexType]
-      def context
-        # Get the static context from the nearest namespace
-        @context ||= find_context
-      end
-      alias full_context context
-
-      # @return [String]
-      def namespace
-        context.namespace.to_s
-      end
-
-      # @return [ComplexType]
-      def binder
-        @binder || context
-      end
-
-      # @return [String]
-      def comments
-        @comments ||= ''
-      end
-
-      # @return [String]
-      def path
-        @path ||= name.empty? ? context.namespace : "#{context.namespace}::#{name}"
-      end
-
-      protected
-
-      attr_writer :context
-
-      private
-
-      # @return [ComplexType]
-      def find_context
-        here = closure
-        until here.nil?
-          if here.is_a?(Pin::Namespace)
-            return here.return_type
-          elsif here.is_a?(Pin::Method)
-            return here.context
-          end
-          here = here.closure
-        end
-        ComplexType::ROOT
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    module Common
+      # @!method source
+      #   @abstract
+      #   @return [Source, nil]
+      # @!method reset_generated!
+      #   @abstract
+      #   @return [void]
+      # @type @closure [Pin::Closure, nil]
+      # @type @binder [ComplexType, ComplexType::UniqueType, nil]
+
+      # @todo Missed nil violation
+      # @return [Location, nil]
+      attr_accessor :location
+
+      # @param value [Pin::Closure]
+      # @return [void]
+      def closure= value
+        @closure = value
+        # remove cached values generated from closure
+        reset_generated!
+      end
+
+      # @return [Pin::Closure, nil]
+      def closure
+        unless @closure
+          Solargraph.assert_or_log(:closure,
+                                   "Closure not set on #{self.class} #{name.inspect} from #{source.inspect}")
+        end
+        @closure
+      end
+
+      # @return [String]
+      def name
+        @name ||= ''
+      end
+
+      # @todo redundant with Base#return_type?
+      # @return [ComplexType]
+      def return_type
+        @return_type ||= ComplexType::UNDEFINED
+      end
+
+      # @return [ComplexType, ComplexType::UniqueType]
+      def context
+        # Get the static context from the nearest namespace
+        @context ||= find_context
+      end
+      alias full_context context
+
+      # @return [String]
+      def namespace
+        context.namespace.to_s
+      end
+
+      # @return [ComplexType, ComplexType::UniqueType]
+      # @sg-ignore https://github.com/castwide/solargraph/pull/1100
+      def binder
+        @binder || context
+      end
+
+      # @return [String]
+      def comments
+        @comments ||= ''
+      end
+
+      # @return [String]
+      def path
+        @path ||= name.empty? ? context.namespace : "#{context.namespace}::#{name}"
+      end
+
+      protected
+
+      attr_writer :context
+
+      private
+
+      # @return [ComplexType]
+      def find_context
+        here = closure
+        until here.nil?
+          if here.is_a?(Pin::Namespace)
+            return here.return_type
+          elsif here.is_a?(Pin::Method)
+            return here.context
+          end
+          # @sg-ignore Need to add nil check here
+          here = here.closure
+        end
+        ComplexType::ROOT
+      end
+    end
+  end
+end

data/lib/solargraph/pin/compound_statement.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    # A series of statements where if a given statement executes, /all
+    # of the previous statements in the sequence must have executed as
+    # well/.  In other words, the statements are run from the top in
+    # sequence, until interrupted by something like a
+    # return/break/next/raise/etc.
+    #
+    # This mix-in is used in flow sensitive typing to determine how
+    # far we can assume a given assertion about a type can be trusted
+    # to be true.
+    #
+    # Some examples in Ruby:
+    #
+    # * Bodies of methods and Ruby blocks
+    # * Branches of conditionals and loops - if/elsif/else,
+    #   unless/else, when, until, ||=, ?:, switch/case/else
+    # * The body of begin-end/try/rescue/ensure statements
+    #
+    # Compare/contrast with:
+    #
+    # * Scope - a sequence where variables declared are not available
+    #   after the end of the scope.  Note that this is not necessarily
+    #   true for a compound statement.
+    # * Compound statement - synonym
+    # * Block - in Ruby this has a special meaning (a closure passed to a method), but
+    #   in general parlance this is also a synonym.
+    # * Closure - a sequence which is also a scope
+    # * Namespace - a named sequence which is also a scope and a
+    #   closure
+    #
+    # See:
+    #   https://cse.buffalo.edu/~regan/cse305/RubyBNF.pdf
+    #   https://ruby-doc.org/docs/ruby-doc-bundle/Manual/man-1.4/syntax.html
+    #   https://en.wikipedia.org/wiki/Block_(programming)
+    #
+    # Note:
+    #
+    # Just because statement #1 in a sequence is executed, it doesn't
+    # mean that future ones will.  Consider the effect of
+    # break/next/return/raise/etc. on control flow.
+    class CompoundStatement < Pin::Base
+      attr_reader :node
+
+      # @param node [Parser::AST::Node, nil]
+      # @param [Hash{Symbol => Object}] splat
+      def initialize node: nil, **splat
+        super(**splat)
+        @node = node
+      end
+    end
+  end
+end

data/lib/solargraph/pin/constant.rb

@@ -1,45 +1,43 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    class Constant < BaseVariable
-      attr_reader :visibility
-
-      # @param visibility [::Symbol] The visibility of the constant (:public, :protected, or :private)
-      # @param splat [Hash] Additional options supported by superclasses
-      def initialize visibility: :public, **splat
-        super(**splat)
-        @visibility = visibility
-      end
-
-      def return_type
-        @return_type ||= generate_complex_type
-      end
-
-      def completion_item_kind
-        Solargraph::LanguageServer::CompletionItemKinds::CONSTANT
-      end
-
-      # @return [Integer]
-      def symbol_kind
-        LanguageServer::SymbolKinds::CONSTANT
-      end
-
-      def path
-        @path ||= context.namespace.to_s.empty? ? name : "#{context.namespace}::#{name}"
-      end
-
-      private
-
-      # @return [ComplexType]
-      def generate_complex_type
-        tags = docstring.tags(:return).map(&:types).flatten.reject(&:nil?)
-        if tags.empty?
-          tags = docstring.tags(:type).map(&:types).flatten.reject(&:nil?)
-        end
-        return ComplexType::UNDEFINED if tags.empty?
-        ComplexType.try_parse *tags
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Constant < BaseVariable
+      attr_reader :visibility
+
+      # @param visibility [::Symbol] The visibility of the constant (:public, :protected, or :private)
+      # @param splat [Hash] Additional options supported by superclasses
+      def initialize visibility: :public, **splat
+        super(**splat)
+        @visibility = visibility
+      end
+
+      def return_type
+        @return_type ||= generate_complex_type
+      end
+
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::CONSTANT
+      end
+
+      # @return [Integer]
+      def symbol_kind
+        LanguageServer::SymbolKinds::CONSTANT
+      end
+
+      def path
+        @path ||= context.namespace.to_s.empty? ? name : "#{context.namespace}::#{name}"
+      end
+
+      private
+
+      # @return [ComplexType]
+      def generate_complex_type
+        tags = docstring.tags(:return).map(&:types).flatten.compact
+        tags = docstring.tags(:type).map(&:types).flatten.compact if tags.empty?
+        return ComplexType::UNDEFINED if tags.empty?
+        ComplexType.try_parse(*tags)
+      end
+    end
+  end
+end

data/lib/solargraph/pin/conversions.rb

@@ -1,123 +1,129 @@
-# frozen_string_literal: true
-
-require 'cgi'
-
-module Solargraph
-  module Pin
-    # @todo Move this stuff. It should be the responsibility of the language server.
-    # @todo abstract methods below should be verified to be overridden
-    #   by type checker when mixin included by non-abstract class
-    module Conversions
-      # @!parse
-      #   include Documenting
-      #   include Common
-
-      # @return [Integer]
-      # @abstract
-      def completion_item_kind
-        raise NotImplementedError
-      end
-
-      # @abstract
-      # @return [Boolean]
-      def deprecated?
-        raise NotImplementedError
-      end
-
-      # @abstract
-      def probed?
-        raise NotImplementedError
-      end
-
-      # @abstract
-      def proxied?
-        raise NotImplementedError
-      end
-
-      # @return [Hash]
-      def completion_item
-        @completion_item ||= {
-          label: name,
-          kind: completion_item_kind,
-          detail: detail,
-          data: {
-            path: path,
-            return_type: return_type.tag,
-            location: (location ? location.to_hash : nil),
-            deprecated: deprecated?
-          }
-        }
-      end
-
-      # @return [Hash]
-      def resolve_completion_item
-        @resolve_completion_item ||= begin
-          extra = {}
-          alldoc = ''
-          # alldoc += link_documentation unless link_documentation.nil?
-          # alldoc += "\n\n" unless alldoc.empty?
-          alldoc += documentation unless documentation.nil?
-          extra[:documentation] = alldoc unless alldoc.empty?
-          completion_item.merge(extra)
-        end
-      end
-
-      # @return [::Array<Hash>]
-      def signature_help
-        []
-      end
-
-      # @return [String, nil]
-      def detail
-        # This property is not cached in an instance variable because it can
-        # change when pins get proxied.
-        detail = String.new
-        detail += "=#{probed? ? '~' : (proxied? ? '^' : '>')} #{return_type.to_s}" unless return_type.undefined?
-        detail.strip!
-        return nil if detail.empty?
-        detail
-      end
-
-      # Get a markdown-flavored link to a documentation page.
-      #
-      # @return [String]
-      def link_documentation
-        @link_documentation ||= generate_link
-      end
-
-      # @return [String, nil]
-      def text_documentation
-        this_path = path || name || return_type.tag
-        return nil if this_path == 'undefined'
-        escape_brackets this_path
-      end
-
-      # @return [void]
-      def reset_conversions
-        @completion_item = nil
-        @resolve_completion_item = nil
-        @signature_help = nil
-        @detail = nil
-        @link_documentation = nil
-      end
-
-      private
-
-      # @return [String, nil]
-      def generate_link
-        this_path = path || name || return_type.tag
-        return nil if this_path == 'undefined'
-        return nil if this_path.nil? || this_path == 'undefined'
-        return this_path if path.nil?
-        "[#{escape_brackets(this_path).gsub('_', '\\\\_')}](solargraph:/document?query=#{CGI.escape(this_path)})"
-      end
-
-      # @param text [String]
-      # @return [String]
-      def escape_brackets text
-        # text.gsub(/(\<|\>)/, "\\#{$1}")
-        text.gsub("<", '\<').gsub(">", '\>')
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'cgi'
+
+module Solargraph
+  module Pin
+    # @todo Move this stuff. It should be the responsibility of the language server.
+    # @todo abstract methods below should be verified to be overridden
+    #   by type checker when mixin included by non-abstract class
+    module Conversions
+      # @!parse
+      #   include Documenting
+      #   include Common
+
+      # @return [Integer]
+      # @abstract
+      def completion_item_kind
+        raise NotImplementedError
+      end
+
+      # @abstract
+      # @return [Boolean]
+      def deprecated?
+        raise NotImplementedError
+      end
+
+      # @abstract
+      def probed?
+        raise NotImplementedError
+      end
+
+      # @abstract
+      def proxied?
+        raise NotImplementedError
+      end
+
+      # @return [Hash]
+      def completion_item
+        @completion_item ||= {
+          label: name,
+          kind: completion_item_kind,
+          detail: detail,
+          data: {
+            path: path,
+            return_type: return_type.tag,
+            location: location&.to_hash,
+            deprecated: deprecated?
+          }
+        }
+      end
+
+      # @return [Hash]
+      def resolve_completion_item
+        @resolve_completion_item ||= begin
+          extra = {}
+          alldoc = ''
+          # alldoc += link_documentation unless link_documentation.nil?
+          # alldoc += "\n\n" unless alldoc.empty?
+          alldoc += documentation unless documentation.nil?
+          extra[:documentation] = alldoc unless alldoc.empty?
+          completion_item.merge(extra)
+        end
+      end
+
+      # @return [::Array<Hash>]
+      def signature_help
+        []
+      end
+
+      # @return [String, nil]
+      def detail
+        # This property is not cached in an instance variable because it can
+        # change when pins get proxied.
+        detail = String.new
+        unless return_type.undefined?
+          detail += "=#{if probed?
+                          '~'
+                        else
+                          (proxied? ? '^' : '>')
+                        end} #{return_type}"
+        end
+        detail.strip!
+        return nil if detail.empty?
+        detail
+      end
+
+      # Get a markdown-flavored link to a documentation page.
+      #
+      # @return [String, nil]
+      def link_documentation
+        @link_documentation ||= generate_link
+      end
+
+      # @return [String, nil]
+      def text_documentation
+        this_path = path || name || return_type.tag
+        return nil if this_path == 'undefined'
+        escape_brackets this_path
+      end
+
+      # @return [void]
+      def reset_conversions
+        @completion_item = nil
+        @resolve_completion_item = nil
+        @signature_help = nil
+        @detail = nil
+        @link_documentation = nil
+      end
+
+      private
+
+      # @return [String, nil]
+      def generate_link
+        this_path = path || name || return_type.tag
+        return nil if this_path == 'undefined'
+        return nil if this_path.nil? || this_path == 'undefined'
+        return this_path if path.nil?
+        "[#{escape_brackets(this_path).gsub('_', '\\\\_')}](solargraph:/document?query=#{CGI.escape(this_path)})"
+      end
+
+      # @param text [String]
+      # @return [String]
+      def escape_brackets text
+        # text.gsub(/(\<|\>)/, "\\#{$1}")
+        text.gsub('<', '\<').gsub('>', '\>')
+      end
+    end
+  end
+end