Skip to content

Enforce callers pass a path for debugging purposes, and update ppx to… #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions bin/build
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
set -e

yarn build-ppx

yarn build-lib

yarn test
22 changes: 11 additions & 11 deletions ppx_src/bin/Codecs.re
Original file line number Diff line number Diff line change
Expand Up @@ -31,53 +31,53 @@ let rec parameterizeCodecs = (typeArgs, encoderFunc, decoderFunc, generatorSetti
)
}

and generateConstrCodecs = ({ doEncode, doDecode }, { Location.txt: identifier, loc }) => {
and generateConstrCodecs: (generatorSettings, Location.loc(Longident.t)) => (option(expression), option(expression)) = ({ doEncode, doDecode }, { Location.txt: identifier, loc }) => {
open Longident;

switch identifier {
| Lident("string") => (
doEncode ? Some([%expr Decco.stringToJson]) : None,
doDecode ? Some([%expr Decco.stringFromJson]) : None
doDecode ? Some([%expr Decco.stringFromJson([%e locToString(loc)])]) : None
)
| Lident("int") => (
doEncode ? Some([%expr Decco.intToJson]) : None,
doDecode ? Some([%expr Decco.intFromJson]) : None
doDecode ? Some([%expr Decco.intFromJson([%e locToString(loc)])]) : None
)
| Lident("int64") => (
doEncode ? Some([%expr Decco.int64ToJson]) : None,
doDecode ? Some([%expr Decco.int64FromJson]) : None
doDecode ? Some([%expr Decco.int64FromJson([%e locToString(loc)])]) : None
)
| Lident("float") => (
doEncode ? Some([%expr Decco.floatToJson]) : None,
doDecode ? Some([%expr Decco.floatFromJson]) : None
doDecode ? Some([%expr Decco.floatFromJson([%e locToString(loc)])]) : None
)
| Lident("bool") => (
doEncode ? Some([%expr Decco.boolToJson]) : None,
doDecode ? Some([%expr Decco.boolFromJson]) : None
doDecode ? Some([%expr Decco.boolFromJson([%e locToString(loc)])]) : None
)
| Lident("unit") => (
doEncode ? Some([%expr Decco.unitToJson]) : None,
doDecode ? Some([%expr Decco.unitFromJson]) : None
)
| Lident("array") => (
doEncode ? Some([%expr Decco.arrayToJson]) : None,
doDecode ? Some([%expr Decco.arrayFromJson]) : None
doDecode ? Some([%expr Decco.arrayFromJson([%e locToString(loc)])]) : None
)
| Lident("list") => (
doEncode ? Some([%expr Decco.listToJson]) : None,
doDecode ? Some([%expr Decco.listFromJson]) : None
doDecode ? Some([%expr Decco.listFromJson([%e locToString(loc)])]) : None
)
| Lident("option") => (
doEncode ? Some([%expr Decco.optionToJson]) : None,
doDecode ? Some([%expr Decco.optionFromJson]) : None
)
| Ldot(Ldot(Lident("Belt"), "Result"), "t") => (
doEncode ? Some([%expr Decco.resultToJson]) : None,
doDecode ? Some([%expr Decco.resultFromJson]) : None
doDecode ? Some([%expr Decco.resultFromJson([%e locToString(loc)])]) : None
)
| Ldot(Ldot(Lident("Js"), "Dict"), "t") => (
doEncode ? Some([%expr Decco.dictToJson]) : None,
doDecode ? Some([%expr Decco.dictFromJson]) : None
doDecode ? Some([%expr Decco.dictFromJson([%e locToString(loc)])]) : None
)
| Ldot(Ldot(Lident("Js"), "Json"), "t") => (
doEncode ? Some([%expr (v) => v]) : None,
Expand Down Expand Up @@ -116,7 +116,7 @@ and generateCodecs = (
doDecode ? Some(
compositeCodecs
|> List.map(((_, d)) => BatOption.get(d))
|> Tuple.generateDecoder)
|> Tuple.generateDecoder(ptyp_loc))
: None
);
}
Expand Down
14 changes: 7 additions & 7 deletions ppx_src/bin/Records.re
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ let generateDictGets = (decls) => decls
|> List.map(generateDictGet)
|> tupleOrSingleton(Exp.tuple);

let generateErrorCase = ({ key }) => {
pc_lhs: [%pat? Belt.Result.Error(e : Decco.decodeError)],
let generateErrorCase: parsedDecl => case = ({ key }) => {
pc_lhs: [%pat? Belt.Result.Error((e: Decco.decodeError))],
pc_guard: None,
pc_rhs: [%expr Belt.Result.Error({ ...e, path: "." ++ [%e key] ++ e.path })]
pc_rhs: [%expr Belt.Result.Error({ ...e, path: "." ++ [%e key] ++ " " ++ e.path })],
};

let generateFinalRecordExpr = (decls) =>
Expand Down Expand Up @@ -81,11 +81,11 @@ let rec generateNestedSwitchesRecurse = (allDecls, remainingDecls) => {

let generateNestedSwitches = (decls) => generateNestedSwitchesRecurse(decls, decls);

let generateDecoder = (decls) => {
let generateDecoder: (Location.t, list(parsedDecl)) => expression = (loc, decls) => {
[%expr (v) =>
switch (Js.Json.classify(v)) {
| Js.Json.JSONObject(dict) => [%e generateNestedSwitches(decls)]
| _ => Decco.error("Not an object", v)
| _ => Decco.error({ path: [%e locToString(loc)], message: "Not an object", value: v })
}
]
};
Expand Down Expand Up @@ -114,10 +114,10 @@ let parseDecl = (generatorSettings, { pld_name: { txt }, pld_loc, pld_type, pld_
};
};

let generateCodecs = ({ doEncode, doDecode } as generatorSettings, decls) => {
let generateCodecs: (Location.t, generatorSettings, list(label_declaration)) => (option(expression), option(expression)) = (loc, { doEncode, doDecode } as generatorSettings, decls) => {
let parsedDecls = List.map(parseDecl(generatorSettings), decls);
(
doEncode ? Some(generateEncoder(parsedDecls)) : None,
doDecode ? Some(generateDecoder(parsedDecls)) : None
doDecode ? Some(generateDecoder(loc, parsedDecls)) : None
)
};
6 changes: 3 additions & 3 deletions ppx_src/bin/Structure.re
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ let generateCodecDecls = (typeName, paramNames, (encoder, decoder)) => {
vbs;
};

let mapTypeDecl = (decl) => {
let mapTypeDecl: type_declaration => list(value_binding) = (decl) => {
let { ptype_attributes, ptype_name: { txt: typeName },
ptype_manifest, ptype_params, ptype_loc, ptype_kind } = decl;

Expand All @@ -65,11 +65,11 @@ let mapTypeDecl = (decl) => {
)
| (None, Ptype_variant(decls)) => generateCodecDecls(
typeName, getParamNames(ptype_params),
Variants.generateCodecs(generatorSettings, decls)
Variants.generateCodecs(ptype_loc, generatorSettings, decls)
)
| (None, Ptype_record(decls)) => generateCodecDecls(
typeName, getParamNames(ptype_params),
Records.generateCodecs(generatorSettings, decls)
Records.generateCodecs(ptype_loc, generatorSettings, decls)
)
| _ => fail(ptype_loc, "This type is not handled by decco")
}
Expand Down
6 changes: 3 additions & 3 deletions ppx_src/bin/Tuple.re
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ let generateDecodeSwitch = (compositeDecoders) => {
|> Exp.match(decodeExpr);
};

let generateDecoder = (compositeDecoders) => {
let generateDecoder = (loc: Location.t, compositeDecoders) => {
let matchArrPattern = compositeDecoders
|> List.mapi((i, _) => Pat.var(Location.mknoloc("v" ++ string_of_int(i))))
|> Pat.array;
Expand All @@ -62,8 +62,8 @@ let generateDecoder = (compositeDecoders) => {

let outerSwitch = Exp.match([%expr Js.Json.classify(json)], [
Exp.case(matchPattern, generateDecodeSwitch(compositeDecoders)),
Exp.case([%pat? Js.Json.JSONArray(_)], [%expr Decco.error("Incorrect cardinality", json)]),
Exp.case([%pat? _], [%expr Decco.error("Not a tuple", json)])
Exp.case([%pat? Js.Json.JSONArray(_)], [%expr Decco.error({ path: [%e locToString(loc)], message: "Incorrect cardinality", value: json })]),
Exp.case([%pat? _], [%expr Decco.error({ path: [%e locToString(loc)], message: "Not a tuple", value: json })])
]);

[%expr (json) => [%e outerSwitch]];
Expand Down
22 changes: 22 additions & 0 deletions ppx_src/bin/Utils.re
Original file line number Diff line number Diff line change
Expand Up @@ -100,3 +100,25 @@ let attrWarning = expr => {
PStr([{pstr_desc: Pstr_eval(expr, []), pstr_loc: loc}]),
);
};

let locToString = (loc: Location.t): expression => {
let line =
loc.loc_start.pos_lnum == loc.loc_end.pos_lnum
? "line " ++ string_of_int(loc.loc_start.pos_lnum)
: "lines "
++ string_of_int(loc.loc_start.pos_lnum)
++ " - "
++ string_of_int(loc.loc_end.pos_lnum);
Ast_convenience_406.str(
~loc,
"File \""
++ Filename.basename(loc.loc_start.pos_fname)
++ "\", "
++ line
++ ", characters "
++ string_of_int(loc.loc_start.pos_cnum - loc.loc_start.pos_bol)
++ " - "
++ string_of_int(loc.loc_end.pos_cnum - loc.loc_end.pos_bol),
);
}

12 changes: 6 additions & 6 deletions ppx_src/bin/Variants.re
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ let generateArgDecoder = (generatorSettings, args, constructorName) => {
);
};

let generateDecoderCase = (generatorSettings, { pcd_name: { txt: name }, pcd_args }) => {
let generateDecoderCase = (generatorSettings, { pcd_name: { txt: name }, pcd_args, pcd_loc }) => {
switch pcd_args {
| Pcstr_tuple(args) => {
let argLen =
Expand All @@ -108,7 +108,7 @@ let generateDecoderCase = (generatorSettings, { pcd_name: { txt: name }, pcd_arg
pc_guard: None,
pc_rhs: [%expr
(Js.Array.length(tagged) !== [%e argLen]) ?
Decco.error("Invalid number of arguments to variant constructor", v)
Decco.error({ path: [%e locToString(pcd_loc)], message: "Invalid number of arguments to variant constructor", value: v })
:
[%e decoded]
]
Expand All @@ -118,7 +118,7 @@ let generateDecoderCase = (generatorSettings, { pcd_name: { txt: name }, pcd_arg
}
};

let generateCodecs = ({ doEncode, doDecode } as generatorSettings, constrDecls) => {
let generateCodecs: (Location.t, generatorSettings, list(constructor_declaration)) => (option(expression), option(expression)) = (loc, { doEncode, doDecode } as generatorSettings, constrDecls) => {
let encoder =
doEncode ?
List.map(generateEncoderCase(generatorSettings), constrDecls)
Expand All @@ -130,7 +130,7 @@ let generateCodecs = ({ doEncode, doDecode } as generatorSettings, constrDecls)
let decoderDefaultCase = {
pc_lhs: [%pat? _],
pc_guard: None,
pc_rhs: [%expr Decco.error("Invalid variant constructor", Belt.Array.getExn(jsonArr, 0))]
pc_rhs: [%expr Decco.error({ path: [%e locToString(loc)], message: "Invalid variant constructor", value: Belt.Array.getExn(jsonArr, 0) })]
};

let decoder =
Expand All @@ -145,14 +145,14 @@ let generateCodecs = ({ doEncode, doDecode } as generatorSettings, constrDecls)
Some([%expr (v) =>
switch (Js.Json.classify(v)) {
| Js.Json.JSONArray([||]) =>
Decco.error("Expected variant, found empty array", v)
Decco.error({ path: [%e locToString(loc)], message: "Expected variant, found empty array", value: v })

| Js.Json.JSONArray(jsonArr) => {
let tagged = Js.Array.map(Js.Json.classify, jsonArr);
[%e decoderSwitch]
}

| _ => Decco.error("Not a variant", v)
| _ => Decco.error({ path: [%e locToString(loc)], message: "Not a variant", value: v })
}
]);
}
Expand Down
Loading