Merge pull request #52 from Gabrielforest/master

Implement language support for Portuguese

Project.toml

@@ -1,7 +1,7 @@
 name = "SpelledOut"
 uuid = "4728c690-e668-4265-bc0d-51a8c0f93067"
 authors = ["Jake W. Ireland <[email protected]> and contributors"]
-version = "1.1.1"
+version = "1.2.0"
 
 [deps]
 DecFP = "55939f99-70c6-5e9b-8bb0-5071ed7d61fd"

docs/src/supported_languages.md

@@ -7,3 +7,7 @@ Current languages to choose from are:
       - `:en_UK` (aliases: `:en_GB`; equivalencies: `:en_NZ`, `:en_AU`)
     - Dictionaries supported include `:modern`, `:british`, and `:european`, and default to the former.
   - Spanish (`:es`)
+  - Portuguese 
+    - Variants
+      - (`:pt_BR`)
+      - (`:pt`)

src/SpelledOut.jl

@@ -1,12 +1,13 @@
 module SpelledOut
 
-using DecFP: Dec64
+using DecFP: Dec64, Dec128
 using Formatting: format
 
 export spelled_out, Spelled_out, Spelled_Out, SPELLED_OUT
 
 include("en.jl")
 include("es.jl")
+include("pt.jl")
 
 """
 ```julia
@@ -38,6 +39,12 @@ julia> spelled_out(112, lang = :en, dict = :european)
 
 julia> spelled_out(112, lang = :es)
 "ciento doce"
+
+julia> spelled_out(19, lang = :pt_BR)
+"dezenove"
+
+julia> spelled_out(19, lang = :pt)
+"dezanove"
 ```
 """
 function spelled_out(
@@ -51,7 +58,11 @@ function spelled_out(
     elseif lang ∈ (:en_UK, :en_GB, :en_NZ, :en_AU)
         return spelled_out_en(number, british = true, dict = dict)
     elseif lang ∈ (:es,)
-        return spelled_out_es(number,dict)
+        return spelled_out_es(number; dict = dict)
+    elseif lang ∈ (:pt_BR,)
+        return spelled_out_pt(number; portugal = false, dict = dict)
+    elseif lang ∈ (:pt,)
+        return spelled_out_pt(number; portugal = true, dict = dict)
     end
 
     throw(error("We do not support $lang yet.  Please make an issue and someone might be able to help you, or feel free to contribute."))

src/es.jl

@@ -1,15 +1,5 @@
 include(joinpath(@__DIR__, "es", "standard_es.jl"))
 
-#retuns a vector of ints, each of that 
-function split_numbers_10³(num::Integer)
-    digits(num,base=10^3) 
-end
-
-function split_numbers_10⁶(num::Integer)
-    digits(num,base=10^6) 
-end
-
-#function 
 function es_spell_1e3(number,short_one=false)
     if number <= 99 #0 - 99
         if number<30 #1 - 30
@@ -102,7 +92,7 @@ function es_spell_large(_number)
 end
 
 
-function spelled_out_es(number,dict=:standard)
+function spelled_out_es(number; dict=:standard)
     if iszero(number)
         return "cero"
     end

src/pt.jl

@@ -0,0 +1,158 @@
+include(joinpath(@__DIR__, "pt", "standard_pt_br.jl")) 
+include(joinpath(@__DIR__, "pt", "pt_pt.jl")) 
+
+## Implement Spelled Out for Brazilian Portuguese and Portugal Portuguese
+
+#retuns a vector of ints, each of that 
+function split_numbers_10³( num::Integer )
+    digits( num, base = 10^3)  
+end
+
+function split_numbers_10⁶( num::Integer )
+    digits( num, base = 10^6)  
+end
+
+#function
+function pt_spell_1e3( number; short_one = false, portugal::Bool = false )
+    if number <= 99 #0 - 99
+        if number < 20 #1 - 19
+            iszero( number ) && return ""
+            if isone( number ) && short_one
+                return "um"
+            elseif portugal
+                return pt_PT_1_a_19[ number ] 
+            else
+                return pt_BR_1_a_19[ number ] 
+            end  
+        else #20-99
+            unit, dec = digits( number )
+            if isone( unit ) && short_one
+                unit_text = " e um"
+            elseif iszero( unit )
+                unit_text = ""
+            elseif portugal
+                unit_text = " e " * pt_PT_1_a_19[ unit ]
+            else
+                unit_text = " e " * pt_BR_1_a_19[ unit ]
+            end
+            return pt_BR_dezenas[ dec ] * unit_text 
+        end
+    elseif number ∈ centenas_dicionario
+        unit, cent = digits( number, base = 100 )
+        unit_text = pt_spell_1e3( unit; short_one )
+        return pt_BR_centenas[ cent ]
+    elseif portugal == false & 100 <= number <= 999
+        number == 100 && return "cem" 
+        unit, cent = digits( number, base = 100 )
+        unit_text = pt_spell_1e3( unit; short_one )
+        return pt_BR_centenas[ cent ] * " e "  * unit_text
+    elseif portugal & 100 <= number <= 999
+        number == 100 && return "cem" 
+        unit, cent = digits( number, base = 100 )
+        unit_text = pt_spell_1e3( unit; short_one, portugal = portugal )
+        return pt_PT_centenas[ cent ] * " e "  * unit_text
+    end
+end
+
+function pt_spell_1e6( number; short_one = false, portugal::Bool = false )
+    number = Int( number )
+    number == 0 && return ""
+    number == 1000 && return "mil"
+    number <= 999 && return pt_spell_1e3( number; short_one = short_one, portugal = portugal )
+    low,high = digits( number, base = 1000 )
+    low_txt = pt_spell_1e3( low; short_one = short_one, portugal = portugal )
+    if high == 1
+        high_text = "mil e "
+    else
+        high_text = pt_spell_1e3( high; short_one = false, portugal = portugal ) * " mil"
+    end
+    return high_text * low_txt
+end
+
+#spells only decimals, including 0
+function pt_spell_decimal( number, partitive = true; portugal::Bool = false )
+    whole, decimal = split( string( number ), "." )
+    decnum, wholenum = abs.( modf( number ) )
+    decimal_length = length( decimal )
+    decint = decnum*10^decimal_length
+    if partitive
+        if decimal_length > 6
+            throw(error("""partitive pronunciation of Portuguese decimals is only supported to up to six decimals, the decimal part is $decimal .
+            If you want english-like decimals (zero ponto dois), try using partitive = false.
+            If the decimal part seems to differ from the perceived input number, try using big numbers: `big"123.23"`.
+            """))
+        end
+
+        dectext = pt_spell_1e6( Dec128( decint ); short_one = false, portugal = portugal )
+        res = strip( dectext ) * " " * pt_BR_decimais[ decimal_length ]
+        if decint != 1
+            res = res * "s"
+        end
+        return res
+    else
+        res =  digits( decint ) .|> z-> pt_spell_1e3( z; short_one = true, portugal = portugal ) .|> strip |> reverse |> z-> join( z," " )
+        res = "ponto " * res
+    end
+end
+
+function pt_spell_large_map( number, i; portugal::Bool = false )
+    if isone( i )
+        return pt_spell_1e6( number;  short_one = true, portugal = portugal )
+    elseif portugal == false & isone( number )
+        return "um " * pt_BR_multiplos_1e6_singular[ i - 1 ]
+    elseif portugal & isone( number )
+        return "um " * pt_PT_multiplos_1e6_singular[ i - 1 ]
+    else
+        return pt_spell_1e6( number;  short_one = false, portugal = portugal ) * " " * pt_PT_multiplos_1e6_plural[ i - 1 ]
+    end
+end
+
+function pt_spell_large( _number; portugal::Bool = false )
+    number = abs( _number ) 
+    list = digits( number, base = 1_000_000 )
+    if portugal
+        res = pt_spell_large_map.( list, 1:length( list ), portugal = portugal ) .|> strip |> reverse |> z-> join( z," " ) 
+        ( _number < 0 ) && ( res = "menos " * res )
+    else 
+        res = pt_spell_large_map.( list, 1:length( list ) ) .|> strip |> reverse |> z-> join( z," " ) 
+        ( _number < 0 ) && ( res = "menos " * res )
+    end
+    return res
+end
+
+function spelled_out_pt( number; portugal::Bool = false, dict::Symbol = :standard )
+    if iszero( number )
+        return "zero"
+    end
+    if isinteger( number )
+        if dict in ( :standard, :large, :modern )
+            res = pt_spell_large( number; portugal = portugal )
+        elseif dict in (:short,)
+            res = pt_spell_short( number; portugal = portugal )
+        else
+            throw( error( "unrecognized dict value: $dict" ) )
+        end
+        return res
+    else #with decimals
+        partitive = true
+        _dec, _int = modf( number )
+        _int = Dec128( _int )
+        if ( _int == 0 ) & !partitive
+            intres = "zero"
+
+        elseif ( _int == 0 ) & partitive
+            intres = ""
+        elseif dict in ( :standard, :large, :modern )
+            intres = pt_spell_large( _int; portugal = portugal ) * " con "
+        elseif dict in ( :short, )
+            intres = pt_spell_short( _int; portugal = portugal ) * " con "
+        else
+            throw( error( "unrecognized dict value: $dict" ) )
+        end
+
+        decres = pt_spell_decimal( abs( _dec ); portugal = portugal )
+        return intres * decres
+    end
+end
+
+

src/pt/pt_pt.jl

@@ -0,0 +1,82 @@
+const pt_PT_1_a_19 =[
+    "um"
+    "dois"
+    "três"
+    "quatro"
+    "cinco"
+    "seis"
+    "sete"
+    "oito"
+    "nove"
+    "dez"
+    "onze"
+    "doze"
+    "treze"
+    "catorze"
+    "quinze"
+    "dezasseis"
+    "dezassete"
+    "dezoito"
+    "dezanove"
+]
+
+const pt_PT_dezenas = [
+    ""
+    "vinte"
+    "trinta"
+    "quarenta"
+    "cinquenta"
+    "sessenta"
+    "setenta"
+    "oitenta"
+    "noventa"
+]
+
+const pt_PT_centenas = [
+    "cento"
+    "duzentos"
+    "trezentos"
+    "quatrocentos"
+    "quinhentos"
+    "seiscentos"
+    "setecentos"
+    "oitocentos"
+    "novecentos"
+] 
+
+const pt_PT_multiplos_1e6_singular = [
+    "milhão"
+    "bilião"
+    "trilião"
+    "quatrilião"
+    "quintilião"
+    "sextilião"
+    "septilião" 
+    "oitolião"
+    "nonilião" 
+    "decilião"
+    "undecilião"
+    "duodecilião"
+]
+
+const pt_PT_multiplos_1e6_plural = [
+    "milhões"
+    "biliões"
+    "triliões"
+    "quatriliões"
+    "quintiliões"
+    "sextiliões"
+    "septiliões"
+    "oitoliões"
+    "noniliões"
+    "deciliões"
+    "undeciliões"
+    "duodeciliões"
+]
+
+const pt_PT_decimais = [
+    "décimo"
+    "centésimo"
+    "milésimo"
+    "milionésimo"
+]