add type annotations

Author: dbackowski

lib/polish_validators/common.ex

@@ -24,6 +24,7 @@ defmodule PolishValidators.Common do
       { :error, "Invalid length" }
 
   """
+  @spec validate_length(String.t, integer() | list(integer)) :: {atom, String.t}
   def validate_length(string, valid_length) do
     valid_length = cond do
       is_number(valid_length) -> [valid_length]
@@ -48,6 +49,7 @@ defmodule PolishValidators.Common do
       { :error, "Wrong checksum" }
 
   """
+  @spec validate_checksum(integer(), integer()) :: {atom, String.t}
   def validate_checksum(checksum, control_digit) do
     if (checksum == control_digit) do
       { :ok, "Valid" }
@@ -65,6 +67,7 @@ defmodule PolishValidators.Common do
       [1, 2, 3]
 
   """
+  @spec to_integers_list(String.t) :: list(integer) 
   def to_integers_list(number) do
     to_string(number) 
       |> split("", trim: true)

lib/polish_validators/iban.ex

@@ -24,6 +24,7 @@ defmodule PolishValidators.Iban do
       { :error, "Invalid length" }
   
   """
+  @spec validate(String.t) :: {atom, String.t}
   def validate(iban) when is_binary(iban) do
     iban_length = replace_prefix(iban, "PL", "")
                     |> validate_length(26)

lib/polish_validators/nip.ex

@@ -24,6 +24,7 @@ defmodule PolishValidators.Nip do
       { :error, "Invalid length" }
   
   """
+  @spec validate(String.t) :: {atom, String.t}
   def validate(nip) when is_binary(nip) do
     nip_length = validate_length(nip, 10)
 

lib/polish_validators/pesel.ex

@@ -24,6 +24,7 @@ defmodule PolishValidators.Pesel do
       { :error, "Invalid length" }
   
   """
+  @spec validate(String.t) :: {atom, String.t}
   def validate(pesel) when is_binary(pesel) do
     pesel_length = validate_length(pesel, 11)
 

lib/polish_validators/regon.ex

@@ -33,6 +33,7 @@ defmodule PolishValidators.Regon do
       { :error, "Invalid length" }
   
   """
+  @spec validate(String.t) :: {atom, String.t}
   def validate(regon) when is_binary(regon) do
     regon_length = validate_length(regon, [9, 14])
 

mix.exs

@@ -4,7 +4,7 @@ defmodule PolishValidators.Mixfile do
   def project do
     [
       app: :polish_validators,
-      version: "0.1.0",
+      version: "0.1.1",
       elixir: "~> 1.5",
       start_permanent: Mix.env == :prod,
       description: description(),
@@ -40,9 +40,8 @@ defmodule PolishValidators.Mixfile do
   defp deps do
     [
       {:ex_doc, "~> 0.11", only: :dev},
-      {:earmark, "~> 0.1", only: :dev}
-      # {:dep_from_hexpm, "~> 0.3.0"},
-      # {:dep_from_git, git: "https://github.com/elixir-lang/my_dep.git", tag: "0.1.0"},
+      {:earmark, "~> 0.1", only: :dev},
+      {:dialyxir, "~> 0.3", only: [:dev]}
     ]
   end
 end

mix.lock

@@ -1,2 +1,3 @@
-%{"earmark": {:hex, :earmark, "0.2.1", "ba6d26ceb16106d069b289df66751734802777a3cbb6787026dd800ffeb850f3", [], [], "hexpm"},
+%{"dialyxir": {:hex, :dialyxir, "0.5.1", "b331b091720fd93e878137add264bac4f644e1ddae07a70bf7062c7862c4b952", [], [], "hexpm"},
+  "earmark": {:hex, :earmark, "0.2.1", "ba6d26ceb16106d069b289df66751734802777a3cbb6787026dd800ffeb850f3", [], [], "hexpm"},
   "ex_doc": {:hex, :ex_doc, "0.12.0", "b774aabfede4af31c0301aece12371cbd25995a21bb3d71d66f5c2fe074c603f", [], [{:earmark, "~> 0.2", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"}}