From b4e3de508fe25e2abaf2103579c7a372eadadf3f Mon Sep 17 00:00:00 2001 From: atanda rasheed Date: Fri, 24 Jan 2025 07:25:57 +0100 Subject: [PATCH] chore: module cleanup --- lib/request.ex | 2 +- lib/validator/plug.ex | 6 +----- lib/validator/rules.ex | 26 +++++++++++++------------- test/support/register_request.ex | 2 +- test/support/strict_request.ex | 5 +---- test/validator/rules_test.exs | 4 ++-- 6 files changed, 19 insertions(+), 26 deletions(-) diff --git a/lib/request.ex b/lib/request.ex index a5cc028..424af41 100644 --- a/lib/request.ex +++ b/lib/request.ex @@ -46,7 +46,7 @@ defmodule Request.Validator do ## Examples iex> import Request.Validator - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> rules = ~V[required|email:format] iex> [%{validator: _}, rule] = rules iex> is_function(rule, 2) diff --git a/lib/validator/plug.ex b/lib/validator/plug.ex index 610e289..4d115ed 100644 --- a/lib/validator/plug.ex +++ b/lib/validator/plug.ex @@ -13,11 +13,8 @@ defmodule Request.Validator.Plug do on_error: fn conn, errors -> json_resp(conn, "Handle your errors: #{inspect errors}") end ``` """ - def init(opts) when is_map(opts), do: init(Keyword.new(opts)) - def init(opts) do - opts - |> Keyword.put_new(:on_error, &Validator.Plug.on_error/2) + Keyword.put_new(opts, :on_error, &Validator.Plug.on_error/2) end @doc ~S""" @@ -56,7 +53,6 @@ defmodule Request.Validator.Plug do end end - defp get_validator(opt, key) when is_map(opt), do: Map.get(opt, key) defp get_validator(opt, key) when is_list(opt), do: Keyword.get(opt, key) defp json_resp(conn, status, body) do diff --git a/lib/validator/rules.ex b/lib/validator/rules.ex index c0e4ea4..cfd3a1d 100644 --- a/lib/validator/rules.ex +++ b/lib/validator/rules.ex @@ -1,4 +1,4 @@ -defmodule Request.Validator.Rulex do +defmodule Request.Validator.Rules do alias EmailChecker.Check.Format alias EmailChecker.Check.MX alias Request.Validator.Utils @@ -30,7 +30,7 @@ defmodule Request.Validator.Rulex do @doc """ ## Examples - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> %{validator: fun} = required() iex> fun.("name", "") {:error, "The name field is required."} @@ -67,7 +67,7 @@ defmodule Request.Validator.Rulex do @doc """ ## Examples - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> %{validator: fun} = required_if(true) iex> fun.("description", "") {:error, "The description field is required."} @@ -132,7 +132,7 @@ defmodule Request.Validator.Rulex do @doc """ ## Examples - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> fun = string() iex> fun.("content", "") :ok @@ -159,7 +159,7 @@ defmodule Request.Validator.Rulex do @doc """ ## Examples - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> fun = alpha() iex> fun.("uid", "abcde") :ok @@ -189,7 +189,7 @@ defmodule Request.Validator.Rulex do @doc """ ## Examples - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> fun = alpha_num() iex> fun.("ref", "1ab2de3") :ok @@ -224,7 +224,7 @@ defmodule Request.Validator.Rulex do @doc """ ## Examples - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> fun = alpha_dash() iex> fun.("username", "abcde2") :ok @@ -260,7 +260,7 @@ defmodule Request.Validator.Rulex do @doc """ ## Examples - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> fun = integer() iex> fun.("age", 1) :ok @@ -289,7 +289,7 @@ defmodule Request.Validator.Rulex do @doc """ ## Examples - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> fun = decimal() iex> fun.("amount", 2.0) :ok @@ -321,7 +321,7 @@ defmodule Request.Validator.Rulex do @doc """ ## Examples - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> fun = numeric() iex> fun.("width", 2.0) :ok @@ -350,7 +350,7 @@ defmodule Request.Validator.Rulex do @doc """ ## Examples - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> fun = email() iex> fun.("email", "test@gmail.com") :ok @@ -391,7 +391,7 @@ defmodule Request.Validator.Rulex do ## Examples iex> alias Request.Validator.Fields - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> data = Fields.new(%{ ...> "password" => 12345678, ...> "password_confirmation" => 12345678, @@ -427,7 +427,7 @@ defmodule Request.Validator.Rulex do @doc """ ## Examples - iex> import Request.Validator.Rulex + iex> import Request.Validator.Rules iex> fun = allowed(["male", "female"]) iex> fun.("gender", "male") :ok diff --git a/test/support/register_request.ex b/test/support/register_request.ex index 93908c3..56dcfb4 100644 --- a/test/support/register_request.ex +++ b/test/support/register_request.ex @@ -1,7 +1,7 @@ defmodule RequestValidatorTest.RegisterRequest do use Request.Validator - import Request.Validator.Rulex + import Request.Validator.Rules @impl Request.Validator def rules(_) do diff --git a/test/support/strict_request.ex b/test/support/strict_request.ex index 6221687..f52ba72 100644 --- a/test/support/strict_request.ex +++ b/test/support/strict_request.ex @@ -1,11 +1,8 @@ defmodule RequestValidatorTest.StrictRequest do use Request.Validator, strict: true - import Request.Validator.Rulex + import Request.Validator.Rules @impl Request.Validator def rules(_), do: %{"email" => [email()]} - - @impl Request.Validator - def authorize(_), do: true end diff --git a/test/validator/rules_test.exs b/test/validator/rules_test.exs index ab8a011..3ac33a9 100644 --- a/test/validator/rules_test.exs +++ b/test/validator/rules_test.exs @@ -1,7 +1,7 @@ defmodule Request.Validator.RulesTest do use ExUnit.Case - alias Request.Validator.Rulex + alias Request.Validator.Rules - doctest(Rulex) + doctest(Rules) end