X-Git-Url: https://git.xandkar.net/?a=blobdiff_plain;f=src%2Fhope_kv_list.erl;h=394e53d658638bf909fc58f5fef4285f1df990aa;hb=e163be89d2e192e63fdc03b66146067d92b21e1f;hp=f4ee72ea731dbf324d0c9fe15f7ac1c408dc40ec;hpb=fa24061d65e74509ce66bbff0a6c99cbe33e9ddb;p=hope.git diff --git a/src/hope_kv_list.erl b/src/hope_kv_list.erl index f4ee72e..394e53d 100644 --- a/src/hope_kv_list.erl +++ b/src/hope_kv_list.erl @@ -3,7 +3,9 @@ %%%---------------------------------------------------------------------------- -module(hope_kv_list). --behavior(hope_dictionary). +-include_lib("hope_kv_list.hrl"). + +-behavior(hope_gen_dictionary). -export_type( [ t/2 @@ -12,6 +14,7 @@ -export( [ empty/0 , get/2 + , get/3 , set/3 , update/3 , pop/2 @@ -21,14 +24,26 @@ , fold/3 , of_kv_list/1 , to_kv_list/1 - , validate_unique_presence/2 % Assume default optional parameter(s) - , validate_unique_presence/3 % Specify optional parameter(s) + , 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 ]). -type t(K, V) :: [{K, V}]. +-type presence_violations(A) :: + % This is a hack to effectively parametarize the types of record fields. + % IMPORTANT: Make sure that the order of fields matches the definition of + % #hope_kv_list_presence_violations + { hope_kv_list_presence_violations + , [A] % keys_missing + , [A] % keys_duplicated + , [A] % keys_unsupported + }. + -type presence_error(A) :: {keys_missing , [A]} | {keys_duplicated , [A]} @@ -53,6 +68,12 @@ get(T, K) -> ; {K, V} -> {some, V} end. +-spec get(t(K, V), K, V) -> + V. +get(T, K, Default) -> + Vopt = get(T, K), + hope_option:get(Vopt, Default). + -spec set(t(K, V), K, V) -> t(K, V). set(T, K, V) -> @@ -118,35 +139,58 @@ validate_unique_presence(T, KeysRequired) -> -spec validate_unique_presence(t(K, _V), [K], [K]) -> hope_result:t(ok, [presence_error(K)]). validate_unique_presence(T, KeysRequired, KeysOptional) -> - KeysSupported = KeysRequired ++ KeysOptional, - KeysGiven = [K || {K, _V} <- T], - KeysGivenUnique = lists:usort(KeysGiven), - KeysDups = lists:usort(KeysGiven -- KeysGivenUnique), - KeysMissing = KeysRequired -- KeysGivenUnique, - KeysUnsupported = KeysGivenUnique -- KeysSupported, - case {KeysDups, KeysMissing, KeysUnsupported} - of {[], [], []} -> + case find_unique_presence_violations(T, KeysRequired, KeysOptional) + of #hope_kv_list_presence_violations + { keys_missing = [] + , keys_duplicated = [] + , keys_unsupported = [] + } -> {ok, ok} - ; {Dups, Missing, Unsupported} -> - ErrorDups = - case Dups + ; #hope_kv_list_presence_violations + { keys_missing = KeysMissing + , keys_duplicated = KeysDuplicated + , keys_unsupported = KeysUnsupported + } -> + ErrorMissing = + case KeysMissing of [] -> [] - ; [_|_] -> [{keys_duplicated, Dups}] + ; [_|_] -> [{keys_missing, KeysMissing}] end, - ErrorMissing = - case Missing + ErrorDups = + case KeysDuplicated of [] -> [] - ; [_|_] -> [{keys_missing, Missing}] + ; [_|_] -> [{keys_duplicated, KeysDuplicated}] end, ErrorUnsupported = - case Unsupported + case KeysUnsupported of [] -> [] - ; [_|_] -> [{keys_unsupported, Unsupported}] + ; [_|_] -> [{keys_unsupported, KeysUnsupported}] end, Errors = ErrorDups ++ ErrorMissing ++ ErrorUnsupported, {error, Errors} end. +-spec find_unique_presence_violations(t(K, _V), [K]) -> + presence_violations(K). +find_unique_presence_violations(T, KeysRequired) -> + KeysOptional = [], + find_unique_presence_violations(T, KeysRequired, KeysOptional). + +-spec find_unique_presence_violations(t(K, _V), [K], [K]) -> + presence_violations(K). +find_unique_presence_violations(T, KeysRequired, KeysOptional) -> + KeysSupported = KeysRequired ++ KeysOptional, + KeysGiven = [K || {K, _V} <- T], + KeysGivenUnique = lists:usort(KeysGiven), + KeysDuplicated = lists:usort(KeysGiven -- KeysGivenUnique), + KeysMissing = KeysRequired -- KeysGivenUnique, + KeysUnsupported = KeysGivenUnique -- KeysSupported, + #hope_kv_list_presence_violations + { keys_missing = KeysMissing + , keys_duplicated = KeysDuplicated + , keys_unsupported = KeysUnsupported + }. + %% ============================================================================ %% Helpers