🚀 Add ability to set shared folder root path

Docs/commands-help/env.md

@@ -18,11 +18,74 @@
 
 ## Discussion
 
-Rugby supports these environment variables:
+This command prints the Rugby environment. For example:
+```yml
+Rugby version: 2.3.0
+Swift: 5.9
+CLT: Xcode 15.0.1 (Build version 15A507)
+CPU: Apple M1 (arm64)
+Project: Example
+Git branch: main
+RUGBY_KEEP_HASH_YAMLS: NO
+RUGBY_PRINT_MISSING_BINARIES: NO
+RUGBY_SHARED_DIR_ROOT: /Users/swiftyfinch
+```
+
+You can find the same environment output in the head of each Rugby log file.
+
+<br>
+
+### Keep hash YML files
+
+A flag to keep yaml files with target hash in the binaries folder.
 ```objc
-# A flag to keep yaml files with target hash in the binaries folder.
-RUGBY_KEEP_HASH_YAMLS = NO
+RUGBY_KEEP_HASH_YAMLS=YES rugby
+```
+```sh
+.rugby 
+└─ bin
+   └─ Debug-iphonesimulator-arm64
+      └─ 85d4367
+         ├─ 85d4367.yml # Hash yml file
+         └─ Alamofire.framework
+```
+
+### Print missing binaries as a tree
 
-# A flag to print missing binaries as a tree during an analysing process.
-RUGBY_PRINT_MISSING_BINARIES = NO
+A flag to print missing binaries as a tree during an analysing process.
+```objc
+RUGBY_PRINT_MISSING_BINARIES=YES rugby
+```
+```
+. Missing Binaries (3)
+┣━ Kingfisher-framework (1a1f878)
+┗━ Moya-framework (a4a42b2)
+    ┗━ Alamofire-framework (85d4367)
+```
+
+### Set a custom path to shared folder root
+
+A path to the root of shared folder (without `.rugby` folder name).
+By default:
+```objc
+RUGBY_SHARED_DIR_ROOT=$HOME rugby
+```
+```sh
+~
+└─ .rugby # shared folder
+   ├─ bin
+   └─ logs
+```
+
+You can set a different one. For example, a current directory:
+```objc
+RUGBY_SHARED_DIR_ROOT=`pwd` rugby
+```
+```sh
+pwd
+└─ .rugby # shared folder combined with local one
+   ├─ backup
+   ├─ bin
+   ├─ build
+   └─ logs
 ```

Sources/Rugby/Commands/Utils/Env.swift

@@ -11,7 +11,7 @@ struct Env: AsyncParsableCommand {
     func run() async throws {
         try await dependencies.environmentCollector.env(
             rugbyVersion: Rugby.configuration.version,
-            rugbyEnvironment: dependencies.featureToggles.all
+            rugbyEnvironment: dependencies.env.all
         ).forEach { print($0) }
     }
 }

Sources/Rugby/Core/Dependencies/FeatureToggles/FeatureToggles.swift → Sources/Rugby/Core/Dependencies/Environment/Environment.swift

@@ -1,18 +1,21 @@
+import Fish
 import Foundation
 import RugbyFoundation
 
