solargraph 0.57.0 → 0.58.1

data/rbs/fills/open3/0/open3.rbs

@@ -0,0 +1,172 @@
+# <!-- rdoc-file=lib/open3.rb -->
+# Module Open3 supports creating child processes with access to their $stdin,
+# $stdout, and $stderr streams.
+#
+# ## What's Here
+#
+# Each of these methods executes a given command in a new process or subshell,
+# or multiple commands in new processes and/or subshells:
+#
+# *   Each of these methods executes a single command in a process or subshell,
+#     accepts a string for input to $stdin, and returns string output from
+#     $stdout, $stderr, or both:
+#
+#     *   Open3.capture2: Executes the command; returns the string from $stdout.
+#     *   Open3.capture2e: Executes the command; returns the string from merged
+#         $stdout and $stderr.
+#     *   Open3.capture3: Executes the command; returns strings from $stdout and
+#         $stderr.
+#
+# *   Each of these methods executes a single command in a process or subshell,
+#     and returns pipes for $stdin, $stdout, and/or $stderr:
+#
+#     *   Open3.popen2: Executes the command; returns pipes for $stdin and
+#         $stdout.
+#     *   Open3.popen2e: Executes the command; returns pipes for $stdin and
+#         merged $stdout and $stderr.
+#     *   Open3.popen3: Executes the command; returns pipes for $stdin, $stdout,
+#         and $stderr.
+#
+# *   Each of these methods executes one or more commands in processes and/or
+#     subshells, returns pipes for the first $stdin, the last $stdout, or both:
+#
+#     *   Open3.pipeline_r: Returns a pipe for the last $stdout.
+#     *   Open3.pipeline_rw: Returns pipes for the first $stdin and the last
+#         $stdout.
+#     *   Open3.pipeline_w: Returns a pipe for the first $stdin.
+#     *   Open3.pipeline_start: Does not wait for processes to complete.
+#     *   Open3.pipeline: Waits for processes to complete.
+#
+# Each of the methods above accepts:
+#
+# *   An optional hash of environment variable names and values; see [Execution
+#     Environment](rdoc-ref:Process@Execution+Environment).
+# *   A required string argument that is a `command_line` or `exe_path`; see
+#     [Argument command_line or
+#     exe_path](rdoc-ref:Process@Argument+command_line+or+exe_path).
+# *   An optional hash of execution options; see [Execution
+#     Options](rdoc-ref:Process@Execution+Options).
+#
+module Open3
+  # <!--
+  #   rdoc-file=lib/open3.rb
+  #   - Open3.capture2e([env, ] command_line, options = {}) -> [stdout_and_stderr_s, status]
+  #   - Open3.capture2e([env, ] exe_path, *args, options = {}) -> [stdout_and_stderr_s, status]
+  # -->
+  # Basically a wrapper for Open3.popen3 that:
+  #
+  # *   Creates a child process, by calling Open3.popen3 with the given arguments
+  #     (except for certain entries in hash `options`; see below).
+  # *   Returns as string `stdout_and_stderr_s` the merged standard output and
+  #     standard error of the child process.
+  # *   Returns as `status` a `Process::Status` object that represents the exit
+  #     status of the child process.
+  #
+  # Returns the array `[stdout_and_stderr_s, status]`:
+  #
+  #     stdout_and_stderr_s, status = Open3.capture2e('echo "Foo"')
+  #     # => ["Foo\n", #<Process::Status: pid 2371692 exit 0>]
+  #
+  # Like Process.spawn, this method has potential security vulnerabilities if
+  # called with untrusted input; see [Command
+  # Injection](rdoc-ref:command_injection.rdoc@Command+Injection).
+  #
+  # Unlike Process.spawn, this method waits for the child process to exit before
+  # returning, so the caller need not do so.
+  #
+  # If the first argument is a hash, it becomes leading argument `env` in the call
+  # to Open3.popen3; see [Execution
+  # Environment](rdoc-ref:Process@Execution+Environment).
+  #
+  # If the last argument is a hash, it becomes trailing argument `options` in the
+  # call to Open3.popen3; see [Execution
+  # Options](rdoc-ref:Process@Execution+Options).
+  #
+  # The hash `options` is given; two options have local effect in method
+  # Open3.capture2e:
+  #
+  # *   If entry `options[:stdin_data]` exists, the entry is removed and its
+  #     string value is sent to the command's standard input:
+  #
+  #         Open3.capture2e('tee', stdin_data: 'Foo')
+  #         # => ["Foo", #<Process::Status: pid 2371732 exit 0>]
+  #
+  # *   If entry `options[:binmode]` exists, the entry is removed and the internal
+  #     streams are set to binary mode.
+  #
+  # The single required argument is one of the following:
+  #
+  # *   `command_line` if it is a string, and if it begins with a shell reserved
+  #     word or special built-in, or if it contains one or more metacharacters.
+  # *   `exe_path` otherwise.
+  #
+  # **Argument `command_line`**
+  #
+  # String argument `command_line` is a command line to be passed to a shell; it
+  # must begin with a shell reserved word, begin with a special built-in, or
+  # contain meta characters:
+  #
+  #     Open3.capture2e('if true; then echo "Foo"; fi') # Shell reserved word.
+  #     # => ["Foo\n", #<Process::Status: pid 2371740 exit 0>]
+  #     Open3.capture2e('echo')                         # Built-in.
+  #     # => ["\n", #<Process::Status: pid 2371774 exit 0>]
+  #     Open3.capture2e('date > date.tmp')              # Contains meta character.
+  #     # => ["", #<Process::Status: pid 2371812 exit 0>]
+  #
+  # The command line may also contain arguments and options for the command:
+  #
+  #     Open3.capture2e('echo "Foo"')
+  #     # => ["Foo\n", #<Process::Status: pid 2326183 exit 0>]
+  #
+  # **Argument `exe_path`**
+  #
+  # Argument `exe_path` is one of the following:
+  #
+  # *   The string path to an executable to be called.
+  # *   A 2-element array containing the path to an executable and the string to
+  #     be used as the name of the executing process.
+  #
+  # Example:
+  #
+  #     Open3.capture2e('/usr/bin/date')
+  #     # => ["Sat Sep 30 09:01:46 AM CDT 2023\n", #<Process::Status: pid 2371820 exit 0>]
+  #
+  # Ruby invokes the executable directly, with no shell and no shell expansion:
+  #
+  #     Open3.capture2e('doesnt_exist') # Raises Errno::ENOENT
+  #
+  # If one or more `args` is given, each is an argument or option to be passed to
+  # the executable:
+  #
+  #     Open3.capture2e('echo', 'C #')
+  #     # => ["C #\n", #<Process::Status: pid 2371856 exit 0>]
+  #     Open3.capture2e('echo', 'hello', 'world')
+  #     # => ["hello world\n", #<Process::Status: pid 2371894 exit 0>]
+  #
+  def self.capture2e: (*String, ?stdin_data: String, ?chdir: String, ?binmode: boolish) -> [String, Process::Status]
+                   |  (Hash[String, String] env, *String cmds, ?chdir: String, ?stdin_data: String, ?binmode: boolish) -> [String, Process::Status]
+
+  def self.capture2: (?Hash[String, String] env, *String cmds, ?chdir: String) -> [String, Process::Status]
+
+  def self.capture3: (?Hash[String, String] env, *String cmds, ?chdir: String) -> [String, String, Process::Status]
+
+  def self.pipeline: (?Hash[String, String] env, *String cmds, ?chdir: String) -> Array[Process::Status]
+
+  def self.pipeline_r: (?Hash[String, String] env, *String cmds, ?chdir: String) -> [IO, Process::Waiter]
+
+  def self.pipeline_rw: (?Hash[String, String] env, *String cmds, ?chdir: String) -> [IO, IO, Process::Waiter]
+
+  def self.pipeline_start: (?Hash[String, String] env, *String cmds, ?chdir: String) -> Array[Process::Waiter]
+
+  def self.pipeline_w: (?Hash[String, String] env, *String cmds, ?chdir: String) -> [IO, Process::Waiter]
+
+  def self.popen2: (?Hash[String, String] env, *String exe_path_or_cmd_with_args, ?chdir: String) -> [IO, IO, Process::Waiter]
+                 | [U] (?Hash[String, String] env, *String exe_path_or_cmd_with_args, ?chdir: String) { (IO stdin, IO stdout, Process::Waiter wait_thread) -> U } -> U
+
+  def self.popen2e: (?Hash[String, String] env, *String exe_path_or_cmd_with_args, ?chdir: String) -> [IO, IO, Process::Waiter]
+                  | [U] (?Hash[String, String] env, *String exe_path_or_cmd_with_args, ?chdir: String) { (IO stdin, IO stdout_and_stderr, Process::Waiter wait_thread) -> U } -> U
+
+  def self.popen3: (?Hash[String, String] env, *String exe_path_or_cmd_with_args, ?chdir: String) -> [IO, IO, IO, Process::Waiter]
+                 | [U] (?Hash[String, String] env, *String exe_path_or_cmd_with_args, ?chdir: String) { (IO stdin, IO stdout, IO stderr, Process::Waiter wait_thread) -> U } -> U
+
+end

