Refactor version module (#3861)

commit-id:f673da00

Author: ksew1

crates/docs/src/snippet.rs

@@ -1,7 +1,7 @@
 use std::sync::LazyLock;
 
 use regex::Regex;
-use scarb_api::ScarbCommand;
+use scarb_api::version::scarb_version;
 use semver::VersionReq;
 use serde::{Deserialize, Serialize};
 
@@ -101,10 +101,7 @@ impl Default for SnippetConfig {
 impl SnippetConfig {
     fn check_scarb_compatibility(&mut self) {
         if let Some(ref scarb_version_req) = self.scarb_version {
-            let current_scarb_version = ScarbCommand::version()
-                .run()
-                .expect("Failed to get scarb version")
-                .scarb;
+            let current_scarb_version = scarb_version().expect("Failed to get scarb version").scarb;
 
             if !scarb_version_req.matches(&current_scarb_version) {
                 self.ignored = true;

crates/forge/src/new.rs

@@ -4,6 +4,7 @@ use anyhow::{Context, Ok, Result, anyhow, bail, ensure};
 use camino::Utf8PathBuf;
 use include_dir::{Dir, DirEntry, include_dir};
 use indoc::formatdoc;
+use scarb_api::version::scarb_version;
 use scarb_api::{ScarbCommand, ensure_scarb_available};
 use semver::Version;
 use std::env;
@@ -107,7 +108,7 @@ impl TryFrom<&Template> for TemplateManifestConfig {
     type Error = anyhow::Error;
 
     fn try_from(template: &Template) -> Result<Self> {
-        let cairo_version = ScarbCommand::version().run()?.cairo;
+        let cairo_version = scarb_version()?.cairo;
         match template {
             Template::CairoProgram => Ok(TemplateManifestConfig {
                 dependencies: vec![],
@@ -254,7 +255,7 @@ fn set_cairo_edition(document: &mut DocumentMut, cairo_edition: &str) {
 }
 
 fn add_assert_macros(document: &mut DocumentMut) -> Result<()> {
-    let versions = ScarbCommand::version().run()?;
+    let versions = scarb_version()?;
     let version = if versions.scarb < MINIMAL_SCARB_FOR_CORRESPONDING_ASSERT_MACROS {
         DEFAULT_ASSERT_MACROS
     } else {
@@ -359,7 +360,7 @@ pub fn new(
         );
     }
     let name = infer_name(name, &path)?;
-    let scarb_version = ScarbCommand::version().run()?.scarb;
+    let scarb_version = scarb_version()?.scarb;
 
     fs::create_dir_all(&path)?;
     let project_path = path.canonicalize()?;
@@ -453,7 +454,7 @@ fn get_template_dir(template: &Template) -> Result<Dir<'_>> {
 }
 
 fn get_oz_version() -> Result<Version> {
-    let scarb_version = ScarbCommand::version().run()?.scarb;
+    let scarb_version = scarb_version()?.scarb;
 
     let oz_version = match scarb_version {
         ver if ver >= Version::new(2, 9, 4) => Version::new(1, 0, 0),

crates/forge/src/run_tests/workspace.rs

@@ -19,8 +19,8 @@ use forge_runner::test_case_summary::AnyTestCaseSummary;
 use forge_runner::{CACHE_DIR, test_target_summary::TestTargetSummary};
 use foundry_ui::UI;
 use scarb_api::metadata::{MetadataOpts, metadata_with_opts};
+use scarb_api::version::scarb_version;
 use scarb_api::{
-    ScarbCommand,
     metadata::{Metadata, PackageMetadata},
     target_dir_for_workspace,
 };
@@ -46,7 +46,7 @@ pub async fn run_for_workspace(args: TestArgs, ui: Arc<UI>) -> Result<ExitStatus
 
     check_profile_compatibility(&args, &scarb_metadata)?;
 
-    let scarb_version = ScarbCommand::version().run()?.scarb;
+    let scarb_version = scarb_version()?.scarb;
     if scarb_version >= MINIMAL_SCARB_VERSION_FOR_V2_MACROS_REQUIREMENT {
         error_if_snforge_std_not_compatible(&scarb_metadata)?;
         warn_if_snforge_std_does_not_match_package_version(&scarb_metadata, &ui)?;

crates/forge/src/warn.rs

@@ -5,7 +5,8 @@ use forge_runner::package_tests::with_config_resolved::TestTargetWithResolvedCon
 use foundry_ui::UI;
 use foundry_ui::components::warning::WarningMessage;
 use indoc::formatdoc;
-use scarb_api::{ScarbCommand, package_matches_version_requirement};
+use scarb_api::package_matches_version_requirement;
+use scarb_api::version::scarb_version;
 use scarb_metadata::Metadata;
 use semver::{Comparator, Op, Version, VersionReq};
 use shared::rpc::create_rpc_client;
@@ -25,7 +26,7 @@ pub(crate) fn warn_if_available_gas_used_with_incompatible_scarb_version(
                 .config
                 .available_gas
                 .as_ref().is_some_and(cheatnet::runtime_extensions::forge_config_extension::config::RawAvailableResourceBoundsConfig::is_zero)
-                && ScarbCommand::version().run()?.scarb <= Version::new(2, 4, 3)
+                && scarb_version()?.scarb <= Version::new(2, 4, 3)
             {
                 ui.println(&WarningMessage::new("`available_gas` attribute was probably specified when using Scarb ~2.4.3 \
                     Make sure to use Scarb >=2.4.4"

crates/forge/test_utils/src/lib.rs

@@ -6,7 +6,7 @@ use assert_fs::fixture::PathCopy;
 use camino::Utf8PathBuf;
 use forge::MINIMAL_SCARB_VERSION_FOR_V2_MACROS_REQUIREMENT;
 use project_root::get_project_root;
-use scarb_api::ScarbCommand;
+use scarb_api::version::scarb_version;
 use semver::Version;
 use std::str::FromStr;
 
@@ -21,7 +21,7 @@ pub fn tempdir_with_tool_versions() -> Result<assert_fs::TempDir> {
 }
 
 pub fn get_assert_macros_version() -> Result<Version> {
-    let scarb_version_output = ScarbCommand::version().run()?;
+    let scarb_version_output = scarb_version()?;
     let assert_macros_version =
         if scarb_version_output.scarb < MINIMAL_SCARB_FOR_CORRESPONDING_ASSERT_MACROS {
             DEFAULT_ASSERT_MACROS
@@ -56,8 +56,6 @@ pub fn get_snforge_std_entry() -> Result<String> {
 
 #[must_use]
 pub fn use_snforge_std_deprecated() -> bool {
-    let scarb_version_output = ScarbCommand::version()
-        .run()
-        .expect("Failed to get scarb version");
+    let scarb_version_output = scarb_version().expect("Failed to get scarb version");
     scarb_version_output.scarb < MINIMAL_SCARB_VERSION_FOR_V2_MACROS_REQUIREMENT
 }

crates/forge/tests/e2e/plugin_versions.rs

@@ -2,6 +2,7 @@ use crate::e2e::common::runner::{runner, test_runner};
 use camino::Utf8PathBuf;
 use indoc::{formatdoc, indoc};
 use scarb_api::ScarbCommand;
+use scarb_api::version::scarb_version_for_dir;
 use shared::test_utils::output_assert::assert_stdout_contains;
 use snapbox::cmd::Command;
 use test_utils::tempdir_with_tool_versions;
@@ -146,9 +147,7 @@ fn new_scarb_deprecated_macros() {
         .command()
         .output()
         .unwrap();
-    let scarb_version = ScarbCommand::version()
-        .current_dir(temp.path())
-        .run()
+    let scarb_version = scarb_version_for_dir(temp.path())
         .unwrap()
         .scarb
         .to_string();

crates/forge/tests/e2e/requirements.rs

@@ -1,6 +1,6 @@
 use crate::e2e::common::runner::{runner, setup_package};
 use indoc::{formatdoc, indoc};
-use scarb_api::ScarbCommand;
+use scarb_api::version::scarb_version;
 use semver::Version;
 use shared::test_utils::output_assert::assert_stdout_contains;
 
@@ -9,7 +9,7 @@ fn happy_path() {
     let temp = setup_package("simple_package");
     let output = runner(&temp).arg("check-requirements").assert();
 
-    let scarb_version = ScarbCommand::version().run().unwrap().scarb;
+    let scarb_version = scarb_version().unwrap().scarb;
 
     let rust_check = if scarb_version < Version::new(2, 10, 0) {
         indoc! {"

crates/forge/tests/integration/meta_tx_v0.rs

@@ -1,6 +1,6 @@
 use forge_runner::forge_config::ForgeTrackedResource;
 use indoc::indoc;
-use scarb_api::ScarbCommand;
+use scarb_api::version::scarb_version;
 use semver::Version;
 use std::path::Path;
 use test_utils::runner::{Contract, assert_passed};
@@ -9,9 +9,7 @@ use test_utils::test_case;
 
 // TODO(#3704) Remove scarb version check
 fn skip_scarb_lt_2_11_0() -> bool {
-    let version_info = ScarbCommand::version()
-        .run()
-        .expect("Failed to get Scarb version");
+    let version_info = scarb_version().expect("Failed to get Scarb version");
 
     if version_info.scarb < Version::new(2, 11, 0) {
         eprintln!("[IGNORED] `meta_tx_v0` syscall is not supported in Scarb < 2.11.0");

crates/scarb-api/src/command.rs

@@ -1,4 +1,3 @@
-use crate::version::VersionCommand;
 use scarb_ui::args::{FeaturesSpec, PackagesFilter, ProfileSpec, ToEnvVars};
 use std::collections::HashMap;
 use std::ffi::{OsStr, OsString};
@@ -50,12 +49,6 @@ impl ScarbCommand {
         cmd
     }
 
-    /// Creates [`VersionCommand`] command
-    #[must_use]
-    pub fn version() -> VersionCommand {
-        VersionCommand::new()
-    }
-
     /// Path to `Scarb.toml`.
     ///
     /// If not set, this will look for `Scarb.toml` in the current directory or its ancestors.