solargraph 0.44.2 → 0.46.0

data/lib/solargraph/yard_map/core_fills.rb

@@ -1,203 +1,208 @@
-module Solargraph
-  class YardMap
-    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'
-      ].map { |k| Pin::Keyword.new(k) }
-
-      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#concat', 'Array'),
-        Override.method_return('Array#keep_if', 'self'),
-        Override.method_return('Array#delete_if', 'self'),
-        Override.from_comment('Array#map', %(
-@overload map(&block)
-  @return [Array]
-@overload map()
-  @return [Enumerator]
-        )),
-        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#map', 'Array'),
-        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.from_comment('Enumerable#detect', %(
-@overload detect(&block)
-  @return_single_parameter
-@overload detect()
-  @return [Enumerator]
-        )),
-        Override.from_comment('Enumerable#find', %(
-@overload find(&block)
-  @return_single_parameter
-@overload find()
-  @return [Enumerator]
-        )),
-        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.method_return('Hash#merge', 'Hash'),
-
-        Override.from_comment('Integer#+', %(
-@param y [Numeric]
-@return [Numeric]
-        )),
-        Override.from_comment('Integer#times', %(
-@overload times(&block)
-  @return [Integer]
-@overload times()
-  @return [Enumerator]
-        )),
-
-        Override.method_return('Kernel#puts', 'nil'),
-
-        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]
-        )),
-        Override.from_comment('String.new', %(
-@overload new(*)
-  @return [self]
-      ))
-      ].concat(
-        methods_with_yieldparam_subtypes.map do |path|
-          Override.from_comment(path, %(
-@yieldparam_single_parameter
-            ))
-        end
-      )
-
-      PINS = [
-        Pin::Reference::Superclass.new(closure: Pin::Namespace.new(name: 'File'), name: 'IO'),
-        Pin::Reference::Superclass.new(closure: Pin::Namespace.new(name: 'Integer'), name: 'Numeric'),
-        Pin::Reference::Superclass.new(closure: Pin::Namespace.new(name: 'Float'), name: 'Numeric')
-      ].concat(
-        # HACK: Add Errno exception classes
-        begin
-          errno = Solargraph::Pin::Namespace.new(name: 'Errno')
-          result = []
-          Errno.constants.each do |const|
-            result.push Solargraph::Pin::Namespace.new(type: :class, name: const.to_s, closure: errno)
-            result.push Solargraph::Pin::Reference::Superclass.new(closure: result.last, name: 'SystemCallError')
-          end
-          result
-        end
-      )
-
-      ALL = KEYWORDS + PINS + OVERRIDES
-    end
-  end
-end
+module Solargraph
+  class YardMap
+    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'
+      ].map { |k| Pin::Keyword.new(k) }
+
+      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#concat', 'Array'),
+        Override.method_return('Array#keep_if', 'self'),
+        Override.method_return('Array#delete_if', 'self'),
+        Override.from_comment('Array#map', %(
+@overload map(&block)
+  @return [Array]
+@overload map()
+  @return [Enumerator]
+        )),
+        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#map', 'Array'),
+        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.from_comment('Enumerable#detect', %(
+@overload detect(&block)
+  @return_single_parameter
+@overload detect()
+  @return [Enumerator]
+        )),
+        Override.from_comment('Enumerable#find', %(
+@overload find(&block)
+  @return_single_parameter
+@overload find()
+  @return [Enumerator]
+        )),
+        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.method_return('File.open', 'File'),
+
+        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.method_return('Hash#merge', 'Hash'),
+        Override.from_comment('Hash#store', %{
+@overload store(key, value)
+        }),
+
+        Override.from_comment('Integer#+', %(
+@param y [Numeric]
+@return [Numeric]
+        )),
+        Override.from_comment('Integer#times', %(
+@overload times(&block)
+  @return [Integer]
+@overload times()
+  @return [Enumerator]
+        )),
+
+        Override.method_return('Kernel#puts', 'nil'),
+
+        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]
+        )),
+        Override.from_comment('String.new', %(
+@overload new(*)
+  @return [self]
+      ))
+      ].concat(
+        methods_with_yieldparam_subtypes.map do |path|
+          Override.from_comment(path, %(
+@yieldparam_single_parameter
+            ))
+        end
+      )
+
+      PINS = [
+        # HACK: Extending Hash is not accurate to the implementation, but
+        # accurate enough to the behavior
+        Pin::Reference::Extend.new(closure: Pin::Namespace.new(name: 'ENV'), name: 'Hash'),
+        Pin::Reference::Superclass.new(closure: Pin::Namespace.new(name: 'File'), name: 'IO'),
+        Pin::Reference::Superclass.new(closure: Pin::Namespace.new(name: 'Integer'), name: 'Numeric'),
+        Pin::Reference::Superclass.new(closure: Pin::Namespace.new(name: 'Float'), name: 'Numeric')
+      ].concat(
+        # HACK: Add Errno exception classes
+        begin
+          errno = Solargraph::Pin::Namespace.new(name: 'Errno')
+          result = []
+          Errno.constants.each do |const|
+            result.push Solargraph::Pin::Namespace.new(type: :class, name: const.to_s, closure: errno)
+            result.push Solargraph::Pin::Reference::Superclass.new(closure: result.last, name: 'SystemCallError')
+          end
+          result
+        end
+      )
+
+      ALL = KEYWORDS + PINS + OVERRIDES
+    end
+  end
+end

