Add has_key/2 dictionary method.

[hope.git] / src / hope_kv_list.erl

diff --git a/src/hope_kv_list.erl b/src/hope_kv_list.erl
index 394e53d..c12f3b4 100644 (file)
--- a/src/hope_kv_list.erl
+++ b/src/hope_kv_list.erl
@@ -13,8 +13,9 @@
 
 -export(
     [ empty/0
-    , get/2
-    , get/3
+    , get/2  % get option
+    , get/3  % get existing or default
+    , get/4  % get existing if valid, or default
     , set/3
     , update/3
     , pop/2
@@ -24,10 +25,12 @@
     , fold/3
     , of_kv_list/1
     , to_kv_list/1
+    , has_key/2
     , find_unique_presence_violations/2  % No optional keys
     , find_unique_presence_violations/3  % Specify optional keys
     , validate_unique_presence/2  % No optional keys
     , validate_unique_presence/3  % Specify optional keys
+    , presence_violations_to_list/1
     ]).
 
 
@@ -74,6 +77,13 @@ get(T, K, Default) ->
     Vopt = get(T, K),
     hope_option:get(Vopt, Default).
 
+-spec get(t(K, V), K, V, fun((V) -> boolean())) ->
+    V.
+get(T, K, Default, IsValid) ->
+    VOpt1 = get(T, K),
+    VOpt2 = hope_option:validate(VOpt1, IsValid),
+    hope_option:get(VOpt2, Default).
+
 -spec set(t(K, V), K, V) ->
     t(K, V).
 set(T, K, V) ->
@@ -130,14 +140,16 @@ of_kv_list(List) ->
     % TODO: Decide if validation is to be done here. Do so if yes.
     List.
 
--spec validate_unique_presence(t(K, _V), [K]) ->
-    hope_result:t(ok, [presence_error(K)]).
+-spec validate_unique_presence(T, [K]) ->
+    hope_result:t(T, [presence_error(K)])
+    when T :: t(K, _V).
 validate_unique_presence(T, KeysRequired) ->
     KeysOptional = [],
     validate_unique_presence(T, KeysRequired, KeysOptional).
 
 -spec validate_unique_presence(t(K, _V), [K], [K]) ->
-    hope_result:t(ok, [presence_error(K)]).
+    hope_result:t(T, [presence_error(K)])
+    when T :: t(K, _V).
 validate_unique_presence(T, KeysRequired, KeysOptional) ->
     case find_unique_presence_violations(T, KeysRequired, KeysOptional)
     of  #hope_kv_list_presence_violations
@@ -145,29 +157,9 @@ validate_unique_presence(T, KeysRequired, KeysOptional) ->
         , keys_duplicated  = []
         , keys_unsupported = []
         } ->
-            {ok, ok}
-    ;   #hope_kv_list_presence_violations
-        { keys_missing     = KeysMissing
-        , keys_duplicated  = KeysDuplicated
-        , keys_unsupported = KeysUnsupported
-        } ->
-            ErrorMissing =
-                case KeysMissing
-                of  []    -> []
-                ;   [_|_] -> [{keys_missing, KeysMissing}]
-                end,
-            ErrorDups =
-                case KeysDuplicated
-                of  []    -> []
-                ;   [_|_] -> [{keys_duplicated, KeysDuplicated}]
-                end,
-            ErrorUnsupported =
-                case KeysUnsupported
-                of  []    -> []
-                ;   [_|_] -> [{keys_unsupported, KeysUnsupported}]
-                end,
-            Errors = ErrorDups ++ ErrorMissing ++ ErrorUnsupported,
-            {error, Errors}
+            {ok, T}
+    ;   #hope_kv_list_presence_violations{}=Violations ->
+            {error, presence_violations_to_list(Violations)}
     end.
 
 -spec find_unique_presence_violations(t(K, _V), [K]) ->
@@ -191,6 +183,34 @@ find_unique_presence_violations(T, KeysRequired, KeysOptional) ->
     , keys_unsupported = KeysUnsupported
     }.
 
+-spec presence_violations_to_list(presence_violations(K)) ->
+    [presence_error(K)].
+presence_violations_to_list(#hope_kv_list_presence_violations
+{ keys_missing     = KeysMissing
+, keys_duplicated  = KeysDuplicated
+, keys_unsupported = KeysUnsupported
+}) ->
+    ErrorMissing =
+        case KeysMissing
+        of  []    -> []
+        ;   [_|_] -> [{keys_missing, KeysMissing}]
+        end,
+    ErrorDups =
+        case KeysDuplicated
+        of  []    -> []
+        ;   [_|_] -> [{keys_duplicated, KeysDuplicated}]
+        end,
+    ErrorUnsupported =
+        case KeysUnsupported
+        of  []    -> []
+        ;   [_|_] -> [{keys_unsupported, KeysUnsupported}]
+        end,
+    ErrorDups ++ ErrorMissing ++ ErrorUnsupported.
+
+-spec has_key(t(K, _), K) ->
+    boolean().
+has_key(T, K1) ->
+    lists:any(fun ({K2, _}) -> K1 =:= K2 end, T).
 
 %% ============================================================================
 %% Helpers