-final class FeatureToggles {
+final class Environment {
     // swiftlint:disable identifier_name
     private let RUGBY_KEEP_HASH_YAMLS = "RUGBY_KEEP_HASH_YAMLS"
     private let RUGBY_PRINT_MISSING_BINARIES = "RUGBY_PRINT_MISSING_BINARIES"
+    private let RUGBY_SHARED_DIR_ROOT = "RUGBY_SHARED_DIR_ROOT"
     // swiftlint:enable identifier_name
 }
 
-extension FeatureToggles: IFeatureToggles {
+extension Environment: IEnvironment {
     var all: [String: String] {
         [
             RUGBY_KEEP_HASH_YAMLS: keepHashYamls.yesNo,
-            RUGBY_PRINT_MISSING_BINARIES: printMissingBinaries.yesNo
+            RUGBY_PRINT_MISSING_BINARIES: printMissingBinaries.yesNo,
+            RUGBY_SHARED_DIR_ROOT: sharedFolderParentPath
         ]
     }
 
@@ -23,6 +26,10 @@
     var printMissingBinaries: Bool {
         ProcessInfo.processInfo.environment[RUGBY_PRINT_MISSING_BINARIES].isEnabled
     }
+
+    var sharedFolderParentPath: String {
+        ProcessInfo.processInfo.environment[RUGBY_SHARED_DIR_ROOT] ?? Folder.home.path
+    }
 }
 
 private extension String? {

Sources/Rugby/Core/RunnableCommand/RunnableCommand.swift

@@ -29,7 +29,7 @@
         try await dependencies.environmentCollector.write(
             rugbyVersion: Rugby.configuration.version,
             command: self,
-            rugbyEnvironment: dependencies.featureToggles.all
+            rugbyEnvironment: dependencies.env.all
         )
 
         let name = Self.configuration.commandName?.capitalized ?? "Unknown"

Sources/Rugby/Rugby.swift

@@ -70,12 +70,13 @@
     // MARK: - Private
 
     private static func prepareDependencies() {
-        Vault.setupShared(
-            featureToggles: FeatureToggles(),
+        let env = Environment()
+        return Vault.setupShared(
+            env: env,
             logger: Logger(clock: Clock()),
             router: Router(
                 workingDirectory: Folder.current,
-                sharedFolderPath: Folder.home.path
+                sharedFolderPath: env.sharedFolderParentPath
             )
         )
     }

Sources/RugbyFoundation/Core/Build/BuildManager.swift

@@ -43,7 +43,7 @@
     private let useBinariesManager: IUseBinariesManager
     private let binariesCleaner: BinariesCleaner
     private let environmentCollector: IEnvironmentCollector
-    private let featureToggles: IFeatureToggles
+    private let env: IEnvironment
     private let targetTreePainter: ITargetTreePainter
 
     init(logger: ILogger,
@@ -59,7 +59,7 @@
          useBinariesManager: IUseBinariesManager,
          binariesCleaner: BinariesCleaner,
          environmentCollector: IEnvironmentCollector,
-         featureToggles: IFeatureToggles,
+         env: IEnvironment,
          targetTreePainter: ITargetTreePainter) {
         self.logger = logger
         self.buildTargetsManager = buildTargetsManager
@@ -74,7 +74,7 @@
         self.useBinariesManager = useBinariesManager
         self.binariesCleaner = binariesCleaner
         self.environmentCollector = environmentCollector
-        self.featureToggles = featureToggles
+        self.env = env
         self.targetTreePainter = targetTreePainter
     }
 
@@ -99,7 +99,7 @@
             return nil
         }
 
-        if featureToggles.printMissingBinaries {
+        if env.printMissingBinaries {
             let tree = targetTreePainter.paint(targets: buildTargets)
             await logPlain(
                 "\(".".yellow) \("Missing Binaries (\(buildTargets.count))".green)\n\(tree)"

Sources/RugbyFoundation/Core/Common/IEnvironment.swift

@@ -0,0 +1,14 @@
+/// The protocol describing a service providing the environment variables.
+public protocol IEnvironment: AnyObject {
+    /// The variable names and their values.
+    var all: [String: String] { get }
+
+    /// A flag to keep yaml files with target hash in the binaries folder.
+    var keepHashYamls: Bool { get }
+
+    /// A flag to print missing binaries as a tree during an analysing process.
+    var printMissingBinaries: Bool { get }
+
+    /// A path to the root of shared folder (without `.rugby` folder name).
+    var sharedFolderParentPath: String { get }
+}

Sources/RugbyFoundation/Vault/Commands/Build/Vault+Build.swift

@@ -42,7 +42,7 @@ extension Vault {
                             useBinariesManager: useBinariesManager,
                             binariesCleaner: binariesCleaner,
                             environmentCollector: environmentCollector,
-                            featureToggles: featureToggles,
+                            env: env,
                             targetTreePainter: TargetTreePainter())
     }
 }

Sources/RugbyFoundation/Vault/Vault.swift

@@ -11,17 +11,17 @@ public final class Vault {
     ///   - logger: The service collecting information about Rugby execution.
     ///   - router: The service providing all paths for Rugby infrastructure.
     public static func setupShared(
-        featureToggles: IFeatureToggles,
+        env: IEnvironment,
         logger: ILogger,
         router: IRouter
     ) {
-        shared = Vault(featureToggles: featureToggles, logger: logger, router: router)
+        shared = Vault(env: env, logger: logger, router: router)
     }
 
     // MARK: - Init
 
-    /// The service providing feature toggles.
-    public let featureToggles: IFeatureToggles
+    /// The service providing environment variables.
+    public let env: IEnvironment
     /// The general Rugby settings.
     public let settings = Settings()
     /// The service collecting information about Rugby execution.
@@ -30,11 +30,11 @@ public final class Vault {
     public let router: IRouter
 
     private init(
-        featureToggles: IFeatureToggles,
+        env: IEnvironment,
         logger: ILogger,
         router: IRouter
     ) {
-        self.featureToggles = featureToggles
+        self.env = env
         self.logger = logger
         self.router = router
     }
@@ -95,7 +95,7 @@ public final class Vault {
     private(set) lazy var binariesManager = BinariesStorage(
         logger: logger,
         sharedPath: router.binFolderPath,
-        keepHashYamls: featureToggles.keepHashYamls
+        keepHashYamls: env.keepHashYamls
     )
     func targetsHasher() -> TargetsHasher {
         let foundationHasher = SHA1Hasher()