Initial release with test (#1)

* Finalised user API for initial release

Author: PyDataBlog

.github/workflows/CI.yml

@@ -19,7 +19,6 @@ jobs:
           - windows-latest
         arch:
           - x64
-          - x86
         exclude:
           - os: macOS-latest
             arch: x86

src/InstaRound.jl

@@ -1,5 +1,15 @@
 module InstaRound
 
 # Write your package code here.
+import Base: round
+
+
+include("custom.jl")
+include("utils.jl")
+
+
+####### Globals Exports #######
+export round, IGRound
+
 
 end

src/custom.jl

@@ -0,0 +1,6 @@
+"""
+    IGRound
+
+Abstract base type for dispatched InstaRound rounds.
+"""
+abstract type IGRound end

src/utils.jl

@@ -0,0 +1,60 @@
+"""
+    business_round(num)
+
+Internal function to round a number to the nearest IG style.
+"""
+function business_round(num)
+    if num < 10^3
+        return string(num)
+    elseif num < 10^4
+        return string(string(num)[1], "K")
+    elseif num < 10^5
+        return string(string(num)[1:2], "K")
+    elseif num < 10^6
+        return string(string(num)[1:3], "K")
+    elseif num < 10^7
+        return string(string(num)[1], "M")
+    elseif num < 10^8
+        return string(string(num)[1:2], "M")
+    elseif num < 10^9
+        return string(string(num)[1:3], "M")
+    elseif num < 10^10
+        return string(string(num)[1], "B")
+    elseif num < 10^11
+        return string(string(num)[1:2], "B")
+    elseif num < 10^12
+        return string(string(num)[1:3], "B")
+    elseif num < 10^13
+        return string(string(num)[1], "T")
+    elseif num < 10^14
+        return string(string(num)[1:2], "T")
+    elseif num < 10^15
+        return string(string(num)[1:3], "T")
+    elseif num < 10^16
+        return string(string(num)[1], "Q")
+    elseif num < 10^17
+        return string(string(num)[1:2], "Q")
+    elseif num < 10^18
+        return string(string(num)[1:3], "Q")
+    end
+end
+
+
+"""
+    round(::Type{IGRound}, x::Number)
+
+Main function to round a number x to the nearest IG style.
+
+# Arguments
+ * x: The number to round.
+
+```
+# Example
+julia> round(IGRound, 100_000)
+"100K"
+```
+"""
+function round(::Type{IGRound}, x::Number)
+    init_round = Base.round(Int, x)
+    return init_round |> business_round
+end

test/runtests.jl

@@ -2,5 +2,20 @@ using InstaRound
 using Test
 
 @testset "InstaRound.jl" begin
-    # Write your tests here.
+    @test round(IGRound, 999) == "999"
+    @test round(IGRound, 1_000) == "1K"
+    @test round(IGRound, 10_000) == "10K"
+    @test round(IGRound, 100_000) == "100K"
+    @test round(IGRound, 1_000_000) == "1M"
+    @test round(IGRound, 10_000_000) == "10M"
+    @test round(IGRound, 100_000_000) == "100M"
+    @test round(IGRound, 1_000_000_000) == "1B"
+    @test round(IGRound, 10_000_000_000) == "10B"
+    @test round(IGRound, 100_000_000_000) == "100B"
+    @test round(IGRound, 1_000_000_000_000) == "1T"
+    @test round(IGRound, 10_000_000_000_000) == "10T"
+    @test round(IGRound, 100_000_000_000_000) == "100T"
+    @test round(IGRound, 1_000_000_000_000_000) == "1Q"
+    @test round(IGRound, 10_000_000_000_000_000) == "10Q"
+    @test round(IGRound, 100_000_000_000_000_000) == "100Q"
 end