devonfw#799: fix unzip with progressbar

refactoring of progressbar and changing expected result of IJ and AStudio plugin
hohwille · Dec 6, 2024 · 917254f · 917254f
1 parent d6c38c8
commit 917254f
Show file tree

Hide file tree

Showing 13 changed files with 226 additions and 139 deletions.
diff --git a/cli/src/main/java/com/devonfw/tools/ide/context/IdeContext.java b/cli/src/main/java/com/devonfw/tools/ide/context/IdeContext.java
@@ -399,13 +399,50 @@ default Path getSettingsTemplatePath() {
   ProcessContext newProcess();
 
   /**
-   * Prepares the {@link IdeProgressBar} initializes task name and maximum size as well as the behaviour and style.
-   *
-   * @param taskName name of the task.
-   * @param size of the content.
-   * @return {@link IdeProgressBar} to use.
+   * @param title the {@link IdeProgressBar#getTitle() title}.
+   * @param size the {@link IdeProgressBar#getMaxSize() expected maximum size}.
+   * @param unitName the {@link IdeProgressBar#getUnitName() unit name}.
+   * @param unitSize the {@link IdeProgressBar#getUnitSize() unit size}.
+   * @return the new {@link IdeProgressBar} to use.
+   */
+  IdeProgressBar newProgressBar(String title, long size, String unitName, long unitSize);
+
+  /**
+   * @param title the {@link IdeProgressBar#getTitle() title}.
+   * @param size the {@link IdeProgressBar#getMaxSize() expected maximum size} in bytes.
+   * @return the new {@link IdeProgressBar} to use.
    */
-  IdeProgressBar prepareProgressBar(String taskName, long size);
+  default IdeProgressBar newProgressBarInMib(String title, long size) {
+
+    return newProgressBar(title, size, "MiB", 1048576);
+  }
+
+  /**
+   * @param size the {@link IdeProgressBar#getMaxSize() expected maximum size} in bytes.
+   * @return the new {@link IdeProgressBar} for copy.
+   */
+  default IdeProgressBar newProgressBarForDownload(long size) {
+
+    return newProgressBarInMib(IdeProgressBar.TITLE_DOWNLOADING, size);
+  }
+
+  /**
+   * @param size the {@link IdeProgressBar#getMaxSize() expected maximum size} in bytes.
+   * @return the new {@link IdeProgressBar} for extracting.
+   */
+  default IdeProgressBar newProgressbarForExtracting(long size) {
+
+    return newProgressBarInMib(IdeProgressBar.TITLE_EXTRACTING, size);
+  }
+
+  /**
+   * @param size the {@link IdeProgressBar#getMaxSize() expected maximum size} in bytes.
+   * @return the new {@link IdeProgressBar} for copy.
+   */
+  default IdeProgressBar newProgressbarForCopying(long size) {
+
+    return newProgressBarInMib(IdeProgressBar.TITLE_COPYING, size);
+  }
 
   /**
    * @return the {@link DirectoryMerger} used to configure and merge the workspace for an {@link com.devonfw.tools.ide.tool.ide.IdeToolCommandlet IDE}.

diff --git a/cli/src/main/java/com/devonfw/tools/ide/context/IdeContextConsole.java b/cli/src/main/java/com/devonfw/tools/ide/context/IdeContextConsole.java
@@ -59,7 +59,8 @@ protected String readLine() {
   }
 
   @Override
-  public IdeProgressBar prepareProgressBar(String taskName, long size) {
-    return new IdeProgressBarConsole(getSystemInfo(), taskName, size);
+  public IdeProgressBar newProgressBar(String title, long size, String unitName, long unitSize) {
+
+    return new IdeProgressBarConsole(getSystemInfo(), title, size, unitName, unitSize);
   }
 }
diff --git a/cli/src/main/java/com/devonfw/tools/ide/io/AbstractIdeProgressBar.java b/cli/src/main/java/com/devonfw/tools/ide/io/AbstractIdeProgressBar.java
@@ -5,22 +5,59 @@
  */
 public abstract class AbstractIdeProgressBar implements IdeProgressBar {
 
-  private long currentProgress;
+  /** @see #getTitle() */
+  protected final String title;
+
+  /** @see #getMaxSize() */
+  protected final long maxSize;
+
+  /** @see #getUnitName() */
+  protected final String unitName;
 
-  private final long maxLength;
+  /** @see #getUnitSize() */
+  protected final long unitSize;
+
+  private long currentProgress;
 
   /**
-   * @param maxLength the maximum length of the progress bar.
+   * The constructor.
+   *
+   * @param title the {@link #getTitle() title}.
+   * @param maxSize the {@link #getMaxSize() maximum size}.
+   * @param unitName the {@link #getUnitName() unit name}.
+   * @param unitSize the {@link #getUnitSize() unit size}.
    */
-  public AbstractIdeProgressBar(long maxLength) {
+  public AbstractIdeProgressBar(String title, long maxSize, String unitName, long unitSize) {
+
+    super();
+    this.title = title;
+    this.maxSize = maxSize;
+    this.unitName = unitName;
+    this.unitSize = unitSize;
+  }
+
+  @Override
+  public String getTitle() {
+
+    return this.title;
+  }
+
+  @Override
+  public long getMaxSize() {
+
+    return this.maxSize;
+  }
+
+  @Override
+  public String getUnitName() {
 
-    this.maxLength = maxLength;
+    return this.unitName;
   }
 
   @Override
-  public long getMaxLength() {
+  public long getUnitSize() {
 
-    return maxLength;
+    return this.unitSize;
   }
 
   /**
@@ -38,8 +75,8 @@ public long getMaxLength() {
    */
   protected void stepTo(long stepPosition) {
 
-    if ((this.maxLength > 0) && (stepPosition > this.maxLength)) {
-      stepPosition = this.maxLength; // clip to max avoiding overflow
+    if ((this.maxSize > 0) && (stepPosition > this.maxSize)) {
+      stepPosition = this.maxSize; // clip to max avoiding overflow
     }
     this.currentProgress = stepPosition;
     doStepTo(stepPosition);
@@ -56,11 +93,11 @@ protected void stepTo(long stepPosition) {
   public void stepBy(long stepSize) {
 
     this.currentProgress += stepSize;
-    if (this.maxLength > 0) {
+    if (this.maxSize > 0) {
       // check if maximum overflow
-      if (this.currentProgress > this.maxLength) {
-        this.currentProgress = this.maxLength;
-        stepTo(this.maxLength);
+      if (this.currentProgress > this.maxSize) {
+        this.currentProgress = this.maxSize;
+        stepTo(this.maxSize);
         return;
       }
     }
@@ -76,12 +113,12 @@ public long getCurrentProgress() {
 
   @Override
   public void close() {
-    if (this.maxLength < 0) {
+    if (this.maxSize < 0) {
       return;
     }
 
-    if (this.currentProgress < this.maxLength) {
-      stepTo(this.maxLength);
+    if (this.currentProgress < this.maxSize) {
+      stepTo(this.maxSize);
     }
   }