mangrove 0.31.0 → 0.35.0

data/sorbet/rbi/gems/ruboclean@0.7.1.rbi

@@ -0,0 +1,473 @@
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for types exported from the `ruboclean` gem.
+# Please instead update this file by running `bin/tapioca gem ruboclean`.
+
+
+# Ruboclean entry point
+#
+# source://ruboclean//lib/ruboclean/cli_arguments.rb#3
+module Ruboclean
+  class << self
+    # source://ruboclean//lib/ruboclean.rb#35
+    def post_execution_message(changed, verify); end
+
+    # source://ruboclean//lib/ruboclean.rb#18
+    def run_from_cli!(args); end
+  end
+end
+
+# Reads command line arguments and exposes corresponding reader methods
+#
+# source://ruboclean//lib/ruboclean/cli_arguments.rb#5
+class Ruboclean::CliArguments
+  # @return [CliArguments] a new instance of CliArguments
+  #
+  # source://ruboclean//lib/ruboclean/cli_arguments.rb#15
+  def initialize(command_line_arguments = T.unsafe(nil)); end
+
+  # source://ruboclean//lib/ruboclean/cli_arguments.rb#19
+  def input; end
+
+  # source://ruboclean//lib/ruboclean/cli_arguments.rb#27
+  def output; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/cli_arguments.rb#35
+  def preserve_comments?; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/cli_arguments.rb#39
+  def preserve_paths?; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/cli_arguments.rb#31
+  def silent?; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/cli_arguments.rb#23
+  def stdin?; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/cli_arguments.rb#43
+  def verify?; end
+
+  private
+
+  # Returns the value of attribute command_line_arguments.
+  #
+  # source://ruboclean//lib/ruboclean/cli_arguments.rb#49
+  def command_line_arguments; end
+
+  # source://ruboclean//lib/ruboclean/cli_arguments.rb#63
+  def custom_flag_arguments; end
+
+  # source://ruboclean//lib/ruboclean/cli_arguments.rb#51
+  def find_input; end
+
+  # source://ruboclean//lib/ruboclean/cli_arguments.rb#59
+  def flag_arguments; end
+end
+
+# source://ruboclean//lib/ruboclean/cli_arguments.rb#6
+Ruboclean::CliArguments::FLAG_DEFAULTS = T.let(T.unsafe(nil), Hash)
+
+# Groups the rubocop configuration items into three categories:
+#   - base: base configuration like 'require', 'inherit_from', etc
+#   - namespaces: every item which does **not** include an "/"
+#   - cops: every item which **includes** an "/"
+#
+# source://ruboclean//lib/ruboclean/grouper.rb#8
+class Ruboclean::Grouper
+  # @return [Grouper] a new instance of Grouper
+  #
+  # source://ruboclean//lib/ruboclean/grouper.rb#9
+  def initialize(configuration_hash); end
+
+  # source://ruboclean//lib/ruboclean/grouper.rb#13
+  def group_config; end
+
+  private
+
+  # Returns the value of attribute configuration_hash.
+  #
+  # source://ruboclean//lib/ruboclean/grouper.rb#23
+  def configuration_hash; end
+
+  # source://ruboclean//lib/ruboclean/grouper.rb#25
+  def empty_groups; end
+
+  # source://ruboclean//lib/ruboclean/grouper.rb#29
+  def find_target_group(key); end
+end
+
+# Logger for clean management of log levels
+#
+# source://ruboclean//lib/ruboclean/logger.rb#5
+class Ruboclean::Logger
+  # @raise [ArgumentError]
+  # @return [Logger] a new instance of Logger
+  #
+  # source://ruboclean//lib/ruboclean/logger.rb#6
+  def initialize(log_level = T.unsafe(nil)); end
+
+  # source://ruboclean//lib/ruboclean/logger.rb#12
+  def verbose(message); end
+end
+
+# Orders the items within the groups alphabetically
+#
+# source://ruboclean//lib/ruboclean/orderer.rb#5
+class Ruboclean::Orderer
+  # @return [Orderer] a new instance of Orderer
+  #
+  # source://ruboclean//lib/ruboclean/orderer.rb#6
+  def initialize(configuration_hash); end
+
+  # source://ruboclean//lib/ruboclean/orderer.rb#10
+  def order; end
+
+  private
+
+  # Returns the value of attribute configuration_hash.
+  #
+  # source://ruboclean//lib/ruboclean/orderer.rb#19
+  def configuration_hash; end
+
+  # source://ruboclean//lib/ruboclean/orderer.rb#25
+  def grouped_config; end
+
+  # source://ruboclean//lib/ruboclean/orderer.rb#21
+  def order_by_key(group_items); end
+end
+
+# Cleans up any `Include` or `Exclude` paths that don't exist.
+# The `Include` and `Exclude` paths are relative to the directory
+# where the `.rubocop.yml` file is located. If a path includes a
+# regexp, it's assumed to be valid.
+# If all entries in `Include` or `Exclude` are removed, the entire property is removed.
+# If a Cop gets entirely truncated due to removing all `Includes` and/or `Exclude`, the Cop itself will be removed.
+#
+# source://ruboclean//lib/ruboclean/path_cleanup.rb#10
+class Ruboclean::PathCleanup
+  # @return [PathCleanup] a new instance of PathCleanup
+  #
+  # source://ruboclean//lib/ruboclean/path_cleanup.rb#11
+  def initialize(configuration_hash, options:); end
+
+  # source://ruboclean//lib/ruboclean/path_cleanup.rb#16
+  def cleanup; end
+
+  private
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/path_cleanup.rb#76
+  def any_global_command_pattern?(item); end
+
+  # Returns the value of attribute configuration_hash.
+  #
+  # source://ruboclean//lib/ruboclean/path_cleanup.rb#30
+  def configuration_hash; end
+
+  # Returns the value of attribute options.
+  #
+  # source://ruboclean//lib/ruboclean/path_cleanup.rb#30
+  def options; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/path_cleanup.rb#66
+  def path_exists?(item); end
+
+  # source://ruboclean//lib/ruboclean/path_cleanup.rb#57
+  def process_cop_property(cop_property_key, cop_property_value); end
+
+  # top_level_value could be something like this:
+  #
+  # {
+  #   Include: [...],
+  #   Exclude: [...],
+  #   EnforcedStyle: "..."
+  # }
+  #
+  # We process it further in case of a Hash.
+  #
+  # source://ruboclean//lib/ruboclean/path_cleanup.rb#45
+  def process_top_level_value(top_level_value); end
+
+  # We don't support Regexp, so we just say it exists.
+  #
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/path_cleanup.rb#81
+  def regexp_pattern?(item); end
+
+  # source://ruboclean//lib/ruboclean/path_cleanup.rb#32
+  def root_directory; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/path_cleanup.rb#72
+  def specific_path_exists?(item); end
+end
+
+# Entry point for processing
+#
+# source://ruboclean//lib/ruboclean/runner.rb#8
+class Ruboclean::Runner
+  # @return [Runner] a new instance of Runner
+  #
+  # source://ruboclean//lib/ruboclean/runner.rb#9
+  def initialize(command_line_arguments = T.unsafe(nil)); end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/runner.rb#24
+  def changed?(target_yaml); end
+
+  # source://ruboclean//lib/ruboclean/runner.rb#36
+  def input_path; end
+
+  # source://ruboclean//lib/ruboclean/runner.rb#14
+  def run!; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/runner.rb#28
+  def verbose?; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/runner.rb#32
+  def verify?; end
+
+  private
+
+  # source://ruboclean//lib/ruboclean/runner.rb#56
+  def cleanup_paths(configuration_hash); end
+
+  # source://ruboclean//lib/ruboclean/runner.rb#60
+  def convert_to_yaml(configuration_hash); end
+
+  # Returns the value of attribute options.
+  #
+  # source://ruboclean//lib/ruboclean/runner.rb#42
+  def options; end
+
+  # source://ruboclean//lib/ruboclean/runner.rb#52
+  def order(configuration_hash); end
+
+  # source://ruboclean//lib/ruboclean/runner.rb#48
+  def parse_yaml; end
+
+  # source://ruboclean//lib/ruboclean/runner.rb#44
+  def source_yaml; end
+
+  # source://ruboclean//lib/ruboclean/runner.rb#64
+  def write_stream!(target_yaml); end
+end
+
+# Consolidates cli_arguments with "smart" defaults
+#
+# source://ruboclean//lib/ruboclean/runner/options.rb#6
+class Ruboclean::Runner::Options
+  # @return [Options] a new instance of Options
+  #
+  # source://ruboclean//lib/ruboclean/runner/options.rb#7
+  def initialize(cli_arguments:); end
+
+  # source://ruboclean//lib/ruboclean/runner/options.rb#15
+  def input_path; end
+
+  # source://ruboclean//lib/ruboclean/runner/options.rb#11
+  def input_stream; end
+
+  # source://ruboclean//lib/ruboclean/runner/options.rb#19
+  def output_stream; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/runner/options.rb#31
+  def preserve_comments?; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/runner/options.rb#35
+  def preserve_paths?; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/runner/options.rb#27
+  def silent?; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/runner/options.rb#23
+  def verbose?; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/runner/options.rb#39
+  def verify?; end
+
+  private
+
+  # Returns the value of attribute cli_arguments.
+  #
+  # source://ruboclean//lib/ruboclean/runner/options.rb#45
+  def cli_arguments; end
+
+  # source://ruboclean//lib/ruboclean/runner/options.rb#47
+  def input; end
+
+  # source://ruboclean//lib/ruboclean/runner/options.rb#51
+  def output; end
+end
+
+# Determines the input stream
+#
+# source://ruboclean//lib/ruboclean/runner/options/input.rb#7
+class Ruboclean::Runner::Options::Input
+  # @return [Input] a new instance of Input
+  #
+  # source://ruboclean//lib/ruboclean/runner/options/input.rb#8
+  def initialize(cli_arguments:); end
+
+  # source://ruboclean//lib/ruboclean/runner/options/input.rb#16
+  def input_path; end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/runner/options/input.rb#20
+  def stdin?; end
+
+  # source://ruboclean//lib/ruboclean/runner/options/input.rb#12
+  def stream; end
+
+  private
+
+  # Returns the value of attribute cli_arguments.
+  #
+  # source://ruboclean//lib/ruboclean/runner/options/input.rb#26
+  def cli_arguments; end
+
+  # @raise [ArgumentError]
+  #
+  # source://ruboclean//lib/ruboclean/runner/options/input.rb#28
+  def determine_input_stream; end
+
+  # source://ruboclean//lib/ruboclean/runner/options/input.rb#36
+  def find_input_path; end
+end
+
+# Determines the output stream
+#
+# source://ruboclean//lib/ruboclean/runner/options/output.rb#7
+class Ruboclean::Runner::Options::Output
+  # @return [Output] a new instance of Output
+  #
+  # source://ruboclean//lib/ruboclean/runner/options/output.rb#8
+  def initialize(cli_arguments:, input:); end
+
+  # @return [Boolean]
+  #
+  # source://ruboclean//lib/ruboclean/runner/options/output.rb#17
+  def stdout?; end
+
+  # source://ruboclean//lib/ruboclean/runner/options/output.rb#13
+  def stream; end
+
+  private
+
+  # Returns the value of attribute cli_arguments.
+  #
+  # source://ruboclean//lib/ruboclean/runner/options/output.rb#24
+  def cli_arguments; end
+
+  # source://ruboclean//lib/ruboclean/runner/options/output.rb#26
+  def determine_output_stream; end
+
+  # @raise [ArgumentError]
+  #
+  # source://ruboclean//lib/ruboclean/runner/options/output.rb#36
+  def find_output_path; end
+
+  # Returns the value of attribute input.
+  #
+  # source://ruboclean//lib/ruboclean/runner/options/output.rb#24
+  def input; end
+
+  # source://ruboclean//lib/ruboclean/runner/options/output.rb#32
+  def output_path; end
+end
+
+# Orders the items within the groups alphabetically
+#
+# source://ruboclean//lib/ruboclean/stream_writer.rb#5
+class Ruboclean::StreamWriter
+  # @return [StreamWriter] a new instance of StreamWriter
+  #
+  # source://ruboclean//lib/ruboclean/stream_writer.rb#6
+  def initialize(content, options:); end
+
+  # source://ruboclean//lib/ruboclean/stream_writer.rb#11
+  def write!; end
+
+  private
+
+  # Returns the value of attribute content.
+  #
+  # source://ruboclean//lib/ruboclean/stream_writer.rb#19
+  def content; end
+
+  # Returns the value of attribute options.
+  #
+  # source://ruboclean//lib/ruboclean/stream_writer.rb#19
+  def options; end
+end
+
+# Converts the configuration hash to YAML and applies modifications on it, if requested
+#
+# source://ruboclean//lib/ruboclean/to_yaml_converter.rb#5
+class Ruboclean::ToYamlConverter
+  # @return [ToYamlConverter] a new instance of ToYamlConverter
+  #
+  # source://ruboclean//lib/ruboclean/to_yaml_converter.rb#6
+  def initialize(configuration_hash, source_yaml, options:); end
+
+  # source://ruboclean//lib/ruboclean/to_yaml_converter.rb#12
+  def to_yaml; end
+
+  private
+
+  # Returns the value of attribute configuration_hash.
+  #
+  # source://ruboclean//lib/ruboclean/to_yaml_converter.rb#22
+  def configuration_hash; end
+
+  # Returns the value of attribute options.
+  #
+  # source://ruboclean//lib/ruboclean/to_yaml_converter.rb#22
+  def options; end
+
+  # source://ruboclean//lib/ruboclean/to_yaml_converter.rb#28
+  def preserve_preceding_comments(source, target); end
+
+  # source://ruboclean//lib/ruboclean/to_yaml_converter.rb#24
+  def sanitize_yaml(data); end
+
+  # Returns the value of attribute source_yaml.
+  #
+  # source://ruboclean//lib/ruboclean/to_yaml_converter.rb#22
+  def source_yaml; end
+end
+
+# source://ruboclean//lib/ruboclean/version.rb#4
+Ruboclean::VERSION = T.let(T.unsafe(nil), String)