Merge pull request #193 from esl/fix_description_encoding

Fix #190: Allow description to be binary in required_variable attributes

Author: Denys Gonchar

elvis.config

@@ -43,7 +43,7 @@
 {project_plugins, [
     {rebar3_hex, "~> 7.0"},
     {rebar3_ex_doc, "~> 0.2"},
-    {rebar3_lint, "~> 4.1"},
+    {rebar3_lint, "~> 4.2"},
     {rebar3_codecov, "~> 0.7"}
 ]}.
 
@@ -76,7 +76,8 @@
         rules => [
             {elvis_text_style, line_length, #{skip_comments => whole_line}},
             {elvis_style, export_used_types, disable},
-            {elvis_style, invalid_dynamic_call, #{ignore => [{amoc_code_server, get_md5}]}},
+            {elvis_style, private_data_types, disable},
+            {elvis_style, no_invalid_dynamic_calls, #{ignore => [{amoc_code_server, get_md5}]}},
             {elvis_style, no_block_expressions, #{ignore => [amoc_cluster]}},
             {elvis_style, no_throw, #{ignore => [amoc_config]}}
         ]

rebar.config

@@ -37,7 +37,7 @@
 -record(module_parameter, {name :: name(),
                            mod :: module(),
                            value :: value(),
-                           description :: string(),
+                           description :: unicode:chardata(),
                            verification_fn :: maybe_verification_fun(),
                            update_fn = read_only :: maybe_update_fun() | read_only}).
 
@@ -51,7 +51,7 @@
 -type update_method() :: read_only | none | mfa(2) | update_fun().
 
 -type module_attribute() :: #{ name := name(),
-                               description := string(),
+                               description := unicode:chardata(),
                                default_value => value(),
                                verification => verification_method(),
                                update => update_method()}.

src/config/amoc_config.hrl

@@ -68,12 +68,11 @@ process_var_attr(Module, Attr) ->
     end.
 
 -spec check_mandatory_fields(maybe_module_attribute()) ->
-    {ok, #{name := name(), description := string(), any() => any()}} | {error, reason()}.
-check_mandatory_fields(#{description := List, name := Atom} = Attr) when is_atom(Atom),
-                                                                         is_list(List) ->
-    case io_lib:char_list(List) of
-        true -> {ok, Attr};
-        false -> {error, invalid_attribute}
+    {ok, #{name := name(), description := unicode:chardata(), any() => any()}} | {error, reason()}.
+check_mandatory_fields(#{description := Description, name := Atom} = Attr) when is_atom(Atom) ->
+    case unicode:characters_to_binary(Description) of
+        Bin when is_binary(Bin) -> {ok, Attr#{description := Bin}};
+        _ -> {error, invalid_attribute}
     end;
 check_mandatory_fields(_Attr) ->
     {error, invalid_attribute}.
@@ -111,7 +110,7 @@ check_update_method(Attr) ->
     end.
 
 -spec make_module_parameter(#{name := name(),
-                              description := string(),
+                              description := unicode:chardata(),
                               default_value := value(),
                               verification := maybe_verification_fun(),
                               update := maybe_update_fun(),

src/config/amoc_config_attributes.erl

@@ -170,15 +170,14 @@ normalize_coordination_item({{Min, Max}, Actions}) when ?IS_POS_INT(Min), ?IS_PO
     [assert_action({Min, Max}, A) || A <- Actions],
     {{Min, Max}, Actions}.
 
-assert_action(all, Action) when is_function(Action, 1);
-                                is_function(Action, 2) ->
+assert_action(all, Action) when is_function(Action, 1) orelse is_function(Action, 2) ->
     ok;
-assert_action(N, Action) when is_integer(N),
+assert_action(N, Action) when is_integer(N) andalso
                               (is_function(Action, 1) orelse
                                is_function(Action, 2) orelse
                                is_function(Action, 3)) ->
     ok;
-assert_action({Min, Max}, Action) when is_integer(Min), is_integer(Max),
+assert_action({Min, Max}, Action) when is_integer(Min) andalso is_integer(Max) andalso
                                        (is_function(Action, 1) orelse
                                         is_function(Action, 2) orelse
                                         is_function(Action, 3)) ->

src/coordinator/amoc_coordinator.erl

@@ -7,6 +7,7 @@
 -export([all/0]).
 -export([get_module_attributes/1,
          get_module_configuration/1,
+         description_binary_and_list/1,
          errors_reporting/1,
          one_of_function/1]).
 
@@ -52,6 +53,7 @@ update_value(_, _) -> ok.
 all() ->
     [get_module_attributes,
      get_module_configuration,
+     description_binary_and_list,
      errors_reporting,
      one_of_function].
 
@@ -109,6 +111,27 @@ get_module_configuration(_) ->
                            verification_fn = VerificationNone, update_fn = UpdateValueFN}],
         Config).
 
+description_binary_and_list(_) ->
+    %% Description as list (string) is accepted and stored as binary
+    ListAttr = #{name => desc_list_var, description => "list description",
+                 default_value => def, verification => none, update => read_only},
+    {ok, [#module_parameter{description = <<"list description">>}]} =
+        amoc_config_attributes:process_module_attributes(?MODULE, [ListAttr]),
+    %% Description as binary is accepted and stored as binary
+    BinAttr = #{name => desc_bin_var, description => <<"binary description">>,
+                default_value => def, verification => none, update => read_only},
+    {ok, [#module_parameter{description = <<"binary description">>}]} =
+        amoc_config_attributes:process_module_attributes(?MODULE, [BinAttr]),
+    %% Unicode in both forms is preserved
+    UnicodeList = #{name => unicode_list_var, description => "café",
+                    default_value => def, verification => none, update => read_only},
+    {ok, [#module_parameter{description = <<"café"/utf8>>}]} =
+        amoc_config_attributes:process_module_attributes(?MODULE, [UnicodeList]),
+    UnicodeBin = #{name => unicode_bin_var, description => <<"café"/utf8>>,
+                   default_value => def, verification => none, update => read_only},
+    {ok, [#module_parameter{description = <<"café"/utf8>>}]} =
+        amoc_config_attributes:process_module_attributes(?MODULE, [UnicodeBin]).
+
 errors_reporting(_) ->
     InvalidParam0 = #{name => "invalid_var0", description => "config_attrs_var0"},
     InvalidParam1 = #{name => invalid_var1, description => [$a, -2]},