solargraph 0.39.14 → 0.40.1

data/lib/solargraph/core_fills.rb

@@ -1,160 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  # Overrides for the Ruby core.
-  #
-  # The YardMap uses this module to add type information to core methods.
-  #
-  module CoreFills
-    Override = Pin::Reference::Override
-
-    KEYWORDS = [
-      '__ENCODING__', '__LINE__', '__FILE__', 'BEGIN', 'END', 'alias', 'and',
-      'begin', 'break', 'case', 'class', 'def', 'defined?', 'do', 'else',
-      'elsif', 'end', 'ensure', 'false', 'for', 'if', 'in', 'module', 'next',
-      'nil', 'not', 'or', 'redo', 'rescue', 'retry', 'return', 'self', 'super',
-      'then', 'true', 'undef', 'unless', 'until', 'when', 'while', 'yield'
-    ].freeze
-
-    methods_with_yieldparam_subtypes = %w[
-      Array#each Array#map Array#map! Array#any? Array#all? Array#index
-      Array#keep_if Array#delete_if
-      Enumerable#each_entry Enumerable#map Enumerable#any? Enumerable#all?
-      Enumerable#select Enumerable#reject
-      Set#each
-    ]
-
-    OVERRIDES = [
-      Override.method_return('Array#keep_if', 'self'),
-      Override.method_return('Array#delete_if', 'self'),
-      Override.from_comment('Array#reject', %(
-@overload reject(&block)
-  @return [self]
-@overload reject()
-  @return [Enumerator]
-              )),
-      Override.method_return('Array#reverse', 'self', delete: ['overload']),
-      Override.from_comment('Array#select', %(
-@overload select(&block)
-  @return [self]
-@overload select()
-  @return [Enumerator]
-      )),
-      Override.from_comment('Array#[]', %(
-@overload [](range)
-  @param range [Range]
-  @return [self]
-@overload [](num1, num2)
-  @param num1 [Integer]
-  @param num2 [Integer]
-  @return [self]
-@overload [](num)
-  @param num [Integer]
-  @return_single_parameter
-@return_single_parameter
-      )),
-      Override.from_comment('Array#first', %(
-@overload first(num)
-  @param num [Integer]
-  @return [self]
-@return_single_parameter
-      )),
-      Override.from_comment('Array#last', %(
-@overload last(num)
-  @param num [Integer]
-  @return [self]
-@return_single_parameter
-      )),
-      Override.method_return('Array#uniq', 'self'),
-      Override.method_return('Array#zip', 'Array, nil'),
-
-      Override.from_comment('BasicObject#==', %(
-@param other [BasicObject]
-@return [Boolean]
-      )),
-      Override.method_return('BasicObject#initialize', 'void'),
-
-      Override.method_return('Class#new', 'self'),
-      Override.method_return('Class.new', 'Class<Object>'),
-      Override.method_return('Class#allocate', 'self'),
-      Override.method_return('Class.allocate', 'Class<Object>'),
-
-      Override.method_return('Enumerable#select', 'self'),
-
-      Override.method_return('File.absolute_path', 'String'),
-      Override.method_return('File.basename', 'String'),
-      Override.method_return('File.dirname', 'String'),
-      Override.method_return('File.extname', 'String'),
-      Override.method_return('File.join', 'String'),
-
-      Override.from_comment('Float#+', %(
-@param y [Numeric]
-@return [Numeric]
-      )),
-
-      Override.from_comment('Hash#[]', %(
-@return_value_parameter
-      )),
-
-      # @todo This override isn't robust enough. It needs to allow for
-      #   parameterized Hash types, e.g., [Hash{Symbol => String}].
-      Override.from_comment('Hash#[]=', %(
-@param_tuple
-      )),
-
-      Override.from_comment('Integer#+', %(
-@param y [Numeric]
-@return [Numeric]
-      )),
-
-      Override.method_return('Kernel#puts', 'nil'),
-
-      # Override.method_return('Module#attr_reader', 'void'),
-      # Override.method_return('Module#attr_writer', 'void'),
-      # Override.method_return('Module#attr_accessor', 'void'),
-
-      Override.from_comment('Numeric#+', %(
-@param y [Numeric]
-@return [Numeric]
-      )),
-
-      Override.method_return('Object#!', 'Boolean'),
-      Override.method_return('Object#clone', 'self', delete: [:overload]),
-      Override.method_return('Object#dup', 'self', delete: [:overload]),
-      Override.method_return('Object#freeze', 'self', delete: [:overload]),
-      Override.method_return('Object#inspect', 'String'),
-      Override.method_return('Object#taint', 'self'),
-      Override.method_return('Object#to_s', 'String'),
-      Override.method_return('Object#untaint', 'self'),
-      Override.from_comment('Object#tap', %(
-@return [self]
-@yieldparam [self]
-      )),
-
-      Override.from_comment('STDERR', %(
-@type [IO]
-      )),
-
-      Override.from_comment('STDIN', %(
-@type [IO]
-      )),
-
-      Override.from_comment('STDOUT', %(
-@type [IO]
-      )),
-
-      Override.method_return('String#freeze', 'self'),
-      Override.method_return('String#split', 'Array<String>'),
-      Override.method_return('String#lines', 'Array<String>'),
-      Override.from_comment('String#each_line', %(
-@yieldparam [String]
-      ))
-    ].concat(
-      methods_with_yieldparam_subtypes.map do |path|
-        Override.from_comment(path, %(
-@yieldparam_single_parameter
-          ))
-      end
-    )
-  end
-end

