Added main module to analize format of tax_id and define EDRPOU or ITIN

Bumped to 0.1.3
This commit is contained in:
Danil Negrienko 2024-12-28 20:10:01 -05:00
parent 2fa1c94a22
commit 48672584c7
5 changed files with 114 additions and 3 deletions

View File

@ -9,7 +9,7 @@ The package can be installed by adding `ukraine_tax_id` to your list of dependen
```elixir
def deps do
[
{:ukraine_tax_id, "~> 0.1.1"}
{:ukraine_tax_id, "~> 0.1.3"}
]
end
```

View File

@ -1,5 +1,56 @@
defmodule UkraineTaxidEx do
@itin_length UkraineTaxidEx.Itin.length()
@edrpou_length UkraineTaxidEx.Edrpou.length()
@moduledoc """
Documentation for `UkraineTaxidEx`.
"""
@doc """
`determine/1`: Takes a tax ID string and identifies its type based on length
- Returns `{:ok, UkraineTaxidEx.Itin}` for ITIN numbers
- Returns `{:ok, UkraineTaxidEx.Edrpou}` for EDRPOU numbers
- Returns an error if the length is invalid
"""
def determine(tax_id) when is_binary(tax_id) do
case String.length(tax_id) do
@itin_length -> {:ok, UkraineTaxidEx.Itin}
@edrpou_length -> {:ok, UkraineTaxidEx.Edrpou}
_ -> {:error, "Invalid tax ID length"}
end
end
@doc """
`parse/1`: Determines the tax ID type and parses it using the appropriate parser
- Uses `Module.concat` to dynamically find the correct parser module
- Returns a tuple with status, result, and type information
"""
def parse(tax_id) do
case determine(tax_id) do
{:ok, type} ->
parser = Module.concat(type, "Parser")
{status, result} = parser.parse(tax_id)
{status, result, type}
{:error, error} ->
{:error, error}
end
end
@doc """
`validate/1`: Validates a tax ID by attempting to parse it
- Returns `:ok` if valid
- Returns error tuples with details if invalid
"""
def validate(tax_id) do
case parse(tax_id) do
{:ok, _, _} -> :ok
{:error, error, type} -> {:error, error, type}
{:error, error} -> {:error, error}
end
end
end

View File

@ -24,7 +24,7 @@ defmodule UkraineTaxidEx.BaseParser do
@impl BaseParser
@spec parse(data :: string_or_ok, options :: BaseParser.options()) :: struct_or_error()
def parse(data, options \\ [normalize?: false, clean?: false])
def parse(data, options \\ [normalize?: false, clean?: true])
def parse({:ok, string}, options), do: parse(string, options)
def parse({:error, error}, _options), do: {:error, error}

View File

@ -5,7 +5,7 @@ defmodule UkraineTaxidEx.MixProject do
@module UkraineTaxidEx
@source_url "https://g.tulz.dev/opensource/ukraine-taxid-ex"
@docs_url "https://hexdocs.pm/#{@app}"
@version "0.1.2"
@version "0.1.3"
def project do
[

View File

@ -1,4 +1,64 @@
defmodule UkraineTaxidExTest do
use ExUnit.Case, async: true
doctest UkraineTaxidEx
describe "determine/1" do
test "correctly identifies ITIN tax ID" do
assert {:ok, UkraineTaxidEx.Itin} = UkraineTaxidEx.determine("1234567890")
end
test "correctly identifies EDRPOU tax ID" do
assert {:ok, UkraineTaxidEx.Edrpou} = UkraineTaxidEx.determine("12345678")
end
test "returns error for invalid length" do
assert {:error, "Invalid tax ID length"} = UkraineTaxidEx.determine("123")
assert {:error, "Invalid tax ID length"} = UkraineTaxidEx.determine("1234")
assert {:error, "Invalid tax ID length"} = UkraineTaxidEx.determine("12345")
assert {:error, "Invalid tax ID length"} = UkraineTaxidEx.determine("123456")
assert {:error, "Invalid tax ID length"} = UkraineTaxidEx.determine("1234567")
assert {:error, "Invalid tax ID length"} = UkraineTaxidEx.determine("123456789")
assert {:error, "Invalid tax ID length"} = UkraineTaxidEx.determine("12345678901")
end
end
describe "parse/1" do
test "successfully parses valid ITIN" do
assert {:ok, %{code: "1759013776"}, UkraineTaxidEx.Itin} =
UkraineTaxidEx.parse("1759013776")
end
test "successfully parses valid EDRPOU" do
assert {:ok, %{code: "30283027"}, UkraineTaxidEx.Edrpou} =
UkraineTaxidEx.parse("30283027")
end
test "returns error for invalid tax ID" do
assert {:error, "Invalid tax ID length"} = UkraineTaxidEx.parse("123")
end
test "returns :length_too_short error for invalid format tax id (valid length but invalid after clean)" do
assert {:error, :length_too_short, UkraineTaxidEx.Itin} =
UkraineTaxidEx.parse("abcdefghij")
assert {:error, :length_too_short, UkraineTaxidEx.Edrpou} =
UkraineTaxidEx.parse("abcdefgh")
end
end
describe "validate/1" do
test "returns :invalid_checksum for ITIN with invalid checksum" do
assert {:error, :invalid_checksum, UkraineTaxidEx.Itin} =
UkraineTaxidEx.validate("1234567890")
end
test "returns :invalid_checksum for EDRPOU with invalid checksum" do
assert {:error, :invalid_checksum, UkraineTaxidEx.Edrpou} =
UkraineTaxidEx.validate("12345679")
end
test "returns error for invalid tax ID" do
assert {:error, "Invalid tax ID length"} = UkraineTaxidEx.validate("123")
end
end
end