solargraph 0.46.0 → 0.54.5

data/lib/solargraph/pin/documenting.rb

@@ -1,105 +1,98 @@
-# frozen_string_literal: true
-
-require 'kramdown'
-require 'kramdown-parser-gfm'
-require 'yard'
-require 'reverse_markdown'
-require 'solargraph/converters/dl'
-require 'solargraph/converters/dt'
-require 'solargraph/converters/dd'
-require 'solargraph/converters/misc'
-
-module Solargraph
-  module Pin
-    # A module to add the Pin::Base#documentation method.
-    #
-    module Documenting
-      # A documentation formatter that either performs Markdown conversion for
-      # text, or applies backticks for code blocks.
-      #
-      class DocSection
-        # @return [String]
-        attr_reader :plaintext
-
-        # @param code [Boolean] True if this section is a code block
-        def initialize code
-          @plaintext = String.new('')
-          @code = code
-        end
-
-        def code?
-          @code
-        end
-
-        # @param text [String]
-        # @return [String]
-        def concat text
-          @plaintext.concat text
-        end
-
-        def to_s
-          return "\n```ruby\n#{@plaintext}#{@plaintext.end_with?("\n") ? '' : "\n"}```\n\n" if code?
-          ReverseMarkdown.convert unescape_brackets(Kramdown::Document.new(escape_brackets(@plaintext), input: 'GFM').to_html)
-        end
-
-        private
-
-        # @param text [String]
-        # @return [String]
-        def escape_brackets text
-          # text.gsub(/(\[[^\]]*\])([^\(]|\z)/, '!!!^\1^!!!\2')
-          text.gsub('[', '!!!!b').gsub(']', 'e!!!!')
-        end
-
-        # @param text [String]
-        # @return [String]
-        def unescape_brackets text
-          text.gsub('!!!!b', '[').gsub('e!!!!', ']')
-        end
-      end
-
-      # @return [String]
-      def documentation
-        @documentation ||= begin
-          # Using DocSections allows for code blocks that start with an empty
-          # line and at least two spaces of indentation. This is a common
-          # convention in Ruby core documentation, e.g., String#split.
-          sections = [DocSection.new(false)]
-          normalize_indentation(docstring.to_s).gsub(/\t/, '  ').lines.each do |l|
-            if l.strip.empty?
-              sections.last.concat l
-            else
-              if (l =~ /^  [^\s]/ && sections.last.plaintext =~ /(\r?\n[ \t]*?){2,}$/) || (l.start_with?('  ') && sections.last.code?)
-                # Code block
-                sections.push DocSection.new(true) unless sections.last.code?
-                sections.last.concat l[2..-1]
-              else
-                # Regular documentation
-                sections.push DocSection.new(false) if sections.last.code?
-                sections.last.concat l
-              end
-            end
-          end
-          sections.map(&:to_s).join.strip
-        end
-      end
-
-      private
-
-      # @param text [String]
-      # @return [String]
-      def normalize_indentation text
-        text.lines.map { |l| remove_odd_spaces(l) }.join
-      end
-
-      # @param line [String]
-      # @return [String]
-      def remove_odd_spaces line
-        return line unless line.start_with?(' ')
-        spaces = line.match(/^ +/)[0].length
-        return line unless spaces.odd?
-        line[1..-1]
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'kramdown'
+require 'kramdown-parser-gfm'
+require 'yard'
+require 'reverse_markdown'
+require 'solargraph/converters/dl'
+require 'solargraph/converters/dt'
+require 'solargraph/converters/dd'
+require 'solargraph/converters/misc'
+
+module Solargraph
+  module Pin
+    # A module to add the Pin::Base#documentation method.
+    #
+    module Documenting
+      # A documentation formatter that either performs Markdown conversion for
+      # text, or applies backticks for code blocks.
+      #
+      class DocSection
+        # @return [String]
+        attr_reader :plaintext
+
+        # @param code [Boolean] True if this section is a code block
+        def initialize code
+          @plaintext = String.new('')
+          @code = code
+        end
+
+        def code?
+          @code
+        end
+
+        # @param text [String]
+        # @return [String]
+        def concat text
+          @plaintext.concat text
+        end
+
+        def to_s
+          return to_code if code?
+          to_markdown
+        end
+
+        private
+
+        # @return [String]
+        def to_code
+          "\n```ruby\n#{Documenting.normalize_indentation(@plaintext)}#{@plaintext.end_with?("\n") ? '' : "\n"}```\n\n"
+        end
+
+        # @return [String]
+        def to_markdown
+          ReverseMarkdown.convert Kramdown::Document.new(@plaintext, input: 'GFM').to_html
+        end
+      end
+
+      # @return [String]
+      def documentation
+        @documentation ||= begin
+          # Using DocSections allows for code blocks that start with an empty
+          # line and at least two spaces of indentation. This is a common
+          # convention in Ruby core documentation, e.g., String#split.
+          sections = [DocSection.new(false)]
+          Documenting.normalize_indentation(Documenting.strip_html_comments(docstring.to_s.gsub("\t", '  '))).lines.each do |l|
+            if l.start_with?('  ')
+              # Code block
+              sections.push DocSection.new(true) unless sections.last.code?
+            elsif sections.last.code?
+              # Regular documentation
+              sections.push DocSection.new(false)
+            end
+            sections.last.concat l
+          end
+          sections.map(&:to_s).join.strip
+        end
+      end
+
+      # @param text [String]
+      # @return [String]
+      def self.strip_html_comments text
+        text.gsub(/<!--([\s\S]*?)-->/, '').strip
+      end
+
+      # @param text [String]
+      # @return [String]
+      def self.normalize_indentation text
+        left = text.lines.map do |line|
+          match = line.match(/^ +/)
+          next 0 unless match
+          match[0].length
+        end.min
+        return text if left.nil? || left.zero?
+        text.lines.map { |line| line[left..] }.join
+      end
+    end
+  end
+end