data/lib/solargraph/pin/attribute.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    class Attribute < BaseMethod
-      # @return [::Symbol] :reader or :writer
-      attr_reader :access
-
-      # @param access [::Symbol] :reader or :writer
-      def initialize access: :reader, **splat
-        super(**splat)
-        @access = access
-        if access == :writer
-          parameters.push(
-            Pin::Parameter.new(name: 'value', decl: :arg, closure: self)
-          )
-          if return_type.defined?
-            docstring.add_tag YARD::Tags::Tag.new(:param, '', return_type.to_s.split(', '), 'value')
-          end
-        end
-      end
-
-      def completion_item_kind
-        Solargraph::LanguageServer::CompletionItemKinds::PROPERTY
-      end
-
-      def symbol_kind
-        Solargraph::LanguageServer::SymbolKinds::PROPERTY
-      end
-
-      def path
-        @path ||= namespace + (scope == :instance ? '#' : '.') + name
-      end
-
-      def probe api_map
-        types = []
-        varname = "@#{name.gsub(/=$/, '')}"
-        pins = api_map.get_instance_variable_pins(binder.namespace, binder.scope).select { |iv| iv.name == varname }
-        pins.each do |pin|
-          type = pin.typify(api_map)
-          type = pin.probe(api_map) if type.undefined?
-          types.push type if type.defined?
-        end
-        return ComplexType::UNDEFINED if types.empty?
-        ComplexType.try_parse(*types.map(&:tag).uniq)
-      end
-    end
-  end
-end

data/lib/solargraph/pin/base_method.rb