data/rbs/fills/rubygems/0/basic_specification.rbs

@@ -0,0 +1,326 @@
+# <!-- rdoc-file=lib/rubygems/basic_specification.rb -->
+# BasicSpecification is an abstract class which implements some common code used
+# by both Specification and StubSpecification.
+#
+class Gem::BasicSpecification
+  @ignored: untyped
+
+  @extension_dir: untyped
+
+  @full_gem_path: untyped
+
+  @full_require_paths: untyped
+
+  @paths_map: untyped
+
+  @gem_dir: untyped
+
+  attr_writer base_dir: untyped
+
+  attr_writer extension_dir: untyped
+
+  attr_writer ignored: untyped
+
+  # <!-- rdoc-file=lib/rubygems/basic_specification.rb -->
+  # The path this gemspec was loaded from.  This attribute is not persisted.
+  #
+  attr_accessor loaded_from: untyped
+
+  attr_writer full_gem_path: untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - new()
+  # -->
+  #
+  def initialize: () -> void
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - default_specifications_dir()
+  # -->
+  #
+  def self.default_specifications_dir: () -> untyped
+
+  extend Gem::Deprecate
+
+  def gem_build_complete_path: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - activated?()
+  # -->
+  # True when the gem has been activated
+  #
+  def activated?: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - base_dir()
+  # -->
+  # Returns the full path to the base gem directory.
+  #
+  # eg: /usr/local/lib/ruby/gems/1.8
+  #
+  def base_dir: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - contains_requirable_file?(file)
+  # -->
+  # Return true if this spec can require `file`.
+  #
+  def contains_requirable_file?: (untyped file) -> (false | untyped)
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - ignored?()
+  # -->
+  # Return true if this spec should be ignored because it's missing extensions.
+  #
+  def ignored?: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - default_gem?()
+  # -->
+  #
+  def default_gem?: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - default_gem_priority()
+  # -->
+  # Regular gems take precedence over default gems
+  #
+  def default_gem_priority: () -> (1 | -1)
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - base_dir_priority(gem_path)
+  # -->
+  # Gems higher up in `gem_path` take precedence
+  #
+  def base_dir_priority: (untyped gem_path) -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - extension_dir()
+  # -->
+  # Returns full path to the directory where gem's extensions are installed.
+  #
+  def extension_dir: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - extensions_dir()
+  # -->
+  # Returns path to the extensions directory.
+  #
+  def extensions_dir: () -> untyped
+
+  private
+
+  def find_full_gem_path: () -> untyped
+
+  public
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - full_gem_path()
+  # -->
+  # The full path to the gem (install path + full name).
+  #
+  # TODO: This is duplicated with #gem_dir. Eventually either of them should be
+  # deprecated.
+  #
+  def full_gem_path: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - full_name()
+  # -->
+  # Returns the full name (name-version) of this Gem.  Platform information is
+  # included (name-version-platform) if it is specified and not the default Ruby
+  # platform.
+  #
+  def full_name: () -> ::String
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - full_name_with_location()
+  # -->
+  # Returns the full name of this Gem (see `Gem::BasicSpecification#full_name`).
+  # Information about where the gem is installed is also included if not installed
+  # in the default GEM_HOME.
+  #
+  def full_name_with_location: () -> (::String | untyped)
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - full_require_paths()
+  # -->
+  # Full paths in the gem to add to `$LOAD_PATH` when this gem is activated.
+  #
+  def full_require_paths: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - datadir()
+  # -->
+  # The path to the data directory for this gem.
+  #
+  def datadir: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - to_fullpath(path)
+  # -->
+  # Full path of the target library file. If the file is not in this gem, return
+  # nil.
+  #
+  def to_fullpath: (untyped path) -> (untyped | nil)
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - gem_dir()
+  # -->
+  # Returns the full path to this spec's gem directory. eg:
+  # /usr/local/lib/ruby/1.8/gems/mygem-1.0
+  #
+  # TODO: This is duplicated with #full_gem_path. Eventually either of them should
+  # be deprecated.
+  #
+  def gem_dir: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - gems_dir()
+  # -->
+  # Returns the full path to the gems directory containing this spec's gem
+  # directory. eg: /usr/local/lib/ruby/1.8/gems
+  #
+  def gems_dir: () -> untyped
+
+  def internal_init: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - name()
+  # -->
+  # Name of the gem
+  #
+  def name: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - platform()
+  # -->
+  # Platform of the gem
+  #
+  def platform: () -> untyped
+
+  def raw_require_paths: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - require_paths()
+  # -->
+  # Paths in the gem to add to `$LOAD_PATH` when this gem is activated.
+  #
+  # See also #require_paths=
+  #
+  # If you have an extension you do not need to add `"ext"` to the require path,
+  # the extension build process will copy the extension files into "lib" for you.
+  #
+  # The default value is `"lib"`
+  #
+  # Usage:
+  #
+  #     # If all library files are in the root directory...
+  #     spec.require_path = '.'
+  #
+  def require_paths: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - source_paths()
+  # -->
+  # Returns the paths to the source files for use with analysis and documentation
+  # tools.  These paths are relative to full_gem_path.
+  #
+  def source_paths: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - matches_for_glob(glob)
+  # -->
+  # Return all files in this gem that match for `glob`.
+  #
+  def matches_for_glob: (untyped glob) -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - plugins()
+  # -->
+  # Returns the list of plugins in this spec.
+  #
+  def plugins: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - lib_dirs_glob()
+  # -->
+  # Returns a string usable in Dir.glob to match all requirable paths for this
+  # spec.
+  #
+  def lib_dirs_glob: () -> ::String
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - to_spec()
+  # -->
+  # Return a Gem::Specification from this gem
+  #
+  def to_spec: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - version()
+  # -->
+  # Version of the gem
+  #
+  def version: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - stubbed?()
+  # -->
+  # Whether this specification is stubbed - i.e. we have information about the gem
+  # from a stub line, without having to evaluate the entire gemspec file.
+  #
+  def stubbed?: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - this()
+  # -->
+  #
+  def this: () -> self
+
+  private
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - have_extensions?()
+  # -->
+  #
+  def have_extensions?: () -> untyped
+
+  # <!--
+  #   rdoc-file=lib/rubygems/basic_specification.rb
+  #   - have_file?(file, suffixes)
+  # -->
+  #
+  def have_file?: (untyped file, untyped suffixes) -> (true | untyped)
+end