reorganize tests - hard Sixel dependency - format check

Author: t-bltg

.JuliaFormatter.toml

@@ -0,0 +1,8 @@
+style = "blue"
+short_to_long_function_def = false
+always_use_return = false
+import_to_using = false
+align_struct_field = true
+align_conditional = true
+align_assignment = true
+align_pair_arrow = true

.github/workflows/format-check.yml

@@ -0,0 +1,39 @@
+name: format-check
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'release-'
+    tags: '*'
+  pull_request:
+
+jobs:
+  check:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        julia-version: ['1']
+        julia-arch: [x64]
+        os: [ubuntu-latest]
+    steps:
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.julia-version }}
+
+      - uses: actions/checkout@v3
+      - name: Install JuliaFormatter and format
+        run: |
+          julia -e 'using Pkg; Pkg.add(PackageSpec(name="JuliaFormatter"))'
+          julia -e 'using JuliaFormatter; format(["src", "test"], verbose=true)'
+      - name: Format check
+        run: |
+          julia -e '
+          out = Cmd(`git diff --name-only`) |> read |> String
+          if out == ""
+              exit(0)
+          else
+              @error "Some files have not been formatted !!!"
+              write(stdout, out)
+              exit(1)
+          end'

AsciiPixel/src/ascii.jl

@@ -1,12 +1,12 @@
 abstract type ImageEncoder end
 struct BigBlocks <: ImageEncoder
-    size::NTuple{2, Int}
+    size::NTuple{2,Int}
 end
 struct SmallBlocks <: ImageEncoder
-    size::NTuple{2, Int}
+    size::NTuple{2,Int}
 end
 
-const RESET = Crayon(reset = true)
+const RESET = Crayon(; reset=true)
 const alpha_chars = ('⋅', '░', '▒', '▓', '█')
 
 function _charof(alpha)
@@ -91,22 +91,22 @@ function ascii_encode(
     ::SmallBlocks,
     colordepth::TermColorDepth,
     img::AbstractMatrix{<:Colorant};
-    trail_nl::Bool = false,
-    ret::Bool = false
+    trail_nl::Bool=false,
+    ret::Bool=false,
 )
     yinds, xinds = axes(img)
     for y in first(yinds):2:last(yinds)
         _printc(io, RESET)
         for x in xinds
             fgcol = _colorant2ansi(img[y, x], colordepth)
-            bgcol = if y+1 <= last(yinds)
-                _colorant2ansi(img[y+1, x], colordepth)
+            bgcol = if y + 1 <= last(yinds)
+                _colorant2ansi(img[y + 1, x], colordepth)
             else
                 # if reached it means that the last character row
                 # has only the upper pixel defined.
                 nothing
             end
-            _printc(io, Crayon(foreground=fgcol, background=bgcol), "▀")
+            _printc(io, Crayon(; foreground=fgcol, background=bgcol), "▀")
         end
         _printc(io, RESET)
         (trail_nl || y < last(yinds)) && println(io)
@@ -119,8 +119,8 @@ function ascii_encode(
     ::BigBlocks,
     colordepth::TermColorDepth,
     img::AbstractMatrix{<:Colorant};
-    trail_nl::Bool = false,
-    ret::Bool = false,
+    trail_nl::Bool=false,
+    ret::Bool=false,
 )
     yinds, xinds = axes(img)
     for y in yinds