data/lib/solargraph/pin/duck_method.rb

@@ -1,16 +1,16 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    # DuckMethod pins are used to add completion items for type tags that
-    # use duck typing, e.g., `@param file [#read]`.
-    #
-    class DuckMethod < Pin::Method
-      # @param location [Solargraph::Location]
-      # @param name [String]
-      # def initialize location, name
-      #   # super(location, '', name, nil, :instance, :public, [])
-      # end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    # DuckMethod pins are used to add completion items for type tags that
+    # use duck typing, e.g., `@param file [#read]`.
+    #
+    class DuckMethod < Pin::Method
+      # @param location [Solargraph::Location]
+      # @param name [String]
+      # def initialize location, name
+      #   # super(location, '', name, nil, :instance, :public, [])
+      # end
+    end
+  end
+end

data/lib/solargraph/pin/global_variable.rb

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    class GlobalVariable < BaseVariable
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class GlobalVariable < BaseVariable
+    end
+  end
+end

data/lib/solargraph/pin/instance_variable.rb

@@ -1,30 +1,34 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    class InstanceVariable < BaseVariable
-      def binder
-        closure.binder
-      end
-
-      def scope
-        closure.binder.scope
-      end
-
-      def context
-        @context ||= begin
-          result = super
-          if scope == :class
-            ComplexType.parse("Class<#{result.namespace}>")
-          else
-            ComplexType.parse("#{result.namespace}")
-          end
-        end
-      end
-
-      def nearly? other
-        super && binder == other.binder
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class InstanceVariable < BaseVariable
+      # @return [ComplexType]
+      def binder
+        closure.binder
+      end
+
+      # @return [::Symbol]
+      def scope
+        closure.binder.scope
+      end
+
+      # @return [ComplexType]
+      def context
+        @context ||= begin
+          result = super
+          if scope == :class
+            ComplexType.parse("::Class<#{result.rooted_namespace}>")
+          else
+            result.reduce_class_type
+          end
+        end
+      end
+
+      # @param other [InstanceVariable]
+      def nearly? other
+        super && binder == other.binder
+      end
+    end
+  end
+end

