Merge branch 'main' into stash-untracked

Author: isc-pbarton

CHANGELOG.md

@@ -10,12 +10,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Web UI includes a "Push Branch" button for local branches that are ahead of upstream
 - Stash option in the Web UI now includes untracked files
+- Added "Status" menu item to editor menu (#285)
 
 ### Fixed
+- Fatal: bad revision HEAD fixed using an empty commmit (#228)
 - Fixed empty mappings when SourceControl.Git.Settings is instantiated (#250)
 - Studio export path doesn't get weird mixed slahes on Windows (#252)
 - Fixed bug with adding mappings through the Settings page (#270)
 - Pulling add/delete of multiple non-IRIS files no longer causes error (#273)
+- Reset SourceControlClass during module uninstall to prevent "Class does not exist error" (#285)
 
 ## [2.2.0] - 2023-06-05
 

cls/SourceControl/Git/Extension.cls

@@ -10,6 +10,7 @@ XData Menu
 {
 <MenuBase>
 <Menu Name="%SourceMenu" Type="0">
+<MenuItem Name="Status" />
 <MenuItem Name="Settings" />
 <MenuItem Name="Init" />
 <MenuItem Name="GitWebUI" />
@@ -42,6 +43,12 @@ XData Menu
 
 Method UserAction(Type As %Integer, Name As %String, InternalName As %String, SelectedText As %String, ByRef Action As %String, ByRef Target As %String, ByRef Msg As %String, ByRef Reload As %Boolean) As %Status
 {
+    // If namespace change event
+    if Type = 1, Name = 5 {
+        // reroute to Status menu option
+        set Name = "%SourceMenu,Status"
+    }
+
     #dim ec as %Status = $$$OK
     #dim menu as %Status = $piece(Name, ",", 1)
     if menu '= "%SourceMenu", menu'="%SourceContext" {
@@ -86,37 +93,41 @@ Method LocalizeName(name As %String) As %String
         "Push":$$$Text("@Push@Push to remote branch"),
         "Fetch":$$$Text("@Fetch@Fetch from remote"),
         "Pull":$$$Text("@Pull@Pull changes from remote branch"),
+        "Status": $$$Text("@Status@Status"),
         :name)
 }
 
 Method OnSourceMenuItem(name As %String, ByRef Enabled As %String, ByRef DisplayName As %String, InternalName As %String) As %Status
 {
     if name = "Settings" {
+        set Enabled = 1
         quit $$$OK
     }
     if ##class(Utils).NeedSettings() {
         set Enabled = -1
         quit $$$OK
     }
-    set Enabled = 1
     if ##class(Utils).IsNamespaceInGit() {
-        if name = "GitWebUI" {
-        } elseif name = "Export" {
-        } elseif name = "ExportForce" {
-        } elseif name = "Import" {
-        } elseif name = "ImportForce" {
-        } elseif $listfind($listbuild("AddToSC","RemoveFromSC","Revert","Commit"),name) {
-            quit ..OnSourceMenuContextItem(InternalName,name,.Enabled,.DisplayName)
-        } elseif name = "NewBranch" {
-        } elseif name = "SwitchBranch" {
-        } elseif name = "Push" {
-        } elseif name = "Fetch" {
-        } elseif name = "Pull" {
-        } elseif name = "" {
-            // enable separators if namespace is in git
-        } else {
-            set Enabled = -1
-        }
+    if $listfind($listbuild("AddToSC", "RemoveFromSC", "Revert", "Commit"), name) {
+        quit ..OnSourceMenuContextItem(InternalName,name,.Enabled,.DisplayName)
+    }
+    set Enabled = $CASE(name, 
+        // cases
+        "Status": 1,
+        "GitWebUI" : 1,
+        "Export": 1,
+        "ExportForce": 1,
+        "Import": 1,
+        "ImportForce": 1,
+        "NewBranch": 1,
+        "SwitchBranch": 1,
+        "Push": 1,
+        "Fetch": 1,
+        "Pull": 1,
+        "": 1,
+        :-1 // default
+    )
+        
     } elseif ##class(Utils).GitBinExists() {
         if name = "Init" {
         } else {

cls/SourceControl/Git/Settings.cls

@@ -155,6 +155,7 @@ Method OnAfterConfigure() As %Boolean
             set workMgr = $System.WorkMgr.%New("")
             $$$ThrowOnError(workMgr.Queue("##class(SourceControl.Git.Utils).Init"))
             $$$ThrowOnError(workMgr.Sync())
+            do ##class(SourceControl.Git.Utils).EmptyInitialCommit()
         } elseif (value = 2) {
             set response = ##class(%Library.Prompt).GetString("Git remote URL (note: if authentication is required, use SSH, not HTTPS):",.remote,,,,defaultPromptFlag)
             if (response '= $$$SuccessResponse) {
@@ -172,4 +173,3 @@ Method OnAfterConfigure() As %Boolean
 }
 
 }
-

cls/SourceControl/Git/Utils.cls

@@ -151,7 +151,7 @@ $Find(..#ImportAfterGitMenuItems, ","_menuItemName_",") > 0
 ClassMethod UserAction(InternalName As %String, MenuName As %String, ByRef Target As %String, ByRef Action As %String, ByRef Reload As %Boolean) As %Status
 {
     #define Force 1
-    #dim menuName as %String = $piece(MenuName,",")
+    // MenuName = "<Name of menu>,<Name of menu item>"
     #dim menuItemName as %String = $piece(MenuName,",",2)
     #dim ec as %Status = $$$OK
 
@@ -233,6 +233,10 @@ ClassMethod UserAction(InternalName As %String, MenuName As %String, ByRef Targe
         set ec = ..AddToSourceControl(InternalName)
     } elseif (menuItemName = "RemoveFromSC") {
         set ec = ..RemoveFromSourceControl(InternalName)
+    } elseif (menuItemName = "Status") {
+        do ..RunGitCommand("status", .errStream, .outStream)
+        write !, !, "Git Status: "
+        do ..PrintStreams(outStream, errStream)
     }
     quit ec
 }
@@ -266,10 +270,8 @@ ClassMethod AfterUserAction(Type As %Integer, Name As %String, InternalName As %
 ClassMethod Init() As %Status
 {
     do ..RunGitCommand("init",.errStream,.outStream)
-    $$$NewLineIfNonEmptyStream(errStream)
-    do errStream.OutputToDevice()
-    $$$NewLineIfNonEmptyStream(outStream)
-    do outStream.OutputToDevice()
+    do ..PrintStreams(outStream, errStream)
+    
     quit $$$OK
 }
 
@@ -290,10 +292,7 @@ ClassMethod Commit(InternalName As %String, Message As %String = "example commit
     set email = ..GitUserEmail()
     set author = username_" <"_email_">"
     do ..RunGitWithArgs(.errStream, .outStream, "commit", "--author", author, "-m", Message, filename)
-    $$$NewLineIfNonEmptyStream(outStream)
-    do outStream.OutputToDevice()
-    $$$NewLineIfNonEmptyStream(errStream)
-    do errStream.OutputToDevice()
+    do ..PrintStreams(outStream, outStream)
     $$$QuitOnError(##class(SourceControl.Git.Change).RemoveUncommitted(filename))
     $$$QuitOnError(##class(SourceControl.Git.Change).RefreshUncommitted())
     quit $$$OK
@@ -302,20 +301,14 @@ ClassMethod Commit(InternalName As %String, Message As %String = "example commit
 ClassMethod NewBranch(newBranchName As %String) As %Status
 {
     do ..RunGitWithArgs(.errStream, .outStream, "checkout", "-b", newBranchName)
-    $$$NewLineIfNonEmptyStream(errStream)
-    do errStream.OutputToDevice()
-    $$$NewLineIfNonEmptyStream(outStream)
-    do outStream.OutputToDevice()
+    do ..PrintStreams(errStream, outStream)
     quit $$$OK
 }
 
 ClassMethod SwitchBranch(targetBranchName As %String) As %Status
 {
     do ..RunGitWithArgs(.errStream, .outStream, "checkout", targetBranchName)
-    $$$NewLineIfNonEmptyStream(errStream)
-    do errStream.OutputToDevice()
-    $$$NewLineIfNonEmptyStream(outStream)
-    do outStream.OutputToDevice()
+    do ..PrintStreams(errStream, outStream)
     quit $$$OK
 }
 
@@ -324,10 +317,7 @@ ClassMethod Push(remote As %String = "origin") As %Status
     do ##class(SourceControl.Git.Utils).RunGitCommandWithInput("branch",,.errStream,.outstream,"--show-current")
     set branchName = outstream.ReadLine(outstream.Size)
     do ..RunGitWithArgs(.errStream, .outStream, "push", remote, branchName)
-    $$$NewLineIfNonEmptyStream(errStream)
-    do errStream.OutputToDevice()
-    $$$NewLineIfNonEmptyStream(outStream)
-    do outStream.OutputToDevice()
+    do ..PrintStreams(errStream, outStream)
     quit $$$OK
 }
 
@@ -353,8 +343,7 @@ ClassMethod Pull(remote As %String = "origin", preview As %Boolean = 0) As %Stat
 
     set sc =  ##class(SourceControl.Git.Utils).RunGitCommandWithInput("fetch",,.errStream,.outStream, remote, branchName)
     if (sc=1){
-        $$$NewLineIfNonEmptyStream(errStream)
-        do errStream.OutputToDevice()
+        do ..PrintStreams(errStream)
         quit sc
     }
 
@@ -389,14 +378,10 @@ ClassMethod Pull(remote As %String = "origin", preview As %Boolean = 0) As %Stat
 
     set sc = ..RunGitWithArgs(.errStream, .outStream, "pull", remote, branchName)
     if (sc=1){
-        $$$NewLineIfNonEmptyStream(errStream)
-        do errStream.OutputToDevice()
-        $$$NewLineIfNonEmptyStream(outStream)
-        do outStream.OutputToDevice()
+        do ..PrintStreams(errStream, outStream)
         quit $$$ERROR(5001, "Pull event handler not called. Fix errors before compiling.")
     }
-    $$$NewLineIfNonEmptyStream(outStream)
-    do outStream.OutputToDevice()
+    do ..PrintStreams(outStream)
     write !
 
     set key = $order(files(""))
@@ -439,6 +424,7 @@ ClassMethod Clone(remote As %String) As %Status
     set settings = ##class(SourceControl.Git.Settings).%New()
     // TODO: eventually use /ENV flag with GIT_TERMINAL_PROMPT=0. (This isn't doc'd yet and is only in really new versions.)
     set sc = ..RunGitWithArgs(.errStream, .outStream, "clone", remote, settings.namespaceTemp)
+    // can I substitute this with the new print method?
     $$$NewLineIfNonEmptyStream(errStream)
     while 'errStream.AtEnd {
         write errStream.ReadLine(),!
@@ -475,8 +461,7 @@ ClassMethod GenerateSSHKeyPair() As %Status
     for stream=errStream,outStream {
         set stream.RemoveOnClose = 1
     }
-    do outStream.OutputToDevice()
-    do errStream.OutputToDevice()
+    do ..PrintStreams(outStream, errStream)
     quit $$$OK
 }
 
@@ -538,10 +523,7 @@ ClassMethod AddToSourceControl(InternalName As %String) As %Status
             set @..#Storage@("items", FileInternalName) = ""
             do ..RunGitCommand("add",.errStream,.outStream,filenames(i))
             write !, "Added ", FileInternalName, " to source control."
-            $$$NewLineIfNonEmptyStream(outStream)
-            do outStream.OutputToDevice()
-            $$$NewLineIfNonEmptyStream(errStream)
-            do errStream.OutputToDevice()
+            do ..PrintStreams(outStream, errStream)
         }
     }
     quit ec
@@ -551,10 +533,7 @@ ClassMethod RemoveFromGit(InternalName)
 {
     #dim fullName = ##class(Utils).FullExternalName(InternalName)
     do ..RunGitCommand("rm",.errStream,.outStream,"--cached", fullName)
-    $$$NewLineIfNonEmptyStream(errStream)
-    do errStream.OutputToDevice()
-    $$$NewLineIfNonEmptyStream(outStream)
-    do errStream.OutputToDevice()
+    do ..PrintStreams(errStream, outStream)
 }
 
 ClassMethod DeleteExternalsForItem(InternalName As %String) As %Status
@@ -1529,6 +1508,12 @@ ClassMethod GitStatus(ByRef files, IncludeAllFiles = 0)
     }
 }
 
+ClassMethod EmptyInitialCommit()
+{
+    set ret = ..RunGitCommandWithInput("commit",, .errStream, .outStream, "--allow-empty", "-m", "empty initial commit")
+    do ..PrintStreams(errStream, outStream)
+}
+
 /*
     Internal name: e.g. SourceControl.Git.Utils.CLS
     External name e.g. cls/SourceControl/Git/Utils.cls
@@ -1990,5 +1975,18 @@ ClassMethod SetDefaultMappings(mappingsNode As %String)
     set @mappingsNode@("MAC","*")="rtn/"
 }
 
+ClassMethod PrintStreams(streams... As %Stream.FileCharacter)
+{
+    for i=1:1:$get(streams, 0) {
+        set stream = streams(i)
+        $$$NewLineIfNonEmptyStream(stream)
+        do stream.OutputToDevice()
+    }
 }
 
+ClassMethod ResetSourceControlClass()
+{
+    do ##class(%Studio.SourceControl.Interface).SourceControlClassSet("")
+}
+
+}

module.xml

@@ -33,6 +33,8 @@
       <Invoke Class="SourceControl.Git.Utils" Method="Localize" />
       <Invoke Class="SourceControl.Git.Utils" Method="ConfigureWeb" />
       <Invoke Class="SourceControl.Git.Utils" Method="CheckInitialization" />
+      
+      <Invoke Class="SourceControl.Git.Utils" Method="ResetSourceControlClass" Phase="Unconfigure" />
     </Module>
   </Document>
 </Export>