@@ -1,141 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    # The base class for method and attribute pins.
-    #
-    class BaseMethod < Closure
-      # @return [::Symbol] :public, :private, or :protected
-      attr_reader :visibility
-
-      # @return [Parser::AST::Node]
-      attr_reader :node
-
-      # @param visibility [::Symbol] :public, :protected, or :private
-      # @param explicit [Boolean]
-      def initialize visibility: :public, explicit: true, **splat
-        super(**splat)
-        @visibility = visibility
-        @explicit = explicit
-      end
-
-      def return_type
-        @return_type ||= generate_complex_type
-      end
-
-      def path
-        @path ||= "#{namespace}#{(scope == :instance ? '#' : '.')}#{name}"
-      end
-
-      def typify api_map
-        decl = super
-        return decl unless decl.undefined?
-        type = see_reference(api_map) || typify_from_super(api_map)
-        return type.qualify(api_map, namespace) unless type.nil?
-        name.end_with?('?') ? ComplexType::BOOLEAN : ComplexType::UNDEFINED
-      end
-
-      # @return [Array<Pin::Parameter>]
-      def parameters
-        @parameters ||= []
-      end
-
-      # @return [Array<String>]
-      def parameter_names
-        parameters.map(&:name)
-      end
-
-      def documentation
-        if @documentation.nil?
-          @documentation ||= super || ''
-          param_tags = docstring.tags(:param)
-          unless param_tags.nil? or param_tags.empty?
-            @documentation += "\n\n" unless @documentation.empty?
-            @documentation += "Params:\n"
-            lines = []
-            param_tags.each do |p|
-              l = "* #{p.name}"
-              l += " [#{escape_brackets(p.types.join(', '))}]" unless p.types.nil? or p.types.empty?
-              l += " #{p.text}"
-              lines.push l
-            end
-            @documentation += lines.join("\n")
-          end
-          return_tags = docstring.tags(:return)
-          unless return_tags.empty?
-            @documentation += "\n\n" unless @documentation.empty?
-            @documentation += "Returns:\n"
-            lines = []
-            return_tags.each do |r|
-              l = "*"
-              l += " [#{escape_brackets(r.types.join(', '))}]" unless r.types.nil? or r.types.empty?
-              l += " #{r.text}"
-              lines.push l
-            end
-            @documentation += lines.join("\n")
-          end
-          @documentation += "\n\n" unless @documentation.empty?
-          @documentation += "Visibility: #{visibility}"
-        end
-        @documentation.to_s
-      end
-
-      def explicit?
-        @explicit
-      end
-
-      private
-
-      # @return [ComplexType]
-      def generate_complex_type
-        tags = docstring.tags(:return).map(&:types).flatten.reject(&:nil?)
-        return ComplexType::UNDEFINED if tags.empty?
-        ComplexType.try_parse *tags
-      end
-
-      # @param api_map [ApiMap]
-      # @return [ComplexType, nil]
-      def see_reference api_map
-        docstring.ref_tags.each do |ref|
-          next unless ref.tag_name == 'return' && ref.owner
-          result = resolve_reference(ref.owner.to_s, api_map)
-          return result unless result.nil?
-        end
-        match = comments.match(/^[ \t]*\(see (.*)\)/m)
-        return nil if match.nil?
-        resolve_reference match[1], api_map
-      end
-
-      # @param api_map [ApiMap]
-      # @return [ComplexType, nil]
-      def typify_from_super api_map
-        stack = api_map.get_method_stack(namespace, name, scope: scope).reject { |pin| pin.path == path }
-        return nil if stack.empty?
-        stack.each do |pin|
-          return pin.return_type unless pin.return_type.undefined?
-        end
-        nil
-      end
-
-      # @param ref [String]
-      # @param api_map [ApiMap]
-      # @return [ComplexType]
-      def resolve_reference ref, api_map
-        parts = ref.split(/[\.#]/)
-        if parts.first.empty? || parts.one?
-          path = "#{namespace}#{ref}"
-        else
-          fqns = api_map.qualify(parts.first, namespace)
-          return ComplexType::UNDEFINED if fqns.nil?
-          path = fqns + ref[parts.first.length] + parts.last
-        end
-        pins = api_map.get_path_pins(path)
-        pins.each do |pin|
-          type = pin.typify(api_map)
-          return type unless type.undefined?
-        end
-        nil
-      end
-    end
-  end
-end

data/lib/solargraph/pin/yard_pin.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    module YardPin
-      autoload :YardMixin, 'solargraph/pin/yard_pin/yard_mixin'
-      autoload :Constant,  'solargraph/pin/yard_pin/constant'
-      autoload :Method,    'solargraph/pin/yard_pin/method'
-      autoload :Namespace, 'solargraph/pin/yard_pin/namespace'
-    end
-  end
-end

data/lib/solargraph/pin/yard_pin/method.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    module YardPin
-      class Method < Pin::Method
-        include YardMixin
-
-        # @param code_object [YARD::CodeObjects::Base]
-        # @param name [String, nil]
-        # @param scope [Symbol, nil]
-        # @param visibility [Symbol, nil]
-        # @param closure [Solargraph::Pin::Closure, nil]
-        # @param spec [Gem::Specification]
-        def initialize code_object, name = nil, scope = nil, visibility = nil, closure = nil, spec = nil
-          closure ||= Solargraph::Pin::Namespace.new(
-            name: code_object.namespace.to_s,
-            gates: [code_object.namespace.to_s]
-          )
-          super(
-            location: object_location(code_object, spec),
-            closure: closure,
-            name: name || code_object.name.to_s,
-            comments: code_object.docstring ? code_object.docstring.all.to_s : '',
-            scope: scope || code_object.scope,
-            visibility: visibility || code_object.visibility,
-            parameters: get_parameters(code_object),
-            explicit: code_object.is_explicit?
-          )
-        end
-
-        private
-
-        # @param code_object [YARD::CodeObjects::Base]
-        # @return [Array<Solargraph::Pin::Parameter>]
-        def get_parameters code_object
-          return [] unless code_object.is_a?(YARD::CodeObjects::MethodObject)
-          # HACK: Skip `nil` and `self` parameters that are sometimes emitted
-          # for methods defined in C
-          # See https://github.com/castwide/solargraph/issues/345
-          code_object.parameters.select { |a| a[0] && a[0] != 'self' }.map do |a|
-            Solargraph::Pin::Parameter.new(
-              location: location,
-              closure: self,
-              comments: comments,
-              name: arg_name(a),
-              presence: nil,
-              decl: arg_type(a),
-              asgn_code: a[1]
-            )
-          end
-        end
-
-        # @param a [Array]
-        # @return [String]
-        def arg_name a
-          a[0].match(/[A-Za-z0-9_]*/)[0]
-        end
-
-        # @param a [Array]
-        # @return [Symbol]
-        def arg_type a
-          if a[0].start_with?('**')
-            :kwrestarg
-          elsif a[0].start_with?('*')
-            :restarg
-          elsif a[0].start_with?('&')
-            :blockarg
-          elsif a[1]
-            :optarg
-          elsif a[0].end_with?(':')
-            a[1] ? :kwarg : :kwoptarg
-          else
-            :arg
-          end
-        end
-      end
-    end
-  end
-end

data/lib/solargraph/pin/yard_pin/yard_mixin.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Solargraph
-  module Pin
-    module YardPin
-      module YardMixin
-        private
-
-        # @param code_object [YARD::CodeObjects::Base]
-        # @param spec [Gem::Specification]
-        # @return [Solargraph::Location, nil]
-        def object_location code_object, spec
-          return nil if spec.nil? || code_object.nil? || code_object.file.nil? || code_object.line.nil?
-          file = File.join(spec.full_gem_path, code_object.file)
-          Solargraph::Location.new(file, Solargraph::Range.from_to(code_object.line - 1, 0, code_object.line - 1, 0))
-        end
-      end
-    end
-  end
-end