Tasks archiving support in CHelper style #135

AntKirill · 2021-09-07T21:43:51Z

An attempt to support the feature Archive any task #120 in a different way than in PR.

The idea is to avoid a mess in RCs when working on a large number of tasks.
For example:

Features:

Allows archiving either a single file with a task or a directory with possibly many nested directories which contain tasks
Archives only those files for which there exist JHelper run configurations. All the other files are silently ignored
Acts independently of the currently selected run configuration, it works with selected file or directory exclusively
Tasks with the same names are not mixed up in the archive as the date and time of archiving is appended to the name of the archived file and RC. When tasks are restored all their names are restored either
Removes run configurations for all archived tasks
Allows configuring archive directory
Restores all tasks to their former places independently of the archive's folder place
Restores all run configurations including default and custom tests for tasks
Restores only the tasks for which there exist archived run configurations. All the other files are silently ignored

AlexeyDmitriev · 2021-09-07T23:23:01Z

Thanks for your interest and for the PR.
It's pretty big, so I'll need to read it thoughtfully and I'm not really sure I'll have time for that soon. Sorry for that.

AlexeyDmitriev · 2021-09-07T23:51:09Z

resources/META-INF/plugin.xml

+                text="Restore Tasks"
+                icon="/name/admitriev/jhelper/icons/unarchive.png"
+                description="Restore directory with tasks or a single task back to the former place">
+            <add-to-group group-id="ProjectViewPopupMenu" anchor="first"/>


Is is possible to add it to menu only for files for which it make sense (e.g cpp&xml & directories)? and ideally only inside project that work with JHelper

I thought about it, but it puts a big overhead if we recursively check all the directories and inner files on every menu popup opening. To optimize, we can mark parent directories after the creation of a new JHelper config or a newly archived file, but that looks a bit complicated for now :) What do you think?

As a workaround, we can remove those buttons from the popup menu completely (a user can add them there manually anyway) and have them available via Ctrl+Shift+A

P.S. Thanks a lot for the very quick reply and for the awesome JHeleper plugin!!

I probably would not check recursively, but I'd only add it for cpp&xml files and for directories (if that's possible). Others are guaranteed to not do anything.

Also, I think that adding it to the first position in the menu may be a little to aggressive and we should add it a bit lower.

Workaround you mentioned is always an option, it's what is done with other actions anyway

AlexeyDmitriev · 2021-09-07T23:54:48Z

src/name/admitriev/jhelper/actions/ArchiveTaskAction.java

+            } catch (IOException ex) {
+                throw new NotificationException("Unable to create archive directory", "Root of archive directory does not exist and failed to be created");
+            }
+            VfsUtilCore.visitChildrenRecursively(selectedFile, new VirtualFileVisitor<>() {


Will it work ok if there are symlinks inside the directory? If there's a symlink to somewhere out of project, e.g /, will it be able to wipe all my cpp's ? What about recursive symlinks?

AlexeyDmitriev · 2021-09-08T00:02:22Z

src/name/admitriev/jhelper/actions/ArchiveTaskAction.java

+                }
+            });
+            if (archivedCount > 0) {
+                LocalFileSystem.getInstance().refresh(true); // to notify Vfs about new files created in archive


should we notify fs if something was created even if there was exception in the middle?

AlexeyDmitriev · 2021-09-08T00:04:44Z

src/name/admitriev/jhelper/actions/ArchiveTaskAction.java

+                        "All tasks in " + selectedFile.getName() + " were successfully archived",
+                        NotificationType.INFORMATION
+                );
+                DeleteTaskAction.selectSomeTaskConfiguration(RunManagerEx.getInstanceEx(project));


It's strange that we are going to different action here. Probably need to extract this soewhere. IDEUtils maybe

AlexeyDmitriev · 2021-09-08T00:16:33Z

src/name/admitriev/jhelper/ui/ConfigurationDialog.java

@@ -40,6 +41,11 @@ public ConfigurationDialog(@NotNull Project project, Configurator.State configur
 				configuration.getRunFile(),
 				RelativeFileChooserDescriptor.fileChooser(project.getBaseDir())
 		);
+		archiveDirectory = new FileSelector(


Maybe it makes sense to store/find absolute path here?
Archived files do not really "participate" in the project anyway, and it'll allow less concatentation back and forth. (and it'll require less changes when they finally remove project.getBaseDir())

On the other hand it will make it less consistent and also make it harder to move th project across the FS.

What do you think?

Interesting, perhaps we can try to support both options by giving a special configuration item for the archive directory? It could look somehow like CardLayout component in swing. I can try to add this

Not sure it's worth to support 2 options.
Do you know how CLion/IDEA handle paths themselves?

AlexeyDmitriev · 2021-09-08T00:22:37Z

