Merge pull request #161 from ctongfei/0.10.1

0.10.1
ctongfei · Mar 24, 2024 · 4c80a7f · 4c80a7f
2 parents 5af6755 + 7ed2fa4
commit 4c80a7f
Show file tree

Hide file tree

Showing 7 changed files with 62 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,8 @@
 # Changelog
+ * `0.10.1`:
+     - Improvements:
+        - Changed the JPMS module dependency `org.jline` to a more fine-grained module `org.jline.terminal` (#158, PR #159). Thanks @brett-smith !
+        - Added a new builder method `setRenderer` to allow custom renderers (#157). Thanks @drothmaler !
  * `0.10.0`:
      - New functionalities:
         - Make `me.tongfei.progressbar` a Java 9 module (#149, #153, #154). Thanks @clo-vis, @Kamillaova, @bowbahdoe !

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015--2020 Tongfei Chen and contributors
+Copyright (c) 2015--2024 Tongfei Chen and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/docs/index.md b/docs/index.md
@@ -12,16 +12,18 @@ Depending on your build tool, add the following setting.
     <dependency>
         <groupId>me.tongfei</groupId>
         <artifactId>progressbar</artifactId>
-        <version>0.9.4</version>
+        <version>$VERSION</version>
     </dependency>
     ```
 
 === "Gradle"
 
     ``` groovy
-    compile 'me.tongfei:progressbar:0.9.4'
+    compile 'me.tongfei:progressbar:$VERSION'
     ```
 
+The newest `$VERSION` is [![Maven Central](https://img.shields.io/maven-central/v/me.tongfei/progressbar.svg?style=flat-square)](https://maven-badges.herokuapp.com/maven-central/me.tongfei/progressbar).
+
 #### Getting started
 
 ``` java

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,7 +1,7 @@
 site_name: 'Progressbar'
 site_description: 'A terminal progress bar for Java/JVM'
 site_author: 'Tongfei Chen'
-copyright: 'Copyright &copy; 2015-2023 Tongfei Chen and contributors'
+copyright: 'Copyright &copy; 2015-2024 Tongfei Chen and contributors'
 
 theme:
   name: 'material'
@@ -19,7 +19,9 @@ markdown_extensions:
       permalink: true
   - pymdownx.superfences
   - pymdownx.highlight
-  - pymdownx.tabbed
+  - pymdownx.tabbed:
+      alternate_style: true
+  - admonition
 
 repo_name: 'ctongfei/progressbar'
 repo_url: 'https://github.com/ctongfei/progressbar'
@@ -35,3 +37,5 @@ nav:
   - 'Kotlin extensions': 'kotlin.md'
   - 'Integrating with loggers': 'loggers.md'
   - 'Changelog': 'changelog.md'
+  - 'API Docs':
+       - 'index': 'dokka-javadoc/index.html'
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>me.tongfei</groupId>
     <artifactId>progressbar</artifactId>
-    <version>0.10.0</version>
+    <version>0.10.1</version>
     <name>progressbar</name>
     <description>A terminal-based progress bar for JVM</description>
     <url>http://github.com/ctongfei/progressbar</url>
@@ -129,13 +129,17 @@
             <id>PakhomovAlexander</id>
             <name>Aleksandr Pakhomov</name>
         </developer>
+        <developer>
+            <id>brett-smith</id>
+            <name>Brett Smith</name>
+        </developer>
     </developers>
 
     <dependencies>
         <dependency>
             <groupId>org.jline</groupId>
-            <artifactId>jline</artifactId>
-            <version>3.23.0</version>
+            <artifactId>jline-terminal</artifactId>
+            <version>3.24.1</version>
         </dependency>
 
         <dependency>
@@ -262,6 +266,28 @@
                     <useModulePath>false</useModulePath>  <!-- tests use classpath -->
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.jetbrains.dokka</groupId>
+                <artifactId>dokka-maven-plugin</artifactId>
+                <version>1.9.10</version>
+                <executions>
+                    <execution>
+                        <phase>pre-site</phase>
+                        <goals>
+                            <goal>dokka</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <dokkaPlugins>
+                        <plugin>
+                            <groupId>org.jetbrains.dokka</groupId>
+                            <artifactId>javadoc-plugin</artifactId>
+                            <version>1.9.10</version>
+                        </plugin>
+                    </dokkaPlugins>
+                </configuration>
+            </plugin>
 
         </plugins>
     </build>

diff --git a/src/main/java/me/tongfei/progressbar/ProgressBarBuilder.java b/src/main/java/me/tongfei/progressbar/ProgressBarBuilder.java
@@ -31,6 +31,8 @@ public class ProgressBarBuilder {
     private Duration elapsed = Duration.ZERO;
     private int maxRenderedLength = -1;
 
+    private ProgressBarRenderer renderer = null;
+
     public ProgressBarBuilder() { }
 
     public ProgressBarBuilder setTaskName(String task) {
@@ -83,6 +85,11 @@ public ProgressBarBuilder setMaxRenderedLength(int maxRenderedLength) {
         return this;
     }
 
+    public ProgressBarBuilder setRenderer(ProgressBarRenderer renderer) {
+        this.renderer = renderer;
+        return this;
+    }
+
     public ProgressBarBuilder showSpeed() {
         return showSpeed(new DecimalFormat("#.0"));
     }
@@ -129,11 +136,17 @@ public ProgressBar build() {
                 clearDisplayOnFinish,
                 processed,
                 elapsed,
-                new DefaultProgressBarRenderer(
-                        style, unitName, unitSize,
+                (renderer == null
+                        ? new DefaultProgressBarRenderer(
+                                style, unitName, unitSize,
                         showSpeed, speedFormat, speedUnit,
-                        !hideEta, eta),
-                consumer == null ? Util.createConsoleConsumer(maxRenderedLength) : consumer
+                        !hideEta, eta)
+                        : renderer
+                ),
+                (consumer == null
+                        ? Util.createConsoleConsumer(maxRenderedLength)
+                        : consumer
+                )
         );
     }
 }
diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java
@@ -1,4 +1,4 @@
 module me.tongfei.progressbar {
-    requires org.jline;
+    requires org.jline.terminal;
     exports me.tongfei.progressbar;
 }