Add functionality for cloning from git in welcome view (#232)

* Git Clone: Add basic functionality of cloning repository

Basics of cloning repository implemented. Pressing clone on welcome
view now opens simple window with url input with clone and close buttons

For now it clones the repositories in to your home dir. Error handling
for now is nada and should be implemented in later commits

* Git Clone: Select target folder and clone the repository

Now you can select the folder to which you want to clone the repository.
This defaults to home folder.

Also added check that the repository isn't empty when trying to clone.

* Git Clone: Open cloned folder

Now after we press `clone` button, we firstly clone the specified
repository to given folder. After cloning, we open folder picker for
the user to pick folder to open the editor in. However this could be better if
we straight up open the editor in the cloned folder, rather than giving user an option
to choose the folder in between.

* Git Clone: Add error handling

Added error handling for git related errors e.g. when trying to clone
non existent repository

* Git Clone: Implementation as a module

Changed GitClone to be module as discussed in
#232 (comment)

* Git Clone: Uncomment dependency from Package.swift

* Git Clone: Switch to use NSSavePanel

Switched the git clone view folder picking to use NSSavePanel
instead of NSOpenPanel.

NSSavePanel gives us kind of the same flow as Xcode has, as it's also using
NSSavePanel to prompt the target folder for cloning.

The view now consist of two separate modals that pop open, and it may
seem cumbersome, but it now has kind of the same functionality as Xcode.

* Git Clone: Remove .git only if the url has it.

* Git Clone: Reposition UI

Repositioning buttons, input and text. Also added app icon to the view

* Git Clone: Change clone view to be sheet

Changed git clone view to be sheet instead of normal window. This
is better for UX as you can't click anywhere else than the clone view
until you either cancel or clone the repository

* Git Clone: Validate url and more error handling

Naive Xcode-like check for the url implemented. For now if the url
does not start with certain string, the clone button is disabled, just
like in Xcode.

Also added check for when user decides to press cancel on folder selection
#232 (comment)

* Git Clone: Add automatic pasting

If you have 'valid' git url in your clipboard when opening the clone
view, it now automatically pastes it to the textfield

* GitClone: Fix some force unwrappings and make vars private

* GitClone: Make shellClient constant

* GitClone: Fix indentation and make logic private func

Fixed indentation in WelcomeView and moved the logic of cloning
repository into it's own private function

Author: Pythonen

CodeEdit.xcodeproj/project.pbxproj

@@ -47,6 +47,7 @@
 		5CAD1B972806B57D0059A74E /* Breadcrumbs in Frameworks */ = {isa = PBXBuildFile; productRef = 5CAD1B962806B57D0059A74E /* Breadcrumbs */; };
 		5CF38A5E27E48E6C0096A0F7 /* CodeFile in Frameworks */ = {isa = PBXBuildFile; productRef = 5CF38A5D27E48E6C0096A0F7 /* CodeFile */; };
 		5CFA753B27E896B60002F01B /* GitClient in Frameworks */ = {isa = PBXBuildFile; productRef = 5CFA753A27E896B60002F01B /* GitClient */; };
+		B34B213227ECDC3A006033A9 /* GitClone in Frameworks */ = {isa = PBXBuildFile; productRef = B34B213127ECDC3A006033A9 /* GitClone */; };
 		64B64EDE27F7B79400C400F1 /* About in Frameworks */ = {isa = PBXBuildFile; productRef = 64B64EDD27F7B79400C400F1 /* About */; };
 		B658FB3427DA9E1000EA4DBD /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = B658FB3327DA9E1000EA4DBD /* Assets.xcassets */; };
 		B658FB3727DA9E1000EA4DBD /* Preview Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = B658FB3627DA9E1000EA4DBD /* Preview Assets.xcassets */; };
@@ -158,6 +159,7 @@
 				D70F5E2C27E4E8CF004EE4B9 /* WelcomeModule in Frameworks */,
 				2859B93F27EB50050069BE88 /* FontPicker in Frameworks */,
 				D7F72DEB27EA3574000C3064 /* Search in Frameworks */,
+				B34B213227ECDC3A006033A9 /* GitClone in Frameworks */,
 				5CFA753B27E896B60002F01B /* GitClient in Frameworks */,
 				28CE5EA027E6493D0065D29C /* StatusBar in Frameworks */,
 				20D2A95527F72E6800E7ECF6 /* Accounts in Frameworks */,
@@ -382,6 +384,7 @@
 				0485EB2427E7B9C800138301 /* Overlays */,
 				5CFA753A27E896B60002F01B /* GitClient */,
 				D7F72DEA27EA3574000C3064 /* Search */,
+				B34B213127ECDC3A006033A9 /* GitClone */,
 				2859B93E27EB50050069BE88 /* FontPicker */,
 				2803257027F3CF1F009C7DC2 /* AppPreferences */,
 				20D2A95427F72E6800E7ECF6 /* Accounts */,