data/lib/solargraph/yard_map/core_gen.rb

@@ -1,76 +1,76 @@
-# frozen_string_literal: true
-
-require 'fileutils'
-require 'tmpdir'
-require 'pathname'
-require 'rubygems/package'
-require 'shellwords'
-
-module Solargraph
-  class YardMap
-    # Tools for generating core documentation.
-    #
-    module CoreGen
-      class << self
-        # Generate documentation from the specified Ruby source directory.
-        #
-        # @param ruby_dir [String] The Ruby source directory
-        # @param dest_dir [String] The destination directory for the yardocs
-        # @return [void]
-        def generate_docs ruby_dir, dest_dir
-          path_name = Pathname.new(Dir.pwd).join(dest_dir).to_s
-          FileUtils.mkdir_p path_name
-          Dir.chdir(ruby_dir) do
-            `yardoc -b "#{File.join(path_name, 'yardoc')}" -n *.c`
-            raise 'An error occurred generating the core yardoc.' unless $?.success?
-            `yardoc -b "#{File.join(path_name, 'yardoc-stdlib')}" -n lib ext`
-            raise 'An error occurred generating the stdlib yardoc.' unless $?.success?
-          end
-        end
-
-        # Generate a gzip of documentation from the specified Ruby source
-        # directory.
-        #
-        # This method is designed to generate the directory architecture that
-        # YardMap core docs expect.
-        #
-        # @param ruby_dir [String] The Ruby source directory
-        # @param ver_name [String, nil] The version name
-        # @param dest_dir [String] The destination directory
-        # @return [void]
-        def generate_gzip ruby_dir, ver_name = nil, dest_dir = Dir.pwd
-          Dir.mktmpdir do |tmp|
-            base_name = ver_name || begin
-              match = ruby_dir.match(/\d+\.\d+\.\d+$/)
-              raise "Unable to determine version name from #{ruby_dir}" if match.nil?
-              match[0]
-            end
-            path_name = Pathname.new(tmp).join(base_name).to_s
-            generate_docs ruby_dir, path_name
-            gzip path_name, Pathname.new(dest_dir).join("#{base_name}.tar.gz").to_s
-          end
-        end
-
-        private
-
-        # @param dir [String] The directory to compress
-        # @param dst [String] The destination file
-        def gzip dir, dst
-          File.open(dst, 'wb') do |file|
-            Zlib::GzipWriter.wrap(file) do |gzip|
-              Gem::Package::TarWriter.new(gzip) do |tar|
-                Dir["#{dir}/**/*"].each do |filename|
-                  next if File.directory?(filename)
-                  relname = File.join(File.basename(dir), filename[dir.length+1..-1])
-                  tar.add_file_simple(relname, 0o644, File.size(filename)) do |io|
-                    io.write File.read_binary(filename)
-                  end
-                end
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'tmpdir'
+require 'pathname'
+require 'rubygems/package'
+require 'shellwords'
+
+module Solargraph
+  class YardMap
+    # Tools for generating core documentation.
+    #
+    module CoreGen
+      class << self
+        # Generate documentation from the specified Ruby source directory.
+        #
+        # @param ruby_dir [String] The Ruby source directory
+        # @param dest_dir [String] The destination directory for the yardocs
+        # @return [void]
+        def generate_docs ruby_dir, dest_dir
+          path_name = Pathname.new(Dir.pwd).join(dest_dir).to_s
+          FileUtils.mkdir_p path_name
+          Dir.chdir(ruby_dir) do
+            `yardoc -b "#{File.join(path_name, 'yardoc')}" -n *.c`
+            raise 'An error occurred generating the core yardoc.' unless $?.success?
+            `yardoc -b "#{File.join(path_name, 'yardoc-stdlib')}" -n lib ext`
+            raise 'An error occurred generating the stdlib yardoc.' unless $?.success?
+          end
+        end
+
+        # Generate a gzip of documentation from the specified Ruby source
+        # directory.
+        #
+        # This method is designed to generate the directory architecture that
+        # YardMap core docs expect.
+        #
+        # @param ruby_dir [String] The Ruby source directory
+        # @param ver_name [String, nil] The version name
+        # @param dest_dir [String] The destination directory
+        # @return [void]
+        def generate_gzip ruby_dir, ver_name = nil, dest_dir = Dir.pwd
+          Dir.mktmpdir do |tmp|
+            base_name = ver_name || begin
+              match = ruby_dir.match(/\d+\.\d+\.\d+$/)
+              raise "Unable to determine version name from #{ruby_dir}" if match.nil?
+              match[0]
+            end
+            path_name = Pathname.new(tmp).join(base_name).to_s
+            generate_docs ruby_dir, path_name
+            gzip path_name, Pathname.new(dest_dir).join("#{base_name}.tar.gz").to_s
+          end
+        end
+
+        private
+
+        # @param dir [String] The directory to compress
+        # @param dst [String] The destination file
+        def gzip dir, dst
+          File.open(dst, 'wb') do |file|
+            Zlib::GzipWriter.wrap(file) do |gzip|
+              Gem::Package::TarWriter.new(gzip) do |tar|
+                Dir["#{dir}/**/*"].each do |filename|
+                  next if File.directory?(filename)
+                  relname = File.join(File.basename(dir), filename[dir.length+1..-1])
+                  tar.add_file_simple(relname, 0o644, File.size(filename)) do |io|
+                    io.write File.read_binary(filename)
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/yard_map/helpers.rb

