Minestrone lib Codebase Map #

This document maps the files under lib/, the classes/modules they define, what they are for, and the main internal dependencies between them.

High-Level Shape #

Minestrone is centered on Minestrone::Configuration. The root file loads the configuration DSL, extension/plugin support, and a small String helper. Configuration mixes in modules for variables, task namespaces, callbacks, single-server selection, recipe loading, SSH connection management, command execution, file transfer, and inspection helpers.

Built-in recipes live under lib/minestrone/recipes. The deploy recipe composes two plugin families:

• Minestrone::Deploy::SCM: source control adapters that return shell commands. This tree currently keeps only Git and the no-SCM local-copy adapter.
• Minestrone::Deploy::Strategy: deployment strategies that execute SCM commands locally or remotely.

File Inventory #

Dependency Graph #

This graph shows the main internal runtime clusters rather than every standard-library require.

Saved image: docs/lib-dependency-graph.svg

flowchart TD
  root["lib/minestrone.rb"] --> config["Minestrone::Configuration"]
  root --> extensions["Minestrone.plugin / ExtensionProxy"]
  root --> string_ext["String#compact"]

  cli["Minestrone::CLI"] --> config
  cli --> cli_options["CLI::Options"]
  cli --> cli_help["CLI::Help"]

  config --> variables["Configuration::Variables"]
  config --> namespaces["Configuration::Namespaces"]
  config --> execution["Configuration::Execution"]
  config --> callbacks["Configuration::Callbacks"]
  config --> servers_mod["Configuration::Servers"]
  config --> loading["Configuration::Loading"]
  config --> connections["Configuration::Connections"]
  config --> invocation["Actions::Invocation"]
  config --> transfer_actions["Actions::FileTransfer"]
  config --> inspect_actions["Actions::Inspect"]
  config --> log_formatters["Configuration::LogFormatters"]

  namespaces --> task_definition["TaskDefinition"]
  servers_mod --> server_definition["ServerDefinition"]
  connections --> ssh["SSH"]
  connections --> errors["Errors"]
  invocation --> command["Command"]
  transfer_actions --> transfer["Transfer"]
  command --> processable["Processable"]
  transfer --> processable
  callbacks --> callback_classes["Callback / ProcCallback / TaskCallback"]
  execution --> callbacks
  execution --> namespaces

  deploy_recipe["recipes/deploy.rb"] --> scm_factory["Deploy::SCM factory"]
  deploy_recipe --> strategy_factory["Deploy::Strategy factory"]
  deploy_recipe --> config
  assets_recipe["recipes/deploy/assets.rb"] --> deploy_recipe
  bundler_recipe["recipes/deploy/bundler.rb"] --> deploy_recipe

  scm_factory --> scm_base["SCM::Base"]
  scm_base --> scm_adapters["Git, None"]
  strategy_factory --> strategy_base["Strategy::Base"]
  strategy_base --> dependencies["Deploy::Dependencies"]
  dependencies --> local_dep["LocalDependency"]
  dependencies --> remote_dep["RemoteDependency"]
  strategy_base --> strategies["Copy, RemoteCache"]
  strategies --> scm_adapters
  strategies --> config

Static/Internal Require And Load Dependencies #

These are the code-level edges visible from require and load, excluding Ruby standard-library and gem dependencies unless they are important to the file's role.

Runtime Usage Notes #

• Configuration is the central dependency hub. Most recipe and strategy code calls into it through DSL methods mixed in from its modules.
• Command and Transfer depend on Processable because they share the same single-session Net::SSH event-loop pattern.
• ServerDefinition is the single configured server identity object. It carries host/user/port/options into the SERVER/HOSTS override path, SSH connection setup, command placeholders, transfer logging, and error reporting.
• Callbacks wraps Execution#invoke_task_directly; task lifecycle hooks therefore apply to all direct task execution paths, including CLI actions and recipe-invoked task aliases.
• Deploy::SCM and Deploy::Strategy are factories. They load adapter files by name and instantiate classes from generated constant names.
• SCM adapters generally do not execute commands. They return shell command strings and prompt handlers. Strategies decide whether those commands run locally, remotely, through caches, or through uploaded archives.
• Strategy::Copy is the main bridge from local SCM commands to remote deployment: it uses the SCM's local proxy, local filesystem staging, compression utilities, upload, and remote decompression.
• recipes/deploy/assets.rb and recipes/deploy/bundler.rb are not class extensions. They are recipes that mutate the current configuration by setting defaults, registering callbacks, adding helper methods, and defining deployment tasks.