@@ -1049,6 +1052,10 @@
 			isa = XCSwiftPackageProductDependency;
 			productName = GitClient;
 		};
+		B34B213127ECDC3A006033A9 /* GitClone */ = {
+			isa = XCSwiftPackageProductDependency;
+			productName = GitClone;
+		};
 		64B64EDD27F7B79400C400F1 /* About */ = {
 			isa = XCSwiftPackageProductDependency;
 			productName = About;

CodeEditModules/Modules/GitClient/src/Interface.swift

@@ -12,6 +12,7 @@ public struct GitClient {
     public var getBranches: () throws -> [String]
     public var checkoutBranch: (String) throws -> Void
     public var pull: () throws -> Void
+    public var cloneRepository: (String) throws -> Void
     /// Get commit history
     /// - Parameters:
     ///   - entries: number of commits we want to fetch. Will use max if nil
@@ -24,12 +25,14 @@ public struct GitClient {
         getBranches: @escaping () throws -> [String],
         checkoutBranch: @escaping (String) throws -> Void,
         pull: @escaping () throws -> Void,
+        cloneRepository: @escaping (String) throws -> Void,
         getCommitHistory: @escaping (_ entries: Int?, _ fileLocalPath: String?) throws -> [Commit]
     ) {
         self.getCurrentBranchName = getCurrentBranchName
         self.getBranches = getBranches
         self.checkoutBranch = checkoutBranch
         self.pull = pull
+        self.cloneRepository = cloneRepository
         self.getCommitHistory = getCommitHistory
     }
 

CodeEditModules/Modules/GitClient/src/Live.swift

@@ -44,6 +44,12 @@ public extension GitClient {
                 throw GitClientError.outputError(output)
             }
         }
+        func cloneRepository(url: String) throws {
+            let output = try shellClient.run("cd \(directoryURL.relativePath);git clone \(url) .")
+            if output.contains("fatal") {
+                throw GitClientError.outputError(output)
+            }
+        }
 
         func getCommitHistory(entries: Int?, fileLocalPath: String?) throws -> [Commit] {
             var entriesString = ""
@@ -79,6 +85,7 @@ public extension GitClient {
                     throw GitClientError.notGitRepository
                 }
             },
+            cloneRepository: cloneRepository(url:),
             getCommitHistory: getCommitHistory(entries:fileLocalPath:)
         )
     }

CodeEditModules/Modules/GitClone/src/GitCloneView.swift

