Merge pull request #75 from sile/efmt-v0.3.0

Update `rebar3_efmt` to v0.3.0 and make it a project plugin

Author: sile

rebar.config

@@ -1,35 +1,31 @@
 %% -*- erlang -*-
-{erl_opts,
- [warnings_as_errors,
-  warn_export_all,
-  warn_untyped_record,
-  inline,
-  {platform_define, "^R[01][0-9]", 'NO_MAP_TYPE'},
-  {platform_define, "^(R|17)", 'NO_DIALYZER_SPEC'}]}.
+{erl_opts, [warnings_as_errors,
+            warn_export_all,
+            warn_untyped_record,
+            inline,
+            {platform_define, "^R[01][0-9]", 'NO_MAP_TYPE'},
+            {platform_define, "^(R|17)", 'NO_DIALYZER_SPEC'}]}.
 
 {xref_checks, [fail_on_warning, undefined_function_calls]}.
 
 {clean_files, [".eunit/*", "ebin/*.beam"]}.
 
 {cover_enabled, true}.
 
-{edoc_opts,
- [{dialyzer_specs, all},
-  {report_missing_type, true},
-  {report_type_mismatch, true},
-  {pretty_print, erl_pp},
-  {preprocess, true}]}.
+{edoc_opts, [{dialyzer_specs, all},
+             {report_missing_type, true},
+             {report_type_mismatch, true},
+             {pretty_print, erl_pp},
+             {preprocess, true}]}.
 {validate_app_modules, true}.
 
 {shell, [{apps, [jsone]}]}.
 
 {dialyzer, [{warnings, [error_handling, race_conditions, unmatched_returns, unknown, no_improper_lists]}]}.
 
-{profiles,
- [{native, [{erl_opts, [{d, 'ENABLE_HIPE'}]}]}, {edown, [{edoc_opts, [{doclet, edown_doclet}]}, {deps, [edown]}]}]}.
+{profiles, [{native, [{erl_opts, [{d, 'ENABLE_HIPE'}]}]},
+            {edown, [{edoc_opts, [{doclet, edown_doclet}]}, {deps, [edown]}]}]}.
 
-{project_plugins, [covertool]}.
+{project_plugins, [covertool, rebar3_efmt]}.
 {cover_export_enabled, true}.
 {covertool, [{coverdata_files, ["ct.coverdata", "eunit.coverdata"]}]}.
-
-{plugins, [rebar3_efmt]}.

src/jsone.app.src

@@ -1,9 +1,8 @@
-{application,
- jsone,
- [{description, "Erlang JSON Library"},
-  {vsn, "1.7.0"},
-  {registered, []},
-  {applications, [kernel, stdlib]},
-  {licenses, ["MIT"]},
-  {links, [{"GitHub", "https://github.com/sile/jsone"}]},
-  {env, []}]}.
+{application, jsone,
+              [{description, "Erlang JSON Library"},
+               {vsn, "1.7.0"},
+               {registered, []},
+               {applications, [kernel, stdlib]},
+               {licenses, ["MIT"]},
+               {links, [{"GitHub", "https://github.com/sile/jsone"}]},
+               {env, []}]}.

src/jsone.erl

@@ -29,14 +29,10 @@
 %%--------------------------------------------------------------------------------
 %% Exported API
 %%--------------------------------------------------------------------------------