@@ -1,16 +1,16 @@
-module Solargraph
-  class YardMap
-    module Helpers
-      module_function
-
-      # @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
+module Solargraph
+  class YardMap
+    module Helpers
+      module_function
+
+      # @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

data/lib/solargraph/yard_map/mapper/to_constant.rb

@@ -1,25 +1,25 @@
-# frozen_string_literal: true
-
-module Solargraph
-  class YardMap
-    class Mapper
-      module ToConstant
-        extend YardMap::Helpers
-
-        def self.make code_object, closure = nil, spec = nil
-          closure ||= Solargraph::Pin::Namespace.new(
-            name: code_object.namespace.to_s,
-            gates: [code_object.namespace.to_s]
-          )
-          Pin::Constant.new(
-            location: object_location(code_object, spec),
-            closure: closure,
-            name: code_object.name.to_s,
-            comments: code_object.docstring ? code_object.docstring.all.to_s : '',
-            visibility: code_object.visibility
-          )
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module Solargraph
+  class YardMap
+    class Mapper
+      module ToConstant
+        extend YardMap::Helpers
+
+        def self.make code_object, closure = nil, spec = nil
+          closure ||= Solargraph::Pin::Namespace.new(
+            name: code_object.namespace.to_s,
+            gates: [code_object.namespace.to_s]
+          )
+          Pin::Constant.new(
+            location: object_location(code_object, spec),
+            closure: closure,
+            name: code_object.name.to_s,
+            comments: code_object.docstring ? code_object.docstring.all.to_s : '',
+            visibility: code_object.visibility
+          )
+        end
+      end
+    end
+  end
+end