@@ -0,0 +1,171 @@
+//
+//  GitCloneView.swift
+//  CodeEdit
+//
+//  Created by Aleksi Puttonen on 23.3.2022.
+//
+
+import SwiftUI
+import GitClient
+import Foundation
+import ShellClient
+
+public struct GitCloneView: View {
+    private let shellClient: ShellClient
+    @Binding private var isPresented: Bool
+    @State private var repoUrlStr = ""
+    @State private var repoPath = "~/"
+    public init(shellClient: ShellClient, isPresented: Binding<Bool>) {
+        self.shellClient = shellClient
+        self._isPresented = isPresented
+    }
+    public var body: some View {
+        VStack(spacing: 8) {
+            HStack {
+                Image(nsImage: NSApp.applicationIconImage)
+                    .resizable()
+                    .frame(width: 64, height: 64)
+                    .padding(.bottom, 50)
+                VStack(alignment: .leading) {
+                    Text("Clone an existing repository")
+                        .bold()
+                        .padding(.bottom, 2)
+                    Text("Enter a git repository URL:")
+                        .font(.system(size: 11))
+                        .foregroundColor(.secondary)
+                        .alignmentGuide(.trailing) { context in
+                        context[.trailing]
+                    }
+                    TextField("Git Repository URL", text: $repoUrlStr)
+                        .lineLimit(1)
+                        .padding(.bottom, 15)
+                        .frame(width: 300)
+                    HStack {
+                        Button("Cancel") {
+                            isPresented = false
+                        }
+                        Button("Clone") {
+                            cloneRepository()
+                        }
+                        .keyboardShortcut(.defaultAction)
+                        .disabled(!isValid(url: repoUrlStr))
+                    }
+                    .offset(x: 185)
+                    .alignmentGuide(.leading) { context in
+                        context[.leading]
+                    }
+                }
+            }
+            .padding(.top, 20)
+            .padding(.horizontal, 20)
+            .padding(.bottom, 16)
+            .onAppear {
+                self.checkClipboard(textFieldText: &repoUrlStr)
+            }
+        }
+    }
+}
+
+extension GitCloneView {
+    func getPath(modifiable: inout String, saveName: String) -> String? {
+        let dialog = NSSavePanel()
+        dialog.showsResizeIndicator    = true
+        dialog.showsHiddenFiles        = false
+        dialog.showsTagField = false
+        dialog.prompt = "Clone"
+        dialog.nameFieldStringValue = saveName
+        dialog.nameFieldLabel = "Clone as"
+        dialog.title = "Clone"
+
+        if dialog.runModal() ==  NSApplication.ModalResponse.OK {
+            let result = dialog.url
+
+            if result != nil {
+                let path: String = result!.path
+                // path contains the directory path e.g
+                // /Users/ourcodeworld/Desktop/folder
+                modifiable = path
+                return path
+            }
+        } else {
+            // User clicked on "Cancel"
+            return nil
+        }
+        return nil
+    }
+    func showAlert(alertMsg: String, infoText: String) {
+        let alert = NSAlert()
+        alert.messageText = alertMsg
+        alert.informativeText = infoText
+        alert.addButton(withTitle: "OK")
+        alert.alertStyle = .warning
+        alert.runModal()
+    }
+    func isValid(url: String) -> Bool {
+        // Doing the same kind of check that Xcode does when cloning
+        let url = url.lowercased()
+        if url.starts(with: "http://") && url.count > 7 {
+            return true
+        } else if url.starts(with: "https://") && url.count > 8 {
+            return true
+        } else if url.starts(with: "git@") && url.count > 4 {
+            return true
+        }
+        return false
+    }
+    func checkClipboard(textFieldText: inout String) {
+        if let url = NSPasteboard.general.pasteboardItems?.first?.string(forType: .string) {
+            if isValid(url: url) {
+                textFieldText = url
+            }
+        }
+    }
+    private func cloneRepository() {
+        do {
+            if repoUrlStr == "" {
+                showAlert(alertMsg: "Url cannot be empty",
+                          infoText: "You must specify a repository to clone")
+                return
+            }
+            // Parsing repo name
+            let repoURL = URL(string: repoUrlStr)
+            if var repoName = repoURL?.lastPathComponent {
+                // Strip .git from name if it has it.
+                // Cloning repository without .git also works
+                if repoName.contains(".git") {
+                    repoName.removeLast(4)
+                }
+                guard getPath(modifiable: &repoPath, saveName: repoName) != nil else {
+                    return
+                }
+            } else {
+                return
+            }
+            guard let dirUrl = URL(string: repoPath) else {
+                return
+            }
+            var isDir: ObjCBool = true
+            if FileManager.default.fileExists(atPath: repoPath, isDirectory: &isDir) {
+                showAlert(alertMsg: "Error", infoText: "Directory already exists")
+                return
+            }
+            try FileManager.default.createDirectory(atPath: repoPath,
+                                                    withIntermediateDirectories: true,
+                                                    attributes: nil)
+            try GitClient.default(directoryURL: dirUrl,
+                                  shellClient: shellClient).cloneRepository(repoUrlStr)
+            // TODO: Maybe add possibility to checkout to certain branch straight after cloning
+            isPresented = false
+        } catch {
+            guard let error = error as? GitClient.GitClientError else {
+                return showAlert(alertMsg: "Error", infoText: error.localizedDescription)
+            }
+            switch error {
+            case let .outputError(message):
+                showAlert(alertMsg: "Error", infoText: message)
+            case .notGitRepository:
+                showAlert(alertMsg: "Error", infoText: "Not git repository")
+            }
+        }
+    }
+}

CodeEditModules/Modules/WelcomeModule/src/WelcomeView.swift

@@ -9,9 +9,11 @@ import SwiftUI
 import AppKit
 import Foundation
 import AppPreferences
+import GitClone
 
 public struct WelcomeView: View {
     @Environment(\.colorScheme) var colorScheme
+    @State var showGitClone = false
     @State var isHovering: Bool = false
     @State var isHoveringClose: Bool = false
     @StateObject private var prefs: AppPreferencesModel = .shared
@@ -157,9 +159,9 @@ public struct WelcomeView: View {
                                 comment: ""
                             )
                         )
-                        .onTapGesture {
-                            // TODO: clone a Git repository
-                        }
+                            .onTapGesture {
+                                showGitClone = true
+                            }
                     }
                 }
                 Spacer()
@@ -198,6 +200,9 @@ public struct WelcomeView: View {
                 .transition(AnyTransition.opacity.animation(.easeInOut(duration: 0.25)))
             }
         }
+        .sheet(isPresented: $showGitClone) {
+            GitCloneView(shellClient: .live, isPresented: $showGitClone)
+        }
     }
 
     private var dismissButton: some View {

CodeEditModules/Package.swift

@@ -41,6 +41,10 @@ let package = Package(
             name: "Search",
             targets: ["Search"]
         ),
+        .library(
+            name: "GitClone",
+            targets: ["GitClone"]
+        ),
         .library(
             name: "FontPicker",
             targets: ["FontPicker"]
@@ -204,6 +208,14 @@ let package = Package(
             ],
             path: "Modules/Search/src"
         ),
+        .target(
+            name: "GitClone",
+            dependencies: [
+                "GitClient",
+                "ShellClient"
+            ],
+            path: "Modules/GitClone/src"
+        ),
         .target(
             name: "FontPicker",
             path: "Modules/FontPicker/src"