src/name/admitriev/jhelper/configuration/TaskConfiguration.java

@@ -166,6 +167,7 @@ private static Test readTest(Element element) {

 	@Override
 	public void writeExternal(Element element) {
+		element.setAttribute("name", getName());


My understanding is that name is already saved automatically. Can you please explain a bit more how it's used?

<component name="ProjectRunConfigurationManager"> <configuration default="false" name="A1: Consistency - Chapter 1" type="name.admitriev.jhelper.configuration.TaskConfigurationType" className="A1ConsistencyChapter1" cppPath="tasks/A1ConsistencyChapter1.cpp" inputType="LOCAL_REGEXP" inputFile="consistency_chapter_.*input[.]txt" outputType="CUSTOM" outputFile="consistency_chapter__output.txt" testType="MULTI_NUMBER"> <tests> <test input="6
ABC
F
BANANA
FBHC
FOXEN
CONSISTENCY
" output="Case #1: 2
Case #2: 0
Case #3: 3
Case #4: 4
Case #5: 5
Case #6: 12
" active="true" /> </tests> <method v="2" /> </configuration> </component>```

AlexeyDmitriev · 2021-09-08T00:27:46Z

src/name/admitriev/jhelper/actions/UnarchiveTaskAction.java

+                    return false;
+                }
+            });
+            UIUtils.openMethodInEditor(project, (OCFile) Objects.requireNonNull(PsiManager.getInstance(project).findFile(lastGeneratedFile)), "solve");


It's probably not wise to throw here if there's no solve method

AlexeyDmitriev · 2021-09-08T00:31:18Z

src/name/admitriev/jhelper/actions/ArchiveTaskAction.java

+        private void saveRCToArchive(TaskConfiguration taskConfiguration, VirtualFile directoryInArchiveForTheTask, String archiveRCFileName) {
+            try {
+                String rcArchiveFqn = directoryInArchiveForTheTask.getPath() + "/" + archiveRCFileName;
+                Element rc = new Element("RC");


It looks like here we do something very similar to what IDE does for us when saving configurations(in .idea/runConfigurations/). Maybe it's possible and makes sense to reuse it somehow?

I'd spell RC fully in the XML

Yes, I tried to do this via their API, but it is not obvious how to make the platform "forget" about the RC stored in a separate file before deleting them. They have a handy method for that in platform com.intellij.execution.impl.RunManagerImpl#removeConfigurations$intellij_platform_execution_impl but it is private.

Alternatively, we can get a path to the file where our configuration is currently stored and just copy the file back and forth. But that seems to be worse since the platform may update the place where RCs are stored in the future and that will break restoring.

Do you see any other options to reuse the platform?

I agree about the spelling, I will fix it

rishabhdeepsingh · 2021-10-15T15:27:26Z

Oh wow, This is actually better than my implementation.
Also Clion 2021.2.3 is also released, can you test on that as well?

AntKirill added 5 commits September 7, 2021 23:49

add name of the task to external element

09d7fde

refactoring - change select configuration method to public

64ddd87

add archive directory setting to configs

5b1e735

add icons for archiving

fa95743

add actions for archiving

146f243

AlexeyDmitriev reviewed Sep 7, 2021

View reviewed changes

AlexeyDmitriev reviewed Sep 8, 2021

View reviewed changes

AlexeyDmitriev mentioned this pull request Sep 8, 2021

Exception while parsing tasks of a contest #133

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tasks archiving support in CHelper style #135

Tasks archiving support in CHelper style #135

AntKirill commented Sep 7, 2021

AlexeyDmitriev commented Sep 7, 2021

AlexeyDmitriev Sep 7, 2021

AntKirill Sep 8, 2021

AlexeyDmitriev Sep 8, 2021

AlexeyDmitriev Sep 7, 2021

AlexeyDmitriev Sep 8, 2021

AlexeyDmitriev Sep 8, 2021

AlexeyDmitriev Sep 8, 2021

AntKirill Sep 8, 2021

AlexeyDmitriev Sep 8, 2021

AlexeyDmitriev Sep 8, 2021

AlexeyDmitriev Sep 8, 2021

AlexeyDmitriev Sep 8, 2021

AlexeyDmitriev Sep 8, 2021

AntKirill Sep 8, 2021

rishabhdeepsingh commented Oct 15, 2021 •

edited

Loading

Tasks archiving support in CHelper style #135

Are you sure you want to change the base?

Tasks archiving support in CHelper style #135

Conversation

AntKirill commented Sep 7, 2021

AlexeyDmitriev commented Sep 7, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rishabhdeepsingh commented Oct 15, 2021 • edited Loading

rishabhdeepsingh commented Oct 15, 2021 •

edited

Loading