data/lib/solargraph/pin/keyword.rb

@@ -1,15 +1,15 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    class Keyword < Base
-      def initialize name
-        super(name: name)
-      end
-
-      def name
-        @name
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class Keyword < Base
+      def initialize name
+        super(name: name)
+      end
+
+      def name
+        @name
+      end
+    end
+  end
+end

data/lib/solargraph/pin/keyword_param.rb

@@ -1,8 +1,8 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    class KeywordParam < Symbol
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class KeywordParam < Symbol
+    end
+  end
+end

data/lib/solargraph/pin/local_variable.rb

@@ -1,55 +1,67 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    class LocalVariable < BaseVariable
-      # @return [Range]
-      attr_reader :presence
-
-      def initialize assignment: nil, presence: nil, **splat
-        super(**splat)
-        @assignment = assignment
-        @presence = presence
-      end
-
-      def try_merge! pin
-        return false unless super
-        @presence = pin.presence
-        true
-      end
-
-      # @param other_closure [Pin::Closure]
-      # @param other_loc [Location]
-      def visible_at?(other_closure, other_loc)
-        return true if location.filename == other_loc.filename &&
-          presence.include?(other_loc.range.start) &&
-          match_named_closure(other_closure, closure)
-      end
-
-      private
-
-      # @param tag1 [String]
-      # @param tag2 [String]
-      # @return [Boolean]
-      def match_tags tag1, tag2
-        # @todo This is an unfortunate hack made necessary by a discrepancy in
-        #   how tags indicate the root namespace. The long-term solution is to
-        #   standardize it, whether it's `Class<>`, an empty string, or
-        #   something else.
-        tag1 == tag2 ||
-          (['', 'Class<>'].include?(tag1) && ['', 'Class<>'].include?(tag2))
-      end
-
-      def match_named_closure needle, haystack
-        return true if needle == haystack || haystack.is_a?(Pin::Block)
-        cursor = haystack
-        until cursor.nil?
-          return true if needle.path == cursor.path
-          return false if cursor.path && !cursor.path.empty?
-          cursor = cursor.closure
-        end
-        false
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  module Pin
+    class LocalVariable < BaseVariable
+      # @return [Range]
+      attr_reader :presence
+
+      # @param assignment [AST::Node, nil]
+      # @param presence [Range, nil]
+      # @param splat [Hash]
+      def initialize assignment: nil, presence: nil, **splat
+        super(**splat)
+        @assignment = assignment
+        @presence = presence
+      end
+
+      # @param pin [self]
+      def try_merge! pin
+        return false unless super
+        @presence = pin.presence
+        true
+      end
+
+      # @param other_closure [Pin::Closure]
+      # @param other_loc [Location]
+      def visible_at?(other_closure, other_loc)
+        location.filename == other_loc.filename &&
+          presence.include?(other_loc.range.start) &&
+          match_named_closure(other_closure, closure)
+      end
+
+      # @return [String]
+      def to_rbs
+        (name || '(anon)') + ' ' + (return_type&.to_rbs || 'untyped')
+      end
+
+      private
+
+      # @param tag1 [String]
+      # @param tag2 [String]
+      # @return [Boolean]
+      def match_tags tag1, tag2
+        # @todo This is an unfortunate hack made necessary by a discrepancy in
+        #   how tags indicate the root namespace. The long-term solution is to
+        #   standardize it, whether it's `Class<>`, an empty string, or
+        #   something else.
+        tag1 == tag2 ||
+          (['', 'Class<>'].include?(tag1) && ['', 'Class<>'].include?(tag2))
+      end
+
+      # @param needle [Pin::Base]
+      # @param haystack [Pin::Base]
+      # @return [Boolean]
+      def match_named_closure needle, haystack
+        return true if needle == haystack || haystack.is_a?(Pin::Block)
+        cursor = haystack
+        until cursor.nil?
+          return true if needle.path == cursor.path
+          return false if cursor.path && !cursor.path.empty?
+          cursor = cursor.closure
+        end
+        false
+      end
+    end
+  end
+end