diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..f8e8e84 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,25 @@ +name: ci + +on: + push: + paths-ignore: + - "LICENSE" + - "**.md" + +jobs: + ci: + runs-on: ubuntu-latest + timeout-minutes: 10 + container: + image: shiguredo/erlang:otp-27.1.2-openssl-3.4.0-ubuntu-24.04-x86_64 + steps: + - uses: actions/checkout@v4 + - run: make compile dialyzer test + - name: Slack Notification + if: failure() + uses: rtCamp/action-slack-notify@v2 + env: + SLACK_CHANNEL: ${{ secrets.SLACK_INTERNAL_CHANNEL }} + SLACK_COLOR: danger + SLACK_TITLE: Failure test + SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..69fa449 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +_build/ diff --git a/CHANGES.md b/CHANGES.md new file mode 100644 index 0000000..d79cdf7 --- /dev/null +++ b/CHANGES.md @@ -0,0 +1,16 @@ +# 変更履歴 + +- CHANGE + - 下位互換のない変更 +- ADD + - 下位互換がある追加 +- UPDATE + - 下位互換がある変更 +- FIX + - バグ修正 + +## develop + +## 2024.1.0 + +**初リリース** diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d9a10c0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..5077545 --- /dev/null +++ b/Makefile @@ -0,0 +1,26 @@ +.PHONY: clean upgrade compile test distclean + +all: clean upgrade compile dialyzer test + +upgrade: + @./rebar3 plugins upgrade --all + @./rebar3 upgrade --all + +compile: + @./rebar3 xref + +clean: + @./rebar3 clean + +test: + @./rebar3 as test eunit + @./rebar3 as test cover + +dialyzer: + @./rebar3 dialyzer + +distclean: + @./rebar3 clean --all + +publish: + @./rebar3 hex publish package diff --git a/README.md b/README.md new file mode 100644 index 0000000..b42dc98 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# shiguredo_jsone + +![GitHub Actions workflow](https://github.com/shiguredo/jsone/actions/workflows/ci.yml/badge.svg) +[![GitHub tag](https://img.shields.io/github/tag/shiguredo/jsone.svg)](https://github.com/shiguredo/jsone) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) + +## 概要 + +[Erlang/OTP の標準 JSON ライブラリ](https://www.erlang.org/doc/apps/stdlib/json.html) を [sile/jsone: Erlang JSON library](https://github.com/sile/jsone) 互換にするラッパーです。 + +> [!CAUTION] +> jsone 一部の機能のみを実装しています。 + +## rebar.conf + +```erlang +{deps, [{jsone, "2024.1.0", {pkg, shiguredo_jsone}}]}. +``` + +## ライセンス + +```text +Copyright 2024-2024, Takeru Ohta (Original Author) +Copyright 2024-2024, Shiguredo Inc. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +``` diff --git a/rebar.config b/rebar.config new file mode 100644 index 0000000..60278b7 --- /dev/null +++ b/rebar.config @@ -0,0 +1,36 @@ +{minimum_otp_vsn, "27.1"}. + +{erl_opts, [{i, "src"}, + warnings_as_errors, + warn_export_all, + warn_unused_import]}. + +{xref_checks, [undefined_function_calls, + undefined_functions, + locals_not_used, + deprecated_function_calls, + deprecated_functions]}. + +{dialyzer, [{warnings, [extra_return, + missing_return, + no_unknown + %% unmatched_returns, + %% overspecs, + %% underspecs, + %% specdiffs, + %% error_handling + ]}, + incremental, + {plt_apps, top_level_deps}, + %% {plt_apps, all_apps}, + {plt_location, local}, + {base_plt_location, global}]}. + +{project_plugins, [rebar3_efmt, rebar3_lint]}. +{elvis_output_format, colors}. + +{cover_enabled, true}. + +{validate_app_modules, true}. + +{plugins, [rebar3_hex]}. diff --git a/rebar.lock b/rebar.lock new file mode 100644 index 0000000..57afcca --- /dev/null +++ b/rebar.lock @@ -0,0 +1 @@ +[]. diff --git a/rebar3 b/rebar3 new file mode 100755 index 0000000..762dc0b Binary files /dev/null and b/rebar3 differ diff --git a/src/jsone.app.src b/src/jsone.app.src new file mode 100644 index 0000000..57b7776 --- /dev/null +++ b/src/jsone.app.src @@ -0,0 +1,10 @@ +{application, jsone, + [{description, "Erlang JSON library"}, + {pkg_name, shiguredo_jsone}, + {vsn, "2024.1.0"}, + {registered, []}, + {applications, [kernel, stdlib]}, + {env, []}, + {modules, []}, + {licenses, ["Apache-2.0"]}, + {links, [{"GitHub", "https://github.com/shiguredo/kvconf"}]}]}. diff --git a/src/jsone.erl b/src/jsone.erl new file mode 100644 index 0000000..35b1c2e --- /dev/null +++ b/src/jsone.erl @@ -0,0 +1,251 @@ +-module(jsone). + +-export([decode/1, decode/2, + try_decode/1, try_decode/2, + encode/1, encode/2, + try_encode/1, try_encode/2]). + +-export_type([json_value/0, + json_boolean/0, + json_number/0, + json_string/0, + json_array/0, + json_object/0, + + encode_option/0, + decode_option/0]). + +-type json_value() :: json_number() | + json_string() | + json_array() | + json_object() | + json_boolean() | + null | + undefined. +-type json_boolean() :: boolean(). +-type json_number() :: number(). +-type json_string() :: binary() | atom(). +-type json_array() :: [json_value()]. +-type json_object() :: #{json_string() => json_value()} | + [{json_string(), json_value()}]. + +-type encode_option() :: skip_undefined | + undefined_as_null | + {float_format, [float_format_option()]}. + +-type decode_option() :: {keys, attempt_atom}. + +-type float_format_option() :: {scientific, Decimals :: 0..249} | + {decimals, Decimals :: 0..253} | + compact | + short. + +-record(encode_options, { + skip_undefined = false :: boolean(), + undefined_as_null = false :: boolean(), + float_format = [] :: [float_format_option()] + }). + + +%% @equiv decode(Json, []) +-spec decode(binary()) -> json_value(). +decode(Json) -> + decode(Json, []). + + +%% JSON 文字列バイナリをデコードする +%% +%% 入力バイナリが不正だったり、二つ以上の JSON 値が含まれている場合には例外が送出される +-spec decode(binary(), [decode_option()]) -> json_value(). +decode(Json, Options) -> + Decoders = create_decoders(Options, #{}), + {Value, ok, Remainings} = json:decode(Json, ok, Decoders), + check_decode_remainings(Remainings), + Value. + + +%% @equiv try_decode(Json, []) +-spec try_decode(binary()) -> + {ok, json_value(), Remainings :: binary()} | {error, {Reason :: term(), erlang:stacktrace()}}. +try_decode(Json) -> + try_decode(Json, []). + + +%% JSON 文字列バイナリをデコードする +%% +%% 入力バイナリが不正な場合には {error, _} が返される +%% +%% 入力バイナリから JSON 値をパースした後に、まだ後続のデータが存在する場合には、 +%% その後続バイナリは `Remainings` に格納されて返される +-spec try_decode(binary(), [decode_option()]) -> + {ok, json_value(), Remainings :: binary()} | {error, {Reason :: term(), erlang:stacktrace()}}. +try_decode(Json, Options) -> + Decoders = create_decoders(Options, #{}), + try + {Value, ok, Remainings} = json:decode(Json, ok, Decoders), + {ok, Value, Remainings} + catch + error:Reason:Stacktrace -> + {error, {Reason, Stacktrace}} + end. + + +%% @equiv encode(JsonValue, []) +-spec encode(json_value()) -> binary(). +encode(JsonValue) -> + encode(JsonValue, []). + + +%% JSON 値をエンコードする +%% +%% 入力の値が不正な場合には例外が送出される +-spec encode(json_value(), [encode_option()]) -> binary(). +encode(JsonValue, Options) -> + EncodeOptions = build_encode_options(Options, #encode_options{}), + Iodata = + json:encode(JsonValue, + fun(Value, Encoder) -> + encode(Value, Encoder, EncodeOptions) + end), + iolist_to_binary(Iodata). + + +%% @equiv try_encode(JsonValue, []) +-spec try_encode(json_value()) -> {ok, binary()} | {error, {Reason :: term(), erlang:stacktrace()}}. +try_encode(JsonValue) -> + try_encode(JsonValue, []). + + +%% JSON 値をエンコードする +%% +%% 入力の値が不正な場合には {error, _} が返される +-spec try_encode(json_value(), [encode_option()]) -> + {ok, binary()} | {error, {Reason :: term(), erlang:stacktrace()}}. +try_encode(JsonValue, Options) -> + try + {ok, encode(JsonValue, Options)} + catch + error:Reason:Stacktrace -> + {error, {Reason, Stacktrace}} + end. + + +%% Internal Functions + + +-spec create_decoders([decode_option()], json:decoders()) -> json:decoders(). +create_decoders([], Acc) -> + Acc; +create_decoders([{keys, attempt_atom} | Options], Acc) -> + ObjectPush = + fun(Key, Value, Members) -> + try + [{binary_to_existing_atom(Key, utf8), Value} | Members] + catch + error:badarg -> + [{Key, Value} | Members] + end + end, + create_decoders(Options, Acc#{object_push => ObjectPush}); +create_decoders(Options, Acc) -> + %% 不明なオプションが指定されていたらエラーにする + erlang:error(badarg, [Options, Acc]). + + +-spec check_decode_remainings(binary()) -> ok. +check_decode_remainings(<<>>) -> + ok; +check_decode_remainings(<<$ , Bin/binary>>) -> + check_decode_remainings(Bin); +check_decode_remainings(<<$\t, Bin/binary>>) -> + check_decode_remainings(Bin); +check_decode_remainings(<<$\r, Bin/binary>>) -> + check_decode_remainings(Bin); +check_decode_remainings(<<$\n, Bin/binary>>) -> + check_decode_remainings(Bin); +check_decode_remainings(<>) -> + erlang:error(badarg, [Bin]). + + +-spec build_encode_options([encode_option()], #encode_options{}) -> #encode_options{}. +build_encode_options([], Acc) -> + Acc; +build_encode_options([skip_undefined | Options], Acc) -> + build_encode_options(Options, Acc#encode_options{skip_undefined = true}); +build_encode_options([undefined_as_null | Options], Acc) -> + build_encode_options(Options, Acc#encode_options{undefined_as_null = true}); +build_encode_options([{float_format, Format} | Options], Acc) -> + build_encode_options(Options, Acc#encode_options{float_format = Format}); +build_encode_options(Options, Acc) -> + %% 不明なオプションが指定されていたらエラーにする + erlang:error(badarg, [Options, Acc]). + + +-spec encode(json_value(), json:enocder(), #encode_options{}) -> iodata(). +encode([{_, _} | _] = Value0, Encoder, Options) -> + Value1 = + case Options of + #encode_options{skip_undefined = true} -> + lists:filter(fun({_, V}) -> V =/= undefined end, Value0); + _ -> + Value0 + end, + json:encode_key_value_list(Value1, Encoder); +encode(undefined, Encoder, #encode_options{undefined_as_null = true}) -> + json:encode_atom(null, Encoder); +encode(Value0, Encoder, #encode_options{skip_undefined = true}) when is_map(Value0) -> + Value1 = maps:filter(fun(_, V) -> V =/= undefined end, Value0), + json:encode_value(Value1, Encoder); +encode(Value, _Encoder, #encode_options{float_format = FloatFormat}) when is_float(Value) -> + float_to_binary(Value, FloatFormat); +encode(Value, Encoder, _Options) -> + try + json:encode_value(Value, Encoder) + catch + error:{unsupported_type, Value} -> + json:encode_value(list_to_binary(io_lib:format("~0p", [Value])), Encoder) + end. + + +-ifdef(TEST). + +-include_lib("eunit/include/eunit.hrl"). + + +decode_test() -> + %% Basic decoding. + ?assertEqual(#{<<"foo">> => 1}, decode(~'{"foo": 1}')), + + %% `attempt_atom` option. + ?assertEqual(#{foo => 1}, decode(~'{"foo": 1}', [{keys, attempt_atom}])), + ?assertEqual(#{<<"no_existing_atom">> => 1}, decode(~'{"no_existing_atom": 1}', [{keys, attempt_atom}])), + + ok. + + +encode_test() -> + %% Basic encoding. + ?assertEqual(~'{"foo":1}', encode(#{foo => 1})), + ?assertEqual(~'{"foo":1}', encode(#{<<"foo">> => 1})), + ?assertEqual(~'{"foo":1}', encode([{foo, 1}])), + + %% `undefined_as_null` option. + ?assertEqual(~'{"foo":null}', encode([{foo, undefined}], [undefined_as_null])), + ?assertEqual(~'{"undefined":[null]}', encode(#{undefined => [undefined]}, [undefined_as_null])), + + %% `skip_undefined` option. + ?assertEqual(~'{"bar":1}', encode([{foo, undefined}, {bar, 1}], [skip_undefined])), + ?assertEqual(~'{"bar":1}', encode(#{foo => undefined, bar => 1}, [skip_undefined])), + + %% `float_format` option. + ?assertEqual(~'{"foo":1.1000}', encode(#{foo => 1.1}, [{float_format, [{decimals, 4}]}])), + ?assertEqual(~'{"foo":1.1}', encode(#{foo => 1.1}, [{float_format, [{decimals, 4}, compact]}])), + + %% json モジュールが直接はサポートしていないタイプのエンコード + %% => io_lib:format() で文字列に変換される + ?assertEqual(~'{"foo":"{bar,baz}"}', encode(#{foo => {bar, baz}})), + + ok. + + +-endif.