@@ -129,7 +129,7 @@ function ascii_encode(
             color = img[y, x]
             fgcol = _colorant2ansi(color, colordepth)
             chr = _charof(alpha(color))
-            _printc(io, Crayon(foreground = fgcol), chr, chr)
+            _printc(io, Crayon(; foreground=fgcol), chr, chr)
         end
         _printc(io, RESET)
         (trail_nl || y < last(yinds)) && println(io)
@@ -142,15 +142,15 @@ function ascii_encode(
     ::SmallBlocks,
     colordepth::TermColorDepth,
     img::AbstractVector{<:Colorant};
-    trail_nl::Bool = false,
-    ret::Bool = false
+    trail_nl::Bool=false,
+    ret::Bool=false,
 )
     _printc(io, RESET)
     for i in axes(img, 1)
         color = img[i]
         fgcol = _colorant2ansi(color, colordepth)
         chr = _charof(alpha(color))
-        _printc(io, Crayon(foreground = fgcol), chr)
+        _printc(io, Crayon(; foreground=fgcol), chr)
     end
     _printc(io, RESET)
     trail_nl && println(io)
@@ -162,26 +162,26 @@ function ascii_encode(
     enc::BigBlocks,
     colordepth::TermColorDepth,
     img::AbstractVector{<:Colorant};
-    trail_nl::Bool = false,
-    ret::Bool = false
+    trail_nl::Bool=false,
+    ret::Bool=false,
 )
     w = length(img)
     n = enc.size[2] ÷ 3 == w ? w : enc.size[2] ÷ 6
     # left or full
     _printc(io, RESET)
-    for i in (0:n-1) .+ firstindex(img)
+    for i in (0:(n - 1)) .+ firstindex(img)
         color = img[i]
         fgcol = _colorant2ansi(color, colordepth)
         chr = _charof(alpha(color))
-        _printc(io, Crayon(foreground = fgcol), chr, chr, " ")
+        _printc(io, Crayon(; foreground=fgcol), chr, chr, " ")
     end
     if n < w  # right part
         _printc(io, RESET, " … ")
-        for i in (-n+1:0) .+ lastindex(img)
+        for i in ((-n + 1):0) .+ lastindex(img)
             color = img[i]
             fgcol = _colorant2ansi(color, colordepth)
             chr = _charof(alpha(color))
-            _printc(io, Crayon(foreground = fgcol), chr, chr, " ")
+            _printc(io, Crayon(; foreground=fgcol), chr, chr, " ")
         end
     end
     _printc(io, RESET)
@@ -190,11 +190,9 @@ function ascii_encode(
 end
 
 # use a `PipeBuffer` as io and returns encoded data reading lines of this buffer (using `readlines(io)`)
-ascii_encode(enc::SmallBlocks, args...) =
-    ascii_encode(PipeBuffer(), enc, args...; ret=true)
+ascii_encode(enc::SmallBlocks, args...) = ascii_encode(PipeBuffer(), enc, args...; ret=true)
 
-ascii_encode(enc::BigBlocks, args...) =
-    ascii_encode(PipeBuffer(), enc, args...; ret=true)
+ascii_encode(enc::BigBlocks, args...) = ascii_encode(PipeBuffer(), enc, args...; ret=true)
 
 """
     ascii_display([stream], img, [depth::TermColorDepth], [maxsize])
@@ -214,8 +212,8 @@ function ascii_display(
     io::IO,
     img::AbstractMatrix{<:Colorant},
     colordepth::TermColorDepth,
-    maxsize::Tuple = displaysize(io);
-    kwargs...
+    maxsize::Tuple=displaysize(io);
+    kwargs...,
 )
     io_h, io_w = maxsize
     img_h, img_w = map(length, axes(img))
@@ -229,8 +227,8 @@ function ascii_display(
     io::IO,
     img::AbstractVector{<:Colorant},
     colordepth::TermColorDepth,
-    maxsize::Tuple = displaysize(io);
-    kwargs...
+    maxsize::Tuple=displaysize(io);
+    kwargs...,
 )
     io_h, io_w = maxsize
     img_w = length(img)

AsciiPixel/src/colorant2ansi.jl

@@ -1,5 +1,5 @@
 abstract type TermColorDepth end
-struct TermColor8bit  <: TermColorDepth end
+struct TermColor8bit <: TermColorDepth end
 struct TermColor24bit <: TermColorDepth end
 
 """
@@ -36,23 +36,24 @@ _colorant2ansi(gr::TransparentColor, colordepth::TermColorDepth) =
 # 8bit (256) colors
 function _colorant2ansi(col::AbstractRGB, ::TermColor8bit)
     r, g, b = clamp01nan(red(col)), clamp01nan(green(col)), clamp01nan(blue(col))
-    r24, g24, b24 = map(c->round(Int, 23c), (r, g, b))
+    r24, g24, b24 = map(c -> round(Int, 23c), (r, g, b))
     if r24 == g24 == b24
         # Use grayscales because of higher resolution
         # This way even grayscale RGB images look good.
         232 + r24
     else
-        r6, g6, b6 = map(c->round(Int, 5c), (r, g, b))
+        r6, g6, b6 = map(c -> round(Int, 5c), (r, g, b))
         16 + 36r6 + 6g6 + b6
     end
 end
 
-_colorant2ansi(gr::Color{<:Any,1}, ::TermColor8bit) = round(Int, 232 + 23clamp01nan(real(gr)))
+_colorant2ansi(gr::Color{<:Any,1}, ::TermColor8bit) =
+    round(Int, 232 + 23clamp01nan(real(gr)))
 
 # 24 bit colors
 function _colorant2ansi(col::AbstractRGB, ::TermColor24bit)
     r, g, b = clamp01nan(red(col)), clamp01nan(green(col)), clamp01nan(blue(col))
-    map(c->round(Int, 255c), (r, g, b))
+    map(c -> round(Int, 255c), (r, g, b))
 end
 
 function _colorant2ansi(gr::Color{<:Any,1}, ::TermColor24bit)

AsciiPixel/test/common.jl

@@ -1,11 +1,13 @@
 # common test statements for ImageInTerminal and AsciiPixel
 
 # define some test images
-gray_square = colorview(Gray, N0f8[0. .3; .7 1])
-gray_square_alpha = colorview(GrayA, N0f8[0. .3; .7 1], N0f8[1 .7; .3 0])
-gray_line = colorview(Gray, N0f8[0., .3, .7, 1])
-gray_line_alpha = colorview(GrayA, N0f8[0., .3, .7, 1], N0f8[1, .7, .3, 0])
-rgb_line = colorview(RGB, range(0, stop=1, length=20), zeroarray, range(1, stop=0, length=20))
+gray_square = colorview(Gray, N0f8[0.0 0.3; 0.7 1])
+gray_square_alpha = colorview(GrayA, N0f8[0.0 0.3; 0.7 1], N0f8[1 0.7; 0.3 0])
+gray_line = colorview(Gray, N0f8[0.0, 0.3, 0.7, 1])
+gray_line_alpha = colorview(GrayA, N0f8[0.0, 0.3, 0.7, 1], N0f8[1, 0.7, 0.3, 0])
+rgb_line = colorview(
+    RGB, range(0; stop=1, length=20), zeroarray, range(1; stop=0, length=20)
+)
 rgb_line_4d = repeat(repeat(rgb_line', 1, 1, 1, 1), 1, 1, 2, 2)
 
 camera_man = testimage("camera")  # .tif

AsciiPixel/test/runtests.jl

@@ -15,10 +15,7 @@ function check_encoded(res::Vector{String}, expected::Vector{String})
     @test all(res .== expected)
 end
 
-for t in (
-    "tst_colorant2ansi.jl",
-    "tst_ascii.jl",
-)
+for t in ("tst_colorant2ansi.jl", "tst_ascii.jl")
     @testset "$t" begin
         include(t)
     end