willbe/tool/

cargo.rs

/// Define a private namespace for all its items.
#[ allow( clippy ::std_instead_of_alloc, clippy ::std_instead_of_core ) ]
mod private
{

  #[ allow( unused_imports, clippy ::wildcard_imports ) ]
  use crate ::tool :: *;

  use std ::ffi ::OsString;
  use std ::path ::PathBuf;
  // use error ::err;
  // use error ::untyped ::format_err;
  use former ::Former;
  use process_tools ::process;
  // use process_tools ::process :: *;
  // qqq: for Bohdan: bad
  // use error ::Result;
  // qqq: group dependencies

  // qqq: for Bohdan: bad: tools can't depend on entitties!
  use crate ::channel ::Channel;
  // Explicit import for Result and its variants for pattern matching
  use std ::result ::Result :: { Ok, Err };

  // aaa: documentation /// aaa: documented

  /// Represents options for packaging a project.
  ///
  /// The `PackOptions` struct encapsulates various options that can be configured when packaging a project,
  /// including the path to the project, the distribution channel, and various flags for controlling the behavior of the packaging process.
  #[ derive( Debug, Former, Clone ) ]
  #[ allow( clippy ::struct_excessive_bools ) ]
  pub struct PackOptions
  {
  /// The path to the project to be packaged.
  ///
  /// This field specifies the file system path where the project is located.
  pub( crate ) path: PathBuf,
  /// The distribution channel for the packaging project.
  ///
  /// This field specifies the channel through which the packaged project will be distributed.
  ///
  pub( crate ) channel: Channel,
  /// Flag indicating whether to allow packaging even if the working directory is dirty.
  ///
  /// This field is set to `true` by default, meaning that packaging will proceed even if there are uncommitted changes.
  #[ former( default = true ) ]
  pub( crate ) allow_dirty: bool,
  // qqq: rename to checking_changes
  /// Flag indicating whether to skip verification checks.
  #[ former( default = false ) ]
  // aaa: don't abuse negative form, rename to checking_consistency
  // renamed and changed logic
  pub( crate ) checking_consistency: bool,
  
  /// An optional temporary path to be used during packaging.
  ///
  /// This field may contain a path to a temporary directory that will be used during the packaging process.
  pub( crate ) temp_path: Option< PathBuf >,
  /// Flag indicating whether to perform a dry run.
  ///
  /// This field specifies whether the packaging process should be a dry run, meaning that no actual changes will be made.
  pub( crate ) dry: bool,
 }

  impl PackOptionsFormer
  {
  pub fn option_temp_path( mut self, value: impl Into< Option< PathBuf > > ) -> Self
  {
   self.storage.temp_path = value.into();
   self
 }
 }

  impl PackOptions
  {
  #[ allow( clippy ::if_not_else ) ]
  fn to_pack_args( &self, toolchain: &str ) -> Vec< String >
  {
   // Building the full path to Cargo.toml
   let manifest_path = self.path.join( "Cargo.toml" );
   let normalized_manifest_path = manifest_path.to_string_lossy().replace( '\\', "/" );
   [ "run".to_string(), toolchain.to_string(), "cargo".into(), "package".into() ]
   .into_iter()
   // clearly show the way to the manifesto
   .chain( Some( "--manifest-path".to_string() ) )
   .chain( Some( normalized_manifest_path ) )
   .chain( if self.allow_dirty { Some( "--allow-dirty".to_string() ) } else { None } )
   .chain( if !self.checking_consistency { Some( "--no-verify".to_string() ) } else { None } )
   .chain( self.temp_path.clone().map( | p | vec![ "--target-dir".to_string(), p.to_string_lossy().into() ] ).into_iter().flatten() )
   .collect()
 }
 }


