Add done!

.github/workflows/CI.yml

@@ -22,6 +22,7 @@ jobs:
           - '1.6'
           - '1.7'
           - '1.8'
+          - '1.9'
           - 'nightly'
         os:
           - ubuntu-latest

Project.toml

@@ -1,10 +1,11 @@
 name = "PSRProgressBar"
 uuid = "e78ae4d9-7c0a-4397-83ad-465eb5391708"
-version = "0.1.0"
+version = "0.1.1"
 
 [deps]
 
 [compat]
+Aqua = "0.6"
 julia = "1.6"
 
 [extras]

format/format.jl

@@ -0,0 +1,6 @@
+import Pkg
+Pkg.instantiate()
+
+using JuliaFormatter
+
+format(dirname(@__DIR__))

src/PSRProgressBar.jl

@@ -3,4 +3,4 @@ module PSRProgressBar
 include("progress_bar.jl")
 include("utils.jl")
 
-end # module PSRProgressBar
+end

src/progress_bar.jl

@@ -6,7 +6,6 @@ abstract type AbstractProgressBar end
 end
 
 Base.@kwdef mutable struct ProgressBar <: AbstractProgressBar
-
     maximum_steps::Int
     current_length::Int = 0
     current_steps::Int = 0
@@ -45,7 +44,6 @@ function _header(p::AbstractProgressBar)
     return nothing
 end
 
-
 function _footer(p::AbstractProgressBar)
     @assert p.has_finished
     if p.maximum_length > 2
@@ -59,8 +57,8 @@ end
 
 function _show_progress_bar(
     p::AbstractProgressBar,
-    l_text::String = "",
-    r_text::String = "",
+    l_text::AbstractString = "",
+    r_text::AbstractString = "",
 )
     if isempty(l_text)
         l_text = p.left_bar
@@ -110,9 +108,7 @@ function _show_progress_bar(
     return nothing
 end
 
-
-
-function next!(p::AbstractProgressBar, steps::Int = 1)
+function next!(p::AbstractProgressBar, steps::Integer = 1)
     if p.current_steps == 0
         p.start_time = time()
         p.time = time()
@@ -149,3 +145,8 @@ function next!(p::AbstractProgressBar, steps::Int = 1)
     p.time = time()
     return nothing
 end
+
+function done!(p::AbstractProgressBar)
+    next!(p, p.maximum_steps - p.current_steps)
+    return nothing
+end

src/utils.jl

@@ -1,4 +1,4 @@
-function _convert_time_unit(time::Float64)
+function _convert_time_unit(time::Real)
     t_unit = if time < 1.0
         time = round(Int, time * 1000.0)
         "ms"
@@ -15,13 +15,12 @@ function _convert_time_unit(time::Float64)
     return "$(time)$(t_unit)"
 end
 
-
-function _eta_text(p::AbstractProgressBar, new_length::Float64)
+function _eta_text(p::AbstractProgressBar, new_length::Real)
     if !p.has_eta
         return ""
     end
     if !p.eta_started
-        return  " ETA: --"
+        return " ETA: --"
     end
 
     s2 = p.maximum_steps - p.current_steps # remaining length
@@ -41,12 +40,11 @@ function _elapsed_text(p::AbstractProgressBar)
     return " Time: $(_convert_time_unit(elapsed))"
 end
 
-function _percentage_text(p::AbstractProgressBar, frac::Float64)
+function _percentage_text(p::AbstractProgressBar, frac::Real)
     percentage = floor(Int, frac * 100)
     percentage_text = (" "^(4 - length("$percentage"))) * "$percentage" # percentage text should always have length 5 ( 1 for spacing + xxx%)
     if p.has_percentage && p.display == ITERATIVE
         return percentage_text * "%"
     end
     return " "^5
 end
-

test/runtests.jl

@@ -50,7 +50,7 @@ function test_length()
         end
     end
     @test p_incremental.current_ticks == p_iterative.current_ticks
-    @test p_incremental.current_ticks == p_incremental.maximum_length-2
+    @test p_incremental.current_ticks == p_incremental.maximum_length - 2
 
     last_stage = 104
     first_stage = 1
@@ -75,7 +75,7 @@ function test_length()
         end
     end
     @test p_incremental.current_ticks == p_iterative.current_ticks
-    @test p_incremental.current_ticks == p_incremental.maximum_length-2
+    @test p_incremental.current_ticks == p_incremental.maximum_length - 2
 
 end