--export([decode/1,
-         decode/2,
-         try_decode/1,
-         try_decode/2,
-         encode/1,
-         encode/2,
-         try_encode/1,
-         try_encode/2,
+-export([decode/1, decode/2,
+         try_decode/1, try_decode/2,
+         encode/1, encode/2,
+         try_encode/1, try_encode/2,
          term_to_json_string/1,
          ip_address_to_json_string/1]).
 
@@ -203,7 +199,7 @@
                          {object_key_type, string | scalar | value} |
                          {space, non_neg_integer()} |
                          {indent, non_neg_integer()} |
-                         {map_unknown_value, undefined | fun ((term()) -> {ok, json_value()} | error)} |
+                         {map_unknown_value, undefined | fun((term()) -> {ok, json_value()} | error)} |
                          skip_undefined |
                          common_option().
 %% `native_utf8': <br />
@@ -307,12 +303,13 @@
 %% The 'OTP_RELEASE' macro introduced at OTP-21,
 %% so we can use it for detecting whether the Erlang compiler supports new try/catch syntax or not.
 -define(CAPTURE_STACKTRACE, :__StackTrace).
--define(GET_STACKTRACE, __StackTrace).
+-define(GET_STACKTRACE,     __StackTrace).
 -else.
 -define(CAPTURE_STACKTRACE, ).
--define(GET_STACKTRACE, erlang:get_stacktrace()).
+-define(GET_STACKTRACE,     erlang:get_stacktrace()).
 -endif.
 
+
 %%--------------------------------------------------------------------------------
 %% Exported Functions
 %%--------------------------------------------------------------------------------
@@ -321,6 +318,7 @@
 decode(Json) ->
     decode(Json, []).
 
+
 %% @doc Decodes an erlang term from json text (a utf8 encoded binary)
 %%
 %% Raises an error exception if input is not valid json
@@ -346,11 +344,13 @@ decode(Json, Options) ->
             erlang:raise(error, Reason, [StackItem | ?GET_STACKTRACE])
     end.
 
+
 %% @equiv try_decode(Json, [])
 -spec try_decode(binary()) -> {ok, json_value(), Remainings :: binary()} | {error, {Reason :: term(), [stack_item()]}}.
 try_decode(Json) ->
     try_decode(Json, []).
 
+
 %% @doc Decodes an erlang term from json text (a utf8 encoded binary)
 %%
 %% ```
@@ -367,11 +367,13 @@ try_decode(Json) ->
 try_decode(Json, Options) ->
     jsone_decode:decode(Json, Options).
 
+
 %% @equiv encode(JsonValue, [])
 -spec encode(json_value()) -> binary().
 encode(JsonValue) ->
     encode(JsonValue, []).
 
+
 %% @doc Encodes an erlang term into json text (a utf8 encoded binary)
 %%
 %% Raises an error exception if input is not an instance of type `json_value()'
@@ -396,11 +398,13 @@ encode(JsonValue, Options) ->
             erlang:raise(error, Reason, [StackItem | ?GET_STACKTRACE])
     end.
 
+
 %% @equiv try_encode(JsonValue, [])
 -spec try_encode(json_value()) -> {ok, binary()} | {error, {Reason :: term(), [stack_item()]}}.
 try_encode(JsonValue) ->
     try_encode(JsonValue, []).
 
+
 %% @doc Encodes an erlang term into json text (a utf8 encoded binary)
 %%
 %% ```
@@ -416,11 +420,13 @@ try_encode(JsonValue) ->
 try_encode(JsonValue, Options) ->
     jsone_encode:encode(JsonValue, Options).
 
+
 %% @doc Converts the given term `X' to its string representation (i.e., the result of `io_lib:format("~p", [X])').
 -spec term_to_json_string(term()) -> {ok, json_string()} | error.
 term_to_json_string(X) ->
     {ok, list_to_binary(io_lib:format("~p", [X]))}.
 
+
 %% @doc Convert an IP address into a text representation.
 %%
 %% This function can be specified as the value of the `map_unknown_value' encoding option.
@@ -448,6 +454,7 @@ term_to_json_string(X) ->
 ip_address_to_json_string(X) ->
     jsone_inet:ip_address_to_json_string(X).
 
+
 %%--------------------------------------------------------------------------------
 %% Internal Functions
 %%--------------------------------------------------------------------------------

src/jsone_decode.erl

@@ -63,28 +63,32 @@
 
 -type decode_result() :: {ok, jsone:json_value(), Rest :: binary()} | {error, {Reason :: term(), [jsone:stack_item()]}}.
 
--record(decode_opt_v2,
-        {object_format = ?DEFAULT_OBJECT_FORMAT :: tuple | proplist | map,
-         allow_ctrl_chars = false :: boolean(),
-         reject_invalid_utf8 = false :: boolean(),
-         keys = binary :: 'binary' | 'atom' | 'existing_atom' | 'attempt_atom',
-         undefined_as_null = false :: boolean(),
-         duplicate_map_keys = first :: first | last}).
+-record(decode_opt_v2, {
+          object_format = ?DEFAULT_OBJECT_FORMAT :: tuple | proplist | map,
+          allow_ctrl_chars = false :: boolean(),
+          reject_invalid_utf8 = false :: boolean(),
+          keys = binary :: 'binary' | 'atom' | 'existing_atom' | 'attempt_atom',
+          undefined_as_null = false :: boolean(),
+          duplicate_map_keys = first :: first | last
+         }).
 -define(OPT, #decode_opt_v2).
 -type opt() :: #decode_opt_v2{}.
 
+
 %%--------------------------------------------------------------------------------
 %% Exported Functions
 %%--------------------------------------------------------------------------------
 -spec decode(binary()) -> decode_result().
 decode(Json) ->
     decode(Json, []).
 
+
 -spec decode(binary(), [jsone:decode_option()]) -> decode_result().
 decode(<<Json/binary>>, Options) ->
     Opt = parse_options(Options),
     whitespace(Json, value, [], <<"">>, Opt).
 
+
 %%--------------------------------------------------------------------------------
 %% Internal Functions
 %%--------------------------------------------------------------------------------
@@ -101,6 +105,7 @@ next(<<Bin/binary>>, Value, [Next | Nexts], Buf, Opt) ->
             whitespace(Bin, {object_next, [{Key, Value} | Members]}, Nexts, Buf, Opt)
     end.
 
+
 -spec whitespace(binary(), whitespace_next(), [next()], binary(), opt()) -> decode_result().
 whitespace(<<$ , Bin/binary>>, Next, Nexts, Buf, Opt) ->
     whitespace(Bin, Next, Nexts, Buf, Opt);
@@ -128,6 +133,7 @@ whitespace(<<Bin/binary>>, Next, Nexts, Buf, Opt) ->
             object_next(Bin, Members, Nexts, Buf, Opt)
     end.
 
+
 -spec value(binary(), [next()], binary(), opt()) -> decode_result().
 value(<<"false", Bin/binary>>, Nexts, Buf, Opt) ->
     next(Bin, false, Nexts, Buf, Opt);
@@ -146,12 +152,14 @@ value(<<$", Bin/binary>>, Nexts, Buf, Opt) ->
 value(<<Bin/binary>>, Nexts, Buf, Opt) ->
     number(Bin, Nexts, Buf, Opt).
 
+
 -spec array(binary(), [next()], binary(), opt()) -> decode_result().
 array(<<$], Bin/binary>>, Nexts, Buf, Opt) ->
     next(Bin, [], Nexts, Buf, Opt);
 array(<<Bin/binary>>, Nexts, Buf, Opt) ->
     value(Bin, [{array_next, []} | Nexts], Buf, Opt).
 
+
 -spec array_next(binary(), [jsone:json_value()], [next()], binary(), opt()) -> decode_result().
 array_next(<<$], Bin/binary>>, Values, Nexts, Buf, Opt) ->
     next(Bin, lists:reverse(Values), Nexts, Buf, Opt);
@@ -160,18 +168,21 @@ array_next(<<$,, Bin/binary>>, Values, Nexts, Buf, Opt) ->
 array_next(Bin, Values, Nexts, Buf, Opt) ->
     ?ERROR(array_next, [Bin, Values, Nexts, Buf, Opt]).
 
+
 -spec object(binary(), [next()], binary(), opt()) -> decode_result().
 object(<<$}, Bin/binary>>, Nexts, Buf, Opt) ->
     next(Bin, make_object([], Opt), Nexts, Buf, Opt);
 object(<<Bin/binary>>, Nexts, Buf, Opt) ->
     object_key(Bin, [], Nexts, Buf, Opt).
 
+
 -spec object_key(binary(), jsone:json_object_members(), [next()], binary(), opt()) -> decode_result().
 object_key(<<$", Bin/binary>>, Members, Nexts, Buf, Opt) ->
     string(Bin, byte_size(Buf), [{object_value, Members} | Nexts], Buf, Opt);
 object_key(<<Bin/binary>>, Members, Nexts, Buf, Opt) ->
     ?ERROR(object_key, [Bin, Members, Nexts, Buf, Opt]).
 
+
 -spec object_value(binary(), jsone:json_string(), jsone:json_object_members(), [next()], binary(), opt()) ->
           decode_result().
 object_value(<<$:, Bin/binary>>, Key, Members, Nexts, Buf, Opt) ->
@@ -180,6 +191,8 @@ object_value(Bin, Key, Members, Nexts, Buf, Opt) ->
     ?ERROR(object_value, [Bin, Key, Members, Nexts, Buf, Opt]).
 
 -compile({inline, [object_key/2]}).
+
+
 object_key(Key, ?OPT{keys = binary}) ->
     Key;
 object_key(Key, ?OPT{keys = atom}) ->
@@ -194,6 +207,7 @@ object_key(Key, ?OPT{keys = attempt_atom}) ->
             Key
     end.
 
+
 -spec object_next(binary(), jsone:json_object_members(), [next()], binary(), opt()) -> decode_result().
 object_next(<<$}, Bin/binary>>, Members, Nexts, Buf, Opt) ->
     next(Bin, make_object(Members, Opt), Nexts, Buf, Opt);
@@ -202,10 +216,12 @@ object_next(<<$,, Bin/binary>>, Members, Nexts, Buf, Opt) ->
 object_next(Bin, Members, Nexts, Buf, Opt) ->
     ?ERROR(object_next, [Bin, Members, Nexts, Buf, Opt]).
 
+
 -spec string(binary(), non_neg_integer(), [next()], binary(), opt()) -> decode_result().
 string(<<Bin/binary>>, Start, Nexts, Buf, Opt) ->
     string(Bin, Bin, Start, Nexts, Buf, Opt).
 
+
 -spec string(binary(), binary(), non_neg_integer(), [next()], binary(), opt()) -> decode_result().
 string(<<$", Bin/binary>>, Base, Start, Nexts, Buf, Opt) ->
     Prefix = binary:part(Base, 0, byte_size(Base) - byte_size(Bin) - 1),
@@ -252,6 +268,7 @@ string(<<C/utf8, Bin/binary>>, Base, Start, Nexts, Buf, Opt) when 16#20 =< C ->
 string(Bin, Base, Start, Nexts, Buf, Opt) ->
     ?ERROR(string, [Bin, Base, Start, Nexts, Buf, Opt]).
 
+
 -spec unicode_string(binary(), non_neg_integer(), [next()], binary(), opt()) -> decode_result().
 unicode_string(<<N:4/binary, Bin/binary>>, Start, Nexts, Buf, Opt) ->
     try
@@ -290,12 +307,14 @@ unicode_string(<<N:4/binary, Bin/binary>>, Start, Nexts, Buf, Opt) ->
 unicode_string(Bin, Start, Nexts, Buf, Opt) ->
     ?ERROR(unicode_string, [Bin, Start, Nexts, Buf, Opt]).
 
+
 -spec number(binary(), [next()], binary(), opt()) -> decode_result().
 number(<<$-, Bin/binary>>, Nexts, Buf, Opt) ->
     number_integer_part(Bin, -1, Nexts, Buf, Opt);
 number(<<Bin/binary>>, Nexts, Buf, Opt) ->
     number_integer_part(Bin, 1, Nexts, Buf, Opt).
 
+
 -spec number_integer_part(binary(), 1 | -1, [next()], binary(), opt()) -> decode_result().
 number_integer_part(<<$0, Bin/binary>>, Sign, Nexts, Buf, Opt) ->
     number_fraction_part(Bin, Sign, 0, Nexts, Buf, Opt);
@@ -304,18 +323,21 @@ number_integer_part(<<C, Bin/binary>>, Sign, Nexts, Buf, Opt) when $1 =< C, C =<
 number_integer_part(Bin, Sign, Nexts, Buf, Opt) ->
     ?ERROR(number_integer_part, [Bin, Sign, Nexts, Buf, Opt]).
 
+
 -spec number_integer_part_rest(binary(), non_neg_integer(), 1 | -1, [next()], binary(), opt()) -> decode_result().
 number_integer_part_rest(<<C, Bin/binary>>, N, Sign, Nexts, Buf, Opt) when $0 =< C, C =< $9 ->
     number_integer_part_rest(Bin, N * 10 + C - $0, Sign, Nexts, Buf, Opt);
 number_integer_part_rest(<<Bin/binary>>, N, Sign, Nexts, Buf, Opt) ->
     number_fraction_part(Bin, Sign, N, Nexts, Buf, Opt).
 
+
 -spec number_fraction_part(binary(), 1 | -1, non_neg_integer(), [next()], binary(), opt()) -> decode_result().
 number_fraction_part(<<$., Bin/binary>>, Sign, Int, Nexts, Buf, Opt) ->
     number_fraction_part_rest(Bin, Sign, Int, 0, Nexts, Buf, Opt);
 number_fraction_part(<<Bin/binary>>, Sign, Int, Nexts, Buf, Opt) ->
     number_exponation_part(Bin, Sign * Int, 0, Nexts, Buf, Opt).
 
+
 -spec number_fraction_part_rest(binary(), 1 | -1, non_neg_integer(), non_neg_integer(), [next()], binary(), opt()) ->
           decode_result().
 number_fraction_part_rest(<<C, Bin/binary>>, Sign, N, DecimalOffset, Nexts, Buf, Opt) when $0 =< C, C =< $9 ->
@@ -325,6 +347,7 @@ number_fraction_part_rest(<<Bin/binary>>, Sign, N, DecimalOffset, Nexts, Buf, Op
 number_fraction_part_rest(Bin, Sign, N, DecimalOffset, Nexts, Buf, Opt) ->
     ?ERROR(number_fraction_part_rest, [Bin, Sign, N, DecimalOffset, Nexts, Buf, Opt]).
 
+
 -spec number_exponation_part(binary(), integer(), non_neg_integer(), [next()], binary(), opt()) -> decode_result().
 number_exponation_part(<<$e, $+, Bin/binary>>, N, DecimalOffset, Nexts, Buf, Opt) ->
     number_exponation_part(Bin, N, DecimalOffset, 1, 0, true, Nexts, Buf, Opt);
@@ -346,6 +369,7 @@ number_exponation_part(<<Bin/binary>>, N, DecimalOffset, Nexts, Buf, Opt) ->
             next(Bin, N / math:pow(10, DecimalOffset), Nexts, Buf, Opt)
     end.
 
+
 -spec number_exponation_part(binary(),
                              integer(),
                              non_neg_integer(),
@@ -376,6 +400,7 @@ number_exponation_part(<<Bin/binary>>, N, DecimalOffset, ExpSign, Exp, false, Ne
 number_exponation_part(Bin, N, DecimalOffset, ExpSign, Exp, IsFirst, Nexts, Buf, Opt) ->
     ?ERROR(number_exponation_part, [Bin, N, DecimalOffset, ExpSign, Exp, IsFirst, Nexts, Buf, Opt]).
 
+
 -spec make_object(jsone:json_object_members(), opt()) -> jsone:json_object().
 make_object(Members, ?OPT{object_format = tuple}) ->
     {lists:reverse(Members)};
@@ -388,10 +413,12 @@ make_object([], _) ->
 make_object(Members, _) ->
     lists:reverse(Members).
 
+
 -spec parse_options([jsone:decode_option()]) -> opt().
 parse_options(Options) ->
     parse_option(Options, ?OPT{}).
 
+
 -spec parse_option([jsone:decode_option()], opt()) -> opt().
 parse_option([], Opt) ->
     Opt;