  ///
  /// Assemble the local package into a distributable tarball.
  ///
  /// # Args :
  /// - `path` - path to the package directory
  /// - `dry` - a flag that indicates whether to execute the command or not
  ///
  // FIX: Added # Errors section for `pack` function
  /// # Errors
  ///
  /// Returns an error if the `rustup ... cargo package` command fails.
  ///
  #[ cfg_attr
  (
  feature = "tracing",
  track_caller,
  tracing ::instrument( fields( caller = ?{ let x = std ::panic ::Location ::caller(); ( x.file(), x.line() ) } ) )
 )]
  // qqq: should be typed error, apply err_with
  // qqq: use typed error
  pub fn pack( args: PackOptions ) -> error ::untyped ::Result< process ::Report >
  {
  // Fix(issue-NNN): Resolve actual rustup toolchain identifier before invoking `rustup run`.
  // Root cause: "rustup run stable" requires the "stable" alias; version-pinned toolchains
  // (e.g. "1.94.1-aarch64-unknown-linux-gnu") do not register that alias.
  // Pitfall: Channel::Stable formats as "stable" but that string only works when the alias exists.
  let toolchain = crate ::channel ::toolchain_name( args.channel, &args.path )?;
  let ( program, options ) = ( "rustup", args.to_pack_args( &toolchain ) );

  if args.dry
  {
   Ok
   (
  process ::Report
  {
   command: format!( "{program} {}", options.join( " " ) ),
   out: String ::new(),
   err: String ::new(),
   current_path: args.path.clone(),
   error: Ok( () ),
 }
 )
 }
  else
  {
   process ::Run ::former()
   .bin_path( program )
   .args( options.into_iter().map( OsString ::from ).collect :: < Vec< _ > >() )
   .current_path( args.path )
   .run().map_err( | report | error ::untyped ::format_err!( report.to_string() ) )
 }
 }


  /// Represents the options for the publish.
  #[ derive( Debug, Former, Clone, Default ) ]
  pub struct PublishOptions
  {
  pub( crate ) path: PathBuf,
  pub( crate ) temp_path: Option< PathBuf >,
  #[ former( default = 0usize ) ]
  pub( crate ) retry_count: usize,
  pub( crate ) dry: bool,
 }

  impl PublishOptionsFormer
  {
  pub fn option_temp_path( mut self, value: impl Into< Option< PathBuf > > ) -> Self
  {
   self.storage.temp_path = value.into();
   self
 }
 }

  impl PublishOptions
  {
  fn as_publish_args( &self ) -> Vec< String >
  {
   let target_dir = self.temp_path.clone().map( | p | vec![ "--target-dir".to_string(), p.to_string_lossy().into() ] );
   [ "publish".to_string() ].into_iter().chain( target_dir.into_iter().flatten() ).collect()
 }
 }

  /// Upload a package to the registry
  // FIX: Added # Errors section for `publish` function
  /// # Errors
  ///
  /// Returns an error if the `cargo publish` command fails after all retry attempts.
  ///
  #[ cfg_attr
  (
  feature = "tracing",
  track_caller,
  tracing ::instrument( fields( caller = ?{ let x = std ::panic ::Location ::caller(); ( x.file(), x.line() ) } ) )
 )]
  pub fn publish( args: &PublishOptions ) -> error ::untyped ::Result< process ::Report >
  // qqq: use typed error
  {
  
  let ( program, arguments) = ( "cargo", args.as_publish_args() );

  if args.dry
  {
   Ok
  (
   process ::Report
   {
  command: format!( "{program} {}", arguments.join( " " ) ),
  out: String ::new(),
  err: String ::new(),
  current_path: args.path.clone(),
  error: Ok( () ),
 }
 )
 }
  else
  {
   let mut results = Vec ::with_capacity( args.retry_count + 1 );
   let run_args: Vec< _ > =  arguments.into_iter().map( OsString ::from ).collect();
   for _ in 0 ..=args.retry_count
   {
  let result = process ::Run ::former()
  .bin_path( program )
  .args( run_args.clone() )
  .current_path( &args.path )
  .run();
  match result
  {
   Ok( report ) => return Ok( report ),
   Err( e ) => results.push( e ),
 }
 }
   if args.retry_count > 0
   {
  Err( error ::untyped ::format_err!
  ( 
   "It took {} attempts, but still failed. Here are the errors: \n{}", 
   args.retry_count + 1, 
   results
   .into_iter()
   .map( | r | format!( "- {r}" ) )
   .collect :: < Vec< _ > >()
   .join( "\n" ) 
 ))
 }
   else
   {
  Err( results.remove( 0 ) ).map_err( | report | error ::untyped ::format_err!( report.to_string() ) )
 }
 }
 }
}

//

crate ::mod_interface!
{
  own use pack;
  own use publish;

  own use PublishOptions;
  own use PackOptions;

}