Introduce a way to see skipped worktree files (#6)

monosoul · web-flow · commit 3be206a72c6b · 2021-04-25T21:04:22.000+02:00
diff --git a/README.md b/README.md
@@ -18,6 +18,10 @@ It adds the support for the next subcommands:
 
 ![New items in the git context menu](screenshots/screenshot_2.png)
 
+![Show Skipped Worktree option](screenshots/screenshot_3.png)
+
+![Show skipped worktree changes view element](screenshots/screenshot_4.png)
+
 ## Release History
 * 0.0.5
   * Run the commands in a background task (fixes the exception).
diff --git a/screenshots/screenshot_3.png b/screenshots/screenshot_3.png
diff --git a/screenshots/screenshot_4.png b/screenshots/screenshot_4.png
diff --git a/src/main/kotlin/com/github/monosoul/git/updateindex/extended/ExtendedUpdateIndexTask.kt b/src/main/kotlin/com/github/monosoul/git/updateindex/extended/ExtendedUpdateIndexTask.kt
@@ -25,7 +25,7 @@ class ExtendedUpdateIndexTask(
                 .mapNotNull { fileToVcsRoot(it) }
                 .groupBy({ (_, vcsRoot) -> vcsRoot }, { (file, _) -> file })
                 .onEach { (vcsRoot, files) ->
-                    gitLineHandlerFactory(command, vcsRoot, files).runAndLog()
+                    updateIndexLineHandlerFactory(command, vcsRoot, files).runAndLog()
                     files.forEach(vcsDirtyScopeManager::fileDirty)
                 }
         }
@@ -36,8 +36,8 @@ class ExtendedUpdateIndexTask(
         ?.let(GitCommandResult::getErrorOutput)
         ?.forEach(logger::error)
 
-    private val Project.gitLineHandlerFactory: GitLineHandlerFactory
-        get() = getService(GitLineHandlerFactory::class.java)
+    private val Project.updateIndexLineHandlerFactory: UpdateIndexLineHandlerFactory
+        get() = getService(UpdateIndexLineHandlerFactory::class.java)
 
     private val Project.vcsDirtyScopeManager: VcsDirtyScopeManager
         get() = VcsDirtyScopeManager.getInstance(this)
diff --git a/src/main/kotlin/com/github/monosoul/git/updateindex/extended/UpdateIndexLineHandlerFactory.kt b/src/main/kotlin/com/github/monosoul/git/updateindex/extended/UpdateIndexLineHandlerFactory.kt
@@ -9,7 +9,7 @@ import git4idea.commands.GitCommand.UPDATE_INDEX
 import git4idea.commands.GitLineHandler
 
 @Service
-class GitLineHandlerFactory(private val project: Project) {
+class UpdateIndexLineHandlerFactory(private val project: Project) {
 
     private val logger by Slf4j
 
diff --git a/src/main/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/ChangesBrowserSkippedWorktreeNode.kt b/src/main/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/ChangesBrowserSkippedWorktreeNode.kt
@@ -0,0 +1,18 @@
+package com.github.monosoul.git.updateindex.extended.changes.view
+
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vcs.FilePath
+import com.intellij.openapi.vcs.changes.IgnoredViewDialog
+import com.intellij.openapi.vcs.changes.ui.ChangesBrowserNode.Tag
+import com.intellij.openapi.vcs.changes.ui.ChangesBrowserSpecificFilePathsNode
+
+class ChangesBrowserSkippedWorktreeNode(
+    project: Project,
+    files: Collection<FilePath>
+) : ChangesBrowserSpecificFilePathsNode<Tag>(
+    TagImpl("Skipped Worktree"),
+    files,
+    { if (!project.isDisposed) IgnoredViewDialog(project).show() }
+) {
+    override fun getTextPresentation() = getUserObject().toString()
+}
diff --git a/src/main/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/Constants.kt b/src/main/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/Constants.kt
@@ -0,0 +1,6 @@
+package com.github.monosoul.git.updateindex.extended.changes.view
+
+object Constants {
+    const val PROPERTY = "com.github.monosoul.git-extended-update-index-plugin.showSkipped"
+    const val SKIPPED_FILE = "S"
+}
diff --git a/src/main/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/GetSkippedWorktreeFilesTask.kt b/src/main/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/GetSkippedWorktreeFilesTask.kt
@@ -0,0 +1,48 @@
+package com.github.monosoul.git.updateindex.extended.changes.view
+
+import com.github.monosoul.git.updateindex.extended.changes.view.Constants.SKIPPED_FILE
+import com.intellij.openapi.progress.ProgressIndicator
+import com.intellij.openapi.progress.Task.WithResult
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vcs.FilePath
+import com.intellij.openapi.vcs.ProjectLevelVcsManager
+import com.intellij.openapi.vcs.VcsException
+import com.intellij.openapi.vcs.VcsRoot
+import com.intellij.vcsUtil.VcsUtil
+import git4idea.GitUtil
+import git4idea.commands.Git
+import git4idea.commands.GitAuthenticationMode.NONE
+import git4idea.commands.GitCommand.LS_FILES
+import git4idea.commands.GitCommandResult
+import git4idea.commands.GitLineHandler
+
+class GetSkippedWorktreeFilesTask(
+    project: Project
+) : WithResult<List<FilePath>, RuntimeException>(project, "Getting Skipped Files", false) {
+
+    override fun compute(indicator: ProgressIndicator): List<FilePath> {
+        val vcsManager = ProjectLevelVcsManager.getInstance(project) ?: return emptyList()
+
+        return vcsManager.allVcsRoots.map(VcsRoot::getPath).map { vcsRoot ->
+            GitLineHandler(project, vcsRoot, LS_FILES).apply {
+                addParameters("-v")
+                ignoreAuthenticationMode = NONE
+            }.let(Git.getInstance()::runCommand).mapOrThrow { result ->
+                result.filter {
+                    it.startsWith(SKIPPED_FILE)
+                }.map {
+                    it.removePrefix("$SKIPPED_FILE ")
+                }.map {
+                    VcsUtil.getFilePath(vcsRoot, GitUtil.unescapePath(it))
+                }
+            }
+        }.flatten()
+    }
+
+    @Throws(VcsException::class)
+    private fun <T> GitCommandResult.mapOrThrow(mapper: (List<String>) -> T): T {
+        throwOnError()
+
+        return mapper(output)
+    }
+}
diff --git a/src/main/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/SkippedWorktreeChangesViewModifier.kt b/src/main/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/SkippedWorktreeChangesViewModifier.kt
@@ -0,0 +1,30 @@
+package com.github.monosoul.git.updateindex.extended.changes.view
+
+import com.github.monosoul.git.updateindex.extended.changes.view.Constants.PROPERTY
+import com.github.monosoul.git.updateindex.extended.logging.Slf4j
+import com.intellij.ide.util.PropertiesComponent
+import com.intellij.openapi.progress.ProgressManager
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vcs.changes.ChangesViewModifier
+import com.intellij.openapi.vcs.changes.ui.ChangesViewModelBuilder
+
+class SkippedWorktreeChangesViewModifier(private val project: Project) : ChangesViewModifier {
+
+    private val logger by Slf4j
+
+    override fun modifyTreeModelBuilder(modelBuilder: ChangesViewModelBuilder) {
+        val showSkippedTree = PropertiesComponent.getInstance().getBoolean(PROPERTY, false)
+        if (!showSkippedTree) {
+            logger.debug("Show skipped files is turned off. Doing nothing.")
+            return
+        }
+
+        val skippedFiles = ProgressManager.getInstance().run(GetSkippedWorktreeFilesTask(project))
+
+        logger.debug("Skipped files: {}", skippedFiles)
+
+        val rootNode = ChangesBrowserSkippedWorktreeNode(project, skippedFiles)
+        modelBuilder.insertSubtreeRoot(rootNode)
+        modelBuilder.insertFilesIntoNode(skippedFiles.mapNotNull { it.virtualFile }, rootNode)
+    }
+}
diff --git a/src/main/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/ToggleSkippedWorktreeAction.kt b/src/main/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/ToggleSkippedWorktreeAction.kt
@@ -0,0 +1,42 @@
+package com.github.monosoul.git.updateindex.extended.changes.view
+
+import com.github.monosoul.git.updateindex.extended.changes.view.Constants.PROPERTY
+import com.github.monosoul.git.updateindex.extended.logging.Slf4j
+import com.github.monosoul.git.updateindex.extended.support.PresentationUpdater
+import com.intellij.ide.util.PropertiesComponent
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.actionSystem.Presentation
+import com.intellij.openapi.actionSystem.ToggleAction
+import com.intellij.openapi.project.Project
+import com.intellij.openapi.vcs.changes.ChangesViewManager
+
+class ToggleSkippedWorktreeAction : ToggleAction() {
+
+    private val logger by Slf4j
+
+    override fun update(event: AnActionEvent) {
+        super.update(event)
+        event.run {
+            project?.updatePresentation(presentation)
+        }
+    }
+
+    override fun isSelected(event: AnActionEvent): Boolean {
+        return PropertiesComponent.getInstance().getBoolean(PROPERTY, false).also {
+            logger.debug("Get property value: {}", it)
+        }
+    }
+
+    override fun setSelected(event: AnActionEvent, state: Boolean) {
+        PropertiesComponent.getInstance().setValue(PROPERTY, state)
+        logger.debug("Set property value: {}", state)
+        val project = event.project ?: return
+
+        ChangesViewManager.getInstanceEx(project).refreshImmediately()
+    }
+
+    private fun Project.updatePresentation(presentation: Presentation) {
+        logger.debug("Updating presentation")
+        getService(PresentationUpdater::class.java)?.invoke(presentation)
+    }
+}
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
@@ -55,12 +55,15 @@
     <depends>Git4Idea</depends>
 
     <extensions defaultExtensionNs="com.intellij">
-        <projectService serviceImplementation="com.github.monosoul.git.updateindex.extended.GitLineHandlerFactory"/>
+        <projectService serviceImplementation="com.github.monosoul.git.updateindex.extended.UpdateIndexLineHandlerFactory"/>
 
         <projectService serviceImplementation="com.github.monosoul.git.updateindex.extended.support.CommandInvoker"/>
 
         <projectService
                 serviceImplementation="com.github.monosoul.git.updateindex.extended.support.PresentationUpdater"/>
+
+        <vcs.changes.changesViewModifier
+                implementation="com.github.monosoul.git.updateindex.extended.changes.view.SkippedWorktreeChangesViewModifier"/>
     </extensions>
 
     <actions>
@@ -84,6 +87,12 @@
                     description="Mark file as not executable (chmod -x)"/>
             <add-to-group group-id="Git.ContextMenu" anchor="last"/>
         </group>
+        <action id="monosoul.Git.UpdateIndex.Extended.ToggleSkippedWorktreeAction"
+                class="com.github.monosoul.git.updateindex.extended.changes.view.ToggleSkippedWorktreeAction"
+                text="Show Skipped Worktree"
+                description="Show files that were marked to skip worktree">
+            <add-to-group group-id="ChangesView.ViewOptions" anchor="last"/>
+        </action>
     </actions>
 
 </idea-plugin>
diff --git a/src/test/kotlin/com/github/monosoul/git/updateindex/extended/ExtendedUpdateIndexTaskTest.kt b/src/test/kotlin/com/github/monosoul/git/updateindex/extended/ExtendedUpdateIndexTaskTest.kt
@@ -55,7 +55,7 @@ internal class ExtendedUpdateIndexTaskTest {
     private lateinit var dirtyScopeManager: VcsDirtyScopeManager
 
     @MockK
-    private lateinit var gitLineHandlerFactory: GitLineHandlerFactory
+    private lateinit var updateIndexLineHandlerFactory: UpdateIndexLineHandlerFactory
 
     @MockK
     private lateinit var gitLineHandler: GitLineHandler
@@ -74,11 +74,11 @@ internal class ExtendedUpdateIndexTaskTest {
         project = MockProject(null, parent)
         project.registerService(vcsManager, parent)
         project.registerService(dirtyScopeManager, parent)
-        project.registerService(gitLineHandlerFactory, parent)
+        project.registerService(updateIndexLineHandlerFactory, parent)
 
         appender = mockedAppender<ExtendedUpdateIndexTask>()
 
-        every { gitLineHandlerFactory.invoke(any(), any(), any()) } returns gitLineHandler
+        every { updateIndexLineHandlerFactory.invoke(any(), any(), any()) } returns gitLineHandler
         every { git.runCommand(any<GitLineHandler>()) } returns gitCommandResult
     }
 
@@ -103,7 +103,7 @@ internal class ExtendedUpdateIndexTaskTest {
         }
         verifyAll {
             git wasNot Called
-            gitLineHandlerFactory wasNot Called
+            updateIndexLineHandlerFactory wasNot Called
             gitLineHandler wasNot Called
             dirtyScopeManager wasNot Called
         }
@@ -128,7 +128,7 @@ internal class ExtendedUpdateIndexTaskTest {
             vcsManager.getVcsRootFor(any<VirtualFile>())
         }
         verifyOrder {
-            gitLineHandlerFactory.invoke(command, root, withArg {
+            updateIndexLineHandlerFactory.invoke(command, root, withArg {
                 expectThat(it) containsExactlyInAnyOrder files
             })
             git.runCommand(gitLineHandler)
@@ -159,7 +159,7 @@ internal class ExtendedUpdateIndexTaskTest {
             vcsManager.getVcsRootFor(any<VirtualFile>())
         }
         verifyOrder {
-            gitLineHandlerFactory.invoke(command, root, withArg {
+            updateIndexLineHandlerFactory.invoke(command, root, withArg {
                 expectThat(it) containsExactlyInAnyOrder files
             })
             git.runCommand(gitLineHandler)
diff --git a/src/test/kotlin/com/github/monosoul/git/updateindex/extended/UpdateIndexLineHandlerFactoryTest.kt b/src/test/kotlin/com/github/monosoul/git/updateindex/extended/UpdateIndexLineHandlerFactoryTest.kt
@@ -27,7 +27,7 @@ import java.util.stream.Stream.generate
 import kotlin.streams.toList
 
 @ExtendWith(MockKExtension::class)
-internal class GitLineHandlerFactoryTest {
+internal class UpdateIndexLineHandlerFactoryTest {
 
     private companion object {
         val CAN_NOT_OVERRIDE_GIT_CONFIG_FOR_COMMAND = GitVersion(1, 7, 1, 0)
@@ -82,7 +82,7 @@ internal class GitLineHandlerFactoryTest {
     fun `should build a GitLineHandler with supplied command and files`() {
         val (vcsRoot, files) = vcsRootToFileListPair()
 
-        val actual = GitLineHandlerFactory(project).invoke(updateIndexCommand, vcsRoot, files)
+        val actual = UpdateIndexLineHandlerFactory(project).invoke(updateIndexCommand, vcsRoot, files)
         val expected = buildExpected(updateIndexCommand, files)
 
         expectThat(actual) {
diff --git a/src/test/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/ChangesBrowserSkippedWorktreeNodeTest.kt b/src/test/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/ChangesBrowserSkippedWorktreeNodeTest.kt
@@ -0,0 +1,44 @@
+package com.github.monosoul.git.updateindex.extended.changes.view
+
+import com.github.monosoul.git.updateindex.extended.TestDisposable
+import com.intellij.mock.MockApplication
+import com.intellij.mock.MockProject
+import com.intellij.openapi.application.ApplicationManager
+import com.intellij.openapi.util.Disposer.dispose
+import io.mockk.junit5.MockKExtension
+import org.junit.jupiter.api.AfterEach
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.extension.ExtendWith
+import strikt.api.expectThat
+import strikt.assertions.isEqualTo
+
+@ExtendWith(MockKExtension::class)
+internal class ChangesBrowserSkippedWorktreeNodeTest {
+
+    private lateinit var parent: TestDisposable
+    private lateinit var application: MockApplication
+    private lateinit var project: MockProject
+
+    @BeforeEach
+    fun setUp() {
+        parent = TestDisposable()
+
+        application = MockApplication(parent)
+        ApplicationManager.setApplication(application, parent)
+
+        project = MockProject(null, parent)
+    }
+
+    @AfterEach
+    fun tearDown() {
+        dispose(parent)
+    }
+
+    @Test
+    fun `getTextPresentation method should delegate the call to string representation of user object`() {
+        val actual = ChangesBrowserSkippedWorktreeNode(project, emptyList()).textPresentation
+
+        expectThat(actual) isEqualTo "Skipped Worktree"
+    }
+}
diff --git a/src/test/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/GetSkippedWorktreeFilesTaskTest.kt b/src/test/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/GetSkippedWorktreeFilesTaskTest.kt
diff --git a/src/test/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/SkippedWorktreeChangesViewModifierTest.kt b/src/test/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/SkippedWorktreeChangesViewModifierTest.kt
diff --git a/src/test/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/ToggleSkippedWorktreeActionTest.kt b/src/test/kotlin/com/github/monosoul/git/updateindex/extended/changes/view/ToggleSkippedWorktreeActionTest.kt
