From 462b104d8d631d6cbe1902eaa25f38a534057004 Mon Sep 17 00:00:00 2001 From: Johannes Leupold Date: Wed, 21 Aug 2024 12:49:38 +0000 Subject: [PATCH 1/7] Initial commit --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cf4440d..151595c 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,3 @@ -# vertx-json-path +# Vert.x JSON Path + A complete implementation of the JSON Path Standard (RFC 9535) for use with Vert.x From 14de2bb304ae5c9bf34d7dea4f9cf67ad040c30a Mon Sep 17 00:00:00 2001 From: Johannes Leupold Date: Wed, 21 Aug 2024 14:37:08 +0200 Subject: [PATCH 2/7] Initial Implementation --- .editorconfig | 10 + .gitignore | 56 ++- .gitmodules | 3 + .idea/.gitignore | 3 + .idea/codeStyles/Project.xml | 7 + .idea/codeStyles/codeStyleConfig.xml | 5 + .idea/gradle.xml | 17 + .idea/inspectionProfiles/Project_Default.xml | 6 + .idea/kotlinc.xml | 6 + .idea/misc.xml | 51 ++ .idea/scala_compiler.xml | 6 + .idea/vcs.xml | 7 + build.gradle.kts | 55 ++ gradle.properties | 17 + gradle/wrapper/gradle-wrapper.jar | Bin 0 -> 60756 bytes gradle/wrapper/gradle-wrapper.properties | 6 + gradlew | 234 +++++++++ gradlew.bat | 89 ++++ settings.gradle.kts | 21 + .../com/kobil/vertx/jsonpath/Expression.kt | 108 ++++ .../com/kobil/vertx/jsonpath/JsonPath.kt | 41 ++ .../com/kobil/vertx/jsonpath/Segment.kt | 22 + .../com/kobil/vertx/jsonpath/Selector.kt | 105 ++++ .../jsonpath/compiler/JsonPathCompiler.kt | 52 ++ .../vertx/jsonpath/compiler/JsonPathParser.kt | 470 ++++++++++++++++++ .../jsonpath/compiler/JsonPathScanner.kt | 293 +++++++++++ .../kobil/vertx/jsonpath/compiler/Token.kt | 175 +++++++ .../vertx/jsonpath/error/JsonPathError.kt | 100 ++++ .../vertx/jsonpath/error/JsonPathException.kt | 5 + .../vertx/jsonpath/error/MultipleResults.kt | 4 + .../interpreter/ComparableExpressions.kt | 112 +++++ .../jsonpath/interpreter/FilterExpressions.kt | 156 ++++++ .../vertx/jsonpath/interpreter/Segments.kt | 50 ++ .../vertx/jsonpath/interpreter/Selectors.kt | 93 ++++ .../kobil/vertx/jsonpath/ComplianceTest.kt | 140 ++++++ .../com/kobil/vertx/jsonpath/testing/Util.kt | 6 + .../vertx/jsonpath/testing/VertxExtension.kt | 87 ++++ src/test/resources/compliance-test-suite | 1 + 38 files changed, 2600 insertions(+), 19 deletions(-) create mode 100644 .editorconfig create mode 100644 .gitmodules create mode 100644 .idea/.gitignore create mode 100644 .idea/codeStyles/Project.xml create mode 100644 .idea/codeStyles/codeStyleConfig.xml create mode 100644 .idea/gradle.xml create mode 100644 .idea/inspectionProfiles/Project_Default.xml create mode 100644 .idea/kotlinc.xml create mode 100644 .idea/misc.xml create mode 100644 .idea/scala_compiler.xml create mode 100644 .idea/vcs.xml create mode 100644 build.gradle.kts create mode 100644 gradle.properties create mode 100644 gradle/wrapper/gradle-wrapper.jar create mode 100644 gradle/wrapper/gradle-wrapper.properties create mode 100644 gradlew create mode 100644 gradlew.bat create mode 100644 settings.gradle.kts create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Token.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathException.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/ComparableExpressions.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Segments.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/ComplianceTest.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/testing/Util.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/testing/VertxExtension.kt create mode 160000 src/test/resources/compliance-test-suite diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..47d127a --- /dev/null +++ b/.editorconfig @@ -0,0 +1,10 @@ +root = true + +[*] +insert_final_newline = true +end_of_line = lf + +[*.{kt,kts}] +indent_style = space +indent_size = 2 +max_line_length = 100 \ No newline at end of file diff --git a/.gitignore b/.gitignore index 524f096..3348a20 100644 --- a/.gitignore +++ b/.gitignore @@ -1,24 +1,42 @@ -# Compiled class file -*.class +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ -# Log file -*.log +### IntelliJ IDEA ### +.idea/modules.xml +.idea/jarRepositories.xml +.idea/compiler.xml +.idea/libraries/ +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ -# BlueJ files -*.ctxt +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ -# Mobile Tools for Java (J2ME) -.mtj.tmp/ +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ -# Package Files # -*.jar -*.war -*.nar -*.ear -*.zip -*.tar.gz -*.rar +### VS Code ### +.vscode/ -# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml -hs_err_pid* -replay_pid* +### Mac OS ### +.DS_Store diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..6f678d2 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "jsonpath-compliance-test-suite"] + path = src/test/resources/compliance-test-suite + url = git@github.com:jsonpath-standard/jsonpath-compliance-test-suite.git diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..26d3352 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,3 @@ +# Default ignored files +/shelf/ +/workspace.xml diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml new file mode 100644 index 0000000..919ce1f --- /dev/null +++ b/.idea/codeStyles/Project.xml @@ -0,0 +1,7 @@ + + + + + + \ No newline at end of file diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml new file mode 100644 index 0000000..a55e7a1 --- /dev/null +++ b/.idea/codeStyles/codeStyleConfig.xml @@ -0,0 +1,5 @@ + + + + \ No newline at end of file diff --git a/.idea/gradle.xml b/.idea/gradle.xml new file mode 100644 index 0000000..50a1fae --- /dev/null +++ b/.idea/gradle.xml @@ -0,0 +1,17 @@ + + + + + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml new file mode 100644 index 0000000..b9bf187 --- /dev/null +++ b/.idea/inspectionProfiles/Project_Default.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/kotlinc.xml b/.idea/kotlinc.xml new file mode 100644 index 0000000..6d0ee1c --- /dev/null +++ b/.idea/kotlinc.xml @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..d074712 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,51 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/scala_compiler.xml b/.idea/scala_compiler.xml new file mode 100644 index 0000000..3c0e0f6 --- /dev/null +++ b/.idea/scala_compiler.xml @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..2543e09 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..9f0b9a3 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,55 @@ +plugins { + kotlin("jvm") version "2.0.0" + + id("org.jetbrains.kotlinx.kover") + id("org.sonarqube") version "3.5.0.2730" + + id("org.jlleitschuh.gradle.ktlint") +} + +group = "com.kobil.vertx" +version = "1.0.0" + +repositories { + mavenCentral() +} + +val arrowVersion: String by project +val caffeineVersion: String by project +val kotlinCoroutinesVersion: String by project +val vertxVersion: String by project + +val kotestVersion: String by project +val kotestArrowVersion: String by project + +dependencies { + implementation(kotlin("stdlib-jdk8")) + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$kotlinCoroutinesVersion") + + implementation(platform("io.arrow-kt:arrow-stack:$arrowVersion")) + implementation("io.arrow-kt:arrow-core") + + implementation("com.github.ben-manes.caffeine:caffeine:$caffeineVersion") + + implementation(platform("io.vertx:vertx-stack-depchain:$vertxVersion")) + implementation("io.vertx:vertx-core") + implementation("io.vertx:vertx-lang-kotlin") + implementation("io.vertx:vertx-lang-kotlin-coroutines") + + testImplementation(platform("io.kotest:kotest-bom:$kotestVersion")) + testImplementation("io.kotest:kotest-runner-junit5") + testImplementation("io.kotest:kotest-assertions-core") + testImplementation("io.kotest.extensions:kotest-assertions-arrow:$kotestArrowVersion") +} + +tasks.test { + useJUnitPlatform() +} + +kotlin { + jvmToolchain(21) +} + +ktlint { + version.set("1.3.1") +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..391c5c6 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,17 @@ +kotlin.code.style=official + +# Dependencies +arrowVersion=1.2.4 +caffeineVersion=3.1.8 +kotlinCoroutinesVersion=1.8.1 +vertxVersion=4.5.9 + +# Test Dependencies +kotestVersion=5.9.1 +kotestArrowVersion=1.4.0 + +# Tools +koverVersion=0.8.3 + +ktlintVersion=1.3.1 +ktlintGradleVersion=12.1.0 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000000000000000000000000000000000000..249e5832f090a2944b7473328c07c9755baa3196 GIT binary patch literal 60756 zcmb5WV{~QRw(p$^Dz@00IL3?^hro$gg*4VI_WAaTyVM5Foj~O|-84 z$;06hMwt*rV;^8iB z1~&0XWpYJmG?Ts^K9PC62H*`G}xom%S%yq|xvG~FIfP=9*f zZoDRJBm*Y0aId=qJ?7dyb)6)JGWGwe)MHeNSzhi)Ko6J<-m@v=a%NsP537lHe0R* z`If4$aaBA#S=w!2z&m>{lpTy^Lm^mg*3?M&7HFv}7K6x*cukLIGX;bQG|QWdn{%_6 zHnwBKr84#B7Z+AnBXa16a?or^R?+>$4`}{*a_>IhbjvyTtWkHw)|ay)ahWUd-qq$~ zMbh6roVsj;_qnC-R{G+Cy6bApVOinSU-;(DxUEl!i2)1EeQ9`hrfqj(nKI7?Z>Xur zoJz-a`PxkYit1HEbv|jy%~DO^13J-ut986EEG=66S}D3!L}Efp;Bez~7tNq{QsUMm zh9~(HYg1pA*=37C0}n4g&bFbQ+?-h-W}onYeE{q;cIy%eZK9wZjSwGvT+&Cgv z?~{9p(;bY_1+k|wkt_|N!@J~aoY@|U_RGoWX<;p{Nu*D*&_phw`8jYkMNpRTWx1H* z>J-Mi_!`M468#5Aix$$u1M@rJEIOc?k^QBc?T(#=n&*5eS#u*Y)?L8Ha$9wRWdH^3D4|Ps)Y?m0q~SiKiSfEkJ!=^`lJ(%W3o|CZ zSrZL-Xxc{OrmsQD&s~zPfNJOpSZUl%V8tdG%ei}lQkM+z@-4etFPR>GOH9+Y_F<3=~SXln9Kb-o~f>2a6Xz@AS3cn^;c_>lUwlK(n>z?A>NbC z`Ud8^aQy>wy=$)w;JZzA)_*Y$Z5hU=KAG&htLw1Uh00yE!|Nu{EZkch zY9O6x7Y??>!7pUNME*d!=R#s)ghr|R#41l!c?~=3CS8&zr6*aA7n9*)*PWBV2w+&I zpW1-9fr3j{VTcls1>ua}F*bbju_Xq%^v;-W~paSqlf zolj*dt`BBjHI)H9{zrkBo=B%>8}4jeBO~kWqO!~Thi!I1H(in=n^fS%nuL=X2+s!p}HfTU#NBGiwEBF^^tKU zbhhv+0dE-sbK$>J#t-J!B$TMgN@Wh5wTtK2BG}4BGfsZOoRUS#G8Cxv|6EI*n&Xxq zt{&OxCC+BNqz$9b0WM7_PyBJEVObHFh%%`~!@MNZlo*oXDCwDcFwT~Rls!aApL<)^ zbBftGKKBRhB!{?fX@l2_y~%ygNFfF(XJzHh#?`WlSL{1lKT*gJM zs>bd^H9NCxqxn(IOky5k-wALFowQr(gw%|`0991u#9jXQh?4l|l>pd6a&rx|v=fPJ z1mutj{YzpJ_gsClbWFk(G}bSlFi-6@mwoQh-XeD*j@~huW4(8ub%^I|azA)h2t#yG z7e_V_<4jlM3D(I+qX}yEtqj)cpzN*oCdYHa!nm%0t^wHm)EmFP*|FMw!tb@&`G-u~ zK)=Sf6z+BiTAI}}i{*_Ac$ffr*Wrv$F7_0gJkjx;@)XjYSh`RjAgrCck`x!zP>Ifu z&%he4P|S)H*(9oB4uvH67^0}I-_ye_!w)u3v2+EY>eD3#8QR24<;7?*hj8k~rS)~7 zSXs5ww)T(0eHSp$hEIBnW|Iun<_i`}VE0Nc$|-R}wlSIs5pV{g_Dar(Zz<4X3`W?K z6&CAIl4U(Qk-tTcK{|zYF6QG5ArrEB!;5s?tW7 zrE3hcFY&k)+)e{+YOJ0X2uDE_hd2{|m_dC}kgEKqiE9Q^A-+>2UonB+L@v3$9?AYw zVQv?X*pK;X4Ovc6Ev5Gbg{{Eu*7{N3#0@9oMI~}KnObQE#Y{&3mM4`w%wN+xrKYgD zB-ay0Q}m{QI;iY`s1Z^NqIkjrTlf`B)B#MajZ#9u41oRBC1oM1vq0i|F59> z#StM@bHt|#`2)cpl_rWB($DNJ3Lap}QM-+A$3pe}NyP(@+i1>o^fe-oxX#Bt`mcQc zb?pD4W%#ep|3%CHAYnr*^M6Czg>~L4?l16H1OozM{P*en298b+`i4$|w$|4AHbzqB zHpYUsHZET$Z0ztC;U+0*+amF!@PI%^oUIZy{`L{%O^i{Xk}X0&nl)n~tVEpcAJSJ} zverw15zP1P-O8h9nd!&hj$zuwjg?DoxYIw{jWM zW5_pj+wFy8Tsa9g<7Qa21WaV&;ejoYflRKcz?#fSH_)@*QVlN2l4(QNk| z4aPnv&mrS&0|6NHq05XQw$J^RR9T{3SOcMKCXIR1iSf+xJ0E_Wv?jEc*I#ZPzyJN2 zUG0UOXHl+PikM*&g$U@g+KbG-RY>uaIl&DEtw_Q=FYq?etc!;hEC_}UX{eyh%dw2V zTTSlap&5>PY{6I#(6`j-9`D&I#|YPP8a;(sOzgeKDWsLa!i-$frD>zr-oid!Hf&yS z!i^cr&7tN}OOGmX2)`8k?Tn!!4=tz~3hCTq_9CdiV!NIblUDxHh(FJ$zs)B2(t5@u z-`^RA1ShrLCkg0)OhfoM;4Z{&oZmAec$qV@ zGQ(7(!CBk<5;Ar%DLJ0p0!ResC#U<+3i<|vib1?{5gCebG7$F7URKZXuX-2WgF>YJ^i zMhHDBsh9PDU8dlZ$yJKtc6JA#y!y$57%sE>4Nt+wF1lfNIWyA`=hF=9Gj%sRwi@vd z%2eVV3y&dvAgyuJ=eNJR+*080dbO_t@BFJO<@&#yqTK&+xc|FRR;p;KVk@J3$S{p` zGaMj6isho#%m)?pOG^G0mzOAw0z?!AEMsv=0T>WWcE>??WS=fII$t$(^PDPMU(P>o z_*0s^W#|x)%tx8jIgZY~A2yG;US0m2ZOQt6yJqW@XNY_>_R7(Nxb8Ged6BdYW6{prd!|zuX$@Q2o6Ona8zzYC1u!+2!Y$Jc9a;wy+pXt}o6~Bu1oF1c zp7Y|SBTNi@=I(K%A60PMjM#sfH$y*c{xUgeSpi#HB`?|`!Tb&-qJ3;vxS!TIzuTZs-&%#bAkAyw9m4PJgvey zM5?up*b}eDEY+#@tKec)-c(#QF0P?MRlD1+7%Yk*jW;)`f;0a-ZJ6CQA?E%>i2Dt7T9?s|9ZF|KP4;CNWvaVKZ+Qeut;Jith_y{v*Ny6Co6!8MZx;Wgo z=qAi%&S;8J{iyD&>3CLCQdTX*$+Rx1AwA*D_J^0>suTgBMBb=*hefV+Ars#mmr+YsI3#!F@Xc1t4F-gB@6aoyT+5O(qMz*zG<9Qq*f0w^V!03rpr*-WLH}; zfM{xSPJeu6D(%8HU%0GEa%waFHE$G?FH^kMS-&I3)ycx|iv{T6Wx}9$$D&6{%1N_8 z_CLw)_9+O4&u94##vI9b-HHm_95m)fa??q07`DniVjAy`t7;)4NpeyAY(aAk(+T_O z1om+b5K2g_B&b2DCTK<>SE$Ode1DopAi)xaJjU>**AJK3hZrnhEQ9E`2=|HHe<^tv z63e(bn#fMWuz>4erc47}!J>U58%<&N<6AOAewyzNTqi7hJc|X{782&cM zHZYclNbBwU6673=!ClmxMfkC$(CykGR@10F!zN1Se83LR&a~$Ht&>~43OX22mt7tcZUpa;9@q}KDX3O&Ugp6< zLZLfIMO5;pTee1vNyVC$FGxzK2f>0Z-6hM82zKg44nWo|n}$Zk6&;5ry3`(JFEX$q zK&KivAe${e^5ZGc3a9hOt|!UOE&OocpVryE$Y4sPcs4rJ>>Kbi2_subQ9($2VN(3o zb~tEzMsHaBmBtaHAyES+d3A(qURgiskSSwUc9CfJ@99&MKp2sooSYZu+-0t0+L*!I zYagjOlPgx|lep9tiU%ts&McF6b0VE57%E0Ho%2oi?=Ks+5%aj#au^OBwNwhec zta6QAeQI^V!dF1C)>RHAmB`HnxyqWx?td@4sd15zPd*Fc9hpDXP23kbBenBxGeD$k z;%0VBQEJ-C)&dTAw_yW@k0u?IUk*NrkJ)(XEeI z9Y>6Vel>#s_v@=@0<{4A{pl=9cQ&Iah0iD0H`q)7NeCIRz8zx;! z^OO;1+IqoQNak&pV`qKW+K0^Hqp!~gSohcyS)?^P`JNZXw@gc6{A3OLZ?@1Uc^I2v z+X!^R*HCm3{7JPq{8*Tn>5;B|X7n4QQ0Bs79uTU%nbqOJh`nX(BVj!#f;#J+WZxx4 z_yM&1Y`2XzhfqkIMO7tB3raJKQS+H5F%o83bM+hxbQ zeeJm=Dvix$2j|b4?mDacb67v-1^lTp${z=jc1=j~QD>7c*@+1?py>%Kj%Ejp7Y-!? z8iYRUlGVrQPandAaxFfks53@2EC#0)%mrnmGRn&>=$H$S8q|kE_iWko4`^vCS2aWg z#!`RHUGyOt*k?bBYu3*j3u0gB#v(3tsije zgIuNNWNtrOkx@Pzs;A9un+2LX!zw+p3_NX^Sh09HZAf>m8l@O*rXy_82aWT$Q>iyy zqO7Of)D=wcSn!0+467&!Hl))eff=$aneB?R!YykdKW@k^_uR!+Q1tR)+IJb`-6=jj zymzA>Sv4>Z&g&WWu#|~GcP7qP&m*w-S$)7Xr;(duqCTe7p8H3k5>Y-n8438+%^9~K z3r^LIT_K{i7DgEJjIocw_6d0!<;wKT`X;&vv+&msmhAAnIe!OTdybPctzcEzBy88_ zWO{6i4YT%e4^WQZB)KHCvA(0tS zHu_Bg+6Ko%a9~$EjRB90`P(2~6uI@SFibxct{H#o&y40MdiXblu@VFXbhz>Nko;7R z70Ntmm-FePqhb%9gL+7U8@(ch|JfH5Fm)5${8|`Lef>LttM_iww6LW2X61ldBmG0z zax3y)njFe>j*T{i0s8D4=L>X^j0)({R5lMGVS#7(2C9@AxL&C-lZQx~czI7Iv+{%1 z2hEG>RzX4S8x3v#9sgGAnPzptM)g&LB}@%E>fy0vGSa(&q0ch|=ncKjNrK z`jA~jObJhrJ^ri|-)J^HUyeZXz~XkBp$VhcTEcTdc#a2EUOGVX?@mYx#Vy*!qO$Jv zQ4rgOJ~M*o-_Wptam=~krnmG*p^j!JAqoQ%+YsDFW7Cc9M%YPiBOrVcD^RY>m9Pd< zu}#9M?K{+;UIO!D9qOpq9yxUquQRmQNMo0pT`@$pVt=rMvyX)ph(-CCJLvUJy71DI zBk7oc7)-%ngdj~s@76Yse3L^gV0 z2==qfp&Q~L(+%RHP0n}+xH#k(hPRx(!AdBM$JCfJ5*C=K3ts>P?@@SZ_+{U2qFZb>4kZ{Go37{# zSQc+-dq*a-Vy4?taS&{Ht|MLRiS)Sn14JOONyXqPNnpq&2y~)6wEG0oNy>qvod$FF z`9o&?&6uZjhZ4_*5qWVrEfu(>_n2Xi2{@Gz9MZ8!YmjYvIMasE9yVQL10NBrTCczq zcTY1q^PF2l!Eraguf{+PtHV3=2A?Cu&NN&a8V(y;q(^_mFc6)%Yfn&X&~Pq zU1?qCj^LF(EQB1F`8NxNjyV%fde}dEa(Hx=r7$~ts2dzDwyi6ByBAIx$NllB4%K=O z$AHz1<2bTUb>(MCVPpK(E9wlLElo(aSd(Os)^Raum`d(g9Vd_+Bf&V;l=@mM=cC>) z)9b0enb)u_7V!!E_bl>u5nf&Rl|2r=2F3rHMdb7y9E}}F82^$Rf+P8%dKnOeKh1vs zhH^P*4Ydr^$)$h@4KVzxrHyy#cKmWEa9P5DJ|- zG;!Qi35Tp7XNj60=$!S6U#!(${6hyh7d4q=pF{`0t|N^|L^d8pD{O9@tF~W;#Je*P z&ah%W!KOIN;SyAEhAeTafJ4uEL`(RtnovM+cb(O#>xQnk?dzAjG^~4$dFn^<@-Na3 z395;wBnS{t*H;Jef2eE!2}u5Ns{AHj>WYZDgQJt8v%x?9{MXqJsGP|l%OiZqQ1aB! z%E=*Ig`(!tHh>}4_z5IMpg{49UvD*Pp9!pxt_gdAW%sIf3k6CTycOT1McPl=_#0?8 zVjz8Hj*Vy9c5-krd-{BQ{6Xy|P$6LJvMuX$* zA+@I_66_ET5l2&gk9n4$1M3LN8(yEViRx&mtd#LD}AqEs?RW=xKC(OCWH;~>(X6h!uDxXIPH06xh z*`F4cVlbDP`A)-fzf>MuScYsmq&1LUMGaQ3bRm6i7OsJ|%uhTDT zlvZA1M}nz*SalJWNT|`dBm1$xlaA>CCiQ zK`xD-RuEn>-`Z?M{1%@wewf#8?F|(@1e0+T4>nmlSRrNK5f)BJ2H*$q(H>zGD0>eL zQ!tl_Wk)k*e6v^m*{~A;@6+JGeWU-q9>?+L_#UNT%G?4&BnOgvm9@o7l?ov~XL+et zbGT)|G7)KAeqb=wHSPk+J1bdg7N3$vp(ekjI1D9V$G5Cj!=R2w=3*4!z*J-r-cyeb zd(i2KmX!|Lhey!snRw z?#$Gu%S^SQEKt&kep)up#j&9}e+3=JJBS(s>MH+|=R(`8xK{mmndWo_r`-w1#SeRD&YtAJ#GiVI*TkQZ}&aq<+bU2+coU3!jCI6E+Ad_xFW*ghnZ$q zAoF*i&3n1j#?B8x;kjSJD${1jdRB;)R*)Ao!9bd|C7{;iqDo|T&>KSh6*hCD!rwv= zyK#F@2+cv3=|S1Kef(E6Niv8kyLVLX&e=U;{0x{$tDfShqkjUME>f8d(5nzSkY6@! z^-0>DM)wa&%m#UF1F?zR`8Y3X#tA!*7Q$P3lZJ%*KNlrk_uaPkxw~ zxZ1qlE;Zo;nb@!SMazSjM>;34ROOoygo%SF);LL>rRonWwR>bmSd1XD^~sGSu$Gg# zFZ`|yKU0%!v07dz^v(tY%;So(e`o{ZYTX`hm;@b0%8|H>VW`*cr8R%3n|ehw2`(9B+V72`>SY}9^8oh$En80mZK9T4abVG*to;E z1_S6bgDOW?!Oy1LwYy=w3q~KKdbNtyH#d24PFjX)KYMY93{3-mPP-H>@M-_>N~DDu zENh~reh?JBAK=TFN-SfDfT^=+{w4ea2KNWXq2Y<;?(gf(FgVp8Zp-oEjKzB%2Iqj;48GmY3h=bcdYJ}~&4tS`Q1sb=^emaW$IC$|R+r-8V- zf0$gGE(CS_n4s>oicVk)MfvVg#I>iDvf~Ov8bk}sSxluG!6#^Z_zhB&U^`eIi1@j( z^CK$z^stBHtaDDHxn+R;3u+>Lil^}fj?7eaGB z&5nl^STqcaBxI@v>%zG|j))G(rVa4aY=B@^2{TFkW~YP!8!9TG#(-nOf^^X-%m9{Z zCC?iC`G-^RcBSCuk=Z`(FaUUe?hf3{0C>>$?Vs z`2Uud9M+T&KB6o4o9kvdi^Q=Bw!asPdxbe#W-Oaa#_NP(qpyF@bVxv5D5))srkU#m zj_KA+#7sqDn*Ipf!F5Byco4HOSd!Ui$l94|IbW%Ny(s1>f4|Mv^#NfB31N~kya9!k zWCGL-$0ZQztBate^fd>R!hXY_N9ZjYp3V~4_V z#eB)Kjr8yW=+oG)BuNdZG?jaZlw+l_ma8aET(s+-x+=F-t#Qoiuu1i`^x8Sj>b^U} zs^z<()YMFP7CmjUC@M=&lA5W7t&cxTlzJAts*%PBDAPuqcV5o7HEnqjif_7xGt)F% zGx2b4w{@!tE)$p=l3&?Bf#`+!-RLOleeRk3 z7#pF|w@6_sBmn1nECqdunmG^}pr5(ZJQVvAt$6p3H(16~;vO>?sTE`Y+mq5YP&PBo zvq!7#W$Gewy`;%6o^!Dtjz~x)T}Bdk*BS#=EY=ODD&B=V6TD2z^hj1m5^d6s)D*wk zu$z~D7QuZ2b?5`p)E8e2_L38v3WE{V`bVk;6fl#o2`) z99JsWhh?$oVRn@$S#)uK&8DL8>An0&S<%V8hnGD7Z^;Y(%6;^9!7kDQ5bjR_V+~wp zfx4m3z6CWmmZ<8gDGUyg3>t8wgJ5NkkiEm^(sedCicP^&3D%}6LtIUq>mXCAt{9eF zNXL$kGcoUTf_Lhm`t;hD-SE)m=iBnxRU(NyL}f6~1uH)`K!hmYZjLI%H}AmEF5RZt z06$wn63GHnApHXZZJ}s^s)j9(BM6e*7IBK6Bq(!)d~zR#rbxK9NVIlgquoMq z=eGZ9NR!SEqP6=9UQg#@!rtbbSBUM#ynF);zKX+|!Zm}*{H z+j=d?aZ2!?@EL7C~%B?6ouCKLnO$uWn;Y6Xz zX8dSwj732u(o*U3F$F=7xwxm>E-B+SVZH;O-4XPuPkLSt_?S0)lb7EEg)Mglk0#eS z9@jl(OnH4juMxY+*r03VDfPx_IM!Lmc(5hOI;`?d37f>jPP$?9jQQIQU@i4vuG6MagEoJrQ=RD7xt@8E;c zeGV*+Pt+t$@pt!|McETOE$9k=_C!70uhwRS9X#b%ZK z%q(TIUXSS^F0`4Cx?Rk07C6wI4!UVPeI~-fxY6`YH$kABdOuiRtl73MqG|~AzZ@iL&^s?24iS;RK_pdlWkhcF z@Wv-Om(Aealfg)D^adlXh9Nvf~Uf@y;g3Y)i(YP zEXDnb1V}1pJT5ZWyw=1i+0fni9yINurD=EqH^ciOwLUGi)C%Da)tyt=zq2P7pV5-G zR7!oq28-Fgn5pW|nlu^b!S1Z#r7!Wtr{5J5PQ>pd+2P7RSD?>(U7-|Y z7ZQ5lhYIl_IF<9?T9^IPK<(Hp;l5bl5tF9>X-zG14_7PfsA>6<$~A338iYRT{a@r_ zuXBaT=`T5x3=s&3=RYx6NgG>No4?5KFBVjE(swfcivcIpPQFx5l+O;fiGsOrl5teR z_Cm+;PW}O0Dwe_(4Z@XZ)O0W-v2X><&L*<~*q3dg;bQW3g7)a#3KiQP>+qj|qo*Hk z?57>f2?f@`=Fj^nkDKeRkN2d$Z@2eNKpHo}ksj-$`QKb6n?*$^*%Fb3_Kbf1(*W9K>{L$mud2WHJ=j0^=g30Xhg8$#g^?36`p1fm;;1@0Lrx+8t`?vN0ZorM zSW?rhjCE8$C|@p^sXdx z|NOHHg+fL;HIlqyLp~SSdIF`TnSHehNCU9t89yr@)FY<~hu+X`tjg(aSVae$wDG*C zq$nY(Y494R)hD!i1|IIyP*&PD_c2FPgeY)&mX1qujB1VHPG9`yFQpLFVQ0>EKS@Bp zAfP5`C(sWGLI?AC{XEjLKR4FVNw(4+9b?kba95ukgR1H?w<8F7)G+6&(zUhIE5Ef% z=fFkL3QKA~M@h{nzjRq!Y_t!%U66#L8!(2-GgFxkD1=JRRqk=n%G(yHKn%^&$dW>; zSjAcjETMz1%205se$iH_)ZCpfg_LwvnsZQAUCS#^FExp8O4CrJb6>JquNV@qPq~3A zZ<6dOU#6|8+fcgiA#~MDmcpIEaUO02L5#T$HV0$EMD94HT_eXLZ2Zi&(! z&5E>%&|FZ`)CN10tM%tLSPD*~r#--K(H-CZqIOb99_;m|D5wdgJ<1iOJz@h2Zkq?} z%8_KXb&hf=2Wza(Wgc;3v3TN*;HTU*q2?#z&tLn_U0Nt!y>Oo>+2T)He6%XuP;fgn z-G!#h$Y2`9>Jtf}hbVrm6D70|ERzLAU>3zoWhJmjWfgM^))T+2u$~5>HF9jQDkrXR z=IzX36)V75PrFjkQ%TO+iqKGCQ-DDXbaE;C#}!-CoWQx&v*vHfyI>$HNRbpvm<`O( zlx9NBWD6_e&J%Ous4yp~s6)Ghni!I6)0W;9(9$y1wWu`$gs<$9Mcf$L*piP zPR0Av*2%ul`W;?-1_-5Zy0~}?`e@Y5A&0H!^ApyVTT}BiOm4GeFo$_oPlDEyeGBbh z1h3q&Dx~GmUS|3@4V36&$2uO8!Yp&^pD7J5&TN{?xphf*-js1fP?B|`>p_K>lh{ij zP(?H%e}AIP?_i^f&Li=FDSQ`2_NWxL+BB=nQr=$ zHojMlXNGauvvwPU>ZLq!`bX-5F4jBJ&So{kE5+ms9UEYD{66!|k~3vsP+mE}x!>%P za98bAU0!h0&ka4EoiDvBM#CP#dRNdXJcb*(%=<(g+M@<)DZ!@v1V>;54En?igcHR2 zhubQMq}VSOK)onqHfczM7YA@s=9*ow;k;8)&?J3@0JiGcP! zP#00KZ1t)GyZeRJ=f0^gc+58lc4Qh*S7RqPIC6GugG1gXe$LIQMRCo8cHf^qXgAa2 z`}t>u2Cq1CbSEpLr~E=c7~=Qkc9-vLE%(v9N*&HF`(d~(0`iukl5aQ9u4rUvc8%m) zr2GwZN4!s;{SB87lJB;veebPmqE}tSpT>+`t?<457Q9iV$th%i__Z1kOMAswFldD6 ztbOvO337S5o#ZZgN2G99_AVqPv!?Gmt3pzgD+Hp3QPQ`9qJ(g=kjvD+fUSS3upJn! zqoG7acIKEFRX~S}3|{EWT$kdz#zrDlJU(rPkxjws_iyLKU8+v|*oS_W*-guAb&Pj1 z35Z`3z<&Jb@2Mwz=KXucNYdY#SNO$tcVFr9KdKm|%^e-TXzs6M`PBper%ajkrIyUe zp$vVxVs9*>Vp4_1NC~Zg)WOCPmOxI1V34QlG4!aSFOH{QqSVq1^1)- z0P!Z?tT&E-ll(pwf0?=F=yOzik=@nh1Clxr9}Vij89z)ePDSCYAqw?lVI?v?+&*zH z)p$CScFI8rrwId~`}9YWPFu0cW1Sf@vRELs&cbntRU6QfPK-SO*mqu|u~}8AJ!Q$z znzu}50O=YbjwKCuSVBs6&CZR#0FTu)3{}qJJYX(>QPr4$RqWiwX3NT~;>cLn*_&1H zaKpIW)JVJ>b{uo2oq>oQt3y=zJjb%fU@wLqM{SyaC6x2snMx-}ivfU<1- znu1Lh;i$3Tf$Kh5Uk))G!D1UhE8pvx&nO~w^fG)BC&L!_hQk%^p`Kp@F{cz>80W&T ziOK=Sq3fdRu*V0=S53rcIfWFazI}Twj63CG(jOB;$*b`*#B9uEnBM`hDk*EwSRdwP8?5T?xGUKs=5N83XsR*)a4|ijz|c{4tIU+4j^A5C<#5 z*$c_d=5ml~%pGxw#?*q9N7aRwPux5EyqHVkdJO=5J>84!X6P>DS8PTTz>7C#FO?k#edkntG+fJk8ZMn?pmJSO@`x-QHq;7^h6GEXLXo1TCNhH z8ZDH{*NLAjo3WM`xeb=X{((uv3H(8&r8fJJg_uSs_%hOH%JDD?hu*2NvWGYD+j)&` zz#_1%O1wF^o5ryt?O0n;`lHbzp0wQ?rcbW(F1+h7_EZZ9{>rePvLAPVZ_R|n@;b$;UchU=0j<6k8G9QuQf@76oiE*4 zXOLQ&n3$NR#p4<5NJMVC*S);5x2)eRbaAM%VxWu9ohlT;pGEk7;002enCbQ>2r-us z3#bpXP9g|mE`65VrN`+3mC)M(eMj~~eOf)do<@l+fMiTR)XO}422*1SL{wyY(%oMpBgJagtiDf zz>O6(m;};>Hi=t8o{DVC@YigqS(Qh+ix3Rwa9aliH}a}IlOCW1@?%h_bRbq-W{KHF z%Vo?-j@{Xi@=~Lz5uZP27==UGE15|g^0gzD|3x)SCEXrx`*MP^FDLl%pOi~~Il;dc z^hrwp9sYeT7iZ)-ajKy@{a`kr0-5*_!XfBpXwEcFGJ;%kV$0Nx;apKrur zJN2J~CAv{Zjj%FolyurtW8RaFmpn&zKJWL>(0;;+q(%(Hx!GMW4AcfP0YJ*Vz!F4g z!ZhMyj$BdXL@MlF%KeInmPCt~9&A!;cRw)W!Hi@0DY(GD_f?jeV{=s=cJ6e}JktJw zQORnxxj3mBxfrH=x{`_^Z1ddDh}L#V7i}$njUFRVwOX?qOTKjfPMBO4y(WiU<)epb zvB9L=%jW#*SL|Nd_G?E*_h1^M-$PG6Pc_&QqF0O-FIOpa4)PAEPsyvB)GKasmBoEt z?_Q2~QCYGH+hW31x-B=@5_AN870vY#KB~3a*&{I=f);3Kv7q4Q7s)0)gVYx2#Iz9g(F2;=+Iy4 z6KI^8GJ6D@%tpS^8boU}zpi=+(5GfIR)35PzrbuXeL1Y1N%JK7PG|^2k3qIqHfX;G zQ}~JZ-UWx|60P5?d1e;AHx!_;#PG%d=^X(AR%i`l0jSpYOpXoKFW~7ip7|xvN;2^? zsYC9fanpO7rO=V7+KXqVc;Q5z%Bj})xHVrgoR04sA2 zl~DAwv=!(()DvH*=lyhIlU^hBkA0$e*7&fJpB0|oB7)rqGK#5##2T`@_I^|O2x4GO z;xh6ROcV<9>?e0)MI(y++$-ksV;G;Xe`lh76T#Htuia+(UrIXrf9?

L(tZ$0BqX1>24?V$S+&kLZ`AodQ4_)P#Q3*4xg8}lMV-FLwC*cN$< zt65Rf%7z41u^i=P*qO8>JqXPrinQFapR7qHAtp~&RZ85$>ob|Js;GS^y;S{XnGiBc zGa4IGvDl?x%gY`vNhv8wgZnP#UYI-w*^4YCZnxkF85@ldepk$&$#3EAhrJY0U)lR{F6sM3SONV^+$;Zx8BD&Eku3K zKNLZyBni3)pGzU0;n(X@1fX8wYGKYMpLmCu{N5-}epPDxClPFK#A@02WM3!myN%bkF z|GJ4GZ}3sL{3{qXemy+#Uk{4>Kf8v11;f8I&c76+B&AQ8udd<8gU7+BeWC`akUU~U zgXoxie>MS@rBoyY8O8Tc&8id!w+_ooxcr!1?#rc$-|SBBtH6S?)1e#P#S?jFZ8u-Bs&k`yLqW|{j+%c#A4AQ>+tj$Y z^CZajspu$F%73E68Lw5q7IVREED9r1Ijsg#@DzH>wKseye>hjsk^{n0g?3+gs@7`i zHx+-!sjLx^fS;fY!ERBU+Q zVJ!e0hJH%P)z!y%1^ZyG0>PN@5W~SV%f>}c?$H8r;Sy-ui>aruVTY=bHe}$e zi&Q4&XK!qT7-XjCrDaufT@>ieQ&4G(SShUob0Q>Gznep9fR783jGuUynAqc6$pYX; z7*O@@JW>O6lKIk0G00xsm|=*UVTQBB`u1f=6wGAj%nHK_;Aqmfa!eAykDmi-@u%6~ z;*c!pS1@V8r@IX9j&rW&d*}wpNs96O2Ute>%yt{yv>k!6zfT6pru{F1M3P z2WN1JDYqoTB#(`kE{H676QOoX`cnqHl1Yaru)>8Ky~VU{)r#{&s86Vz5X)v15ULHA zAZDb{99+s~qI6;-dQ5DBjHJP@GYTwn;Dv&9kE<0R!d z8tf1oq$kO`_sV(NHOSbMwr=To4r^X$`sBW4$gWUov|WY?xccQJN}1DOL|GEaD_!@& z15p?Pj+>7d`@LvNIu9*^hPN)pwcv|akvYYq)ks%`G>!+!pW{-iXPZsRp8 z35LR;DhseQKWYSD`%gO&k$Dj6_6q#vjWA}rZcWtQr=Xn*)kJ9kacA=esi*I<)1>w^ zO_+E>QvjP)qiSZg9M|GNeLtO2D7xT6vsj`88sd!94j^AqxFLi}@w9!Y*?nwWARE0P znuI_7A-saQ+%?MFA$gttMV-NAR^#tjl_e{R$N8t2NbOlX373>e7Ox=l=;y#;M7asp zRCz*CLnrm$esvSb5{T<$6CjY zmZ(i{Rs_<#pWW>(HPaaYj`%YqBra=Ey3R21O7vUbzOkJJO?V`4-D*u4$Me0Bx$K(lYo`JO}gnC zx`V}a7m-hLU9Xvb@K2ymioF)vj12<*^oAqRuG_4u%(ah?+go%$kOpfb`T96P+L$4> zQ#S+sA%VbH&mD1k5Ak7^^dZoC>`1L%i>ZXmooA!%GI)b+$D&ziKrb)a=-ds9xk#~& z7)3iem6I|r5+ZrTRe_W861x8JpD`DDIYZNm{$baw+$)X^Jtjnl0xlBgdnNY}x%5za zkQ8E6T<^$sKBPtL4(1zi_Rd(tVth*3Xs!ulflX+70?gb&jRTnI8l+*Aj9{|d%qLZ+ z>~V9Z;)`8-lds*Zgs~z1?Fg?Po7|FDl(Ce<*c^2=lFQ~ahwh6rqSjtM5+$GT>3WZW zj;u~w9xwAhOc<kF}~`CJ68 z?(S5vNJa;kriPlim33{N5`C{9?NWhzsna_~^|K2k4xz1`xcui*LXL-1#Y}Hi9`Oo!zQ>x-kgAX4LrPz63uZ+?uG*84@PKq-KgQlMNRwz=6Yes) zY}>YN+qP}nwr$(CZQFjUOI=-6J$2^XGvC~EZ+vrqWaOXB$k?%Suf5k=4>AveC1aJ! ziaW4IS%F$_Babi)kA8Y&u4F7E%99OPtm=vzw$$ zEz#9rvn`Iot_z-r3MtV>k)YvErZ<^Oa${`2>MYYODSr6?QZu+be-~MBjwPGdMvGd!b!elsdi4% z`37W*8+OGulab8YM?`KjJ8e+jM(tqLKSS@=jimq3)Ea2EB%88L8CaM+aG7;27b?5` z4zuUWBr)f)k2o&xg{iZ$IQkJ+SK>lpq4GEacu~eOW4yNFLU!Kgc{w4&D$4ecm0f}~ zTTzquRW@`f0}|IILl`!1P+;69g^upiPA6F{)U8)muWHzexRenBU$E^9X-uIY2%&1w z_=#5*(nmxJ9zF%styBwivi)?#KMG96-H@hD-H_&EZiRNsfk7mjBq{L%!E;Sqn!mVX*}kXhwH6eh;b42eD!*~upVG@ z#smUqz$ICm!Y8wY53gJeS|Iuard0=;k5i5Z_hSIs6tr)R4n*r*rE`>38Pw&lkv{_r!jNN=;#?WbMj|l>cU(9trCq; z%nN~r^y7!kH^GPOf3R}?dDhO=v^3BeP5hF|%4GNQYBSwz;x({21i4OQY->1G=KFyu z&6d`f2tT9Yl_Z8YACZaJ#v#-(gcyeqXMhYGXb=t>)M@fFa8tHp2x;ODX=Ap@a5I=U z0G80^$N0G4=U(>W%mrrThl0DjyQ-_I>+1Tdd_AuB3qpYAqY54upwa3}owa|x5iQ^1 zEf|iTZxKNGRpI>34EwkIQ2zHDEZ=(J@lRaOH>F|2Z%V_t56Km$PUYu^xA5#5Uj4I4RGqHD56xT%H{+P8Ag>e_3pN$4m8n>i%OyJFPNWaEnJ4McUZPa1QmOh?t8~n& z&RulPCors8wUaqMHECG=IhB(-tU2XvHP6#NrLVyKG%Ee*mQ5Ps%wW?mcnriTVRc4J`2YVM>$ixSF2Xi+Wn(RUZnV?mJ?GRdw%lhZ+t&3s7g!~g{%m&i<6 z5{ib-<==DYG93I(yhyv4jp*y3#*WNuDUf6`vTM%c&hiayf(%=x@4$kJ!W4MtYcE#1 zHM?3xw63;L%x3drtd?jot!8u3qeqctceX3m;tWetK+>~q7Be$h>n6riK(5@ujLgRS zvOym)k+VAtyV^mF)$29Y`nw&ijdg~jYpkx%*^ z8dz`C*g=I?;clyi5|!27e2AuSa$&%UyR(J3W!A=ZgHF9OuKA34I-1U~pyD!KuRkjA zbkN!?MfQOeN>DUPBxoy5IX}@vw`EEB->q!)8fRl_mqUVuRu|C@KD-;yl=yKc=ZT0% zB$fMwcC|HE*0f8+PVlWHi>M`zfsA(NQFET?LrM^pPcw`cK+Mo0%8*x8@65=CS_^$cG{GZQ#xv($7J z??R$P)nPLodI;P!IC3eEYEHh7TV@opr#*)6A-;EU2XuogHvC;;k1aI8asq7ovoP!* z?x%UoPrZjj<&&aWpsbr>J$Er-7!E(BmOyEv!-mbGQGeJm-U2J>74>o5x`1l;)+P&~ z>}f^=Rx(ZQ2bm+YE0u=ZYrAV@apyt=v1wb?R@`i_g64YyAwcOUl=C!i>=Lzb$`tjv zOO-P#A+)t-JbbotGMT}arNhJmmGl-lyUpMn=2UacVZxmiG!s!6H39@~&uVokS zG=5qWhfW-WOI9g4!R$n7!|ViL!|v3G?GN6HR0Pt_L5*>D#FEj5wM1DScz4Jv@Sxnl zB@MPPmdI{(2D?;*wd>3#tjAirmUnQoZrVv`xM3hARuJksF(Q)wd4P$88fGYOT1p6U z`AHSN!`St}}UMBT9o7i|G`r$ zrB=s$qV3d6$W9@?L!pl0lf%)xs%1ko^=QY$ty-57=55PvP(^6E7cc zGJ*>m2=;fOj?F~yBf@K@9qwX0hA803Xw+b0m}+#a(>RyR8}*Y<4b+kpp|OS+!whP( zH`v{%s>jsQI9rd$*vm)EkwOm#W_-rLTHcZRek)>AtF+~<(did)*oR1|&~1|e36d-d zgtm5cv1O0oqgWC%Et@P4Vhm}Ndl(Y#C^MD03g#PH-TFy+7!Osv1z^UWS9@%JhswEq~6kSr2DITo59+; ze=ZC}i2Q?CJ~Iyu?vn|=9iKV>4j8KbxhE4&!@SQ^dVa-gK@YfS9xT(0kpW*EDjYUkoj! zE49{7H&E}k%5(>sM4uGY)Q*&3>{aitqdNnRJkbOmD5Mp5rv-hxzOn80QsG=HJ_atI-EaP69cacR)Uvh{G5dTpYG7d zbtmRMq@Sexey)||UpnZ?;g_KMZq4IDCy5}@u!5&B^-=6yyY{}e4Hh3ee!ZWtL*s?G zxG(A!<9o!CL+q?u_utltPMk+hn?N2@?}xU0KlYg?Jco{Yf@|mSGC<(Zj^yHCvhmyx z?OxOYoxbptDK()tsJ42VzXdINAMWL$0Gcw?G(g8TMB)Khw_|v9`_ql#pRd2i*?CZl z7k1b!jQB=9-V@h%;Cnl7EKi;Y^&NhU0mWEcj8B|3L30Ku#-9389Q+(Yet0r$F=+3p z6AKOMAIi|OHyzlHZtOm73}|ntKtFaXF2Fy|M!gOh^L4^62kGUoWS1i{9gsds_GWBc zLw|TaLP64z3z9?=R2|T6Xh2W4_F*$cq>MtXMOy&=IPIJ`;!Tw?PqvI2b*U1)25^<2 zU_ZPoxg_V0tngA0J+mm?3;OYw{i2Zb4x}NedZug!>EoN3DC{1i)Z{Z4m*(y{ov2%- zk(w>+scOO}MN!exSc`TN)!B=NUX`zThWO~M*ohqq;J2hx9h9}|s#?@eR!=F{QTrq~ zTcY|>azkCe$|Q0XFUdpFT=lTcyW##i;-e{}ORB4D?t@SfqGo_cS z->?^rh$<&n9DL!CF+h?LMZRi)qju!meugvxX*&jfD!^1XB3?E?HnwHP8$;uX{Rvp# zh|)hM>XDv$ZGg=$1{+_bA~u-vXqlw6NH=nkpyWE0u}LQjF-3NhATL@9rRxMnpO%f7 z)EhZf{PF|mKIMFxnC?*78(}{Y)}iztV12}_OXffJ;ta!fcFIVjdchyHxH=t%ci`Xd zX2AUB?%?poD6Zv*&BA!6c5S#|xn~DK01#XvjT!w!;&`lDXSJT4_j$}!qSPrb37vc{ z9^NfC%QvPu@vlxaZ;mIbn-VHA6miwi8qJ~V;pTZkKqqOii<1Cs}0i?uUIss;hM4dKq^1O35y?Yp=l4i zf{M!@QHH~rJ&X~8uATV><23zZUbs-J^3}$IvV_ANLS08>k`Td7aU_S1sLsfi*C-m1 z-e#S%UGs4E!;CeBT@9}aaI)qR-6NU@kvS#0r`g&UWg?fC7|b^_HyCE!8}nyh^~o@< zpm7PDFs9yxp+byMS(JWm$NeL?DNrMCNE!I^ko-*csB+dsf4GAq{=6sfyf4wb>?v1v zmb`F*bN1KUx-`ra1+TJ37bXNP%`-Fd`vVQFTwWpX@;s(%nDQa#oWhgk#mYlY*!d>( zE&!|ySF!mIyfING+#%RDY3IBH_fW$}6~1%!G`suHub1kP@&DoAd5~7J55;5_noPI6eLf{t;@9Kf<{aO0`1WNKd?<)C-|?C?)3s z>wEq@8=I$Wc~Mt$o;g++5qR+(6wt9GI~pyrDJ%c?gPZe)owvy^J2S=+M^ z&WhIE`g;;J^xQLVeCtf7b%Dg#Z2gq9hp_%g)-%_`y*zb; zn9`f`mUPN-Ts&fFo(aNTsXPA|J!TJ{0hZp0^;MYHLOcD=r_~~^ymS8KLCSeU3;^QzJNqS z5{5rEAv#l(X?bvwxpU;2%pQftF`YFgrD1jt2^~Mt^~G>T*}A$yZc@(k9orlCGv&|1 zWWvVgiJsCAtamuAYT~nzs?TQFt<1LSEx!@e0~@yd6$b5!Zm(FpBl;(Cn>2vF?k zOm#TTjFwd2D-CyA!mqR^?#Uwm{NBemP>(pHmM}9;;8`c&+_o3#E5m)JzfwN?(f-a4 zyd%xZc^oQx3XT?vcCqCX&Qrk~nu;fxs@JUoyVoi5fqpi&bUhQ2y!Ok2pzsFR(M(|U zw3E+kH_zmTRQ9dUMZWRE%Zakiwc+lgv7Z%|YO9YxAy`y28`Aw;WU6HXBgU7fl@dnt z-fFBV)}H-gqP!1;V@Je$WcbYre|dRdp{xt!7sL3Eoa%IA`5CAA%;Wq8PktwPdULo! z8!sB}Qt8#jH9Sh}QiUtEPZ6H0b*7qEKGJ%ITZ|vH)5Q^2m<7o3#Z>AKc%z7_u`rXA zqrCy{-{8;9>dfllLu$^M5L z-hXs))h*qz%~ActwkIA(qOVBZl2v4lwbM>9l70Y`+T*elINFqt#>OaVWoja8RMsep z6Or3f=oBnA3vDbn*+HNZP?8LsH2MY)x%c13@(XfuGR}R?Nu<|07{$+Lc3$Uv^I!MQ z>6qWgd-=aG2Y^24g4{Bw9ueOR)(9h`scImD=86dD+MnSN4$6 z^U*o_mE-6Rk~Dp!ANp#5RE9n*LG(Vg`1)g6!(XtDzsov$Dvz|Gv1WU68J$CkshQhS zCrc|cdkW~UK}5NeaWj^F4MSgFM+@fJd{|LLM)}_O<{rj z+?*Lm?owq?IzC%U%9EBga~h-cJbIu=#C}XuWN>OLrc%M@Gu~kFEYUi4EC6l#PR2JS zQUkGKrrS#6H7}2l0F@S11DP`@pih0WRkRJl#F;u{c&ZC{^$Z+_*lB)r)-bPgRFE;* zl)@hK4`tEP=P=il02x7-C7p%l=B`vkYjw?YhdJU9!P!jcmY$OtC^12w?vy3<<=tlY zUwHJ_0lgWN9vf>1%WACBD{UT)1qHQSE2%z|JHvP{#INr13jM}oYv_5#xsnv9`)UAO zuwgyV4YZ;O)eSc3(mka6=aRohi!HH@I#xq7kng?Acdg7S4vDJb6cI5fw?2z%3yR+| zU5v@Hm}vy;${cBp&@D=HQ9j7NcFaOYL zj-wV=eYF{|XTkFNM2uz&T8uH~;)^Zo!=KP)EVyH6s9l1~4m}N%XzPpduPg|h-&lL` zAXspR0YMOKd2yO)eMFFJ4?sQ&!`dF&!|niH*!^*Ml##o0M(0*uK9&yzekFi$+mP9s z>W9d%Jb)PtVi&-Ha!o~Iyh@KRuKpQ@)I~L*d`{O8!kRObjO7=n+Gp36fe!66neh+7 zW*l^0tTKjLLzr`x4`_8&on?mjW-PzheTNox8Hg7Nt@*SbE-%kP2hWYmHu#Fn@Q^J(SsPUz*|EgOoZ6byg3ew88UGdZ>9B2Tq=jF72ZaR=4u%1A6Vm{O#?@dD!(#tmR;eP(Fu z{$0O%=Vmua7=Gjr8nY%>ul?w=FJ76O2js&17W_iq2*tb!i{pt#`qZB#im9Rl>?t?0c zicIC}et_4d+CpVPx)i4~$u6N-QX3H77ez z?ZdvXifFk|*F8~L(W$OWM~r`pSk5}#F?j_5u$Obu9lDWIknO^AGu+Blk7!9Sb;NjS zncZA?qtASdNtzQ>z7N871IsPAk^CC?iIL}+{K|F@BuG2>qQ;_RUYV#>hHO(HUPpk@ z(bn~4|F_jiZi}Sad;_7`#4}EmD<1EiIxa48QjUuR?rC}^HRocq`OQPM@aHVKP9E#q zy%6bmHygCpIddPjE}q_DPC`VH_2m;Eey&ZH)E6xGeStOK7H)#+9y!%-Hm|QF6w#A( zIC0Yw%9j$s-#odxG~C*^MZ?M<+&WJ+@?B_QPUyTg9DJGtQN#NIC&-XddRsf3n^AL6 zT@P|H;PvN;ZpL0iv$bRb7|J{0o!Hq+S>_NrH4@coZtBJu#g8#CbR7|#?6uxi8d+$g z87apN>EciJZ`%Zv2**_uiET9Vk{pny&My;+WfGDw4EVL#B!Wiw&M|A8f1A@ z(yFQS6jfbH{b8Z-S7D2?Ixl`j0{+ZnpT=;KzVMLW{B$`N?Gw^Fl0H6lT61%T2AU**!sX0u?|I(yoy&Xveg7XBL&+>n6jd1##6d>TxE*Vj=8lWiG$4=u{1UbAa5QD>5_ z;Te^42v7K6Mmu4IWT6Rnm>oxrl~b<~^e3vbj-GCdHLIB_>59}Ya+~OF68NiH=?}2o zP(X7EN=quQn&)fK>M&kqF|<_*H`}c zk=+x)GU>{Af#vx&s?`UKUsz})g^Pc&?Ka@t5$n$bqf6{r1>#mWx6Ep>9|A}VmWRnowVo`OyCr^fHsf# zQjQ3Ttp7y#iQY8l`zEUW)(@gGQdt(~rkxlkefskT(t%@i8=|p1Y9Dc5bc+z#n$s13 zGJk|V0+&Ekh(F};PJzQKKo+FG@KV8a<$gmNSD;7rd_nRdc%?9)p!|B-@P~kxQG}~B zi|{0}@}zKC(rlFUYp*dO1RuvPC^DQOkX4<+EwvBAC{IZQdYxoq1Za!MW7%p7gGr=j zzWnAq%)^O2$eItftC#TTSArUyL$U54-O7e|)4_7%Q^2tZ^0-d&3J1}qCzR4dWX!)4 zzIEKjgnYgMus^>6uw4Jm8ga6>GBtMjpNRJ6CP~W=37~||gMo_p@GA@#-3)+cVYnU> zE5=Y4kzl+EbEh%dhQokB{gqNDqx%5*qBusWV%!iprn$S!;oN_6E3?0+umADVs4ako z?P+t?m?};gev9JXQ#Q&KBpzkHPde_CGu-y z<{}RRAx=xlv#mVi+Ibrgx~ujW$h{?zPfhz)Kp7kmYS&_|97b&H&1;J-mzrBWAvY} zh8-I8hl_RK2+nnf&}!W0P+>5?#?7>npshe<1~&l_xqKd0_>dl_^RMRq@-Myz&|TKZBj1=Q()) zF{dBjv5)h=&Z)Aevx}+i|7=R9rG^Di!sa)sZCl&ctX4&LScQ-kMncgO(9o6W6)yd< z@Rk!vkja*X_N3H=BavGoR0@u0<}m-7|2v!0+2h~S2Q&a=lTH91OJsvms2MT~ zY=c@LO5i`mLpBd(vh|)I&^A3TQLtr>w=zoyzTd=^f@TPu&+*2MtqE$Avf>l>}V|3-8Fp2hzo3y<)hr_|NO(&oSD z!vEjTWBxbKTiShVl-U{n*B3#)3a8$`{~Pk}J@elZ=>Pqp|MQ}jrGv7KrNcjW%TN_< zZz8kG{#}XoeWf7qY?D)L)8?Q-b@Na&>i=)(@uNo zr;cH98T3$Iau8Hn*@vXi{A@YehxDE2zX~o+RY`)6-X{8~hMpc#C`|8y> zU8Mnv5A0dNCf{Ims*|l-^ z(MRp{qoGohB34|ggDI*p!Aw|MFyJ|v+<+E3brfrI)|+l3W~CQLPbnF@G0)P~Ly!1TJLp}xh8uW`Q+RB-v`MRYZ9Gam3cM%{ zb4Cb*f)0deR~wtNb*8w-LlIF>kc7DAv>T0D(a3@l`k4TFnrO+g9XH7;nYOHxjc4lq zMmaW6qpgAgy)MckYMhl?>sq;-1E)-1llUneeA!ya9KM$)DaNGu57Z5aE>=VST$#vb zFo=uRHr$0M{-ha>h(D_boS4zId;3B|Tpqo|?B?Z@I?G(?&Iei+-{9L_A9=h=Qfn-U z1wIUnQe9!z%_j$F_{rf&`ZFSott09gY~qrf@g3O=Y>vzAnXCyL!@(BqWa)Zqt!#_k zfZHuwS52|&&)aK;CHq9V-t9qt0au{$#6c*R#e5n3rje0hic7c7m{kW$p(_`wB=Gw7 z4k`1Hi;Mc@yA7dp@r~?@rfw)TkjAW++|pkfOG}0N|2guek}j8Zen(!+@7?qt_7ndX zB=BG6WJ31#F3#Vk3=aQr8T)3`{=p9nBHlKzE0I@v`{vJ}h8pd6vby&VgFhzH|q;=aonunAXL6G2y(X^CtAhWr*jI zGjpY@raZDQkg*aMq}Ni6cRF z{oWv}5`nhSAv>usX}m^GHt`f(t8@zHc?K|y5Zi=4G*UG1Sza{$Dpj%X8 zzEXaKT5N6F5j4J|w#qlZP!zS7BT)9b+!ZSJdToqJts1c!)fwih4d31vfb{}W)EgcA zH2pZ^8_k$9+WD2n`6q5XbOy8>3pcYH9 z07eUB+p}YD@AH!}p!iKv><2QF-Y^&xx^PAc1F13A{nUeCDg&{hnix#FiO!fe(^&%Qcux!h znu*S!s$&nnkeotYsDthh1dq(iQrE|#f_=xVgfiiL&-5eAcC-> z5L0l|DVEM$#ulf{bj+Y~7iD)j<~O8CYM8GW)dQGq)!mck)FqoL^X zwNdZb3->hFrbHFm?hLvut-*uK?zXn3q1z|UX{RZ;-WiLoOjnle!xs+W0-8D)kjU#R z+S|A^HkRg$Ij%N4v~k`jyHffKaC~=wg=9)V5h=|kLQ@;^W!o2^K+xG&2n`XCd>OY5Ydi= zgHH=lgy++erK8&+YeTl7VNyVm9-GfONlSlVb3)V9NW5tT!cJ8d7X)!b-$fb!s76{t z@d=Vg-5K_sqHA@Zx-L_}wVnc@L@GL9_K~Zl(h5@AR#FAiKad8~KeWCo@mgXIQ#~u{ zgYFwNz}2b6Vu@CP0XoqJ+dm8px(5W5-Jpis97F`+KM)TuP*X8H@zwiVKDKGVp59pI zifNHZr|B+PG|7|Y<*tqap0CvG7tbR1R>jn70t1X`XJixiMVcHf%Ez*=xm1(CrTSDt z0cle!+{8*Ja&EOZ4@$qhBuKQ$U95Q%rc7tg$VRhk?3=pE&n+T3upZg^ZJc9~c2es% zh7>+|mrmA-p&v}|OtxqmHIBgUxL~^0+cpfkSK2mhh+4b=^F1Xgd2)}U*Yp+H?ls#z zrLxWg_hm}AfK2XYWr!rzW4g;+^^&bW%LmbtRai9f3PjU${r@n`JThy-cphbcwn)rq9{A$Ht`lmYKxOacy z6v2R(?gHhD5@&kB-Eg?4!hAoD7~(h>(R!s1c1Hx#s9vGPePUR|of32bS`J5U5w{F) z>0<^ktO2UHg<0{oxkdOQ;}coZDQph8p6ruj*_?uqURCMTac;>T#v+l1Tc~%^k-Vd@ zkc5y35jVNc49vZpZx;gG$h{%yslDI%Lqga1&&;mN{Ush1c7p>7e-(zp}6E7f-XmJb4nhk zb8zS+{IVbL$QVF8pf8}~kQ|dHJAEATmmnrb_wLG}-yHe>W|A&Y|;muy-d^t^<&)g5SJfaTH@P1%euONny=mxo+C z4N&w#biWY41r8k~468tvuYVh&XN&d#%QtIf9;iVXfWY)#j=l`&B~lqDT@28+Y!0E+MkfC}}H*#(WKKdJJq=O$vNYCb(ZG@p{fJgu;h z21oHQ(14?LeT>n5)s;uD@5&ohU!@wX8w*lB6i@GEH0pM>YTG+RAIWZD;4#F1&F%Jp zXZUml2sH0!lYJT?&sA!qwez6cXzJEd(1ZC~kT5kZSp7(@=H2$Azb_*W&6aA|9iwCL zdX7Q=42;@dspHDwYE?miGX#L^3xD&%BI&fN9^;`v4OjQXPBaBmOF1;#C)8XA(WFlH zycro;DS2?(G&6wkr6rqC>rqDv3nfGw3hmN_9Al>TgvmGsL8_hXx09};l9Ow@)F5@y z#VH5WigLDwZE4nh^7&@g{1FV^UZ%_LJ-s<{HN*2R$OPg@R~Z`c-ET*2}XB@9xvAjrK&hS=f|R8Gr9 zr|0TGOsI7RD+4+2{ZiwdVD@2zmg~g@^D--YL;6UYGSM8i$NbQr4!c7T9rg!8;TM0E zT#@?&S=t>GQm)*ua|?TLT2ktj#`|R<_*FAkOu2Pz$wEc%-=Y9V*$&dg+wIei3b*O8 z2|m$!jJG!J!ZGbbIa!(Af~oSyZV+~M1qGvelMzPNE_%5?c2>;MeeG2^N?JDKjFYCy z7SbPWH-$cWF9~fX%9~v99L!G(wi!PFp>rB!9xj7=Cv|F+7CsGNwY0Q_J%FID%C^CBZQfJ9K(HK%k31j~e#&?hQ zNuD6gRkVckU)v+53-fc} z7ZCzYN-5RG4H7;>>Hg?LU9&5_aua?A0)0dpew1#MMlu)LHe(M;OHjHIUl7|%%)YPo z0cBk;AOY00%Fe6heoN*$(b<)Cd#^8Iu;-2v@>cE-OB$icUF9EEoaC&q8z9}jMTT2I z8`9;jT%z0;dy4!8U;GW{i`)3!c6&oWY`J3669C!tM<5nQFFrFRglU8f)5Op$GtR-3 zn!+SPCw|04sv?%YZ(a7#L?vsdr7ss@WKAw&A*}-1S|9~cL%uA+E~>N6QklFE>8W|% zyX-qAUGTY1hQ-+um`2|&ji0cY*(qN!zp{YpDO-r>jPk*yuVSay<)cUt`t@&FPF_&$ zcHwu1(SQ`I-l8~vYyUxm@D1UEdFJ$f5Sw^HPH7b!9 zzYT3gKMF((N(v0#4f_jPfVZ=ApN^jQJe-X$`A?X+vWjLn_%31KXE*}5_}d8 zw_B1+a#6T1?>M{ronLbHIlEsMf93muJ7AH5h%;i99<~JX^;EAgEB1uHralD*!aJ@F zV2ruuFe9i2Q1C?^^kmVy921eb=tLDD43@-AgL^rQ3IO9%+vi_&R2^dpr}x{bCVPej z7G0-0o64uyWNtr*loIvslyo0%)KSDDKjfThe0hcqs)(C-MH1>bNGBDRTW~scy_{w} zp^aq8Qb!h9Lwielq%C1b8=?Z=&U)ST&PHbS)8Xzjh2DF?d{iAv)Eh)wsUnf>UtXN( zL7=$%YrZ#|^c{MYmhn!zV#t*(jdmYdCpwqpZ{v&L8KIuKn`@IIZfp!uo}c;7J57N` zAxyZ-uA4=Gzl~Ovycz%MW9ZL7N+nRo&1cfNn9(1H5eM;V_4Z_qVann7F>5f>%{rf= zPBZFaV@_Sobl?Fy&KXyzFDV*FIdhS5`Uc~S^Gjo)aiTHgn#<0C=9o-a-}@}xDor;D zZyZ|fvf;+=3MZd>SR1F^F`RJEZo+|MdyJYQAEauKu%WDol~ayrGU3zzbHKsnHKZ*z zFiwUkL@DZ>!*x05ql&EBq@_Vqv83&?@~q5?lVmffQZ+V-=qL+!u4Xs2Z2zdCQ3U7B&QR9_Iggy} z(om{Y9eU;IPe`+p1ifLx-XWh?wI)xU9ik+m#g&pGdB5Bi<`PR*?92lE0+TkRuXI)z z5LP!N2+tTc%cB6B1F-!fj#}>S!vnpgVU~3!*U1ej^)vjUH4s-bd^%B=ItQqDCGbrEzNQi(dJ`J}-U=2{7-d zK8k^Rlq2N#0G?9&1?HSle2vlkj^KWSBYTwx`2?9TU_DX#J+f+qLiZCqY1TXHFxXZqYMuD@RU$TgcnCC{_(vwZ-*uX)~go#%PK z@}2Km_5aQ~(<3cXeJN6|F8X_1@L%@xTzs}$_*E|a^_URF_qcF;Pfhoe?FTFwvjm1o z8onf@OY@jC2tVcMaZS;|T!Ks(wOgPpRzRnFS-^RZ4E!9dsnj9sFt609a|jJbb1Dt@ z<=Gal2jDEupxUSwWu6zp<<&RnAA;d&4gKVG0iu6g(DsST(4)z6R)zDpfaQ}v{5ARt zyhwvMtF%b-YazR5XLz+oh=mn;y-Mf2a8>7?2v8qX;19y?b>Z5laGHvzH;Nu9S`B8} zI)qN$GbXIQ1VL3lnof^6TS~rvPVg4V?Dl2Bb*K2z4E{5vy<(@@K_cN@U>R!>aUIRnb zL*)=787*cs#zb31zBC49x$`=fkQbMAef)L2$dR{)6BAz!t5U_B#1zZG`^neKSS22oJ#5B=gl%U=WeqL9REF2g zZnfCb0?quf?Ztj$VXvDSWoK`0L=Zxem2q}!XWLoT-kYMOx)!7fcgT35uC~0pySEme z`{wGWTkGr7>+Kb^n;W?BZH6ZP(9tQX%-7zF>vc2}LuWDI(9kh1G#7B99r4x6;_-V+k&c{nPUrR zAXJGRiMe~aup{0qzmLNjS_BC4cB#sXjckx{%_c&^xy{M61xEb>KW_AG5VFXUOjAG4 z^>Qlm9A#1N{4snY=(AmWzatb!ngqiqPbBZ7>Uhb3)dTkSGcL#&SH>iMO-IJBPua`u zo)LWZ>=NZLr758j{%(|uQuZ)pXq_4c!!>s|aDM9#`~1bzK3J1^^D#<2bNCccH7~-X}Ggi!pIIF>uFx%aPARGQsnC8ZQc8lrQ5o~smqOg>Ti^GNme94*w z)JZy{_{#$jxGQ&`M z!OMvZMHR>8*^>eS%o*6hJwn!l8VOOjZQJvh)@tnHVW&*GYPuxqXw}%M!(f-SQf`=L z5;=5w2;%82VMH6Xi&-K3W)o&K^+vJCepWZ-rW%+Dc6X3(){z$@4zjYxQ|}8UIojeC zYZpQ1dU{fy=oTr<4VX?$q)LP}IUmpiez^O&N3E_qPpchGTi5ZM6-2ScWlQq%V&R2Euz zO|Q0Hx>lY1Q1cW5xHv5!0OGU~PVEqSuy#fD72d#O`N!C;o=m+YioGu-wH2k6!t<~K zSr`E=W9)!g==~x9VV~-8{4ZN9{~-A9zJpRe%NGg$+MDuI-dH|b@BD)~>pPCGUNNzY zMDg||0@XGQgw`YCt5C&A{_+J}mvV9Wg{6V%2n#YSRN{AP#PY?1FF1#|vO_%e+#`|2*~wGAJaeRX6=IzFNeWhz6gJc8+(03Ph4y6ELAm=AkN7TOgMUEw*N{= z_)EIDQx5q22oUR+_b*tazu9+pX|n1c*IB-}{DqIj z-?E|ks{o3AGRNb;+iKcHkZvYJvFsW&83RAPs1Oh@IWy%l#5x2oUP6ZCtv+b|q>jsf zZ_9XO;V!>n`UxH1LvH8)L4?8raIvasEhkpQoJ`%!5rBs!0Tu(s_D{`4opB;57)pkX z4$A^8CsD3U5*!|bHIEqsn~{q+Ddj$ME@Gq4JXtgVz&7l{Ok!@?EA{B3P~NAqb9)4? zkQo30A^EbHfQ@87G5&EQTd`frrwL)&Yw?%-W@uy^Gn23%j?Y!Iea2xw<-f;esq zf%w5WN@E1}zyXtYv}}`U^B>W`>XPmdLj%4{P298|SisrE;7HvXX;A}Ffi8B#3Lr;1 zHt6zVb`8{#+e$*k?w8|O{Uh|&AG}|DG1PFo1i?Y*cQm$ZwtGcVgMwtBUDa{~L1KT-{jET4w60>{KZ27vXrHJ;fW{6| z=|Y4!&UX020wU1>1iRgB@Q#m~1^Z^9CG1LqDhYBrnx%IEdIty z!46iOoKlKs)c}newDG)rWUikD%j`)p z_w9Ph&e40=(2eBy;T!}*1p1f1SAUDP9iWy^u^Ubdj21Kn{46;GR+hwLO=4D11@c~V zI8x&(D({K~Df2E)Nx_yQvYfh4;MbMJ@Z}=Dt3_>iim~QZ*hZIlEs0mEb z_54+&*?wMD`2#vsQRN3KvoT>hWofI_Vf(^C1ff-Ike@h@saEf7g}<9T`W;HAne-Nd z>RR+&SP35w)xKn8^U$7))PsM!jKwYZ*RzEcG-OlTrX3}9a{q%#Un5E5W{{hp>w~;` zGky+3(vJvQyGwBo`tCpmo0mo((?nM8vf9aXrrY1Ve}~TuVkB(zeds^jEfI}xGBCM2 zL1|#tycSaWCurP+0MiActG3LCas@_@tao@(R1ANlwB$4K53egNE_;!&(%@Qo$>h`^1S_!hN6 z)vZtG$8fN!|BXBJ=SI>e(LAU(y(i*PHvgQ2llulxS8>qsimv7yL}0q_E5WiAz7)(f zC(ahFvG8&HN9+6^jGyLHM~$)7auppeWh_^zKk&C_MQ~8;N??OlyH~azgz5fe^>~7F zl3HnPN3z-kN)I$4@`CLCMQx3sG~V8hPS^}XDXZrQA>}mQPw%7&!sd(Pp^P=tgp-s^ zjl}1-KRPNWXgV_K^HkP__SR`S-|OF0bR-N5>I%ODj&1JUeAQ3$9i;B~$S6}*^tK?= z**%aCiH7y?xdY?{LgVP}S0HOh%0%LI$wRx;$T|~Y8R)Vdwa}kGWv8?SJVm^>r6+%I z#lj1aR94{@MP;t-scEYQWc#xFA30^}?|BeX*W#9OL;Q9#WqaaM546j5j29((^_8Nu z4uq}ESLr~r*O7E7$D{!k9W>`!SLoyA53i9QwRB{!pHe8um|aDE`Cg0O*{jmor)^t)3`>V>SWN-2VJcFmj^1?~tT=JrP`fVh*t zXHarp=8HEcR#vFe+1a%XXuK+)oFs`GDD}#Z+TJ}Ri`FvKO@ek2ayn}yaOi%(8p%2$ zpEu)v0Jym@f}U|-;}CbR=9{#<^z28PzkkTNvyKvJDZe+^VS2bES3N@Jq!-*}{oQlz z@8bgC_KnDnT4}d#&Cpr!%Yb?E!brx0!eVOw~;lLwUoz#Np%d$o%9scc3&zPm`%G((Le|6o1 zM(VhOw)!f84zG^)tZ1?Egv)d8cdNi+T${=5kV+j;Wf%2{3g@FHp^Gf*qO0q!u$=m9 zCaY`4mRqJ;FTH5`a$affE5dJrk~k`HTP_7nGTY@B9o9vvnbytaID;^b=Tzp7Q#DmD zC(XEN)Ktn39z5|G!wsVNnHi) z%^q94!lL|hF`IijA^9NR0F$@h7k5R^ljOW(;Td9grRN0Mb)l_l7##{2nPQ@?;VjXv zaLZG}yuf$r$<79rVPpXg?6iiieX|r#&`p#Con2i%S8*8F}(E) zI5E6c3tG*<;m~6>!&H!GJ6zEuhH7mkAzovdhLy;)q z{H2*8I^Pb}xC4s^6Y}6bJvMu=8>g&I)7!N!5QG$xseeU#CC?ZM-TbjsHwHgDGrsD= z{%f;@Sod+Ch66Ko2WF~;Ty)v>&x^aovCbCbD7>qF*!?BXmOV3(s|nxsb*Lx_2lpB7 zokUnzrk;P=T-&kUHO}td+Zdj!3n&NR?K~cRU zAXU!DCp?51{J4w^`cV#ye}(`SQhGQkkMu}O3M*BWt4UsC^jCFUy;wTINYmhD$AT;4 z?Xd{HaJjP`raZ39qAm;%beDbrLpbRf(mkKbANan7XsL>_pE2oo^$TgdidjRP!5-`% zv0d!|iKN$c0(T|L0C~XD0aS8t{*&#LnhE;1Kb<9&=c2B+9JeLvJr*AyyRh%@jHej=AetOMSlz^=!kxX>>B{2B1uIrQyfd8KjJ+DBy!h)~*(!|&L4^Q_07SQ~E zcemVP`{9CwFvPFu7pyVGCLhH?LhEVb2{7U+Z_>o25#+3<|8%1T^5dh}*4(kfJGry} zm%r#hU+__Z;;*4fMrX=Bkc@7|v^*B;HAl0((IBPPii%X9+u3DDF6%bI&6?Eu$8&aWVqHIM7mK6?Uvq$1|(-T|)IV<>e?!(rY zqkmO1MRaLeTR=)io(0GVtQT@s6rN%C6;nS3@eu;P#ry4q;^O@1ZKCJyp_Jo)Ty^QW z+vweTx_DLm{P-XSBj~Sl<%_b^$=}odJ!S2wAcxenmzFGX1t&Qp8Vxz2VT`uQsQYtdn&_0xVivIcxZ_hnrRtwq4cZSj1c-SG9 z7vHBCA=fd0O1<4*=lu$6pn~_pVKyL@ztw1swbZi0B?spLo56ZKu5;7ZeUml1Ws1?u zqMf1p{5myAzeX$lAi{jIUqo1g4!zWLMm9cfWcnw`k6*BR^?$2(&yW?>w;G$EmTA@a z6?y#K$C~ZT8+v{87n5Dm&H6Pb_EQ@V0IWmG9cG=O;(;5aMWWrIPzz4Q`mhK;qQp~a z+BbQrEQ+w{SeiuG-~Po5f=^EvlouB@_|4xQXH@A~KgpFHrwu%dwuCR)=B&C(y6J4J zvoGk9;lLs9%iA-IJGU#RgnZZR+@{5lYl8(e1h6&>Vc_mvg0d@);X zji4T|n#lB!>pfL|8tQYkw?U2bD`W{na&;*|znjmalA&f;*U++_aBYerq;&C8Kw7mI z7tsG*?7*5j&dU)Lje;^{D_h`%(dK|pB*A*1(Jj)w^mZ9HB|vGLkF1GEFhu&rH=r=8 zMxO42e{Si6$m+Zj`_mXb&w5Q(i|Yxyg?juUrY}78uo@~3v84|8dfgbPd0iQJRdMj< zncCNGdMEcsxu#o#B5+XD{tsg*;j-eF8`mp~K8O1J!Z0+>0=7O=4M}E?)H)ENE;P*F z$Ox?ril_^p0g7xhDUf(q652l|562VFlC8^r8?lQv;TMvn+*8I}&+hIQYh2 z1}uQQaag&!-+DZ@|C+C$bN6W;S-Z@)d1|en+XGvjbOxCa-qAF*LA=6s(Jg+g;82f$ z(Vb)8I)AH@cdjGFAR5Rqd0wiNCu!xtqWbcTx&5kslzTb^7A78~Xzw1($UV6S^VWiP zFd{Rimd-0CZC_Bu(WxBFW7+k{cOW7DxBBkJdJ;VsJ4Z@lERQr%3eVv&$%)b%<~ zCl^Y4NgO}js@u{|o~KTgH}>!* z_iDNqX2(As7T0xivMH|3SC1ivm8Q}6Ffcd7owUKN5lHAtzMM4<0v+ykUT!QiowO;`@%JGv+K$bBx@*S7C8GJVqQ_K>12}M`f_Ys=S zKFh}HM9#6Izb$Y{wYzItTy+l5U2oL%boCJn?R3?jP@n$zSIwlmyGq30Cw4QBO|14` zW5c);AN*J3&eMFAk$SR~2k|&+&Bc$e>s%c{`?d~85S-UWjA>DS5+;UKZ}5oVa5O(N zqqc@>)nee)+4MUjH?FGv%hm2{IlIF-QX}ym-7ok4Z9{V+ZHVZQl$A*x!(q%<2~iVv znUa+BX35&lCb#9VE-~Y^W_f;Xhl%vgjwdjzMy$FsSIj&ok}L+X`4>J=9BkN&nu^E*gbhj3(+D>C4E z@Fwq_=N)^bKFSHTzZk?-gNU$@l}r}dwGyh_fNi=9b|n}J>&;G!lzilbWF4B}BBq4f zYIOl?b)PSh#XTPp4IS5ZR_2C!E)Z`zH0OW%4;&~z7UAyA-X|sh9@~>cQW^COA9hV4 zXcA6qUo9P{bW1_2`eo6%hgbN%(G-F1xTvq!sc?4wN6Q4`e9Hku zFwvlAcRY?6h^Fj$R8zCNEDq8`=uZB8D-xn)tA<^bFFy}4$vA}Xq0jAsv1&5!h!yRA zU()KLJya5MQ`q&LKdH#fwq&(bNFS{sKlEh_{N%{XCGO+po#(+WCLmKW6&5iOHny>g z3*VFN?mx!16V5{zyuMWDVP8U*|BGT$(%IO|)?EF|OI*sq&RovH!N%=>i_c?K*A>>k zyg1+~++zY4Q)J;VWN0axhoIKx;l&G$gvj(#go^pZskEVj8^}is3Jw26LzYYVos0HX zRPvmK$dVxM8(Tc?pHFe0Z3uq){{#OK3i-ra#@+;*=ui8)y6hsRv z4Fxx1c1+fr!VI{L3DFMwXKrfl#Q8hfP@ajgEau&QMCxd{g#!T^;ATXW)nUg&$-n25 zruy3V!!;{?OTobo|0GAxe`Acn3GV@W=&n;~&9 zQM>NWW~R@OYORkJAo+eq1!4vzmf9K%plR4(tB@TR&FSbDoRgJ8qVcH#;7lQub*nq&?Z>7WM=oeEVjkaG zT#f)=o!M2DO5hLR+op>t0CixJCIeXH*+z{-XS|%jx)y(j&}Wo|3!l7{o)HU3m7LYyhv*xF&tq z%IN7N;D4raue&&hm0xM=`qv`+TK@;_xAcGKuK(2|75~ar2Yw)geNLSmVxV@x89bQu zpViVKKnlkwjS&&c|-X6`~xdnh}Ps)Hs z4VbUL^{XNLf7_|Oi>tA%?SG5zax}esF*FH3d(JH^Gvr7Rp*n=t7frH!U;!y1gJB^i zY_M$KL_}mW&XKaDEi9K-wZR|q*L32&m+2n_8lq$xRznJ7p8}V>w+d@?uB!eS3#u<} zIaqi!b!w}a2;_BfUUhGMy#4dPx>)_>yZ`ai?Rk`}d0>~ce-PfY-b?Csd(28yX22L% zI7XI>OjIHYTk_@Xk;Gu^F52^Gn6E1&+?4MxDS2G_#PQ&yXPXP^<-p|2nLTb@AAQEY zI*UQ9Pmm{Kat}wuazpjSyXCdnrD&|C1c5DIb1TnzF}f4KIV6D)CJ!?&l&{T)e4U%3HTSYqsQ zo@zWB1o}ceQSV)<4G<)jM|@@YpL+XHuWsr5AYh^Q{K=wSV99D~4RRU52FufmMBMmd z_H}L#qe(}|I9ZyPRD6kT>Ivj&2Y?qVZq<4bG_co_DP`sE*_Xw8D;+7QR$Uq(rr+u> z8bHUWbV19i#)@@G4bCco@Xb<8u~wVDz9S`#k@ciJtlu@uP1U0X?yov8v9U3VOig2t zL9?n$P3=1U_Emi$#slR>N5wH-=J&T=EdUHA}_Z zZIl3nvMP*AZS9{cDqFanrA~S5BqxtNm9tlu;^`)3X&V4tMAkJ4gEIPl= zoV!Gyx0N{3DpD@)pv^iS*dl2FwANu;1;%EDl}JQ7MbxLMAp>)UwNwe{=V}O-5C*>F zu?Ny+F64jZn<+fKjF01}8h5H_3pey|;%bI;SFg$w8;IC<8l|3#Lz2;mNNik6sVTG3 z+Su^rIE#40C4a-587$U~%KedEEw1%r6wdvoMwpmlXH$xPnNQN#f%Z7|p)nC>WsuO= z4zyqapLS<8(UJ~Qi9d|dQijb_xhA2)v>la)<1md5s^R1N&PiuA$^k|A<+2C?OiHbj z>Bn$~t)>Y(Zb`8hW7q9xQ=s>Rv81V+UiuZJc<23HplI88isqRCId89fb`Kt|CxVIg znWcwprwXnotO>3s&Oypkte^9yJjlUVVxSe%_xlzmje|mYOVPH^vjA=?6xd0vaj0Oz zwJ4OJNiFdnHJX3rw&inskjryukl`*fRQ#SMod5J|KroJRsVXa5_$q7whSQ{gOi*s0 z1LeCy|JBWRsDPn7jCb4s(p|JZiZ8+*ExC@Vj)MF|*Vp{B(ziccSn`G1Br9bV(v!C2 z6#?eqpJBc9o@lJ#^p-`-=`4i&wFe>2)nlPK1p9yPFzJCzBQbpkcR>={YtamIw)3nt z(QEF;+)4`>8^_LU)_Q3 zC5_7lgi_6y>U%m)m@}Ku4C}=l^J=<<7c;99ec3p{aR+v=diuJR7uZi%aQv$oP?dn?@6Yu_+*^>T0ptf(oobdL;6)N-I!TO`zg^Xbv3#L0I~sn@WGk-^SmPh5>W+LB<+1PU}AKa?FCWF|qMNELOgdxR{ zbqE7@jVe+FklzdcD$!(A$&}}H*HQFTJ+AOrJYnhh}Yvta(B zQ_bW4Rr;R~&6PAKwgLWXS{Bnln(vUI+~g#kl{r+_zbngT`Y3`^Qf=!PxN4IYX#iW4 zucW7@LLJA9Zh3(rj~&SyN_pjO8H&)|(v%!BnMWySBJV=eSkB3YSTCyIeJ{i;(oc%_hk{$_l;v>nWSB)oVeg+blh=HB5JSlG_r7@P z3q;aFoZjD_qS@zygYqCn=;Zxjo!?NK!%J$ z52lOP`8G3feEj+HTp@Tnn9X~nG=;tS+z}u{mQX_J0kxtr)O30YD%oo)L@wy`jpQYM z@M>Me=95k1p*FW~rHiV1CIfVc{K8r|#Kt(ApkXKsDG$_>76UGNhHExFCw#Ky9*B-z zNq2ga*xax!HMf_|Vp-86r{;~YgQKqu7%szk8$hpvi_2I`OVbG1doP(`gn}=W<8%Gn z%81#&WjkH4GV;4u43EtSW>K_Ta3Zj!XF?;SO3V#q=<=>Tc^@?A`i;&`-cYj|;^ zEo#Jl5zSr~_V-4}y8pnufXLa80vZY4z2ko7fj>DR)#z=wWuS1$$W!L?(y}YC+yQ|G z@L&`2upy3f>~*IquAjkVNU>}c10(fq#HdbK$~Q3l6|=@-eBbo>B9(6xV`*)sae58*f zym~RRVx;xoCG3`JV`xo z!lFw)=t2Hy)e!IFs?0~7osWk(d%^wxq&>_XD4+U#y&-VF%4z?XH^i4w`TxpF{`XhZ z%G}iEzf!T(l>g;W9<~K+)$g!{UvhW{E0Lis(S^%I8OF&%kr!gJ&fMOpM=&=Aj@wuL zBX?*6i51Qb$uhkwkFYkaD_UDE+)rh1c;(&Y=B$3)J&iJfQSx!1NGgPtK!$c9OtJuu zX(pV$bfuJpRR|K(dp@^j}i&HeJOh@|7lWo8^$*o~Xqo z5Sb+!EtJ&e@6F+h&+_1ETbg7LfP5GZjvIUIN3ibCOldAv z)>YdO|NH$x7AC8dr=<2ekiY1%fN*r~e5h6Yaw<{XIErujKV~tiyrvV_DV0AzEknC- zR^xKM3i<1UkvqBj3C{wDvytOd+YtDSGu!gEMg+!&|8BQrT*|p)(dwQLEy+ zMtMzij3zo40)CA!BKZF~yWg?#lWhqD3@qR)gh~D{uZaJO;{OWV8XZ_)J@r3=)T|kt zUS1pXr6-`!Z}w2QR7nP%d?ecf90;K_7C3d!UZ`N(TZoWNN^Q~RjVhQG{Y<%E1PpV^4 z-m-K+$A~-+VDABs^Q@U*)YvhY4Znn2^w>732H?NRK(5QSS$V@D7yz2BVX4)f5A04~$WbxGOam22>t&uD)JB8-~yiQW6ik;FGblY_I>SvB_z2?PS z*Qm&qbKI{H1V@YGWzpx`!v)WeLT02};JJo*#f$a*FH?IIad-^(;9XC#YTWN6;Z6+S zm4O1KH=#V@FJw7Pha0!9Vb%ZIM$)a`VRMoiN&C|$YA3~ZC*8ayZRY^fyuP6$n%2IU z$#XceYZeqLTXw(m$_z|33I$B4k~NZO>pP6)H_}R{E$i%USGy{l{-jOE;%CloYPEU+ zRFxOn4;7lIOh!7abb23YKD+_-?O z0FP9otcAh+oSj;=f#$&*ExUHpd&e#bSF%#8*&ItcL2H$Sa)?pt0Xtf+t)z$_u^wZi z44oE}r4kIZGy3!Mc8q$B&6JqtnHZ>Znn!Zh@6rgIu|yU+zG8q`q9%B18|T|oN3zMq z`l&D;U!OL~%>vo&q0>Y==~zLiCZk4v%s_7!9DxQ~id1LLE93gf*gg&2$|hB#j8;?3 z5v4S;oM6rT{Y;I+#FdmNw z){d%tNM<<#GN%n9ox7B=3#;u7unZ~tLB_vRZ52a&2=IM)2VkXm=L+Iqq~uk#Dug|x z>S84e+A7EiOY5lj*!q?6HDkNh~0g;0Jy(al!ZHHDtur9T$y-~)94HelX1NHjXWIM7UAe}$?jiz z9?P4`I0JM=G5K{3_%2jPLC^_Mlw?-kYYgb7`qGa3@dn|^1fRMwiyM@Ch z;CB&o7&&?c5e>h`IM;Wnha0QKnEp=$hA8TJgR-07N~U5(>9vJzeoFsSRBkDq=x(YgEMpb=l4TDD`2 zwVJpWGTA_u7}?ecW7s6%rUs&NXD3+n;jB86`X?8(l3MBo6)PdakI6V6a}22{)8ilT zM~T*mU}__xSy|6XSrJ^%lDAR3Lft%+yxC|ZUvSO_nqMX!_ul3;R#*{~4DA=h$bP)%8Yv9X zyp><|e8=_ttI}ZAwOd#dlnSjck#6%273{E$kJuCGu=I@O)&6ID{nWF5@gLb16sj|&Sb~+du4e4O_%_o`Ix4NRrAsyr1_}MuP94s>de8cH-OUkVPk3+K z&jW)It9QiU-ti~AuJkL`XMca8Oh4$SyJ=`-5WU<{cIh+XVH#e4d&zive_UHC!pN>W z3TB;Mn5i)9Qn)#6@lo4QpI3jFYc0~+jS)4AFz8fVC;lD^+idw^S~Qhq>Tg(!3$yLD zzktzoFrU@6s4wwCMz}edpF5i5Q1IMmEJQHzp(LAt)pgN3&O!&d?3W@6U4)I^2V{;- z6A(?zd93hS*uQmnh4T)nHnE{wVhh(=MMD(h(P4+^p83Om6t<*cUW>l(qJzr%5vp@K zN27ka(L{JX=1~e2^)F^i=TYj&;<7jyUUR2Bek^A8+3Up*&Xwc{)1nRR5CT8vG>ExV zHnF3UqXJOAno_?bnhCX-&kwI~Ti8t4`n0%Up>!U`ZvK^w2+0Cs-b9%w%4`$+To|k= zKtgc&l}P`*8IS>8DOe?EB84^kx4BQp3<7P{Pq}&p%xF_81pg!l2|u=&I{AuUgmF5n zJQCTLv}%}xbFGYtKfbba{CBo)lWW%Z>i(_NvLhoQZ*5-@2l&x>e+I~0Nld3UI9tdL zRzu8}i;X!h8LHVvN?C+|M81e>Jr38%&*9LYQec9Ax>?NN+9(_>XSRv&6hlCYB`>Qm z1&ygi{Y()OU4@D_jd_-7vDILR{>o|7-k)Sjdxkjgvi{@S>6GqiF|o`*Otr;P)kLHN zZkpts;0zw_6;?f(@4S1FN=m!4^mv~W+lJA`&7RH%2$)49z0A+8@0BCHtj|yH--AEL z0tW6G%X-+J+5a{5*WKaM0QDznf;V?L5&uQw+yegDNDP`hA;0XPYc6e0;Xv6|i|^F2WB)Z$LR|HR4 zTQsRAby9(^Z@yATyOgcfQw7cKyr^3Tz7lc7+JEwwzA7)|2x+PtEb>nD(tpxJQm)Kn zW9K_*r!L%~N*vS8<5T=iv|o!zTe9k_2jC_j*7ik^M_ zaf%k{WX{-;0*`t`G!&`eW;gChVXnJ-Rn)To8vW-?>>a%QU1v`ZC=U)f8iA@%JG0mZ zDqH;~mgBnrCP~1II<=V9;EBL)J+xzCoiRBaeH&J6rL!{4zIY8tZka?_FBeQeNO3q6 zyG_alW54Ba&wQf{&F1v-r1R6ID)PTsqjIBc+5MHkcW5Fnvi~{-FjKe)t1bl}Y;z@< z=!%zvpRua>>t_x}^}z0<7MI!H2v6|XAyR9!t50q-A)xk0nflgF4*OQlCGK==4S|wc zRMsSscNhRzHMBU8TdcHN!q^I}x0iXJ%uehac|Zs_B$p@CnF)HeXPpB_Za}F{<@6-4 zl%kml@}kHQ(ypD8FsPJ2=14xXJE|b20RUIgs!2|R3>LUMGF6X*B_I|$`Qg=;zm7C z{mEDy9dTmPbued7mlO@phdmAmJ7p@GR1bjCkMw6*G7#4+`k>fk1czdJUB!e@Q(~6# zwo%@p@V5RL0ABU2LH7Asq^quDUho@H>eTZH9f*no9fY0T zD_-9px3e}A!>>kv5wk91%C9R1J_Nh!*&Kk$J3KNxC}c_@zlgpJZ+5L)Nw|^p=2ue}CJtm;uj*Iqr)K})kA$xtNUEvX;4!Px*^&9T_`IN{D z{6~QY=Nau6EzpvufB^hflc#XIsSq0Y9(nf$d~6ZwK}fal92)fr%T3=q{0mP-EyP_G z)UR5h@IX}3Qll2b0oCAcBF>b*@Etu*aTLPU<%C>KoOrk=x?pN!#f_Og-w+;xbFgjQ zXp`et%lDBBh~OcFnMKMUoox0YwBNy`N0q~bSPh@+enQ=4RUw1) zpovN`QoV>vZ#5LvC;cl|6jPr}O5tu!Ipoyib8iXqy}TeJ;4+_7r<1kV0v5?Kv>fYp zg>9L`;XwXa&W7-jf|9~uP2iyF5`5AJ`Q~p4eBU$MCC00`rcSF>`&0fbd^_eqR+}mK z4n*PMMa&FOcc)vTUR zlDUAn-mh`ahi_`f`=39JYTNVjsTa_Y3b1GOIi)6dY)D}xeshB0T8Eov5%UhWd1)u}kjEQ|LDo{tqKKrYIfVz~@dp!! zMOnah@vp)%_-jDTUG09l+;{CkDCH|Q{NqX*uHa1YxFShy*1+;J`gywKaz|2Q{lG8x zP?KBur`}r`!WLKXY_K;C8$EWG>jY3UIh{+BLv0=2)KH%P}6xE2kg)%(-uA6lC?u8}{K(#P*c zE9C8t*u%j2r_{;Rpe1A{9nNXU;b_N0vNgyK!EZVut~}+R2rcbsHilqsOviYh-pYX= zHw@53nlmwYI5W5KP>&`dBZe0Jn?nAdC^HY1wlR6$u^PbpB#AS&5L6zqrXN&7*N2Q` z+Rae1EwS)H=aVSIkr8Ek^1jy2iS2o7mqm~Mr&g5=jjt7VxwglQ^`h#Mx+x2v|9ZAwE$i_9918MjJxTMr?n!bZ6n$}y11u8I9COTU`Z$Fi z!AeAQLMw^gp_{+0QTEJrhL424pVDp%wpku~XRlD3iv{vQ!lAf!_jyqd_h}+Tr1XG| z`*FT*NbPqvHCUsYAkFnM`@l4u_QH&bszpUK#M~XLJt{%?00GXY?u_{gj3Hvs!=N(I z(=AuWPijyoU!r?aFTsa8pLB&cx}$*%;K$e*XqF{~*rA-qn)h^!(-;e}O#B$|S~c+U zN4vyOK0vmtx$5K!?g*+J@G1NmlEI=pyZXZ69tAv=@`t%ag_Hk{LP~OH9iE)I= zaJ69b4kuCkV0V zo(M0#>phpQ_)@j;h%m{-a*LGi(72TP)ws2w*@4|C-3+;=5DmC4s7Lp95%n%@Ko zfdr3-a7m*dys9iIci$A=4NPJ`HfJ;hujLgU)ZRuJI`n;Pw|yksu!#LQnJ#dJysgNb z@@qwR^wrk(jbq4H?d!lNyy72~Dnn87KxsgQ!)|*m(DRM+eC$wh7KnS-mho3|KE)7h zK3k;qZ;K1Lj6uEXLYUYi)1FN}F@-xJ z@@3Hb84sl|j{4$3J}aTY@cbX@pzB_qM~APljrjju6P0tY{C@ zpUCOz_NFmALMv1*blCcwUD3?U6tYs+N%cmJ98D%3)%)Xu^uvzF zS5O!sc#X6?EwsYkvPo6A%O8&y8sCCQH<%f2togVwW&{M;PR!a(ZT_A+jVAbf{@5kL zB@Z(hb$3U{T_}SKA_CoQVU-;j>2J=L#lZ~aQCFg-d<9rzs$_gO&d5N6eFSc z1ml8)P*FSi+k@!^M9nDWR5e@ATD8oxtDu=36Iv2!;dZzidIS(PCtEuXAtlBb1;H%Z zwnC^Ek*D)EX4#Q>R$$WA2sxC_t(!!6Tr?C#@{3}n{<^o;9id1RA&-Pig1e-2B1XpG zliNjgmd3c&%A}s>qf{_j#!Z`fu0xIwm4L0)OF=u(OEmp;bLCIaZX$&J_^Z%4Sq4GZ zPn6sV_#+6pJmDN_lx@1;Zw6Md_p0w9h6mHtzpuIEwNn>OnuRSC2=>fP^Hqgc)xu^4 z<3!s`cORHJh#?!nKI`Et7{3C27+EuH)Gw1f)aoP|B3y?fuVfvpYYmmukx0ya-)TQX zR{ggy5cNf4X|g)nl#jC9p>7|09_S7>1D2GTRBUTW zAkQ=JMRogZqG#v;^=11O6@rPPwvJkr{bW-Qg8`q8GoD#K`&Y+S#%&B>SGRL>;ZunM@49!}Uy zN|bBCJ%sO;@3wl0>0gbl3L@1^O60ONObz8ZI7nder>(udj-jt`;yj^nTQ$L9`OU9W zX4alF#$|GiR47%x@s&LV>2Sz2R6?;2R~5k6V>)nz!o_*1Y!$p>BC5&?hJg_MiE6UBy>RkVZj`9UWbRkN-Hk!S`=BS3t3uyX6)7SF#)71*}`~Ogz z1rap5H6~dhBJ83;q-Y<5V35C2&F^JI-it(=5D#v!fAi9p#UwV~2tZQI+W(Dv?1t9? zfh*xpxxO{-(VGB>!Q&0%^YW_F!@aZS#ucP|YaD#>wd1Fv&Z*SR&mc;asi}1G) z_H>`!akh-Zxq9#io(7%;a$)w+{QH)Y$?UK1Dt^4)up!Szcxnu}kn$0afcfJL#IL+S z5gF_Y30j;{lNrG6m~$Ay?)*V9fZuU@3=kd40=LhazjFrau>(Y>SJNtOz>8x_X-BlA zIpl{i>OarVGj1v(4?^1`R}aQB&WCRQzS~;7R{tDZG=HhgrW@B`W|#cdyj%YBky)P= zpxuOZkW>S6%q7U{VsB#G(^FMsH5QuGXhb(sY+!-R8Bmv6Sx3WzSW<1MPPN1!&PurYky(@`bP9tz z52}LH9Q?+FF5jR6-;|+GVdRA!qtd;}*-h&iIw3Tq3qF9sDIb1FFxGbo&fbG5n8$3F zyY&PWL{ys^dTO}oZ#@sIX^BKW*bon=;te9j5k+T%wJ zNJtoN1~YVj4~YRrlZl)b&kJqp+Z`DqT!la$x&&IxgOQw#yZd-nBP3!7FijBXD|IsU8Zl^ zc6?MKpJQ+7ka|tZQLfchD$PD|;K(9FiLE|eUZX#EZxhG!S-63C$jWX1Yd!6-Yxi-u zjULIr|0-Q%D9jz}IF~S%>0(jOqZ(Ln<$9PxiySr&2Oic7vb<8q=46)Ln%Z|<*z5&> z3f~Zw@m;vR(bESB<=Jqkxn(=#hQw42l(7)h`vMQQTttz9XW6^|^8EK7qhju4r_c*b zJIi`)MB$w@9epwdIfnEBR+?~);yd6C(LeMC& zn&&N*?-g&BBJcV;8&UoZi4Lmxcj16ojlxR~zMrf=O_^i1wGb9X-0@6_rpjPYemIin zmJb+;lHe;Yp=8G)Q(L1bzH*}I>}uAqhj4;g)PlvD9_e_ScR{Ipq|$8NvAvLD8MYr}xl=bU~)f%B3E>r3Bu9_t|ThF3C5~BdOve zEbk^r&r#PT&?^V1cb{72yEWH}TXEE}w>t!cY~rA+hNOTK8FAtIEoszp!qqptS&;r$ zaYV-NX96-h$6aR@1xz6_E0^N49mU)-v#bwtGJm)ibygzJ8!7|WIrcb`$XH~^!a#s& z{Db-0IOTFq#9!^j!n_F}#Z_nX{YzBK8XLPVmc&X`fT7!@$U-@2KM9soGbmOSAmqV z{nr$L^MBo_u^Joyf0E^=eo{Rt0{{e$IFA(#*kP@SQd6lWT2-#>` zP1)7_@IO!9lk>Zt?#CU?cuhiLF&)+XEM9B)cS(gvQT!X3`wL*{fArTS;Ak`J<84du zALKPz4}3nlG8Fo^MH0L|oK2-4xIY!~Oux~1sw!+It)&D3p;+N8AgqKI`ld6v71wy8I!eP0o~=RVcFQR2Gr(eP_JbSytoQ$Yt}l*4r@A8Me94y z8cTDWhqlq^qoAhbOzGBXv^Wa4vUz$(7B!mX`T=x_ueKRRDfg&Uc-e1+z4x$jyW_Pm zp?U;-R#xt^Z8Ev~`m`iL4*c#65Nn)q#=Y0l1AuD&+{|8-Gsij3LUZXpM0Bx0u7WWm zH|%yE@-#XEph2}-$-thl+S;__ciBxSSzHveP%~v}5I%u!z_l_KoW{KRx2=eB33umE zIYFtu^5=wGU`Jab8#}cnYry@9p5UE#U|VVvx_4l49JQ;jQdp(uw=$^A$EA$LM%vmE zvdEOaIcp5qX8wX{mYf0;#51~imYYPn4=k&#DsKTxo{_Mg*;S495?OBY?#gv=edYC* z^O@-sd-qa+U24xvcbL0@C7_6o!$`)sVr-jSJE4XQUQ$?L7}2(}Eixqv;L8AdJAVqc zq}RPgpnDb@E_;?6K58r3h4-!4rT4Ab#rLHLX?eMOfluJk=3i1@Gt1i#iA=O`M0@x! z(HtJP9BMHXEzuD93m|B&woj0g6T?f#^)>J>|I4C5?Gam>n9!8CT%~aT;=oco5d6U8 zMXl(=W;$ND_8+DD*?|5bJ!;8ebESXMUKBAf7YBwNVJibGaJ*(2G`F%wx)grqVPjudiaq^Kl&g$8A2 zWMxMr@_$c}d+;_B`#kUX-t|4VKH&_f^^EP0&=DPLW)H)UzBG%%Tra*5 z%$kyZe3I&S#gfie^z5)!twG={3Cuh)FdeA!Kj<-9** zvT*5%Tb`|QbE!iW-XcOuy39>D3oe6x{>&<#E$o8Ac|j)wq#kQzz|ATd=Z0K!p2$QE zPu?jL8Lb^y3_CQE{*}sTDe!2!dtlFjq&YLY@2#4>XS`}v#PLrpvc4*@q^O{mmnr5D zmyJq~t?8>FWU5vZdE(%4cuZuao0GNjp3~Dt*SLaxI#g_u>hu@k&9Ho*#CZP~lFJHj z(e!SYlLigyc?&5-YxlE{uuk$9b&l6d`uIlpg_z15dPo*iU&|Khx2*A5Fp;8iK_bdP z?T6|^7@lcx2j0T@x>X7|kuuBSB7<^zeY~R~4McconTxA2flHC0_jFxmSTv-~?zVT| zG_|yDqa9lkF*B6_{j=T>=M8r<0s;@z#h)3BQ4NLl@`Xr__o7;~M&dL3J8fP&zLfDfy z);ckcTev{@OUlZ`bCo(-3? z1u1xD`PKgSg?RqeVVsF<1SLF;XYA@Bsa&cY!I48ZJn1V<3d!?s=St?TLo zC0cNr`qD*M#s6f~X>SCNVkva^9A2ZP>CoJ9bvgXe_c}WdX-)pHM5m7O zrHt#g$F0AO+nGA;7dSJ?)|Mo~cf{z2L)Rz!`fpi73Zv)H=a5K)*$5sf_IZypi($P5 zsPwUc4~P-J1@^3C6-r9{V-u0Z&Sl7vNfmuMY4yy*cL>_)BmQF!8Om9Dej%cHxbIzA zhtV0d{=%cr?;bpBPjt@4w=#<>k5ee=TiWAXM2~tUGfm z$s&!Dm0R^V$}fOR*B^kGaipi~rx~A2cS0;t&khV1a4u38*XRUP~f za!rZMtay8bsLt6yFYl@>-y^31(*P!L^^s@mslZy(SMsv9bVoX`O#yBgEcjCmGpyc* zeH$Dw6vB5P*;jor+JOX@;6K#+xc)Z9B8M=x2a@Wx-{snPGpRmOC$zpsqW*JCh@M2Y z#K+M(>=#d^>Of9C`))h<=Bsy)6zaMJ&x-t%&+UcpLjV`jo4R2025 zXaG8EA!0lQa)|dx-@{O)qP6`$rhCkoQqZ`^SW8g-kOwrwsK8 z3ms*AIcyj}-1x&A&vSq{r=QMyp3CHdWH35!sad#!Sm>^|-|afB+Q;|Iq@LFgqIp#Z zD1%H+3I?6RGnk&IFo|u+E0dCxXz4yI^1i!QTu7uvIEH>i3rR{srcST`LIRwdV1P;W z+%AN1NIf@xxvVLiSX`8ILA8MzNqE&7>%jMzGt9wm78bo9<;h*W84i29^w!>V>{N+S zd`5Zmz^G;f=icvoOZfK5#1ctx*~UwD=ab4DGQXehQ!XYnak*dee%YN$_ZPL%KZuz$ zD;$PpT;HM^$KwtQm@7uvT`i6>Hae1CoRVM2)NL<2-k2PiX=eAx+-6j#JI?M}(tuBW zkF%jjLR)O`gI2fcPBxF^HeI|DWwQWHVR!;;{BXXHskxh8F@BMDn`oEi-NHt;CLymW z=KSv5)3dyzec0T5B*`g-MQ<;gz=nIWKUi9ko<|4I(-E0k$QncH>E4l z**1w&#={&zv4Tvhgz#c29`m|;lU-jmaXFMC11 z*dlXDMEOG>VoLMc>!rApwOu2prKSi*!w%`yzGmS+k(zm*CsLK*wv{S_0WX^8A-rKy zbk^Gf_92^7iB_uUF)EE+ET4d|X|>d&mdN?x@vxKAQk`O+r4Qdu>XGy(a(19g;=jU} zFX{O*_NG>!$@jh!U369Lnc+D~qch3uT+_Amyi}*k#LAAwh}k8IPK5a-WZ81ufD>l> z$4cF}GSz>ce`3FAic}6W4Z7m9KGO?(eWqi@L|5Hq0@L|&2flN1PVl}XgQ2q*_n2s3 zt5KtowNkTYB5b;SVuoXA@i5irXO)A&%7?V`1@HGCB&)Wgk+l|^XXChq;u(nyPB}b3 zY>m5jkxpZgi)zfbgv&ec4Zqdvm+D<?Im*mXweS9H+V>)zF#Zp3)bhl$PbISY{5=_z!8&*Jv~NYtI-g!>fDs zmvL5O^U%!^VaKA9gvKw|5?-jk>~%CVGvctKmP$kpnpfN{D8@X*Aazi$txfa%vd-|E z>kYmV66W!lNekJPom29LdZ%(I+ZLZYTXzTg*to~m?7vp%{V<~>H+2}PQ?PPAq`36R z<%wR8v6UkS>Wt#hzGk#44W<%9S=nBfB);6clKwnxY}T*w21Qc3_?IJ@4gYzC7s;WP zVQNI(M=S=JT#xsZy7G`cR(BP9*je0bfeN8JN5~zY(DDs0t{LpHOIbN);?T-69Pf3R zSNe*&p2%AwXHL>__g+xd4Hlc_vu<25H?(`nafS%)3UPP7_4;gk-9ckt8SJRTv5v0M z_Hww`qPudL?ajIR&X*;$y-`<)6dxx1U~5eGS13CB!lX;3w7n&lDDiArbAhSycd}+b zya_3p@A`$kQy;|NJZ~s44Hqo7Hwt}X86NK=(ey>lgWTtGL6k@Gy;PbO!M%1~Wcn2k zUFP|*5d>t-X*RU8g%>|(wwj*~#l4z^Aatf^DWd1Wj#Q*AY0D^V@sC`M zjJc6qXu0I7Y*2;;gGu!plAFzG=J;1%eIOdn zQA>J&e05UN*7I5@yRhK|lbBSfJ+5Uq;!&HV@xfPZrgD}kE*1DSq^=%{o%|LChhl#0 zlMb<^a6ixzpd{kNZr|3jTGeEzuo}-eLT-)Q$#b{!vKx8Tg}swCni>{#%vDY$Ww$84 zew3c9BBovqb}_&BRo#^!G(1Eg((BScRZ}C)Oz?y`T5wOrv);)b^4XR8 zhJo7+<^7)qB>I;46!GySzdneZ>n_E1oWZY;kf94#)s)kWjuJN1c+wbVoNQcmnv}{> zN0pF+Sl3E}UQ$}slSZeLJrwT>Sr}#V(dVaezCQl2|4LN`7L7v&siYR|r7M(*JYfR$ zst3=YaDw$FSc{g}KHO&QiKxuhEzF{f%RJLKe3p*7=oo`WNP)M(9X1zIQPP0XHhY3c znrP{$4#Ol$A0s|4S7Gx2L23dv*Gv2o;h((XVn+9+$qvm}s%zi6nI-_s6?mG! zj{DV;qesJb&owKeEK?=J>UcAlYckA7Sl+I&IN=yasrZOkejir*kE@SN`fk<8Fgx*$ zy&fE6?}G)d_N`){P~U@1jRVA|2*69)KSe_}!~?+`Yb{Y=O~_+@!j<&oVQQMnhoIRU zA0CyF1OFfkK44n*JD~!2!SCPM;PRSk%1XL=0&rz00wxPs&-_eapJy#$h!eqY%nS0{ z!aGg58JIJPF3_ci%n)QSVpa2H`vIe$RD43;#IRfDV&Ibit z+?>HW4{2wOfC6Fw)}4x}i1maDxcE1qi@BS*qcxD2gE@h3#4cgU*D-&3z7D|tVZWt= z-Cy2+*Cm@P4GN_TPUtaVyVesbVDazF@)j8VJ4>XZv!f%}&eO1SvIgr}4`A*3#vat< z_MoByL(qW6L7SFZ#|Gc1fFN)L2PxY+{B8tJp+pxRyz*87)vXR}*=&ahXjBlQKguuf zX6x<<6fQulE^C*KH8~W%ptpaC0l?b=_{~*U4?5Vt;dgM4t_{&UZ1C2j?b>b+5}{IF_CUyvz-@QZPMlJ)r_tS$9kH%RPv#2_nMb zRLj5;chJ72*U`Z@Dqt4$@_+k$%|8m(HqLG!qT4P^DdfvGf&){gKnGCX#H0!;W=AGP zbA&Z`-__a)VTS}kKFjWGk z%|>yE?t*EJ!qeQ%dPk$;xIQ+P0;()PCBDgjJm6Buj{f^awNoVx+9<|lg3%-$G(*f) zll6oOkN|yamn1uyl2*N-lnqRI1cvs_JxLTeahEK=THV$Sz*gQhKNb*p0fNoda#-&F zB-qJgW^g}!TtM|0bS2QZekW7_tKu%GcJ!4?lObt0z_$mZ4rbQ0o=^curCs3bJK6sq z9fu-aW-l#>z~ca(B;4yv;2RZ?tGYAU)^)Kz{L|4oPj zdOf_?de|#yS)p2v8-N||+XL=O*%3+y)oI(HbM)Ds?q8~HPzIP(vs*G`iddbWq}! z(2!VjP&{Z1w+%eUq^ '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..f865bc1 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,21 @@ +pluginManagement { + repositories { + gradlePluginPortal() + mavenCentral() + } + + val koverVersion: String by settings + val ktlintGradleVersion: String by settings + + plugins { + id("org.jetbrains.kotlinx.kover") version koverVersion + + id("org.jlleitschuh.gradle.ktlint") version ktlintGradleVersion + } +} + +plugins { + id("org.gradle.toolchains.foojay-resolver-convention") version "0.8.0" +} + +rootProject.name = "vertx-json-path" diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt new file mode 100644 index 0000000..7acc265 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt @@ -0,0 +1,108 @@ +package com.kobil.vertx.jsonpath + +import arrow.core.Either +import arrow.core.NonEmptyList +import arrow.core.None +import arrow.core.Option +import arrow.core.left +import arrow.core.right +import arrow.core.some +import com.kobil.vertx.jsonpath.compiler.JsonPathCompiler.compileJsonPathFilter +import com.kobil.vertx.jsonpath.compiler.JsonPathCompiler.compileJsonPathQuery +import com.kobil.vertx.jsonpath.compiler.Token +import com.kobil.vertx.jsonpath.error.JsonPathError +import com.kobil.vertx.jsonpath.error.MultipleResults +import io.vertx.core.Vertx + +sealed interface FilterExpression { + data class And( + val operands: NonEmptyList, + ) : FilterExpression + + data class Or( + val operands: NonEmptyList, + ) : FilterExpression + + data class Not( + val operand: FilterExpression, + ) : FilterExpression + + data class Comparison( + val op: Op, + val lhs: ComparableExpression, + val rhs: ComparableExpression, + ) : FilterExpression { + enum class Op { + EQ, + NOT_EQ, + LESS, + LESS_EQ, + GREATER, + GREATER_EQ, + } + } + + data class Existence( + val query: NodeListExpression, + ) : FilterExpression + + companion object { + suspend fun compile( + vertx: Vertx, + filterExpression: String, + ): Either = vertx.compileJsonPathFilter(filterExpression) + } +} + +sealed interface ComparableExpression { + data class Literal( + val token: Token, + val value: Any?, + ) : ComparableExpression +} + +sealed interface NodeListExpression : ComparableExpression + +sealed interface FunctionExpression : ComparableExpression { + val token: Token + + data class Length( + override val token: Token, + val arg: ComparableExpression, + ) : FunctionExpression + + data class Count( + override val token: Token, + val arg: QueryExpression, + ) : FunctionExpression + + data class Match( + override val token: Token, + val subject: ComparableExpression, + val pattern: ComparableExpression, + val full: Boolean = true, + ) : FunctionExpression, + FilterExpression + + data class Value( + override val token: Token, + val arg: QueryExpression, + ) : FunctionExpression +} + +sealed interface QueryExpression : NodeListExpression { + val token: Token + val segments: List + val isSingular: Boolean + get() = segments.all { it.isSingular } + + data class Relative( + override val token: Token, + override val segments: List, + ) : QueryExpression + + data class Absolute( + override val token: Token, + override val segments: List, + ) : QueryExpression +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt new file mode 100644 index 0000000..b8e2cf1 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt @@ -0,0 +1,41 @@ +package com.kobil.vertx.jsonpath + +import arrow.core.Either +import arrow.core.None +import arrow.core.Option +import arrow.core.left +import arrow.core.right +import arrow.core.some +import com.kobil.vertx.jsonpath.compiler.JsonPathCompiler.compileJsonPathQuery +import com.kobil.vertx.jsonpath.error.JsonPathError +import com.kobil.vertx.jsonpath.error.MultipleResults +import com.kobil.vertx.jsonpath.interpreter.evaluate +import io.vertx.core.Vertx +import io.vertx.core.json.JsonArray +import io.vertx.core.json.JsonObject + +data class JsonPath(val segments: List) { + fun evaluate(obj: JsonObject): List = segments.evaluate(obj) + + fun evaluate(arr: JsonArray): List = segments.evaluate(arr) + + fun evaluateSingle(obj: JsonObject): Either> = + segments.evaluate(obj).one() + + fun evaluateSingle(arr: JsonArray): Either> = + segments.evaluate(arr).one() + + companion object { + suspend fun compile( + vertx: Vertx, + jsonPath: String, + ): Either = vertx.compileJsonPathQuery(jsonPath) + + fun List.one(): Either> = + when (size) { + 0 -> None.right() + 1 -> first().some().right() + else -> MultipleResults(this).left() + } + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt new file mode 100644 index 0000000..aaafb1b --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt @@ -0,0 +1,22 @@ +package com.kobil.vertx.jsonpath + +sealed interface Segment { + val selectors: List + val isSingular: Boolean + + data class ChildSegment( + override val selectors: List, + ) : Segment { + override val isSingular: Boolean + get() = + selectors.size == 1 && + (selectors.first() is Selector.Name || selectors.first() is Selector.Index) + } + + data class DescendantSegment( + override val selectors: List, + ) : Segment { + override val isSingular: Boolean + get() = false + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt new file mode 100644 index 0000000..24d3ddb --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt @@ -0,0 +1,105 @@ +package com.kobil.vertx.jsonpath + +import arrow.core.raise.Raise +import com.kobil.vertx.jsonpath.compiler.Token +import com.kobil.vertx.jsonpath.error.JsonPathError +import java.nio.charset.StandardCharsets + +sealed interface Selector { + data class Name( + val name: String, + ) : Selector { + companion object { + private val INVALID_ESCAPE = """(?u[a-fA-F0-9]{4}|[btnfr'"/\\]))""".toRegex() + private val CONTROL_CHARACTER = """[\u0000-\u001F]""".toRegex() + private val INVALID_SURROGATE_PAIR = + """(?>\\u[Dd][89aAbB][0-9a-fA-F]{2}(?!\\u[Dd][CcDdEeFf][0-9a-fA-F]{2}))""".toRegex() + private val LONE_LOW_SURROGATE = + """(?>(?.check( + rawName: Token.Str, + regex: Regex, + reason: () -> String, + ) { + regex.find(rawName.value)?.let { + raise( + JsonPathError.InvalidEscapeSequence( + rawName.value, + rawName.line, + rawName.column, + it.range.first, + reason(), + ), + ) + } + } + + internal fun Raise.unescape(rawName: Token.Str): String { + check(rawName, INVALID_ESCAPE) { "Invalid escape sequence" } + check(rawName, INVALID_SURROGATE_PAIR) { + "A unicode high surrogate must be followed by a low surrogate" + } + check(rawName, LONE_LOW_SURROGATE) { + "A unicode low surrogate must be preceded by a high surrogate" + } + check(rawName, CONTROL_CHARACTER) { "Control characters (U+0000 to U+001F) are disallowed" } + + return rawName + .value + .replace("\\b", "\b") + .replace("\\t", "\t") + .replace("\\n", "\n") + .replace("\\f", "\u000c") + .replace("\\r", "\r") + .replace("\\\"", "\"") + .replace("\\'", "'") + .replace("\\/", "/") + .unescapeUnicode() + .replace("\\\\", "\\") + } + } + } + + data object Wildcard : Selector + + data class Index( + val index: Int, + ) : Selector + + data class Slice( + val first: Int?, + val last: Int?, + val step: Int?, + ) : Selector + + data class Filter( + val filter: FilterExpression, + ) : Selector +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt new file mode 100644 index 0000000..3e5e3f1 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt @@ -0,0 +1,52 @@ +package com.kobil.vertx.jsonpath.compiler + +import arrow.core.Either +import com.github.benmanes.caffeine.cache.Cache +import com.github.benmanes.caffeine.cache.Caffeine +import com.kobil.vertx.jsonpath.FilterExpression +import com.kobil.vertx.jsonpath.JsonPath +import com.kobil.vertx.jsonpath.error.JsonPathError +import io.vertx.core.Vertx +import io.vertx.kotlin.coroutines.dispatcher +import kotlinx.coroutines.CoroutineScope +import kotlinx.coroutines.async +import kotlinx.coroutines.coroutineScope + +object JsonPathCompiler { + private val queryCache: Cache> = + Caffeine + .newBuilder() + .maximumSize(1_000) + .build() + + private val filterCache: Cache> = + Caffeine + .newBuilder() + .maximumSize(1_000) + .build() + + suspend fun Vertx.compileJsonPathQuery(jsonPath: String): Either = + queryCache + .getIfPresent(jsonPath) + ?: launchInScope { + JsonPathParser(JsonPathScanner(jsonPath), this) + .query() + }.also { queryCache.put(jsonPath, it) } + + suspend fun Vertx.compileJsonPathFilter( + filterExpression: String, + ): Either = + filterCache + .getIfPresent(filterExpression) + ?: launchInScope { + JsonPathParser(JsonPathScanner(filterExpression), this) + .filterExpression() + }.also { filterCache.put(filterExpression, it) } + + private suspend inline fun Vertx.launchInScope( + crossinline block: suspend CoroutineScope.() -> T, + ): T = + coroutineScope { + async(dispatcher()) { block() }.await() + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt new file mode 100644 index 0000000..f9adc46 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt @@ -0,0 +1,470 @@ +package com.kobil.vertx.jsonpath.compiler + +import arrow.core.Either +import arrow.core.nonEmptyListOf +import arrow.core.raise.Raise +import arrow.core.raise.either +import arrow.core.raise.ensure +import com.kobil.vertx.jsonpath.ComparableExpression +import com.kobil.vertx.jsonpath.FilterExpression +import com.kobil.vertx.jsonpath.FunctionExpression +import com.kobil.vertx.jsonpath.JsonPath +import com.kobil.vertx.jsonpath.NodeListExpression +import com.kobil.vertx.jsonpath.QueryExpression +import com.kobil.vertx.jsonpath.Segment +import com.kobil.vertx.jsonpath.Selector +import com.kobil.vertx.jsonpath.Selector.Name.Companion.unescape +import com.kobil.vertx.jsonpath.error.JsonPathError +import kotlinx.coroutines.CoroutineScope +import kotlinx.coroutines.channels.Channel +import kotlinx.coroutines.channels.ReceiveChannel +import kotlinx.coroutines.flow.catch +import kotlinx.coroutines.flow.launchIn +import kotlinx.coroutines.flow.onCompletion +import kotlinx.coroutines.flow.onEach + +internal data class JsonPathParser( + val scanner: JsonPathScanner, + val scope: CoroutineScope, +) { + suspend fun query(): Either = + either { + val ch = tokenChannel() + + try { + State(ch, this).run { + require("JSON path query") + JsonPath(segments()) + } + } finally { + ch.cancel() + } + } + + suspend fun filterExpression(): Either = + either { + val ch = tokenChannel() + + try { + State(ch, this).filterExpr() + } finally { + ch.cancel() + } + } + + private fun tokenChannel(): ReceiveChannel = + Channel().also { ch -> + scanner + .tokens() + .catch { ch.close(it) } + .onCompletion { ch.close(it) } + .onEach(ch::send) + .launchIn(scope) + } + + private suspend fun State.filterExpr() = or() + + private suspend fun State.segments(): List = + buildList { + while (!isAtEnd()) { + skipWhiteSpace() + + val dot = takeIf() + + if (dot != null || advanceIf()) { + add(childSegment(dot != null)) + } else if (advanceIf()) { + add(descendantSegment()) + } else { + break + } + } + }.toList() + + private suspend fun State.childSegment(dottedSegment: Boolean): Segment = + Segment.ChildSegment(selectors(dottedSegment, "child")) + + private suspend fun State.descendantSegment(): Segment { + val dottedSegment = !advanceIf() + return Segment.DescendantSegment(selectors(dottedSegment, "descendant")) + } + + private suspend fun State.selectors( + dottedSegment: Boolean, + segmentType: String, + ): List { + val selectors = mutableListOf() + + do { + if (!dottedSegment) skipWhiteSpace() + selectors.add(selector(dottedSegment)) + if (!dottedSegment) skipWhiteSpace() + } while (!dottedSegment && !isAtEnd() && advanceIf()) + + if (!dottedSegment) require("$segmentType segment") + + return selectors.toList() + } + + private suspend fun State.selector(dottedSegment: Boolean): Selector = + when (val t = advance()) { + is Token.Star -> Selector.Wildcard + + is Token.Str -> { + if (dottedSegment) { + illegalSelector( + t, + "Quoted name selectors are only allowed in bracketed segments", + ) + } + Selector.Name(unescape(t)) + } + + is Token.Identifier -> { + if (!dottedSegment) { + illegalSelector( + t, + "Unquoted name selectors are only allowed in dotted segments", + ) + } + Selector.Name(t.value) + } + + is Token.Num -> { + if (dottedSegment) { + illegalSelector( + t, + "Index and slice selectors are only allowed in bracketed segments", + ) + } + + val start = checkInt(t) + val whitespace = takeIf() + + if (advanceIf()) { + skipWhiteSpace() + + // Slice Selector + val end = takeIf()?.let { checkInt(it) } + skipWhiteSpace() + + val step = + if (advanceIf()) { + skipWhiteSpace() + takeIf()?.let { checkInt(it) } + } else { + null + } + + Selector.Slice(start, end, step) + } else { + if (whitespace != null) raise(JsonPathError.UnexpectedToken(whitespace, "index selector")) + Selector.Index(start) + } + } + + is Token.Colon -> { + if (dottedSegment) { + illegalSelector( + t, + "Slice selectors are only allowed in bracketed segments", + ) + } + + skipWhiteSpace() + + // Slice Selector without explicit start + val end = takeIf()?.let { checkInt(it) } + + skipWhiteSpace() + + val step = if (advanceIf()) takeIf()?.let { checkInt(it) } else null + + skipWhiteSpace() + + Selector.Slice(null, end, step) + } + + is Token.QuestionMark -> { + if (dottedSegment) { + illegalSelector( + t, + "Filter selectors are only allowed in bracketed segments", + ) + } + + skipWhiteSpace() + + // Filter Selector + Selector.Filter(filterExpr()) + } + + else -> unexpectedToken(t, "selector") + } + + private fun State.checkInt(number: Token.Num): Int { + ensure(number.absolute is Int) { + JsonPathError.IndicesMustBeIntegers(number.absolute, number.line, number.column) + } + ensure(!number.negative || number.absolute != 0) { + JsonPathError.IllegalCharacter( + '-', + number.line, + number.column, + "An index of -0 is not allowed", + ) + } + return number.intValue + } + + private suspend fun State.queryExpr(): QueryExpression = + when (val t = advance()) { + is Token.At -> QueryExpression.Relative(t, segments()) + is Token.Dollar -> QueryExpression.Absolute(t, segments()) + else -> unexpectedToken(t, "query expression") + } + + private suspend inline fun State.functionExpr( + identifier: Token.Identifier, + parse: State.() -> C, + constructor: (Token, C) -> ComparableExpression, + requireSingular: Boolean = true, + ): ComparableExpression { + require("${identifier.value} function expression") + skipWhiteSpace() + val expr = constructor(identifier, parse().also { if (requireSingular) checkSingular(it) }) + skipWhiteSpace() + require("${identifier.value} function expression") + + return expr + } + + private suspend fun State.functionExpr(identifier: Token.Identifier): ComparableExpression = + when (val name = identifier.value) { + "length" -> functionExpr(identifier, { comparable() }, FunctionExpression::Length) + "count" -> + functionExpr(identifier, { + queryExpr() + }, FunctionExpression::Count, requireSingular = false) + "match", "search" -> { + require("$name function expression") + skipWhiteSpace() + val firstArg = checkSingular(comparable()) + + skipWhiteSpace() + require("$name function expression") + skipWhiteSpace() + + val secondArg = checkSingular(comparable()) + skipWhiteSpace() + require("$name function expression") + + FunctionExpression.Match(identifier, firstArg, secondArg, name == "match") + } + + "value" -> + functionExpr(identifier, { + queryExpr() + }, FunctionExpression::Value, requireSingular = false) + else -> raise(JsonPathError.UnknownFunction(name, identifier.line, identifier.column)) + } + + private suspend fun State.comparable(): ComparableExpression = + when (val t = advance()) { + is Token.Num -> ComparableExpression.Literal(t, t.value) + is Token.Str -> ComparableExpression.Literal(t, unescape(t)) + is Token.Identifier -> + when (t.value) { + "true" -> ComparableExpression.Literal(t, true) + "false" -> ComparableExpression.Literal(t, false) + "null" -> ComparableExpression.Literal(t, null) + else -> functionExpr(t) + } + + is Token.At -> QueryExpression.Relative(t, segments()) + is Token.Dollar -> QueryExpression.Absolute(t, segments()) + else -> unexpectedToken(t, "comparable expression") + } + + private suspend fun State.groupExpr(): FilterExpression { + require("parenthesized expression") + skipWhiteSpace() + val expr = filterExpr() + skipWhiteSpace() + require("parenthesized expression") + + return expr + } + + private suspend fun State.notExpr(): FilterExpression { + require("not expression") + skipWhiteSpace() + return FilterExpression.Not(basicLogicalExpr()) + } + + private suspend fun State.basicLogicalExpr(): FilterExpression { + if (check()) { + return notExpr() + } else if (check()) { + return groupExpr() + } + + val lhs = comparable() + skipWhiteSpace() + val op = takeIf() + + if (op != null) { + if (lhs is FunctionExpression.Match) { + raise( + JsonPathError.UnexpectedToken( + op, + "filter expression with match function", + ), + ) + } + + skipWhiteSpace() + val rhs = comparable() + + return FilterExpression.Comparison( + op.operator, + checkSingular(lhs), + checkSingular(rhs), + ) + } + + return when (lhs) { + is FunctionExpression.Match -> lhs + is NodeListExpression -> FilterExpression.Existence(lhs) + is ComparableExpression.Literal -> + raise( + JsonPathError.UnexpectedToken(lhs.token, "basic logical expression"), + ) + is FunctionExpression -> + raise( + JsonPathError.UnexpectedToken(lhs.token, "basic logical expression"), + ) + } + } + + private fun Raise.checkSingular( + expr: ComparableExpression, + ): ComparableExpression = + expr.apply { + if (this is QueryExpression && + !isSingular + ) { + raise(JsonPathError.MustBeSingularQuery(token.line, token.column)) + } + } + + private suspend fun State.and(): FilterExpression { + var expr = basicLogicalExpr() + skipWhiteSpace() + + while (!isAtEnd() && advanceIf()) { + skipWhiteSpace() + val right = basicLogicalExpr() + + expr = + when (expr) { + is FilterExpression.And -> FilterExpression.And(expr.operands + right) + else -> FilterExpression.And(nonEmptyListOf(expr, right)) + } + skipWhiteSpace() + } + + return expr + } + + private suspend fun State.or(): FilterExpression { + var expr = and() + skipWhiteSpace() + + while (!isAtEnd() && advanceIf()) { + skipWhiteSpace() + + val right = and() + + expr = + when (expr) { + is FilterExpression.Or -> FilterExpression.Or(expr.operands + right) + else -> FilterExpression.Or(nonEmptyListOf(expr, right)) + } + + skipWhiteSpace() + } + + return expr + } + + private suspend fun State.skipWhiteSpace() { + while (advanceIf()) { + // Drop all whitespace tokens + } + } + + private suspend fun State.peek(): Token = + current ?: run { + val first = receiveToken()!! + current = first + first + } + + private suspend fun State.advance(): Token = + peek().also { + current = receiveToken() + } + + private suspend inline fun State.advanceIf(): Boolean { + if (check()) { + advance() + return true + } + + return false + } + + private suspend inline fun State.takeIf(): T? { + if (check()) { + return advance() as T + } + + return null + } + + private suspend inline fun State.require(parsing: String): T = + takeIf() ?: unexpectedToken(peek(), parsing) + + private suspend inline fun State.check(): Boolean = peek() is T + + private suspend fun State.isAtEnd(): Boolean = check() + + private class State( + tokens: ReceiveChannel, + raise: Raise, + var current: Token? = null, + ) : Raise by raise, + ReceiveChannel by tokens { + suspend fun receiveToken(): Token? = + receiveCatching().let { + when { + it.isClosed -> it.exceptionOrNull()?.let { t -> raise(JsonPathError(t)) } + it.isSuccess -> it.getOrThrow() + else -> error("Unexpected Failed channel result") + } + } + } + + private fun State.unexpectedToken( + token: Token, + parsing: String, + ): Nothing { + raise(JsonPathError.UnexpectedToken(token, parsing)) + } + + private fun State.illegalSelector( + token: Token, + reason: String, + ): Nothing = raise(JsonPathError.IllegalSelector(token.line, token.column, reason)) +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt new file mode 100644 index 0000000..dcafabf --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt @@ -0,0 +1,293 @@ +package com.kobil.vertx.jsonpath.compiler + +import arrow.core.raise.Raise +import arrow.core.raise.recover +import com.kobil.vertx.jsonpath.error.JsonPathError +import com.kobil.vertx.jsonpath.error.JsonPathException +import kotlinx.coroutines.flow.Flow +import kotlinx.coroutines.flow.FlowCollector +import kotlinx.coroutines.flow.flow + +internal data class JsonPathScanner( + val expr: String, +) { + fun tokens(): Flow = + flow { + recover( + block = { + val state = State(this@flow, this) + + if (expr.firstOrNull()?.isWhitespace() == true) { + raise(JsonPathError.IllegalCharacter(expr[0], 1, 1, "Leading whitespace is disallowed")) + } + + while (state.current < expr.length) { + state.start = state.current + state.startLine = state.line + state.startColumn = state.column + emit(state.scanToken()) + } + + if (expr.lastOrNull()?.isWhitespace() == true) { + raise( + JsonPathError.IllegalCharacter( + expr.last(), + state.line, + state.column - 1, + "Trailing whitespace is disallowed", + ), + ) + } + + emit(Token.Eof(state.line, state.column)) + }, + recover = { + throw JsonPathException(it) + }, + ) + } + + private fun State.scanToken(): Token = + when (val ch = advance()) { + // Simple one-character tokens + '$' -> Token.Dollar(line, column) + '@' -> Token.At(line, column) + ',' -> Token.Comma(line, column) + '*' -> Token.Star(line, column) + ':' -> Token.Colon(line, column) + '?' -> Token.QuestionMark(line, column) + '[' -> Token.LeftBracket(line, column) + ']' -> Token.RightBracket(line, column) + '(' -> Token.LeftParen(line, column) + ')' -> Token.RightParen(line, column) + + // Potential two-character tokens + '.' -> match('.', { Token.DotDot(line, column) }, { Token.Dot(line, column) }) + '!' -> match('=', { Token.BangEq(line, column) }, { Token.Bang(line, column) }) + '<' -> match('=', { Token.LessEq(line, column) }, { Token.Less(line, column) }) + '>' -> match('=', { Token.GreaterEq(line, column) }, { Token.Greater(line, column) }) + + // Two-character tokens + '=' -> expect('=') { Token.EqEq(line, column) } + '&' -> expect('&') { Token.AndAnd(line, column) } + '|' -> expect('|') { Token.PipePipe(line, column) } + + // Numbers + in '0'..'9', '-' -> scanNumber(ch) + + // Strings + '\'', '\"' -> scanQuotedString(ch) + + // Potential name shorthand + in 'A'..'Z', in 'a'..'z', '_', in '\u0080'..'\ud7ff', in '\ue000'..'\uffff' -> + scanIdentifier() + + ' ', '\t', '\r' -> scanWhitespace(line, column) + '\n' -> { + val l = line + val c = column + + newLine() + scanWhitespace(l, c) + } + + else -> + raise( + JsonPathError.IllegalCharacter( + ch, + line, + column - 1, + "Character not allowed in JSON Path", + ), + ) + } + + private fun State.scanNumber(first: Char): Token.Num { + val negative = first == '-' + + when { + negative && !expr[current].isDigit() -> + raise( + JsonPathError.IllegalCharacter( + expr[current], + line, + column, + "Expecting an integer part after '-'", + ), + ) + + first == '0' && !isAtEnd() && expr[current].isDigit() -> + raise( + JsonPathError.IllegalCharacter( + expr[current], + line, + column - 1, + "Leading zeroes in numbers are not allowed", + ), + ) + + first == '-' && !isAtEnd(1) && expr[current] == '0' && expr[current + 1].isDigit() -> + raise( + JsonPathError.IllegalCharacter( + expr[current], + line, + column, + "Leading zeroes in numbers are not allowed", + ), + ) + } + + while (!isAtEnd() && expr[current].isDigit()) advance() + + var decimal = false + if (!isAtEnd(1) && expr[current] == '.' && expr[current + 1].isDigit()) { + decimal = true + advance() + + while (!isAtEnd() && expr[current].isDigit()) advance() + } + + if (!isAtEnd(2) && + expr[current] in exponent && + ( + (expr[current + 1] in plusMinus && expr[current + 2].isDigit()) || + expr[current + 1].isDigit() + ) + ) { + decimal = true + advance() + if (expr[current] in plusMinus) advance() + + while (!isAtEnd() && expr[current].isDigit()) advance() + } + + val strValue = + if (negative) { + expr.substring(start + 1..= expr.length + + private fun State.advance(): Char = expr[current++] + + private fun State.advanceIf(next: Char): Boolean = + if (!isAtEnd() && expr[current] == next) { + true.also { current++ } + } else { + false + } + + private fun State.match( + next: Char, + ifMatch: () -> Token, + ifNoMatch: () -> Token, + ): Token = if (advanceIf(next)) ifMatch() else ifNoMatch() + + private fun State.expect( + next: Char, + ifMatch: () -> Token, + ): Token = + if (advanceIf(next)) { + ifMatch() + } else { + raise(JsonPathError.IllegalCharacter(expr[current], line, column, "Expected '$next'")) + } + + private fun State.newLine() { + line++ + currentLineStart = current + } + + private val State.column: Int + get() = start - currentLineStart + 1 + + class State( + flow: FlowCollector, + raise: Raise, + var start: Int = 0, + var current: Int = 0, + var line: Int = 1, + var currentLineStart: Int = 0, + var startLine: Int = 1, + var startColumn: Int = 1, + ) : Raise by raise, + FlowCollector by flow + + companion object { + private val identifierChar = + ('A'..'Z').toSet() + ('a'..'z') + '_' + ('\u0080'..'\ud7ff') + ('\ue000'..'\uffff') + + ('0'..'9') + private val whitespaceChar = setOf(' ', '\t', '\n', '\r') + private val plusMinus = setOf('+', '-') + private val exponent = setOf('e', 'E') + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Token.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Token.kt new file mode 100644 index 0000000..03f322f --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Token.kt @@ -0,0 +1,175 @@ +package com.kobil.vertx.jsonpath.compiler + +import com.kobil.vertx.jsonpath.FilterExpression + +sealed interface Token { + val line: Int + val column: Int + val name: String + get() = this::class.simpleName!! + + sealed interface ComparisonOperator : Token { + val operator: FilterExpression.Comparison.Op + } + + sealed interface StringValueToken : Token { + val value: String + } + + data class Whitespace( + override val line: Int, + override val column: Int, + ) : Token + + data class Eof( + override val line: Int, + override val column: Int, + ) : Token + + data class Dollar( + override val line: Int, + override val column: Int, + ) : Token + + data class At( + override val line: Int, + override val column: Int, + ) : Token + + data class Comma( + override val line: Int, + override val column: Int, + ) : Token + + data class Star( + override val line: Int, + override val column: Int, + ) : Token + + data class Colon( + override val line: Int, + override val column: Int, + ) : Token + + data class QuestionMark( + override val line: Int, + override val column: Int, + ) : Token + + data class LeftBracket( + override val line: Int, + override val column: Int, + ) : Token + + data class RightBracket( + override val line: Int, + override val column: Int, + ) : Token + + data class LeftParen( + override val line: Int, + override val column: Int, + ) : Token + + data class RightParen( + override val line: Int, + override val column: Int, + ) : Token + + data class Dot( + override val line: Int, + override val column: Int, + ) : Token + + data class DotDot( + override val line: Int, + override val column: Int, + ) : Token + + data class EqEq( + override val line: Int, + override val column: Int, + ) : ComparisonOperator { + override val operator: FilterExpression.Comparison.Op = FilterExpression.Comparison.Op.EQ + } + + data class Bang( + override val line: Int, + override val column: Int, + ) : Token + + data class BangEq( + override val line: Int, + override val column: Int, + ) : ComparisonOperator { + override val operator: FilterExpression.Comparison.Op = FilterExpression.Comparison.Op.NOT_EQ + } + + data class Less( + override val line: Int, + override val column: Int, + ) : ComparisonOperator { + override val operator: FilterExpression.Comparison.Op = FilterExpression.Comparison.Op.LESS + } + + data class LessEq( + override val line: Int, + override val column: Int, + ) : ComparisonOperator { + override val operator: FilterExpression.Comparison.Op = FilterExpression.Comparison.Op.LESS_EQ + } + + data class Greater( + override val line: Int, + override val column: Int, + ) : ComparisonOperator { + override val operator: FilterExpression.Comparison.Op = FilterExpression.Comparison.Op.GREATER + } + + data class GreaterEq( + override val line: Int, + override val column: Int, + ) : ComparisonOperator { + override val operator: FilterExpression.Comparison.Op = + FilterExpression.Comparison.Op.GREATER_EQ + } + + data class AndAnd( + override val line: Int, + override val column: Int, + ) : Token + + data class PipePipe( + override val line: Int, + override val column: Int, + ) : Token + + data class Str( + override val line: Int, + override val column: Int, + override val value: String, + ) : StringValueToken + + data class Num( + override val line: Int, + override val column: Int, + val negative: Boolean, + val absolute: Number, + ) : Token { + val intValue: Int + get() = if (negative) -(absolute as Int) else absolute as Int + val value: Number + get() = + when (absolute) { + is Double -> if (negative) -absolute else absolute + is Int -> if (negative) -absolute else absolute + else -> error("unreachable") + } + } + + data class Identifier( + override val line: Int, + override val column: Int, + override val value: String, + ) : StringValueToken +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt new file mode 100644 index 0000000..060c643 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt @@ -0,0 +1,100 @@ +package com.kobil.vertx.jsonpath.error + +import com.kobil.vertx.jsonpath.compiler.Token + +sealed interface JsonPathError { + data class IllegalCharacter( + val char: Char, + val line: Int, + val column: Int, + val reason: String, + ) : JsonPathError { + override fun toString(): String = + "${messagePrefix(line, column)}: Illegal character '$char' ($reason)" + } + + data class UnterminatedString( + val line: Int, + val column: Int, + val startLine: Int, + val startColumn: Int, + ) : JsonPathError { + override fun toString(): String = + "${messagePrefix( + line, + column, + )}: Unterminated string literal starting at [$startLine:$startColumn]" + } + + data class UnexpectedToken( + val token: Token, + val parsing: String, + ) : JsonPathError { + override fun toString(): String = + "${messagePrefix(token.line, token.column)}: Unexpected token while parsing $parsing" + } + + data class IllegalSelector( + val line: Int, + val column: Int, + val reason: String, + ) : JsonPathError { + override fun toString(): String = "${messagePrefix(line, column)}: Illegal selector ($reason)" + } + + data class UnknownFunction( + val name: String, + val line: Int, + val column: Int, + ) : JsonPathError { + override fun toString(): String = + "${messagePrefix(line, column)}: Unknown function extension '$name'" + } + + data class MustBeSingularQuery( + val line: Int, + val column: Int, + ) : JsonPathError { + override fun toString(): String = "${messagePrefix(line, column)}: A singular query is expected" + } + + data class IndicesMustBeIntegers( + val number: Number, + val line: Int, + val column: Int, + ) : JsonPathError { + override fun toString(): String = + "${messagePrefix(line, column)}: Expected an integer index, but got $number" + } + + data class InvalidEscapeSequence( + val string: String, + val line: Int, + val column: Int, + val position: Int, + val reason: String, + ) : JsonPathError { + override fun toString(): String = + "${messagePrefix(line, column)}: " + + "Invalid escape sequence at position $position in string literal '$string' ($reason)" + } + + data class UnexpectedError( + val cause: Throwable, + ) : JsonPathError { + override fun toString(): String = "Unexpected error: $cause" + } + + companion object { + operator fun invoke(throwable: Throwable): JsonPathError = + when (throwable) { + is JsonPathException -> throwable.err + else -> UnexpectedError(throwable) + } + + private fun messagePrefix( + line: Int, + column: Int, + ): String = "Error at [$line:$column]" + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathException.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathException.kt new file mode 100644 index 0000000..690a5d7 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathException.kt @@ -0,0 +1,5 @@ +package com.kobil.vertx.jsonpath.error + +class JsonPathException( + val err: JsonPathError, +) : Exception(err.toString(), (err as? JsonPathError.UnexpectedError)?.cause, false, false) diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt new file mode 100644 index 0000000..fcf2624 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt @@ -0,0 +1,4 @@ +package com.kobil.vertx.jsonpath.error + +data class MultipleResults(val results: List) + diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/ComparableExpressions.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/ComparableExpressions.kt new file mode 100644 index 0000000..73b202d --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/ComparableExpressions.kt @@ -0,0 +1,112 @@ +package com.kobil.vertx.jsonpath.interpreter + +import arrow.core.None +import arrow.core.Option +import arrow.core.raise.option +import arrow.core.some +import com.kobil.vertx.jsonpath.ComparableExpression +import com.kobil.vertx.jsonpath.FunctionExpression +import com.kobil.vertx.jsonpath.NodeListExpression +import com.kobil.vertx.jsonpath.QueryExpression +import io.vertx.core.json.JsonArray +import io.vertx.core.json.JsonObject +import java.util.regex.PatternSyntaxException + +internal fun ComparableExpression.evaluate( + input: Any?, + root: Any?, +): Option = + when (this) { + is ComparableExpression.Literal -> value.some() + is FunctionExpression.Length -> evaluate(input, root) + is FunctionExpression.Count -> evaluate(input, root) + is FunctionExpression.Value -> evaluate(input, root) + is FunctionExpression.Match -> evaluate(input, root) + is QueryExpression -> evaluate(input, root).takeIfSingular() + } + +internal fun FunctionExpression.Length.evaluate( + input: Any?, + root: Any?, +): Option = + when (arg) { + is ComparableExpression.Literal -> arg.value.some() + is NodeListExpression -> arg.evaluate(input, root).takeIfSingular() + is FunctionExpression -> arg.evaluate(input, root) + }.flatMap { + when (it) { + is String -> it.length.some() + is JsonArray -> it.size().some() + is JsonObject -> it.size().some() + else -> None + } + } + +internal fun FunctionExpression.Count.evaluate( + input: Any?, + root: Any?, +): Option = arg.evaluate(input, root).size.some() + +internal fun FunctionExpression.Value.evaluate( + input: Any?, + root: Any?, +): Option = arg.evaluate(input, root).takeIfSingular() + +private val unescapedDot = """(?(\\\\)*)\.(?![^]\n\r]*])""".toRegex() + +internal fun FunctionExpression.Match.evaluate( + input: Any?, + root: Any?, +): Option = + option { + val subjectStr = + when (subject) { + is ComparableExpression.Literal -> subject.value + is NodeListExpression -> subject.evaluate(input, root).takeIfSingular().getOrNull() + is FunctionExpression -> pattern.evaluate(input, root) + } as? String ?: return@option false + + val patternStr = + when (pattern) { + is ComparableExpression.Literal -> pattern.value + is NodeListExpression -> pattern.evaluate(input, root).takeIfSingular().getOrNull() + is FunctionExpression -> pattern.evaluate(input, root).getOrNull() + } as? String ?: return@option false + + val patternRegex = + try { + patternStr.replace(unescapedDot, """${"$"}{backslashes}[^\\n\\r]""").toRegex() + } catch (pse: PatternSyntaxException) { + return@option false + } + + if (full) { + patternRegex.matches(subjectStr) + } else { + patternRegex.containsMatchIn(subjectStr) + } + } + +internal fun NodeListExpression.evaluate( + input: Any?, + root: Any?, +): List = + when (this) { + is QueryExpression -> evaluate(input, root) + } + +internal fun QueryExpression.evaluate( + input: Any?, + root: Any?, +): List = + when (this) { + is QueryExpression.Relative -> segments.evaluate(input, root) + is QueryExpression.Absolute -> segments.evaluate(root) + } + +internal fun List.takeIfSingular(): Option = + if (size == 1) { + first().some() + } else { + None + } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt new file mode 100644 index 0000000..2e2fca7 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt @@ -0,0 +1,156 @@ +package com.kobil.vertx.jsonpath.interpreter + +import arrow.core.None +import arrow.core.Option +import arrow.core.Some +import arrow.core.getOrElse +import com.kobil.vertx.jsonpath.FilterExpression +import com.kobil.vertx.jsonpath.FunctionExpression +import io.vertx.core.json.JsonArray +import io.vertx.core.json.JsonObject + +fun FilterExpression.match( + input: Any?, + root: Any? = input, +): Boolean = + when (this) { + is FilterExpression.And -> match(input, root) + is FilterExpression.Or -> match(input, root) + is FilterExpression.Not -> !operand.match(input, root) + is FilterExpression.Comparison -> match(input, root) + is FilterExpression.Existence -> match(input, root) + is FunctionExpression.Match -> match(input, root) + } + +internal fun FilterExpression.And.match( + input: Any?, + root: Any?, +): Boolean = + operands.fold(true) { acc, operand -> + acc && operand.match(input, root) + } + +internal fun FilterExpression.Or.match( + input: Any?, + root: Any?, +): Boolean = + operands.fold(false) { acc, operand -> + acc || operand.match(input, root) + } + +internal fun FilterExpression.Comparison.match( + input: Any?, + root: Any?, +): Boolean { + val lhsVal = lhs.evaluate(input, root) + val rhsVal = rhs.evaluate(input, root) + + return when (op) { + FilterExpression.Comparison.Op.EQ -> equals(lhsVal, rhsVal) + FilterExpression.Comparison.Op.NOT_EQ -> !equals(lhsVal, rhsVal) + FilterExpression.Comparison.Op.LESS -> less(lhsVal, rhsVal) + FilterExpression.Comparison.Op.LESS_EQ -> less(lhsVal, rhsVal) || equals(lhsVal, rhsVal) + FilterExpression.Comparison.Op.GREATER -> greater(lhsVal, rhsVal) + FilterExpression.Comparison.Op.GREATER_EQ -> greater(lhsVal, rhsVal) || equals(lhsVal, rhsVal) + } +} + +internal fun FilterExpression.Existence.match( + input: Any?, + root: Any?, +): Boolean = query.evaluate(input, root).isNotEmpty() + +internal fun FunctionExpression.Match.match( + input: Any?, + root: Any?, +): Boolean = evaluate(input, root).getOrElse { false } + +internal fun equals( + lhs: Option, + rhs: Option, +): Boolean = + when (lhs) { + is None -> rhs is None + is Some -> rhs is Some && valuesEqual(lhs.value, rhs.value) + } + +internal fun less( + lhs: Option, + rhs: Option, +): Boolean = + when (lhs) { + is None -> false + is Some -> rhs is Some && valueLess(lhs.value, rhs.value) + } + +internal fun greater( + lhs: Option, + rhs: Option, +): Boolean = + when (lhs) { + is None -> false + is Some -> rhs is Some && valueGreater(lhs.value, rhs.value) + } + +internal fun valuesEqual( + lhs: Any?, + rhs: Any?, +): Boolean { + val lhsVal = replaceNodeListWithNode(lhs) + val rhsVal = replaceNodeListWithNode(rhs) + + return when (lhsVal) { + null -> rhs == null + is Number -> rhsVal is Number && lhsVal.toDouble() == rhsVal.toDouble() + is String -> rhsVal is String && lhsVal == rhsVal + is Boolean -> rhsVal is Boolean && lhsVal == rhsVal + is JsonArray -> + rhsVal is JsonArray && + lhsVal.size() == rhsVal.size() && + lhsVal + .zip(rhsVal) + .all { (l, r) -> valuesEqual(l, r) } + + is JsonObject -> + rhsVal is JsonObject && + lhsVal.map.keys == rhsVal.map.keys && + lhsVal.map.keys.all { + valuesEqual( + lhsVal.getValue(it), + rhsVal.getValue(it), + ) + } + + is List<*> -> + if (lhsVal.isEmpty()) { + rhsVal is List<*> && rhsVal.isEmpty() + } else { + false + } + + else -> false + } +} + +internal fun valueLess( + lhs: Any?, + rhs: Any?, +): Boolean = + when (lhs) { + is Number -> rhs is Number && lhs.toDouble() < rhs.toDouble() + is String -> rhs is String && lhs < rhs + else -> false + } + +internal fun valueGreater( + lhs: Any?, + rhs: Any?, +): Boolean = + when (lhs) { + is Number -> rhs is Number && lhs.toDouble() > rhs.toDouble() + is String -> rhs is String && lhs > rhs + else -> false + } + +internal fun replaceNodeListWithNode(maybeList: Any?): Any? = + (maybeList as? List)?.takeIf { it.size == 1 }?.first() ?: maybeList diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Segments.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Segments.kt new file mode 100644 index 0000000..c2cc99f --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Segments.kt @@ -0,0 +1,50 @@ +package com.kobil.vertx.jsonpath.interpreter + +import com.kobil.vertx.jsonpath.Segment +import io.vertx.core.json.JsonArray +import io.vertx.core.json.JsonObject + +fun List.evaluate( + input: Any?, + root: Any? = input, +): List = + fold(listOf(input)) { selected, segment -> + segment.evaluate(selected, root) + } + +fun Segment.evaluate( + input: List, + root: Any?, +): List = + when (this) { + is Segment.ChildSegment -> evaluate(input, root) + is Segment.DescendantSegment -> evaluate(input, root) + }.ifEmpty(::emptyList) + +internal fun Segment.ChildSegment.evaluate( + input: List, + root: Any?, +): List = + input.flatMap { node -> + selectors.flatMap { it.select(node, root) } + } + +internal fun Segment.DescendantSegment.evaluate( + input: List, + root: Any?, +): List = + input.flatMap { node -> + node.enumerateDescendants().flatMap { descendant -> + selectors.flatMap { it.select(descendant, root) } + } + } + +internal fun Any?.enumerateDescendants(): Sequence = + sequence { + yield(this@enumerateDescendants) + + when (this@enumerateDescendants) { + is JsonObject -> forEach { yieldAll(it.value.enumerateDescendants()) } + is JsonArray -> forEach { yieldAll(it.enumerateDescendants()) } + } + } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt new file mode 100644 index 0000000..5b60920 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt @@ -0,0 +1,93 @@ +package com.kobil.vertx.jsonpath.interpreter + +import com.kobil.vertx.jsonpath.Selector +import io.vertx.core.json.JsonArray +import io.vertx.core.json.JsonObject + +fun Selector.select( + input: Any?, + root: Any?, +): List = + when (this) { + is Selector.Name -> select(input) + is Selector.Index -> select(input) + is Selector.Wildcard -> selectAll(input) + is Selector.Slice -> select(input) + is Selector.Filter -> select(input, root) + } + +internal fun Selector.Name.select(input: Any?): List = + (input as? JsonObject)?.let { + if (it.containsKey(name)) { + listOf(it.getValue(name)) + } else { + emptyList() + } + } ?: emptyList() + +internal fun selectAll(input: Any?): List = + when (input) { + is JsonObject -> input.map { it.value } + is JsonArray -> input.toList() + else -> emptyList() + } + +internal fun Selector.Index.select(input: Any?): List = + (input as? JsonArray)?.let { arr -> + val idx = index.normalizeIndex(arr.size()) + + if (idx in 0.. = + (input as? JsonArray)?.let { arr -> + val len = arr.size() + val step = step ?: 1 + + if (step == 0) return emptyList() + + val lower = + if (step > 0) { + minOf(maxOf(first?.normalizeIndex(len) ?: 0, 0), len) + } else { + minOf(maxOf(last?.normalizeIndex(len) ?: -1, -1), len - 1) + } + + val upper = + if (step > 0) { + minOf(maxOf(last?.normalizeIndex(len) ?: len, 0), len) + } else { + minOf(maxOf(first?.normalizeIndex(len) ?: (len - 1), -1), len - 1) + } + + sequence { + var i = if (step > 0) lower else upper + val inBounds = { it: Int -> if (step > 0) it < upper else lower < it } + + while (inBounds(i)) { + yield(arr.getValue(i)) + i += step + } + }.toList() + } ?: emptyList() + +internal fun Selector.Filter.select( + input: Any?, + root: Any?, +): List = + when (input) { + is JsonObject -> input.map { it.value }.filter { filter.match(it, root) } + is JsonArray -> input.filter { filter.match(it, root) } + else -> emptyList() + } + +internal fun Int.normalizeIndex(size: Int): Int = + if (this >= 0) { + toInt() + } else { + toInt() + size + } diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/ComplianceTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/ComplianceTest.kt new file mode 100644 index 0000000..f4d7772 --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/ComplianceTest.kt @@ -0,0 +1,140 @@ +package com.kobil.vertx.jsonpath + +import com.kobil.vertx.jsonpath.testing.ShouldSpecContext +import com.kobil.vertx.jsonpath.testing.VertxExtension +import com.kobil.vertx.jsonpath.testing.VertxExtension.Companion.vertx +import io.kotest.assertions.arrow.core.shouldBeLeft +import io.kotest.assertions.arrow.core.shouldBeRight +import io.kotest.assertions.fail +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.collections.shouldBeIn +import io.kotest.matchers.shouldBe +import io.vertx.core.json.JsonArray +import io.vertx.core.json.JsonObject +import io.vertx.kotlin.core.json.get +import io.vertx.kotlin.coroutines.coAwait + +class ComplianceTest : + ShouldSpec({ + println("Instantiating test suite") + + register(VertxExtension()) + + context("The JSON Path implementation should pass the standard compliance test suite") { + val testSuite = + vertx + .fileSystem() + .readFile("compliance-test-suite/cts.json") + .coAwait() + .toJsonObject() + + val tests = + testSuite + .getJsonArray("tests") + .filterIsInstance() + + for (test in tests) { + val ctx: ShouldSpecContext = + if (test.name in skippedTests) { + { name, block -> xcontext(name, block) } + } else { + { name, block -> context(name, block) } + } + + if (test.isInvalid) { + ctx(test.name) { + should("yield an error when compiled") { + JsonPath.compile(vertx, test.selector).shouldBeLeft() + } + } + } else { + val result = test.result?.toList() + val results = test.results?.map { (it as JsonArray).toList() } + + if (result != null) { + ctx(test.name) { + should("compile to a valid JSON path") { + JsonPath.compile(vertx, test.selector).shouldBeRight() + } + + should("yield the expected results") { + val jsonPath = JsonPath.compile(vertx, test.selector).shouldBeRight() + + val actual = + when (val d = test.document) { + is JsonObject -> jsonPath.evaluate(d) + is JsonArray -> jsonPath.evaluate(d) + else -> fail("Unsupported document $d") + } + + actual shouldBe result + } + } + } else if (results != null) { + ctx(test.name) { + should("compile to a valid JSON path") { + JsonPath.compile(vertx, test.selector).shouldBeRight() + } + + should("yield the expected results") { + val jsonPath = JsonPath.compile(vertx, test.selector).shouldBeRight() + + val actual = + when (val d = test.document) { + is JsonObject -> jsonPath.evaluate(d) + is JsonArray -> jsonPath.evaluate(d) + else -> fail("Unsupported document $d") + } + + actual shouldBeIn results + } + } + } else { + fail( + "Unsupported test case: invalid_selector=false, but neither result nor results is present", + ) + } + } + } + } + }) { + companion object { + val skippedTests = + setOf( + // Tests using values greater than Java's int, which makes no sense in Java as + // indices can never go beyond int's max value + "index selector, min exact index", + "index selector, max exact index", + "slice selector, excessively large to value", + "slice selector, excessively small from value", + "slice selector, excessively large from value with negative step", + "slice selector, excessively small to value with negative step", + "slice selector, excessively large step", + "slice selector, excessively small step", + "slice selector, start, min exact", + "slice selector, start, max exact", + "slice selector, end, min exact", + "slice selector, end, max exact", + "slice selector, step, min exact", + "slice selector, step, max exact", + ) + + private val JsonObject.name: String + get() = this["name"] + + private val JsonObject.selector: String + get() = this["selector"] + + private val JsonObject.document: Any? + get() = this["document"] + + private val JsonObject.result: JsonArray? + get() = this["result"] + + private val JsonObject.results: JsonArray? + get() = this["results"] + + private val JsonObject.isInvalid: Boolean + get() = getBoolean("invalid_selector", false) + } +} diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/testing/Util.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/testing/Util.kt new file mode 100644 index 0000000..3247da0 --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/testing/Util.kt @@ -0,0 +1,6 @@ +package com.kobil.vertx.jsonpath.testing + +import io.kotest.core.spec.style.scopes.ShouldSpecContainerScope + +typealias SpecContext = suspend Container.(String, suspend Container.() -> Unit) -> Unit +typealias ShouldSpecContext = SpecContext diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/testing/VertxExtension.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/testing/VertxExtension.kt new file mode 100644 index 0000000..d25f29b --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/testing/VertxExtension.kt @@ -0,0 +1,87 @@ +package com.kobil.vertx.jsonpath.testing + +import io.kotest.assertions.fail +import io.kotest.core.extensions.SpecExtension +import io.kotest.core.extensions.TestCaseExtension +import io.kotest.core.spec.Spec +import io.kotest.core.spec.style.scopes.ContainerScope +import io.kotest.core.test.TestCase +import io.kotest.core.test.TestResult +import io.kotest.core.test.TestScope +import io.vertx.core.Vertx +import io.vertx.kotlin.coroutines.coAwait +import io.vertx.kotlin.coroutines.dispatcher +import kotlinx.coroutines.CoroutineScope +import kotlinx.coroutines.async +import kotlinx.coroutines.launch +import kotlin.coroutines.AbstractCoroutineContextElement +import kotlin.coroutines.CoroutineContext + +class VertxExtension( + private val lifecycle: Lifecycle = Lifecycle.Spec, +) : TestCaseExtension, + SpecExtension { + companion object { + val TestScope.vertx: Vertx + get() = + coroutineContext[VertxKey]?.vertx + ?: fail("VertxExtension not installed for this test") + val ContainerScope.vertx: Vertx + get() = + coroutineContext[VertxKey]?.vertx + ?: fail("VertxExtension not installed for this test") + } + + override suspend fun intercept( + testCase: TestCase, + execute: suspend (TestCase) -> TestResult, + ): TestResult { + if (lifecycle == Lifecycle.Test) { + val vertx = Vertx.vertx() + + val job = + CoroutineScope(vertx.dispatcher() + VertxElement(vertx)).async { + execute(testCase) + } + + val result = job.await() + + vertx.close().coAwait() + + return result + } else { + return execute(testCase) + } + } + + override suspend fun intercept( + spec: Spec, + execute: suspend (Spec) -> Unit, + ) { + if (lifecycle == Lifecycle.Spec) { + val vertx = Vertx.vertx() + + val job = + CoroutineScope(vertx.dispatcher() + VertxElement(vertx)).launch { + execute(spec) + } + + job.join() + + vertx.close().coAwait() + } else { + execute(spec) + } + } + + enum class Lifecycle { + Spec, + Test, + } + + private data object VertxKey : CoroutineContext.Key + + private data class VertxElement( + val vertx: Vertx, + ) : AbstractCoroutineContextElement(VertxKey) +} diff --git a/src/test/resources/compliance-test-suite b/src/test/resources/compliance-test-suite new file mode 160000 index 0000000..9277705 --- /dev/null +++ b/src/test/resources/compliance-test-suite @@ -0,0 +1 @@ +Subproject commit 9277705cda4489c3d0d984831e7656e48145399b From 9b7efd5a028da8f166587de5dd9bce50ff4b5cca Mon Sep 17 00:00:00 2001 From: Johannes Leupold Date: Fri, 23 Aug 2024 12:46:06 +0200 Subject: [PATCH 3/7] Write more tests and refactor implementation --- build.gradle.kts | 3 + .../com/kobil/vertx/jsonpath/Expression.kt | 50 +- .../com/kobil/vertx/jsonpath/JsonNode.kt | 13 + .../com/kobil/vertx/jsonpath/JsonPath.kt | 55 +- .../com/kobil/vertx/jsonpath/Segment.kt | 24 + .../com/kobil/vertx/jsonpath/Selector.kt | 109 +-- .../jsonpath/compiler/JsonPathCompiler.kt | 6 +- .../vertx/jsonpath/compiler/JsonPathParser.kt | 711 +++++++++--------- .../jsonpath/compiler/JsonPathScanner.kt | 525 ++++++------- .../kobil/vertx/jsonpath/compiler/Strings.kt | 80 ++ .../kobil/vertx/jsonpath/compiler/Token.kt | 162 ++-- .../vertx/jsonpath/error/JsonPathError.kt | 50 +- .../vertx/jsonpath/error/MultipleResults.kt | 5 +- .../interpreter/ComparableExpressions.kt | 71 +- .../jsonpath/interpreter/FilterExpressions.kt | 87 ++- .../vertx/jsonpath/interpreter/Segments.kt | 46 +- .../vertx/jsonpath/interpreter/Selectors.kt | 80 +- .../kobil/vertx/jsonpath/ComplianceTest.kt | 9 +- .../vertx/jsonpath/FilterExpressionTest.kt | 259 +++++++ .../com/kobil/vertx/jsonpath/JsonPathTest.kt | 303 ++++++++ .../jsonpath/compiler/JsonPathScannerTest.kt | 104 +++ .../vertx/jsonpath/error/JsonPathErrorTest.kt | 135 ++++ .../jsonpath/error/JsonPathExceptionTest.kt | 88 +++ .../com/kobil/vertx/jsonpath/testing/Gen.kt | 37 + 24 files changed, 2044 insertions(+), 968 deletions(-) create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/JsonNode.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Strings.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScannerTest.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathErrorTest.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathExceptionTest.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/testing/Gen.kt diff --git a/build.gradle.kts b/build.gradle.kts index 9f0b9a3..0141776 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -39,11 +39,14 @@ dependencies { testImplementation(platform("io.kotest:kotest-bom:$kotestVersion")) testImplementation("io.kotest:kotest-runner-junit5") testImplementation("io.kotest:kotest-assertions-core") + testImplementation("io.kotest:kotest-property") testImplementation("io.kotest.extensions:kotest-assertions-arrow:$kotestArrowVersion") } tasks.test { useJUnitPlatform() + + finalizedBy(tasks.koverHtmlReport, tasks.koverXmlReport) } kotlin { diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt index 7acc265..9b37b6c 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt @@ -2,19 +2,20 @@ package com.kobil.vertx.jsonpath import arrow.core.Either import arrow.core.NonEmptyList -import arrow.core.None -import arrow.core.Option -import arrow.core.left -import arrow.core.right -import arrow.core.some +import com.kobil.vertx.jsonpath.JsonNode.Companion.rootNode import com.kobil.vertx.jsonpath.compiler.JsonPathCompiler.compileJsonPathFilter -import com.kobil.vertx.jsonpath.compiler.JsonPathCompiler.compileJsonPathQuery import com.kobil.vertx.jsonpath.compiler.Token import com.kobil.vertx.jsonpath.error.JsonPathError -import com.kobil.vertx.jsonpath.error.MultipleResults +import com.kobil.vertx.jsonpath.interpreter.match import io.vertx.core.Vertx +import io.vertx.core.json.JsonArray +import io.vertx.core.json.JsonObject sealed interface FilterExpression { + fun match(obj: JsonObject): Boolean = match(obj.rootNode) + + fun match(arr: JsonArray): Boolean = match(arr.rootNode) + data class And( val operands: NonEmptyList, ) : FilterExpression @@ -46,6 +47,13 @@ sealed interface FilterExpression { val query: NodeListExpression, ) : FilterExpression + data class Match( + val subject: ComparableExpression, + val pattern: ComparableExpression, + val matchEntire: Boolean, + val token: Token? = null, + ) : FilterExpression + companion object { suspend fun compile( vertx: Vertx, @@ -56,53 +64,45 @@ sealed interface FilterExpression { sealed interface ComparableExpression { data class Literal( - val token: Token, val value: Any?, + val token: Token? = null, ) : ComparableExpression } sealed interface NodeListExpression : ComparableExpression sealed interface FunctionExpression : ComparableExpression { - val token: Token + val token: Token? data class Length( - override val token: Token, val arg: ComparableExpression, + override val token: Token? = null, ) : FunctionExpression data class Count( - override val token: Token, val arg: QueryExpression, + override val token: Token? = null, ) : FunctionExpression - data class Match( - override val token: Token, - val subject: ComparableExpression, - val pattern: ComparableExpression, - val full: Boolean = true, - ) : FunctionExpression, - FilterExpression - data class Value( - override val token: Token, val arg: QueryExpression, + override val token: Token? = null, ) : FunctionExpression } sealed interface QueryExpression : NodeListExpression { - val token: Token + val token: Token? val segments: List val isSingular: Boolean get() = segments.all { it.isSingular } data class Relative( - override val token: Token, - override val segments: List, + override val segments: List = listOf(), + override val token: Token? = null, ) : QueryExpression data class Absolute( - override val token: Token, - override val segments: List, + override val segments: List = listOf(), + override val token: Token? = null, ) : QueryExpression } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonNode.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonNode.kt new file mode 100644 index 0000000..f6ad12d --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonNode.kt @@ -0,0 +1,13 @@ +package com.kobil.vertx.jsonpath + +data class JsonNode( + val value: Any?, + val path: JsonPath, +) { + companion object { + fun root(value: Any?): JsonNode = JsonNode(value, JsonPath.root) + + val Any?.rootNode: JsonNode + get() = root(this) + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt index b8e2cf1..da0709a 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt @@ -6,6 +6,7 @@ import arrow.core.Option import arrow.core.left import arrow.core.right import arrow.core.some +import com.kobil.vertx.jsonpath.JsonNode.Companion.rootNode import com.kobil.vertx.jsonpath.compiler.JsonPathCompiler.compileJsonPathQuery import com.kobil.vertx.jsonpath.error.JsonPathError import com.kobil.vertx.jsonpath.error.MultipleResults @@ -14,28 +15,66 @@ import io.vertx.core.Vertx import io.vertx.core.json.JsonArray import io.vertx.core.json.JsonObject -data class JsonPath(val segments: List) { - fun evaluate(obj: JsonObject): List = segments.evaluate(obj) +data class JsonPath internal constructor( + val segments: List = emptyList(), +) { + fun evaluate(obj: JsonObject): List = segments.evaluate(obj.rootNode) - fun evaluate(arr: JsonArray): List = segments.evaluate(arr) + fun evaluate(arr: JsonArray): List = segments.evaluate(arr.rootNode) - fun evaluateSingle(obj: JsonObject): Either> = - segments.evaluate(obj).one() + fun evaluateSingle(obj: JsonObject): Either> = + evaluate(obj).one() - fun evaluateSingle(arr: JsonArray): Either> = - segments.evaluate(arr).one() + fun evaluateSingle(arr: JsonArray): Either> = + evaluate(arr).one() + + operator fun get( + selector: Selector, + vararg more: Selector, + ): JsonPath = JsonPath(segments + Segment.ChildSegment(selector, *more)) + + operator fun get( + field: String, + vararg more: String, + ): JsonPath = JsonPath(segments + Segment.ChildSegment(field, *more)) + + operator fun get( + index: Int, + vararg more: Int, + ): JsonPath = JsonPath(segments + Segment.ChildSegment(index, *more)) companion object { + val root = JsonPath() + suspend fun compile( vertx: Vertx, jsonPath: String, ): Either = vertx.compileJsonPathQuery(jsonPath) - fun List.one(): Either> = + fun List.one(): Either> = when (size) { 0 -> None.right() 1 -> first().some().right() else -> MultipleResults(this).left() } + + fun List.onlyValues(): List = map(JsonNode::value) + + fun List.onlyPaths(): List = map(JsonNode::path) + + operator fun get( + selector: Selector, + vararg more: Selector, + ): JsonPath = root.get(selector, *more) + + operator fun get( + field: String, + vararg more: String, + ): JsonPath = root.get(field, *more) + + operator fun get( + index: Int, + vararg more: Int, + ): JsonPath = root.get(index, *more) } } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt index aaafb1b..509c667 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt @@ -7,6 +7,18 @@ sealed interface Segment { data class ChildSegment( override val selectors: List, ) : Segment { + constructor(selector: Selector, vararg more: Selector) : this(listOf(selector, *more)) + + constructor(name: String, vararg more: String) : this( + Selector(name), + *more.map(Selector::invoke).toTypedArray(), + ) + + constructor(index: Int, vararg more: Int) : this( + Selector(index), + *more.map(Selector::invoke).toTypedArray(), + ) + override val isSingular: Boolean get() = selectors.size == 1 && @@ -16,6 +28,18 @@ sealed interface Segment { data class DescendantSegment( override val selectors: List, ) : Segment { + constructor(selector: Selector, vararg more: Selector) : this(listOf(selector, *more)) + + constructor(name: String, vararg more: String) : this( + Selector(name), + *more.map(Selector::invoke).toTypedArray(), + ) + + constructor(index: Int, vararg more: Int) : this( + Selector(index), + *more.map(Selector::invoke).toTypedArray(), + ) + override val isSingular: Boolean get() = false } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt index 24d3ddb..3baeda7 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt @@ -1,91 +1,9 @@ package com.kobil.vertx.jsonpath -import arrow.core.raise.Raise -import com.kobil.vertx.jsonpath.compiler.Token -import com.kobil.vertx.jsonpath.error.JsonPathError -import java.nio.charset.StandardCharsets - sealed interface Selector { data class Name( val name: String, - ) : Selector { - companion object { - private val INVALID_ESCAPE = """(?u[a-fA-F0-9]{4}|[btnfr'"/\\]))""".toRegex() - private val CONTROL_CHARACTER = """[\u0000-\u001F]""".toRegex() - private val INVALID_SURROGATE_PAIR = - """(?>\\u[Dd][89aAbB][0-9a-fA-F]{2}(?!\\u[Dd][CcDdEeFf][0-9a-fA-F]{2}))""".toRegex() - private val LONE_LOW_SURROGATE = - """(?>(?.check( - rawName: Token.Str, - regex: Regex, - reason: () -> String, - ) { - regex.find(rawName.value)?.let { - raise( - JsonPathError.InvalidEscapeSequence( - rawName.value, - rawName.line, - rawName.column, - it.range.first, - reason(), - ), - ) - } - } - - internal fun Raise.unescape(rawName: Token.Str): String { - check(rawName, INVALID_ESCAPE) { "Invalid escape sequence" } - check(rawName, INVALID_SURROGATE_PAIR) { - "A unicode high surrogate must be followed by a low surrogate" - } - check(rawName, LONE_LOW_SURROGATE) { - "A unicode low surrogate must be preceded by a high surrogate" - } - check(rawName, CONTROL_CHARACTER) { "Control characters (U+0000 to U+001F) are disallowed" } - - return rawName - .value - .replace("\\b", "\b") - .replace("\\t", "\t") - .replace("\\n", "\n") - .replace("\\f", "\u000c") - .replace("\\r", "\r") - .replace("\\\"", "\"") - .replace("\\'", "'") - .replace("\\/", "/") - .unescapeUnicode() - .replace("\\\\", "\\") - } - } - } + ) : Selector data object Wildcard : Selector @@ -102,4 +20,29 @@ sealed interface Selector { data class Filter( val filter: FilterExpression, ) : Selector + + companion object { + operator fun invoke(name: String): Selector = Name(name) + + operator fun invoke(index: Int): Selector = Index(index) + + operator fun invoke(slice: IntProgression): Selector = + if (slice.step >= 0) { + Slice(slice.first, slice.last + 1, slice.step) + } else { + Slice( + slice.first, + if (slice.last != 0) slice.last - 1 else null, + slice.step, + ) + } + + operator fun invoke( + first: Int?, + lastExclusive: Int?, + step: Int? = null, + ): Selector = Slice(first, lastExclusive, step) + + operator fun invoke(filter: FilterExpression): Selector = Filter(filter) + } } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt index 3e5e3f1..45103df 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt @@ -29,8 +29,7 @@ object JsonPathCompiler { queryCache .getIfPresent(jsonPath) ?: launchInScope { - JsonPathParser(JsonPathScanner(jsonPath), this) - .query() + jsonPath.scanTokens().parseJsonPathQuery() }.also { queryCache.put(jsonPath, it) } suspend fun Vertx.compileJsonPathFilter( @@ -39,8 +38,7 @@ object JsonPathCompiler { filterCache .getIfPresent(filterExpression) ?: launchInScope { - JsonPathParser(JsonPathScanner(filterExpression), this) - .filterExpression() + filterExpression.scanTokens().parseJsonPathFilter() }.also { filterCache.put(filterExpression, it) } private suspend inline fun Vertx.launchInScope( diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt index f9adc46..874b790 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt @@ -13,458 +13,453 @@ import com.kobil.vertx.jsonpath.NodeListExpression import com.kobil.vertx.jsonpath.QueryExpression import com.kobil.vertx.jsonpath.Segment import com.kobil.vertx.jsonpath.Selector -import com.kobil.vertx.jsonpath.Selector.Name.Companion.unescape import com.kobil.vertx.jsonpath.error.JsonPathError import kotlinx.coroutines.CoroutineScope import kotlinx.coroutines.channels.Channel import kotlinx.coroutines.channels.ReceiveChannel +import kotlinx.coroutines.flow.Flow import kotlinx.coroutines.flow.catch import kotlinx.coroutines.flow.launchIn import kotlinx.coroutines.flow.onCompletion import kotlinx.coroutines.flow.onEach +import kotlin.coroutines.coroutineContext -internal data class JsonPathParser( - val scanner: JsonPathScanner, - val scope: CoroutineScope, -) { - suspend fun query(): Either = - either { - val ch = tokenChannel() - - try { - State(ch, this).run { - require("JSON path query") - JsonPath(segments()) - } - } finally { - ch.cancel() +internal suspend fun Flow.parseJsonPathQuery(): Either = + either { + val ch = collectIntoChannel() + + try { + ParserState(ch, this).run { + require("JSON path query") + JsonPath(segments()) } + } finally { + ch.cancel() } + } - suspend fun filterExpression(): Either = - either { - val ch = tokenChannel() +internal suspend fun Flow.parseJsonPathFilter(): Either = + either { + val ch = collectIntoChannel() - try { - State(ch, this).filterExpr() - } finally { - ch.cancel() - } + try { + ParserState(ch, this).filterExpr() + } finally { + ch.cancel() } + } - private fun tokenChannel(): ReceiveChannel = - Channel().also { ch -> - scanner - .tokens() - .catch { ch.close(it) } - .onCompletion { ch.close(it) } - .onEach(ch::send) - .launchIn(scope) - } +private suspend fun Flow.collectIntoChannel(): ReceiveChannel = + Channel().also { ch -> + catch { ch.close(it) } + .onCompletion { ch.close(it) } + .onEach(ch::send) + .launchIn(CoroutineScope(coroutineContext)) + } - private suspend fun State.filterExpr() = or() +private suspend fun ParserState.filterExpr() = or() - private suspend fun State.segments(): List = - buildList { - while (!isAtEnd()) { - skipWhiteSpace() +private suspend fun ParserState.segments(): List = + buildList { + while (!isAtEnd()) { + skipWhiteSpace() - val dot = takeIf() + val dot = takeIf() - if (dot != null || advanceIf()) { - add(childSegment(dot != null)) - } else if (advanceIf()) { - add(descendantSegment()) - } else { - break - } + if (dot != null || advanceIf()) { + add(childSegment(dot != null)) + } else if (advanceIf()) { + add(descendantSegment()) + } else { + break } - }.toList() + } + }.toList() - private suspend fun State.childSegment(dottedSegment: Boolean): Segment = - Segment.ChildSegment(selectors(dottedSegment, "child")) +private suspend fun ParserState.childSegment(dottedSegment: Boolean): Segment = + Segment.ChildSegment(selectors(dottedSegment, "child")) - private suspend fun State.descendantSegment(): Segment { - val dottedSegment = !advanceIf() - return Segment.DescendantSegment(selectors(dottedSegment, "descendant")) - } +private suspend fun ParserState.descendantSegment(): Segment { + val dottedSegment = !advanceIf() + return Segment.DescendantSegment(selectors(dottedSegment, "descendant")) +} - private suspend fun State.selectors( - dottedSegment: Boolean, - segmentType: String, - ): List { - val selectors = mutableListOf() +private suspend fun ParserState.selectors( + dottedSegment: Boolean, + segmentType: String, +): List { + val selectors = mutableListOf() - do { - if (!dottedSegment) skipWhiteSpace() - selectors.add(selector(dottedSegment)) - if (!dottedSegment) skipWhiteSpace() - } while (!dottedSegment && !isAtEnd() && advanceIf()) + do { + if (!dottedSegment) skipWhiteSpace() + selectors.add(selector(dottedSegment)) + if (!dottedSegment) skipWhiteSpace() + } while (!dottedSegment && !isAtEnd() && advanceIf()) - if (!dottedSegment) require("$segmentType segment") + if (!dottedSegment) require("$segmentType segment") - return selectors.toList() - } + return selectors.toList() +} + +private suspend fun ParserState.selector(dottedSegment: Boolean): Selector = + when (val t = advance()) { + is Token.Star -> Selector.Wildcard - private suspend fun State.selector(dottedSegment: Boolean): Selector = - when (val t = advance()) { - is Token.Star -> Selector.Wildcard - - is Token.Str -> { - if (dottedSegment) { - illegalSelector( - t, - "Quoted name selectors are only allowed in bracketed segments", - ) - } - Selector.Name(unescape(t)) + is Token.Str -> { + if (dottedSegment) { + illegalSelector( + t, + "Quoted name selectors are only allowed in bracketed segments", + ) } + Selector.Name(unescape(t)) + } - is Token.Identifier -> { - if (!dottedSegment) { - illegalSelector( - t, - "Unquoted name selectors are only allowed in dotted segments", - ) - } - Selector.Name(t.value) + is Token.Identifier -> { + if (!dottedSegment) { + illegalSelector( + t, + "Unquoted name selectors are only allowed in dotted segments", + ) } + Selector.Name(t.value) + } - is Token.Num -> { - if (dottedSegment) { - illegalSelector( - t, - "Index and slice selectors are only allowed in bracketed segments", - ) - } - - val start = checkInt(t) - val whitespace = takeIf() - - if (advanceIf()) { - skipWhiteSpace() - - // Slice Selector - val end = takeIf()?.let { checkInt(it) } - skipWhiteSpace() - - val step = - if (advanceIf()) { - skipWhiteSpace() - takeIf()?.let { checkInt(it) } - } else { - null - } - - Selector.Slice(start, end, step) - } else { - if (whitespace != null) raise(JsonPathError.UnexpectedToken(whitespace, "index selector")) - Selector.Index(start) - } + is Token.Integer -> { + if (dottedSegment) { + illegalSelector( + t, + "Index and slice selectors are only allowed in bracketed segments", + ) } - is Token.Colon -> { - if (dottedSegment) { - illegalSelector( - t, - "Slice selectors are only allowed in bracketed segments", - ) - } + val start = checkInt(t) + val whitespace = takeIf() + if (advanceIf()) { skipWhiteSpace() - // Slice Selector without explicit start - val end = takeIf()?.let { checkInt(it) } - + // Slice Selector + val end = takeIf()?.let { checkInt(it) } skipWhiteSpace() - val step = if (advanceIf()) takeIf()?.let { checkInt(it) } else null - - skipWhiteSpace() + val step = + if (advanceIf()) { + skipWhiteSpace() + takeIf()?.let { checkInt(it) } + } else { + null + } + + Selector.Slice(start, end, step) + } else { + if (whitespace != null) raise(JsonPathError.UnexpectedToken(whitespace, "index selector")) + Selector.Index(start) + } + } - Selector.Slice(null, end, step) + is Token.Colon -> { + if (dottedSegment) { + illegalSelector( + t, + "Slice selectors are only allowed in bracketed segments", + ) } - is Token.QuestionMark -> { - if (dottedSegment) { - illegalSelector( - t, - "Filter selectors are only allowed in bracketed segments", - ) - } + skipWhiteSpace() - skipWhiteSpace() + // Slice Selector without explicit start + val end = takeIf()?.let { checkInt(it) } - // Filter Selector - Selector.Filter(filterExpr()) - } + skipWhiteSpace() - else -> unexpectedToken(t, "selector") - } + val step = + if (advanceIf()) takeIf()?.let { checkInt(it) } else null - private fun State.checkInt(number: Token.Num): Int { - ensure(number.absolute is Int) { - JsonPathError.IndicesMustBeIntegers(number.absolute, number.line, number.column) - } - ensure(!number.negative || number.absolute != 0) { - JsonPathError.IllegalCharacter( - '-', - number.line, - number.column, - "An index of -0 is not allowed", - ) + skipWhiteSpace() + + Selector.Slice(null, end, step) } - return number.intValue - } - private suspend fun State.queryExpr(): QueryExpression = - when (val t = advance()) { - is Token.At -> QueryExpression.Relative(t, segments()) - is Token.Dollar -> QueryExpression.Absolute(t, segments()) - else -> unexpectedToken(t, "query expression") + is Token.QuestionMark -> { + if (dottedSegment) { + illegalSelector( + t, + "Filter selectors are only allowed in bracketed segments", + ) + } + + skipWhiteSpace() + + // Filter Selector + Selector.Filter(filterExpr()) } - private suspend inline fun State.functionExpr( - identifier: Token.Identifier, - parse: State.() -> C, - constructor: (Token, C) -> ComparableExpression, - requireSingular: Boolean = true, - ): ComparableExpression { - require("${identifier.value} function expression") - skipWhiteSpace() - val expr = constructor(identifier, parse().also { if (requireSingular) checkSingular(it) }) - skipWhiteSpace() - require("${identifier.value} function expression") + else -> unexpectedToken(t, "selector") + } - return expr +private fun ParserState.checkInt(number: Token.Integer): Int { + ensure(!number.negative || number.value != 0) { + JsonPathError.IllegalCharacter( + '-', + number.line, + number.column, + "An index of -0 is not allowed", + ) } + return number.value +} - private suspend fun State.functionExpr(identifier: Token.Identifier): ComparableExpression = - when (val name = identifier.value) { - "length" -> functionExpr(identifier, { comparable() }, FunctionExpression::Length) - "count" -> - functionExpr(identifier, { - queryExpr() - }, FunctionExpression::Count, requireSingular = false) - "match", "search" -> { - require("$name function expression") - skipWhiteSpace() - val firstArg = checkSingular(comparable()) +private suspend fun ParserState.queryExpr(): QueryExpression = + when (val t = advance()) { + is Token.At -> QueryExpression.Relative(segments(), t) + is Token.Dollar -> QueryExpression.Absolute(segments(), t) + else -> unexpectedToken(t, "query expression") + } - skipWhiteSpace() - require("$name function expression") - skipWhiteSpace() +private suspend inline fun ParserState.functionExpr( + identifier: Token.Identifier, + parse: ParserState.() -> C, + constructor: (C, Token?) -> ComparableExpression, + requireSingular: Boolean = true, +): ComparableExpression { + require("${identifier.value} function expression") + skipWhiteSpace() + val expr = constructor(parse().also { if (requireSingular) checkSingular(it) }, identifier) + skipWhiteSpace() + require("${identifier.value} function expression") + + return expr +} - val secondArg = checkSingular(comparable()) - skipWhiteSpace() - require("$name function expression") +private suspend fun ParserState.functionExpr(identifier: Token.Identifier): ComparableExpression = + when (val name = identifier.value) { + "length" -> functionExpr(identifier, { comparable() }, FunctionExpression::Length) + "count" -> + functionExpr(identifier, { + queryExpr() + }, FunctionExpression::Count, requireSingular = false) + + "value" -> + functionExpr(identifier, { + queryExpr() + }, FunctionExpression::Value, requireSingular = false) + + else -> raise(JsonPathError.UnknownFunction(name, identifier.line, identifier.column)) + } - FunctionExpression.Match(identifier, firstArg, secondArg, name == "match") +private suspend fun ParserState.comparable(): ComparableExpression = + when (val t = advance()) { + is Token.Integer -> ComparableExpression.Literal(t.value, t) + is Token.Decimal -> ComparableExpression.Literal(t.value, t) + is Token.Str -> ComparableExpression.Literal(unescape(t), t) + is Token.Identifier -> + when (t.value) { + "true" -> ComparableExpression.Literal(true, t) + "false" -> ComparableExpression.Literal(false, t) + "null" -> ComparableExpression.Literal(null, t) + else -> functionExpr(t) } - "value" -> - functionExpr(identifier, { - queryExpr() - }, FunctionExpression::Value, requireSingular = false) - else -> raise(JsonPathError.UnknownFunction(name, identifier.line, identifier.column)) - } + is Token.At -> QueryExpression.Relative(segments(), t) + is Token.Dollar -> QueryExpression.Absolute(segments(), t) + else -> unexpectedToken(t, "comparable expression") + } - private suspend fun State.comparable(): ComparableExpression = - when (val t = advance()) { - is Token.Num -> ComparableExpression.Literal(t, t.value) - is Token.Str -> ComparableExpression.Literal(t, unescape(t)) - is Token.Identifier -> - when (t.value) { - "true" -> ComparableExpression.Literal(t, true) - "false" -> ComparableExpression.Literal(t, false) - "null" -> ComparableExpression.Literal(t, null) - else -> functionExpr(t) - } - - is Token.At -> QueryExpression.Relative(t, segments()) - is Token.Dollar -> QueryExpression.Absolute(t, segments()) - else -> unexpectedToken(t, "comparable expression") - } +private suspend fun ParserState.groupExpr(): FilterExpression { + require("parenthesized expression") + skipWhiteSpace() + val expr = filterExpr() + skipWhiteSpace() + require("parenthesized expression") - private suspend fun State.groupExpr(): FilterExpression { - require("parenthesized expression") - skipWhiteSpace() - val expr = filterExpr() - skipWhiteSpace() - require("parenthesized expression") + return expr +} - return expr - } +private suspend fun ParserState.notExpr(): FilterExpression { + require("not expression") + skipWhiteSpace() + return FilterExpression.Not(basicLogicalExpr()) +} - private suspend fun State.notExpr(): FilterExpression { - require("not expression") - skipWhiteSpace() - return FilterExpression.Not(basicLogicalExpr()) +private suspend fun ParserState.matchOrSearchFunction(): FilterExpression { + val identifier = require("basic logical expression") + val name = identifier.value + + require("$name function expression") + skipWhiteSpace() + val firstArg = checkSingular(comparable()) + + skipWhiteSpace() + require("$name function expression") + skipWhiteSpace() + + val secondArg = checkSingular(comparable()) + skipWhiteSpace() + require("$name function expression") + + return FilterExpression.Match(firstArg, secondArg, name == "match", identifier) +} + +private suspend fun ParserState.basicLogicalExpr(): FilterExpression { + if (check()) { + return notExpr() + } else if (check()) { + return groupExpr() } - private suspend fun State.basicLogicalExpr(): FilterExpression { - if (check()) { - return notExpr() - } else if (check()) { - return groupExpr() - } + val matchOrSearch = (current as? Token.Identifier)?.takeIf { it.value in matchOrSearch } + + if (matchOrSearch != null) return matchOrSearchFunction() + + val lhs = comparable() + skipWhiteSpace() + val op = takeIf() - val lhs = comparable() + if (op != null) { skipWhiteSpace() - val op = takeIf() - - if (op != null) { - if (lhs is FunctionExpression.Match) { - raise( - JsonPathError.UnexpectedToken( - op, - "filter expression with match function", - ), - ) - } + val rhs = comparable() - skipWhiteSpace() - val rhs = comparable() + return FilterExpression.Comparison( + op.operator, + checkSingular(lhs), + checkSingular(rhs), + ) + } - return FilterExpression.Comparison( - op.operator, - checkSingular(lhs), - checkSingular(rhs), + return when (lhs) { + is NodeListExpression -> FilterExpression.Existence(lhs) + is ComparableExpression.Literal -> + raise( + JsonPathError.UnexpectedToken(current!!, "basic logical expression"), ) - } - return when (lhs) { - is FunctionExpression.Match -> lhs - is NodeListExpression -> FilterExpression.Existence(lhs) - is ComparableExpression.Literal -> - raise( - JsonPathError.UnexpectedToken(lhs.token, "basic logical expression"), - ) - is FunctionExpression -> - raise( - JsonPathError.UnexpectedToken(lhs.token, "basic logical expression"), - ) - } + is FunctionExpression -> + raise( + JsonPathError.UnexpectedToken(current!!, "basic logical expression"), + ) } +} - private fun Raise.checkSingular( - expr: ComparableExpression, - ): ComparableExpression = - expr.apply { - if (this is QueryExpression && - !isSingular - ) { - raise(JsonPathError.MustBeSingularQuery(token.line, token.column)) - } +private fun Raise.checkSingular( + expr: ComparableExpression, +): ComparableExpression = + expr.apply { + if (this is QueryExpression && + !isSingular + ) { + raise(JsonPathError.MustBeSingularQuery(token!!.line, token!!.column)) } + } + +private suspend fun ParserState.and(): FilterExpression { + var expr = basicLogicalExpr() + skipWhiteSpace() - private suspend fun State.and(): FilterExpression { - var expr = basicLogicalExpr() + while (!isAtEnd() && advanceIf()) { skipWhiteSpace() + val right = basicLogicalExpr() - while (!isAtEnd() && advanceIf()) { - skipWhiteSpace() - val right = basicLogicalExpr() + expr = + when (expr) { + is FilterExpression.And -> FilterExpression.And(expr.operands + right) + else -> FilterExpression.And(nonEmptyListOf(expr, right)) + } + skipWhiteSpace() + } - expr = - when (expr) { - is FilterExpression.And -> FilterExpression.And(expr.operands + right) - else -> FilterExpression.And(nonEmptyListOf(expr, right)) - } - skipWhiteSpace() - } + return expr +} - return expr - } +private suspend fun ParserState.or(): FilterExpression { + var expr = and() + skipWhiteSpace() - private suspend fun State.or(): FilterExpression { - var expr = and() + while (!isAtEnd() && advanceIf()) { skipWhiteSpace() - while (!isAtEnd() && advanceIf()) { - skipWhiteSpace() + val right = and() - val right = and() + expr = + when (expr) { + is FilterExpression.Or -> FilterExpression.Or(expr.operands + right) + else -> FilterExpression.Or(nonEmptyListOf(expr, right)) + } - expr = - when (expr) { - is FilterExpression.Or -> FilterExpression.Or(expr.operands + right) - else -> FilterExpression.Or(nonEmptyListOf(expr, right)) - } + skipWhiteSpace() + } - skipWhiteSpace() - } + return expr +} - return expr +private suspend fun ParserState.skipWhiteSpace() { + while (advanceIf()) { + // Drop all whitespace tokens } +} - private suspend fun State.skipWhiteSpace() { - while (advanceIf()) { - // Drop all whitespace tokens - } +private suspend fun ParserState.peek(): Token = + current ?: run { + val first = receiveToken()!! + current = first + first } - private suspend fun State.peek(): Token = - current ?: run { - val first = receiveToken()!! - current = first - first - } - - private suspend fun State.advance(): Token = - peek().also { - current = receiveToken() - } - - private suspend inline fun State.advanceIf(): Boolean { - if (check()) { - advance() - return true - } +private suspend fun ParserState.advance(): Token = + peek().also { + current = receiveToken() + } - return false +private suspend inline fun ParserState.advanceIf(): Boolean { + if (check()) { + advance() + return true } - private suspend inline fun State.takeIf(): T? { - if (check()) { - return advance() as T - } + return false +} - return null +private suspend inline fun ParserState.takeIf(): T? { + if (check()) { + return advance() as T } - private suspend inline fun State.require(parsing: String): T = - takeIf() ?: unexpectedToken(peek(), parsing) - - private suspend inline fun State.check(): Boolean = peek() is T - - private suspend fun State.isAtEnd(): Boolean = check() - - private class State( - tokens: ReceiveChannel, - raise: Raise, - var current: Token? = null, - ) : Raise by raise, - ReceiveChannel by tokens { - suspend fun receiveToken(): Token? = - receiveCatching().let { - when { - it.isClosed -> it.exceptionOrNull()?.let { t -> raise(JsonPathError(t)) } - it.isSuccess -> it.getOrThrow() - else -> error("Unexpected Failed channel result") - } - } - } + return null +} - private fun State.unexpectedToken( - token: Token, - parsing: String, - ): Nothing { - raise(JsonPathError.UnexpectedToken(token, parsing)) - } +private suspend inline fun ParserState.require(parsing: String): T = + takeIf() ?: unexpectedToken(peek(), parsing) + +private suspend inline fun ParserState.check(): Boolean = peek() is T + +private suspend fun ParserState.isAtEnd(): Boolean = check() + +private class ParserState( + tokens: ReceiveChannel, + raise: Raise, + var current: Token? = null, +) : Raise by raise, + ReceiveChannel by tokens { + suspend fun receiveToken(): Token? = + receiveCatching().let { + when { + it.isClosed -> it.exceptionOrNull()?.let { t -> raise(JsonPathError(t)) } + it.isSuccess -> it.getOrThrow() + else -> error("Unexpected Failed channel result") + } + } +} - private fun State.illegalSelector( - token: Token, - reason: String, - ): Nothing = raise(JsonPathError.IllegalSelector(token.line, token.column, reason)) +private fun ParserState.unexpectedToken( + token: Token, + parsing: String, +): Nothing { + raise(JsonPathError.UnexpectedToken(token, parsing)) } + +private fun ParserState.illegalSelector( + token: Token, + reason: String, +): Nothing = raise(JsonPathError.IllegalSelector(token.line, token.column, reason)) + +private val matchOrSearch = setOf("match", "search") diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt index dcafabf..d71d522 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt @@ -8,286 +8,307 @@ import kotlinx.coroutines.flow.Flow import kotlinx.coroutines.flow.FlowCollector import kotlinx.coroutines.flow.flow -internal data class JsonPathScanner( - val expr: String, -) { - fun tokens(): Flow = - flow { - recover( - block = { - val state = State(this@flow, this) - - if (expr.firstOrNull()?.isWhitespace() == true) { - raise(JsonPathError.IllegalCharacter(expr[0], 1, 1, "Leading whitespace is disallowed")) - } - - while (state.current < expr.length) { - state.start = state.current - state.startLine = state.line - state.startColumn = state.column - emit(state.scanToken()) - } - - if (expr.lastOrNull()?.isWhitespace() == true) { - raise( - JsonPathError.IllegalCharacter( - expr.last(), - state.line, - state.column - 1, - "Trailing whitespace is disallowed", - ), - ) - } - - emit(Token.Eof(state.line, state.column)) - }, - recover = { - throw JsonPathException(it) - }, - ) - } - - private fun State.scanToken(): Token = - when (val ch = advance()) { - // Simple one-character tokens - '$' -> Token.Dollar(line, column) - '@' -> Token.At(line, column) - ',' -> Token.Comma(line, column) - '*' -> Token.Star(line, column) - ':' -> Token.Colon(line, column) - '?' -> Token.QuestionMark(line, column) - '[' -> Token.LeftBracket(line, column) - ']' -> Token.RightBracket(line, column) - '(' -> Token.LeftParen(line, column) - ')' -> Token.RightParen(line, column) - - // Potential two-character tokens - '.' -> match('.', { Token.DotDot(line, column) }, { Token.Dot(line, column) }) - '!' -> match('=', { Token.BangEq(line, column) }, { Token.Bang(line, column) }) - '<' -> match('=', { Token.LessEq(line, column) }, { Token.Less(line, column) }) - '>' -> match('=', { Token.GreaterEq(line, column) }, { Token.Greater(line, column) }) - - // Two-character tokens - '=' -> expect('=') { Token.EqEq(line, column) } - '&' -> expect('&') { Token.AndAnd(line, column) } - '|' -> expect('|') { Token.PipePipe(line, column) } - - // Numbers - in '0'..'9', '-' -> scanNumber(ch) - - // Strings - '\'', '\"' -> scanQuotedString(ch) - - // Potential name shorthand - in 'A'..'Z', in 'a'..'z', '_', in '\u0080'..'\ud7ff', in '\ue000'..'\uffff' -> - scanIdentifier() - - ' ', '\t', '\r' -> scanWhitespace(line, column) - '\n' -> { - val l = line - val c = column - - newLine() - scanWhitespace(l, c) - } - - else -> - raise( - JsonPathError.IllegalCharacter( - ch, - line, - column - 1, - "Character not allowed in JSON Path", - ), - ) - } +internal fun String.scanTokens(): Flow = + flow { + recover( + block = { + val scannerState = ScannerState(this@scanTokens, this@flow, this) + + if (firstOrNull() in whitespaceChar) { + this.raise( + JsonPathError.IllegalCharacter( + this@scanTokens[0], + 1U, + 1U, + "Leading whitespace is disallowed", + ), + ) + } + + while (scannerState.current < uLength) { + scannerState.start = scannerState.current + scannerState.startLine = scannerState.line + scannerState.startColumn = scannerState.column + emit(scannerState.scanToken()) + } + + if (lastOrNull() in whitespaceChar) { + this.raise( + JsonPathError.IllegalCharacter( + last(), + scannerState.line, + scannerState.column - 1U, + "Trailing whitespace is disallowed", + ), + ) + } + + scannerState.start = scannerState.current + + emit(Token.Eof(scannerState.line, scannerState.column)) + }, + recover = { + throw JsonPathException(it) + }, + ) + } - private fun State.scanNumber(first: Char): Token.Num { - val negative = first == '-' - - when { - negative && !expr[current].isDigit() -> - raise( - JsonPathError.IllegalCharacter( - expr[current], - line, - column, - "Expecting an integer part after '-'", - ), - ) - - first == '0' && !isAtEnd() && expr[current].isDigit() -> - raise( - JsonPathError.IllegalCharacter( - expr[current], - line, - column - 1, - "Leading zeroes in numbers are not allowed", - ), - ) - - first == '-' && !isAtEnd(1) && expr[current] == '0' && expr[current + 1].isDigit() -> - raise( - JsonPathError.IllegalCharacter( - expr[current], - line, - column, - "Leading zeroes in numbers are not allowed", - ), - ) +private fun ScannerState.scanToken(): Token = + when (val ch = advance()) { + // Simple one-character tokens + '$' -> Token.Dollar(line, column) + '@' -> Token.At(line, column) + ',' -> Token.Comma(line, column) + '*' -> Token.Star(line, column) + ':' -> Token.Colon(line, column) + '?' -> Token.QuestionMark(line, column) + '[' -> Token.LeftBracket(line, column) + ']' -> Token.RightBracket(line, column) + '(' -> Token.LeftParen(line, column) + ')' -> Token.RightParen(line, column) + + // Potential two-character tokens + '.' -> match('.', { Token.DotDot(line, column) }, { Token.Dot(line, column) }) + '!' -> match('=', { Token.BangEq(line, column) }, { Token.Bang(line, column) }) + '<' -> match('=', { Token.LessEq(line, column) }, { Token.Less(line, column) }) + '>' -> match('=', { Token.GreaterEq(line, column) }, { Token.Greater(line, column) }) + + // Two-character tokens + '=' -> expect('=') { Token.EqEq(line, column) } + '&' -> expect('&') { Token.AndAnd(line, column) } + '|' -> expect('|') { Token.PipePipe(line, column) } + + // Numbers + in '0'..'9', '-' -> scanNumber(ch) + + // Strings + '\'', '\"' -> scanQuotedString(ch) + + // Potential name shorthand + in 'A'..'Z', in 'a'..'z', '_', in '\u0080'..'\ud7ff', in '\ue000'..'\uffff' -> + scanIdentifier() + + ' ', '\t', '\r' -> scanWhitespace(line, column) + '\n' -> { + val l = line + val c = column + + newLine() + scanWhitespace(l, c) } - while (!isAtEnd() && expr[current].isDigit()) advance() + else -> + raise( + JsonPathError.IllegalCharacter( + ch, + line, + column - 1U, + "Character not allowed in JSON Path", + ), + ) + } - var decimal = false - if (!isAtEnd(1) && expr[current] == '.' && expr[current + 1].isDigit()) { - decimal = true - advance() +private fun ScannerState.scanNumber(first: Char): Token { + val negative = first == '-' + + when { + negative && !expr[current].isDigit() -> + raise( + JsonPathError.IllegalCharacter( + expr[current], + line, + column, + "Expecting an integer part after '-'", + ), + ) - while (!isAtEnd() && expr[current].isDigit()) advance() - } + first == '0' && !isAtEnd() && expr[current].isDigit() -> + raise( + JsonPathError.IllegalCharacter( + expr[current], + line, + column - 1U, + "Leading zeroes in numbers are not allowed", + ), + ) - if (!isAtEnd(2) && - expr[current] in exponent && - ( - (expr[current + 1] in plusMinus && expr[current + 2].isDigit()) || - expr[current + 1].isDigit() + first == '-' && !isAtEnd(1U) && expr[current] == '0' && expr[current + 1U].isDigit() -> + raise( + JsonPathError.IllegalCharacter( + expr[current], + line, + column, + "Leading zeroes in numbers are not allowed", + ), ) - ) { - decimal = true - advance() - if (expr[current] in plusMinus) advance() + } - while (!isAtEnd() && expr[current].isDigit()) advance() - } + while (!isAtEnd() && expr[current].isDigit()) advance() - val strValue = - if (negative) { - expr.substring(start + 1..= expr.length +private inline val ScannerState.hasExponent: Boolean + get() = + expr[current] in exponent && + ( + (expr[current + 1U] in plusMinus && expr[current + 2U].isDigit()) || + expr[current + 1U].isDigit() + ) - private fun State.advance(): Char = expr[current++] +private inline val ScannerState.decimal: Token.Decimal + get() = Token.Decimal(line, column, expr.substring(start.. Token, - ifNoMatch: () -> Token, - ): Token = if (advanceIf(next)) ifMatch() else ifNoMatch() - - private fun State.expect( - next: Char, - ifMatch: () -> Token, - ): Token = - if (advanceIf(next)) { - ifMatch() + if (ch == '\\' && !escaped) { + escaped = true } else { - raise(JsonPathError.IllegalCharacter(expr[current], line, column, "Expected '$next'")) + if (ch == '\n') newLine() + + escaped = false } + } + + if (isAtEnd()) raise(JsonPathError.UnterminatedString(line, column, startLine, startColumn)) + + advance() + + return Token.Str(line, column, expr.substring(start + 1U..= expr.uLength + +private fun ScannerState.advance(): Char = expr[current++] + +private fun ScannerState.advanceIf(next: Char): Boolean = + if (!isAtEnd() && expr[current] == next) { + true.also { current++ } + } else { + false } - private val State.column: Int - get() = start - currentLineStart + 1 - - class State( - flow: FlowCollector, - raise: Raise, - var start: Int = 0, - var current: Int = 0, - var line: Int = 1, - var currentLineStart: Int = 0, - var startLine: Int = 1, - var startColumn: Int = 1, - ) : Raise by raise, - FlowCollector by flow - - companion object { - private val identifierChar = - ('A'..'Z').toSet() + ('a'..'z') + '_' + ('\u0080'..'\ud7ff') + ('\ue000'..'\uffff') + - ('0'..'9') - private val whitespaceChar = setOf(' ', '\t', '\n', '\r') - private val plusMinus = setOf('+', '-') - private val exponent = setOf('e', 'E') +private fun ScannerState.match( + next: Char, + ifMatch: () -> Token, + ifNoMatch: () -> Token, +): Token = if (advanceIf(next)) ifMatch() else ifNoMatch() + +private fun ScannerState.expect( + next: Char, + ifMatch: () -> Token, +): Token = + if (advanceIf(next)) { + ifMatch() + } else { + raise(JsonPathError.IllegalCharacter(expr[current], line, column, "Expected '$next'")) } + +private fun ScannerState.newLine() { + line++ + currentLineStart = current } + +private val ScannerState.column: UInt + get() = start - currentLineStart + 1U + +private operator fun String.get(idx: UInt): Char = this[idx.toInt()] + +private fun String.substring(range: UIntRange): String = + substring(range.first.toInt()..range.last.toInt()) + +private val String.uLength: UInt + get() = length.toUInt() + +private class ScannerState( + var expr: String, + flow: FlowCollector, + raise: Raise, + var start: UInt = 0U, + var current: UInt = 0U, + var line: UInt = 1U, + var currentLineStart: UInt = 0U, + var startLine: UInt = 1U, + var startColumn: UInt = 1U, +) : Raise by raise, + FlowCollector by flow + +private val identifierChar = + ('A'..'Z').toSet() + ('a'..'z') + '_' + ('\u0080'..'\ud7ff') + ('\ue000'..'\uffff') + + ('0'..'9') +private val whitespaceChar = setOf(' ', '\t', '\n', '\r') +private val plusMinus = setOf('+', '-') +private val exponent = setOf('e', 'E') diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Strings.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Strings.kt new file mode 100644 index 0000000..55a52ac --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Strings.kt @@ -0,0 +1,80 @@ +package com.kobil.vertx.jsonpath.compiler + +import arrow.core.raise.Raise +import com.kobil.vertx.jsonpath.error.JsonPathError +import java.nio.charset.StandardCharsets + +private val INVALID_ESCAPE = """(?u[a-fA-F0-9]{4}|[btnfr'"/\\]))""".toRegex() +private val CONTROL_CHARACTER = """[\u0000-\u001F]""".toRegex() +private val INVALID_SURROGATE_PAIR = + """(?>\\u[Dd][89aAbB][0-9a-fA-F]{2}(?!\\u[Dd][CcDdEeFf][0-9a-fA-F]{2}))""".toRegex() +private val LONE_LOW_SURROGATE = + """(?>(?.unescape(rawName: Token.Str): String { + check(rawName, INVALID_ESCAPE) { "Invalid escape sequence" } + check(rawName, INVALID_SURROGATE_PAIR) { + "A unicode high surrogate must be followed by a low surrogate" + } + check(rawName, LONE_LOW_SURROGATE) { + "A unicode low surrogate must be preceded by a high surrogate" + } + check(rawName, CONTROL_CHARACTER) { "Control characters (U+0000 to U+001F) are disallowed" } + + return rawName + .value + .replace("\\b", "\b") + .replace("\\t", "\t") + .replace("\\n", "\n") + .replace("\\f", "\u000c") + .replace("\\r", "\r") + .replace("\\\"", "\"") + .replace("\\'", "'") + .replace("\\/", "/") + .unescapeUnicode() + .replace("\\\\", "\\") +} + +@OptIn(ExperimentalStdlibApi::class) +private fun String.unescapeUnicode(): String { + var result = this + var match = UNICODE_SEQUENCE.find(result) + + while (match != null) { + val sequence = match.value + + val decoded = + sequence + .replace("\\u", "") + .lowercase() + .hexToByteArray() + .toString(StandardCharsets.UTF_16) + + result = + result.substring(0...check( + rawName: Token.Str, + regex: Regex, + reason: () -> String, +) { + regex.find(rawName.value)?.let { + raise( + JsonPathError.InvalidEscapeSequence( + rawName.value, + rawName.line, + rawName.column, + it.range.first.toUInt(), + reason(), + ), + ) + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Token.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Token.kt index 03f322f..224e378 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Token.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Token.kt @@ -3,173 +3,179 @@ package com.kobil.vertx.jsonpath.compiler import com.kobil.vertx.jsonpath.FilterExpression sealed interface Token { - val line: Int - val column: Int + val line: UInt + val column: UInt val name: String get() = this::class.simpleName!! - sealed interface ComparisonOperator : Token { + sealed interface ComparisonOperator { val operator: FilterExpression.Comparison.Op } - sealed interface StringValueToken : Token { - val value: String + sealed interface Value { + val value: T } data class Whitespace( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class Eof( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class Dollar( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class At( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class Comma( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class Star( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class Colon( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class QuestionMark( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class LeftBracket( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class RightBracket( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class LeftParen( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class RightParen( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class Dot( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class DotDot( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class EqEq( - override val line: Int, - override val column: Int, - ) : ComparisonOperator { + override val line: UInt, + override val column: UInt, + ) : Token, + ComparisonOperator { override val operator: FilterExpression.Comparison.Op = FilterExpression.Comparison.Op.EQ } data class Bang( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class BangEq( - override val line: Int, - override val column: Int, - ) : ComparisonOperator { + override val line: UInt, + override val column: UInt, + ) : Token, + ComparisonOperator { override val operator: FilterExpression.Comparison.Op = FilterExpression.Comparison.Op.NOT_EQ } data class Less( - override val line: Int, - override val column: Int, - ) : ComparisonOperator { + override val line: UInt, + override val column: UInt, + ) : Token, + ComparisonOperator { override val operator: FilterExpression.Comparison.Op = FilterExpression.Comparison.Op.LESS } data class LessEq( - override val line: Int, - override val column: Int, - ) : ComparisonOperator { + override val line: UInt, + override val column: UInt, + ) : Token, + ComparisonOperator { override val operator: FilterExpression.Comparison.Op = FilterExpression.Comparison.Op.LESS_EQ } data class Greater( - override val line: Int, - override val column: Int, - ) : ComparisonOperator { + override val line: UInt, + override val column: UInt, + ) : Token, + ComparisonOperator { override val operator: FilterExpression.Comparison.Op = FilterExpression.Comparison.Op.GREATER } data class GreaterEq( - override val line: Int, - override val column: Int, - ) : ComparisonOperator { + override val line: UInt, + override val column: UInt, + ) : Token, + ComparisonOperator { override val operator: FilterExpression.Comparison.Op = FilterExpression.Comparison.Op.GREATER_EQ } data class AndAnd( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class PipePipe( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, ) : Token data class Str( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, override val value: String, - ) : StringValueToken + ) : Token, + Value - data class Num( - override val line: Int, - override val column: Int, + data class Integer( + override val line: UInt, + override val column: UInt, val negative: Boolean, - val absolute: Number, - ) : Token { - val intValue: Int - get() = if (negative) -(absolute as Int) else absolute as Int - val value: Number - get() = - when (absolute) { - is Double -> if (negative) -absolute else absolute - is Int -> if (negative) -absolute else absolute - else -> error("unreachable") - } - } + override val value: Int, + ) : Token, + Value + + data class Decimal( + override val line: UInt, + override val column: UInt, + override val value: Double, + ) : Token, + Value data class Identifier( - override val line: Int, - override val column: Int, + override val line: UInt, + override val column: UInt, override val value: String, - ) : StringValueToken + ) : Token, + Value } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt index 060c643..fc0acfe 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt @@ -1,12 +1,13 @@ package com.kobil.vertx.jsonpath.error import com.kobil.vertx.jsonpath.compiler.Token +import kotlinx.coroutines.CancellationException sealed interface JsonPathError { data class IllegalCharacter( val char: Char, - val line: Int, - val column: Int, + val line: UInt, + val column: UInt, val reason: String, ) : JsonPathError { override fun toString(): String = @@ -14,10 +15,10 @@ sealed interface JsonPathError { } data class UnterminatedString( - val line: Int, - val column: Int, - val startLine: Int, - val startColumn: Int, + val line: UInt, + val column: UInt, + val startLine: UInt, + val startColumn: UInt, ) : JsonPathError { override fun toString(): String = "${messagePrefix( @@ -31,12 +32,15 @@ sealed interface JsonPathError { val parsing: String, ) : JsonPathError { override fun toString(): String = - "${messagePrefix(token.line, token.column)}: Unexpected token while parsing $parsing" + "${messagePrefix( + token.line, + token.column, + )}: Unexpected token '${token.name}' while parsing $parsing" } data class IllegalSelector( - val line: Int, - val column: Int, + val line: UInt, + val column: UInt, val reason: String, ) : JsonPathError { override fun toString(): String = "${messagePrefix(line, column)}: Illegal selector ($reason)" @@ -44,34 +48,25 @@ sealed interface JsonPathError { data class UnknownFunction( val name: String, - val line: Int, - val column: Int, + val line: UInt, + val column: UInt, ) : JsonPathError { override fun toString(): String = "${messagePrefix(line, column)}: Unknown function extension '$name'" } data class MustBeSingularQuery( - val line: Int, - val column: Int, + val line: UInt, + val column: UInt, ) : JsonPathError { override fun toString(): String = "${messagePrefix(line, column)}: A singular query is expected" } - data class IndicesMustBeIntegers( - val number: Number, - val line: Int, - val column: Int, - ) : JsonPathError { - override fun toString(): String = - "${messagePrefix(line, column)}: Expected an integer index, but got $number" - } - data class InvalidEscapeSequence( val string: String, - val line: Int, - val column: Int, - val position: Int, + val line: UInt, + val column: UInt, + val position: UInt, val reason: String, ) : JsonPathError { override fun toString(): String = @@ -89,12 +84,13 @@ sealed interface JsonPathError { operator fun invoke(throwable: Throwable): JsonPathError = when (throwable) { is JsonPathException -> throwable.err + is CancellationException, is Error -> throw throwable else -> UnexpectedError(throwable) } private fun messagePrefix( - line: Int, - column: Int, + line: UInt, + column: UInt, ): String = "Error at [$line:$column]" } } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt index fcf2624..98e5db9 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt @@ -1,4 +1,7 @@ package com.kobil.vertx.jsonpath.error -data class MultipleResults(val results: List) +import com.kobil.vertx.jsonpath.JsonNode +data class MultipleResults( + val results: List, +) diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/ComparableExpressions.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/ComparableExpressions.kt index 73b202d..c71a316 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/ComparableExpressions.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/ComparableExpressions.kt @@ -2,32 +2,31 @@ package com.kobil.vertx.jsonpath.interpreter import arrow.core.None import arrow.core.Option -import arrow.core.raise.option import arrow.core.some import com.kobil.vertx.jsonpath.ComparableExpression import com.kobil.vertx.jsonpath.FunctionExpression +import com.kobil.vertx.jsonpath.JsonNode +import com.kobil.vertx.jsonpath.JsonPath.Companion.onlyValues import com.kobil.vertx.jsonpath.NodeListExpression import com.kobil.vertx.jsonpath.QueryExpression import io.vertx.core.json.JsonArray import io.vertx.core.json.JsonObject -import java.util.regex.PatternSyntaxException internal fun ComparableExpression.evaluate( - input: Any?, - root: Any?, + input: JsonNode, + root: JsonNode, ): Option = when (this) { is ComparableExpression.Literal -> value.some() is FunctionExpression.Length -> evaluate(input, root) is FunctionExpression.Count -> evaluate(input, root) is FunctionExpression.Value -> evaluate(input, root) - is FunctionExpression.Match -> evaluate(input, root) is QueryExpression -> evaluate(input, root).takeIfSingular() } internal fun FunctionExpression.Length.evaluate( - input: Any?, - root: Any?, + input: JsonNode, + root: JsonNode, ): Option = when (arg) { is ComparableExpression.Literal -> arg.value.some() @@ -43,65 +42,33 @@ internal fun FunctionExpression.Length.evaluate( } internal fun FunctionExpression.Count.evaluate( - input: Any?, - root: Any?, + input: JsonNode, + root: JsonNode, ): Option = arg.evaluate(input, root).size.some() internal fun FunctionExpression.Value.evaluate( - input: Any?, - root: Any?, + input: JsonNode, + root: JsonNode, ): Option = arg.evaluate(input, root).takeIfSingular() -private val unescapedDot = """(?(\\\\)*)\.(?![^]\n\r]*])""".toRegex() - -internal fun FunctionExpression.Match.evaluate( - input: Any?, - root: Any?, -): Option = - option { - val subjectStr = - when (subject) { - is ComparableExpression.Literal -> subject.value - is NodeListExpression -> subject.evaluate(input, root).takeIfSingular().getOrNull() - is FunctionExpression -> pattern.evaluate(input, root) - } as? String ?: return@option false - - val patternStr = - when (pattern) { - is ComparableExpression.Literal -> pattern.value - is NodeListExpression -> pattern.evaluate(input, root).takeIfSingular().getOrNull() - is FunctionExpression -> pattern.evaluate(input, root).getOrNull() - } as? String ?: return@option false - - val patternRegex = - try { - patternStr.replace(unescapedDot, """${"$"}{backslashes}[^\\n\\r]""").toRegex() - } catch (pse: PatternSyntaxException) { - return@option false - } - - if (full) { - patternRegex.matches(subjectStr) - } else { - patternRegex.containsMatchIn(subjectStr) - } - } - internal fun NodeListExpression.evaluate( - input: Any?, - root: Any?, + input: JsonNode, + root: JsonNode, ): List = when (this) { is QueryExpression -> evaluate(input, root) } internal fun QueryExpression.evaluate( - input: Any?, - root: Any?, + input: JsonNode, + root: JsonNode, ): List = when (this) { - is QueryExpression.Relative -> segments.evaluate(input, root) - is QueryExpression.Absolute -> segments.evaluate(root) + is QueryExpression.Relative -> + segments.evaluate(input, root).onlyValues() + + is QueryExpression.Absolute -> + segments.evaluate(root).onlyValues() } internal fun List.takeIfSingular(): Option = diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt index 2e2fca7..ed3f67b 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt @@ -3,15 +3,19 @@ package com.kobil.vertx.jsonpath.interpreter import arrow.core.None import arrow.core.Option import arrow.core.Some -import arrow.core.getOrElse +import com.kobil.vertx.jsonpath.ComparableExpression import com.kobil.vertx.jsonpath.FilterExpression import com.kobil.vertx.jsonpath.FunctionExpression +import com.kobil.vertx.jsonpath.JsonNode +import com.kobil.vertx.jsonpath.NodeListExpression import io.vertx.core.json.JsonArray import io.vertx.core.json.JsonObject +import io.vertx.kotlin.core.json.get +import java.util.regex.PatternSyntaxException fun FilterExpression.match( - input: Any?, - root: Any? = input, + input: JsonNode, + root: JsonNode = input, ): Boolean = when (this) { is FilterExpression.And -> match(input, root) @@ -19,28 +23,28 @@ fun FilterExpression.match( is FilterExpression.Not -> !operand.match(input, root) is FilterExpression.Comparison -> match(input, root) is FilterExpression.Existence -> match(input, root) - is FunctionExpression.Match -> match(input, root) + is FilterExpression.Match -> match(input, root) } internal fun FilterExpression.And.match( - input: Any?, - root: Any?, + input: JsonNode, + root: JsonNode, ): Boolean = operands.fold(true) { acc, operand -> acc && operand.match(input, root) } internal fun FilterExpression.Or.match( - input: Any?, - root: Any?, + input: JsonNode, + root: JsonNode, ): Boolean = operands.fold(false) { acc, operand -> acc || operand.match(input, root) } internal fun FilterExpression.Comparison.match( - input: Any?, - root: Any?, + input: JsonNode, + root: JsonNode, ): Boolean { val lhsVal = lhs.evaluate(input, root) val rhsVal = rhs.evaluate(input, root) @@ -56,14 +60,43 @@ internal fun FilterExpression.Comparison.match( } internal fun FilterExpression.Existence.match( - input: Any?, - root: Any?, + input: JsonNode, + root: JsonNode, ): Boolean = query.evaluate(input, root).isNotEmpty() -internal fun FunctionExpression.Match.match( - input: Any?, - root: Any?, -): Boolean = evaluate(input, root).getOrElse { false } +private val unescapedDot = """(?(\\\\)*)\.(?![^]\n\r]*])""".toRegex() + +internal fun FilterExpression.Match.match( + input: JsonNode, + root: JsonNode, +): Boolean { + val subjectStr = + when (subject) { + is ComparableExpression.Literal -> subject.value + is NodeListExpression -> subject.evaluate(input, root).takeIfSingular().getOrNull() + is FunctionExpression -> pattern.evaluate(input, root) + } as? String ?: return false + + val patternStr = + when (pattern) { + is ComparableExpression.Literal -> pattern.value + is NodeListExpression -> pattern.evaluate(input, root).takeIfSingular().getOrNull() + is FunctionExpression -> pattern.evaluate(input, root).getOrNull() + } as? String ?: return false + + val patternRegex = + try { + patternStr.replace(unescapedDot, """${"$"}{backslashes}[^\\n\\r]""").toRegex() + } catch (pse: PatternSyntaxException) { + return false + } + + return if (matchEntire) { + patternRegex.matches(subjectStr) + } else { + patternRegex.containsMatchIn(subjectStr) + } +} internal fun equals( lhs: Option, @@ -107,19 +140,12 @@ internal fun valuesEqual( is JsonArray -> rhsVal is JsonArray && lhsVal.size() == rhsVal.size() && - lhsVal - .zip(rhsVal) - .all { (l, r) -> valuesEqual(l, r) } + lhsVal.asSequence().zip(rhsVal.asSequence(), ::valuesEqual).all { it } is JsonObject -> rhsVal is JsonObject && lhsVal.map.keys == rhsVal.map.keys && - lhsVal.map.keys.all { - valuesEqual( - lhsVal.getValue(it), - rhsVal.getValue(it), - ) - } + lhsVal.map.keys.all { valuesEqual(lhsVal[it], rhsVal[it]) } is List<*> -> if (lhsVal.isEmpty()) { @@ -152,5 +178,12 @@ internal fun valueGreater( else -> false } -internal fun replaceNodeListWithNode(maybeList: Any?): Any? = - (maybeList as? List)?.takeIf { it.size == 1 }?.first() ?: maybeList +internal fun replaceNodeListWithNode(maybeList: Any?): Any? { + val maybeNode = + (maybeList as? List<*>) + ?.takeIf { it.size == 1 } + ?.first() + as? JsonNode + + return maybeNode ?: maybeList +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Segments.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Segments.kt index c2cc99f..31938ca 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Segments.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Segments.kt @@ -1,50 +1,56 @@ package com.kobil.vertx.jsonpath.interpreter +import com.kobil.vertx.jsonpath.JsonNode import com.kobil.vertx.jsonpath.Segment import io.vertx.core.json.JsonArray import io.vertx.core.json.JsonObject fun List.evaluate( - input: Any?, - root: Any? = input, -): List = + input: JsonNode, + root: JsonNode = input, +): List = fold(listOf(input)) { selected, segment -> segment.evaluate(selected, root) } fun Segment.evaluate( - input: List, - root: Any?, -): List = + input: List, + root: JsonNode, +): List = when (this) { is Segment.ChildSegment -> evaluate(input, root) is Segment.DescendantSegment -> evaluate(input, root) }.ifEmpty(::emptyList) internal fun Segment.ChildSegment.evaluate( - input: List, - root: Any?, -): List = - input.flatMap { node -> - selectors.flatMap { it.select(node, root) } + input: List, + root: JsonNode, +): List = + input.flatMap { selected -> + selectors.flatMap { it.select(selected, root) } } internal fun Segment.DescendantSegment.evaluate( - input: List, - root: Any?, -): List = - input.flatMap { node -> - node.enumerateDescendants().flatMap { descendant -> + input: List, + root: JsonNode, +): List = + input.flatMap { selected -> + selected.enumerateDescendants().flatMap { descendant -> selectors.flatMap { it.select(descendant, root) } } } -internal fun Any?.enumerateDescendants(): Sequence = +internal fun JsonNode.enumerateDescendants(): Sequence = sequence { yield(this@enumerateDescendants) - when (this@enumerateDescendants) { - is JsonObject -> forEach { yieldAll(it.value.enumerateDescendants()) } - is JsonArray -> forEach { yieldAll(it.enumerateDescendants()) } + when (value) { + is JsonObject -> + value.forEach { yieldAll(child(it.key, it.value).enumerateDescendants()) } + + is JsonArray -> + value.forEachIndexed { idx, item -> + yieldAll(child(idx, item).enumerateDescendants()) + } } } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt index 5b60920..f3ccc32 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt @@ -1,13 +1,14 @@ package com.kobil.vertx.jsonpath.interpreter +import com.kobil.vertx.jsonpath.JsonNode import com.kobil.vertx.jsonpath.Selector import io.vertx.core.json.JsonArray import io.vertx.core.json.JsonObject fun Selector.select( - input: Any?, - root: Any?, -): List = + input: JsonNode, + root: JsonNode, +): List = when (this) { is Selector.Name -> select(input) is Selector.Index -> select(input) @@ -16,35 +17,35 @@ fun Selector.select( is Selector.Filter -> select(input, root) } -internal fun Selector.Name.select(input: Any?): List = - (input as? JsonObject)?.let { +internal fun Selector.Name.select(input: JsonNode): List = + (input.value as? JsonObject)?.let { if (it.containsKey(name)) { - listOf(it.getValue(name)) + listOf(input.child(name, it.getValue(name))) } else { emptyList() } } ?: emptyList() -internal fun selectAll(input: Any?): List = - when (input) { - is JsonObject -> input.map { it.value } - is JsonArray -> input.toList() +internal fun selectAll(input: JsonNode): List = + when (val node = input.value) { + is JsonObject -> node.map { input.child(it.key, it.value) } + is JsonArray -> node.mapIndexed { idx, item -> input.child(idx, item) } else -> emptyList() } -internal fun Selector.Index.select(input: Any?): List = - (input as? JsonArray)?.let { arr -> +internal fun Selector.Index.select(input: JsonNode): List = + (input.value as? JsonArray)?.let { arr -> val idx = index.normalizeIndex(arr.size()) if (idx in 0.. = - (input as? JsonArray)?.let { arr -> +internal fun Selector.Slice.select(input: JsonNode): List = + (input.value as? JsonArray)?.let { arr -> val len = arr.size() val step = step ?: 1 @@ -64,24 +65,35 @@ internal fun Selector.Slice.select(input: Any?): List = minOf(maxOf(first?.normalizeIndex(len) ?: (len - 1), -1), len - 1) } - sequence { - var i = if (step > 0) lower else upper - val inBounds = { it: Int -> if (step > 0) it < upper else lower < it } - - while (inBounds(i)) { - yield(arr.getValue(i)) - i += step + val range = + if (step > 0) { + lower.. input.child(i, arr.getValue(i)) } } ?: emptyList() internal fun Selector.Filter.select( - input: Any?, - root: Any?, -): List = - when (input) { - is JsonObject -> input.map { it.value }.filter { filter.match(it, root) } - is JsonArray -> input.filter { filter.match(it, root) } + input: JsonNode, + root: JsonNode, +): List = + when (val value = input.value) { + is JsonObject -> + value + .asSequence() + .map { (key, field) -> input.child(key, field) } + .filter { node -> filter.match(node, root) } + .toList() + + is JsonArray -> + value + .asSequence() + .mapIndexed { idx, item -> input.child(idx, item) } + .filter { node -> filter.match(node, root) } + .toList() + else -> emptyList() } @@ -91,3 +103,13 @@ internal fun Int.normalizeIndex(size: Int): Int = } else { toInt() + size } + +internal fun JsonNode.child( + name: String, + node: Any?, +): JsonNode = JsonNode(node, path[name]) + +internal fun JsonNode.child( + index: Int, + node: Any?, +): JsonNode = JsonNode(node, path[index]) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/ComplianceTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/ComplianceTest.kt index f4d7772..b00dfc0 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/ComplianceTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/ComplianceTest.kt @@ -1,5 +1,6 @@ package com.kobil.vertx.jsonpath +import com.kobil.vertx.jsonpath.JsonPath.Companion.onlyValues import com.kobil.vertx.jsonpath.testing.ShouldSpecContext import com.kobil.vertx.jsonpath.testing.VertxExtension import com.kobil.vertx.jsonpath.testing.VertxExtension.Companion.vertx @@ -62,8 +63,8 @@ class ComplianceTest : val actual = when (val d = test.document) { - is JsonObject -> jsonPath.evaluate(d) - is JsonArray -> jsonPath.evaluate(d) + is JsonObject -> jsonPath.evaluate(d).onlyValues() + is JsonArray -> jsonPath.evaluate(d).onlyValues() else -> fail("Unsupported document $d") } @@ -81,8 +82,8 @@ class ComplianceTest : val actual = when (val d = test.document) { - is JsonObject -> jsonPath.evaluate(d) - is JsonArray -> jsonPath.evaluate(d) + is JsonObject -> jsonPath.evaluate(d).onlyValues() + is JsonArray -> jsonPath.evaluate(d).onlyValues() else -> fail("Unsupported document $d") } diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt new file mode 100644 index 0000000..2f3a2bd --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt @@ -0,0 +1,259 @@ +package com.kobil.vertx.jsonpath + +import com.kobil.vertx.jsonpath.compiler.Token +import com.kobil.vertx.jsonpath.error.JsonPathError +import com.kobil.vertx.jsonpath.testing.VertxExtension +import com.kobil.vertx.jsonpath.testing.VertxExtension.Companion.vertx +import io.kotest.assertions.arrow.core.shouldBeLeft +import io.kotest.assertions.arrow.core.shouldBeRight +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.booleans.shouldBeFalse +import io.kotest.matchers.booleans.shouldBeTrue +import io.vertx.kotlin.core.json.jsonArrayOf +import io.vertx.kotlin.core.json.jsonObjectOf + +class FilterExpressionTest : + ShouldSpec({ + register(VertxExtension()) + + context("Invalid filter expressions") { + context("with a leading question mark") { + should("result in an error when compiled") { + val unexpectedQuestion = + JsonPathError.UnexpectedToken( + Token.QuestionMark(1U, 1U), + "comparable expression", + ) + + // Leading ? must be omitted + FilterExpression.compile(vertx, "?@") shouldBeLeft unexpectedQuestion + FilterExpression.compile(vertx, "?@.abc") shouldBeLeft unexpectedQuestion + FilterExpression.compile(vertx, "?!@") shouldBeLeft unexpectedQuestion + FilterExpression.compile(vertx, "?!@.abc") shouldBeLeft unexpectedQuestion + FilterExpression.compile(vertx, "?@ == 'x'") shouldBeLeft unexpectedQuestion + FilterExpression.compile(vertx, "?@.abc < 1U") shouldBeLeft unexpectedQuestion + FilterExpression.compile(vertx, "?@['xyz'] >= 'a'") shouldBeLeft unexpectedQuestion + FilterExpression.compile(vertx, "?@.abc != 2U") shouldBeLeft unexpectedQuestion + } + } + + context("with a non-singular query as the operand of a comparison expression") { + should("result in an error when compiled") { + FilterExpression.compile(vertx, "@..a == 2") shouldBeLeft + JsonPathError.MustBeSingularQuery( + 1U, + 1U, + ) + + FilterExpression.compile(vertx, "2 == @..a") shouldBeLeft + JsonPathError.MustBeSingularQuery( + 1U, + 6U, + ) + + FilterExpression.compile(vertx, "@.a[1, 2] == 2") shouldBeLeft + JsonPathError.MustBeSingularQuery( + 1U, + 1U, + ) + + FilterExpression.compile(vertx, "2 == @.a[1, 2]") shouldBeLeft + JsonPathError.MustBeSingularQuery( + 1U, + 6U, + ) + + FilterExpression.compile(vertx, "@.a['b', 'c'] == 2") shouldBeLeft + JsonPathError.MustBeSingularQuery( + 1U, + 1U, + ) + + FilterExpression.compile(vertx, "2 == @.a['b', 'c']") shouldBeLeft + JsonPathError.MustBeSingularQuery( + 1U, + 6U, + ) + + FilterExpression.compile(vertx, "@.a[1:] == 2") shouldBeLeft + JsonPathError.MustBeSingularQuery( + 1U, + 1U, + ) + + FilterExpression.compile(vertx, "2 == @.a[1:]") shouldBeLeft + JsonPathError.MustBeSingularQuery( + 1U, + 6U, + ) + + FilterExpression.compile(vertx, "@.a[?@.b == 1] == 2") shouldBeLeft + JsonPathError.MustBeSingularQuery( + 1U, + 1U, + ) + + FilterExpression.compile(vertx, "2 == @.a[?@.b == 1]") shouldBeLeft + JsonPathError.MustBeSingularQuery( + 1U, + 6U, + ) + } + } + } + + context("Valid filter expressions") { + context("using a simple existence check") { + val at = Token.At(1U, 1U) + + val hasA = "@.a" + val hasB = "@['b']" + val has1 = "@[1]" + val hasNestedA = "@..a" + val hasNestedB = "@..['b']" + val hasNested1 = "@..[1]" + + should("compile successfully") { + FilterExpression.compile(vertx, hasA) shouldBeRight + FilterExpression.Existence( + QueryExpression.Relative(listOf(Segment.ChildSegment("a")), at), + ) + + FilterExpression.compile(vertx, hasB) shouldBeRight + FilterExpression.Existence( + QueryExpression.Relative(listOf(Segment.ChildSegment("b")), at), + ) + + FilterExpression.compile(vertx, has1) shouldBeRight + FilterExpression.Existence( + QueryExpression.Relative(listOf(Segment.ChildSegment(1)), at), + ) + FilterExpression.compile(vertx, hasNestedA) shouldBeRight + FilterExpression.Existence( + QueryExpression.Relative(listOf(Segment.DescendantSegment("a")), at), + ) + + FilterExpression.compile(vertx, hasNestedB) shouldBeRight + FilterExpression.Existence( + QueryExpression.Relative(listOf(Segment.DescendantSegment("b")), at), + ) + + FilterExpression.compile(vertx, hasNested1) shouldBeRight + FilterExpression.Existence( + QueryExpression.Relative(listOf(Segment.DescendantSegment(1)), at), + ) + } + + context("of a child segment") { + should("return true for inputs if, and only if, they contain the required element") { + val obj1 = jsonObjectOf("a" to 1) + val obj2 = jsonObjectOf("b" to 2) + val obj3 = jsonObjectOf("a" to 1, "b" to 2) + val objANull = jsonObjectOf("a" to null) + val objName1 = jsonObjectOf("1" to true) + + val arr1 = jsonArrayOf("a") + val arr2 = jsonArrayOf("a", "b") + val arr3 = jsonArrayOf("a", "b", "c", "d") + val arr4 = jsonArrayOf(1) + + FilterExpression.compile(vertx, hasA).shouldBeRight().also { + it.match(obj1).shouldBeTrue() + it.match(obj2).shouldBeFalse() + it.match(obj3).shouldBeTrue() + it.match(objANull).shouldBeTrue() + it.match(arr1).shouldBeFalse() + it.match(arr2).shouldBeFalse() + it.match(arr3).shouldBeFalse() + it.match(arr4).shouldBeFalse() + } + + FilterExpression.compile(vertx, hasB).shouldBeRight().also { + it.match(obj1).shouldBeFalse() + it.match(obj2).shouldBeTrue() + it.match(obj3).shouldBeTrue() + it.match(objANull).shouldBeFalse() + it.match(arr1).shouldBeFalse() + it.match(arr2).shouldBeFalse() + it.match(arr3).shouldBeFalse() + it.match(arr4).shouldBeFalse() + } + + FilterExpression.compile(vertx, has1).shouldBeRight().also { + it.match(obj1).shouldBeFalse() + it.match(obj2).shouldBeFalse() + it.match(obj3).shouldBeFalse() + it.match(objANull).shouldBeFalse() + it.match(objName1).shouldBeFalse() + it.match(arr1).shouldBeFalse() + it.match(arr2).shouldBeTrue() + it.match(arr3).shouldBeTrue() + it.match(arr4).shouldBeFalse() + } + } + } + + context("of a descendant segment") { + should("return true for inputs if, and only if, they contain the required element") { + val obj1 = jsonObjectOf("a" to 1) + val obj2 = jsonObjectOf("b" to jsonObjectOf("a" to 1)) + val obj3 = jsonObjectOf("a" to 1, "b" to jsonArrayOf(1)) + val obj4 = jsonObjectOf("a" to jsonArrayOf(1, 2, 3)) + val obj5 = + jsonObjectOf( + "c" to + jsonArrayOf( + jsonObjectOf("a" to true), + jsonObjectOf("b" to false), + ), + ) + val obj6 = jsonObjectOf("b" to jsonArrayOf(1, 2), "c" to jsonObjectOf("b" to 1)) + + val arr1 = jsonArrayOf("a") + val arr2 = jsonArrayOf("a", "b", jsonObjectOf("a" to 1)) + val arr3 = jsonArrayOf("a", "b", "c", "d") + val arr4 = jsonArrayOf(jsonArrayOf("a", "b")) + + FilterExpression.compile(vertx, hasNestedA).shouldBeRight().also { + it.match(obj1).shouldBeTrue() + it.match(obj2).shouldBeTrue() + it.match(obj3).shouldBeTrue() + it.match(obj4).shouldBeTrue() + it.match(obj5).shouldBeTrue() + it.match(obj6).shouldBeFalse() + it.match(arr1).shouldBeFalse() + it.match(arr2).shouldBeTrue() + it.match(arr3).shouldBeFalse() + it.match(arr4).shouldBeFalse() + } + + FilterExpression.compile(vertx, hasNestedB).shouldBeRight().also { + it.match(obj1).shouldBeFalse() + it.match(obj2).shouldBeTrue() + it.match(obj3).shouldBeTrue() + it.match(obj4).shouldBeFalse() + it.match(obj5).shouldBeTrue() + it.match(obj6).shouldBeTrue() + it.match(arr1).shouldBeFalse() + it.match(arr2).shouldBeFalse() + it.match(arr3).shouldBeFalse() + it.match(arr4).shouldBeFalse() + } + + FilterExpression.compile(vertx, hasNested1).shouldBeRight().also { + it.match(obj1).shouldBeFalse() + it.match(obj2).shouldBeFalse() + it.match(obj3).shouldBeFalse() + it.match(obj4).shouldBeTrue() + it.match(obj5).shouldBeTrue() + it.match(obj6).shouldBeTrue() + it.match(arr1).shouldBeFalse() + it.match(arr2).shouldBeTrue() + it.match(arr3).shouldBeTrue() + it.match(arr4).shouldBeTrue() + } + } + } + } + } + }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt new file mode 100644 index 0000000..794e4ba --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt @@ -0,0 +1,303 @@ +package com.kobil.vertx.jsonpath + +import com.kobil.vertx.jsonpath.JsonPath.Companion.onlyPaths +import com.kobil.vertx.jsonpath.testing.VertxExtension +import com.kobil.vertx.jsonpath.testing.VertxExtension.Companion.vertx +import com.kobil.vertx.jsonpath.testing.normalizedJsonPath +import io.kotest.assertions.arrow.core.shouldBeLeft +import io.kotest.assertions.arrow.core.shouldBeNone +import io.kotest.assertions.arrow.core.shouldBeRight +import io.kotest.assertions.arrow.core.shouldBeSome +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.collections.shouldContainExactly +import io.kotest.matchers.collections.shouldContainExactlyInAnyOrder +import io.kotest.property.Arb +import io.kotest.property.arbitrary.list +import io.kotest.property.checkAll +import io.vertx.kotlin.core.json.jsonArrayOf +import io.vertx.kotlin.core.json.jsonObjectOf + +class JsonPathTest : + ShouldSpec({ + register(VertxExtension()) + + context("The evaluateSingle function") { + context("called on a JSON object") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile(vertx, "$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile(vertx, "$.a[1]['b']").shouldBeRight() + + jsonPath1 + .evaluateSingle(jsonObjectOf("a" to 1, "b" to 2)) + .shouldBeRight() shouldBeSome JsonNode(1, JsonPath["a"]) + + jsonPath1 + .evaluateSingle(jsonObjectOf("a" to "string")) + .shouldBeRight() shouldBeSome JsonNode("string", JsonPath["a"]) + + jsonPath2 + .evaluateSingle(jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("b" to true)))) + .shouldBeRight() shouldBeSome JsonNode(true, JsonPath["a"][1]["b"]) + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile(vertx, "$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile(vertx, "$.a[1]['b']").shouldBeRight() + + jsonPath1.evaluateSingle(jsonObjectOf("b" to 2)).shouldBeRight().shouldBeNone() + + jsonPath1 + .evaluateSingle(jsonObjectOf("b" to jsonObjectOf("a" to 1))) + .shouldBeRight() + .shouldBeNone() + + jsonPath2 + .evaluateSingle(jsonObjectOf("b" to jsonArrayOf(null, jsonObjectOf("b" to true)))) + .shouldBeRight() + .shouldBeNone() + + jsonPath2 + .evaluateSingle(jsonObjectOf("a" to jsonArrayOf(jsonObjectOf("b" to true)))) + .shouldBeRight() + .shouldBeNone() + + jsonPath2 + .evaluateSingle(jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("a" to true)))) + .shouldBeRight() + .shouldBeNone() + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile(vertx, "$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile(vertx, "$[?@.a]").shouldBeRight() + + jsonPath1 + .evaluateSingle( + jsonObjectOf( + "a" to 1, + "b" to jsonObjectOf("a" to 2), + "c" to jsonArrayOf(1, jsonObjectOf("a" to 3)), + ), + ).shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(1, JsonPath["a"]), + JsonNode(2, JsonPath["b"]["a"]), + JsonNode(3, JsonPath["c"][1]["a"]), + ) + + jsonPath1 + .evaluateSingle(jsonObjectOf("a" to "string", "b" to jsonObjectOf("a" to null))) + .shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode("string", JsonPath["a"]), + JsonNode(null, JsonPath["b"]["a"]), + ) + + jsonPath2 + .evaluateSingle( + jsonObjectOf( + "a" to jsonObjectOf("a" to 1), + "b" to jsonObjectOf("a" to 2), + ), + ).shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(jsonObjectOf("a" to 1), JsonPath["a"]), + JsonNode(jsonObjectOf("a" to 2), JsonPath["b"]), + ) + } + } + + context("called on a JSON array") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile(vertx, "$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile(vertx, "$[1]['b']").shouldBeRight() + + jsonPath1 + .evaluateSingle(jsonArrayOf(1, 2, 3)) + .shouldBeRight() shouldBeSome JsonNode(1, JsonPath[0]) + + jsonPath1 + .evaluateSingle(jsonArrayOf("string", null, true)) + .shouldBeRight() shouldBeSome JsonNode("string", JsonPath[0]) + + jsonPath2 + .evaluateSingle(jsonArrayOf(null, jsonObjectOf("b" to true))) + .shouldBeRight() shouldBeSome JsonNode(true, JsonPath[1]["b"]) + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile(vertx, "$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile(vertx, "$[1]['b']").shouldBeRight() + + jsonPath1.evaluateSingle(jsonArrayOf()).shouldBeRight().shouldBeNone() + + jsonPath2 + .evaluateSingle(jsonArrayOf(null, jsonObjectOf("a" to true))) + .shouldBeRight() + .shouldBeNone() + + jsonPath2 + .evaluateSingle(jsonArrayOf(jsonObjectOf("b" to true))) + .shouldBeRight() + .shouldBeNone() + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile(vertx, "$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile(vertx, "$[?@.a]").shouldBeRight() + + jsonPath1 + .evaluateSingle( + jsonArrayOf( + jsonObjectOf("a" to 2), + jsonArrayOf(1, jsonObjectOf("a" to 3)), + ), + ).shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(2, JsonPath[0]["a"]), + JsonNode(3, JsonPath[1][1]["a"]), + ) + + jsonPath2 + .evaluateSingle( + jsonArrayOf( + jsonObjectOf("a" to 1), + true, + jsonObjectOf("b" to 3), + jsonObjectOf("a" to 2), + ), + ).shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(jsonObjectOf("a" to 1), JsonPath[0]), + JsonNode(jsonObjectOf("a" to 2), JsonPath[3]), + ) + } + } + } + + context("The onlyPaths function") { + should("return exactly the path fields of the list of JsonNodes") { + checkAll(Arb.list(Arb.normalizedJsonPath(), 0..32)) { paths -> + paths.map { JsonNode(null, it) }.onlyPaths() shouldContainExactly paths + } + } + } + + context("The selector constructor") { + context("taking an IntProgression") { + should("return a proper slice selector") { + val jp1 = JsonPath[Selector(1..6 step 2)] + + jp1.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( + JsonNode(1, JsonPath[1]), + JsonNode(3, JsonPath[3]), + JsonNode(5, JsonPath[5]), + ) + + val jp2 = JsonPath[Selector(6 downTo 0 step 2)] + + jp2.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( + JsonNode(6, JsonPath[6]), + JsonNode(4, JsonPath[4]), + JsonNode(2, JsonPath[2]), + JsonNode(0, JsonPath[0]), + ) + + val jp3 = JsonPath[Selector(-1 downTo -3 step 1)] + + jp3.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( + JsonNode(6, JsonPath[6]), + JsonNode(5, JsonPath[5]), + JsonNode(4, JsonPath[4]), + ) + } + } + + context("taking three nullable integers") { + should("return a proper slice selector") { + val jp1 = JsonPath[Selector(1, 6, 2)] + + jp1.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( + JsonNode(1, JsonPath[1]), + JsonNode(3, JsonPath[3]), + JsonNode(5, JsonPath[5]), + ) + + val jp2 = JsonPath[Selector(6, null, -2)] + + jp2.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( + JsonNode(6, JsonPath[6]), + JsonNode(4, JsonPath[4]), + JsonNode(2, JsonPath[2]), + JsonNode(0, JsonPath[0]), + ) + + val jp3 = JsonPath[Selector(-1, -4, -1)] + + jp3.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( + JsonNode(6, JsonPath[6]), + JsonNode(5, JsonPath[5]), + JsonNode(4, JsonPath[4]), + ) + + val jp4 = JsonPath[Selector(2, 5)] + + jp4.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( + JsonNode(2, JsonPath[2]), + JsonNode(3, JsonPath[3]), + JsonNode(4, JsonPath[4]), + ) + } + } + + context("taking a filter") { + should("return a proper filter Selector") { + val jp1 = + JsonPath[ + Selector( + FilterExpression.Comparison( + FilterExpression.Comparison.Op.LESS, + QueryExpression.Relative(), + ComparableExpression.Literal(3), + ), + ), + ] + + jp1.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( + JsonNode(0, JsonPath[0]), + JsonNode(1, JsonPath[1]), + JsonNode(2, JsonPath[2]), + ) + + val jp2 = + JsonPath[ + Selector( + FilterExpression.Match( + QueryExpression.Relative(listOf(Segment.ChildSegment("a"))), + ComparableExpression.Literal("a.*"), + matchEntire = true, + ), + ), + ] + + jp2 + .evaluate( + jsonArrayOf( + jsonObjectOf("a" to "a"), + jsonObjectOf("a" to "bc"), + jsonObjectOf("a" to "abc"), + jsonObjectOf("b" to "ab"), + ), + ).shouldContainExactly( + JsonNode(jsonObjectOf("a" to "a"), JsonPath[0]), + JsonNode(jsonObjectOf("a" to "abc"), JsonPath[2]), + ) + } + } + } + }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScannerTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScannerTest.kt new file mode 100644 index 0000000..627e052 --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScannerTest.kt @@ -0,0 +1,104 @@ +package com.kobil.vertx.jsonpath.compiler + +import com.kobil.vertx.jsonpath.testing.nameChar +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.shouldBe +import io.kotest.property.Arb +import io.kotest.property.arbitrary.Codepoint +import io.kotest.property.arbitrary.az +import io.kotest.property.arbitrary.of +import io.kotest.property.arbitrary.string +import io.kotest.property.checkAll +import kotlinx.coroutines.flow.toList + +class JsonPathScannerTest : + ShouldSpec({ + context("When called on an empty string") { + should("only return an EOF token") { + "".scanTokens().toList() shouldBe listOf(Token.Eof(1U, 1U)) + } + } + + context("Dotted segments") { + should("be parsed to an Identifier token when they start with a lowercase latin letter") { + checkAll( + Arb.string(1, Codepoint.az()), + Arb.string(1..48, Codepoint.nameChar()), + ) { firstLetter, rest -> + val name = "$firstLetter$rest" + + "$.$name".scanTokens().toList() shouldBe + listOf( + Token.Dollar(1U, 1U), + Token.Dot(1U, 2U), + Token.Identifier(1U, 3U, name), + Token.Eof(1U, name.length.toUInt() + 3U), + ) + } + } + should("be parsed to an Identifier token when they start with a uppercase latin letter") { + checkAll( + Arb.string(1, Arb.of(('A'.code..'Z'.code).map(::Codepoint))), + Arb.string(1..48, Codepoint.nameChar()), + ) { firstLetter, rest -> + val name = "$firstLetter$rest" + + "$.$name".scanTokens().toList() shouldBe + listOf( + Token.Dollar(1U, 1U), + Token.Dot(1U, 2U), + Token.Identifier(1U, 3U, name), + Token.Eof(1U, name.length.toUInt() + 3U), + ) + } + } + + should("be parsed to an Identifier token when they start with an underscore") { + checkAll(Arb.string(1..48, Codepoint.nameChar())) { rest -> + val name = "_$rest" + + "$.$name".scanTokens().toList() shouldBe + listOf( + Token.Dollar(1U, 1U), + Token.Dot(1U, 2U), + Token.Identifier(1U, 3U, name), + Token.Eof(1U, name.length.toUInt() + 3U), + ) + } + } + + should("be parsed to an Identifier token when they start with a letter U+0080-U+D7FF") { + checkAll( + Arb.string(1, Arb.of((0x80..0xd7ff).map(::Codepoint))), + Arb.string(1..48, Codepoint.nameChar()), + ) { firstLetter, rest -> + val name = "$firstLetter$rest" + + "$.$name".scanTokens().toList() shouldBe + listOf( + Token.Dollar(1U, 1U), + Token.Dot(1U, 2U), + Token.Identifier(1U, 3U, name), + Token.Eof(1U, name.length.toUInt() + 3U), + ) + } + } + + should("be parsed to an Identifier token when they start with a letter U+E000-U+FFFF") { + checkAll( + Arb.string(1, Arb.of((0xe000..0xffff).map(::Codepoint))), + Arb.string(1..48, Codepoint.nameChar()), + ) { firstLetter, rest -> + val name = "$firstLetter$rest" + + "$.$name".scanTokens().toList() shouldBe + listOf( + Token.Dollar(1U, 1U), + Token.Dot(1U, 2U), + Token.Identifier(1U, 3U, name), + Token.Eof(1U, name.length.toUInt() + 3U), + ) + } + } + } + }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathErrorTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathErrorTest.kt new file mode 100644 index 0000000..5154093 --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathErrorTest.kt @@ -0,0 +1,135 @@ +package com.kobil.vertx.jsonpath.error + +import com.kobil.vertx.jsonpath.compiler.Token +import io.kotest.assertions.throwables.shouldThrow +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.shouldBe +import io.kotest.matchers.types.shouldBeInstanceOf +import io.kotest.matchers.types.shouldBeSameInstanceAs +import io.kotest.property.checkAll +import java.io.IOException +import kotlin.coroutines.cancellation.CancellationException + +class JsonPathErrorTest : + ShouldSpec({ + context("The 'invoke' operator of JsonPathError") { + context("applied to a JsonPathException") { + should("return the error wrapped in the exception") { + val errors = + listOf( + JsonPathError.UnexpectedError(IllegalArgumentException("a")), + JsonPathError.UnexpectedError(IllegalStateException("a")), + JsonPathError.UnexpectedError(NullPointerException("a")), + JsonPathError.IllegalCharacter('a', 1U, 1U, "something"), + JsonPathError.UnterminatedString(1U, 1U, 1U, 1U), + JsonPathError.UnexpectedToken(Token.QuestionMark(1U, 1U), "something"), + JsonPathError.IllegalSelector(1U, 1U, "something"), + JsonPathError.UnknownFunction("something", 1U, 1U), + JsonPathError.MustBeSingularQuery(1U, 1U), + JsonPathError.InvalidEscapeSequence("abc", 1U, 1U, 1U, "something"), + ) + + for (err in errors) { + JsonPathError(JsonPathException(err)) shouldBeSameInstanceAs err + } + } + } + + context("applied to a CancellationException") { + should("rethrow the exception") { + shouldThrow { + JsonPathError(CancellationException("abc")) + } + } + } + + context("applied to an Error") { + should("rethrow the error") { + shouldThrow { + JsonPathError(OutOfMemoryError("abc")) + } + } + } + + context("applied to any other exception") { + should("return an UnexpectedError wrapping the exception") { + val exceptions = + listOf( + IllegalArgumentException("a"), + IllegalStateException("a"), + NullPointerException("a"), + IOException("a"), + ) + + for (ex in exceptions) { + JsonPathError(ex) + .shouldBeInstanceOf() + .cause shouldBeSameInstanceAs ex + } + } + } + } + + context("The 'IllegalCharacter' error") { + should("produce the correct message from toString") { + checkAll { ch, line, col, reason -> + JsonPathError.IllegalCharacter(ch, line, col, reason).toString() shouldBe + "Error at [$line:$col]: Illegal character '$ch' ($reason)" + } + } + } + + context("The 'UnterminatedString' error") { + should("produce the correct message from toString") { + checkAll { line, col, startLine, startCol -> + JsonPathError.UnterminatedString(line, col, startLine, startCol).toString() shouldBe + "Error at [$line:$col]: Unterminated string literal starting at [$startLine:$startCol]" + } + } + } + + context("The 'UnexpectedToken' error") { + should("produce the correct message from toString") { + checkAll { token, string -> + JsonPathError.UnexpectedToken(token, string).toString() shouldBe + "Error at [${token.line}:${token.column}]: Unexpected token '${token.name}' while parsing $string" + } + } + } + + context("The 'IllegalSelector' error") { + should("produce the correct message from toString") { + checkAll { line, col, string -> + JsonPathError.IllegalSelector(line, col, string).toString() shouldBe + "Error at [$line:$col]: Illegal selector ($string)" + } + } + } + + context("The 'UnknownFunction' error") { + should("produce the correct message from toString") { + checkAll { line, col, name -> + JsonPathError.UnknownFunction(name, line, col).toString() shouldBe + "Error at [$line:$col]: Unknown function extension '$name'" + } + } + } + + context("The 'MustBeSingularQuery' error") { + should("produce the correct message from toString") { + checkAll { line, col -> + JsonPathError.MustBeSingularQuery(line, col).toString() shouldBe + "Error at [$line:$col]: A singular query is expected" + } + } + } + + context("The 'InvalidEscapeSequence' error") { + should("produce the correct message from toString") { + checkAll { string, line, col, pos, reason -> + JsonPathError.InvalidEscapeSequence(string, line, col, pos, reason).toString() shouldBe + "Error at [$line:$col]: Invalid escape sequence at position $pos in string literal '$string' ($reason)" + } + } + } + }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathExceptionTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathExceptionTest.kt new file mode 100644 index 0000000..35605f9 --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathExceptionTest.kt @@ -0,0 +1,88 @@ +package com.kobil.vertx.jsonpath.error + +import com.kobil.vertx.jsonpath.compiler.Token +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.collections.shouldBeEmpty +import io.kotest.matchers.throwable.shouldHaveCause +import io.kotest.matchers.throwable.shouldHaveMessage +import io.kotest.matchers.throwable.shouldNotHaveCause +import io.kotest.matchers.types.shouldBeSameInstanceAs + +class JsonPathExceptionTest : + ShouldSpec({ + context("The constructor of JsonPathException") { + context("called on an instance of UnexpectedError") { + should("use the cause of the UnexpectedError as cause") { + checkUnexpectedErrorCause(IllegalArgumentException("a")) + checkUnexpectedErrorCause(IllegalStateException("a")) + checkUnexpectedErrorCause(NullPointerException("a")) + } + + should("have a message of 'Unexpected error: '") { + checkUnexpectedErrorMessage(IllegalArgumentException("a")) + checkUnexpectedErrorMessage(IllegalStateException("a")) + checkUnexpectedErrorMessage(NullPointerException("a")) + } + + should("have no stack trace") { + checkNoStackTrace(JsonPathError.UnexpectedError(IllegalArgumentException("a"))) + checkNoStackTrace(JsonPathError.UnexpectedError(IllegalStateException("a"))) + checkNoStackTrace(JsonPathError.UnexpectedError(NullPointerException("a"))) + } + } + + context("called on any instance of JsonPathError that is no UnexpectedError") { + should("have no cause") { + checkErrorNoCause(JsonPathError.IllegalCharacter('a', 1U, 1U, "something")) + checkErrorNoCause(JsonPathError.UnterminatedString(1U, 1U, 1U, 1U)) + checkErrorNoCause(JsonPathError.UnexpectedToken(Token.QuestionMark(1U, 1U), "something")) + checkErrorNoCause(JsonPathError.IllegalSelector(1U, 1U, "something")) + checkErrorNoCause(JsonPathError.UnknownFunction("something", 1U, 1U)) + checkErrorNoCause(JsonPathError.MustBeSingularQuery(1U, 1U)) + checkErrorNoCause(JsonPathError.InvalidEscapeSequence("abc", 1U, 1U, 1U, "something")) + } + + should("have a message of error.toString") { + checkErrorMessage(JsonPathError.IllegalCharacter('a', 1U, 1U, "something")) + checkErrorMessage(JsonPathError.UnterminatedString(1U, 1U, 1U, 1U)) + checkErrorMessage(JsonPathError.UnexpectedToken(Token.QuestionMark(1U, 1U), "something")) + checkErrorMessage(JsonPathError.IllegalSelector(1U, 1U, "something")) + checkErrorMessage(JsonPathError.UnknownFunction("something", 1U, 1U)) + checkErrorMessage(JsonPathError.MustBeSingularQuery(1U, 1U)) + checkErrorMessage(JsonPathError.InvalidEscapeSequence("abc", 1U, 1U, 1U, "something")) + } + + should("have no stack trace") { + checkNoStackTrace(JsonPathError.IllegalCharacter('a', 1U, 1U, "something")) + checkNoStackTrace(JsonPathError.UnterminatedString(1U, 1U, 1U, 1U)) + checkNoStackTrace(JsonPathError.UnexpectedToken(Token.QuestionMark(1U, 1U), "something")) + checkNoStackTrace(JsonPathError.IllegalSelector(1U, 1U, "something")) + checkNoStackTrace(JsonPathError.UnknownFunction("something", 1U, 1U)) + checkNoStackTrace(JsonPathError.MustBeSingularQuery(1U, 1U)) + checkNoStackTrace(JsonPathError.InvalidEscapeSequence("abc", 1U, 1U, 1U, "something")) + } + } + } + }) + +private fun checkUnexpectedErrorCause(t: Throwable) { + val e = JsonPathException(JsonPathError.UnexpectedError(t)) + e.shouldHaveCause { it shouldBeSameInstanceAs t } +} + +private fun checkUnexpectedErrorMessage(t: Throwable) { + val e = JsonPathException(JsonPathError.UnexpectedError(t)) + e shouldHaveMessage "Unexpected error: $t" +} + +private fun checkErrorNoCause(e: JsonPathError) { + JsonPathException(e).shouldNotHaveCause() +} + +private fun checkErrorMessage(e: JsonPathError) { + JsonPathException(e) shouldHaveMessage e.toString() +} + +private fun checkNoStackTrace(e: JsonPathError) { + JsonPathException(e).stackTrace.shouldBeEmpty() +} diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/testing/Gen.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/testing/Gen.kt new file mode 100644 index 0000000..97a41c4 --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/testing/Gen.kt @@ -0,0 +1,37 @@ +package com.kobil.vertx.jsonpath.testing + +import com.kobil.vertx.jsonpath.JsonPath +import io.kotest.property.Arb +import io.kotest.property.arbitrary.Codepoint +import io.kotest.property.arbitrary.arbitrary +import io.kotest.property.arbitrary.boolean +import io.kotest.property.arbitrary.int +import io.kotest.property.arbitrary.of +import io.kotest.property.resolution.default + +fun Codepoint.Companion.nameChar(): Arb = + Arb.of( + ('0'.code..'9'.code).map(::Codepoint) + + ('A'.code..'Z'.code).map(::Codepoint) + + ('a'.code..'z'.code).map(::Codepoint) + + Codepoint('_'.code) + + (0x80..0xd7ff).map(::Codepoint) + + (0xe000..0xffff).map(::Codepoint), + ) + +fun Arb.Companion.normalizedJsonPath(): Arb = + arbitrary { + val length = Arb.int(0..10).bind() + var path = JsonPath.root + + for (i in 1..length) { + path = + if (Arb.boolean().bind()) { + path[Arb.default().bind()] + } else { + path[Arb.int(0..Int.MAX_VALUE).bind()] + } + } + + path + } From 17ecfa8a7b803bf6ac8c0c54c85dbc56a82c605e Mon Sep 17 00:00:00 2001 From: Johannes Leupold Date: Fri, 23 Aug 2024 16:49:22 +0200 Subject: [PATCH 4/7] De-suspend everything and write some extensions --- .../com/kobil/vertx/jsonpath/Expression.kt | 7 +- .../com/kobil/vertx/jsonpath/JsonPath.kt | 21 +- .../kotlin/com/kobil/vertx/jsonpath/Vertx.kt | 56 ++ .../jsonpath/compiler/JsonPathCompiler.kt | 40 +- .../vertx/jsonpath/compiler/JsonPathParser.kt | 108 +-- .../jsonpath/compiler/JsonPathScanner.kt | 36 +- .../vertx/jsonpath/error/JsonPathError.kt | 21 + .../vertx/jsonpath/error/MultipleResults.kt | 2 +- .../jsonpath/error/RequiredJsonValueError.kt | 5 + .../kobil/vertx/jsonpath/ComplianceTest.kt | 10 +- .../vertx/jsonpath/FilterExpressionTest.kt | 64 +- .../com/kobil/vertx/jsonpath/JsonPathTest.kt | 75 +- .../vertx/jsonpath/VertxExtensionsTest.kt | 690 ++++++++++++++++++ .../jsonpath/compiler/JsonPathScannerTest.kt | 44 +- .../vertx/jsonpath/error/JsonPathErrorTest.kt | 18 + .../jsonpath/error/JsonPathExceptionTest.kt | 88 --- 16 files changed, 963 insertions(+), 322 deletions(-) create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/Vertx.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/error/RequiredJsonValueError.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/VertxExtensionsTest.kt delete mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathExceptionTest.kt diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt index 9b37b6c..26483b7 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt @@ -7,7 +7,6 @@ import com.kobil.vertx.jsonpath.compiler.JsonPathCompiler.compileJsonPathFilter import com.kobil.vertx.jsonpath.compiler.Token import com.kobil.vertx.jsonpath.error.JsonPathError import com.kobil.vertx.jsonpath.interpreter.match -import io.vertx.core.Vertx import io.vertx.core.json.JsonArray import io.vertx.core.json.JsonObject @@ -55,10 +54,8 @@ sealed interface FilterExpression { ) : FilterExpression companion object { - suspend fun compile( - vertx: Vertx, - filterExpression: String, - ): Either = vertx.compileJsonPathFilter(filterExpression) + fun compile(filterExpression: String): Either = + compileJsonPathFilter(filterExpression) } } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt index da0709a..c7321f1 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt @@ -11,22 +11,16 @@ import com.kobil.vertx.jsonpath.compiler.JsonPathCompiler.compileJsonPathQuery import com.kobil.vertx.jsonpath.error.JsonPathError import com.kobil.vertx.jsonpath.error.MultipleResults import com.kobil.vertx.jsonpath.interpreter.evaluate -import io.vertx.core.Vertx -import io.vertx.core.json.JsonArray -import io.vertx.core.json.JsonObject +import io.vertx.core.json.impl.JsonUtil data class JsonPath internal constructor( val segments: List = emptyList(), ) { - fun evaluate(obj: JsonObject): List = segments.evaluate(obj.rootNode) + fun evaluate(subject: Any?): List = + segments.evaluate(JsonUtil.wrapJsonValue(subject).rootNode) - fun evaluate(arr: JsonArray): List = segments.evaluate(arr.rootNode) - - fun evaluateSingle(obj: JsonObject): Either> = - evaluate(obj).one() - - fun evaluateSingle(arr: JsonArray): Either> = - evaluate(arr).one() + fun evaluateOne(subject: Any?): Either> = + evaluate(subject).one() operator fun get( selector: Selector, @@ -46,10 +40,7 @@ data class JsonPath internal constructor( companion object { val root = JsonPath() - suspend fun compile( - vertx: Vertx, - jsonPath: String, - ): Either = vertx.compileJsonPathQuery(jsonPath) + fun compile(jsonPath: String): Either = compileJsonPathQuery(jsonPath) fun List.one(): Either> = when (size) { diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Vertx.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Vertx.kt new file mode 100644 index 0000000..2788b03 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Vertx.kt @@ -0,0 +1,56 @@ +package com.kobil.vertx.jsonpath + +import arrow.core.Either +import arrow.core.Option +import arrow.core.flatMap +import arrow.core.getOrElse +import arrow.core.left +import arrow.core.right +import com.kobil.vertx.jsonpath.JsonPath.Companion.onlyPaths +import com.kobil.vertx.jsonpath.JsonPath.Companion.onlyValues +import com.kobil.vertx.jsonpath.error.MultipleResults +import com.kobil.vertx.jsonpath.error.RequiredJsonValueError +import io.vertx.core.json.JsonArray +import io.vertx.core.json.JsonObject + +inline operator fun JsonObject.get(path: JsonPath): Either> = + path.evaluateOne(this).map { node -> + node.map { it.value as T } + } + +inline operator fun JsonArray.get(path: JsonPath): Either> = + path.evaluateOne(this).map { node -> + node.map { it.value as T } + } + +inline fun JsonObject.required(path: JsonPath): Either { + val maybeNode = path.evaluateOne(this) as Either> + + return maybeNode.flatMap { node -> + node.map { (it.value as T).right() }.getOrElse { RequiredJsonValueError.NoResult.left() } + } +} + +inline fun JsonArray.required(path: JsonPath): Either { + val maybeNode = path.evaluateOne(this) as Either> + + return maybeNode.flatMap { node -> + node.map { (it.value as T).right() }.getOrElse { RequiredJsonValueError.NoResult.left() } + } +} + +inline fun JsonObject.getAll(path: JsonPath): List = + path.evaluate(this).onlyValues().map { it as T } + +inline fun JsonArray.getAll(path: JsonPath): List = + path.evaluate(this).onlyValues().map { it as T } + +fun JsonObject.traceOne(path: JsonPath): Either> = + path.evaluateOne(this).map { node -> node.map(JsonNode::path) } + +fun JsonArray.traceOne(path: JsonPath): Either> = + path.evaluateOne(this).map { node -> node.map(JsonNode::path) } + +fun JsonObject.traceAll(path: JsonPath): List = path.evaluate(this).onlyPaths() + +fun JsonArray.traceAll(path: JsonPath): List = path.evaluate(this).onlyPaths() diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt index 45103df..a56ee4b 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt @@ -1,50 +1,28 @@ package com.kobil.vertx.jsonpath.compiler import arrow.core.Either -import com.github.benmanes.caffeine.cache.Cache import com.github.benmanes.caffeine.cache.Caffeine +import com.github.benmanes.caffeine.cache.LoadingCache import com.kobil.vertx.jsonpath.FilterExpression import com.kobil.vertx.jsonpath.JsonPath import com.kobil.vertx.jsonpath.error.JsonPathError -import io.vertx.core.Vertx -import io.vertx.kotlin.coroutines.dispatcher -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.async -import kotlinx.coroutines.coroutineScope object JsonPathCompiler { - private val queryCache: Cache> = + private val queryCache: LoadingCache> = Caffeine .newBuilder() .maximumSize(1_000) - .build() + .build { jsonPath -> jsonPath.scanTokens().parseJsonPathQuery() } - private val filterCache: Cache> = + private val filterCache: LoadingCache> = Caffeine .newBuilder() .maximumSize(1_000) - .build() + .build { filterExpression -> filterExpression.scanTokens().parseJsonPathFilter() } - suspend fun Vertx.compileJsonPathQuery(jsonPath: String): Either = - queryCache - .getIfPresent(jsonPath) - ?: launchInScope { - jsonPath.scanTokens().parseJsonPathQuery() - }.also { queryCache.put(jsonPath, it) } + fun compileJsonPathQuery(jsonPath: String): Either = + queryCache.get(jsonPath) - suspend fun Vertx.compileJsonPathFilter( - filterExpression: String, - ): Either = - filterCache - .getIfPresent(filterExpression) - ?: launchInScope { - filterExpression.scanTokens().parseJsonPathFilter() - }.also { filterCache.put(filterExpression, it) } - - private suspend inline fun Vertx.launchInScope( - crossinline block: suspend CoroutineScope.() -> T, - ): T = - coroutineScope { - async(dispatcher()) { block() }.await() - } + fun compileJsonPathFilter(filterExpression: String): Either = + filterCache.get(filterExpression) } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt index 874b790..0d5ee74 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt @@ -14,52 +14,23 @@ import com.kobil.vertx.jsonpath.QueryExpression import com.kobil.vertx.jsonpath.Segment import com.kobil.vertx.jsonpath.Selector import com.kobil.vertx.jsonpath.error.JsonPathError -import kotlinx.coroutines.CoroutineScope -import kotlinx.coroutines.channels.Channel -import kotlinx.coroutines.channels.ReceiveChannel -import kotlinx.coroutines.flow.Flow -import kotlinx.coroutines.flow.catch -import kotlinx.coroutines.flow.launchIn -import kotlinx.coroutines.flow.onCompletion -import kotlinx.coroutines.flow.onEach -import kotlin.coroutines.coroutineContext - -internal suspend fun Flow.parseJsonPathQuery(): Either = - either { - val ch = collectIntoChannel() - - try { - ParserState(ch, this).run { - require("JSON path query") - JsonPath(segments()) - } - } finally { - ch.cancel() - } - } -internal suspend fun Flow.parseJsonPathFilter(): Either = +internal fun Sequence.parseJsonPathQuery(): Either = either { - val ch = collectIntoChannel() - - try { - ParserState(ch, this).filterExpr() - } finally { - ch.cancel() + ParserState(iterator(), this).run { + require("JSON path query") + JsonPath(segments()) } } -private suspend fun Flow.collectIntoChannel(): ReceiveChannel = - Channel().also { ch -> - catch { ch.close(it) } - .onCompletion { ch.close(it) } - .onEach(ch::send) - .launchIn(CoroutineScope(coroutineContext)) +internal fun Sequence.parseJsonPathFilter() = + either { + ParserState(iterator(), this).filterExpr() } -private suspend fun ParserState.filterExpr() = or() +private fun ParserState.filterExpr() = or() -private suspend fun ParserState.segments(): List = +private fun ParserState.segments(): List = buildList { while (!isAtEnd()) { skipWhiteSpace() @@ -76,15 +47,15 @@ private suspend fun ParserState.segments(): List = } }.toList() -private suspend fun ParserState.childSegment(dottedSegment: Boolean): Segment = +private fun ParserState.childSegment(dottedSegment: Boolean): Segment = Segment.ChildSegment(selectors(dottedSegment, "child")) -private suspend fun ParserState.descendantSegment(): Segment { +private fun ParserState.descendantSegment(): Segment { val dottedSegment = !advanceIf() return Segment.DescendantSegment(selectors(dottedSegment, "descendant")) } -private suspend fun ParserState.selectors( +private fun ParserState.selectors( dottedSegment: Boolean, segmentType: String, ): List { @@ -101,7 +72,7 @@ private suspend fun ParserState.selectors( return selectors.toList() } -private suspend fun ParserState.selector(dottedSegment: Boolean): Selector = +private fun ParserState.selector(dottedSegment: Boolean): Selector = when (val t = advance()) { is Token.Star -> Selector.Wildcard @@ -210,14 +181,14 @@ private fun ParserState.checkInt(number: Token.Integer): Int { return number.value } -private suspend fun ParserState.queryExpr(): QueryExpression = +private fun ParserState.queryExpr(): QueryExpression = when (val t = advance()) { is Token.At -> QueryExpression.Relative(segments(), t) is Token.Dollar -> QueryExpression.Absolute(segments(), t) else -> unexpectedToken(t, "query expression") } -private suspend inline fun ParserState.functionExpr( +private inline fun ParserState.functionExpr( identifier: Token.Identifier, parse: ParserState.() -> C, constructor: (C, Token?) -> ComparableExpression, @@ -232,7 +203,7 @@ private suspend inline fun ParserState.functionExpr( return expr } -private suspend fun ParserState.functionExpr(identifier: Token.Identifier): ComparableExpression = +private fun ParserState.functionExpr(identifier: Token.Identifier): ComparableExpression = when (val name = identifier.value) { "length" -> functionExpr(identifier, { comparable() }, FunctionExpression::Length) "count" -> @@ -248,7 +219,7 @@ private suspend fun ParserState.functionExpr(identifier: Token.Identifier): Comp else -> raise(JsonPathError.UnknownFunction(name, identifier.line, identifier.column)) } -private suspend fun ParserState.comparable(): ComparableExpression = +private fun ParserState.comparable(): ComparableExpression = when (val t = advance()) { is Token.Integer -> ComparableExpression.Literal(t.value, t) is Token.Decimal -> ComparableExpression.Literal(t.value, t) @@ -266,7 +237,7 @@ private suspend fun ParserState.comparable(): ComparableExpression = else -> unexpectedToken(t, "comparable expression") } -private suspend fun ParserState.groupExpr(): FilterExpression { +private fun ParserState.groupExpr(): FilterExpression { require("parenthesized expression") skipWhiteSpace() val expr = filterExpr() @@ -276,13 +247,13 @@ private suspend fun ParserState.groupExpr(): FilterExpression { return expr } -private suspend fun ParserState.notExpr(): FilterExpression { +private fun ParserState.notExpr(): FilterExpression { require("not expression") skipWhiteSpace() return FilterExpression.Not(basicLogicalExpr()) } -private suspend fun ParserState.matchOrSearchFunction(): FilterExpression { +private fun ParserState.matchOrSearchFunction(): FilterExpression { val identifier = require("basic logical expression") val name = identifier.value @@ -301,7 +272,7 @@ private suspend fun ParserState.matchOrSearchFunction(): FilterExpression { return FilterExpression.Match(firstArg, secondArg, name == "match", identifier) } -private suspend fun ParserState.basicLogicalExpr(): FilterExpression { +private fun ParserState.basicLogicalExpr(): FilterExpression { if (check()) { return notExpr() } else if (check()) { @@ -352,7 +323,7 @@ private fun Raise.checkSingular( } } -private suspend fun ParserState.and(): FilterExpression { +private fun ParserState.and(): FilterExpression { var expr = basicLogicalExpr() skipWhiteSpace() @@ -371,7 +342,7 @@ private suspend fun ParserState.and(): FilterExpression { return expr } -private suspend fun ParserState.or(): FilterExpression { +private fun ParserState.or(): FilterExpression { var expr = and() skipWhiteSpace() @@ -392,25 +363,25 @@ private suspend fun ParserState.or(): FilterExpression { return expr } -private suspend fun ParserState.skipWhiteSpace() { +private fun ParserState.skipWhiteSpace() { while (advanceIf()) { // Drop all whitespace tokens } } -private suspend fun ParserState.peek(): Token = +private fun ParserState.peek(): Token = current ?: run { - val first = receiveToken()!! + val first = receiveToken() current = first first } -private suspend fun ParserState.advance(): Token = +private fun ParserState.advance(): Token = peek().also { - current = receiveToken() + if (!isAtEnd()) current = receiveToken() } -private suspend inline fun ParserState.advanceIf(): Boolean { +private inline fun ParserState.advanceIf(): Boolean { if (check()) { advance() return true @@ -419,7 +390,7 @@ private suspend inline fun ParserState.advanceIf(): Boolean return false } -private suspend inline fun ParserState.takeIf(): T? { +private inline fun ParserState.takeIf(): T? { if (check()) { return advance() as T } @@ -427,27 +398,20 @@ private suspend inline fun ParserState.takeIf(): T? { return null } -private suspend inline fun ParserState.require(parsing: String): T = +private inline fun ParserState.require(parsing: String): T = takeIf() ?: unexpectedToken(peek(), parsing) -private suspend inline fun ParserState.check(): Boolean = peek() is T +private inline fun ParserState.check(): Boolean = peek() is T -private suspend fun ParserState.isAtEnd(): Boolean = check() +private fun ParserState.isAtEnd(): Boolean = check() private class ParserState( - tokens: ReceiveChannel, + tokens: Iterator>, raise: Raise, var current: Token? = null, ) : Raise by raise, - ReceiveChannel by tokens { - suspend fun receiveToken(): Token? = - receiveCatching().let { - when { - it.isClosed -> it.exceptionOrNull()?.let { t -> raise(JsonPathError(t)) } - it.isSuccess -> it.getOrThrow() - else -> error("Unexpected Failed channel result") - } - } + Iterator> by tokens { + fun receiveToken(): Token = next().bind() } private fun ParserState.unexpectedToken( diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt index d71d522..b9dea18 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt @@ -1,18 +1,19 @@ package com.kobil.vertx.jsonpath.compiler +import arrow.core.Either +import arrow.core.left import arrow.core.raise.Raise import arrow.core.raise.recover +import arrow.core.right import com.kobil.vertx.jsonpath.error.JsonPathError -import com.kobil.vertx.jsonpath.error.JsonPathException -import kotlinx.coroutines.flow.Flow -import kotlinx.coroutines.flow.FlowCollector -import kotlinx.coroutines.flow.flow -internal fun String.scanTokens(): Flow = - flow { +internal typealias TokenEvent = Either + +internal fun String.scanTokens(): Sequence = + sequence { recover( block = { - val scannerState = ScannerState(this@scanTokens, this@flow, this) + val scannerState = ScannerState(this@scanTokens, this) if (firstOrNull() in whitespaceChar) { this.raise( @@ -29,7 +30,7 @@ internal fun String.scanTokens(): Flow = scannerState.start = scannerState.current scannerState.startLine = scannerState.line scannerState.startColumn = scannerState.column - emit(scannerState.scanToken()) + yield(scannerState.scanToken().right()) } if (lastOrNull() in whitespaceChar) { @@ -45,10 +46,10 @@ internal fun String.scanTokens(): Flow = scannerState.start = scannerState.current - emit(Token.Eof(scannerState.line, scannerState.column)) + yield(Token.Eof(scannerState.line, scannerState.column).right()) }, recover = { - throw JsonPathException(it) + yield(it.left()) }, ) } @@ -153,7 +154,14 @@ private fun ScannerState.scanNumber(first: Char): Token { return scanScientificNotation() } - return Token.Integer(line, column, negative, expr.substring(start.., raise: Raise, var start: UInt = 0U, var current: UInt = 0U, @@ -303,8 +312,7 @@ private class ScannerState( var currentLineStart: UInt = 0U, var startLine: UInt = 1U, var startColumn: UInt = 1U, -) : Raise by raise, - FlowCollector by flow +) : Raise by raise private val identifierChar = ('A'..'Z').toSet() + ('a'..'z') + '_' + ('\u0080'..'\ud7ff') + ('\ue000'..'\uffff') + diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt index fc0acfe..80c24ec 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt @@ -4,6 +4,15 @@ import com.kobil.vertx.jsonpath.compiler.Token import kotlinx.coroutines.CancellationException sealed interface JsonPathError { + data class PrematureEof( + val expected: String, + val line: UInt, + val column: UInt, + ) : JsonPathError { + override fun toString(): String = + "${messagePrefix(line, column)}: Premature end of input, expected $expected" + } + data class IllegalCharacter( val char: Char, val line: UInt, @@ -27,6 +36,18 @@ sealed interface JsonPathError { )}: Unterminated string literal starting at [$startLine:$startColumn]" } + data class IntOutOfBounds( + val string: String, + val line: UInt, + val column: UInt, + ) : JsonPathError { + override fun toString(): String = + "${messagePrefix( + line, + column, + )}: Invalid integer value (Out of bounds)" + } + data class UnexpectedToken( val token: Token, val parsing: String, diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt index 98e5db9..26ff99c 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt @@ -4,4 +4,4 @@ import com.kobil.vertx.jsonpath.JsonNode data class MultipleResults( val results: List, -) +) : RequiredJsonValueError diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/RequiredJsonValueError.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/RequiredJsonValueError.kt new file mode 100644 index 0000000..7807bce --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/RequiredJsonValueError.kt @@ -0,0 +1,5 @@ +package com.kobil.vertx.jsonpath.error + +sealed interface RequiredJsonValueError { + data object NoResult : RequiredJsonValueError +} diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/ComplianceTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/ComplianceTest.kt index b00dfc0..24413d5 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/ComplianceTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/ComplianceTest.kt @@ -45,7 +45,7 @@ class ComplianceTest : if (test.isInvalid) { ctx(test.name) { should("yield an error when compiled") { - JsonPath.compile(vertx, test.selector).shouldBeLeft() + JsonPath.compile(test.selector).shouldBeLeft() } } } else { @@ -55,11 +55,11 @@ class ComplianceTest : if (result != null) { ctx(test.name) { should("compile to a valid JSON path") { - JsonPath.compile(vertx, test.selector).shouldBeRight() + JsonPath.compile(test.selector).shouldBeRight() } should("yield the expected results") { - val jsonPath = JsonPath.compile(vertx, test.selector).shouldBeRight() + val jsonPath = JsonPath.compile(test.selector).shouldBeRight() val actual = when (val d = test.document) { @@ -74,11 +74,11 @@ class ComplianceTest : } else if (results != null) { ctx(test.name) { should("compile to a valid JSON path") { - JsonPath.compile(vertx, test.selector).shouldBeRight() + JsonPath.compile(test.selector).shouldBeRight() } should("yield the expected results") { - val jsonPath = JsonPath.compile(vertx, test.selector).shouldBeRight() + val jsonPath = JsonPath.compile(test.selector).shouldBeRight() val actual = when (val d = test.document) { diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt index 2f3a2bd..3f7bee7 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt @@ -2,8 +2,6 @@ package com.kobil.vertx.jsonpath import com.kobil.vertx.jsonpath.compiler.Token import com.kobil.vertx.jsonpath.error.JsonPathError -import com.kobil.vertx.jsonpath.testing.VertxExtension -import com.kobil.vertx.jsonpath.testing.VertxExtension.Companion.vertx import io.kotest.assertions.arrow.core.shouldBeLeft import io.kotest.assertions.arrow.core.shouldBeRight import io.kotest.core.spec.style.ShouldSpec @@ -14,8 +12,6 @@ import io.vertx.kotlin.core.json.jsonObjectOf class FilterExpressionTest : ShouldSpec({ - register(VertxExtension()) - context("Invalid filter expressions") { context("with a leading question mark") { should("result in an error when compiled") { @@ -26,74 +22,74 @@ class FilterExpressionTest : ) // Leading ? must be omitted - FilterExpression.compile(vertx, "?@") shouldBeLeft unexpectedQuestion - FilterExpression.compile(vertx, "?@.abc") shouldBeLeft unexpectedQuestion - FilterExpression.compile(vertx, "?!@") shouldBeLeft unexpectedQuestion - FilterExpression.compile(vertx, "?!@.abc") shouldBeLeft unexpectedQuestion - FilterExpression.compile(vertx, "?@ == 'x'") shouldBeLeft unexpectedQuestion - FilterExpression.compile(vertx, "?@.abc < 1U") shouldBeLeft unexpectedQuestion - FilterExpression.compile(vertx, "?@['xyz'] >= 'a'") shouldBeLeft unexpectedQuestion - FilterExpression.compile(vertx, "?@.abc != 2U") shouldBeLeft unexpectedQuestion + FilterExpression.compile("?@") shouldBeLeft unexpectedQuestion + FilterExpression.compile("?@.abc") shouldBeLeft unexpectedQuestion + FilterExpression.compile("?!@") shouldBeLeft unexpectedQuestion + FilterExpression.compile("?!@.abc") shouldBeLeft unexpectedQuestion + FilterExpression.compile("?@ == 'x'") shouldBeLeft unexpectedQuestion + FilterExpression.compile("?@.abc < 1U") shouldBeLeft unexpectedQuestion + FilterExpression.compile("?@['xyz'] >= 'a'") shouldBeLeft unexpectedQuestion + FilterExpression.compile("?@.abc != 2U") shouldBeLeft unexpectedQuestion } } context("with a non-singular query as the operand of a comparison expression") { should("result in an error when compiled") { - FilterExpression.compile(vertx, "@..a == 2") shouldBeLeft + FilterExpression.compile("@..a == 2") shouldBeLeft JsonPathError.MustBeSingularQuery( 1U, 1U, ) - FilterExpression.compile(vertx, "2 == @..a") shouldBeLeft + FilterExpression.compile("2 == @..a") shouldBeLeft JsonPathError.MustBeSingularQuery( 1U, 6U, ) - FilterExpression.compile(vertx, "@.a[1, 2] == 2") shouldBeLeft + FilterExpression.compile("@.a[1, 2] == 2") shouldBeLeft JsonPathError.MustBeSingularQuery( 1U, 1U, ) - FilterExpression.compile(vertx, "2 == @.a[1, 2]") shouldBeLeft + FilterExpression.compile("2 == @.a[1, 2]") shouldBeLeft JsonPathError.MustBeSingularQuery( 1U, 6U, ) - FilterExpression.compile(vertx, "@.a['b', 'c'] == 2") shouldBeLeft + FilterExpression.compile("@.a['b', 'c'] == 2") shouldBeLeft JsonPathError.MustBeSingularQuery( 1U, 1U, ) - FilterExpression.compile(vertx, "2 == @.a['b', 'c']") shouldBeLeft + FilterExpression.compile("2 == @.a['b', 'c']") shouldBeLeft JsonPathError.MustBeSingularQuery( 1U, 6U, ) - FilterExpression.compile(vertx, "@.a[1:] == 2") shouldBeLeft + FilterExpression.compile("@.a[1:] == 2") shouldBeLeft JsonPathError.MustBeSingularQuery( 1U, 1U, ) - FilterExpression.compile(vertx, "2 == @.a[1:]") shouldBeLeft + FilterExpression.compile("2 == @.a[1:]") shouldBeLeft JsonPathError.MustBeSingularQuery( 1U, 6U, ) - FilterExpression.compile(vertx, "@.a[?@.b == 1] == 2") shouldBeLeft + FilterExpression.compile("@.a[?@.b == 1] == 2") shouldBeLeft JsonPathError.MustBeSingularQuery( 1U, 1U, ) - FilterExpression.compile(vertx, "2 == @.a[?@.b == 1]") shouldBeLeft + FilterExpression.compile("2 == @.a[?@.b == 1]") shouldBeLeft JsonPathError.MustBeSingularQuery( 1U, 6U, @@ -114,31 +110,31 @@ class FilterExpressionTest : val hasNested1 = "@..[1]" should("compile successfully") { - FilterExpression.compile(vertx, hasA) shouldBeRight + FilterExpression.compile(hasA) shouldBeRight FilterExpression.Existence( QueryExpression.Relative(listOf(Segment.ChildSegment("a")), at), ) - FilterExpression.compile(vertx, hasB) shouldBeRight + FilterExpression.compile(hasB) shouldBeRight FilterExpression.Existence( QueryExpression.Relative(listOf(Segment.ChildSegment("b")), at), ) - FilterExpression.compile(vertx, has1) shouldBeRight + FilterExpression.compile(has1) shouldBeRight FilterExpression.Existence( QueryExpression.Relative(listOf(Segment.ChildSegment(1)), at), ) - FilterExpression.compile(vertx, hasNestedA) shouldBeRight + FilterExpression.compile(hasNestedA) shouldBeRight FilterExpression.Existence( QueryExpression.Relative(listOf(Segment.DescendantSegment("a")), at), ) - FilterExpression.compile(vertx, hasNestedB) shouldBeRight + FilterExpression.compile(hasNestedB) shouldBeRight FilterExpression.Existence( QueryExpression.Relative(listOf(Segment.DescendantSegment("b")), at), ) - FilterExpression.compile(vertx, hasNested1) shouldBeRight + FilterExpression.compile(hasNested1) shouldBeRight FilterExpression.Existence( QueryExpression.Relative(listOf(Segment.DescendantSegment(1)), at), ) @@ -157,7 +153,7 @@ class FilterExpressionTest : val arr3 = jsonArrayOf("a", "b", "c", "d") val arr4 = jsonArrayOf(1) - FilterExpression.compile(vertx, hasA).shouldBeRight().also { + FilterExpression.compile(hasA).shouldBeRight().also { it.match(obj1).shouldBeTrue() it.match(obj2).shouldBeFalse() it.match(obj3).shouldBeTrue() @@ -168,7 +164,7 @@ class FilterExpressionTest : it.match(arr4).shouldBeFalse() } - FilterExpression.compile(vertx, hasB).shouldBeRight().also { + FilterExpression.compile(hasB).shouldBeRight().also { it.match(obj1).shouldBeFalse() it.match(obj2).shouldBeTrue() it.match(obj3).shouldBeTrue() @@ -179,7 +175,7 @@ class FilterExpressionTest : it.match(arr4).shouldBeFalse() } - FilterExpression.compile(vertx, has1).shouldBeRight().also { + FilterExpression.compile(has1).shouldBeRight().also { it.match(obj1).shouldBeFalse() it.match(obj2).shouldBeFalse() it.match(obj3).shouldBeFalse() @@ -214,7 +210,7 @@ class FilterExpressionTest : val arr3 = jsonArrayOf("a", "b", "c", "d") val arr4 = jsonArrayOf(jsonArrayOf("a", "b")) - FilterExpression.compile(vertx, hasNestedA).shouldBeRight().also { + FilterExpression.compile(hasNestedA).shouldBeRight().also { it.match(obj1).shouldBeTrue() it.match(obj2).shouldBeTrue() it.match(obj3).shouldBeTrue() @@ -227,7 +223,7 @@ class FilterExpressionTest : it.match(arr4).shouldBeFalse() } - FilterExpression.compile(vertx, hasNestedB).shouldBeRight().also { + FilterExpression.compile(hasNestedB).shouldBeRight().also { it.match(obj1).shouldBeFalse() it.match(obj2).shouldBeTrue() it.match(obj3).shouldBeTrue() @@ -240,7 +236,7 @@ class FilterExpressionTest : it.match(arr4).shouldBeFalse() } - FilterExpression.compile(vertx, hasNested1).shouldBeRight().also { + FilterExpression.compile(hasNested1).shouldBeRight().also { it.match(obj1).shouldBeFalse() it.match(obj2).shouldBeFalse() it.match(obj3).shouldBeFalse() diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt index 794e4ba..12f271e 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt @@ -1,8 +1,6 @@ package com.kobil.vertx.jsonpath import com.kobil.vertx.jsonpath.JsonPath.Companion.onlyPaths -import com.kobil.vertx.jsonpath.testing.VertxExtension -import com.kobil.vertx.jsonpath.testing.VertxExtension.Companion.vertx import com.kobil.vertx.jsonpath.testing.normalizedJsonPath import io.kotest.assertions.arrow.core.shouldBeLeft import io.kotest.assertions.arrow.core.shouldBeNone @@ -19,60 +17,67 @@ import io.vertx.kotlin.core.json.jsonObjectOf class JsonPathTest : ShouldSpec({ - register(VertxExtension()) - context("The evaluateSingle function") { context("called on a JSON object") { should("return the single result if there is exactly one") { - val jsonPath1 = JsonPath.compile(vertx, "$.a").shouldBeRight() - val jsonPath2 = JsonPath.compile(vertx, "$.a[1]['b']").shouldBeRight() + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() jsonPath1 - .evaluateSingle(jsonObjectOf("a" to 1, "b" to 2)) + .evaluateOne(jsonObjectOf("a" to 1, "b" to 2)) .shouldBeRight() shouldBeSome JsonNode(1, JsonPath["a"]) + jsonObjectOf("a" to 1, "b" to 2) + .get(jsonPath1) + .shouldBeRight() shouldBeSome 1 jsonPath1 - .evaluateSingle(jsonObjectOf("a" to "string")) + .evaluateOne(jsonObjectOf("a" to "string")) .shouldBeRight() shouldBeSome JsonNode("string", JsonPath["a"]) + jsonObjectOf("a" to "string") + .get(jsonPath1) + .shouldBeRight() shouldBeSome "string" jsonPath2 - .evaluateSingle(jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("b" to true)))) + .evaluateOne(jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("b" to true)))) .shouldBeRight() shouldBeSome JsonNode(true, JsonPath["a"][1]["b"]) + jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("b" to true))) + .get(jsonPath2) + .shouldBeRight() shouldBeSome true } should("return None if there is no result") { - val jsonPath1 = JsonPath.compile(vertx, "$.a").shouldBeRight() - val jsonPath2 = JsonPath.compile(vertx, "$.a[1]['b']").shouldBeRight() + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() - jsonPath1.evaluateSingle(jsonObjectOf("b" to 2)).shouldBeRight().shouldBeNone() + jsonPath1.evaluateOne(jsonObjectOf("b" to 2)).shouldBeRight().shouldBeNone() jsonPath1 - .evaluateSingle(jsonObjectOf("b" to jsonObjectOf("a" to 1))) + .evaluateOne(jsonObjectOf("b" to jsonObjectOf("a" to 1))) .shouldBeRight() .shouldBeNone() jsonPath2 - .evaluateSingle(jsonObjectOf("b" to jsonArrayOf(null, jsonObjectOf("b" to true)))) + .evaluateOne(jsonObjectOf("b" to jsonArrayOf(null, jsonObjectOf("b" to true)))) .shouldBeRight() .shouldBeNone() jsonPath2 - .evaluateSingle(jsonObjectOf("a" to jsonArrayOf(jsonObjectOf("b" to true)))) + .evaluateOne(jsonObjectOf("a" to jsonArrayOf(jsonObjectOf("b" to true)))) .shouldBeRight() .shouldBeNone() jsonPath2 - .evaluateSingle(jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("a" to true)))) + .evaluateOne(jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("a" to true)))) .shouldBeRight() .shouldBeNone() } should("return an error if there are multiple results") { - val jsonPath1 = JsonPath.compile(vertx, "$..a").shouldBeRight() - val jsonPath2 = JsonPath.compile(vertx, "$[?@.a]").shouldBeRight() + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() jsonPath1 - .evaluateSingle( + .evaluateOne( jsonObjectOf( "a" to 1, "b" to jsonObjectOf("a" to 2), @@ -87,7 +92,7 @@ class JsonPathTest : ) jsonPath1 - .evaluateSingle(jsonObjectOf("a" to "string", "b" to jsonObjectOf("a" to null))) + .evaluateOne(jsonObjectOf("a" to "string", "b" to jsonObjectOf("a" to null))) .shouldBeLeft() .results .shouldContainExactlyInAnyOrder( @@ -96,7 +101,7 @@ class JsonPathTest : ) jsonPath2 - .evaluateSingle( + .evaluateOne( jsonObjectOf( "a" to jsonObjectOf("a" to 1), "b" to jsonObjectOf("a" to 2), @@ -112,45 +117,45 @@ class JsonPathTest : context("called on a JSON array") { should("return the single result if there is exactly one") { - val jsonPath1 = JsonPath.compile(vertx, "$[0]").shouldBeRight() - val jsonPath2 = JsonPath.compile(vertx, "$[1]['b']").shouldBeRight() + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() jsonPath1 - .evaluateSingle(jsonArrayOf(1, 2, 3)) + .evaluateOne(jsonArrayOf(1, 2, 3)) .shouldBeRight() shouldBeSome JsonNode(1, JsonPath[0]) jsonPath1 - .evaluateSingle(jsonArrayOf("string", null, true)) + .evaluateOne(jsonArrayOf("string", null, true)) .shouldBeRight() shouldBeSome JsonNode("string", JsonPath[0]) jsonPath2 - .evaluateSingle(jsonArrayOf(null, jsonObjectOf("b" to true))) + .evaluateOne(jsonArrayOf(null, jsonObjectOf("b" to true))) .shouldBeRight() shouldBeSome JsonNode(true, JsonPath[1]["b"]) } should("return None if there is no result") { - val jsonPath1 = JsonPath.compile(vertx, "$[0]").shouldBeRight() - val jsonPath2 = JsonPath.compile(vertx, "$[1]['b']").shouldBeRight() + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() - jsonPath1.evaluateSingle(jsonArrayOf()).shouldBeRight().shouldBeNone() + jsonPath1.evaluateOne(jsonArrayOf()).shouldBeRight().shouldBeNone() jsonPath2 - .evaluateSingle(jsonArrayOf(null, jsonObjectOf("a" to true))) + .evaluateOne(jsonArrayOf(null, jsonObjectOf("a" to true))) .shouldBeRight() .shouldBeNone() jsonPath2 - .evaluateSingle(jsonArrayOf(jsonObjectOf("b" to true))) + .evaluateOne(jsonArrayOf(jsonObjectOf("b" to true))) .shouldBeRight() .shouldBeNone() } should("return an error if there are multiple results") { - val jsonPath1 = JsonPath.compile(vertx, "$..a").shouldBeRight() - val jsonPath2 = JsonPath.compile(vertx, "$[?@.a]").shouldBeRight() + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() jsonPath1 - .evaluateSingle( + .evaluateOne( jsonArrayOf( jsonObjectOf("a" to 2), jsonArrayOf(1, jsonObjectOf("a" to 3)), @@ -163,7 +168,7 @@ class JsonPathTest : ) jsonPath2 - .evaluateSingle( + .evaluateOne( jsonArrayOf( jsonObjectOf("a" to 1), true, diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/VertxExtensionsTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/VertxExtensionsTest.kt new file mode 100644 index 0000000..c7683e3 --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/VertxExtensionsTest.kt @@ -0,0 +1,690 @@ +package com.kobil.vertx.jsonpath + +import com.kobil.vertx.jsonpath.error.MultipleResults +import com.kobil.vertx.jsonpath.error.RequiredJsonValueError +import io.kotest.assertions.arrow.core.shouldBeLeft +import io.kotest.assertions.arrow.core.shouldBeNone +import io.kotest.assertions.arrow.core.shouldBeRight +import io.kotest.assertions.arrow.core.shouldBeSome +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.collections.shouldContainExactly +import io.kotest.matchers.collections.shouldContainExactlyInAnyOrder +import io.kotest.matchers.shouldBe +import io.kotest.matchers.types.shouldBeInstanceOf +import io.vertx.core.json.JsonObject +import io.vertx.kotlin.core.json.jsonArrayOf +import io.vertx.kotlin.core.json.jsonObjectOf + +class VertxExtensionsTest : + ShouldSpec({ + context("The get operator") { + context("applied to a JsonObject") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonObjectOf("a" to 1, "b" to 2) + .get(jsonPath1) + .shouldBeRight() shouldBeSome 1 + + jsonObjectOf("a" to "string") + .get(jsonPath1) + .shouldBeRight() shouldBeSome "string" + + jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("b" to true))) + .get(jsonPath2) + .shouldBeRight() shouldBeSome true + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonPath1.evaluateOne(jsonObjectOf("b" to 2)).shouldBeRight().shouldBeNone() + + jsonObjectOf("b" to jsonObjectOf("a" to 1)) + .get(jsonPath1) + .shouldBeRight() + .shouldBeNone() + + jsonObjectOf("b" to jsonArrayOf(null, jsonObjectOf("b" to true))) + .get(jsonPath2) + .shouldBeRight() + .shouldBeNone() + + jsonObjectOf("a" to jsonArrayOf(jsonObjectOf("b" to true))) + .get(jsonPath2) + .shouldBeRight() + .shouldBeNone() + + jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("a" to true))) + .get(jsonPath2) + .shouldBeRight() + .shouldBeNone() + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonObjectOf( + "a" to 1, + "b" to jsonObjectOf("a" to 2), + "c" to jsonArrayOf(1, jsonObjectOf("a" to 3)), + ).get(jsonPath1) + .shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(1, JsonPath["a"]), + JsonNode(2, JsonPath["b"]["a"]), + JsonNode(3, JsonPath["c"][1]["a"]), + ) + + jsonObjectOf("a" to "string", "b" to jsonObjectOf("a" to null)) + .get(jsonPath1) + .shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode("string", JsonPath["a"]), + JsonNode(null, JsonPath["b"]["a"]), + ) + + jsonObjectOf("a" to jsonObjectOf("a" to 1), "b" to jsonObjectOf("a" to 2)) + .get(jsonPath2) + .shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(jsonObjectOf("a" to 1), JsonPath["a"]), + JsonNode(jsonObjectOf("a" to 2), JsonPath["b"]), + ) + } + } + + context("applied to a JsonArray") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonArrayOf(1, 2, 3) + .get(jsonPath1) + .shouldBeRight() shouldBeSome 1 + + jsonArrayOf("string", null, true) + .get(jsonPath1) + .shouldBeRight() shouldBeSome "string" + + jsonArrayOf(null, jsonObjectOf("b" to true)) + .get(jsonPath2) + .shouldBeRight() shouldBeSome true + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonArrayOf() + .get(jsonPath1) + .shouldBeRight() + .shouldBeNone() + + jsonArrayOf(null, jsonObjectOf("a" to true)) + .get(jsonPath2) + .shouldBeRight() + .shouldBeNone() + + jsonArrayOf(jsonObjectOf("b" to true)) + .get(jsonPath2) + .shouldBeRight() + .shouldBeNone() + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonArrayOf(jsonObjectOf("a" to 2), jsonArrayOf(1, jsonObjectOf("a" to 3))) + .get(jsonPath1) + .shouldBeLeft() + .results + .shouldContainExactly( + JsonNode(2, JsonPath[0]["a"]), + JsonNode(3, JsonPath[1][1]["a"]), + ) + + jsonArrayOf( + jsonObjectOf("a" to 1), + true, + jsonObjectOf("b" to 3), + jsonObjectOf("a" to 2), + ).get(jsonPath2) + .shouldBeLeft() + .results + .shouldContainExactly( + JsonNode(jsonObjectOf("a" to 1), JsonPath[0]), + JsonNode(jsonObjectOf("a" to 2), JsonPath[3]), + ) + } + } + } + + context("The required function") { + context("applied to a JsonObject") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonObjectOf("a" to 1, "b" to 2) + .required(jsonPath1) + .shouldBeRight(1) + + jsonObjectOf("a" to "string") + .required(jsonPath1) + .shouldBeRight("string") + + jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("b" to true))) + .required(jsonPath2) + .shouldBeRight(true) + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonPath1.evaluateOne(jsonObjectOf("b" to 2)).shouldBeRight().shouldBeNone() + + jsonObjectOf("b" to jsonObjectOf("a" to 1)) + .required(jsonPath1) + .shouldBeLeft(RequiredJsonValueError.NoResult) + + jsonObjectOf("b" to jsonArrayOf(null, jsonObjectOf("b" to true))) + .required(jsonPath2) + .shouldBeLeft(RequiredJsonValueError.NoResult) + + jsonObjectOf("a" to jsonArrayOf(jsonObjectOf("b" to true))) + .required(jsonPath2) + .shouldBeLeft(RequiredJsonValueError.NoResult) + + jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("a" to true))) + .required(jsonPath2) + .shouldBeLeft(RequiredJsonValueError.NoResult) + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonObjectOf( + "a" to 1, + "b" to jsonObjectOf("a" to 2), + "c" to jsonArrayOf(1, jsonObjectOf("a" to 3)), + ).required(jsonPath1) + .shouldBeLeft() + .shouldBeInstanceOf() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(1, JsonPath["a"]), + JsonNode(2, JsonPath["b"]["a"]), + JsonNode(3, JsonPath["c"][1]["a"]), + ) + + jsonObjectOf("a" to "string", "b" to jsonObjectOf("a" to null)) + .required(jsonPath1) + .shouldBeLeft() + .shouldBeInstanceOf() + .results + .shouldContainExactlyInAnyOrder( + JsonNode("string", JsonPath["a"]), + JsonNode(null, JsonPath["b"]["a"]), + ) + + jsonObjectOf("a" to jsonObjectOf("a" to 1), "b" to jsonObjectOf("a" to 2)) + .required(jsonPath2) + .shouldBeLeft() + .shouldBeInstanceOf() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(jsonObjectOf("a" to 1), JsonPath["a"]), + JsonNode(jsonObjectOf("a" to 2), JsonPath["b"]), + ) + } + } + + context("applied to a JsonArray") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonArrayOf(1, 2, 3) + .required(jsonPath1) + .shouldBeRight(1) + + jsonArrayOf("string", null, true) + .required(jsonPath1) + .shouldBeRight("string") + + jsonArrayOf(null, jsonObjectOf("b" to true)) + .required(jsonPath2) + .shouldBeRight(true) + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonArrayOf() + .required(jsonPath1) + .shouldBeLeft(RequiredJsonValueError.NoResult) + + jsonArrayOf(null, jsonObjectOf("a" to true)) + .required(jsonPath2) + .shouldBeLeft(RequiredJsonValueError.NoResult) + + jsonArrayOf(jsonObjectOf("b" to true)) + .required(jsonPath2) + .shouldBeLeft(RequiredJsonValueError.NoResult) + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonArrayOf(jsonObjectOf("a" to 2), jsonArrayOf(1, jsonObjectOf("a" to 3))) + .required(jsonPath1) + .shouldBeLeft() + .shouldBeInstanceOf() + .results + .shouldContainExactly( + JsonNode(2, JsonPath[0]["a"]), + JsonNode(3, JsonPath[1][1]["a"]), + ) + + jsonArrayOf( + jsonObjectOf("a" to 1), + true, + jsonObjectOf("b" to 3), + jsonObjectOf("a" to 2), + ).required(jsonPath2) + .shouldBeLeft() + .shouldBeInstanceOf() + .results + .shouldContainExactly( + JsonNode(jsonObjectOf("a" to 1), JsonPath[0]), + JsonNode(jsonObjectOf("a" to 2), JsonPath[3]), + ) + } + } + } + + context("The getAll function") { + context("applied to a JsonObject") { + should("return a list containing the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonObjectOf("a" to 1, "b" to 2) + .getAll(jsonPath1) shouldBe listOf(1) + + jsonObjectOf("a" to "string") + .getAll(jsonPath1) shouldBe listOf("string") + + jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("b" to true))) + .getAll(jsonPath2) shouldBe listOf(true) + } + + should("return an empty list if there is no result") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonPath1.evaluateOne(jsonObjectOf("b" to 2)).shouldBeRight().shouldBeNone() + + jsonObjectOf("b" to jsonObjectOf("a" to 1)) + .getAll(jsonPath1) shouldBe listOf() + + jsonObjectOf("b" to jsonArrayOf(null, jsonObjectOf("b" to true))) + .getAll(jsonPath2) shouldBe listOf() + + jsonObjectOf("a" to jsonArrayOf(jsonObjectOf("b" to true))) + .getAll(jsonPath2) shouldBe listOf() + + jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("a" to true))) + .getAll(jsonPath2) shouldBe listOf() + } + + should("return all results if there are multiple") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonObjectOf( + "a" to 1, + "b" to jsonObjectOf("a" to 2), + "c" to jsonArrayOf(1, jsonObjectOf("a" to 3)), + ).getAll(jsonPath1) shouldContainExactlyInAnyOrder listOf(1, 2, 3) + + jsonObjectOf("a" to "string", "b" to jsonObjectOf("a" to null)) + .getAll(jsonPath1) shouldContainExactlyInAnyOrder listOf("string", null) + + jsonObjectOf("a" to jsonObjectOf("a" to 1), "b" to jsonObjectOf("a" to 2)) + .getAll(jsonPath2) shouldContainExactlyInAnyOrder + listOf( + jsonObjectOf("a" to 1), + jsonObjectOf("a" to 2), + ) + } + } + + context("applied to a JsonArray") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonArrayOf(1, 2, 3) + .getAll(jsonPath1) shouldBe listOf(1) + + jsonArrayOf("string", null, true) + .getAll(jsonPath1) shouldBe listOf("string") + + jsonArrayOf(null, jsonObjectOf("b" to true)) + .getAll(jsonPath2) shouldBe listOf(true) + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonArrayOf() + .getAll(jsonPath1) shouldBe listOf() + + jsonArrayOf(null, jsonObjectOf("a" to true)) + .getAll(jsonPath2) shouldBe listOf() + + jsonArrayOf(jsonObjectOf("b" to true)) + .getAll(jsonPath2) shouldBe listOf() + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonArrayOf(jsonObjectOf("a" to 2), jsonArrayOf(1, jsonObjectOf("a" to 3))) + .getAll(jsonPath1) shouldContainExactly listOf(2, 3) + + jsonArrayOf( + jsonObjectOf("a" to 1), + true, + jsonObjectOf("b" to 3), + jsonObjectOf("a" to 2), + ).getAll(jsonPath2) shouldContainExactly + listOf( + jsonObjectOf("a" to 1), + jsonObjectOf("a" to 2), + ) + } + } + } + + context("The traceOne function") { + context("applied to a JsonObject") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonObjectOf("a" to 1, "b" to 2) + .traceOne(jsonPath1) + .shouldBeRight() shouldBeSome JsonPath["a"] + + jsonObjectOf("a" to "string") + .traceOne(jsonPath1) + .shouldBeRight() shouldBeSome JsonPath["a"] + + jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("b" to true))) + .traceOne(jsonPath2) + .shouldBeRight() shouldBeSome JsonPath["a"][1]["b"] + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonPath1.evaluateOne(jsonObjectOf("b" to 2)).shouldBeRight().shouldBeNone() + + jsonObjectOf("b" to jsonObjectOf("a" to 1)) + .traceOne(jsonPath1) + .shouldBeRight() + .shouldBeNone() + + jsonObjectOf("b" to jsonArrayOf(null, jsonObjectOf("b" to true))) + .traceOne(jsonPath2) + .shouldBeRight() + .shouldBeNone() + + jsonObjectOf("a" to jsonArrayOf(jsonObjectOf("b" to true))) + .traceOne(jsonPath2) + .shouldBeRight() + .shouldBeNone() + + jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("a" to true))) + .traceOne(jsonPath2) + .shouldBeRight() + .shouldBeNone() + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonObjectOf( + "a" to 1, + "b" to jsonObjectOf("a" to 2), + "c" to jsonArrayOf(1, jsonObjectOf("a" to 3)), + ).traceOne(jsonPath1) + .shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(1, JsonPath["a"]), + JsonNode(2, JsonPath["b"]["a"]), + JsonNode(3, JsonPath["c"][1]["a"]), + ) + + jsonObjectOf("a" to "string", "b" to jsonObjectOf("a" to null)) + .traceOne(jsonPath1) + .shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode("string", JsonPath["a"]), + JsonNode(null, JsonPath["b"]["a"]), + ) + + jsonObjectOf("a" to jsonObjectOf("a" to 1), "b" to jsonObjectOf("a" to 2)) + .traceOne(jsonPath2) + .shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(jsonObjectOf("a" to 1), JsonPath["a"]), + JsonNode(jsonObjectOf("a" to 2), JsonPath["b"]), + ) + } + } + + context("applied to a JsonArray") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonArrayOf(1, 2, 3) + .traceOne(jsonPath1) + .shouldBeRight() shouldBeSome JsonPath[0] + + jsonArrayOf("string", null, true) + .traceOne(jsonPath1) + .shouldBeRight() shouldBeSome JsonPath[0] + + jsonArrayOf(null, jsonObjectOf("b" to true)) + .traceOne(jsonPath2) + .shouldBeRight() shouldBeSome JsonPath[1]["b"] + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonArrayOf() + .traceOne(jsonPath1) + .shouldBeRight() + .shouldBeNone() + + jsonArrayOf(null, jsonObjectOf("a" to true)) + .traceOne(jsonPath2) + .shouldBeRight() + .shouldBeNone() + + jsonArrayOf(jsonObjectOf("b" to true)) + .traceOne(jsonPath2) + .shouldBeRight() + .shouldBeNone() + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonArrayOf(jsonObjectOf("a" to 2), jsonArrayOf(1, jsonObjectOf("a" to 3))) + .traceOne(jsonPath1) + .shouldBeLeft() + .results + .shouldContainExactly( + JsonNode(2, JsonPath[0]["a"]), + JsonNode(3, JsonPath[1][1]["a"]), + ) + + jsonArrayOf( + jsonObjectOf("a" to 1), + true, + jsonObjectOf("b" to 3), + jsonObjectOf("a" to 2), + ).traceOne(jsonPath2) + .shouldBeLeft() + .results + .shouldContainExactly( + JsonNode(jsonObjectOf("a" to 1), JsonPath[0]), + JsonNode(jsonObjectOf("a" to 2), JsonPath[3]), + ) + } + } + } + + context("The traceAll function") { + context("applied to a JsonObject") { + should("return a list containing the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonObjectOf("a" to 1, "b" to 2) + .traceAll(jsonPath1) shouldBe listOf(JsonPath["a"]) + + jsonObjectOf("a" to "string") + .traceAll(jsonPath1) shouldBe listOf(JsonPath["a"]) + + jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("b" to true))) + .traceAll(jsonPath2) shouldBe listOf(JsonPath["a"][1]["b"]) + } + + should("return an empty list if there is no result") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonPath1.evaluateOne(jsonObjectOf("b" to 2)).shouldBeRight().shouldBeNone() + + jsonObjectOf("b" to jsonObjectOf("a" to 1)) + .traceAll(jsonPath1) shouldBe listOf() + + jsonObjectOf("b" to jsonArrayOf(null, jsonObjectOf("b" to true))) + .traceAll(jsonPath2) shouldBe listOf() + + jsonObjectOf("a" to jsonArrayOf(jsonObjectOf("b" to true))) + .traceAll(jsonPath2) shouldBe listOf() + + jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("a" to true))) + .traceAll(jsonPath2) shouldBe listOf() + } + + should("return all results if there are multiple") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonObjectOf( + "a" to 1, + "b" to jsonObjectOf("a" to 2), + "c" to jsonArrayOf(1, jsonObjectOf("a" to 3)), + ).traceAll(jsonPath1) shouldContainExactlyInAnyOrder + listOf( + JsonPath["a"], + JsonPath["b"]["a"], + JsonPath["c"][1]["a"], + ) + + jsonObjectOf("a" to "string", "b" to jsonObjectOf("a" to null)) + .traceAll(jsonPath1) shouldContainExactlyInAnyOrder + listOf( + JsonPath["a"], + JsonPath["b"]["a"], + ) + + jsonObjectOf("a" to jsonObjectOf("a" to 1), "b" to jsonObjectOf("a" to 2)) + .traceAll(jsonPath2) shouldContainExactlyInAnyOrder + listOf( + JsonPath["a"], + JsonPath["b"], + ) + } + } + + context("applied to a JsonArray") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonArrayOf(1, 2, 3) + .traceAll(jsonPath1) shouldBe listOf(JsonPath[0]) + + jsonArrayOf("string", null, true) + .traceAll(jsonPath1) shouldBe listOf(JsonPath[0]) + + jsonArrayOf(null, jsonObjectOf("b" to true)) + .traceAll(jsonPath2) shouldBe listOf(JsonPath[1]["b"]) + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonArrayOf() + .traceAll(jsonPath1) shouldBe listOf() + + jsonArrayOf(null, jsonObjectOf("a" to true)) + .traceAll(jsonPath2) shouldBe listOf() + + jsonArrayOf(jsonObjectOf("b" to true)) + .traceAll(jsonPath2) shouldBe listOf() + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonArrayOf(jsonObjectOf("a" to 2), jsonArrayOf(1, jsonObjectOf("a" to 3))) + .traceAll(jsonPath1) shouldContainExactly listOf(JsonPath[0]["a"], JsonPath[1][1]["a"]) + + jsonArrayOf( + jsonObjectOf("a" to 1), + true, + jsonObjectOf("b" to 3), + jsonObjectOf("a" to 2), + ).traceAll(jsonPath2) shouldContainExactly + listOf( + JsonPath[0], + JsonPath[3], + ) + } + } + } + }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScannerTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScannerTest.kt index 627e052..cd38bf7 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScannerTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScannerTest.kt @@ -1,5 +1,6 @@ package com.kobil.vertx.jsonpath.compiler +import arrow.core.right import com.kobil.vertx.jsonpath.testing.nameChar import io.kotest.core.spec.style.ShouldSpec import io.kotest.matchers.shouldBe @@ -9,13 +10,12 @@ import io.kotest.property.arbitrary.az import io.kotest.property.arbitrary.of import io.kotest.property.arbitrary.string import io.kotest.property.checkAll -import kotlinx.coroutines.flow.toList class JsonPathScannerTest : ShouldSpec({ context("When called on an empty string") { should("only return an EOF token") { - "".scanTokens().toList() shouldBe listOf(Token.Eof(1U, 1U)) + "".scanTokens().toList() shouldBe listOf(Token.Eof(1U, 1U).right()) } } @@ -29,10 +29,10 @@ class JsonPathScannerTest : "$.$name".scanTokens().toList() shouldBe listOf( - Token.Dollar(1U, 1U), - Token.Dot(1U, 2U), - Token.Identifier(1U, 3U, name), - Token.Eof(1U, name.length.toUInt() + 3U), + Token.Dollar(1U, 1U).right(), + Token.Dot(1U, 2U).right(), + Token.Identifier(1U, 3U, name).right(), + Token.Eof(1U, name.length.toUInt() + 3U).right(), ) } } @@ -45,10 +45,10 @@ class JsonPathScannerTest : "$.$name".scanTokens().toList() shouldBe listOf( - Token.Dollar(1U, 1U), - Token.Dot(1U, 2U), - Token.Identifier(1U, 3U, name), - Token.Eof(1U, name.length.toUInt() + 3U), + Token.Dollar(1U, 1U).right(), + Token.Dot(1U, 2U).right(), + Token.Identifier(1U, 3U, name).right(), + Token.Eof(1U, name.length.toUInt() + 3U).right(), ) } } @@ -59,10 +59,10 @@ class JsonPathScannerTest : "$.$name".scanTokens().toList() shouldBe listOf( - Token.Dollar(1U, 1U), - Token.Dot(1U, 2U), - Token.Identifier(1U, 3U, name), - Token.Eof(1U, name.length.toUInt() + 3U), + Token.Dollar(1U, 1U).right(), + Token.Dot(1U, 2U).right(), + Token.Identifier(1U, 3U, name).right(), + Token.Eof(1U, name.length.toUInt() + 3U).right(), ) } } @@ -76,10 +76,10 @@ class JsonPathScannerTest : "$.$name".scanTokens().toList() shouldBe listOf( - Token.Dollar(1U, 1U), - Token.Dot(1U, 2U), - Token.Identifier(1U, 3U, name), - Token.Eof(1U, name.length.toUInt() + 3U), + Token.Dollar(1U, 1U).right(), + Token.Dot(1U, 2U).right(), + Token.Identifier(1U, 3U, name).right(), + Token.Eof(1U, name.length.toUInt() + 3U).right(), ) } } @@ -93,10 +93,10 @@ class JsonPathScannerTest : "$.$name".scanTokens().toList() shouldBe listOf( - Token.Dollar(1U, 1U), - Token.Dot(1U, 2U), - Token.Identifier(1U, 3U, name), - Token.Eof(1U, name.length.toUInt() + 3U), + Token.Dollar(1U, 1U).right(), + Token.Dot(1U, 2U).right(), + Token.Identifier(1U, 3U, name).right(), + Token.Eof(1U, name.length.toUInt() + 3U).right(), ) } } diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathErrorTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathErrorTest.kt index 5154093..6109df0 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathErrorTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathErrorTest.kt @@ -70,6 +70,15 @@ class JsonPathErrorTest : } } + context("The 'PrematureEof' error") { + should("produce the correct message from toString") { + checkAll { expected, line, col -> + JsonPathError.PrematureEof(expected, line, col).toString() shouldBe + "Error at [$line:$col]: Premature end of input, expected $expected" + } + } + } + context("The 'IllegalCharacter' error") { should("produce the correct message from toString") { checkAll { ch, line, col, reason -> @@ -88,6 +97,15 @@ class JsonPathErrorTest : } } + context("The 'IntOutOfBounds' error") { + should("produce the correct message from toString") { + checkAll { string, line, col -> + JsonPathError.IntOutOfBounds(string, line, col).toString() shouldBe + "Error at [$line:$col]: Invalid integer value (Out of bounds)" + } + } + } + context("The 'UnexpectedToken' error") { should("produce the correct message from toString") { checkAll { token, string -> diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathExceptionTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathExceptionTest.kt deleted file mode 100644 index 35605f9..0000000 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathExceptionTest.kt +++ /dev/null @@ -1,88 +0,0 @@ -package com.kobil.vertx.jsonpath.error - -import com.kobil.vertx.jsonpath.compiler.Token -import io.kotest.core.spec.style.ShouldSpec -import io.kotest.matchers.collections.shouldBeEmpty -import io.kotest.matchers.throwable.shouldHaveCause -import io.kotest.matchers.throwable.shouldHaveMessage -import io.kotest.matchers.throwable.shouldNotHaveCause -import io.kotest.matchers.types.shouldBeSameInstanceAs - -class JsonPathExceptionTest : - ShouldSpec({ - context("The constructor of JsonPathException") { - context("called on an instance of UnexpectedError") { - should("use the cause of the UnexpectedError as cause") { - checkUnexpectedErrorCause(IllegalArgumentException("a")) - checkUnexpectedErrorCause(IllegalStateException("a")) - checkUnexpectedErrorCause(NullPointerException("a")) - } - - should("have a message of 'Unexpected error: '") { - checkUnexpectedErrorMessage(IllegalArgumentException("a")) - checkUnexpectedErrorMessage(IllegalStateException("a")) - checkUnexpectedErrorMessage(NullPointerException("a")) - } - - should("have no stack trace") { - checkNoStackTrace(JsonPathError.UnexpectedError(IllegalArgumentException("a"))) - checkNoStackTrace(JsonPathError.UnexpectedError(IllegalStateException("a"))) - checkNoStackTrace(JsonPathError.UnexpectedError(NullPointerException("a"))) - } - } - - context("called on any instance of JsonPathError that is no UnexpectedError") { - should("have no cause") { - checkErrorNoCause(JsonPathError.IllegalCharacter('a', 1U, 1U, "something")) - checkErrorNoCause(JsonPathError.UnterminatedString(1U, 1U, 1U, 1U)) - checkErrorNoCause(JsonPathError.UnexpectedToken(Token.QuestionMark(1U, 1U), "something")) - checkErrorNoCause(JsonPathError.IllegalSelector(1U, 1U, "something")) - checkErrorNoCause(JsonPathError.UnknownFunction("something", 1U, 1U)) - checkErrorNoCause(JsonPathError.MustBeSingularQuery(1U, 1U)) - checkErrorNoCause(JsonPathError.InvalidEscapeSequence("abc", 1U, 1U, 1U, "something")) - } - - should("have a message of error.toString") { - checkErrorMessage(JsonPathError.IllegalCharacter('a', 1U, 1U, "something")) - checkErrorMessage(JsonPathError.UnterminatedString(1U, 1U, 1U, 1U)) - checkErrorMessage(JsonPathError.UnexpectedToken(Token.QuestionMark(1U, 1U), "something")) - checkErrorMessage(JsonPathError.IllegalSelector(1U, 1U, "something")) - checkErrorMessage(JsonPathError.UnknownFunction("something", 1U, 1U)) - checkErrorMessage(JsonPathError.MustBeSingularQuery(1U, 1U)) - checkErrorMessage(JsonPathError.InvalidEscapeSequence("abc", 1U, 1U, 1U, "something")) - } - - should("have no stack trace") { - checkNoStackTrace(JsonPathError.IllegalCharacter('a', 1U, 1U, "something")) - checkNoStackTrace(JsonPathError.UnterminatedString(1U, 1U, 1U, 1U)) - checkNoStackTrace(JsonPathError.UnexpectedToken(Token.QuestionMark(1U, 1U), "something")) - checkNoStackTrace(JsonPathError.IllegalSelector(1U, 1U, "something")) - checkNoStackTrace(JsonPathError.UnknownFunction("something", 1U, 1U)) - checkNoStackTrace(JsonPathError.MustBeSingularQuery(1U, 1U)) - checkNoStackTrace(JsonPathError.InvalidEscapeSequence("abc", 1U, 1U, 1U, "something")) - } - } - } - }) - -private fun checkUnexpectedErrorCause(t: Throwable) { - val e = JsonPathException(JsonPathError.UnexpectedError(t)) - e.shouldHaveCause { it shouldBeSameInstanceAs t } -} - -private fun checkUnexpectedErrorMessage(t: Throwable) { - val e = JsonPathException(JsonPathError.UnexpectedError(t)) - e shouldHaveMessage "Unexpected error: $t" -} - -private fun checkErrorNoCause(e: JsonPathError) { - JsonPathException(e).shouldNotHaveCause() -} - -private fun checkErrorMessage(e: JsonPathError) { - JsonPathException(e) shouldHaveMessage e.toString() -} - -private fun checkNoStackTrace(e: JsonPathError) { - JsonPathException(e).stackTrace.shouldBeEmpty() -} From 236d6cbb6e2df392ede8d18fa5206baff02e2d0b Mon Sep 17 00:00:00 2001 From: Johannes Leupold Date: Tue, 8 Oct 2024 17:22:53 +0200 Subject: [PATCH 5/7] Add APIs to make the library usable in Java and tests --- build.gradle.kts | 13 + gradle.properties | 2 + .../java/com/kobil/vertx/jsonpath/Build.java | 64 ++ .../com/kobil/vertx/jsonpath/Compile.java | 75 ++ .../vertx/jsonpath/ComparableExpression.kt | 69 ++ .../com/kobil/vertx/jsonpath/Expression.kt | 105 --- .../kobil/vertx/jsonpath/FilterExpression.kt | 171 +++++ .../vertx/jsonpath/FunctionExpression.kt | 21 + .../com/kobil/vertx/jsonpath/JsonNode.kt | 3 +- .../com/kobil/vertx/jsonpath/JsonPath.kt | 55 +- .../com/kobil/vertx/jsonpath/JsonPathQuery.kt | 48 ++ .../vertx/jsonpath/NodeListExpression.kt | 5 + .../kobil/vertx/jsonpath/QueryExpression.kt | 64 ++ .../com/kobil/vertx/jsonpath/Segment.kt | 32 + .../com/kobil/vertx/jsonpath/Selector.kt | 48 +- .../kotlin/com/kobil/vertx/jsonpath/Vertx.kt | 9 +- .../vertx/jsonpath/compiler/JsonPathParser.kt | 58 +- .../interpreter/ComparableExpressions.kt | 6 +- .../jsonpath/interpreter/FilterExpressions.kt | 28 +- .../vertx/jsonpath/interpreter/Selectors.kt | 5 +- .../JavaComparableExpressionTest.java | 79 ++ .../jsonpath/JavaFilterExpressionTest.java | 39 + .../vertx/jsonpath/JavaJsonNodeTest.java | 32 + .../vertx/jsonpath/JavaJsonPathTest.java | 46 ++ .../jsonpath/JavaQueryExpressionTest.java | 161 ++++ .../kobil/vertx/jsonpath/JavaSegmentTest.java | 101 +++ .../vertx/jsonpath/JavaSelectorTest.java | 85 +++ .../jsonpath/ComparableExpressionTest.kt | 150 ++++ .../vertx/jsonpath/FilterExpressionTest.kt | 675 +++++++++++++++-- .../vertx/jsonpath/FunctionExpressionTest.kt | 37 + .../kobil/vertx/jsonpath/JsonPathQueryTest.kt | 351 +++++++++ .../com/kobil/vertx/jsonpath/JsonPathTest.kt | 708 +++++++++++++++--- .../vertx/jsonpath/QueryExpressionTest.kt | 219 ++++++ .../com/kobil/vertx/jsonpath/SegmentTest.kt | 130 ++++ .../com/kobil/vertx/jsonpath/SelectorTest.kt | 218 ++++++ .../com/kobil/vertx/jsonpath/testing/Gen.kt | 34 +- 36 files changed, 3600 insertions(+), 346 deletions(-) create mode 100644 src/main/java/com/kobil/vertx/jsonpath/Build.java create mode 100644 src/main/java/com/kobil/vertx/jsonpath/Compile.java create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/ComparableExpression.kt delete mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/FilterExpression.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/FunctionExpression.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/JsonPathQuery.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/NodeListExpression.kt create mode 100644 src/main/kotlin/com/kobil/vertx/jsonpath/QueryExpression.kt create mode 100644 src/test/java/com/kobil/vertx/jsonpath/JavaComparableExpressionTest.java create mode 100644 src/test/java/com/kobil/vertx/jsonpath/JavaFilterExpressionTest.java create mode 100644 src/test/java/com/kobil/vertx/jsonpath/JavaJsonNodeTest.java create mode 100644 src/test/java/com/kobil/vertx/jsonpath/JavaJsonPathTest.java create mode 100644 src/test/java/com/kobil/vertx/jsonpath/JavaQueryExpressionTest.java create mode 100644 src/test/java/com/kobil/vertx/jsonpath/JavaSegmentTest.java create mode 100644 src/test/java/com/kobil/vertx/jsonpath/JavaSelectorTest.java create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/ComparableExpressionTest.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/FunctionExpressionTest.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathQueryTest.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/QueryExpressionTest.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/SegmentTest.kt create mode 100644 src/test/kotlin/com/kobil/vertx/jsonpath/SelectorTest.kt diff --git a/build.gradle.kts b/build.gradle.kts index 0141776..9d9cb3b 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -19,6 +19,7 @@ val caffeineVersion: String by project val kotlinCoroutinesVersion: String by project val vertxVersion: String by project +val junitJupiterVersion: String by project val kotestVersion: String by project val kotestArrowVersion: String by project @@ -41,6 +42,8 @@ dependencies { testImplementation("io.kotest:kotest-assertions-core") testImplementation("io.kotest:kotest-property") testImplementation("io.kotest.extensions:kotest-assertions-arrow:$kotestArrowVersion") + + testImplementation("org.junit.jupiter:junit-jupiter:$junitJupiterVersion") } tasks.test { @@ -56,3 +59,13 @@ kotlin { ktlint { version.set("1.3.1") } + +kover { + reports { + filters { + excludes { + classes("com.kobil.vertx.jsonpath.Build", "com.kobil.vertx.jsonpath.Compile") + } + } + } +} diff --git a/gradle.properties b/gradle.properties index 391c5c6..3a06f9c 100644 --- a/gradle.properties +++ b/gradle.properties @@ -7,6 +7,8 @@ kotlinCoroutinesVersion=1.8.1 vertxVersion=4.5.9 # Test Dependencies +junitJupiterVersion=5.11.2 + kotestVersion=5.9.1 kotestArrowVersion=1.4.0 diff --git a/src/main/java/com/kobil/vertx/jsonpath/Build.java b/src/main/java/com/kobil/vertx/jsonpath/Build.java new file mode 100644 index 0000000..27b1c97 --- /dev/null +++ b/src/main/java/com/kobil/vertx/jsonpath/Build.java @@ -0,0 +1,64 @@ +package com.kobil.vertx.jsonpath; + +import io.vertx.core.json.JsonArray; +import io.vertx.core.json.JsonObject; + +public class Build { + public static void main(String[] args) { +// var jp = "$.a[1].b[1:3,4:-1:2]"; + + var compiled = JsonPath.ROOT + .field("a") + .index(1) + .field("b") + .selectChildren(Selector.slice(1, 3), Selector.slice(4, -1, 2)); + + System.out.println(compiled); + System.out.println(compiled.field("c")); + + var json = new JsonObject(); + var a = new JsonArray(); + var second = new JsonObject(); + var b = new JsonArray(); + + json.put("a", a); + + a.add(1); + a.add(second); + + second.put("b", b); + + for (int i = 0; i < 12; ++i) { + b.add(i); + } + + System.out.println(compiled.evaluate(json)); + + System.out.println(compiled.getOne(json)); + System.out.println(compiled.requireOne(json)); + System.out.println(compiled.getAll(json)); + System.out.println(compiled.traceOne(json)); + System.out.println(compiled.traceAll(json)); + + var jp2 = JsonPath.ROOT.field("a"); + System.out.println(jp2.getOne(json)); + System.out.println(jp2.getOne(a)); + System.out.println(jp2.requireOne(json)); + System.out.println(jp2.requireOne(a)); + System.out.println(jp2.getAll(json)); + System.out.println(jp2.getAll(a)); + System.out.println(jp2.traceOne(json)); + System.out.println(jp2.traceOne(a)); + System.out.println(jp2.traceAll(json)); + System.out.println(jp2.traceAll(a)); + +// var expr = "@.a"; + var filter = QueryExpression.relative().field("a").exists(); + System.out.println(filter); + + System.out.println(filter.test(json)); + System.out.println(filter.test(a)); + System.out.println(filter.test(second)); + System.out.println(filter.test(b)); + } +} diff --git a/src/main/java/com/kobil/vertx/jsonpath/Compile.java b/src/main/java/com/kobil/vertx/jsonpath/Compile.java new file mode 100644 index 0000000..9828922 --- /dev/null +++ b/src/main/java/com/kobil/vertx/jsonpath/Compile.java @@ -0,0 +1,75 @@ +package com.kobil.vertx.jsonpath; + +import arrow.core.Either; +import com.kobil.vertx.jsonpath.error.JsonPathError; +import io.vertx.core.json.JsonArray; +import io.vertx.core.json.JsonObject; + +public class Compile { + private static JsonPath unwrap(Either result) { + return result.fold( + err -> { + throw new IllegalStateException(err.toString()); + }, + r -> r + ); + } + + public static void main(String[] args) { + var jp = "$.a[1].b[1:3,4:-1:2]"; + + var compiled = unwrap(JsonPath.compile(jp)); + + System.out.println(compiled); + System.out.println(compiled.field("c")); + + var json = new JsonObject(); + var a = new JsonArray(); + var second = new JsonObject(); + var b = new JsonArray(); + + json.put("a", a); + + a.add(1); + a.add(second); + + second.put("b", b); + + for (int i = 0; i < 12; ++i) { + b.add(i); + } + + System.out.println(compiled.evaluate(json)); + + System.out.println(compiled.getOne(json)); + System.out.println(compiled.requireOne(json)); + System.out.println(compiled.getAll(json)); + System.out.println(compiled.traceOne(json)); + System.out.println(compiled.traceAll(json)); + + var jp2 = unwrap(JsonPath.compile("$.a")); + System.out.println(jp2.getOne(json)); + System.out.println(jp2.getOne(a)); + System.out.println(jp2.requireOne(json)); + System.out.println(jp2.requireOne(a)); + System.out.println(jp2.getAll(json)); + System.out.println(jp2.getAll(a)); + System.out.println(jp2.traceOne(json)); + System.out.println(jp2.traceOne(a)); + System.out.println(jp2.traceAll(json)); + System.out.println(jp2.traceAll(a)); + + var expr = "@.a"; + var filter = FilterExpression.compile(expr).fold( + err -> { + throw new IllegalStateException(err.toString()); + }, + result -> result + ); + + System.out.println(filter.test(json)); + System.out.println(filter.test(a)); + System.out.println(filter.test(second)); + System.out.println(filter.test(b)); + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/ComparableExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/ComparableExpression.kt new file mode 100644 index 0000000..6130088 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/ComparableExpression.kt @@ -0,0 +1,69 @@ +package com.kobil.vertx.jsonpath + +sealed interface ComparableExpression { + infix fun eq(other: ComparableExpression): FilterExpression = isEqualTo(other) + + fun isEqualTo(other: ComparableExpression): FilterExpression = + FilterExpression.Comparison.eq(this, other) + + infix fun neq(other: ComparableExpression): FilterExpression = isNotEqualTo(other) + + fun isNotEqualTo(other: ComparableExpression): FilterExpression = + FilterExpression.Comparison.neq(this, other) + + infix fun gt(other: ComparableExpression): FilterExpression = isGreaterThan(other) + + fun isGreaterThan(other: ComparableExpression): FilterExpression = + FilterExpression.Comparison.greaterThan(this, other) + + infix fun ge(other: ComparableExpression): FilterExpression = isGreaterOrEqual(other) + + fun isGreaterOrEqual(other: ComparableExpression): FilterExpression = + FilterExpression.Comparison.greaterOrEqual(this, other) + + infix fun lt(other: ComparableExpression): FilterExpression = isLessThan(other) + + fun isLessThan(other: ComparableExpression): FilterExpression = + FilterExpression.Comparison.lessThan(this, other) + + infix fun le(other: ComparableExpression): FilterExpression = isLessOrEqual(other) + + fun isLessOrEqual(other: ComparableExpression): FilterExpression = + FilterExpression.Comparison.lessOrEqual(this, other) + + fun length(): ComparableExpression = FunctionExpression.Length(this) + + fun match(pattern: ComparableExpression): FilterExpression = + FilterExpression.Match(this, pattern, true) + + fun search(pattern: ComparableExpression): FilterExpression = + FilterExpression.Match(this, pattern, false) + + data class Literal( + val value: Any?, + ) : ComparableExpression { + override fun toString(): String = + when (value) { + null -> "null" + is String -> "\"$value\"" + else -> value.toString() + } + } + + companion object { + @JvmStatic + fun literal(value: Int): Literal = Literal(value) + + @JvmStatic + fun literal(value: Double): Literal = Literal(value) + + @JvmStatic + fun literal(value: String): Literal = Literal(value) + + @JvmStatic + fun literal(value: Boolean): Literal = Literal(value) + + @JvmStatic + fun literalNull(): Literal = Literal(null) + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt deleted file mode 100644 index 26483b7..0000000 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Expression.kt +++ /dev/null @@ -1,105 +0,0 @@ -package com.kobil.vertx.jsonpath - -import arrow.core.Either -import arrow.core.NonEmptyList -import com.kobil.vertx.jsonpath.JsonNode.Companion.rootNode -import com.kobil.vertx.jsonpath.compiler.JsonPathCompiler.compileJsonPathFilter -import com.kobil.vertx.jsonpath.compiler.Token -import com.kobil.vertx.jsonpath.error.JsonPathError -import com.kobil.vertx.jsonpath.interpreter.match -import io.vertx.core.json.JsonArray -import io.vertx.core.json.JsonObject - -sealed interface FilterExpression { - fun match(obj: JsonObject): Boolean = match(obj.rootNode) - - fun match(arr: JsonArray): Boolean = match(arr.rootNode) - - data class And( - val operands: NonEmptyList, - ) : FilterExpression - - data class Or( - val operands: NonEmptyList, - ) : FilterExpression - - data class Not( - val operand: FilterExpression, - ) : FilterExpression - - data class Comparison( - val op: Op, - val lhs: ComparableExpression, - val rhs: ComparableExpression, - ) : FilterExpression { - enum class Op { - EQ, - NOT_EQ, - LESS, - LESS_EQ, - GREATER, - GREATER_EQ, - } - } - - data class Existence( - val query: NodeListExpression, - ) : FilterExpression - - data class Match( - val subject: ComparableExpression, - val pattern: ComparableExpression, - val matchEntire: Boolean, - val token: Token? = null, - ) : FilterExpression - - companion object { - fun compile(filterExpression: String): Either = - compileJsonPathFilter(filterExpression) - } -} - -sealed interface ComparableExpression { - data class Literal( - val value: Any?, - val token: Token? = null, - ) : ComparableExpression -} - -sealed interface NodeListExpression : ComparableExpression - -sealed interface FunctionExpression : ComparableExpression { - val token: Token? - - data class Length( - val arg: ComparableExpression, - override val token: Token? = null, - ) : FunctionExpression - - data class Count( - val arg: QueryExpression, - override val token: Token? = null, - ) : FunctionExpression - - data class Value( - val arg: QueryExpression, - override val token: Token? = null, - ) : FunctionExpression -} - -sealed interface QueryExpression : NodeListExpression { - val token: Token? - val segments: List - val isSingular: Boolean - get() = segments.all { it.isSingular } - - data class Relative( - override val segments: List = listOf(), - override val token: Token? = null, - ) : QueryExpression - - data class Absolute( - override val segments: List = listOf(), - override val token: Token? = null, - ) : QueryExpression -} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/FilterExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/FilterExpression.kt new file mode 100644 index 0000000..3735f80 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/FilterExpression.kt @@ -0,0 +1,171 @@ +package com.kobil.vertx.jsonpath + +import arrow.core.Either +import arrow.core.NonEmptyList +import arrow.core.nonEmptyListOf +import com.kobil.vertx.jsonpath.JsonNode.Companion.rootNode +import com.kobil.vertx.jsonpath.compiler.JsonPathCompiler +import com.kobil.vertx.jsonpath.error.JsonPathError +import com.kobil.vertx.jsonpath.interpreter.test +import io.vertx.core.json.JsonArray +import io.vertx.core.json.JsonObject + +sealed interface FilterExpression { + fun test(obj: JsonObject): Boolean = test(obj.rootNode) + + fun test(arr: JsonArray): Boolean = test(arr.rootNode) + + infix fun and(other: FilterExpression): FilterExpression = + if (this is And && other is And) { + And(operands + other.operands) + } else if (this is And) { + And(operands + other) + } else if (other is And) { + And(NonEmptyList(this, other.operands.toList())) + } else { + And(nonEmptyListOf(this, other)) + } + + infix fun or(other: FilterExpression): FilterExpression = + if (this is Or && other is Or) { + Or(operands + other.operands) + } else if (this is Or) { + Or(operands + other) + } else if (other is Or) { + Or(NonEmptyList(this, other.operands.toList())) + } else { + Or(nonEmptyListOf(this, other)) + } + + operator fun not(): FilterExpression = + when (this) { + is Not -> operand + is Comparison -> copy(op = op.inverse) + else -> Not(this) + } + + data class And( + val operands: NonEmptyList, + ) : FilterExpression { + constructor(firstOperand: FilterExpression, vararg moreOperands: FilterExpression) : this( + nonEmptyListOf(firstOperand, *moreOperands), + ) + + override fun toString(): String = + operands.joinToString(" && ") { + if (it is Or) { + "($it)" + } else { + "$it" + } + } + } + + data class Or( + val operands: NonEmptyList, + ) : FilterExpression { + constructor(firstOperand: FilterExpression, vararg moreOperands: FilterExpression) : this( + nonEmptyListOf(firstOperand, *moreOperands), + ) + + override fun toString(): String = operands.joinToString(" || ") + } + + data class Not( + val operand: FilterExpression, + ) : FilterExpression { + override fun toString(): String = + if (operand is Comparison || operand is And || operand is Or) { + "!($operand)" + } else { + "!$operand" + } + } + + data class Comparison( + val op: Op, + val lhs: ComparableExpression, + val rhs: ComparableExpression, + ) : FilterExpression { + enum class Op( + val str: String, + ) { + EQ("=="), + NOT_EQ("!="), + LESS("<"), + LESS_EQ("<="), + GREATER(">"), + GREATER_EQ(">="), + ; + + val inverse: Op + get() = + when (this) { + EQ -> NOT_EQ + NOT_EQ -> EQ + LESS -> GREATER_EQ + LESS_EQ -> GREATER + GREATER -> LESS_EQ + GREATER_EQ -> LESS + } + } + + override fun toString(): String = "$lhs ${op.str} $rhs" + + companion object { + fun eq( + lhs: ComparableExpression, + rhs: ComparableExpression, + ): Comparison = Comparison(Op.EQ, lhs, rhs) + + fun neq( + lhs: ComparableExpression, + rhs: ComparableExpression, + ): Comparison = Comparison(Op.NOT_EQ, lhs, rhs) + + fun greaterThan( + lhs: ComparableExpression, + rhs: ComparableExpression, + ): Comparison = Comparison(Op.GREATER, lhs, rhs) + + fun greaterOrEqual( + lhs: ComparableExpression, + rhs: ComparableExpression, + ): Comparison = Comparison(Op.GREATER_EQ, lhs, rhs) + + fun lessThan( + lhs: ComparableExpression, + rhs: ComparableExpression, + ): Comparison = Comparison(Op.LESS, lhs, rhs) + + fun lessOrEqual( + lhs: ComparableExpression, + rhs: ComparableExpression, + ): Comparison = Comparison(Op.LESS_EQ, lhs, rhs) + } + } + + data class Existence( + val query: NodeListExpression, + ) : FilterExpression { + override fun toString(): String = "$query" + } + + data class Match( + val subject: ComparableExpression, + val pattern: ComparableExpression, + val matchEntire: Boolean, + ) : FilterExpression { + override fun toString(): String { + val name = if (matchEntire) "match" else "search" + + return "$name($subject, $pattern)" + } + } + + companion object { + @JvmStatic + fun compile(filterExpression: String): Either = + JsonPathCompiler.compileJsonPathFilter(filterExpression) + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/FunctionExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/FunctionExpression.kt new file mode 100644 index 0000000..877476d --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/FunctionExpression.kt @@ -0,0 +1,21 @@ +package com.kobil.vertx.jsonpath + +sealed class FunctionExpression : ComparableExpression { + data class Length( + val arg: ComparableExpression, + ) : FunctionExpression() { + override fun toString(): String = "length($arg)" + } + + data class Count( + val arg: QueryExpression<*>, + ) : FunctionExpression() { + override fun toString(): String = "count($arg)" + } + + data class Value( + val arg: QueryExpression<*>, + ) : FunctionExpression() { + override fun toString(): String = "value($arg)" + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonNode.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonNode.kt index f6ad12d..f175e3c 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonNode.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonNode.kt @@ -5,7 +5,8 @@ data class JsonNode( val path: JsonPath, ) { companion object { - fun root(value: Any?): JsonNode = JsonNode(value, JsonPath.root) + @JvmStatic + fun root(value: Any?): JsonNode = JsonNode(value, JsonPath.ROOT) val Any?.rootNode: JsonNode get() = root(this) diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt index c7321f1..dd5f4a0 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt @@ -3,6 +3,7 @@ package com.kobil.vertx.jsonpath import arrow.core.Either import arrow.core.None import arrow.core.Option +import arrow.core.flatMap import arrow.core.left import arrow.core.right import arrow.core.some @@ -10,36 +11,54 @@ import com.kobil.vertx.jsonpath.JsonNode.Companion.rootNode import com.kobil.vertx.jsonpath.compiler.JsonPathCompiler.compileJsonPathQuery import com.kobil.vertx.jsonpath.error.JsonPathError import com.kobil.vertx.jsonpath.error.MultipleResults +import com.kobil.vertx.jsonpath.error.RequiredJsonValueError import com.kobil.vertx.jsonpath.interpreter.evaluate import io.vertx.core.json.impl.JsonUtil data class JsonPath internal constructor( - val segments: List = emptyList(), -) { + override val segments: List = emptyList(), +) : JsonPathQuery { fun evaluate(subject: Any?): List = segments.evaluate(JsonUtil.wrapJsonValue(subject).rootNode) fun evaluateOne(subject: Any?): Either> = evaluate(subject).one() - operator fun get( - selector: Selector, - vararg more: Selector, - ): JsonPath = JsonPath(segments + Segment.ChildSegment(selector, *more)) + @Suppress("UNCHECKED_CAST") + fun getAll(subject: Any?): List = evaluate(subject).onlyValues().map { it as T } - operator fun get( - field: String, - vararg more: String, - ): JsonPath = JsonPath(segments + Segment.ChildSegment(field, *more)) + @Suppress("UNCHECKED_CAST") + fun getOne(subject: Any?): Either> = + evaluateOne(subject).map { maybeValue -> + maybeValue.map { it.value as T } + } - operator fun get( - index: Int, - vararg more: Int, - ): JsonPath = JsonPath(segments + Segment.ChildSegment(index, *more)) + @Suppress("UNCHECKED_CAST") + fun requireOne(subject: Any?): Either = + evaluateOne(subject).flatMap { maybeValue -> + maybeValue.fold( + { RequiredJsonValueError.NoResult.left() }, + { (it.value as T).right() }, + ) + } + + fun traceAll(subject: Any?): List = evaluate(subject).onlyPaths() + + fun traceOne(subject: Any?): Either> = + evaluateOne(subject).map { maybeValue -> maybeValue.map { it.path } } + + override fun plus(segment: Segment): JsonPath = JsonPath(segments + segment) + + override operator fun plus(segments: Iterable): JsonPath = + copy(segments = this.segments + segments) + + override fun toString(): String = segments.joinToString("", prefix = "$") companion object { - val root = JsonPath() + @JvmField + val ROOT = JsonPath() + @JvmStatic fun compile(jsonPath: String): Either = compileJsonPathQuery(jsonPath) fun List.one(): Either> = @@ -56,16 +75,16 @@ data class JsonPath internal constructor( operator fun get( selector: Selector, vararg more: Selector, - ): JsonPath = root.get(selector, *more) + ): JsonPath = ROOT.get(selector, *more) operator fun get( field: String, vararg more: String, - ): JsonPath = root.get(field, *more) + ): JsonPath = ROOT.get(field, *more) operator fun get( index: Int, vararg more: Int, - ): JsonPath = root.get(index, *more) + ): JsonPath = ROOT.get(index, *more) } } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPathQuery.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPathQuery.kt new file mode 100644 index 0000000..bd6d3c3 --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPathQuery.kt @@ -0,0 +1,48 @@ +package com.kobil.vertx.jsonpath + +interface JsonPathQuery> { + val segments: List + + fun selectChildren( + selector: Selector, + vararg more: Selector, + ): T = this + Segment.ChildSegment(selector, *more) + + fun selectDescendants( + selector: Selector, + vararg more: Selector, + ): T = this + Segment.DescendantSegment(selector, *more) + + fun selectAllChildren(): T = selectChildren(Selector.WILDCARD) + + fun selectAllDescendants(): T = selectDescendants(Selector.WILDCARD) + + fun field( + field: String, + vararg more: String, + ): T = this + Segment.ChildSegment(field, *more) + + fun index( + index: Int, + vararg more: Int, + ): T = this + Segment.ChildSegment(index, *more) + + operator fun plus(segment: Segment): T + + operator fun plus(segments: Iterable): T +} + +operator fun > T.get( + selector: Selector, + vararg more: Selector, +): T = selectChildren(selector, *more) + +operator fun > T.get( + field: String, + vararg more: String, +): T = field(field, *more) + +operator fun > T.get( + index: Int, + vararg more: Int, +): T = index(index, *more) diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/NodeListExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/NodeListExpression.kt new file mode 100644 index 0000000..34ab54b --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/NodeListExpression.kt @@ -0,0 +1,5 @@ +package com.kobil.vertx.jsonpath + +sealed interface NodeListExpression : ComparableExpression { + fun exists(): FilterExpression = FilterExpression.Existence(this) +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/QueryExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/QueryExpression.kt new file mode 100644 index 0000000..968d74a --- /dev/null +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/QueryExpression.kt @@ -0,0 +1,64 @@ +package com.kobil.vertx.jsonpath + +sealed class QueryExpression> : + NodeListExpression, + JsonPathQuery { + val isSingular: Boolean + get() = segments.all { it.isSingular } + + fun count(): ComparableExpression = FunctionExpression.Count(this) + + fun value(): ComparableExpression = FunctionExpression.Value(this) + + data class Relative + @JvmOverloads + constructor( + override val segments: List = listOf(), + ) : QueryExpression() { + constructor(firstSegment: Segment, vararg more: Segment) : this(listOf(firstSegment, *more)) + + override operator fun plus(segment: Segment): Relative = copy(segments = segments + segment) + + override operator fun plus(segments: Iterable): Relative = + copy(segments = this.segments + segments) + + override fun toString(): String = segments.joinToString("", prefix = "@") + } + + data class Absolute + @JvmOverloads + constructor( + override val segments: List = listOf(), + ) : QueryExpression() { + constructor(firstSegment: Segment, vararg more: Segment) : this(listOf(firstSegment, *more)) + + override operator fun plus(segment: Segment): Absolute = copy(segments = segments + segment) + + override operator fun plus(segments: Iterable): Absolute = + copy(segments = this.segments + segments) + + override fun toString(): String = segments.joinToString("", prefix = "$") + } + + companion object { + @JvmStatic + @JvmOverloads + fun relative(segments: List = listOf()): Relative = Relative(segments) + + @JvmStatic + fun relative( + firstSegment: Segment, + vararg more: Segment, + ): Relative = Relative(firstSegment, *more) + + @JvmStatic + @JvmOverloads + fun absolute(segments: List = listOf()): Absolute = Absolute(segments) + + @JvmStatic + fun absolute( + firstSegment: Segment, + vararg more: Segment, + ): Absolute = Absolute(firstSegment, *more) + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt index 509c667..ed6a456 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt @@ -7,6 +7,10 @@ sealed interface Segment { data class ChildSegment( override val selectors: List, ) : Segment { + init { + require(selectors.isNotEmpty()) { "A child segment without selectors is not allowed" } + } + constructor(selector: Selector, vararg more: Selector) : this(listOf(selector, *more)) constructor(name: String, vararg more: String) : this( @@ -23,11 +27,17 @@ sealed interface Segment { get() = selectors.size == 1 && (selectors.first() is Selector.Name || selectors.first() is Selector.Index) + + override fun toString(): String = selectors.joinToString(",", prefix = "[", postfix = "]") } data class DescendantSegment( override val selectors: List, ) : Segment { + init { + require(selectors.isNotEmpty()) { "A descendant segment without selectors is not allowed" } + } + constructor(selector: Selector, vararg more: Selector) : this(listOf(selector, *more)) constructor(name: String, vararg more: String) : this( @@ -42,5 +52,27 @@ sealed interface Segment { override val isSingular: Boolean get() = false + + override fun toString(): String = selectors.joinToString(",", prefix = "..[", postfix = "]") + } + + companion object { + @JvmStatic + fun child(selectors: List): Segment = ChildSegment(selectors) + + @JvmStatic + fun child( + selector: Selector, + vararg more: Selector, + ): Segment = ChildSegment(selector, *more) + + @JvmStatic + fun descendant(selectors: List): Segment = DescendantSegment(selectors) + + @JvmStatic + fun descendant( + selector: Selector, + vararg more: Selector, + ): Segment = DescendantSegment(selector, *more) } } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt index 3baeda7..907d99b 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt @@ -3,29 +3,49 @@ package com.kobil.vertx.jsonpath sealed interface Selector { data class Name( val name: String, - ) : Selector + ) : Selector { + override fun toString(): String = "'$name'" + } - data object Wildcard : Selector + data object Wildcard : Selector { + override fun toString(): String = "*" + } data class Index( val index: Int, - ) : Selector + ) : Selector { + override fun toString(): String = "$index" + } data class Slice( val first: Int?, val last: Int?, val step: Int?, - ) : Selector + ) : Selector { + override fun toString(): String = + (first?.toString() ?: "") + ":" + (last?.toString() ?: "") + (step?.let { ":$it" } ?: "") + } data class Filter( val filter: FilterExpression, - ) : Selector + ) : Selector { + override fun toString(): String = "?$filter" + } companion object { + @JvmField + val WILDCARD: Selector = Wildcard + operator fun invoke(name: String): Selector = Name(name) + @JvmStatic + fun name(name: String): Selector = Selector(name) + operator fun invoke(index: Int): Selector = Index(index) + @JvmStatic + fun index(index: Int): Selector = Selector(index) + operator fun invoke(slice: IntProgression): Selector = if (slice.step >= 0) { Slice(slice.first, slice.last + 1, slice.step) @@ -37,12 +57,26 @@ sealed interface Selector { ) } + @JvmStatic + fun slice(slice: IntProgression): Selector = Selector(slice) + operator fun invoke( - first: Int?, + firstInclusive: Int?, + lastExclusive: Int?, + step: Int? = null, + ): Selector = Slice(firstInclusive, lastExclusive, step) + + @JvmStatic + @JvmOverloads + fun slice( + firstInclusive: Int?, lastExclusive: Int?, step: Int? = null, - ): Selector = Slice(first, lastExclusive, step) + ): Selector = Selector(firstInclusive, lastExclusive, step) operator fun invoke(filter: FilterExpression): Selector = Filter(filter) + + @JvmStatic + fun filter(filter: FilterExpression): Selector = Selector(filter) } } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Vertx.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Vertx.kt index 2788b03..69eb603 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Vertx.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Vertx.kt @@ -6,7 +6,6 @@ import arrow.core.flatMap import arrow.core.getOrElse import arrow.core.left import arrow.core.right -import com.kobil.vertx.jsonpath.JsonPath.Companion.onlyPaths import com.kobil.vertx.jsonpath.JsonPath.Companion.onlyValues import com.kobil.vertx.jsonpath.error.MultipleResults import com.kobil.vertx.jsonpath.error.RequiredJsonValueError @@ -46,11 +45,11 @@ inline fun JsonArray.getAll(path: JsonPath): List = path.evaluate(this).onlyValues().map { it as T } fun JsonObject.traceOne(path: JsonPath): Either> = - path.evaluateOne(this).map { node -> node.map(JsonNode::path) } + path.traceOne(this) fun JsonArray.traceOne(path: JsonPath): Either> = - path.evaluateOne(this).map { node -> node.map(JsonNode::path) } + path.traceOne(this) -fun JsonObject.traceAll(path: JsonPath): List = path.evaluate(this).onlyPaths() +fun JsonObject.traceAll(path: JsonPath): List = path.traceAll(this) -fun JsonArray.traceAll(path: JsonPath): List = path.evaluate(this).onlyPaths() +fun JsonArray.traceAll(path: JsonPath): List = path.traceAll(this) diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt index 0d5ee74..f85a417 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt @@ -181,22 +181,23 @@ private fun ParserState.checkInt(number: Token.Integer): Int { return number.value } -private fun ParserState.queryExpr(): QueryExpression = +private fun ParserState.queryExpr(): Pair, Token> = when (val t = advance()) { - is Token.At -> QueryExpression.Relative(segments(), t) - is Token.Dollar -> QueryExpression.Absolute(segments(), t) + is Token.At -> QueryExpression.Relative(segments()) to t + is Token.Dollar -> QueryExpression.Absolute(segments()) to t else -> unexpectedToken(t, "query expression") } private inline fun ParserState.functionExpr( identifier: Token.Identifier, - parse: ParserState.() -> C, - constructor: (C, Token?) -> ComparableExpression, + parse: ParserState.() -> Pair, + constructor: (C) -> ComparableExpression, requireSingular: Boolean = true, ): ComparableExpression { require("${identifier.value} function expression") skipWhiteSpace() - val expr = constructor(parse().also { if (requireSingular) checkSingular(it) }, identifier) + val expr = + constructor(parse().let { if (requireSingular) checkSingular(it) else it.first }) skipWhiteSpace() require("${identifier.value} function expression") @@ -219,21 +220,21 @@ private fun ParserState.functionExpr(identifier: Token.Identifier): ComparableEx else -> raise(JsonPathError.UnknownFunction(name, identifier.line, identifier.column)) } -private fun ParserState.comparable(): ComparableExpression = +private fun ParserState.comparable(): Pair = when (val t = advance()) { - is Token.Integer -> ComparableExpression.Literal(t.value, t) - is Token.Decimal -> ComparableExpression.Literal(t.value, t) - is Token.Str -> ComparableExpression.Literal(unescape(t), t) + is Token.Integer -> ComparableExpression.Literal(t.value) to t + is Token.Decimal -> ComparableExpression.Literal(t.value) to t + is Token.Str -> ComparableExpression.Literal(unescape(t)) to t is Token.Identifier -> when (t.value) { - "true" -> ComparableExpression.Literal(true, t) - "false" -> ComparableExpression.Literal(false, t) - "null" -> ComparableExpression.Literal(null, t) + "true" -> ComparableExpression.Literal(true) + "false" -> ComparableExpression.Literal(false) + "null" -> ComparableExpression.Literal(null) else -> functionExpr(t) - } + } to t - is Token.At -> QueryExpression.Relative(segments(), t) - is Token.Dollar -> QueryExpression.Absolute(segments(), t) + is Token.At -> QueryExpression.Relative(segments()) to t + is Token.Dollar -> QueryExpression.Absolute(segments()) to t else -> unexpectedToken(t, "comparable expression") } @@ -269,7 +270,7 @@ private fun ParserState.matchOrSearchFunction(): FilterExpression { skipWhiteSpace() require("$name function expression") - return FilterExpression.Match(firstArg, secondArg, name == "match", identifier) + return FilterExpression.Match(firstArg, secondArg, name == "match") } private fun ParserState.basicLogicalExpr(): FilterExpression { @@ -283,18 +284,18 @@ private fun ParserState.basicLogicalExpr(): FilterExpression { if (matchOrSearch != null) return matchOrSearchFunction() - val lhs = comparable() + val (lhs, lhsToken) = comparable() skipWhiteSpace() val op = takeIf() if (op != null) { skipWhiteSpace() - val rhs = comparable() + val (rhs, rhsToken) = comparable() return FilterExpression.Comparison( op.operator, - checkSingular(lhs), - checkSingular(rhs), + checkSingular(lhs, lhsToken), + checkSingular(rhs, rhsToken), ) } @@ -312,14 +313,19 @@ private fun ParserState.basicLogicalExpr(): FilterExpression { } } -private fun Raise.checkSingular( - expr: ComparableExpression, -): ComparableExpression = +private fun Raise.checkSingular( + expr: Pair, +): C = checkSingular(expr.first, expr.second) + +private fun Raise.checkSingular( + expr: C, + token: Token, +): C = expr.apply { - if (this is QueryExpression && + if (this is QueryExpression<*> && !isSingular ) { - raise(JsonPathError.MustBeSingularQuery(token!!.line, token!!.column)) + raise(JsonPathError.MustBeSingularQuery(token.line, token.column)) } } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/ComparableExpressions.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/ComparableExpressions.kt index c71a316..7b19a05 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/ComparableExpressions.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/ComparableExpressions.kt @@ -21,7 +21,7 @@ internal fun ComparableExpression.evaluate( is FunctionExpression.Length -> evaluate(input, root) is FunctionExpression.Count -> evaluate(input, root) is FunctionExpression.Value -> evaluate(input, root) - is QueryExpression -> evaluate(input, root).takeIfSingular() + is QueryExpression<*> -> evaluate(input, root).takeIfSingular() } internal fun FunctionExpression.Length.evaluate( @@ -56,10 +56,10 @@ internal fun NodeListExpression.evaluate( root: JsonNode, ): List = when (this) { - is QueryExpression -> evaluate(input, root) + is QueryExpression<*> -> evaluate(input, root) } -internal fun QueryExpression.evaluate( +internal fun QueryExpression<*>.evaluate( input: JsonNode, root: JsonNode, ): List = diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt index ed3f67b..6ff05b6 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt @@ -13,36 +13,36 @@ import io.vertx.core.json.JsonObject import io.vertx.kotlin.core.json.get import java.util.regex.PatternSyntaxException -fun FilterExpression.match( +fun FilterExpression.test( input: JsonNode, root: JsonNode = input, ): Boolean = when (this) { - is FilterExpression.And -> match(input, root) - is FilterExpression.Or -> match(input, root) - is FilterExpression.Not -> !operand.match(input, root) - is FilterExpression.Comparison -> match(input, root) - is FilterExpression.Existence -> match(input, root) - is FilterExpression.Match -> match(input, root) + is FilterExpression.And -> this@test.test(input, root) + is FilterExpression.Or -> this@test.test(input, root) + is FilterExpression.Not -> !operand.test(input, root) + is FilterExpression.Comparison -> this@test.test(input, root) + is FilterExpression.Existence -> this@test.test(input, root) + is FilterExpression.Match -> this@test.test(input, root) } -internal fun FilterExpression.And.match( +internal fun FilterExpression.And.test( input: JsonNode, root: JsonNode, ): Boolean = operands.fold(true) { acc, operand -> - acc && operand.match(input, root) + acc && operand.test(input, root) } -internal fun FilterExpression.Or.match( +internal fun FilterExpression.Or.test( input: JsonNode, root: JsonNode, ): Boolean = operands.fold(false) { acc, operand -> - acc || operand.match(input, root) + acc || operand.test(input, root) } -internal fun FilterExpression.Comparison.match( +internal fun FilterExpression.Comparison.test( input: JsonNode, root: JsonNode, ): Boolean { @@ -59,14 +59,14 @@ internal fun FilterExpression.Comparison.match( } } -internal fun FilterExpression.Existence.match( +internal fun FilterExpression.Existence.test( input: JsonNode, root: JsonNode, ): Boolean = query.evaluate(input, root).isNotEmpty() private val unescapedDot = """(?(\\\\)*)\.(?![^]\n\r]*])""".toRegex() -internal fun FilterExpression.Match.match( +internal fun FilterExpression.Match.test( input: JsonNode, root: JsonNode, ): Boolean { diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt index f3ccc32..138d7bc 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt @@ -2,6 +2,7 @@ package com.kobil.vertx.jsonpath.interpreter import com.kobil.vertx.jsonpath.JsonNode import com.kobil.vertx.jsonpath.Selector +import com.kobil.vertx.jsonpath.get import io.vertx.core.json.JsonArray import io.vertx.core.json.JsonObject @@ -84,14 +85,14 @@ internal fun Selector.Filter.select( value .asSequence() .map { (key, field) -> input.child(key, field) } - .filter { node -> filter.match(node, root) } + .filter { node -> filter.test(node, root) } .toList() is JsonArray -> value .asSequence() .mapIndexed { idx, item -> input.child(idx, item) } - .filter { node -> filter.match(node, root) } + .filter { node -> filter.test(node, root) } .toList() else -> emptyList() diff --git a/src/test/java/com/kobil/vertx/jsonpath/JavaComparableExpressionTest.java b/src/test/java/com/kobil/vertx/jsonpath/JavaComparableExpressionTest.java new file mode 100644 index 0000000..9962024 --- /dev/null +++ b/src/test/java/com/kobil/vertx/jsonpath/JavaComparableExpressionTest.java @@ -0,0 +1,79 @@ +package com.kobil.vertx.jsonpath; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class JavaComparableExpressionTest { + @Test + @DisplayName("The literalNull static function should return a Literal with null value") + public void literalNull() { + assertEquals( + new ComparableExpression.Literal(null), + ComparableExpression.literalNull() + ); + } + + @Nested + @DisplayName("The literal static function") + public class Literal { + @Test + @DisplayName("applied to an integer should return a Literal with the same value") + public void integer() { + assertEquals( + new ComparableExpression.Literal(1), + ComparableExpression.literal(1) + ); + + assertEquals( + new ComparableExpression.Literal(123), + ComparableExpression.literal(123) + ); + } + + @Test + @DisplayName("applied to a floating point number should return a Literal with the same value") + public void floatingPoint() { + assertEquals( + new ComparableExpression.Literal(1.5), + ComparableExpression.literal(1.5) + ); + + assertEquals( + new ComparableExpression.Literal(0.123), + ComparableExpression.literal(0.123) + ); + } + + @Test + @DisplayName("applied to a string should return a Literal with the same value") + public void string() { + assertEquals( + new ComparableExpression.Literal("a"), + ComparableExpression.literal("a") + ); + + assertEquals( + new ComparableExpression.Literal("hello world"), + ComparableExpression.literal("hello world") + ); + } + + @Test + @DisplayName("applied to a boolean should return a Literal with the same value") + public void bool() { + assertEquals( + new ComparableExpression.Literal(true), + ComparableExpression.literal(true) + ); + + assertEquals( + new ComparableExpression.Literal(false), + ComparableExpression.literal(false) + ); + } + } + +} diff --git a/src/test/java/com/kobil/vertx/jsonpath/JavaFilterExpressionTest.java b/src/test/java/com/kobil/vertx/jsonpath/JavaFilterExpressionTest.java new file mode 100644 index 0000000..10dff12 --- /dev/null +++ b/src/test/java/com/kobil/vertx/jsonpath/JavaFilterExpressionTest.java @@ -0,0 +1,39 @@ +package com.kobil.vertx.jsonpath; + +import arrow.core.Either; +import com.kobil.vertx.jsonpath.compiler.Token; +import com.kobil.vertx.jsonpath.error.JsonPathError; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; + +public class JavaFilterExpressionTest { + @Test + @DisplayName("A call to the compile static method with a valid filter expression should return a Right containing the compiled filter") + public void success() { + var filterA = assertInstanceOf(Either.Right.class, FilterExpression.compile("@.a")).getValue(); + assertEquals(new FilterExpression.Existence(QueryExpression.relative().field("a")), filterA); + + var filterB = assertInstanceOf(Either.Right.class, FilterExpression.compile("$['b']")).getValue(); + assertEquals(new FilterExpression.Existence(QueryExpression.absolute().field("b")), filterB); + } + + @Test + @DisplayName("A call to the compile static method with an invalid filter string should return a Left") + public void failure() { + assertInstanceOf( + Token.QuestionMark.class, + assertInstanceOf( + JsonPathError.UnexpectedToken.class, + assertInstanceOf(Either.Left.class, FilterExpression.compile("?@.abc")).getValue() + ).getToken() + ); + + assertInstanceOf( + JsonPathError.MustBeSingularQuery.class, + assertInstanceOf(Either.Left.class, FilterExpression.compile("@..a == 2")).getValue() + ); + } +} diff --git a/src/test/java/com/kobil/vertx/jsonpath/JavaJsonNodeTest.java b/src/test/java/com/kobil/vertx/jsonpath/JavaJsonNodeTest.java new file mode 100644 index 0000000..f25d923 --- /dev/null +++ b/src/test/java/com/kobil/vertx/jsonpath/JavaJsonNodeTest.java @@ -0,0 +1,32 @@ +package com.kobil.vertx.jsonpath; + +import io.vertx.core.json.JsonObject; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +public class JavaJsonNodeTest { + @Test + @DisplayName("The root static function should create a JsoNode with the given value and the root path") + public void root() { + Assertions.assertEquals( + new JsonNode("a", JsonPath.ROOT), + JsonNode.root("a") + ); + + Assertions.assertEquals( + new JsonNode(1, JsonPath.ROOT), + JsonNode.root(1) + ); + + Assertions.assertEquals( + new JsonNode(null, JsonPath.ROOT), + JsonNode.root(null) + ); + + Assertions.assertEquals( + new JsonNode(new JsonObject(), JsonPath.ROOT), + JsonNode.root(new JsonObject()) + ); + } +} diff --git a/src/test/java/com/kobil/vertx/jsonpath/JavaJsonPathTest.java b/src/test/java/com/kobil/vertx/jsonpath/JavaJsonPathTest.java new file mode 100644 index 0000000..ff36ab5 --- /dev/null +++ b/src/test/java/com/kobil/vertx/jsonpath/JavaJsonPathTest.java @@ -0,0 +1,46 @@ +package com.kobil.vertx.jsonpath; + +import arrow.core.Either; +import com.kobil.vertx.jsonpath.compiler.Token; +import com.kobil.vertx.jsonpath.error.JsonPathError; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Test; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertInstanceOf; + +public class JavaJsonPathTest { + @Test + @DisplayName("A call to the compile static method with a valid JSON path should return a Right containing the compiled filter") + public void success() { + var jpA = assertInstanceOf(Either.Right.class, JsonPath.compile("$.a")).getValue(); + assertEquals(JsonPath.ROOT.field("a"), jpA); + + var jpB = assertInstanceOf(Either.Right.class, JsonPath.compile("$['b', 1::2, ?@.a][*]")).getValue(); + assertEquals( + JsonPath.ROOT.selectChildren( + Selector.name("b"), + Selector.slice(1, null, 2), + Selector.filter(QueryExpression.relative().field("a").exists()) + ).selectAllChildren(), + jpB + ); + } + + @Test + @DisplayName("A call to the compile static method with an invalid JSON Path string should return a Left") + public void failure() { + assertInstanceOf( + Token.QuestionMark.class, + assertInstanceOf( + JsonPathError.UnexpectedToken.class, + assertInstanceOf(Either.Left.class, JsonPath.compile("?.abc")).getValue() + ).getToken() + ); + + assertInstanceOf( + JsonPathError.MustBeSingularQuery.class, + assertInstanceOf(Either.Left.class, FilterExpression.compile("$[?@..a == 2]")).getValue() + ); + } +} diff --git a/src/test/java/com/kobil/vertx/jsonpath/JavaQueryExpressionTest.java b/src/test/java/com/kobil/vertx/jsonpath/JavaQueryExpressionTest.java new file mode 100644 index 0000000..cfb71c7 --- /dev/null +++ b/src/test/java/com/kobil/vertx/jsonpath/JavaQueryExpressionTest.java @@ -0,0 +1,161 @@ +package com.kobil.vertx.jsonpath; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; + +import java.util.Arrays; +import java.util.Collections; +import java.util.List; + +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class JavaQueryExpressionTest { + @Nested + @DisplayName("The absolute static function") + public class Absolute { + @Test + @DisplayName("called without arguments should return an empty absolute query") + public void noArgs() { + assertEquals( + new QueryExpression.Absolute(Collections.emptyList()), + QueryExpression.absolute() + ); + } + + @Test + @DisplayName("called with a list of segments should return an absolute query using the same segments") + public void list() { + var n = Selector.name("a"); + var i = Selector.index(1); + var s = Selector.slice(1, -1, 2); + var w = Selector.WILDCARD; + var f = Selector.filter(QueryExpression.absolute().exists()); + + var segments1 = List.of(new Segment.ChildSegment(n)); + var segments2 = Arrays.asList(new Segment.ChildSegment(n, i), new Segment.DescendantSegment(f)); + var segments3 = Arrays.asList(new Segment.ChildSegment(w), new Segment.DescendantSegment(s), + new Segment.ChildSegment(i)); + + assertEquals( + new QueryExpression.Absolute(segments1), + QueryExpression.absolute(segments1) + ); + + assertEquals( + new QueryExpression.Absolute(segments2), + QueryExpression.absolute(segments2) + ); + + assertEquals( + new QueryExpression.Absolute(segments3), + QueryExpression.absolute(segments3) + ); + } + + @Test + @DisplayName("called with vararg segments should return an absolute query using the same segments") + public void varargs() { + var n = Selector.name("a"); + var i = Selector.index(1); + var s = Selector.slice(1, -1, 2); + var w = Selector.WILDCARD; + var f = Selector.filter(QueryExpression.absolute().exists()); + + var segments1 = List.of(new Segment.ChildSegment(n)); + var segments2 = Arrays.asList(new Segment.ChildSegment(n, i), new Segment.DescendantSegment(f)); + var segments3 = Arrays.asList(new Segment.ChildSegment(w), new Segment.DescendantSegment(s), + new Segment.ChildSegment(i)); + + assertEquals( + new QueryExpression.Absolute(segments1), + QueryExpression.absolute(new Segment.ChildSegment(n)) + ); + + assertEquals( + new QueryExpression.Absolute(segments2), + QueryExpression.absolute(new Segment.ChildSegment(n, i), new Segment.DescendantSegment(f)) + ); + + assertEquals( + new QueryExpression.Absolute(segments3), + QueryExpression.absolute(new Segment.ChildSegment(w), new Segment.DescendantSegment(s), + new Segment.ChildSegment(i)) + ); + } + } + + @Nested + @DisplayName("The relative static function") + public class Relative { + @Test + @DisplayName("called without arguments should return an empty relative query") + public void noArgs() { + assertEquals( + new QueryExpression.Relative(Collections.emptyList()), + QueryExpression.relative() + ); + } + + @Test + @DisplayName("called with a list of segments should return a relative query using the same segments") + public void list() { + var n = Selector.name("a"); + var i = Selector.index(1); + var s = Selector.slice(1, -1, 2); + var w = Selector.WILDCARD; + var f = Selector.filter(QueryExpression.relative().exists()); + + var segments1 = List.of(new Segment.ChildSegment(n)); + var segments2 = Arrays.asList(new Segment.ChildSegment(n, i), new Segment.DescendantSegment(f)); + var segments3 = Arrays.asList(new Segment.ChildSegment(w), new Segment.DescendantSegment(s), + new Segment.ChildSegment(i)); + + assertEquals( + new QueryExpression.Relative(segments1), + QueryExpression.relative(segments1) + ); + + assertEquals( + new QueryExpression.Relative(segments2), + QueryExpression.relative(segments2) + ); + + assertEquals( + new QueryExpression.Relative(segments3), + QueryExpression.relative(segments3) + ); + } + + @Test + @DisplayName("called with vararg segments should return a relative query using the same segments") + public void varargs() { + var n = Selector.name("a"); + var i = Selector.index(1); + var s = Selector.slice(1, -1, 2); + var w = Selector.WILDCARD; + var f = Selector.filter(QueryExpression.relative().exists()); + + var segments1 = List.of(new Segment.ChildSegment(n)); + var segments2 = Arrays.asList(new Segment.ChildSegment(n, i), new Segment.DescendantSegment(f)); + var segments3 = Arrays.asList(new Segment.ChildSegment(w), new Segment.DescendantSegment(s), + new Segment.ChildSegment(i)); + + assertEquals( + new QueryExpression.Relative(segments1), + QueryExpression.relative(new Segment.ChildSegment(n)) + ); + + assertEquals( + new QueryExpression.Relative(segments2), + QueryExpression.relative(new Segment.ChildSegment(n, i), new Segment.DescendantSegment(f)) + ); + + assertEquals( + new QueryExpression.Relative(segments3), + QueryExpression.relative(new Segment.ChildSegment(w), new Segment.DescendantSegment(s), + new Segment.ChildSegment(i)) + ); + } + } +} diff --git a/src/test/java/com/kobil/vertx/jsonpath/JavaSegmentTest.java b/src/test/java/com/kobil/vertx/jsonpath/JavaSegmentTest.java new file mode 100644 index 0000000..52d780f --- /dev/null +++ b/src/test/java/com/kobil/vertx/jsonpath/JavaSegmentTest.java @@ -0,0 +1,101 @@ +package com.kobil.vertx.jsonpath; + +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; + +import java.util.ArrayList; +import java.util.Arrays; + +import static org.junit.jupiter.api.Assertions.assertEquals; +import static org.junit.jupiter.api.Assertions.assertThrows; + +public class JavaSegmentTest { + @Nested + @DisplayName("The child static method on Segment") + public class Child { + @Test + @DisplayName("should throw when called with an empty list") + public void emptyList() { + assertThrows( + IllegalArgumentException.class, + () -> Segment.child(new ArrayList<>()) + ); + } + + @Test + @DisplayName("should return a child segment with the same selectors when called with a non-empty list") + public void nonEmptyList() { + var sel = new ArrayList(); + sel.add(Selector.name("a")); + sel.add(Selector.index(1)); + sel.add(Selector.slice(1, -1, 2)); + sel.add(Selector.WILDCARD); + sel.add(Selector.filter(QueryExpression.absolute().exists())); + + assertEquals( + new Segment.ChildSegment(sel), + Segment.child(sel) + ); + } + + @Test + @DisplayName("should return a child segment with the same selectors when called with varargs") + public void varargs() { + var n = Selector.name("a"); + var i = Selector.index(1); + var s = Selector.slice(1, -1, 2); + var w = Selector.WILDCARD; + var f = Selector.filter(QueryExpression.absolute().exists()); + + assertEquals( + new Segment.ChildSegment(Arrays.asList(n, i, s, w, f)), + Segment.child(n, i, s, w, f) + ); + } + } + + @Nested + @DisplayName("The descendant static method on Segment") + public class Descendant { + @Test + @DisplayName("should throw when called with an empty list") + public void emptyList() { + assertThrows( + IllegalArgumentException.class, + () -> Segment.descendant(new ArrayList<>()) + ); + } + + @Test + @DisplayName("should return a descendant segment with the same selectors when called with a non-empty list") + public void nonEmptyList() { + var sel = new ArrayList(); + sel.add(Selector.name("a")); + sel.add(Selector.index(1)); + sel.add(Selector.slice(1, -1, 2)); + sel.add(Selector.WILDCARD); + sel.add(Selector.filter(QueryExpression.absolute().exists())); + + assertEquals( + new Segment.DescendantSegment(sel), + Segment.descendant(sel) + ); + } + + @Test + @DisplayName("should return a descendant segment with the same selectors when called with varargs") + public void varargs() { + var n = Selector.name("a"); + var i = Selector.index(1); + var s = Selector.slice(1, -1, 2); + var w = Selector.WILDCARD; + var f = Selector.filter(QueryExpression.absolute().exists()); + + assertEquals( + new Segment.DescendantSegment(Arrays.asList(n, i, s, w, f)), + Segment.descendant(n, i, s, w, f) + ); + } + } +} diff --git a/src/test/java/com/kobil/vertx/jsonpath/JavaSelectorTest.java b/src/test/java/com/kobil/vertx/jsonpath/JavaSelectorTest.java new file mode 100644 index 0000000..4e645cd --- /dev/null +++ b/src/test/java/com/kobil/vertx/jsonpath/JavaSelectorTest.java @@ -0,0 +1,85 @@ +package com.kobil.vertx.jsonpath; + +import com.kobil.vertx.jsonpath.FilterExpression.Comparison; +import com.kobil.vertx.jsonpath.FilterExpression.Existence; +import com.kobil.vertx.jsonpath.FilterExpression.Not; +import com.kobil.vertx.jsonpath.QueryExpression.Relative; +import com.kobil.vertx.jsonpath.Segment.ChildSegment; +import kotlin.ranges.IntProgression; +import kotlin.ranges.IntRange; +import org.junit.jupiter.api.DisplayName; +import org.junit.jupiter.api.Nested; +import org.junit.jupiter.api.Test; + +import static arrow.core.NonEmptyListKt.nonEmptyListOf; +import static org.junit.jupiter.api.Assertions.assertEquals; + +public class JavaSelectorTest { + @Test + @DisplayName("The name static function should return a Name selector with the given field name") + public void name() { + assertEquals(new Selector.Name("a"), Selector.name("a")); + assertEquals(new Selector.Name("hello world"), Selector.name("hello world")); + } + + @Test + @DisplayName("The index static function should return an Index selector with the given index") + public void index() { + assertEquals(new Selector.Index(1), Selector.index(1)); + assertEquals(new Selector.Index(-10), Selector.index(-10)); + } + + @Nested + @DisplayName("The slice static function") + public class Slice { + @Test + @DisplayName("applied to an IntProgression instance should return an equivalent slice selector") + public void progression() { + assertEquals(new Selector.Slice(1, 3, 1), Selector.slice(new IntRange(1, 2))); + assertEquals(new Selector.Slice(1, 5, 1), Selector.slice(new IntRange(1, 4))); + assertEquals(new Selector.Slice(1, 10, 2), Selector.slice(new IntProgression(1, 10, 2))); + assertEquals(new Selector.Slice(10, 0, -1), Selector.slice(new IntProgression(10, 1, -1))); + assertEquals(new Selector.Slice(10, 1, -4), Selector.slice(new IntProgression(10, 1, -4))); + } + + @Test + @DisplayName("applied to two nullable integers should return an equivalent slice selector with unset step") + public void twoInts() { + assertEquals(new Selector.Slice(1, 2, null), Selector.slice(1, 2)); + assertEquals(new Selector.Slice(1, -1, null), Selector.slice(1, -1)); + assertEquals(new Selector.Slice(1, null, null), Selector.slice(1, null)); + assertEquals(new Selector.Slice(null, 2, null), Selector.slice(null, 2)); + assertEquals(new Selector.Slice(null, null, null), Selector.slice(null, null)); + } + + @Test + @DisplayName("applied to three nullable integers should return an equivalent slice selector") + public void threeInts() { + assertEquals(new Selector.Slice(1, 2, 2), Selector.slice(1, 2, 2)); + assertEquals(new Selector.Slice(1, -1, 3), Selector.slice(1, -1, 3)); + assertEquals(new Selector.Slice(1, null, -1), Selector.slice(1, null, -1)); + assertEquals(new Selector.Slice(null, 2, 3), Selector.slice(null, 2, 3)); + assertEquals(new Selector.Slice(null, null, 3), Selector.slice(null, null, 3)); + assertEquals(new Selector.Slice(null, null, null), Selector.slice(null, null, null)); + } + } + + @Test + @DisplayName("The filter static function should return a Filter selector with the given filter expression") + public void filter() { + var expr1 = new Existence(new Relative(new ChildSegment("a"))); + var expr2 = new FilterExpression.Or( + nonEmptyListOf( + new Comparison( + Comparison.Op.GREATER_EQ, + new Relative(new ChildSegment("a")), + new ComparableExpression.Literal(1) + ), + new Not(new Existence(new Relative(new ChildSegment("a")))) + ) + ); + + assertEquals(new Selector.Filter(expr1), Selector.filter(expr1)); + assertEquals(new Selector.Filter(expr2), Selector.filter(expr2)); + } +} diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/ComparableExpressionTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/ComparableExpressionTest.kt new file mode 100644 index 0000000..194ad64 --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/ComparableExpressionTest.kt @@ -0,0 +1,150 @@ +package com.kobil.vertx.jsonpath + +import com.kobil.vertx.jsonpath.FilterExpression.Comparison +import com.kobil.vertx.jsonpath.testing.comparable +import com.kobil.vertx.jsonpath.testing.matchOperand +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.shouldBe +import io.kotest.property.Arb +import io.kotest.property.arbitrary.boolean +import io.kotest.property.arbitrary.choice +import io.kotest.property.arbitrary.constant +import io.kotest.property.arbitrary.double +import io.kotest.property.arbitrary.int +import io.kotest.property.arbitrary.string +import io.kotest.property.checkAll + +class ComparableExpressionTest : + ShouldSpec({ + context("The eq operator") { + should("return a Comparison of both operands using the EQ operator") { + checkAll(Arb.comparable(), Arb.comparable()) { lhs, rhs -> + lhs eq rhs shouldBe Comparison(Comparison.Op.EQ, lhs, rhs) + } + } + } + + context("The neq operator") { + should("return a Comparison of both operands using the NOT_EQ operator") { + checkAll(Arb.comparable(), Arb.comparable()) { lhs, rhs -> + lhs neq rhs shouldBe Comparison(Comparison.Op.NOT_EQ, lhs, rhs) + } + } + } + + context("The gt operator") { + should("return a Comparison of both operands using the GREATER operator") { + checkAll(Arb.comparable(), Arb.comparable()) { lhs, rhs -> + lhs gt rhs shouldBe Comparison(Comparison.Op.GREATER, lhs, rhs) + } + } + } + + context("The ge operator") { + should("return a Comparison of both operands using the GREATER_EQ operator") { + checkAll(Arb.comparable(), Arb.comparable()) { lhs, rhs -> + lhs ge rhs shouldBe Comparison(Comparison.Op.GREATER_EQ, lhs, rhs) + } + } + } + + context("The lt operator") { + should("return a Comparison of both operands using the LESS operator") { + checkAll(Arb.comparable(), Arb.comparable()) { lhs, rhs -> + lhs lt rhs shouldBe Comparison(Comparison.Op.LESS, lhs, rhs) + } + } + } + + context("The le operator") { + should("return a Comparison of both operands using the LESS_EQ operator") { + checkAll(Arb.comparable(), Arb.comparable()) { lhs, rhs -> + lhs le rhs shouldBe Comparison(Comparison.Op.LESS_EQ, lhs, rhs) + } + } + } + + context("The length function") { + should("return a Length instance with the given operand") { + checkAll(Arb.comparable()) { lhs -> + lhs.length() shouldBe FunctionExpression.Length(lhs) + } + } + } + + context("The match function") { + should("return a Match instance with the given subject and pattern and matchEntire = true") { + checkAll(Arb.matchOperand(), Arb.matchOperand()) { subject, pattern -> + subject.match(pattern) shouldBe + FilterExpression.Match(subject, pattern, matchEntire = true) + } + } + } + + context("The search function") { + should("return a Match instance with the given subject and pattern and matchEntire = false") { + checkAll(Arb.matchOperand(), Arb.matchOperand()) { subject, pattern -> + subject.search(pattern) shouldBe + FilterExpression.Match(subject, pattern, matchEntire = false) + } + } + } + + context("The literal static function") { + context("applied to an integer") { + should("return a Literal with the same value") { + checkAll(Arb.int()) { + ComparableExpression.literal(it) shouldBe ComparableExpression.Literal(it) + } + } + } + + context("applied to a floating point number") { + should("return a Literal with the same value") { + checkAll(Arb.double()) { + ComparableExpression.literal(it) shouldBe ComparableExpression.Literal(it) + } + } + } + + context("applied to a string") { + should("return a Literal with the same value") { + checkAll(Arb.string()) { + ComparableExpression.literal(it) shouldBe ComparableExpression.Literal(it) + } + } + } + + context("applied to a boolean") { + should("return a Literal with the same value") { + checkAll(Arb.boolean()) { + ComparableExpression.literal(it) shouldBe ComparableExpression.Literal(it) + } + } + } + } + + context("The literalNull static function") { + should("return a Literal with null value") { + ComparableExpression.literalNull() shouldBe ComparableExpression.Literal(null) + } + } + + context("The toString method") { + context("of a Literal instance") { + should("wrap a string value in double quotes") { + checkAll(Arb.string()) { + ComparableExpression.Literal(it).toString() shouldBe "\"$it\"" + } + } + + should("simply serialize any other value to string") { + checkAll( + Arb.choice(Arb.int(), Arb.double(), Arb.boolean(), Arb.constant(null)), + ) { + ComparableExpression.Literal(it).toString() shouldBe "$it" + } + } + } + } + }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt index 3f7bee7..b6851de 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt @@ -1,14 +1,32 @@ package com.kobil.vertx.jsonpath +import arrow.core.nonEmptyListOf +import com.kobil.vertx.jsonpath.ComparableExpression.Literal +import com.kobil.vertx.jsonpath.FilterExpression.And +import com.kobil.vertx.jsonpath.FilterExpression.Comparison +import com.kobil.vertx.jsonpath.FilterExpression.Comparison.Op +import com.kobil.vertx.jsonpath.FilterExpression.Existence +import com.kobil.vertx.jsonpath.FilterExpression.Match +import com.kobil.vertx.jsonpath.FilterExpression.Not +import com.kobil.vertx.jsonpath.FilterExpression.Or +import com.kobil.vertx.jsonpath.QueryExpression.Absolute +import com.kobil.vertx.jsonpath.QueryExpression.Relative import com.kobil.vertx.jsonpath.compiler.Token import com.kobil.vertx.jsonpath.error.JsonPathError +import com.kobil.vertx.jsonpath.testing.comparable +import com.kobil.vertx.jsonpath.testing.matchOperand +import com.kobil.vertx.jsonpath.testing.queryExpression import io.kotest.assertions.arrow.core.shouldBeLeft import io.kotest.assertions.arrow.core.shouldBeRight import io.kotest.core.spec.style.ShouldSpec import io.kotest.matchers.booleans.shouldBeFalse import io.kotest.matchers.booleans.shouldBeTrue +import io.kotest.matchers.shouldBe +import io.kotest.property.Arb +import io.kotest.property.checkAll import io.vertx.kotlin.core.json.jsonArrayOf import io.vertx.kotlin.core.json.jsonObjectOf +import arrow.core.nonEmptyListOf as nel class FilterExpressionTest : ShouldSpec({ @@ -100,8 +118,6 @@ class FilterExpressionTest : context("Valid filter expressions") { context("using a simple existence check") { - val at = Token.At(1U, 1U) - val hasA = "@.a" val hasB = "@['b']" val has1 = "@[1]" @@ -111,32 +127,32 @@ class FilterExpressionTest : should("compile successfully") { FilterExpression.compile(hasA) shouldBeRight - FilterExpression.Existence( - QueryExpression.Relative(listOf(Segment.ChildSegment("a")), at), + Existence( + Relative(listOf(Segment.ChildSegment("a"))), ) FilterExpression.compile(hasB) shouldBeRight - FilterExpression.Existence( - QueryExpression.Relative(listOf(Segment.ChildSegment("b")), at), + Existence( + Relative(listOf(Segment.ChildSegment("b"))), ) FilterExpression.compile(has1) shouldBeRight - FilterExpression.Existence( - QueryExpression.Relative(listOf(Segment.ChildSegment(1)), at), + Existence( + Relative(listOf(Segment.ChildSegment(1))), ) FilterExpression.compile(hasNestedA) shouldBeRight - FilterExpression.Existence( - QueryExpression.Relative(listOf(Segment.DescendantSegment("a")), at), + Existence( + Relative(listOf(Segment.DescendantSegment("a"))), ) FilterExpression.compile(hasNestedB) shouldBeRight - FilterExpression.Existence( - QueryExpression.Relative(listOf(Segment.DescendantSegment("b")), at), + Existence( + Relative(listOf(Segment.DescendantSegment("b"))), ) FilterExpression.compile(hasNested1) shouldBeRight - FilterExpression.Existence( - QueryExpression.Relative(listOf(Segment.DescendantSegment(1)), at), + Existence( + Relative(listOf(Segment.DescendantSegment(1))), ) } @@ -154,37 +170,37 @@ class FilterExpressionTest : val arr4 = jsonArrayOf(1) FilterExpression.compile(hasA).shouldBeRight().also { - it.match(obj1).shouldBeTrue() - it.match(obj2).shouldBeFalse() - it.match(obj3).shouldBeTrue() - it.match(objANull).shouldBeTrue() - it.match(arr1).shouldBeFalse() - it.match(arr2).shouldBeFalse() - it.match(arr3).shouldBeFalse() - it.match(arr4).shouldBeFalse() + it.test(obj1).shouldBeTrue() + it.test(obj2).shouldBeFalse() + it.test(obj3).shouldBeTrue() + it.test(objANull).shouldBeTrue() + it.test(arr1).shouldBeFalse() + it.test(arr2).shouldBeFalse() + it.test(arr3).shouldBeFalse() + it.test(arr4).shouldBeFalse() } FilterExpression.compile(hasB).shouldBeRight().also { - it.match(obj1).shouldBeFalse() - it.match(obj2).shouldBeTrue() - it.match(obj3).shouldBeTrue() - it.match(objANull).shouldBeFalse() - it.match(arr1).shouldBeFalse() - it.match(arr2).shouldBeFalse() - it.match(arr3).shouldBeFalse() - it.match(arr4).shouldBeFalse() + it.test(obj1).shouldBeFalse() + it.test(obj2).shouldBeTrue() + it.test(obj3).shouldBeTrue() + it.test(objANull).shouldBeFalse() + it.test(arr1).shouldBeFalse() + it.test(arr2).shouldBeFalse() + it.test(arr3).shouldBeFalse() + it.test(arr4).shouldBeFalse() } FilterExpression.compile(has1).shouldBeRight().also { - it.match(obj1).shouldBeFalse() - it.match(obj2).shouldBeFalse() - it.match(obj3).shouldBeFalse() - it.match(objANull).shouldBeFalse() - it.match(objName1).shouldBeFalse() - it.match(arr1).shouldBeFalse() - it.match(arr2).shouldBeTrue() - it.match(arr3).shouldBeTrue() - it.match(arr4).shouldBeFalse() + it.test(obj1).shouldBeFalse() + it.test(obj2).shouldBeFalse() + it.test(obj3).shouldBeFalse() + it.test(objANull).shouldBeFalse() + it.test(objName1).shouldBeFalse() + it.test(arr1).shouldBeFalse() + it.test(arr2).shouldBeTrue() + it.test(arr3).shouldBeTrue() + it.test(arr4).shouldBeFalse() } } } @@ -211,45 +227,566 @@ class FilterExpressionTest : val arr4 = jsonArrayOf(jsonArrayOf("a", "b")) FilterExpression.compile(hasNestedA).shouldBeRight().also { - it.match(obj1).shouldBeTrue() - it.match(obj2).shouldBeTrue() - it.match(obj3).shouldBeTrue() - it.match(obj4).shouldBeTrue() - it.match(obj5).shouldBeTrue() - it.match(obj6).shouldBeFalse() - it.match(arr1).shouldBeFalse() - it.match(arr2).shouldBeTrue() - it.match(arr3).shouldBeFalse() - it.match(arr4).shouldBeFalse() + it.test(obj1).shouldBeTrue() + it.test(obj2).shouldBeTrue() + it.test(obj3).shouldBeTrue() + it.test(obj4).shouldBeTrue() + it.test(obj5).shouldBeTrue() + it.test(obj6).shouldBeFalse() + it.test(arr1).shouldBeFalse() + it.test(arr2).shouldBeTrue() + it.test(arr3).shouldBeFalse() + it.test(arr4).shouldBeFalse() } FilterExpression.compile(hasNestedB).shouldBeRight().also { - it.match(obj1).shouldBeFalse() - it.match(obj2).shouldBeTrue() - it.match(obj3).shouldBeTrue() - it.match(obj4).shouldBeFalse() - it.match(obj5).shouldBeTrue() - it.match(obj6).shouldBeTrue() - it.match(arr1).shouldBeFalse() - it.match(arr2).shouldBeFalse() - it.match(arr3).shouldBeFalse() - it.match(arr4).shouldBeFalse() + it.test(obj1).shouldBeFalse() + it.test(obj2).shouldBeTrue() + it.test(obj3).shouldBeTrue() + it.test(obj4).shouldBeFalse() + it.test(obj5).shouldBeTrue() + it.test(obj6).shouldBeTrue() + it.test(arr1).shouldBeFalse() + it.test(arr2).shouldBeFalse() + it.test(arr3).shouldBeFalse() + it.test(arr4).shouldBeFalse() } FilterExpression.compile(hasNested1).shouldBeRight().also { - it.match(obj1).shouldBeFalse() - it.match(obj2).shouldBeFalse() - it.match(obj3).shouldBeFalse() - it.match(obj4).shouldBeTrue() - it.match(obj5).shouldBeTrue() - it.match(obj6).shouldBeTrue() - it.match(arr1).shouldBeFalse() - it.match(arr2).shouldBeTrue() - it.match(arr3).shouldBeTrue() - it.match(arr4).shouldBeTrue() + it.test(obj1).shouldBeFalse() + it.test(obj2).shouldBeFalse() + it.test(obj3).shouldBeFalse() + it.test(obj4).shouldBeTrue() + it.test(obj5).shouldBeTrue() + it.test(obj6).shouldBeTrue() + it.test(arr1).shouldBeFalse() + it.test(arr2).shouldBeTrue() + it.test(arr3).shouldBeTrue() + it.test(arr4).shouldBeTrue() } } } } } + + context("The and operator") { + context("when applied to two instances of And") { + should("return a single And instance concatenating the operands of both") { + val f1 = + Or( + nel( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ), + ) + + val f2 = Existence(Relative()["b"]) + + val f3 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + val f4 = Not(Existence(Absolute()["d"])) + + val f5 = + Comparison( + Op.GREATER, + Absolute()["e"], + Literal(2), + ) + + And(nel(f1, f2)) and And(nel(f3, f4)) shouldBe And(nel(f1, f2, f3, f4)) + And(nel(f1, f3)) and And(nel(f2, f5, f4)) shouldBe And(nel(f1, f3, f2, f5, f4)) + And(nel(f1, f3)) and And(nel(f2, f3, f5)) shouldBe And(nel(f1, f3, f2, f3, f5)) + } + } + + context("when only the left hand operand is an instance of And") { + should( + "return a single And instance appending the right hand operand to the operands of the left hand And", + ) { + val f1 = + Or( + nel( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ), + ) + + val f2 = Existence(Relative()["b"]) + + val f3 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + val f4 = Not(Existence(Absolute()["d"])) + + val f5 = + Comparison( + Op.GREATER, + Absolute()["e"], + Literal(2), + ) + + And(nel(f1, f2)) and f3 shouldBe And(nel(f1, f2, f3)) + And(nel(f1, f3, f5)) and f4 shouldBe And(nel(f1, f3, f5, f4)) + And(nel(f1, f3, f5, f2)) and f2 and f4 shouldBe And(nel(f1, f3, f5, f2, f2, f4)) + } + } + + context("when only the right hand operand is an instance of And") { + should( + "return a single And instance prepending the left hand operand to the operands of the right hand And", + ) { + val f1 = + Or( + nel( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ), + ) + + val f2 = Existence(Relative()["b"]) + + val f3 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + val f4 = Not(Existence(Absolute()["d"])) + + val f5 = + Comparison( + Op.GREATER, + Absolute()["e"], + Literal(2), + ) + + f3 and And(nel(f1, f2)) shouldBe And(nel(f3, f1, f2)) + f4 and And(nel(f1, f3, f5)) shouldBe And(nel(f4, f1, f3, f5)) + f2 and And(nel(f1, f3, f5, f2)) and f4 shouldBe And(nel(f2, f1, f3, f5, f2, f4)) + } + } + + context("when none of the operands is an instance of And") { + should("return an And instance containing both operands") { + val f1 = + Or( + nel( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ), + ) + + val f2 = Existence(Relative()["b"]) + + val f3 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + f1 and f2 shouldBe And(nonEmptyListOf(f1, f2)) + f1 and f3 shouldBe And(nonEmptyListOf(f1, f3)) + f2 and f3 shouldBe And(nonEmptyListOf(f2, f3)) + f3 and f1 shouldBe And(nonEmptyListOf(f3, f1)) + f3 and f2 and f1 shouldBe And(nonEmptyListOf(f3, f2, f1)) + } + } + } + + context("The or operator") { + context("when applied to two instances of Or") { + should("return a single Or instance concatenating the operands of both") { + val f1 = + And( + nel( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ), + ) + + val f2 = Existence(Relative()["b"]) + + val f3 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + val f4 = Not(Existence(Absolute()["d"])) + + val f5 = + Comparison( + Op.GREATER, + Absolute()["e"], + Literal(2), + ) + + Or(nel(f1, f2)) or Or(nel(f3, f4)) shouldBe Or(nel(f1, f2, f3, f4)) + Or(nel(f1, f3)) or Or(nel(f2, f5, f4)) shouldBe Or(nel(f1, f3, f2, f5, f4)) + Or(nel(f1, f3)) or Or(nel(f2, f3, f5)) shouldBe Or(nel(f1, f3, f2, f3, f5)) + } + } + + context("when only the left hor operand is an instance of Or") { + should( + "return a single Or instance appending the right hor operand to the operands of the left hor Or", + ) { + val f1 = + And( + nel( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ), + ) + + val f2 = Existence(Relative()["b"]) + + val f3 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + val f4 = Not(Existence(Absolute()["d"])) + + val f5 = + Comparison( + Op.GREATER, + Absolute()["e"], + Literal(2), + ) + + Or(nel(f1, f2)) or f3 shouldBe Or(nel(f1, f2, f3)) + Or(nel(f1, f3, f5)) or f4 shouldBe Or(nel(f1, f3, f5, f4)) + Or(nel(f1, f3, f5, f2)) or f2 or f4 shouldBe Or(nel(f1, f3, f5, f2, f2, f4)) + } + } + + context("when only the right hor operand is an instance of Or") { + should( + "return a single Or instance prepending the left hor operand to the operands of the right hor Or", + ) { + val f1 = + And( + nel( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ), + ) + + val f2 = Existence(Relative()["b"]) + + val f3 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + val f4 = Not(Existence(Absolute()["d"])) + + val f5 = + Comparison( + Op.GREATER, + Absolute()["e"], + Literal(2), + ) + + f3 or Or(nel(f1, f2)) shouldBe Or(nel(f3, f1, f2)) + f4 or Or(nel(f1, f3, f5)) shouldBe Or(nel(f4, f1, f3, f5)) + f2 or Or(nel(f1, f3, f5, f2)) or f4 shouldBe Or(nel(f2, f1, f3, f5, f2, f4)) + } + } + + context("when none of the operands is an instance of Or") { + should("return an Or instance containing both operands") { + val f1 = + And( + nel( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ), + ) + + val f2 = Existence(Relative()["b"]) + + val f3 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + f1 or f2 shouldBe Or(nonEmptyListOf(f1, f2)) + f1 or f3 shouldBe Or(nonEmptyListOf(f1, f3)) + f2 or f3 shouldBe Or(nonEmptyListOf(f2, f3)) + f3 or f1 shouldBe Or(nonEmptyListOf(f3, f1)) + f3 or f2 or f1 shouldBe Or(nonEmptyListOf(f3, f2, f1)) + } + } + } + + context("The not operator") { + context("when applied to an instance of Not") { + should("return the operand of Not") { + val f1 = + And( + nel( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ), + ) + + val f2 = Existence(Relative()["b"]) + + val f3 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + !Not(f1) shouldBe f1 + !Not(f2) shouldBe f2 + !Not(f3) shouldBe f3 + } + } + + context("when applied to an instance of Comparison") { + should("invert the comparison operator") { + checkAll(Arb.comparable(), Arb.comparable()) { lhs, rhs -> + !Comparison(Op.EQ, lhs, rhs) shouldBe Comparison(Op.NOT_EQ, lhs, rhs) + !Comparison(Op.NOT_EQ, lhs, rhs) shouldBe Comparison(Op.EQ, lhs, rhs) + !Comparison(Op.LESS, lhs, rhs) shouldBe Comparison(Op.GREATER_EQ, lhs, rhs) + !Comparison(Op.LESS_EQ, lhs, rhs) shouldBe Comparison(Op.GREATER, lhs, rhs) + !Comparison(Op.GREATER, lhs, rhs) shouldBe Comparison(Op.LESS_EQ, lhs, rhs) + !Comparison(Op.GREATER_EQ, lhs, rhs) shouldBe Comparison(Op.LESS, lhs, rhs) + } + } + } + + context("when the operand is not an instance of Not") { + should("return a Not instance of the operand") { + val f1 = + And( + nel( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ), + ) + + val f2 = Existence(Relative()["b"]) + + val f3 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + !f1 shouldBe Not(f1) + !f2 shouldBe Not(f2) + !f3 shouldBe Not(f3) + } + } + } + + context("The toString method") { + context("of an And expression") { + should("concatenate the serialized operands with &&, parenthesizing Or instances") { + val f1 = + Or( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ) + + val f2 = Existence(Relative()["b"]) + + val f3 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + val f4 = Not(Existence(Absolute()["d"])) + + val f5 = + Comparison( + Op.GREATER, + Absolute()["e"], + Literal(2), + ) + + And(f1, f2, f3, f4).toString() shouldBe "($f1) && $f2 && $f3 && $f4" + And(f5, f1, f2).toString() shouldBe "$f5 && ($f1) && $f2" + And(f3, f1).toString() shouldBe "$f3 && ($f1)" + } + } + + context("of an Or expression") { + should("concatenate the serialized operands with ||") { + val f1 = + And( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ) + + val f2 = Existence(Relative()["b"]) + + val f3 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + val f4 = Not(Existence(Absolute()["d"])) + + val f5 = + Comparison( + Op.GREATER, + Absolute()["e"], + Literal(2), + ) + + Or(f1, f2, f3, f4).toString() shouldBe "$f1 || $f2 || $f3 || $f4" + Or(f5, f1, f2).toString() shouldBe "$f5 || $f1 || $f2" + Or(f3, f1).toString() shouldBe "$f3 || $f1" + } + } + + context("of a Not expression") { + should( + "prepend an exclamation mark to the serialized operand, parenthesizing Or, Comparision and And", + ) { + val f1 = + And( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ) + + val f2 = + Or( + Existence(Relative()["a"]), + Comparison( + Op.LESS, + Literal(1), + Literal(2), + ), + ) + + val f3 = Existence(Relative()["b"]) + + val f4 = + Match( + Relative()["c"], + Literal("a.*"), + true, + ) + + val f5 = + Comparison( + Op.GREATER, + Absolute()["e"], + Literal(2), + ) + + Not(f1).toString() shouldBe "!($f1)" + Not(f2).toString() shouldBe "!($f2)" + Not(f3).toString() shouldBe "!$f3" + Not(f4).toString() shouldBe "!$f4" + Not(f5).toString() shouldBe "!($f5)" + } + } + + context("of an Existence expression") { + should("return the serialized query") { + checkAll(Arb.queryExpression()) { + Existence(it).toString() shouldBe it.toString() + } + } + } + + context("of a Match expression") { + should("serialize to a match function expression if matchEntire = true") { + checkAll(Arb.matchOperand(), Arb.matchOperand()) { subject, pattern -> + Match(subject, pattern, matchEntire = true).toString() shouldBe + "match($subject, $pattern)" + } + } + + should("serialize to a search function expression if matchEntire = false") { + checkAll(Arb.matchOperand(), Arb.matchOperand()) { subject, pattern -> + Match(subject, pattern, matchEntire = false).toString() shouldBe + "search($subject, $pattern)" + } + } + } + } }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/FunctionExpressionTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/FunctionExpressionTest.kt new file mode 100644 index 0000000..9cdb675 --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/FunctionExpressionTest.kt @@ -0,0 +1,37 @@ +package com.kobil.vertx.jsonpath + +import com.kobil.vertx.jsonpath.testing.comparable +import com.kobil.vertx.jsonpath.testing.queryExpression +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.shouldBe +import io.kotest.property.Arb +import io.kotest.property.checkAll + +class FunctionExpressionTest : + ShouldSpec({ + context("the toString method") { + context("of the Length function") { + should("serialize to 'length' followed by the parenthesized serialized argument") { + checkAll(Arb.comparable()) { + FunctionExpression.Length(it).toString() shouldBe "length($it)" + } + } + } + + context("of the Count function") { + should("serialize to 'count' followed by the parenthesized serialized argument") { + checkAll(Arb.queryExpression()) { + FunctionExpression.Count(it).toString() shouldBe "count($it)" + } + } + } + + context("of the Value function") { + should("serialize to 'value' followed by the parenthesized serialized argument") { + checkAll(Arb.queryExpression()) { + FunctionExpression.Value(it).toString() shouldBe "value($it)" + } + } + } + } + }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathQueryTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathQueryTest.kt new file mode 100644 index 0000000..a6e33c8 --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathQueryTest.kt @@ -0,0 +1,351 @@ +package com.kobil.vertx.jsonpath + +import com.kobil.vertx.jsonpath.FilterExpression.Existence +import com.kobil.vertx.jsonpath.QueryExpression.Relative +import com.kobil.vertx.jsonpath.Segment.ChildSegment +import com.kobil.vertx.jsonpath.Segment.DescendantSegment +import com.kobil.vertx.jsonpath.Selector.Index +import com.kobil.vertx.jsonpath.Selector.Name +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.shouldBe +import io.kotest.property.Arb +import io.kotest.property.arbitrary.int +import io.kotest.property.arbitrary.orNull +import io.kotest.property.arbitrary.string +import io.kotest.property.arbitrary.triple +import io.kotest.property.checkAll + +class JsonPathQueryTest : + ShouldSpec({ + context("The get operator") { + context("applied to one or more strings") { + should("append a child segment selecting the specified field names") { + checkAll(Arb.string(), Arb.string(), Arb.string()) { a, b, c -> + QueryExpression.absolute()[a].segments shouldBe + listOf( + ChildSegment(Name(a)), + ) + + QueryExpression.absolute()[a, b].segments shouldBe + listOf( + ChildSegment(listOf(Name(a), Name(b))), + ) + + QueryExpression.absolute()[a, c].segments shouldBe + listOf( + ChildSegment(listOf(Name(a), Name(c))), + ) + + QueryExpression.absolute()[a, b, c].segments shouldBe + listOf( + ChildSegment(listOf(Name(a), Name(b), Name(c))), + ) + + QueryExpression.absolute()[a, c][b].segments shouldBe + listOf( + ChildSegment(listOf(Name(a), Name(c))), + ChildSegment(listOf(Name(b))), + ) + } + } + } + + context("applied to one or more integers") { + should("append a child segment selecting the specified indices") { + checkAll(Arb.int(), Arb.int(), Arb.int()) { a, b, c -> + QueryExpression.absolute()[a].segments shouldBe + listOf( + ChildSegment(Index(a)), + ) + + QueryExpression.absolute()[a, b].segments shouldBe + listOf( + ChildSegment(listOf(Index(a), Index(b))), + ) + + QueryExpression.absolute()[a, c].segments shouldBe + listOf( + ChildSegment(listOf(Index(a), Index(c))), + ) + + QueryExpression.absolute()[a, b, c].segments shouldBe + listOf( + ChildSegment(listOf(Index(a), Index(b), Index(c))), + ) + + QueryExpression.absolute()[a, c][b].segments shouldBe + listOf( + ChildSegment(listOf(Index(a), Index(c))), + ChildSegment(listOf(Index(b))), + ) + } + } + } + + context("applied to one or more selectors") { + should("append a child segment using the specified selectors") { + checkAll( + Arb.string(), + Arb.int(), + Arb.triple(Arb.int().orNull(), Arb.int().orNull(), Arb.int().orNull()), + ) { name, idx, (first, last, step) -> + val n = Selector.name(name) + val i = Selector.index(idx) + val w = Selector.Wildcard + val s = Selector.slice(first, last, step) + val f = Selector.filter(Existence(Relative()["a"])) + + QueryExpression.absolute()[n].segments shouldBe + listOf( + ChildSegment(n), + ) + + QueryExpression.absolute()[n, i].segments shouldBe + listOf( + ChildSegment(listOf(n, i)), + ) + + QueryExpression.absolute()[n, i, s].segments shouldBe + listOf( + ChildSegment(listOf(n, i, s)), + ) + + QueryExpression.absolute()[n, i][s, w].segments shouldBe + listOf( + ChildSegment(listOf(n, i)), + ChildSegment(listOf(s, w)), + ) + + QueryExpression.absolute()[n, i, f][w][i, f, s].segments shouldBe + listOf( + ChildSegment(listOf(n, i, f)), + ChildSegment(listOf(w)), + ChildSegment(listOf(i, f, s)), + ) + } + } + } + } + + context("The selectChildren function") { + should("append a child segment using the specified selectors") { + checkAll( + Arb.string(), + Arb.int(), + Arb.triple(Arb.int().orNull(), Arb.int().orNull(), Arb.int().orNull()), + ) { name, idx, (first, last, step) -> + val n = Selector.name(name) + val i = Selector.index(idx) + val w = Selector.Wildcard + val s = Selector.slice(first, last, step) + val f = Selector.filter(Existence(Relative()["a"])) + + QueryExpression.absolute().selectChildren(n).segments shouldBe + listOf( + ChildSegment(n), + ) + + QueryExpression.absolute().selectChildren(n, i).segments shouldBe + listOf( + ChildSegment(listOf(n, i)), + ) + + QueryExpression.absolute().selectChildren(n, i, s).segments shouldBe + listOf( + ChildSegment(listOf(n, i, s)), + ) + + QueryExpression + .absolute() + .selectChildren(n, i) + .selectChildren(s, w) + .segments shouldBe + listOf( + ChildSegment(listOf(n, i)), + ChildSegment(listOf(s, w)), + ) + + QueryExpression + .absolute() + .selectChildren( + n, + i, + f, + ).selectChildren(w) + .selectChildren(i, f, s) + .segments shouldBe + listOf( + ChildSegment(listOf(n, i, f)), + ChildSegment(listOf(w)), + ChildSegment(listOf(i, f, s)), + ) + } + } + } + + context("The selectDescendants function") { + should("append a descendant segment using the specified selectors") { + checkAll( + Arb.string(), + Arb.int(), + Arb.triple(Arb.int().orNull(), Arb.int().orNull(), Arb.int().orNull()), + ) { name, idx, (first, last, step) -> + val n = Selector.name(name) + val i = Selector.index(idx) + val w = Selector.Wildcard + val s = Selector.slice(first, last, step) + val f = Selector.filter(Existence(Relative()["a"])) + + QueryExpression.absolute().selectDescendants(n).segments shouldBe + listOf( + DescendantSegment(n), + ) + + QueryExpression.absolute().selectDescendants(n, i).segments shouldBe + listOf( + DescendantSegment(listOf(n, i)), + ) + + QueryExpression.absolute().selectDescendants(n, i, s).segments shouldBe + listOf( + DescendantSegment(listOf(n, i, s)), + ) + + QueryExpression + .absolute() + .selectChildren(n, i) + .selectDescendants(s, w) + .segments shouldBe + listOf( + ChildSegment(listOf(n, i)), + DescendantSegment(listOf(s, w)), + ) + + QueryExpression + .absolute() + .selectDescendants( + n, + i, + f, + ).selectChildren(w) + .selectDescendants(i, f, s) + .segments shouldBe + listOf( + DescendantSegment(listOf(n, i, f)), + ChildSegment(listOf(w)), + DescendantSegment(listOf(i, f, s)), + ) + } + } + } + + context("The selectAllChildren function") { + should("append a wildcard selector child segment") { + QueryExpression.absolute().selectAllChildren().segments shouldBe + listOf( + ChildSegment(Selector.WILDCARD), + ) + + QueryExpression + .absolute() + .field("a") + .selectAllChildren() + .segments shouldBe + listOf( + ChildSegment(Name("a")), + ChildSegment(Selector.Wildcard), + ) + } + } + + context("The selectAllDescendants function") { + should("append a wildcard selector descendant segment") { + QueryExpression.absolute().selectAllDescendants().segments shouldBe + listOf( + DescendantSegment(Selector.WILDCARD), + ) + + QueryExpression + .absolute() + .field("a") + .selectAllDescendants() + .segments shouldBe + listOf( + ChildSegment(Name("a")), + DescendantSegment(Selector.Wildcard), + ) + } + } + + context("The field function") { + should("append a child segment selecting the specified field names") { + checkAll(Arb.string(), Arb.string(), Arb.string()) { a, b, c -> + QueryExpression.absolute().field(a).segments shouldBe + listOf( + ChildSegment(Name(a)), + ) + + QueryExpression.absolute().field(a, b).segments shouldBe + listOf( + ChildSegment(listOf(Name(a), Name(b))), + ) + + QueryExpression.absolute().field(a, c).segments shouldBe + listOf( + ChildSegment(listOf(Name(a), Name(c))), + ) + + QueryExpression.absolute().field(a, b, c).segments shouldBe + listOf( + ChildSegment(listOf(Name(a), Name(b), Name(c))), + ) + + QueryExpression + .absolute() + .field(a, c) + .field(b) + .segments shouldBe + listOf( + ChildSegment(listOf(Name(a), Name(c))), + ChildSegment(listOf(Name(b))), + ) + } + } + } + + context("The index function") { + should("append a child segment selecting the specified indices") { + checkAll(Arb.int(), Arb.int(), Arb.int()) { a, b, c -> + QueryExpression.absolute().index(a).segments shouldBe + listOf( + ChildSegment(Index(a)), + ) + + QueryExpression.absolute().index(a, b).segments shouldBe + listOf( + ChildSegment(listOf(Index(a), Index(b))), + ) + + QueryExpression.absolute().index(a, c).segments shouldBe + listOf( + ChildSegment(listOf(Index(a), Index(c))), + ) + + QueryExpression.absolute().index(a, b, c).segments shouldBe + listOf( + ChildSegment(listOf(Index(a), Index(b), Index(c))), + ) + + QueryExpression + .absolute() + .index(a, c) + .index(b) + .segments shouldBe + listOf( + ChildSegment(listOf(Index(a), Index(c))), + ChildSegment(listOf(Index(b))), + ) + } + } + } + }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt index 12f271e..9d2c612 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt @@ -1,23 +1,39 @@ package com.kobil.vertx.jsonpath +import com.kobil.vertx.jsonpath.FilterExpression.Existence import com.kobil.vertx.jsonpath.JsonPath.Companion.onlyPaths +import com.kobil.vertx.jsonpath.QueryExpression.Relative +import com.kobil.vertx.jsonpath.Segment.ChildSegment +import com.kobil.vertx.jsonpath.Segment.DescendantSegment +import com.kobil.vertx.jsonpath.Selector.Index +import com.kobil.vertx.jsonpath.Selector.Name +import com.kobil.vertx.jsonpath.error.MultipleResults +import com.kobil.vertx.jsonpath.error.RequiredJsonValueError.NoResult import com.kobil.vertx.jsonpath.testing.normalizedJsonPath import io.kotest.assertions.arrow.core.shouldBeLeft import io.kotest.assertions.arrow.core.shouldBeNone import io.kotest.assertions.arrow.core.shouldBeRight import io.kotest.assertions.arrow.core.shouldBeSome import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.collections.shouldBeEmpty import io.kotest.matchers.collections.shouldContainExactly import io.kotest.matchers.collections.shouldContainExactlyInAnyOrder +import io.kotest.matchers.shouldBe +import io.kotest.matchers.types.shouldBeInstanceOf import io.kotest.property.Arb +import io.kotest.property.arbitrary.int import io.kotest.property.arbitrary.list +import io.kotest.property.arbitrary.orNull +import io.kotest.property.arbitrary.string +import io.kotest.property.arbitrary.triple import io.kotest.property.checkAll +import io.vertx.core.json.JsonObject import io.vertx.kotlin.core.json.jsonArrayOf import io.vertx.kotlin.core.json.jsonObjectOf class JsonPathTest : ShouldSpec({ - context("The evaluateSingle function") { + context("The evaluateOne function") { context("called on a JSON object") { should("return the single result if there is exactly one") { val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() @@ -185,124 +201,626 @@ class JsonPathTest : } } - context("The onlyPaths function") { - should("return exactly the path fields of the list of JsonNodes") { - checkAll(Arb.list(Arb.normalizedJsonPath(), 0..32)) { paths -> - paths.map { JsonNode(null, it) }.onlyPaths() shouldContainExactly paths + context("The getAll function") { + context("called on a JSON object") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonPath1 + .getAll(jsonObjectOf("a" to 1, "b" to 2)) + .shouldContainExactly(1) + + jsonPath1 + .getAll(jsonObjectOf("a" to "string")) + .shouldContainExactly("string") + + jsonPath2 + .getAll(jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("b" to true)))) + .shouldContainExactly(true) + } + + should("return an empty list if there is no result") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonPath1.evaluateOne(jsonObjectOf("b" to 2)).shouldBeRight().shouldBeNone() + + jsonPath1 + .getAll(jsonObjectOf("b" to jsonObjectOf("a" to 1))) + .shouldBeEmpty() + + jsonPath2 + .getAll(jsonObjectOf("b" to jsonArrayOf(null, jsonObjectOf("b" to true)))) + .shouldBeEmpty() + + jsonPath2 + .getAll(jsonObjectOf("a" to jsonArrayOf(jsonObjectOf("b" to true)))) + .shouldBeEmpty() + + jsonPath2 + .getAll(jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("a" to true)))) + .shouldBeEmpty() + } + + should("return all results if there are multiple") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonPath1 + .getAll( + jsonObjectOf( + "a" to 1, + "b" to jsonObjectOf("a" to 2), + "c" to jsonArrayOf(1, jsonObjectOf("a" to 3)), + ), + ).shouldContainExactlyInAnyOrder(1, 2, 3) + + jsonPath1 + .getAll(jsonObjectOf("a" to "string", "b" to jsonObjectOf("a" to null))) + .shouldContainExactlyInAnyOrder("string", null) + + jsonPath2 + .getAll( + jsonObjectOf( + "a" to jsonObjectOf("a" to 1), + "b" to jsonObjectOf("a" to 2), + ), + ).shouldContainExactlyInAnyOrder( + jsonObjectOf("a" to 1), + jsonObjectOf("a" to 2), + ) + } + } + + context("called on a JSON array") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonPath1 + .getAll(jsonArrayOf(1, 2, 3)) + .shouldContainExactly(1) + + jsonPath1 + .getAll(jsonArrayOf("string", null, true)) + .shouldContainExactly("string") + + jsonPath2 + .getAll(jsonArrayOf(null, jsonObjectOf("b" to true))) + .shouldContainExactly(true) + } + + should("return an empty list if there is no result") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonPath1.evaluateOne(jsonArrayOf()).shouldBeRight().shouldBeNone() + + jsonPath2 + .getAll(jsonArrayOf(null, jsonObjectOf("a" to true))) + .shouldBeEmpty() + + jsonPath2 + .getAll(jsonArrayOf(jsonObjectOf("b" to true))) + .shouldBeEmpty() + } + + should("return all results if there are multiple") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonPath1 + .getAll( + jsonArrayOf( + jsonObjectOf("a" to 2), + jsonArrayOf(1, jsonObjectOf("a" to 3)), + ), + ).shouldContainExactly(2, 3) + + jsonPath2 + .getAll( + jsonArrayOf( + jsonObjectOf("a" to 1), + true, + jsonObjectOf("b" to 3), + jsonObjectOf("a" to 2), + ), + ).shouldContainExactly( + jsonObjectOf("a" to 1), + jsonObjectOf("a" to 2), + ) } } } - context("The selector constructor") { - context("taking an IntProgression") { - should("return a proper slice selector") { - val jp1 = JsonPath[Selector(1..6 step 2)] - - jp1.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( - JsonNode(1, JsonPath[1]), - JsonNode(3, JsonPath[3]), - JsonNode(5, JsonPath[5]), - ) - - val jp2 = JsonPath[Selector(6 downTo 0 step 2)] - - jp2.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( - JsonNode(6, JsonPath[6]), - JsonNode(4, JsonPath[4]), - JsonNode(2, JsonPath[2]), - JsonNode(0, JsonPath[0]), - ) - - val jp3 = JsonPath[Selector(-1 downTo -3 step 1)] - - jp3.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( - JsonNode(6, JsonPath[6]), - JsonNode(5, JsonPath[5]), - JsonNode(4, JsonPath[4]), - ) + context("The getOne function") { + context("called on a JSON object") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonPath1 + .getOne(jsonObjectOf("a" to 1, "b" to 2)) + .shouldBeRight() shouldBeSome 1 + + jsonPath1 + .getOne(jsonObjectOf("a" to "string")) + .shouldBeRight() shouldBeSome "string" + + jsonPath2 + .getOne(jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("b" to true)))) + .shouldBeRight() shouldBeSome true + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonPath1.getOne(jsonObjectOf("b" to 2)).shouldBeRight().shouldBeNone() + + jsonPath1 + .getOne(jsonObjectOf("b" to jsonObjectOf("a" to 1))) + .shouldBeRight() + .shouldBeNone() + + jsonPath2 + .getOne(jsonObjectOf("b" to jsonArrayOf(null, jsonObjectOf("b" to true)))) + .shouldBeRight() + .shouldBeNone() + + jsonPath2 + .getOne(jsonObjectOf("a" to jsonArrayOf(jsonObjectOf("b" to true)))) + .shouldBeRight() + .shouldBeNone() + + jsonPath2 + .getOne(jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("a" to true)))) + .shouldBeRight() + .shouldBeNone() + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonPath1 + .getOne( + jsonObjectOf( + "a" to 1, + "b" to jsonObjectOf("a" to 2), + "c" to jsonArrayOf(1, jsonObjectOf("a" to 3)), + ), + ).shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(1, JsonPath["a"]), + JsonNode(2, JsonPath["b"]["a"]), + JsonNode(3, JsonPath["c"][1]["a"]), + ) + + jsonPath1 + .getOne(jsonObjectOf("a" to "string", "b" to jsonObjectOf("a" to null))) + .shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode("string", JsonPath["a"]), + JsonNode(null, JsonPath["b"]["a"]), + ) + + jsonPath2 + .getOne( + jsonObjectOf( + "a" to jsonObjectOf("a" to 1), + "b" to jsonObjectOf("a" to 2), + ), + ).shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(jsonObjectOf("a" to 1), JsonPath["a"]), + JsonNode(jsonObjectOf("a" to 2), JsonPath["b"]), + ) } } - context("taking three nullable integers") { - should("return a proper slice selector") { - val jp1 = JsonPath[Selector(1, 6, 2)] + context("called on a JSON array") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonPath1 + .getOne(jsonArrayOf(1, 2, 3)) + .shouldBeRight() shouldBeSome 1 + + jsonPath1 + .getOne(jsonArrayOf("string", null, true)) + .shouldBeRight() shouldBeSome "string" - jp1.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( - JsonNode(1, JsonPath[1]), - JsonNode(3, JsonPath[3]), - JsonNode(5, JsonPath[5]), - ) + jsonPath2 + .getOne(jsonArrayOf(null, jsonObjectOf("b" to true))) + .shouldBeRight() shouldBeSome true + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() - val jp2 = JsonPath[Selector(6, null, -2)] + jsonPath1.getOne(jsonArrayOf()).shouldBeRight().shouldBeNone() - jp2.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( - JsonNode(6, JsonPath[6]), - JsonNode(4, JsonPath[4]), - JsonNode(2, JsonPath[2]), - JsonNode(0, JsonPath[0]), - ) + jsonPath2 + .getOne(jsonArrayOf(null, jsonObjectOf("a" to true))) + .shouldBeRight() + .shouldBeNone() - val jp3 = JsonPath[Selector(-1, -4, -1)] + jsonPath2 + .getOne(jsonArrayOf(jsonObjectOf("b" to true))) + .shouldBeRight() + .shouldBeNone() + } - jp3.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( - JsonNode(6, JsonPath[6]), - JsonNode(5, JsonPath[5]), - JsonNode(4, JsonPath[4]), - ) + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() - val jp4 = JsonPath[Selector(2, 5)] + jsonPath1 + .getOne( + jsonArrayOf( + jsonObjectOf("a" to 2), + jsonArrayOf(1, jsonObjectOf("a" to 3)), + ), + ).shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(2, JsonPath[0]["a"]), + JsonNode(3, JsonPath[1][1]["a"]), + ) - jp4.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( - JsonNode(2, JsonPath[2]), - JsonNode(3, JsonPath[3]), - JsonNode(4, JsonPath[4]), - ) + jsonPath2 + .getOne( + jsonArrayOf( + jsonObjectOf("a" to 1), + true, + jsonObjectOf("b" to 3), + jsonObjectOf("a" to 2), + ), + ).shouldBeLeft() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(jsonObjectOf("a" to 1), JsonPath[0]), + JsonNode(jsonObjectOf("a" to 2), JsonPath[3]), + ) } } + } + + context("The requireOne function") { + context("called on a JSON object") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonPath1 + .requireOne(jsonObjectOf("a" to 1, "b" to 2)) shouldBeRight 1 + + jsonPath1 + .requireOne(jsonObjectOf("a" to "string")) shouldBeRight "string" + + jsonPath2 + .requireOne(jsonObjectOf("a" to jsonArrayOf(null, jsonObjectOf("b" to true)))) + .shouldBeRight(true) + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile("$.a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$.a[1]['b']").shouldBeRight() + + jsonPath1.requireOne(jsonObjectOf("b" to 2)) shouldBeLeft NoResult + + jsonPath1 + .requireOne(jsonObjectOf("b" to jsonObjectOf("a" to 1))) shouldBeLeft NoResult + + jsonPath2 + .requireOne( + jsonObjectOf( + "b" to + jsonArrayOf( + null, + jsonObjectOf("b" to true), + ), + ), + ) shouldBeLeft NoResult + + jsonPath2 + .requireOne( + jsonObjectOf("a" to jsonArrayOf(jsonObjectOf("b" to true))), + ) shouldBeLeft + NoResult + + jsonPath2 + .requireOne( + jsonObjectOf( + "a" to + jsonArrayOf( + null, + jsonObjectOf("a" to true), + ), + ), + ) shouldBeLeft NoResult + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonPath1 + .requireOne( + jsonObjectOf( + "a" to 1, + "b" to jsonObjectOf("a" to 2), + "c" to jsonArrayOf(1, jsonObjectOf("a" to 3)), + ), + ).shouldBeLeft() + .shouldBeInstanceOf() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(1, JsonPath["a"]), + JsonNode(2, JsonPath["b"]["a"]), + JsonNode(3, JsonPath["c"][1]["a"]), + ) + + jsonPath1 + .requireOne(jsonObjectOf("a" to "string", "b" to jsonObjectOf("a" to null))) + .shouldBeLeft() + .shouldBeInstanceOf() + .results + .shouldContainExactlyInAnyOrder( + JsonNode("string", JsonPath["a"]), + JsonNode(null, JsonPath["b"]["a"]), + ) - context("taking a filter") { - should("return a proper filter Selector") { - val jp1 = - JsonPath[ - Selector( - FilterExpression.Comparison( - FilterExpression.Comparison.Op.LESS, - QueryExpression.Relative(), - ComparableExpression.Literal(3), - ), + jsonPath2 + .requireOne( + jsonObjectOf( + "a" to jsonObjectOf("a" to 1), + "b" to jsonObjectOf("a" to 2), ), - ] - - jp1.evaluate(jsonArrayOf(0, 1, 2, 3, 4, 5, 6)).shouldContainExactly( - JsonNode(0, JsonPath[0]), - JsonNode(1, JsonPath[1]), - JsonNode(2, JsonPath[2]), - ) - - val jp2 = - JsonPath[ - Selector( - FilterExpression.Match( - QueryExpression.Relative(listOf(Segment.ChildSegment("a"))), - ComparableExpression.Literal("a.*"), - matchEntire = true, - ), + ).shouldBeLeft() + .shouldBeInstanceOf() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(jsonObjectOf("a" to 1), JsonPath["a"]), + JsonNode(jsonObjectOf("a" to 2), JsonPath["b"]), + ) + } + } + + context("called on a JSON array") { + should("return the single result if there is exactly one") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonPath1 + .requireOne(jsonArrayOf(1, 2, 3)) shouldBeRight 1 + + jsonPath1 + .requireOne(jsonArrayOf("string", null, true)) shouldBeRight "string" + + jsonPath2 + .requireOne(jsonArrayOf(null, jsonObjectOf("b" to true))) shouldBeRight true + } + + should("return None if there is no result") { + val jsonPath1 = JsonPath.compile("$[0]").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[1]['b']").shouldBeRight() + + jsonPath1.requireOne(jsonArrayOf()) shouldBeLeft NoResult + + jsonPath2 + .requireOne(jsonArrayOf(null, jsonObjectOf("a" to true))) shouldBeLeft NoResult + + jsonPath2 + .requireOne(jsonArrayOf(jsonObjectOf("b" to true))) shouldBeLeft NoResult + } + + should("return an error if there are multiple results") { + val jsonPath1 = JsonPath.compile("$..a").shouldBeRight() + val jsonPath2 = JsonPath.compile("$[?@.a]").shouldBeRight() + + jsonPath1 + .requireOne( + jsonArrayOf( + jsonObjectOf("a" to 2), + jsonArrayOf(1, jsonObjectOf("a" to 3)), ), - ] + ).shouldBeLeft() + .shouldBeInstanceOf() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(2, JsonPath[0]["a"]), + JsonNode(3, JsonPath[1][1]["a"]), + ) - jp2 - .evaluate( + jsonPath2 + .requireOne( jsonArrayOf( - jsonObjectOf("a" to "a"), - jsonObjectOf("a" to "bc"), - jsonObjectOf("a" to "abc"), - jsonObjectOf("b" to "ab"), + jsonObjectOf("a" to 1), + true, + jsonObjectOf("b" to 3), + jsonObjectOf("a" to 2), ), - ).shouldContainExactly( - JsonNode(jsonObjectOf("a" to "a"), JsonPath[0]), - JsonNode(jsonObjectOf("a" to "abc"), JsonPath[2]), + ).shouldBeLeft() + .shouldBeInstanceOf() + .results + .shouldContainExactlyInAnyOrder( + JsonNode(jsonObjectOf("a" to 1), JsonPath[0]), + JsonNode(jsonObjectOf("a" to 2), JsonPath[3]), + ) + } + } + } + + context("The plus operator") { + context("specifying a single segment") { + should("append the segment") { + val n = Selector.name("a") + val i = Selector.index(1) + val s = Selector.slice(1, -1, 2) + val w = Selector.Wildcard + val f = Selector.filter(QueryExpression.absolute().exists()) + + (JsonPath.ROOT + ChildSegment(n)).segments shouldBe + listOf( + ChildSegment(n), + ) + + (JsonPath.ROOT + ChildSegment(i, f)).segments shouldBe + listOf( + ChildSegment(i, f), + ) + + ( + JsonPath.ROOT + DescendantSegment(n) + ChildSegment(w) + + DescendantSegment( + s, + f, + ) + ).segments shouldBe + listOf( + DescendantSegment(n), + ChildSegment(w), + DescendantSegment(s, f), ) } } + + context("specifying iterable segments") { + should("append all segments") { + checkAll(Arb.normalizedJsonPath()) { (segments) -> + val n = Selector.name("a") + + (JsonPath.ROOT + segments).segments shouldBe segments + (JsonPath.ROOT + ChildSegment(n) + segments).segments shouldBe + listOf(ChildSegment(n)) + segments + } + } + } + } + + context("The onlyPaths function") { + should("return exactly the path fields of the list of JsonNodes") { + checkAll(Arb.list(Arb.normalizedJsonPath(), 0..32)) { paths -> + paths.map { JsonNode(null, it) }.onlyPaths() shouldContainExactly paths + } + } + } + + context("The static get operator") { + context("applied to one or more strings") { + should("append a child segment selecting the specified field names") { + checkAll(Arb.string(), Arb.string(), Arb.string()) { a, b, c -> + JsonPath[a].segments shouldBe + listOf( + ChildSegment(Name(a)), + ) + + JsonPath[a, b].segments shouldBe + listOf( + ChildSegment(listOf(Name(a), Name(b))), + ) + + JsonPath[a, c].segments shouldBe + listOf( + ChildSegment(listOf(Name(a), Name(c))), + ) + + JsonPath[a, b, c].segments shouldBe + listOf( + ChildSegment(listOf(Name(a), Name(b), Name(c))), + ) + + JsonPath[a, c][b].segments shouldBe + listOf( + ChildSegment(listOf(Name(a), Name(c))), + ChildSegment(listOf(Name(b))), + ) + } + } + } + + context("applied to one or more integers") { + should("append a child segment selecting the specified indices") { + checkAll(Arb.int(), Arb.int(), Arb.int()) { a, b, c -> + JsonPath[a].segments shouldBe + listOf( + ChildSegment(Index(a)), + ) + + JsonPath[a, b].segments shouldBe + listOf( + ChildSegment(listOf(Index(a), Index(b))), + ) + + JsonPath[a, c].segments shouldBe + listOf( + ChildSegment(listOf(Index(a), Index(c))), + ) + + JsonPath[a, b, c].segments shouldBe + listOf( + ChildSegment(listOf(Index(a), Index(b), Index(c))), + ) + + JsonPath[a, c][b].segments shouldBe + listOf( + ChildSegment(listOf(Index(a), Index(c))), + ChildSegment(listOf(Index(b))), + ) + } + } + } + + context("applied to one or more selectors") { + should("append a child segment using the specified selectors") { + checkAll( + Arb.string(), + Arb.int(), + Arb.triple(Arb.int().orNull(), Arb.int().orNull(), Arb.int().orNull()), + ) { name, idx, (first, last, step) -> + val n = Selector.name(name) + val i = Selector.index(idx) + val w = Selector.Wildcard + val s = Selector.slice(first, last, step) + val f = Selector.filter(Existence(Relative()["a"])) + + JsonPath[n].segments shouldBe + listOf( + ChildSegment(n), + ) + + JsonPath[n, i].segments shouldBe + listOf( + ChildSegment(listOf(n, i)), + ) + + JsonPath[n, i, s].segments shouldBe + listOf( + ChildSegment(listOf(n, i, s)), + ) + + JsonPath[n, i][s, w].segments shouldBe + listOf( + ChildSegment(listOf(n, i)), + ChildSegment(listOf(s, w)), + ) + + JsonPath[n, i, f][w][i, f, s].segments shouldBe + listOf( + ChildSegment(listOf(n, i, f)), + ChildSegment(listOf(w)), + ChildSegment(listOf(i, f, s)), + ) + } + } + } } }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/QueryExpressionTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/QueryExpressionTest.kt new file mode 100644 index 0000000..d1e57c0 --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/QueryExpressionTest.kt @@ -0,0 +1,219 @@ +package com.kobil.vertx.jsonpath + +import arrow.core.toNonEmptyListOrNull +import com.kobil.vertx.jsonpath.QueryExpression.Absolute +import com.kobil.vertx.jsonpath.QueryExpression.Relative +import com.kobil.vertx.jsonpath.Segment.ChildSegment +import com.kobil.vertx.jsonpath.Segment.DescendantSegment +import com.kobil.vertx.jsonpath.testing.normalizedJsonPath +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.shouldBe +import io.kotest.property.Arb +import io.kotest.property.arbitrary.filter +import io.kotest.property.arbitrary.map +import io.kotest.property.checkAll + +class QueryExpressionTest : + ShouldSpec({ + context("The count method") { + should("return a count function called on the query expression") { + checkAll(Arb.normalizedJsonPath()) { (segments) -> + val abs = Absolute(segments) + val rel = Relative(segments) + + abs.count() shouldBe FunctionExpression.Count(abs) + rel.count() shouldBe FunctionExpression.Count(rel) + } + } + } + + context("The value method") { + should("return a value function called on the query expression") { + checkAll(Arb.normalizedJsonPath()) { (segments) -> + val abs = Absolute(segments) + val rel = Relative(segments) + + abs.value() shouldBe FunctionExpression.Value(abs) + rel.value() shouldBe FunctionExpression.Value(rel) + } + } + } + + context("The plus operator") { + context("called on an absolute query") { + context("specifying a single segment") { + should("append the segment") { + val n = Selector.name("a") + val i = Selector.index(1) + val s = Selector.slice(1, -1, 2) + val w = Selector.Wildcard + val f = Selector.filter(QueryExpression.absolute().exists()) + + (Absolute() + ChildSegment(n)).segments shouldBe + listOf( + ChildSegment(n), + ) + + (Absolute() + ChildSegment(i, f)).segments shouldBe + listOf( + ChildSegment(i, f), + ) + + ( + Absolute() + DescendantSegment(n) + ChildSegment(w) + + DescendantSegment( + s, + f, + ) + ).segments shouldBe + listOf( + DescendantSegment(n), + ChildSegment(w), + DescendantSegment(s, f), + ) + } + } + + context("specifying iterable segments") { + should("append all segments") { + checkAll(Arb.normalizedJsonPath()) { (segments) -> + val n = Selector.name("a") + + (Absolute() + segments).segments shouldBe segments + (Absolute() + ChildSegment(n) + segments).segments shouldBe + listOf(ChildSegment(n)) + segments + } + } + } + } + + context("called on a relative query") { + context("specifying a single segment") { + should("append the segment") { + val n = Selector.name("a") + val i = Selector.index(1) + val s = Selector.slice(1, -1, 2) + val w = Selector.Wildcard + val f = Selector.filter(QueryExpression.relative().exists()) + + (Relative() + ChildSegment(n)).segments shouldBe + listOf( + ChildSegment(n), + ) + + (Relative() + ChildSegment(i, f)).segments shouldBe + listOf( + ChildSegment(i, f), + ) + + ( + Relative() + DescendantSegment(n) + ChildSegment(w) + + DescendantSegment( + s, + f, + ) + ).segments shouldBe + listOf( + DescendantSegment(n), + ChildSegment(w), + DescendantSegment(s, f), + ) + } + } + + context("specifying iterable segments") { + should("append all segments") { + checkAll(Arb.normalizedJsonPath()) { (segments) -> + val n = Selector.name("a") + + (Relative() + segments).segments shouldBe segments + (Relative() + ChildSegment(n) + segments).segments shouldBe + listOf(ChildSegment(n)) + segments + } + } + } + } + } + + context("The toString function") { + context("called on an absolute query") { + should("return the serialized segments, prefixed by $") { + checkAll(Arb.normalizedJsonPath()) { (segments) -> + Absolute(segments).toString() shouldBe "$" + segments.joinToString("") + } + } + } + + context("called on a relative query") { + should("return the serialized segments, prefixed by @") { + checkAll(Arb.normalizedJsonPath()) { (segments) -> + Relative(segments).toString() shouldBe "@" + segments.joinToString("") + } + } + } + } + + context("The static absolute method") { + context("called without an argument") { + should("return an empty absolute query") { + QueryExpression.absolute() shouldBe Absolute(listOf()) + } + } + + context("applied to a list of segments") { + should("return an absolute query with the same list of segments") { + checkAll(Arb.normalizedJsonPath()) { (segments) -> + QueryExpression.absolute(segments) shouldBe Absolute(segments) + } + } + } + + context("applied to vararg segments") { + should("return an absolute query with the same segments") { + checkAll( + Arb + .normalizedJsonPath() + .map { it.segments.toNonEmptyListOrNull() } + .filter { it != null }, + ) { segments -> + QueryExpression.absolute( + segments!!.head, + *segments.tail.toTypedArray(), + ) shouldBe Absolute(segments) + } + } + } + } + + context("The static relative method") { + context("called without an argument") { + should("return an empty relative query") { + QueryExpression.relative() shouldBe Relative(listOf()) + } + } + + context("applied to a list of segments") { + should("return a relative query with the same list of segments") { + checkAll(Arb.normalizedJsonPath()) { (segments) -> + QueryExpression.relative(segments) shouldBe Relative(segments) + } + } + } + + context("applied to vararg segments") { + should("return a relative query with the same segments") { + checkAll( + Arb + .normalizedJsonPath() + .map { it.segments.toNonEmptyListOrNull() } + .filter { it != null }, + ) { segments -> + QueryExpression.relative( + segments!!.head, + *segments.tail.toTypedArray(), + ) shouldBe Relative(segments) + } + } + } + } + }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/SegmentTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/SegmentTest.kt new file mode 100644 index 0000000..e707661 --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/SegmentTest.kt @@ -0,0 +1,130 @@ +package com.kobil.vertx.jsonpath + +import io.kotest.assertions.throwables.shouldThrow +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.shouldBe + +class SegmentTest : + ShouldSpec({ + context("The ChildSegment") { + context("primary constructor") { + should("throw when called with an empty list") { + shouldThrow { + Segment.ChildSegment(listOf()) + } + } + } + + context("toString method") { + should( + "return a string of all selectors, joined by commas, enclosed in square brackets", + ) { + Segment.ChildSegment("a", "b", "c").toString() shouldBe "['a','b','c']" + Segment.ChildSegment("a").toString() shouldBe "['a']" + Segment.ChildSegment(1).toString() shouldBe "[1]" + Segment.ChildSegment(Selector.Wildcard).toString() shouldBe "[*]" + Segment + .ChildSegment( + Selector.name("a"), + Selector.Wildcard, + Selector.index(1), + ).toString() shouldBe "['a',*,1]" + } + } + } + + context("The DescendantSegment") { + context("primary constructor") { + should("throw when called with an empty list") { + shouldThrow { + Segment.DescendantSegment(listOf()) + } + } + } + + context("toString method") { + should( + "return a string of all selectors, separated by commas, enclosed in square brackets, preceded by ..", + ) { + Segment.DescendantSegment("a", "b", "c").toString() shouldBe "..['a','b','c']" + Segment.DescendantSegment("a").toString() shouldBe "..['a']" + Segment.DescendantSegment(1).toString() shouldBe "..[1]" + Segment.DescendantSegment(Selector.Wildcard).toString() shouldBe "..[*]" + Segment + .DescendantSegment(Selector.name("a"), Selector.Wildcard, Selector.index(1)) + .toString() shouldBe "..['a',*,1]" + } + } + } + + context("The child static function") { + context("taking a list of selectors") { + should("throw on an empty list") { + shouldThrow { + Segment.child(listOf()) + } + } + + should("return a child segment with the specified list of selectors") { + val sel = + listOf( + Selector.name("a"), + Selector.index(1), + Selector.slice(1, -1, 2), + Selector.Wildcard, + Selector.Filter(QueryExpression.absolute().exists()), + ) + + Segment.child(sel) shouldBe Segment.ChildSegment(sel) + } + } + + context("taking varargs") { + should("return a child segment with the specified selectors") { + val n = Selector.name("a") + val i = Selector.index(1) + val s = Selector.slice(1, -1, 2) + val w = Selector.Wildcard + val f = Selector.Filter(QueryExpression.absolute().exists()) + + Segment.child(n, i, s, w, f) shouldBe Segment.ChildSegment(listOf(n, i, s, w, f)) + } + } + } + + context("The descendant static function") { + context("taking a list of selectors") { + should("throw on an empty list") { + shouldThrow { + Segment.descendant(listOf()) + } + } + + should("return a descendant segment with the specified list of selectors") { + val sel = + listOf( + Selector.name("a"), + Selector.index(1), + Selector.slice(1, -1, 2), + Selector.Wildcard, + Selector.filter(QueryExpression.absolute().exists()), + ) + + Segment.descendant(sel) shouldBe Segment.DescendantSegment(sel) + } + } + + context("taking varargs") { + should("return a descendant segment with the specified selectors") { + val n = Selector.name("a") + val i = Selector.index(1) + val s = Selector.slice(1, -1, 2) + val w = Selector.Wildcard + val f = Selector.filter(QueryExpression.absolute().exists()) + + Segment.descendant(n, i, s, w, f) shouldBe + Segment.DescendantSegment(listOf(n, i, s, w, f)) + } + } + } + }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/SelectorTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/SelectorTest.kt new file mode 100644 index 0000000..b18ca1b --- /dev/null +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/SelectorTest.kt @@ -0,0 +1,218 @@ +package com.kobil.vertx.jsonpath + +import arrow.core.nonEmptyListOf +import com.kobil.vertx.jsonpath.ComparableExpression.Literal +import com.kobil.vertx.jsonpath.FilterExpression.Comparison +import com.kobil.vertx.jsonpath.FilterExpression.Existence +import com.kobil.vertx.jsonpath.FilterExpression.Not +import com.kobil.vertx.jsonpath.FilterExpression.Or +import com.kobil.vertx.jsonpath.QueryExpression.Relative +import com.kobil.vertx.jsonpath.Segment.ChildSegment +import io.kotest.core.spec.style.ShouldSpec +import io.kotest.matchers.shouldBe +import io.kotest.property.Arb +import io.kotest.property.arbitrary.int +import io.kotest.property.arbitrary.string +import io.kotest.property.checkAll + +class SelectorTest : + ShouldSpec({ + context("the toString method") { + context("of a name selector") { + should("return the name enclosed in single quotes") { + checkAll(Arb.string()) { + Selector.Name(it).toString() shouldBe "'$it'" + } + } + } + + context("of an index selector") { + should("return the index") { + checkAll(Arb.int()) { + Selector.Index(it).toString() shouldBe "$it" + } + } + } + + context("of the wildcard selector") { + should("return a literal *") { + Selector.Wildcard.toString() shouldBe "*" + } + } + + context("of a slice selector") { + should("return the three components separated by colons") { + checkAll(Arb.int(), Arb.int(), Arb.int()) { first, last, step -> + Selector.Slice(first, last, step).toString() shouldBe "$first:$last:$step" + } + } + + should("omit the step component when it is null") { + checkAll(Arb.int(), Arb.int()) { first, last -> + Selector.Slice(first, last, null).toString() shouldBe "$first:$last" + } + } + + should("have an empty first component when it is null") { + checkAll(Arb.int(), Arb.int()) { last, step -> + Selector.Slice(null, last, step).toString() shouldBe ":$last:$step" + } + } + + should("have an empty last component when it is null") { + checkAll(Arb.int(), Arb.int()) { first, step -> + Selector.Slice(first, null, step).toString() shouldBe "$first::$step" + } + } + + should("have empty first and last components when they are both null") { + checkAll(Arb.int()) { step -> + Selector.Slice(null, null, step).toString() shouldBe "::$step" + } + } + + should("return a single colon if all components are null") { + Selector.Slice(null, null, null).toString() shouldBe ":" + } + } + + context("of a filter selector") { + should("return the serialized filter expression preceded by a question mark") { + Selector + .Filter( + Existence( + Relative(ChildSegment(Selector.Name("a"))), + ), + ).toString() shouldBe "?@['a']" + } + } + } + + context("the invoke operator") { + context("called on a string") { + should("return a name selector with the given field name") { + checkAll(Arb.string()) { + Selector(it) shouldBe Selector.Name(it) + } + } + } + + context("called on an integer") { + should("return an index selector with the given index") { + checkAll(Arb.int()) { + Selector(it) shouldBe Selector.Index(it) + } + } + } + + context("called on an IntProgression") { + should("return an equivalent slice selector") { + Selector(1..2) shouldBe Selector.Slice(1, 3, 1) + Selector(1..<5) shouldBe Selector.Slice(1, 5, 1) + Selector(1..10 step 2) shouldBe Selector.Slice(1, 10, 2) + Selector(10 downTo 1) shouldBe Selector.Slice(10, 0, -1) + Selector(10 downTo 1 step 4) shouldBe Selector.Slice(10, 1, -4) + } + } + + context("called on three nullable integers") { + should("return a slice selector with the same parameters") { + checkAll(Arb.int(), Arb.int(), Arb.int()) { first, last, step -> + Selector(first, last, step) shouldBe Selector.Slice(first, last, step) + } + } + } + + context("called on two nullable integers") { + should("return a slice selector with the same parameters and a null step") { + checkAll(Arb.int(), Arb.int()) { first, last -> + Selector(first, last) shouldBe Selector.Slice(first, last, null) + } + } + } + + context("called on a filter expression") { + should("return a filter selector with the given filter expression") { + val expr1 = Existence(Relative(ChildSegment("a"))) + val expr2 = + Or( + nonEmptyListOf( + Comparison( + Comparison.Op.GREATER_EQ, + Relative(ChildSegment("a")), + Literal(1), + ), + Not(Existence(Relative(ChildSegment("a")))), + ), + ) + + Selector(expr1) shouldBe Selector.Filter(expr1) + Selector(expr2) shouldBe Selector.Filter(expr2) + } + } + } + + context("the name static function") { + should("return a name selector with the given field name") { + checkAll(Arb.string()) { + Selector.name(it) shouldBe Selector.Name(it) + } + } + } + + context("the index static function") { + should("return an index selector with the given index") { + checkAll(Arb.int()) { + Selector.index(it) shouldBe Selector.Index(it) + } + } + } + + context("the slice static function") { + context("called on an IntProgression") { + should("return an equivalent slice selector") { + Selector.slice(1..2) shouldBe Selector.Slice(1, 3, 1) + Selector.slice(1..<5) shouldBe Selector.Slice(1, 5, 1) + Selector.slice(1..10 step 2) shouldBe Selector.Slice(1, 10, 2) + Selector.slice(10 downTo 1) shouldBe Selector.Slice(10, 0, -1) + Selector.slice(10 downTo 1 step 4) shouldBe Selector.Slice(10, 1, -4) + } + } + + context("called on three nullable integers") { + should("return a slice selector with the same parameters") { + checkAll(Arb.int(), Arb.int(), Arb.int()) { first, last, step -> + Selector.slice(first, last, step) shouldBe Selector.Slice(first, last, step) + } + } + } + + context("called on two nullable integers") { + should("return a slice selector with the same parameters and a null step") { + checkAll(Arb.int(), Arb.int()) { first, last -> + Selector.slice(first, last) shouldBe Selector.Slice(first, last, null) + } + } + } + } + + context("the filter static function") { + should("return a filter selector with the given filter expression") { + val expr1 = Existence(Relative(ChildSegment("a"))) + val expr2 = + Or( + nonEmptyListOf( + Comparison( + Comparison.Op.GREATER_EQ, + Relative(ChildSegment("a")), + Literal(1), + ), + Not(Existence(Relative(ChildSegment("a")))), + ), + ) + + Selector.filter(expr1) shouldBe Selector.Filter(expr1) + Selector.filter(expr2) shouldBe Selector.Filter(expr2) + } + } + }) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/testing/Gen.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/testing/Gen.kt index 97a41c4..e006616 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/testing/Gen.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/testing/Gen.kt @@ -1,12 +1,20 @@ package com.kobil.vertx.jsonpath.testing +import com.kobil.vertx.jsonpath.ComparableExpression import com.kobil.vertx.jsonpath.JsonPath +import com.kobil.vertx.jsonpath.QueryExpression +import com.kobil.vertx.jsonpath.get import io.kotest.property.Arb import io.kotest.property.arbitrary.Codepoint import io.kotest.property.arbitrary.arbitrary import io.kotest.property.arbitrary.boolean +import io.kotest.property.arbitrary.choice +import io.kotest.property.arbitrary.constant +import io.kotest.property.arbitrary.double import io.kotest.property.arbitrary.int +import io.kotest.property.arbitrary.map import io.kotest.property.arbitrary.of +import io.kotest.property.arbitrary.string import io.kotest.property.resolution.default fun Codepoint.Companion.nameChar(): Arb = @@ -22,7 +30,7 @@ fun Codepoint.Companion.nameChar(): Arb = fun Arb.Companion.normalizedJsonPath(): Arb = arbitrary { val length = Arb.int(0..10).bind() - var path = JsonPath.root + var path = JsonPath.ROOT for (i in 1..length) { path = @@ -35,3 +43,27 @@ fun Arb.Companion.normalizedJsonPath(): Arb = path } + +fun Arb.Companion.comparable(): Arb = + choice( + literal(), + queryExpression(), + queryExpression().map { it.count() }, + queryExpression().map { it.length() }, + queryExpression().map { it.value() }, + ) + +fun Arb.Companion.queryExpression(): Arb> = + choice( + normalizedJsonPath().map { (segments) -> QueryExpression.absolute(segments) }, + normalizedJsonPath().map { (segments) -> QueryExpression.relative(segments) }, + ) + +fun Arb.Companion.literal(): Arb = + choice(int(), double(), string(), boolean(), constant(null)).map(ComparableExpression::Literal) + +fun Arb.Companion.matchOperand(): Arb = + choice( + string().map(ComparableExpression::Literal), + queryExpression(), + ) From 2b3f305547e16fba29c1b96bdb8cadb93bbdbd76 Mon Sep 17 00:00:00 2001 From: Johannes Leupold Date: Thu, 10 Oct 2024 11:09:52 +0200 Subject: [PATCH 6/7] Add API documentation --- .../java/com/kobil/vertx/jsonpath/Build.java | 64 ------- .../com/kobil/vertx/jsonpath/Compile.java | 75 -------- .../vertx/jsonpath/ComparableExpression.kt | 131 +++++++++++-- .../kobil/vertx/jsonpath/FilterExpression.kt | 177 +++++++++++++++++- .../vertx/jsonpath/FunctionExpression.kt | 38 +++- .../com/kobil/vertx/jsonpath/JsonNode.kt | 22 +++ .../com/kobil/vertx/jsonpath/JsonPath.kt | 160 +++++++++++++++- .../com/kobil/vertx/jsonpath/JsonPathQuery.kt | 122 +++++++++++- .../vertx/jsonpath/NodeListExpression.kt | 32 +++- .../kobil/vertx/jsonpath/QueryExpression.kt | 104 ++++++++-- .../com/kobil/vertx/jsonpath/Segment.kt | 138 +++++++++++++- .../com/kobil/vertx/jsonpath/Selector.kt | 137 ++++++++++++++ .../kotlin/com/kobil/vertx/jsonpath/Vertx.kt | 118 +++++++++--- .../vertx/jsonpath/compiler/JsonPathParser.kt | 2 +- .../kobil/vertx/jsonpath/compiler/Token.kt | 2 +- .../vertx/jsonpath/error/JsonPathError.kt | 41 ++-- .../jsonpath/interpreter/FilterExpressions.kt | 4 +- .../JavaComparableExpressionTest.java | 79 -------- .../jsonpath/JavaFilterExpressionTest.java | 9 +- .../vertx/jsonpath/JavaJsonPathTest.java | 5 +- .../vertx/jsonpath/JavaSelectorTest.java | 5 +- .../jsonpath/ComparableExpressionTest.kt | 40 ---- .../vertx/jsonpath/FilterExpressionTest.kt | 86 ++++----- .../kobil/vertx/jsonpath/JsonPathQueryTest.kt | 8 +- .../com/kobil/vertx/jsonpath/JsonPathTest.kt | 4 +- .../com/kobil/vertx/jsonpath/SelectorTest.kt | 12 +- 26 files changed, 1196 insertions(+), 419 deletions(-) delete mode 100644 src/main/java/com/kobil/vertx/jsonpath/Build.java delete mode 100644 src/main/java/com/kobil/vertx/jsonpath/Compile.java delete mode 100644 src/test/java/com/kobil/vertx/jsonpath/JavaComparableExpressionTest.java diff --git a/src/main/java/com/kobil/vertx/jsonpath/Build.java b/src/main/java/com/kobil/vertx/jsonpath/Build.java deleted file mode 100644 index 27b1c97..0000000 --- a/src/main/java/com/kobil/vertx/jsonpath/Build.java +++ /dev/null @@ -1,64 +0,0 @@ -package com.kobil.vertx.jsonpath; - -import io.vertx.core.json.JsonArray; -import io.vertx.core.json.JsonObject; - -public class Build { - public static void main(String[] args) { -// var jp = "$.a[1].b[1:3,4:-1:2]"; - - var compiled = JsonPath.ROOT - .field("a") - .index(1) - .field("b") - .selectChildren(Selector.slice(1, 3), Selector.slice(4, -1, 2)); - - System.out.println(compiled); - System.out.println(compiled.field("c")); - - var json = new JsonObject(); - var a = new JsonArray(); - var second = new JsonObject(); - var b = new JsonArray(); - - json.put("a", a); - - a.add(1); - a.add(second); - - second.put("b", b); - - for (int i = 0; i < 12; ++i) { - b.add(i); - } - - System.out.println(compiled.evaluate(json)); - - System.out.println(compiled.getOne(json)); - System.out.println(compiled.requireOne(json)); - System.out.println(compiled.getAll(json)); - System.out.println(compiled.traceOne(json)); - System.out.println(compiled.traceAll(json)); - - var jp2 = JsonPath.ROOT.field("a"); - System.out.println(jp2.getOne(json)); - System.out.println(jp2.getOne(a)); - System.out.println(jp2.requireOne(json)); - System.out.println(jp2.requireOne(a)); - System.out.println(jp2.getAll(json)); - System.out.println(jp2.getAll(a)); - System.out.println(jp2.traceOne(json)); - System.out.println(jp2.traceOne(a)); - System.out.println(jp2.traceAll(json)); - System.out.println(jp2.traceAll(a)); - -// var expr = "@.a"; - var filter = QueryExpression.relative().field("a").exists(); - System.out.println(filter); - - System.out.println(filter.test(json)); - System.out.println(filter.test(a)); - System.out.println(filter.test(second)); - System.out.println(filter.test(b)); - } -} diff --git a/src/main/java/com/kobil/vertx/jsonpath/Compile.java b/src/main/java/com/kobil/vertx/jsonpath/Compile.java deleted file mode 100644 index 9828922..0000000 --- a/src/main/java/com/kobil/vertx/jsonpath/Compile.java +++ /dev/null @@ -1,75 +0,0 @@ -package com.kobil.vertx.jsonpath; - -import arrow.core.Either; -import com.kobil.vertx.jsonpath.error.JsonPathError; -import io.vertx.core.json.JsonArray; -import io.vertx.core.json.JsonObject; - -public class Compile { - private static JsonPath unwrap(Either result) { - return result.fold( - err -> { - throw new IllegalStateException(err.toString()); - }, - r -> r - ); - } - - public static void main(String[] args) { - var jp = "$.a[1].b[1:3,4:-1:2]"; - - var compiled = unwrap(JsonPath.compile(jp)); - - System.out.println(compiled); - System.out.println(compiled.field("c")); - - var json = new JsonObject(); - var a = new JsonArray(); - var second = new JsonObject(); - var b = new JsonArray(); - - json.put("a", a); - - a.add(1); - a.add(second); - - second.put("b", b); - - for (int i = 0; i < 12; ++i) { - b.add(i); - } - - System.out.println(compiled.evaluate(json)); - - System.out.println(compiled.getOne(json)); - System.out.println(compiled.requireOne(json)); - System.out.println(compiled.getAll(json)); - System.out.println(compiled.traceOne(json)); - System.out.println(compiled.traceAll(json)); - - var jp2 = unwrap(JsonPath.compile("$.a")); - System.out.println(jp2.getOne(json)); - System.out.println(jp2.getOne(a)); - System.out.println(jp2.requireOne(json)); - System.out.println(jp2.requireOne(a)); - System.out.println(jp2.getAll(json)); - System.out.println(jp2.getAll(a)); - System.out.println(jp2.traceOne(json)); - System.out.println(jp2.traceOne(a)); - System.out.println(jp2.traceAll(json)); - System.out.println(jp2.traceAll(a)); - - var expr = "@.a"; - var filter = FilterExpression.compile(expr).fold( - err -> { - throw new IllegalStateException(err.toString()); - }, - result -> result - ); - - System.out.println(filter.test(json)); - System.out.println(filter.test(a)); - System.out.println(filter.test(second)); - System.out.println(filter.test(b)); - } -} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/ComparableExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/ComparableExpression.kt index 6130088..78b3a6b 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/ComparableExpression.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/ComparableExpression.kt @@ -1,44 +1,158 @@ package com.kobil.vertx.jsonpath +/** + * The base interface for all expressions that may occur as operands of a comparison. + * + * It includes methods to build comparison expressions and some function expressions. One simple + * subclass is a [Literal] expression. + * + * @see FilterExpression.Comparison + * @see FunctionExpression + * @see QueryExpression + */ sealed interface ComparableExpression { + /** + * Construct a [FilterExpression.Comparison] checking for equality of this expression and [other] + * + * @param other the right hand side of the comparison + * @return a '==' comparison + */ infix fun eq(other: ComparableExpression): FilterExpression = isEqualTo(other) + /** + * Construct a [FilterExpression.Comparison] checking for equality of this expression and [other] + * + * @param other the right hand side of the comparison + * @return a '==' comparison + */ fun isEqualTo(other: ComparableExpression): FilterExpression = FilterExpression.Comparison.eq(this, other) + /** + * Construct a [FilterExpression.Comparison] checking that this expression is not equal to [other] + * + * @param other the right hand side of the comparison + * @return a '!=' comparison + */ infix fun neq(other: ComparableExpression): FilterExpression = isNotEqualTo(other) + /** + * Construct a [FilterExpression.Comparison] checking that this expression is not equal to [other] + * + * @param other the right hand side of the comparison + * @return a '!=' comparison + */ fun isNotEqualTo(other: ComparableExpression): FilterExpression = FilterExpression.Comparison.neq(this, other) + /** + * Construct a [FilterExpression.Comparison] checking that this expression is greater than [other] + * + * @param other the right hand side of the comparison + * @return a '>' comparison + */ infix fun gt(other: ComparableExpression): FilterExpression = isGreaterThan(other) + /** + * Construct a [FilterExpression.Comparison] checking that this expression is greater than [other] + * + * @param other the right hand side of the comparison + * @return a '>' comparison + */ fun isGreaterThan(other: ComparableExpression): FilterExpression = FilterExpression.Comparison.greaterThan(this, other) + /** + * Construct a [FilterExpression.Comparison] checking that this expression is greater than or + * equal to [other] + * + * @param other the right hand side of the comparison + * @return a '>=' comparison + */ infix fun ge(other: ComparableExpression): FilterExpression = isGreaterOrEqual(other) + /** + * Construct a [FilterExpression.Comparison] checking that this expression is greater than or + * equal to [other] + * + * @param other the right hand side of the comparison + * @return a '>=' comparison + */ fun isGreaterOrEqual(other: ComparableExpression): FilterExpression = FilterExpression.Comparison.greaterOrEqual(this, other) + /** + * Construct a [FilterExpression.Comparison] checking that this expression is less than [other] + * + * @param other the right hand side of the comparison + * @return a '<' comparison + */ infix fun lt(other: ComparableExpression): FilterExpression = isLessThan(other) + /** + * Construct a [FilterExpression.Comparison] checking that this expression is less than [other] + * + * @param other the right hand side of the comparison + * @return a '<' comparison + */ fun isLessThan(other: ComparableExpression): FilterExpression = FilterExpression.Comparison.lessThan(this, other) + /** + * Construct a [FilterExpression.Comparison] checking that this expression is less than or equal + * to [other] + * + * @param other the right hand side of the comparison + * @return a '<=' comparison + */ infix fun le(other: ComparableExpression): FilterExpression = isLessOrEqual(other) + /** + * Construct a [FilterExpression.Comparison] checking that this expression is less than or equal + * to [other] + * + * @param other the right hand side of the comparison + * @return a '<=' comparison + */ fun isLessOrEqual(other: ComparableExpression): FilterExpression = FilterExpression.Comparison.lessOrEqual(this, other) + /** + * Construct a [FunctionExpression.Length] that calculates the length of a string or size of a + * [io.vertx.core.json.JsonObject] or [io.vertx.core.json.JsonArray] + * + * @return a [FunctionExpression.Length] call taking this expression as the argument + */ fun length(): ComparableExpression = FunctionExpression.Length(this) + /** + * Construct a `match` function call that matches this expression to some regex [pattern]. Both + * operands may either be strings or singular query expressions (relative or absolute). The + * `match` function always matches the entire subject string. + * + * @see FilterExpression.Match + * @param pattern the expression specifying the pattern to match + * @return a `match` function expression using this as the subject and [pattern] as the pattern + */ fun match(pattern: ComparableExpression): FilterExpression = FilterExpression.Match(this, pattern, true) + /** + * Construct a `search` function call that matches this expression to some regex [pattern]. Both + * operands may either be strings or singular query expressions (relative or absolute). The + * `search` function looks for a matching substring inside the subject string. + * + * @see FilterExpression.Match + * @param pattern the expression specifying the pattern to match + * @return a `search` function expression using this as the subject and [pattern] as the pattern + */ fun search(pattern: ComparableExpression): FilterExpression = FilterExpression.Match(this, pattern, false) + /** + * A literal expression, which may be an integer, floating point number, string, + * boolean or `null`. + */ data class Literal( val value: Any?, ) : ComparableExpression { @@ -49,21 +163,4 @@ sealed interface ComparableExpression { else -> value.toString() } } - - companion object { - @JvmStatic - fun literal(value: Int): Literal = Literal(value) - - @JvmStatic - fun literal(value: Double): Literal = Literal(value) - - @JvmStatic - fun literal(value: String): Literal = Literal(value) - - @JvmStatic - fun literal(value: Boolean): Literal = Literal(value) - - @JvmStatic - fun literalNull(): Literal = Literal(null) - } } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/FilterExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/FilterExpression.kt index 3735f80..8bebc7f 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/FilterExpression.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/FilterExpression.kt @@ -3,6 +3,7 @@ package com.kobil.vertx.jsonpath import arrow.core.Either import arrow.core.NonEmptyList import arrow.core.nonEmptyListOf +import com.kobil.vertx.jsonpath.FilterExpression.Comparison.Op import com.kobil.vertx.jsonpath.JsonNode.Companion.rootNode import com.kobil.vertx.jsonpath.compiler.JsonPathCompiler import com.kobil.vertx.jsonpath.error.JsonPathError @@ -10,11 +11,34 @@ import com.kobil.vertx.jsonpath.interpreter.test import io.vertx.core.json.JsonArray import io.vertx.core.json.JsonObject +/** + * A base type for filter expressions which may be used in a filter selector, + * or on its own as a predicate. + */ sealed interface FilterExpression { + /** + * Tests whether this filter expression matches the given JSON object. + * + * @param obj the JSON object to match + * @return true, if the filter matches the object, false, otherwise + */ fun test(obj: JsonObject): Boolean = test(obj.rootNode) + /** + * Tests whether this filter expression matches the given JSON array. + * + * @param arr the JSON array to match + * @return true, if the filter matches the array, false, otherwise + */ fun test(arr: JsonArray): Boolean = test(arr.rootNode) + /** + * Constructs a filter expression testing that both, this expression and [other], are satisfied. + * This is equivalent to the '&&' operator in JSON Path. + * + * @param other the right hand operand of the '&&' operator + * @return the '&&' expression testing both operands + */ infix fun and(other: FilterExpression): FilterExpression = if (this is And && other is And) { And(operands + other.operands) @@ -26,6 +50,13 @@ sealed interface FilterExpression { And(nonEmptyListOf(this, other)) } + /** + * Constructs a filter expression testing that at least one of this expression and [other], + * is satisfied. This is equivalent to the '||' operator in JSON Path. + * + * @param other the right hand operand of the '||' operator + * @return the '||' expression testing that at least one operand is satisfied + */ infix fun or(other: FilterExpression): FilterExpression = if (this is Or && other is Or) { Or(operands + other.operands) @@ -37,6 +68,11 @@ sealed interface FilterExpression { Or(nonEmptyListOf(this, other)) } + /** + * Inverts this filter expression. This is equivalent to the '!' operator in JSON Path. + * + * @return the inverted filter expression + */ operator fun not(): FilterExpression = when (this) { is Not -> operand @@ -44,11 +80,27 @@ sealed interface FilterExpression { else -> Not(this) } + /** + * A logical AND connection of the operands + * + * @param operands a non-empty list of operands + */ data class And( val operands: NonEmptyList, ) : FilterExpression { - constructor(firstOperand: FilterExpression, vararg moreOperands: FilterExpression) : this( - nonEmptyListOf(firstOperand, *moreOperands), + /** + * An alternative constructor, taking the operands as varargs. + * + * @param firstOperand the first operand of '&&' + * @param secondOperand the second operand of '&&' + * @param moreOperands all remaining operands of '&&', if any + */ + constructor( + firstOperand: FilterExpression, + secondOperand: FilterExpression, + vararg moreOperands: FilterExpression, + ) : this( + nonEmptyListOf(firstOperand, secondOperand, *moreOperands), ) override fun toString(): String = @@ -61,16 +113,37 @@ sealed interface FilterExpression { } } + /** + * A logical Or connection of the operands + * + * @param operands a non-empty list of operands + */ data class Or( val operands: NonEmptyList, ) : FilterExpression { - constructor(firstOperand: FilterExpression, vararg moreOperands: FilterExpression) : this( - nonEmptyListOf(firstOperand, *moreOperands), + /** + * An alternative constructor, taking the operands as varargs. + * + * @param firstOperand the first operand of '&&' + * @param secondOperand the second operand of '&&' + * @param moreOperands all remaining operands of '&&', if any + */ + constructor( + firstOperand: FilterExpression, + secondOperand: FilterExpression, + vararg moreOperands: FilterExpression, + ) : this( + nonEmptyListOf(firstOperand, secondOperand, *moreOperands), ) override fun toString(): String = operands.joinToString(" || ") } + /** + * The logical inversion of the operand. + * + * @param operand the operand that is inverted + */ data class Not( val operand: FilterExpression, ) : FilterExpression { @@ -82,11 +155,23 @@ sealed interface FilterExpression { } } + /** + * A comparison expression. + * + * @param op the comparison operator, see [Op] + * @param lhs the left hand operand of the comparison + * @param rhs the right hand operand of the comparison + */ data class Comparison( val op: Op, val lhs: ComparableExpression, val rhs: ComparableExpression, ) : FilterExpression { + /** + * A comparison operator. + * + * @param str the string representation of the operator + */ enum class Op( val str: String, ) { @@ -98,6 +183,9 @@ sealed interface FilterExpression { GREATER_EQ(">="), ; + /** + * The logical inverse of the operator + */ val inverse: Op get() = when (this) { @@ -112,32 +200,79 @@ sealed interface FilterExpression { override fun toString(): String = "$lhs ${op.str} $rhs" + /** + * Provides useful helper functions to construct comparison expressions. + */ companion object { + /** + * Construct a [FilterExpression.Comparison] checking that [lhs] is equal to [rhs] + * + * @param lhs the left hand side of the comparison + * @param rhs the right hand side of the comparison + * @return a '==' comparison + */ fun eq( lhs: ComparableExpression, rhs: ComparableExpression, ): Comparison = Comparison(Op.EQ, lhs, rhs) + /** + * Construct a [FilterExpression.Comparison] checking that [lhs] is not equal to [rhs] + * + * @param lhs the left hand side of the comparison + * @param rhs the right hand side of the comparison + * @return a '!=' comparison + */ fun neq( lhs: ComparableExpression, rhs: ComparableExpression, ): Comparison = Comparison(Op.NOT_EQ, lhs, rhs) + /** + * Construct a [FilterExpression.Comparison] checking that [lhs] is greater than [rhs] + * + * @param lhs the left hand side of the comparison + * @param rhs the right hand side of the comparison + * @return a '>' comparison + */ fun greaterThan( lhs: ComparableExpression, rhs: ComparableExpression, ): Comparison = Comparison(Op.GREATER, lhs, rhs) + /** + * Construct a [FilterExpression.Comparison] checking that [lhs] is greater than + * or equal to [rhs] + * + * @param lhs the left hand side of the comparison + * @param rhs the right hand side of the comparison + * @return a '>=' comparison + */ fun greaterOrEqual( lhs: ComparableExpression, rhs: ComparableExpression, ): Comparison = Comparison(Op.GREATER_EQ, lhs, rhs) + /** + * Construct a [FilterExpression.Comparison] checking that [lhs] is less than [rhs] + * + * @param lhs the left hand side of the comparison + * @param rhs the right hand side of the comparison + * @return a '<' comparison + */ fun lessThan( lhs: ComparableExpression, rhs: ComparableExpression, ): Comparison = Comparison(Op.LESS, lhs, rhs) + /** + * Construct a [FilterExpression.Comparison] checking that [lhs] is less than + * or equal to [rhs] + * + * @param lhs the left hand side of the comparison + * @param rhs the right hand side of the comparison + * @return a '<=' comparison + */ fun lessOrEqual( lhs: ComparableExpression, rhs: ComparableExpression, @@ -145,12 +280,30 @@ sealed interface FilterExpression { } } - data class Existence( + /** + * A filter expression checking for the existence of any elements satisfying the query (or, + * generally, the node list expression). + * + * @param query the node list expression, most likely a [QueryExpression] + * @see [QueryExpression] + */ + data class Test( val query: NodeListExpression, ) : FilterExpression { override fun toString(): String = "$query" } + /** + * A filter expression that matches some string [subject] against some regex [pattern]. It may + * either require the entire subject or a substring of the subject to match the pattern. + * + * @param subject the subject, which must be an expression referring to a string + * (e.g. a [ComparableExpression.Literal] or a [QueryExpression] pointing to a string value) + * @param pattern the regex pattern, which must be an expression referring to a string + * (e.g. a [ComparableExpression.Literal] or a [QueryExpression] pointing to a string value) + * @param matchEntire whether the entire subject string should be matched. If false, the function + * looks for a matching substring. + */ data class Match( val subject: ComparableExpression, val pattern: ComparableExpression, @@ -163,7 +316,21 @@ sealed interface FilterExpression { } } + /** + * Contains static functions to construct filter expressions + */ companion object { + /** + * Compiles a filter expression string. It will return an instance of [Either.Right] containing + * the compiled expression if the compilation was successful. Otherwise, an error wrapped in an + * instance of [Either.Left] is returned. + * + * Filter expression strings must not have a leading `?`. + * + * @param filterExpression the filter expression string without leading `?` + * @return the compiled filter expression, or an error + * @see JsonPathError + */ @JvmStatic fun compile(filterExpression: String): Either = JsonPathCompiler.compileJsonPathFilter(filterExpression) diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/FunctionExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/FunctionExpression.kt index 877476d..7f69f4c 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/FunctionExpression.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/FunctionExpression.kt @@ -1,21 +1,47 @@ package com.kobil.vertx.jsonpath -sealed class FunctionExpression : ComparableExpression { +/** + * An expression representing a JSON Path Function extension. It may appear as an operand in a + * [FilterExpression.Comparison]. + */ +sealed interface FunctionExpression : ComparableExpression { + /** + * The `length` function extension, returning the length of a string argument, the number of + * elements in a JSON array, or the number of entries in a JSON object. + * + * @param arg the argument to the function, e.g. a [ComparableExpression.Literal] + * or a [QueryExpression] + */ data class Length( val arg: ComparableExpression, - ) : FunctionExpression() { + ) : FunctionExpression { override fun toString(): String = "length($arg)" } + /** + * The `count` function extension, returning the length of the node list returned by the query. + * + * @param arg the argument to the function, a [NodeListExpression] + * @see NodeListExpression + * @see QueryExpression + */ data class Count( - val arg: QueryExpression<*>, - ) : FunctionExpression() { + val arg: NodeListExpression, + ) : FunctionExpression { override fun toString(): String = "count($arg)" } + /** + * The `value` function extension, returning the single item of the node list resulting from the + * query. If the query doesn't return exactly one node, the function will result in an error. + * + * @param arg the argument to the function, a [NodeListExpression] + * @see NodeListExpression + * @see QueryExpression + */ data class Value( - val arg: QueryExpression<*>, - ) : FunctionExpression() { + val arg: NodeListExpression, + ) : FunctionExpression { override fun toString(): String = "value($arg)" } } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonNode.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonNode.kt index f175e3c..ed07d47 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonNode.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonNode.kt @@ -1,13 +1,35 @@ package com.kobil.vertx.jsonpath +/** + * Any JSON value together with its position, expressed by a normalized [JsonPath]. + * + * @param value the JSON value + * @param path the position of the value, relative to the root document + * @see JsonPath + */ data class JsonNode( val value: Any?, val path: JsonPath, ) { + /** + * Contains helpers to obtain certain JSON nodes + */ companion object { + /** + * Wraps the given value into a JSON node at the root. + * + * @param value the JSON value + * @return a JSON node with the given [value] in root position + */ @JvmStatic fun root(value: Any?): JsonNode = JsonNode(value, JsonPath.ROOT) + /** + * Wraps the given value into a JSON node at the root. + * + * @receiver the JSON value + * @return a JSON node with the given [value] in root position + */ val Any?.rootNode: JsonNode get() = root(this) } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt index dd5f4a0..a1c51de 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt @@ -15,24 +15,96 @@ import com.kobil.vertx.jsonpath.error.RequiredJsonValueError import com.kobil.vertx.jsonpath.interpreter.evaluate import io.vertx.core.json.impl.JsonUtil +/** + * A compiled representation of a JSON Path. + * + * @see Segment + * @see Selector + */ data class JsonPath internal constructor( override val segments: List = emptyList(), ) : JsonPathQuery { + /** + * Evaluates this JSON path query on the given [subject]. It returns a list of all nodes matching + * the JSON Path query. + * + * Results are returned as [JsonNode] instances, i.e. JSON values together with their position + * relative to [subject]. + * + * @param subject the subject to apply the query to + * @return the list of matching JSON nodes + * + * @see JsonNode + */ fun evaluate(subject: Any?): List = segments.evaluate(JsonUtil.wrapJsonValue(subject).rootNode) + /** + * Evaluates this JSON path query on the given [subject], requiring that there is at most one + * result + * + * If there is exactly one result, an instance of [Either.Right] containing a [arrow.core.Some] + * wrapping the node. If there is no result, the [Either.Right] instance contains + * [arrow.core.None]. If there is more than one result, an [Either.Left] wrapping a + * [MultipleResults] error is returned. + * + * Results are returned as [JsonNode] instances, i.e. JSON values together with their position + * relative to [subject]. + * + * @param subject the subject to apply the query to + * @return the single matching JSON node, if any, or an error + * + * @see JsonNode + * @see MultipleResults + */ fun evaluateOne(subject: Any?): Either> = evaluate(subject).one() + /** + * Evaluates this JSON path query on the given [subject]. It returns a list of all values of nodes + * matching the JSON Path query. + * + * @param subject the subject to apply the query to + * @return the list of matching JSON values + */ @Suppress("UNCHECKED_CAST") fun getAll(subject: Any?): List = evaluate(subject).onlyValues().map { it as T } + /** + * Evaluates this JSON path query on the given [subject], requiring that there is at most one + * result. The result value is returned, if there is any. + * + * If there is exactly one result, an instance of [Either.Right] containing a [arrow.core.Some] + * wrapping the value. If there is no result, the [Either.Right] instance contains + * [arrow.core.None]. If there is more than one result, an [Either.Left] wrapping a + * [MultipleResults] error is returned. + * + * @param subject the subject to apply the query to + * @return the single matching JSON value, if any, or an error + * + * @see MultipleResults + */ @Suppress("UNCHECKED_CAST") fun getOne(subject: Any?): Either> = evaluateOne(subject).map { maybeValue -> maybeValue.map { it.value as T } } + /** + * Evaluates this JSON path query on the given [subject], requiring that there is at most one + * result. The result value is returned, if there is any. + * + * If there is exactly one result, an instance of [Either.Right] containing a [arrow.core.Some] + * wrapping the value. If there is no result, an [Either.Left] instance containing the + * [RequiredJsonValueError.NoResult] error is returned. If there is more than one result, an + * [Either.Left] wrapping a [MultipleResults] error is returned. + * + * @param subject the subject to apply the query to + * @return the single matching JSON value, if any, or an error + * + * @see MultipleResults + * @see RequiredJsonValueError + */ @Suppress("UNCHECKED_CAST") fun requireOne(subject: Any?): Either = evaluateOne(subject).flatMap { maybeValue -> @@ -42,46 +114,128 @@ data class JsonPath internal constructor( ) } + /** + * Evaluates this JSON path query on the given [subject], returning the positions of all matching + * nodes inside the JSON. The positions are expressed as normalized [JsonPath]s, i.e. JSON Paths + * only including simple name and index selectors. + * + * @param subject the subject to apply the query to + * @return the list of normalized [JsonPath] positions of matching nodes + */ fun traceAll(subject: Any?): List = evaluate(subject).onlyPaths() + /** + * Evaluates this JSON path query on the given [subject], requiring that there is at most one + * result. The position of the result is returned, if any. The position is expressed as a + * normalized [JsonPath], i.e. a JSON Paths only including simple name and index selectors. + * + * If there is exactly one result, an instance of [Either.Right] containing a [arrow.core.Some] + * wrapping the position. If there is no result, the [Either.Right] instance contains + * [arrow.core.None]. If there is more than one result, an [Either.Left] wrapping a + * [MultipleResults] error is returned. + * + * @param subject the subject to apply the query to + * @return the position of the single matching JSON node, if any, or an error + * + * @see MultipleResults + */ fun traceOne(subject: Any?): Either> = evaluateOne(subject).map { maybeValue -> maybeValue.map { it.path } } override fun plus(segment: Segment): JsonPath = JsonPath(segments + segment) - override operator fun plus(segments: Iterable): JsonPath = - copy(segments = this.segments + segments) + override operator fun plus(additionalSegments: Iterable): JsonPath = + copy(segments = this.segments + additionalSegments) override fun toString(): String = segments.joinToString("", prefix = "$") + /** + * Contains various utilities to work with JSON Paths + */ companion object { + /** + * The [JsonPath] referring to the root document, i.e. '$' + */ @JvmField val ROOT = JsonPath() + /** + * Compiles a filter expression string. It will return an instance of [Either.Right] containing + * the compiled [JsonPath] if the compilation was successful. Otherwise, an error wrapped in an + * instance of [Either.Left] is returned. + * + * @param jsonPath the JSON Path string + * @return the compiled [JsonPath], or an error + * @see JsonPathError + */ @JvmStatic fun compile(jsonPath: String): Either = compileJsonPathQuery(jsonPath) - fun List.one(): Either> = + private fun List.one(): Either> = when (size) { 0 -> None.right() 1 -> first().some().right() else -> MultipleResults(this).left() } + /** + * Only keeps the values from the list of results + * + * @receiver a list of [JsonNode] + * @return the list of values of the JSON nodes + * @see [JsonNode] + */ fun List.onlyValues(): List = map(JsonNode::value) + /** + * Only keeps the positions from the list of results + * + * @receiver a list of [JsonNode] + * @return the list of positions of the JSON nodes + * @see [JsonNode] + */ fun List.onlyPaths(): List = map(JsonNode::path) + /** + * Returns a JSON path with one child segment using the given selectors. + * + * @param selector the first selector + * @param more additional selectors to include, if any + * @return A [JsonPath], equivalent to $[selector, ...more] + * + * @see Segment.ChildSegment + * @See Selector + */ operator fun get( selector: Selector, vararg more: Selector, ): JsonPath = ROOT.get(selector, *more) + /** + * Returns a JSON path with one child segment selecting the given field names. + * + * @param field the first field + * @param more additional fields to include, if any + * @return A [JsonPath], equivalent to $['field', ...'more'] + * + * @see Segment.ChildSegment + * @See Selector.Name + */ operator fun get( field: String, vararg more: String, ): JsonPath = ROOT.get(field, *more) + /** + * Returns a JSON path with one child segment selecting the given indices. + * + * @param index the first index + * @param more additional indices to include, if any + * @return A [JsonPath], equivalent to $[index, ...more] + * + * @see Segment.ChildSegment + * @See Selector.Index + */ operator fun get( index: Int, vararg more: Int, diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPathQuery.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPathQuery.kt index bd6d3c3..f4b21d8 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPathQuery.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPathQuery.kt @@ -1,47 +1,167 @@ package com.kobil.vertx.jsonpath +/** + * A base interface for query-like objects which consist of a sequence of [Segment]s. + * + * @param T the query type + * @see Segment + * @see Selector + */ interface JsonPathQuery> { + /** + * The ordered segments of this query + */ val segments: List + /** + * Appends a child segment using the given selectors to the query. + * + * @param selector the first selector + * @param more additional selectors to include, if any + * @return a query with the [segments] of this query plus a new child segment + * + * @see Segment.ChildSegment + * @see Selector + */ fun selectChildren( selector: Selector, vararg more: Selector, ): T = this + Segment.ChildSegment(selector, *more) + /** + * Appends a descendant segment using the given selectors to the query. + * + * @param selector the first selector + * @param more additional selectors to include, if any + * @return a query with the [segments] of this query plus a new descendant segment + * + * @see Segment.DescendantSegment + * @see Selector + */ fun selectDescendants( selector: Selector, vararg more: Selector, ): T = this + Segment.DescendantSegment(selector, *more) + /** + * Appends a new wildcard child segment to the query. This selects all direct children of all + * currently selected nodes + * + * @return a query with the [segments] of this query plus a new wildcard child segment + * + * @see Segment.ChildSegment + * @see Selector.Wildcard + */ fun selectAllChildren(): T = selectChildren(Selector.WILDCARD) + /** + * Appends a new wildcard descendant segment to the query. This will select all currently selected + * nodes and all their descendants (direct and indirect child nodes) + * + * @return a query with the [segments] of this query plus a new wildcard descendant segment + * + * @see Segment.DescendantSegment + * @see Selector.Wildcard + */ fun selectAllDescendants(): T = selectDescendants(Selector.WILDCARD) + /** + * Selects one or multiple fields from the currently selected nodes. + * + * @param field the first field + * @param more additional fields to include, if any + * @return a query with the [segments] of this query plus a new child segment using name selectors + * + * @see Segment.ChildSegment + * @See Selector.Name + */ fun field( field: String, vararg more: String, ): T = this + Segment.ChildSegment(field, *more) + /** + * Selects one or multiple indices from the currently selected nodes. + * + * @param index the first index + * @param more additional indices to include, if any + * @return a query with the [segments] of this query plus a new child segment + * using index selectors + * + * @see Segment.ChildSegment + * @See Selector.Index + */ fun index( index: Int, vararg more: Int, ): T = this + Segment.ChildSegment(index, *more) + /** + * Appends the given segment to the query. + * + * @param segment the segment to append + * @return a query with the [segments] of this query plus [segment] + * + * @see Segment + */ operator fun plus(segment: Segment): T - operator fun plus(segments: Iterable): T + /** + * Appends the given segments to the query. + * + * @param additionalSegments the segments to append + * @return a query with the [segments] of this query plus [additionalSegments] + * + * @see Segment + */ + operator fun plus(additionalSegments: Iterable): T } +/** + * Appends a child segment using the given selectors to the query. + * + * @receiver the query to append to + * @param selector the first selector + * @param more additional selectors to include, if any + * @return a query with the [JsonPathQuery.segments] of this query plus a new child segment + * + * @see Segment.ChildSegment + * @see Selector + */ operator fun > T.get( selector: Selector, vararg more: Selector, ): T = selectChildren(selector, *more) +/** + * Selects one or multiple fields from the currently selected nodes. + * + * @receiver the query to append to + * @param field the first field + * @param more additional fields to include, if any + * @return a query with the [JsonPathQuery.segments] of this query plus a new child segment + * using name selectors + * + * @see Segment.ChildSegment + * @See Selector.Name + */ operator fun > T.get( field: String, vararg more: String, ): T = field(field, *more) +/** + * Selects one or multiple indices from the currently selected nodes. + * + * @receiver the query to append to + * @param index the first index + * @param more additional indices to include, if any + * @return a query with the [JsonPathQuery.segments] of this query plus a new child segment + * using index selectors + * + * @see Segment.ChildSegment + * @See Selector.Index + */ operator fun > T.get( index: Int, vararg more: Int, diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/NodeListExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/NodeListExpression.kt index 34ab54b..5577fea 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/NodeListExpression.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/NodeListExpression.kt @@ -1,5 +1,35 @@ package com.kobil.vertx.jsonpath +/** + * An expression that results in a node list. This may be a query expression or a function + * expression that returns a node list. + */ sealed interface NodeListExpression : ComparableExpression { - fun exists(): FilterExpression = FilterExpression.Existence(this) + /** + * Returns a test expression, testing for existence of any nodes matching + * this [NodeListExpression]. + * + * @return a test expression checking that the returned node list is non-empty + * + * @see FilterExpression.Test + */ + fun exists(): FilterExpression = FilterExpression.Test(this) + + /** + * Returns a `count` function expression using this [NodeListExpression] as the argument. + * + * @return the `count` function expression + * + * @see FunctionExpression.Count + */ + fun count(): ComparableExpression = FunctionExpression.Count(this) + + /** + * Returns a `value` function expression using this [NodeListExpression] as the argument. + * + * @return the `value` function expression + * + * @see FunctionExpression.Count + */ + fun value(): ComparableExpression = FunctionExpression.Value(this) } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/QueryExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/QueryExpression.kt index 968d74a..e8c91ce 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/QueryExpression.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/QueryExpression.kt @@ -1,60 +1,142 @@ package com.kobil.vertx.jsonpath -sealed class QueryExpression> : +/** + * A query expression, that is, a JSON Path query or a relative query which occurs as part of a + * [FilterExpression]. It may be used in test expressions (checking for existence), as an argument + * to function expressions, or as an operand in comparisons. + * + * @see NodeListExpression + * @see FilterExpression.Comparison + * @see FilterExpression.Match + * @see FunctionExpression + * + * @param T the concrete query type + */ +sealed interface QueryExpression> : NodeListExpression, JsonPathQuery { + /** + * Indicates whether the query is a singular query, that is, it contains only child segments with + * only one [Selector.Name] or [Selector.Index] selector each. + * + * @see Segment.ChildSegment + */ val isSingular: Boolean get() = segments.all { it.isSingular } - fun count(): ComparableExpression = FunctionExpression.Count(this) - - fun value(): ComparableExpression = FunctionExpression.Value(this) - + /** + * A relative query, i.e. a JSON path expression starting with '@'. + * + * @param segments the segments of the query + * @see Segment + */ data class Relative @JvmOverloads constructor( override val segments: List = listOf(), - ) : QueryExpression() { + ) : QueryExpression { + /** + * An alternative varargs constructor + * + * @param firstSegment the first segment of the query + * @param more additional segments, if any + * @see Segment + */ constructor(firstSegment: Segment, vararg more: Segment) : this(listOf(firstSegment, *more)) override operator fun plus(segment: Segment): Relative = copy(segments = segments + segment) - override operator fun plus(segments: Iterable): Relative = - copy(segments = this.segments + segments) + override operator fun plus(additionalSegments: Iterable): Relative = + copy(segments = this.segments + additionalSegments) override fun toString(): String = segments.joinToString("", prefix = "@") } + /** + * An absolute query, equivalent to a JSON Path. In the context of a [FilterExpression], it refers + * to the root document + * + * @param segments the segments of the query + * @see Segment + */ data class Absolute @JvmOverloads constructor( override val segments: List = listOf(), - ) : QueryExpression() { + ) : QueryExpression { + /** + * An alternative varargs constructor + * + * @param firstSegment the first segment of the query + * @param more additional segments, if any + * @see Segment + */ constructor(firstSegment: Segment, vararg more: Segment) : this(listOf(firstSegment, *more)) override operator fun plus(segment: Segment): Absolute = copy(segments = segments + segment) - override operator fun plus(segments: Iterable): Absolute = - copy(segments = this.segments + segments) + override operator fun plus(additionalSegments: Iterable): Absolute = + copy(segments = this.segments + additionalSegments) override fun toString(): String = segments.joinToString("", prefix = "$") } + /** + * Contains convenience factory functions + */ companion object { + /** + * Returns a relative query with the given segments. + * + * @param segments the segments to use + * @return the relative query + * + * @see Segment + * @see Relative + */ @JvmStatic @JvmOverloads fun relative(segments: List = listOf()): Relative = Relative(segments) + /** + * Returns a relative query with the given segments. + * + * @param firstSegment the first segment of the query + * @param more additional segments, if any + * @return the relative query + * + * @see Segment + * @see Relative + */ @JvmStatic fun relative( firstSegment: Segment, vararg more: Segment, ): Relative = Relative(firstSegment, *more) + /** + * Returns an absolute query with the given segments. + * + * @param segments the segments to use + * @return the relative query + * + * @see Segment + * @see Absolute + */ @JvmStatic @JvmOverloads fun absolute(segments: List = listOf()): Absolute = Absolute(segments) + /** + * Returns an absolute query with the given segments. + * + * @param firstSegment the first segment of the query + * @param more additional segments, if any + * @return the absolute query + * + * @see Segment + * @see Absolute + */ @JvmStatic fun absolute( firstSegment: Segment, diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt index ed6a456..d5b17bc 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt @@ -1,9 +1,31 @@ package com.kobil.vertx.jsonpath +/** + * A segment of a JSON path query. It includes [Selector]s, which are applied to the input JSON + * separately, concatenating the results. Segments may either be [ChildSegment] or + * [DescendantSegment], with the former only selecting direct descendants of the currently selected + * nodes and the latter selecting the current nodes and all direct or indirect descendants. + * + * @see Selector + */ sealed interface Segment { + /** + * The selectors used by the segment + */ val selectors: List + + /** + * Whether this segment selects at most one result + */ val isSingular: Boolean + /** + * A child segment selecting direct children of the currently selected nodes. + * + * @param selectors the selectors used by the segment + * + * @see Selector + */ data class ChildSegment( override val selectors: List, ) : Segment { @@ -11,16 +33,40 @@ sealed interface Segment { require(selectors.isNotEmpty()) { "A child segment without selectors is not allowed" } } + /** + * An alternative vararg constructor + * + * @param selector the first selector + * @param more additional selectors, if any + * + * @see Selector + */ constructor(selector: Selector, vararg more: Selector) : this(listOf(selector, *more)) - constructor(name: String, vararg more: String) : this( - Selector(name), - *more.map(Selector::invoke).toTypedArray(), + /** + * An alternative vararg constructor, allowing to specify only field names + * + * @param field the first field name to select + * @param more additional field names, if any + * + * @see Selector.Name + */ + constructor(field: String, vararg more: String) : this( + Selector.Name(field), + *more.map(Selector::Name).toTypedArray(), ) + /** + * An alternative vararg constructor, allowing to specify only indices + * + * @param index the first index to select + * @param more additional indices, if any + * + * @see Selector.Index + */ constructor(index: Int, vararg more: Int) : this( - Selector(index), - *more.map(Selector::invoke).toTypedArray(), + Selector.Index(index), + *more.map(Selector::Index).toTypedArray(), ) override val isSingular: Boolean @@ -31,6 +77,13 @@ sealed interface Segment { override fun toString(): String = selectors.joinToString(",", prefix = "[", postfix = "]") } + /** + * A descendant segment selecting direct and indirect children of the currently selected nodes. + * + * @param selectors the selectors used by the segment + * + * @see Selector + */ data class DescendantSegment( override val selectors: List, ) : Segment { @@ -38,16 +91,40 @@ sealed interface Segment { require(selectors.isNotEmpty()) { "A descendant segment without selectors is not allowed" } } + /** + * An alternative vararg constructor + * + * @param selector the first selector + * @param more additional selectors, if any + * + * @see Selector + */ constructor(selector: Selector, vararg more: Selector) : this(listOf(selector, *more)) - constructor(name: String, vararg more: String) : this( - Selector(name), - *more.map(Selector::invoke).toTypedArray(), + /** + * An alternative vararg constructor, allowing to specify only field names + * + * @param field the first field name to select + * @param more additional field names, if any + * + * @see Selector.Name + */ + constructor(field: String, vararg more: String) : this( + Selector.Name(field), + *more.map(Selector::Name).toTypedArray(), ) + /** + * An alternative vararg constructor, allowing to specify only indices + * + * @param index the first index to select + * @param more additional indices, if any + * + * @see Selector.Index + */ constructor(index: Int, vararg more: Int) : this( - Selector(index), - *more.map(Selector::invoke).toTypedArray(), + Selector.Index(index), + *more.map(Selector::Index).toTypedArray(), ) override val isSingular: Boolean @@ -56,19 +133,60 @@ sealed interface Segment { override fun toString(): String = selectors.joinToString(",", prefix = "..[", postfix = "]") } + /** + * Contains useful factory functions + */ companion object { + /** + * Creates a new [ChildSegment] with the given selectors. + * + * @param selectors the selectors to use + * @return the child segment + * + * @see ChildSegment + * @see Selector + */ @JvmStatic fun child(selectors: List): Segment = ChildSegment(selectors) + /** + * Creates a new [ChildSegment] with the given selectors. + * + * @param selector the first selector + * @param more additional selectors, if any + * @return the child segment + * + * @see ChildSegment + * @see Selector + */ @JvmStatic fun child( selector: Selector, vararg more: Selector, ): Segment = ChildSegment(selector, *more) + /** + * Creates a new [DescendantSegment] with the given selectors. + * + * @param selectors the selectors to use + * @return the descendant segment + * + * @see DescendantSegment + * @see Selector + */ @JvmStatic fun descendant(selectors: List): Segment = DescendantSegment(selectors) + /** + * Creates a new [DescendantSegment] with the given selectors. + * + * @param selector the first selector + * @param more additional selectors, if any + * @return the descendant segment + * + * @see DescendantSegment + * @see Selector + */ @JvmStatic fun descendant( selector: Selector, diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt index 907d99b..2cc8e67 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt @@ -1,22 +1,59 @@ package com.kobil.vertx.jsonpath +/** + * A base interface for JSON Path selectors. + */ sealed interface Selector { + /** + * A selector matching fields with a specific name. + * + * @param name the field name to select + */ data class Name( val name: String, ) : Selector { override fun toString(): String = "'$name'" } + /** + * A selector matching everything. + */ data object Wildcard : Selector { override fun toString(): String = "*" } + /** + * A selector matching items with a specific index. + * + * @param index the index to select + */ data class Index( val index: Int, ) : Selector { override fun toString(): String = "$index" } + /** + * A selector matching a range of indices between [first] (inclusive) and [last] (exclusive) with + * a step size of [step]. For example, if `0 < first < last` and `step > 0`, then this selector + * will select `first + k * step < last` for all values of `k >= 0` satisfying the inequality. + * + * The [first] and [last] indices may be negative, which refers to the "`k`th-last" element of an + * array. For example, `-1` refers to the last element, `-2` refers to the second last element, + * and so on. The [step] may be negative to return elements in reverse order, if the [first] + * element is at a higher index than [last]. + * + * Each component may be `null`, which makes it use a default value: + * - [first]: the first element of the array in iteration order (if [step] is negative, this is + * the _last_ element of the array) + * - [last]: the index _after the last_ element of the array in iteration order (if [step] is + * negative, this is the _first_ element of the array) + * - [step]: Default 1 + * + * @param first the first index (inclusive) of the slice, may be null + * @param last the last index (exclusive) of the slice, may be null + * @param step the step size of the slice, may be null + */ data class Slice( val first: Int?, val last: Int?, @@ -26,26 +63,79 @@ sealed interface Selector { (first?.toString() ?: "") + ":" + (last?.toString() ?: "") + (step?.let { ":$it" } ?: "") } + /** + * A selector matching nodes for which the [filter] evaluates to `true`. + * + * @param filter the filter to apply to the candidates + */ data class Filter( val filter: FilterExpression, ) : Selector { override fun toString(): String = "?$filter" } + /** + * Contains convenience factory methods + */ companion object { + /** + * A selector matching everything. This is for Java users, in Kotlin it is equivalent to + * using [Wildcard]. + */ @JvmField val WILDCARD: Selector = Wildcard + /** + * Constructor taking a field name and returning a [Name] selector. + * + * @param name field name to select + * @return an equivalent [Name] selector + * + * @see Name + */ operator fun invoke(name: String): Selector = Name(name) + /** + * Factory taking a field name and returning a [Name] selector. + * + * @param name field name to select + * @return an equivalent [Name] selector + * + * @see Name + */ @JvmStatic fun name(name: String): Selector = Selector(name) + /** + * Constructor taking an index and returning an [Index] selector. + * + * @param index index to select + * @return an equivalent [Index] selector + * + * @see Index + */ operator fun invoke(index: Int): Selector = Index(index) + /** + * Factory taking an index and returning an [Index] selector. + * + * @param index index to select + * @return an equivalent [Index] selector + * + * @see Index + */ @JvmStatic fun index(index: Int): Selector = Selector(index) + /** + * Constructor taking an [IntProgression] and returning a [Slice] selector selecting the indices + * contained in the progression. + * + * @param slice indices to select + * @return an equivalent [Slice] selector + * + * @see Slice + */ operator fun invoke(slice: IntProgression): Selector = if (slice.step >= 0) { Slice(slice.first, slice.last + 1, slice.step) @@ -57,15 +147,46 @@ sealed interface Selector { ) } + /** + * Factory taking an [IntProgression] and returning a [Slice] selector selecting the indices + * contained in the progression. + * + * @param slice indices to select + * @return an equivalent [Slice] selector + * + * @see Slice + */ @JvmStatic fun slice(slice: IntProgression): Selector = Selector(slice) + /** + * Constructor taking the [first], [last] and [step] parameters and returning a [Slice] selector + * with the same parameters. + * + * @param firstInclusive the first index to include + * @param lastExclusive the first index to exclude + * @param step the step size + * @return an equivalent [Slice] selector + * + * @see Slice + */ operator fun invoke( firstInclusive: Int?, lastExclusive: Int?, step: Int? = null, ): Selector = Slice(firstInclusive, lastExclusive, step) + /** + * Factory taking the [first], [last] and [step] parameters and returning a [Slice] selector + * with the same parameters. + * + * @param firstInclusive the first index to include + * @param lastExclusive the first index to exclude + * @param step the step size + * @return an equivalent [Slice] selector + * + * @see Slice + */ @JvmStatic @JvmOverloads fun slice( @@ -74,8 +195,24 @@ sealed interface Selector { step: Int? = null, ): Selector = Selector(firstInclusive, lastExclusive, step) + /** + * Constructor taking a filter expression and returning a [Filter] selector. + * + * @param filter the filter expression to apply + * @return an equivalent [Filter] selector + * + * @see Filter + */ operator fun invoke(filter: FilterExpression): Selector = Filter(filter) + /** + * Factory taking a filter expression and returning a [Filter] selector. + * + * @param filter the filter expression to apply + * @return an equivalent [Filter] selector + * + * @see Filter + */ @JvmStatic fun filter(filter: FilterExpression): Selector = Selector(filter) } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Vertx.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Vertx.kt index 69eb603..be830e9 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Vertx.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Vertx.kt @@ -2,54 +2,124 @@ package com.kobil.vertx.jsonpath import arrow.core.Either import arrow.core.Option -import arrow.core.flatMap -import arrow.core.getOrElse -import arrow.core.left -import arrow.core.right import com.kobil.vertx.jsonpath.JsonPath.Companion.onlyValues import com.kobil.vertx.jsonpath.error.MultipleResults import com.kobil.vertx.jsonpath.error.RequiredJsonValueError import io.vertx.core.json.JsonArray import io.vertx.core.json.JsonObject +/** + * Queries the JSON object using the JSON path [path] and returns the single result, if any. If + * there are multiple results, an error is returned. + * + * @param path the JSON path query to use + * @return the result, if there is exactly one. None if there is no result. An error otherwise. + * + * @see JsonPath.getOne + */ inline operator fun JsonObject.get(path: JsonPath): Either> = - path.evaluateOne(this).map { node -> - node.map { it.value as T } - } + path.getOne(this) +/** + * Queries the JSON array using the JSON path [path] and returns the single result, if any. If + * there are multiple results, an error is returned. + * + * @param path the JSON path query to use + * @return the result, if there is exactly one. None if there is no result. An error otherwise. + * + * @see JsonPath.getOne + */ inline operator fun JsonArray.get(path: JsonPath): Either> = - path.evaluateOne(this).map { node -> - node.map { it.value as T } - } + path.getOne(this) -inline fun JsonObject.required(path: JsonPath): Either { - val maybeNode = path.evaluateOne(this) as Either> +/** + * Queries the JSON object using the JSON path [path] and returns the single result. If + * there are multiple results, an error is returned. If there is no result, an error is returned. + * + * @param path the JSON path query to use + * @return the result, if there is exactly one. An error otherwise. + * + * @see JsonPath.requireOne + */ +inline fun JsonObject.required(path: JsonPath): Either = + path.requireOne(this) - return maybeNode.flatMap { node -> - node.map { (it.value as T).right() }.getOrElse { RequiredJsonValueError.NoResult.left() } - } -} - -inline fun JsonArray.required(path: JsonPath): Either { - val maybeNode = path.evaluateOne(this) as Either> - - return maybeNode.flatMap { node -> - node.map { (it.value as T).right() }.getOrElse { RequiredJsonValueError.NoResult.left() } - } -} +/** + * Queries the JSON array using the JSON path [path] and returns the single result. If + * there are multiple results, an error is returned. If there is no result, an error is returned. + * + * @param path the JSON path query to use + * @return the result, if there is exactly one. An error otherwise. + * + * @see JsonPath.requireOne + */ +inline fun JsonArray.required(path: JsonPath): Either = + path.requireOne(this) +/** + * Queries the JSON object using the JSON path [path] and returns all results. + * + * @param path the JSON path query to use + * @return the results + * + * @see JsonPath.getAll + */ inline fun JsonObject.getAll(path: JsonPath): List = path.evaluate(this).onlyValues().map { it as T } +/** + * Queries the JSON array using the JSON path [path] and returns all results. + * + * @param path the JSON path query to use + * @return the results + * + * @see JsonPath.getAll + */ inline fun JsonArray.getAll(path: JsonPath): List = path.evaluate(this).onlyValues().map { it as T } +/** + * Queries the JSON object using the JSON path [path] and returns the position of the single result, + * if any. If there are multiple results, an error is returned. + * + * @param path the JSON path query to use + * @return the position of the result, if there is exactly one. None if there is no result. + * An error otherwise. + * + * @see JsonPath.traceOne + */ fun JsonObject.traceOne(path: JsonPath): Either> = path.traceOne(this) +/** + * Queries the JSON array using the JSON path [path] and returns the position of the single result, + * if any. If there are multiple results, an error is returned. + * + * @param path the JSON path query to use + * @return the position of the result, if there is exactly one. None if there is no result. + * An error otherwise. + * + * @see JsonPath.traceOne + */ fun JsonArray.traceOne(path: JsonPath): Either> = path.traceOne(this) +/** + * Queries the JSON object using the JSON path [path] and returns the positions of all results. + * + * @param path the JSON path query to use + * @return the positions of the results + * + * @see JsonPath.traceAll + */ fun JsonObject.traceAll(path: JsonPath): List = path.traceAll(this) +/** + * Queries the JSON object using the JSON path [path] and returns the positions of all results. + * + * @param path the JSON path query to use + * @return the positions of the results + * + * @see JsonPath.traceAll + */ fun JsonArray.traceAll(path: JsonPath): List = path.traceAll(this) diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt index f85a417..3455259 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathParser.kt @@ -300,7 +300,7 @@ private fun ParserState.basicLogicalExpr(): FilterExpression { } return when (lhs) { - is NodeListExpression -> FilterExpression.Existence(lhs) + is NodeListExpression -> FilterExpression.Test(lhs) is ComparableExpression.Literal -> raise( JsonPathError.UnexpectedToken(current!!, "basic logical expression"), diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Token.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Token.kt index 224e378..20858f4 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Token.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/Token.kt @@ -2,7 +2,7 @@ package com.kobil.vertx.jsonpath.compiler import com.kobil.vertx.jsonpath.FilterExpression -sealed interface Token { +internal sealed interface Token { val line: UInt val column: UInt val name: String diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt index 80c24ec..0828cf4 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt @@ -30,10 +30,12 @@ sealed interface JsonPathError { val startColumn: UInt, ) : JsonPathError { override fun toString(): String = - "${messagePrefix( - line, - column, - )}: Unterminated string literal starting at [$startLine:$startColumn]" + "${ + messagePrefix( + line, + column, + ) + }: Unterminated string literal starting at [$startLine:$startColumn]" } data class IntOutOfBounds( @@ -42,21 +44,34 @@ sealed interface JsonPathError { val column: UInt, ) : JsonPathError { override fun toString(): String = - "${messagePrefix( - line, - column, - )}: Invalid integer value (Out of bounds)" + "${ + messagePrefix( + line, + column, + ) + }: Invalid integer value (Out of bounds)" } data class UnexpectedToken( - val token: Token, + val token: String, + val line: UInt, + val column: UInt, val parsing: String, ) : JsonPathError { + internal constructor(token: Token, parsing: String) : this( + token.name, + token.line, + token.column, + parsing + ) + override fun toString(): String = - "${messagePrefix( - token.line, - token.column, - )}: Unexpected token '${token.name}' while parsing $parsing" + "${ + messagePrefix( + line, + column, + ) + }: Unexpected token '$token' while parsing $parsing" } data class IllegalSelector( diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt index 6ff05b6..cecbac1 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt @@ -22,7 +22,7 @@ fun FilterExpression.test( is FilterExpression.Or -> this@test.test(input, root) is FilterExpression.Not -> !operand.test(input, root) is FilterExpression.Comparison -> this@test.test(input, root) - is FilterExpression.Existence -> this@test.test(input, root) + is FilterExpression.Test -> this@test.test(input, root) is FilterExpression.Match -> this@test.test(input, root) } @@ -59,7 +59,7 @@ internal fun FilterExpression.Comparison.test( } } -internal fun FilterExpression.Existence.test( +internal fun FilterExpression.Test.test( input: JsonNode, root: JsonNode, ): Boolean = query.evaluate(input, root).isNotEmpty() diff --git a/src/test/java/com/kobil/vertx/jsonpath/JavaComparableExpressionTest.java b/src/test/java/com/kobil/vertx/jsonpath/JavaComparableExpressionTest.java deleted file mode 100644 index 9962024..0000000 --- a/src/test/java/com/kobil/vertx/jsonpath/JavaComparableExpressionTest.java +++ /dev/null @@ -1,79 +0,0 @@ -package com.kobil.vertx.jsonpath; - -import org.junit.jupiter.api.DisplayName; -import org.junit.jupiter.api.Nested; -import org.junit.jupiter.api.Test; - -import static org.junit.jupiter.api.Assertions.assertEquals; - -public class JavaComparableExpressionTest { - @Test - @DisplayName("The literalNull static function should return a Literal with null value") - public void literalNull() { - assertEquals( - new ComparableExpression.Literal(null), - ComparableExpression.literalNull() - ); - } - - @Nested - @DisplayName("The literal static function") - public class Literal { - @Test - @DisplayName("applied to an integer should return a Literal with the same value") - public void integer() { - assertEquals( - new ComparableExpression.Literal(1), - ComparableExpression.literal(1) - ); - - assertEquals( - new ComparableExpression.Literal(123), - ComparableExpression.literal(123) - ); - } - - @Test - @DisplayName("applied to a floating point number should return a Literal with the same value") - public void floatingPoint() { - assertEquals( - new ComparableExpression.Literal(1.5), - ComparableExpression.literal(1.5) - ); - - assertEquals( - new ComparableExpression.Literal(0.123), - ComparableExpression.literal(0.123) - ); - } - - @Test - @DisplayName("applied to a string should return a Literal with the same value") - public void string() { - assertEquals( - new ComparableExpression.Literal("a"), - ComparableExpression.literal("a") - ); - - assertEquals( - new ComparableExpression.Literal("hello world"), - ComparableExpression.literal("hello world") - ); - } - - @Test - @DisplayName("applied to a boolean should return a Literal with the same value") - public void bool() { - assertEquals( - new ComparableExpression.Literal(true), - ComparableExpression.literal(true) - ); - - assertEquals( - new ComparableExpression.Literal(false), - ComparableExpression.literal(false) - ); - } - } - -} diff --git a/src/test/java/com/kobil/vertx/jsonpath/JavaFilterExpressionTest.java b/src/test/java/com/kobil/vertx/jsonpath/JavaFilterExpressionTest.java index 10dff12..4fbe42c 100644 --- a/src/test/java/com/kobil/vertx/jsonpath/JavaFilterExpressionTest.java +++ b/src/test/java/com/kobil/vertx/jsonpath/JavaFilterExpressionTest.java @@ -1,7 +1,6 @@ package com.kobil.vertx.jsonpath; import arrow.core.Either; -import com.kobil.vertx.jsonpath.compiler.Token; import com.kobil.vertx.jsonpath.error.JsonPathError; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Test; @@ -14,17 +13,17 @@ public class JavaFilterExpressionTest { @DisplayName("A call to the compile static method with a valid filter expression should return a Right containing the compiled filter") public void success() { var filterA = assertInstanceOf(Either.Right.class, FilterExpression.compile("@.a")).getValue(); - assertEquals(new FilterExpression.Existence(QueryExpression.relative().field("a")), filterA); + assertEquals(new FilterExpression.Test(QueryExpression.relative().field("a")), filterA); var filterB = assertInstanceOf(Either.Right.class, FilterExpression.compile("$['b']")).getValue(); - assertEquals(new FilterExpression.Existence(QueryExpression.absolute().field("b")), filterB); + assertEquals(new FilterExpression.Test(QueryExpression.absolute().field("b")), filterB); } @Test @DisplayName("A call to the compile static method with an invalid filter string should return a Left") public void failure() { - assertInstanceOf( - Token.QuestionMark.class, + assertEquals( + "QuestionMark", assertInstanceOf( JsonPathError.UnexpectedToken.class, assertInstanceOf(Either.Left.class, FilterExpression.compile("?@.abc")).getValue() diff --git a/src/test/java/com/kobil/vertx/jsonpath/JavaJsonPathTest.java b/src/test/java/com/kobil/vertx/jsonpath/JavaJsonPathTest.java index ff36ab5..19607bb 100644 --- a/src/test/java/com/kobil/vertx/jsonpath/JavaJsonPathTest.java +++ b/src/test/java/com/kobil/vertx/jsonpath/JavaJsonPathTest.java @@ -1,7 +1,6 @@ package com.kobil.vertx.jsonpath; import arrow.core.Either; -import com.kobil.vertx.jsonpath.compiler.Token; import com.kobil.vertx.jsonpath.error.JsonPathError; import org.junit.jupiter.api.DisplayName; import org.junit.jupiter.api.Test; @@ -30,8 +29,8 @@ public void success() { @Test @DisplayName("A call to the compile static method with an invalid JSON Path string should return a Left") public void failure() { - assertInstanceOf( - Token.QuestionMark.class, + assertEquals( + "QuestionMark", assertInstanceOf( JsonPathError.UnexpectedToken.class, assertInstanceOf(Either.Left.class, JsonPath.compile("?.abc")).getValue() diff --git a/src/test/java/com/kobil/vertx/jsonpath/JavaSelectorTest.java b/src/test/java/com/kobil/vertx/jsonpath/JavaSelectorTest.java index 4e645cd..14b7691 100644 --- a/src/test/java/com/kobil/vertx/jsonpath/JavaSelectorTest.java +++ b/src/test/java/com/kobil/vertx/jsonpath/JavaSelectorTest.java @@ -1,7 +1,6 @@ package com.kobil.vertx.jsonpath; import com.kobil.vertx.jsonpath.FilterExpression.Comparison; -import com.kobil.vertx.jsonpath.FilterExpression.Existence; import com.kobil.vertx.jsonpath.FilterExpression.Not; import com.kobil.vertx.jsonpath.QueryExpression.Relative; import com.kobil.vertx.jsonpath.Segment.ChildSegment; @@ -67,7 +66,7 @@ public void threeInts() { @Test @DisplayName("The filter static function should return a Filter selector with the given filter expression") public void filter() { - var expr1 = new Existence(new Relative(new ChildSegment("a"))); + var expr1 = new FilterExpression.Test(new Relative(new ChildSegment("a"))); var expr2 = new FilterExpression.Or( nonEmptyListOf( new Comparison( @@ -75,7 +74,7 @@ public void filter() { new Relative(new ChildSegment("a")), new ComparableExpression.Literal(1) ), - new Not(new Existence(new Relative(new ChildSegment("a")))) + new Not(new FilterExpression.Test(new Relative(new ChildSegment("a")))) ) ); diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/ComparableExpressionTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/ComparableExpressionTest.kt index 194ad64..ce04bba 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/ComparableExpressionTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/ComparableExpressionTest.kt @@ -90,46 +90,6 @@ class ComparableExpressionTest : } } - context("The literal static function") { - context("applied to an integer") { - should("return a Literal with the same value") { - checkAll(Arb.int()) { - ComparableExpression.literal(it) shouldBe ComparableExpression.Literal(it) - } - } - } - - context("applied to a floating point number") { - should("return a Literal with the same value") { - checkAll(Arb.double()) { - ComparableExpression.literal(it) shouldBe ComparableExpression.Literal(it) - } - } - } - - context("applied to a string") { - should("return a Literal with the same value") { - checkAll(Arb.string()) { - ComparableExpression.literal(it) shouldBe ComparableExpression.Literal(it) - } - } - } - - context("applied to a boolean") { - should("return a Literal with the same value") { - checkAll(Arb.boolean()) { - ComparableExpression.literal(it) shouldBe ComparableExpression.Literal(it) - } - } - } - } - - context("The literalNull static function") { - should("return a Literal with null value") { - ComparableExpression.literalNull() shouldBe ComparableExpression.Literal(null) - } - } - context("The toString method") { context("of a Literal instance") { should("wrap a string value in double quotes") { diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt index b6851de..4d10b2b 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/FilterExpressionTest.kt @@ -5,10 +5,10 @@ import com.kobil.vertx.jsonpath.ComparableExpression.Literal import com.kobil.vertx.jsonpath.FilterExpression.And import com.kobil.vertx.jsonpath.FilterExpression.Comparison import com.kobil.vertx.jsonpath.FilterExpression.Comparison.Op -import com.kobil.vertx.jsonpath.FilterExpression.Existence import com.kobil.vertx.jsonpath.FilterExpression.Match import com.kobil.vertx.jsonpath.FilterExpression.Not import com.kobil.vertx.jsonpath.FilterExpression.Or +import com.kobil.vertx.jsonpath.FilterExpression.Test import com.kobil.vertx.jsonpath.QueryExpression.Absolute import com.kobil.vertx.jsonpath.QueryExpression.Relative import com.kobil.vertx.jsonpath.compiler.Token @@ -127,31 +127,31 @@ class FilterExpressionTest : should("compile successfully") { FilterExpression.compile(hasA) shouldBeRight - Existence( + Test( Relative(listOf(Segment.ChildSegment("a"))), ) FilterExpression.compile(hasB) shouldBeRight - Existence( + Test( Relative(listOf(Segment.ChildSegment("b"))), ) FilterExpression.compile(has1) shouldBeRight - Existence( + Test( Relative(listOf(Segment.ChildSegment(1))), ) FilterExpression.compile(hasNestedA) shouldBeRight - Existence( + Test( Relative(listOf(Segment.DescendantSegment("a"))), ) FilterExpression.compile(hasNestedB) shouldBeRight - Existence( + Test( Relative(listOf(Segment.DescendantSegment("b"))), ) FilterExpression.compile(hasNested1) shouldBeRight - Existence( + Test( Relative(listOf(Segment.DescendantSegment(1))), ) } @@ -275,7 +275,7 @@ class FilterExpressionTest : val f1 = Or( nel( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -284,7 +284,7 @@ class FilterExpressionTest : ), ) - val f2 = Existence(Relative()["b"]) + val f2 = Test(Relative()["b"]) val f3 = Match( @@ -293,7 +293,7 @@ class FilterExpressionTest : true, ) - val f4 = Not(Existence(Absolute()["d"])) + val f4 = Not(Test(Absolute()["d"])) val f5 = Comparison( @@ -315,7 +315,7 @@ class FilterExpressionTest : val f1 = Or( nel( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -324,7 +324,7 @@ class FilterExpressionTest : ), ) - val f2 = Existence(Relative()["b"]) + val f2 = Test(Relative()["b"]) val f3 = Match( @@ -333,7 +333,7 @@ class FilterExpressionTest : true, ) - val f4 = Not(Existence(Absolute()["d"])) + val f4 = Not(Test(Absolute()["d"])) val f5 = Comparison( @@ -355,7 +355,7 @@ class FilterExpressionTest : val f1 = Or( nel( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -364,7 +364,7 @@ class FilterExpressionTest : ), ) - val f2 = Existence(Relative()["b"]) + val f2 = Test(Relative()["b"]) val f3 = Match( @@ -373,7 +373,7 @@ class FilterExpressionTest : true, ) - val f4 = Not(Existence(Absolute()["d"])) + val f4 = Not(Test(Absolute()["d"])) val f5 = Comparison( @@ -393,7 +393,7 @@ class FilterExpressionTest : val f1 = Or( nel( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -402,7 +402,7 @@ class FilterExpressionTest : ), ) - val f2 = Existence(Relative()["b"]) + val f2 = Test(Relative()["b"]) val f3 = Match( @@ -426,7 +426,7 @@ class FilterExpressionTest : val f1 = And( nel( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -435,7 +435,7 @@ class FilterExpressionTest : ), ) - val f2 = Existence(Relative()["b"]) + val f2 = Test(Relative()["b"]) val f3 = Match( @@ -444,7 +444,7 @@ class FilterExpressionTest : true, ) - val f4 = Not(Existence(Absolute()["d"])) + val f4 = Not(Test(Absolute()["d"])) val f5 = Comparison( @@ -466,7 +466,7 @@ class FilterExpressionTest : val f1 = And( nel( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -475,7 +475,7 @@ class FilterExpressionTest : ), ) - val f2 = Existence(Relative()["b"]) + val f2 = Test(Relative()["b"]) val f3 = Match( @@ -484,7 +484,7 @@ class FilterExpressionTest : true, ) - val f4 = Not(Existence(Absolute()["d"])) + val f4 = Not(Test(Absolute()["d"])) val f5 = Comparison( @@ -506,7 +506,7 @@ class FilterExpressionTest : val f1 = And( nel( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -515,7 +515,7 @@ class FilterExpressionTest : ), ) - val f2 = Existence(Relative()["b"]) + val f2 = Test(Relative()["b"]) val f3 = Match( @@ -524,7 +524,7 @@ class FilterExpressionTest : true, ) - val f4 = Not(Existence(Absolute()["d"])) + val f4 = Not(Test(Absolute()["d"])) val f5 = Comparison( @@ -544,7 +544,7 @@ class FilterExpressionTest : val f1 = And( nel( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -553,7 +553,7 @@ class FilterExpressionTest : ), ) - val f2 = Existence(Relative()["b"]) + val f2 = Test(Relative()["b"]) val f3 = Match( @@ -577,7 +577,7 @@ class FilterExpressionTest : val f1 = And( nel( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -586,7 +586,7 @@ class FilterExpressionTest : ), ) - val f2 = Existence(Relative()["b"]) + val f2 = Test(Relative()["b"]) val f3 = Match( @@ -619,7 +619,7 @@ class FilterExpressionTest : val f1 = And( nel( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -628,7 +628,7 @@ class FilterExpressionTest : ), ) - val f2 = Existence(Relative()["b"]) + val f2 = Test(Relative()["b"]) val f3 = Match( @@ -649,7 +649,7 @@ class FilterExpressionTest : should("concatenate the serialized operands with &&, parenthesizing Or instances") { val f1 = Or( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -657,7 +657,7 @@ class FilterExpressionTest : ), ) - val f2 = Existence(Relative()["b"]) + val f2 = Test(Relative()["b"]) val f3 = Match( @@ -666,7 +666,7 @@ class FilterExpressionTest : true, ) - val f4 = Not(Existence(Absolute()["d"])) + val f4 = Not(Test(Absolute()["d"])) val f5 = Comparison( @@ -685,7 +685,7 @@ class FilterExpressionTest : should("concatenate the serialized operands with ||") { val f1 = And( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -693,7 +693,7 @@ class FilterExpressionTest : ), ) - val f2 = Existence(Relative()["b"]) + val f2 = Test(Relative()["b"]) val f3 = Match( @@ -702,7 +702,7 @@ class FilterExpressionTest : true, ) - val f4 = Not(Existence(Absolute()["d"])) + val f4 = Not(Test(Absolute()["d"])) val f5 = Comparison( @@ -723,7 +723,7 @@ class FilterExpressionTest : ) { val f1 = And( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -733,7 +733,7 @@ class FilterExpressionTest : val f2 = Or( - Existence(Relative()["a"]), + Test(Relative()["a"]), Comparison( Op.LESS, Literal(1), @@ -741,7 +741,7 @@ class FilterExpressionTest : ), ) - val f3 = Existence(Relative()["b"]) + val f3 = Test(Relative()["b"]) val f4 = Match( @@ -768,7 +768,7 @@ class FilterExpressionTest : context("of an Existence expression") { should("return the serialized query") { checkAll(Arb.queryExpression()) { - Existence(it).toString() shouldBe it.toString() + Test(it).toString() shouldBe it.toString() } } } diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathQueryTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathQueryTest.kt index a6e33c8..6bc482c 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathQueryTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathQueryTest.kt @@ -1,6 +1,6 @@ package com.kobil.vertx.jsonpath -import com.kobil.vertx.jsonpath.FilterExpression.Existence +import com.kobil.vertx.jsonpath.FilterExpression.Test import com.kobil.vertx.jsonpath.QueryExpression.Relative import com.kobil.vertx.jsonpath.Segment.ChildSegment import com.kobil.vertx.jsonpath.Segment.DescendantSegment @@ -93,7 +93,7 @@ class JsonPathQueryTest : val i = Selector.index(idx) val w = Selector.Wildcard val s = Selector.slice(first, last, step) - val f = Selector.filter(Existence(Relative()["a"])) + val f = Selector.filter(Test(Relative()["a"])) QueryExpression.absolute()[n].segments shouldBe listOf( @@ -138,7 +138,7 @@ class JsonPathQueryTest : val i = Selector.index(idx) val w = Selector.Wildcard val s = Selector.slice(first, last, step) - val f = Selector.filter(Existence(Relative()["a"])) + val f = Selector.filter(Test(Relative()["a"])) QueryExpression.absolute().selectChildren(n).segments shouldBe listOf( @@ -194,7 +194,7 @@ class JsonPathQueryTest : val i = Selector.index(idx) val w = Selector.Wildcard val s = Selector.slice(first, last, step) - val f = Selector.filter(Existence(Relative()["a"])) + val f = Selector.filter(Test(Relative()["a"])) QueryExpression.absolute().selectDescendants(n).segments shouldBe listOf( diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt index 9d2c612..29903ec 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/JsonPathTest.kt @@ -1,6 +1,6 @@ package com.kobil.vertx.jsonpath -import com.kobil.vertx.jsonpath.FilterExpression.Existence +import com.kobil.vertx.jsonpath.FilterExpression.Test import com.kobil.vertx.jsonpath.JsonPath.Companion.onlyPaths import com.kobil.vertx.jsonpath.QueryExpression.Relative import com.kobil.vertx.jsonpath.Segment.ChildSegment @@ -790,7 +790,7 @@ class JsonPathTest : val i = Selector.index(idx) val w = Selector.Wildcard val s = Selector.slice(first, last, step) - val f = Selector.filter(Existence(Relative()["a"])) + val f = Selector.filter(Test(Relative()["a"])) JsonPath[n].segments shouldBe listOf( diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/SelectorTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/SelectorTest.kt index b18ca1b..06109ec 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/SelectorTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/SelectorTest.kt @@ -3,9 +3,9 @@ package com.kobil.vertx.jsonpath import arrow.core.nonEmptyListOf import com.kobil.vertx.jsonpath.ComparableExpression.Literal import com.kobil.vertx.jsonpath.FilterExpression.Comparison -import com.kobil.vertx.jsonpath.FilterExpression.Existence import com.kobil.vertx.jsonpath.FilterExpression.Not import com.kobil.vertx.jsonpath.FilterExpression.Or +import com.kobil.vertx.jsonpath.FilterExpression.Test import com.kobil.vertx.jsonpath.QueryExpression.Relative import com.kobil.vertx.jsonpath.Segment.ChildSegment import io.kotest.core.spec.style.ShouldSpec @@ -80,7 +80,7 @@ class SelectorTest : should("return the serialized filter expression preceded by a question mark") { Selector .Filter( - Existence( + Test( Relative(ChildSegment(Selector.Name("a"))), ), ).toString() shouldBe "?@['a']" @@ -133,7 +133,7 @@ class SelectorTest : context("called on a filter expression") { should("return a filter selector with the given filter expression") { - val expr1 = Existence(Relative(ChildSegment("a"))) + val expr1 = Test(Relative(ChildSegment("a"))) val expr2 = Or( nonEmptyListOf( @@ -142,7 +142,7 @@ class SelectorTest : Relative(ChildSegment("a")), Literal(1), ), - Not(Existence(Relative(ChildSegment("a")))), + Not(Test(Relative(ChildSegment("a")))), ), ) @@ -198,7 +198,7 @@ class SelectorTest : context("the filter static function") { should("return a filter selector with the given filter expression") { - val expr1 = Existence(Relative(ChildSegment("a"))) + val expr1 = Test(Relative(ChildSegment("a"))) val expr2 = Or( nonEmptyListOf( @@ -207,7 +207,7 @@ class SelectorTest : Relative(ChildSegment("a")), Literal(1), ), - Not(Existence(Relative(ChildSegment("a")))), + Not(Test(Relative(ChildSegment("a")))), ), ) From ddfbadd234d6ec69a8427cf5d85b9b59554d7381 Mon Sep 17 00:00:00 2001 From: Johannes Leupold Date: Tue, 15 Oct 2024 15:33:27 +0200 Subject: [PATCH 7/7] More documentation, remove project files --- .gitignore | 12 +- .idea/.gitignore | 3 - .idea/codeStyles/Project.xml | 7 - .idea/codeStyles/codeStyleConfig.xml | 5 - .idea/gradle.xml | 17 --- .idea/inspectionProfiles/Project_Default.xml | 6 - .idea/kotlinc.xml | 6 - .idea/misc.xml | 51 ------- .idea/scala_compiler.xml | 6 - .idea/vcs.xml | 7 - build.gradle.kts | 70 +++++++++- .../vertx/jsonpath/ComparableExpression.kt | 6 + .../kobil/vertx/jsonpath/FilterExpression.kt | 55 +++++++- .../vertx/jsonpath/FunctionExpression.kt | 9 ++ .../com/kobil/vertx/jsonpath/JsonPath.kt | 3 + .../kobil/vertx/jsonpath/QueryExpression.kt | 6 + .../com/kobil/vertx/jsonpath/Segment.kt | 6 + .../com/kobil/vertx/jsonpath/Selector.kt | 15 +++ .../jsonpath/compiler/JsonPathCompiler.kt | 34 +++++ .../jsonpath/compiler/JsonPathScanner.kt | 2 +- .../vertx/jsonpath/error/JsonPathError.kt | 127 ++++++++++++++++-- .../vertx/jsonpath/error/JsonPathException.kt | 7 +- .../vertx/jsonpath/error/MultipleResults.kt | 13 ++ .../jsonpath/error/RequiredJsonValueError.kt | 10 ++ .../jsonpath/interpreter/FilterExpressions.kt | 13 ++ .../vertx/jsonpath/interpreter/Segments.kt | 25 ++++ .../vertx/jsonpath/interpreter/Selectors.kt | 15 ++- .../vertx/jsonpath/error/JsonPathErrorTest.kt | 12 +- 28 files changed, 399 insertions(+), 149 deletions(-) delete mode 100644 .idea/.gitignore delete mode 100644 .idea/codeStyles/Project.xml delete mode 100644 .idea/codeStyles/codeStyleConfig.xml delete mode 100644 .idea/gradle.xml delete mode 100644 .idea/inspectionProfiles/Project_Default.xml delete mode 100644 .idea/kotlinc.xml delete mode 100644 .idea/misc.xml delete mode 100644 .idea/scala_compiler.xml delete mode 100644 .idea/vcs.xml diff --git a/.gitignore b/.gitignore index 3348a20..06bf5d0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,20 +1,12 @@ .gradle +.kotlin build/ !gradle/wrapper/gradle-wrapper.jar !**/src/main/**/build/ !**/src/test/**/build/ ### IntelliJ IDEA ### -.idea/modules.xml -.idea/jarRepositories.xml -.idea/compiler.xml -.idea/libraries/ -*.iws -*.iml -*.ipr -out/ -!**/src/main/**/out/ -!**/src/test/**/out/ +.idea ### Eclipse ### .apt_generated diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index 26d3352..0000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml deleted file mode 100644 index 919ce1f..0000000 --- a/.idea/codeStyles/Project.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml deleted file mode 100644 index a55e7a1..0000000 --- a/.idea/codeStyles/codeStyleConfig.xml +++ /dev/null @@ -1,5 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/gradle.xml b/.idea/gradle.xml deleted file mode 100644 index 50a1fae..0000000 --- a/.idea/gradle.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - \ No newline at end of file diff --git a/.idea/inspectionProfiles/Project_Default.xml b/.idea/inspectionProfiles/Project_Default.xml deleted file mode 100644 index b9bf187..0000000 --- a/.idea/inspectionProfiles/Project_Default.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/kotlinc.xml b/.idea/kotlinc.xml deleted file mode 100644 index 6d0ee1c..0000000 --- a/.idea/kotlinc.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml deleted file mode 100644 index d074712..0000000 --- a/.idea/misc.xml +++ /dev/null @@ -1,51 +0,0 @@ - - - - - - - - - - - \ No newline at end of file diff --git a/.idea/scala_compiler.xml b/.idea/scala_compiler.xml deleted file mode 100644 index 3c0e0f6..0000000 --- a/.idea/scala_compiler.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index 2543e09..0000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts index 9d9cb3b..81d05bb 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,14 +1,21 @@ +import org.jetbrains.dokka.gradle.DokkaTask + plugins { kotlin("jvm") version "2.0.0" + `java-library` + `maven-publish` + id("org.jetbrains.kotlinx.kover") id("org.sonarqube") version "3.5.0.2730" + id("org.jetbrains.dokka") version "1.9.20" + id("org.jlleitschuh.gradle.ktlint") } group = "com.kobil.vertx" -version = "1.0.0" +version = "1.0.0-SNAPSHOT" repositories { mavenCentral() @@ -53,7 +60,15 @@ tasks.test { } kotlin { - jvmToolchain(21) + jvmToolchain(17) + + compilerOptions { + allWarningsAsErrors.set(true) + } +} + +java { + withSourcesJar() } ktlint { @@ -69,3 +84,54 @@ kover { } } } + +tasks.withType().configureEach { + suppressObviousFunctions.set(true) + failOnWarning.set(true) + + dokkaSourceSets.configureEach { + reportUndocumented.set(true) + } +} + +val dokkaJavadocJar: Jar by tasks.creating(Jar::class) { + group = "documentation" + + dependsOn(tasks.dokkaJavadoc) + from(tasks.dokkaJavadoc.flatMap { it.outputDirectory }) + archiveClassifier.set("javadoc") +} + +tasks.assemble.configure { + dependsOn(dokkaJavadocJar) +} + +val documentationElements: Configuration by configurations.creating { + outgoing { + artifact(dokkaJavadocJar) { + type = "jar" + classifier = "javadoc" + builtBy(dokkaJavadocJar) + } + } + + attributes { + attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category::class, Category.DOCUMENTATION)) + attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling::class, Bundling.EXTERNAL)) + attribute(DocsType.DOCS_TYPE_ATTRIBUTE, objects.named(DocsType::class, DocsType.JAVADOC)) + attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage::class, Usage.JAVA_RUNTIME)) + } +} + +components.getByName("java") { + addVariantsFromConfiguration(documentationElements) {} +} + +publishing { + publications { + create("vertx-json-path") { + artifactId = "vertx-json-path" + from(components["java"]) + } + } +} diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/ComparableExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/ComparableExpression.kt index 78b3a6b..711aecc 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/ComparableExpression.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/ComparableExpression.kt @@ -152,10 +152,16 @@ sealed interface ComparableExpression { /** * A literal expression, which may be an integer, floating point number, string, * boolean or `null`. + * + * @param value the literal value, can be any JSON value */ data class Literal( val value: Any?, ) : ComparableExpression { + /** + * Returns the literal value as a string. If the value itself is a string, it is enclosed in + * double quotes. + */ override fun toString(): String = when (value) { null -> "null" diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/FilterExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/FilterExpression.kt index 8bebc7f..17bd163 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/FilterExpression.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/FilterExpression.kt @@ -15,7 +15,7 @@ import io.vertx.core.json.JsonObject * A base type for filter expressions which may be used in a filter selector, * or on its own as a predicate. */ -sealed interface FilterExpression { +sealed class FilterExpression { /** * Tests whether this filter expression matches the given JSON object. * @@ -87,7 +87,7 @@ sealed interface FilterExpression { */ data class And( val operands: NonEmptyList, - ) : FilterExpression { + ) : FilterExpression() { /** * An alternative constructor, taking the operands as varargs. * @@ -103,6 +103,9 @@ sealed interface FilterExpression { nonEmptyListOf(firstOperand, secondOperand, *moreOperands), ) + /** + * Returns the JSON path representation of this And expression. + */ override fun toString(): String = operands.joinToString(" && ") { if (it is Or) { @@ -120,7 +123,7 @@ sealed interface FilterExpression { */ data class Or( val operands: NonEmptyList, - ) : FilterExpression { + ) : FilterExpression() { /** * An alternative constructor, taking the operands as varargs. * @@ -136,6 +139,9 @@ sealed interface FilterExpression { nonEmptyListOf(firstOperand, secondOperand, *moreOperands), ) + /** + * Returns the JSON path representation of this Or expression. + */ override fun toString(): String = operands.joinToString(" || ") } @@ -146,7 +152,10 @@ sealed interface FilterExpression { */ data class Not( val operand: FilterExpression, - ) : FilterExpression { + ) : FilterExpression() { + /** + * Returns the JSON path representation of this Not expression. + */ override fun toString(): String = if (operand is Comparison || operand is And || operand is Or) { "!($operand)" @@ -166,7 +175,7 @@ sealed interface FilterExpression { val op: Op, val lhs: ComparableExpression, val rhs: ComparableExpression, - ) : FilterExpression { + ) : FilterExpression() { /** * A comparison operator. * @@ -175,11 +184,34 @@ sealed interface FilterExpression { enum class Op( val str: String, ) { + /** + * The '==' operator + */ EQ("=="), + + /** + * The '"="=' operator + */ NOT_EQ("!="), + + /** + * The '<' operator + */ LESS("<"), + + /** + * The '<=' operator + */ LESS_EQ("<="), + + /** + * The '>' operator + */ GREATER(">"), + + /** + * The '>=' operator + */ GREATER_EQ(">="), ; @@ -198,6 +230,9 @@ sealed interface FilterExpression { } } + /** + * Returns the JSON path representation of this comparison expression. + */ override fun toString(): String = "$lhs ${op.str} $rhs" /** @@ -289,7 +324,10 @@ sealed interface FilterExpression { */ data class Test( val query: NodeListExpression, - ) : FilterExpression { + ) : FilterExpression() { + /** + * Returns the JSON path representation of this Test expression, i.e. the serialized query + */ override fun toString(): String = "$query" } @@ -308,7 +346,10 @@ sealed interface FilterExpression { val subject: ComparableExpression, val pattern: ComparableExpression, val matchEntire: Boolean, - ) : FilterExpression { + ) : FilterExpression() { + /** + * Returns the JSON path representation of this function expression. + */ override fun toString(): String { val name = if (matchEntire) "match" else "search" diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/FunctionExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/FunctionExpression.kt index 7f69f4c..7e77885 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/FunctionExpression.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/FunctionExpression.kt @@ -15,6 +15,9 @@ sealed interface FunctionExpression : ComparableExpression { data class Length( val arg: ComparableExpression, ) : FunctionExpression { + /** + * Returns the JSON path representation of this function expression. + */ override fun toString(): String = "length($arg)" } @@ -28,6 +31,9 @@ sealed interface FunctionExpression : ComparableExpression { data class Count( val arg: NodeListExpression, ) : FunctionExpression { + /** + * Returns the JSON path representation of this function expression. + */ override fun toString(): String = "count($arg)" } @@ -42,6 +48,9 @@ sealed interface FunctionExpression : ComparableExpression { data class Value( val arg: NodeListExpression, ) : FunctionExpression { + /** + * Returns the JSON path representation of this function expression. + */ override fun toString(): String = "value($arg)" } } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt index a1c51de..411e7f2 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/JsonPath.kt @@ -147,6 +147,9 @@ data class JsonPath internal constructor( override operator fun plus(additionalSegments: Iterable): JsonPath = copy(segments = this.segments + additionalSegments) + /** + * Serializes this JSON path to the corresponding string representation. + */ override fun toString(): String = segments.joinToString("", prefix = "$") /** diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/QueryExpression.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/QueryExpression.kt index e8c91ce..2565e88 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/QueryExpression.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/QueryExpression.kt @@ -49,6 +49,9 @@ sealed interface QueryExpression> : override operator fun plus(additionalSegments: Iterable): Relative = copy(segments = this.segments + additionalSegments) + /** + * Serializes this query to the corresponding string representation + */ override fun toString(): String = segments.joinToString("", prefix = "@") } @@ -78,6 +81,9 @@ sealed interface QueryExpression> : override operator fun plus(additionalSegments: Iterable): Absolute = copy(segments = this.segments + additionalSegments) + /** + * Serializes this query to the corresponding string representation + */ override fun toString(): String = segments.joinToString("", prefix = "$") } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt index d5b17bc..29a3771 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Segment.kt @@ -74,6 +74,9 @@ sealed interface Segment { selectors.size == 1 && (selectors.first() is Selector.Name || selectors.first() is Selector.Index) + /** + * Serializes this segment to the corresponding JSON path representation + */ override fun toString(): String = selectors.joinToString(",", prefix = "[", postfix = "]") } @@ -130,6 +133,9 @@ sealed interface Segment { override val isSingular: Boolean get() = false + /** + * Serializes this segment to the corresponding JSON path representation + */ override fun toString(): String = selectors.joinToString(",", prefix = "..[", postfix = "]") } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt index 2cc8e67..9bce6ae 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/Selector.kt @@ -12,6 +12,9 @@ sealed interface Selector { data class Name( val name: String, ) : Selector { + /** + * Serializes this selector to the corresponding JSON path representation + */ override fun toString(): String = "'$name'" } @@ -19,6 +22,9 @@ sealed interface Selector { * A selector matching everything. */ data object Wildcard : Selector { + /** + * Serializes this selector to the corresponding JSON path representation + */ override fun toString(): String = "*" } @@ -30,6 +36,9 @@ sealed interface Selector { data class Index( val index: Int, ) : Selector { + /** + * Serializes this selector to the corresponding JSON path representation + */ override fun toString(): String = "$index" } @@ -59,6 +68,9 @@ sealed interface Selector { val last: Int?, val step: Int?, ) : Selector { + /** + * Serializes this selector to the corresponding JSON path representation + */ override fun toString(): String = (first?.toString() ?: "") + ":" + (last?.toString() ?: "") + (step?.let { ":$it" } ?: "") } @@ -71,6 +83,9 @@ sealed interface Selector { data class Filter( val filter: FilterExpression, ) : Selector { + /** + * Serializes this selector to the corresponding JSON path representation + */ override fun toString(): String = "?$filter" } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt index a56ee4b..499c54d 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathCompiler.kt @@ -7,6 +7,10 @@ import com.kobil.vertx.jsonpath.FilterExpression import com.kobil.vertx.jsonpath.JsonPath import com.kobil.vertx.jsonpath.error.JsonPathError +/** + * An interface to the JSON Path compiler, caching results of compilation request. It backs the + * implementation of [JsonPath.compile] and [FilterExpression.compile]. + */ object JsonPathCompiler { private val queryCache: LoadingCache> = Caffeine @@ -20,9 +24,39 @@ object JsonPathCompiler { .maximumSize(1_000) .build { filterExpression -> filterExpression.scanTokens().parseJsonPathFilter() } + /** + * Compiles a filter expression string. It will return an instance of [Either.Right] containing + * the compiled [JsonPath] if the compilation was successful. Otherwise, an error wrapped in an + * instance of [Either.Left] is returned. + * + * The result of up to 1000 compilations is cached for performance reasons. + * + * @param jsonPath the JSON Path string + * @return the compiled [JsonPath], or an error + * + * @see JsonPath.compile + * @see JsonPathError + */ + @JvmStatic fun compileJsonPathQuery(jsonPath: String): Either = queryCache.get(jsonPath) + /** + * Compiles a filter expression string. It will return an instance of [Either.Right] containing + * the compiled expression if the compilation was successful. Otherwise, an error wrapped in an + * instance of [Either.Left] is returned. + * + * Filter expression strings must not have a leading `?`. + * + * The result of up to 1000 compilations is cached for performance reasons. + * + * @param filterExpression the filter expression string without leading `?` + * @return the compiled filter expression, or an error + * + * @see FilterExpression.compile + * @see JsonPathError + */ + @JvmStatic fun compileJsonPathFilter(filterExpression: String): Either = filterCache.get(filterExpression) } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt index b9dea18..90fc800 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/compiler/JsonPathScanner.kt @@ -282,7 +282,7 @@ private fun ScannerState.expect( if (advanceIf(next)) { ifMatch() } else if (isAtEnd()) { - raise(JsonPathError.PrematureEof("'$next'", line, column)) + raise(JsonPathError.UnexpectedEof("'$next'", line, column)) } else { raise(JsonPathError.IllegalCharacter(expr[current], line, column, "Expected '$next'")) } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt index 0828cf4..9e8575d 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathError.kt @@ -3,32 +3,68 @@ package com.kobil.vertx.jsonpath.error import com.kobil.vertx.jsonpath.compiler.Token import kotlinx.coroutines.CancellationException +/** + * The base type for JSON Path compiler errors. + */ sealed interface JsonPathError { - data class PrematureEof( + /** + * The input (JSON Path string) ended unexpectedly. + * + * @param expected the expected element when the EOF occurred + * @param line the line number at which the string ended + * @param column the column number within the line at which the string ended + */ + data class UnexpectedEof( val expected: String, val line: UInt, val column: UInt, ) : JsonPathError { + /** + * Serializes this error to a readable string message + */ override fun toString(): String = "${messagePrefix(line, column)}: Premature end of input, expected $expected" } + /** + * The compiler encountered a character in the input string that was invalid in the current + * context. + * + * @param char the illegal character + * @param line the line of the invalid character + * @param column the column of the invalid character + * @param reason information why the character was invalid + */ data class IllegalCharacter( val char: Char, val line: UInt, val column: UInt, val reason: String, ) : JsonPathError { + /** + * Serializes this error to a readable string message + */ override fun toString(): String = "${messagePrefix(line, column)}: Illegal character '$char' ($reason)" } + /** + * Some quoted string was missing the closing quote. + * + * @param line the line where the error was detected + * @param column the column where the error was detected + * @param startLine the line where the opening quote was located + * @param startColumn the column where the opening quote was located + */ data class UnterminatedString( val line: UInt, val column: UInt, val startLine: UInt, val startColumn: UInt, ) : JsonPathError { + /** + * Serializes this error to a readable string message + */ override fun toString(): String = "${ messagePrefix( @@ -38,11 +74,22 @@ sealed interface JsonPathError { }: Unterminated string literal starting at [$startLine:$startColumn]" } + /** + * An integer value outside the supported interval of -2^31..2^31 - 1 was encountered. While the + * JSON Path specification allows indices to be 48 bit integers, this isn't possible in Java. + * + * @param string the string representation of the integer + * @param line the line where the integer is located + * @param column the column where the integer is located + */ data class IntOutOfBounds( val string: String, val line: UInt, val column: UInt, ) : JsonPathError { + /** + * Serializes this error to a readable string message + */ override fun toString(): String = "${ messagePrefix( @@ -52,52 +99,103 @@ sealed interface JsonPathError { }: Invalid integer value (Out of bounds)" } + /** + * An unexpected token was encountered in the current context. + * + * @param token a readable name of the token + * @param line the starting line of the token + * @param column the starting column of the token + * @param context the current parsing context when the error occurred + */ data class UnexpectedToken( val token: String, val line: UInt, val column: UInt, - val parsing: String, + val context: String, ) : JsonPathError { internal constructor(token: Token, parsing: String) : this( token.name, token.line, token.column, - parsing + parsing, ) + /** + * Serializes this error to a readable string message + */ override fun toString(): String = "${ messagePrefix( line, column, ) - }: Unexpected token '$token' while parsing $parsing" + }: Unexpected token '$token' while parsing $context" } + /** + * An illegal selector was encountered. This could be an index or slice selector in a dotted + * segment or a non-quoted string in a bracketed segment. + * + * @param line the line at which the error was detected + * @param column the column at which the error was detected + * @param reason a more detailed description of the error + */ data class IllegalSelector( val line: UInt, val column: UInt, val reason: String, ) : JsonPathError { + /** + * Serializes this error to a readable string message + */ override fun toString(): String = "${messagePrefix(line, column)}: Illegal selector ($reason)" } + /** + * The compiler encountered a function extension that was unknown. + * + * @param name the name of the unknown function + * @param line the line at which the unknown function occurred + * @param column the column at which the unknown function occurred + */ data class UnknownFunction( val name: String, val line: UInt, val column: UInt, ) : JsonPathError { + /** + * Serializes this error to a readable string message + */ override fun toString(): String = "${messagePrefix(line, column)}: Unknown function extension '$name'" } + /** + * A non-singular query appeared in a context where a singular query was expected (e.g. an operand + * of a comparison) + * + * @param line the line at which the offending query occurred + * @param column the column at which the offending query occurred + */ data class MustBeSingularQuery( val line: UInt, val column: UInt, ) : JsonPathError { + /** + * Serializes this error to a readable string message + */ override fun toString(): String = "${messagePrefix(line, column)}: A singular query is expected" } + /** + * An invalid escape sequence occurred in a string literal. + * + * @param string the string literal + * @param line the line at which the string literal is located + * @param column the column at which the string literal is located + * @param position the position of the invalid escape sequence within the string + * @param reason a more detailed description of the issue + */ data class InvalidEscapeSequence( val string: String, val line: UInt, @@ -105,23 +203,30 @@ sealed interface JsonPathError { val position: UInt, val reason: String, ) : JsonPathError { + /** + * Serializes this error to a readable string message + */ override fun toString(): String = "${messagePrefix(line, column)}: " + "Invalid escape sequence at position $position in string literal '$string' ($reason)" } - data class UnexpectedError( - val cause: Throwable, - ) : JsonPathError { - override fun toString(): String = "Unexpected error: $cause" - } - + /** + * Contains helpers and a constructor-like factory function + */ companion object { + /** + * Creates a [JsonPathError] from the given [Throwable]. If it is a [JsonPathException], the + * contained error is unwrapped. + * + * @param throwable the throwable to convert + * @return a corresponding JSON Path Error + */ operator fun invoke(throwable: Throwable): JsonPathError = when (throwable) { is JsonPathException -> throwable.err is CancellationException, is Error -> throw throwable - else -> UnexpectedError(throwable) + else -> throw IllegalStateException(throwable) } private fun messagePrefix( diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathException.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathException.kt index 690a5d7..9ff837e 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathException.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/JsonPathException.kt @@ -1,5 +1,10 @@ package com.kobil.vertx.jsonpath.error +/** + * A simple stacktrace-less exception carrying a [JsonPathError]. + * + * @param err the [JsonPathError] + */ class JsonPathException( val err: JsonPathError, -) : Exception(err.toString(), (err as? JsonPathError.UnexpectedError)?.cause, false, false) +) : Exception(err.toString(), null, false, false) diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt index 26ff99c..61e5787 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/MultipleResults.kt @@ -2,6 +2,19 @@ package com.kobil.vertx.jsonpath.error import com.kobil.vertx.jsonpath.JsonNode +/** + * A query that was required to yield at most one result returned multiple results. + * + * @param results all results that were returned + * + * @see JsonNode + * @see com.kobil.vertx.jsonpath.JsonPath.getOne + * @see com.kobil.vertx.jsonpath.JsonPath.requireOne + * @see com.kobil.vertx.jsonpath.JsonPath.traceOne + * @see com.kobil.vertx.jsonpath.get + * @see com.kobil.vertx.jsonpath.required + * @see com.kobil.vertx.jsonpath.traceOne + */ data class MultipleResults( val results: List, ) : RequiredJsonValueError diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/error/RequiredJsonValueError.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/error/RequiredJsonValueError.kt index 7807bce..0bfce31 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/error/RequiredJsonValueError.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/error/RequiredJsonValueError.kt @@ -1,5 +1,15 @@ package com.kobil.vertx.jsonpath.error +/** + * A base interface for errors that can occur when executing a query that should yield exactly one + * result. + * + * @see NoResult + * @see MultipleResults + */ sealed interface RequiredJsonValueError { + /** + * The query returned no result + */ data object NoResult : RequiredJsonValueError } diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt index cecbac1..4743e93 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/FilterExpressions.kt @@ -13,6 +13,19 @@ import io.vertx.core.json.JsonObject import io.vertx.kotlin.core.json.get import java.util.regex.PatternSyntaxException +/** + * Evaluates the filter expression on the given [input] node in the context of the [root] node. If + * the filter expression contains nested absolute queries, they are evaluated on [root]. + * + * @receiver the filter expression + * @param input the input node + * @param root the root node. When omitted, `input == root` is assumed. + * @return true if the filter expression matches, false otherwise + * + * @see JsonNode + * @see FilterExpression + */ +@JvmOverloads fun FilterExpression.test( input: JsonNode, root: JsonNode = input, diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Segments.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Segments.kt index 31938ca..1a22816 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Segments.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Segments.kt @@ -5,6 +5,19 @@ import com.kobil.vertx.jsonpath.Segment import io.vertx.core.json.JsonArray import io.vertx.core.json.JsonObject +/** + * Evaluates the segments on the given [input] node in the context of the [root] node. If + * any selector within the segments contains nested absolute queries, they are evaluated on [root]. + * + * @receiver an ordered list of segments to evaluate + * @param input the input node + * @param root the root node. When omitted, `input == root` is assumed. + * @return the resulting node list after all segments have been evaluated + * + * @see JsonNode + * @see Segment + */ +@JvmOverloads fun List.evaluate( input: JsonNode, root: JsonNode = input, @@ -13,6 +26,18 @@ fun List.evaluate( segment.evaluate(selected, root) } +/** + * Evaluates the segment on the given [input] node list in the context of the [root] node. If + * any selector within the segments contains nested absolute queries, they are evaluated on [root]. + * + * @receiver the segment to evaluate + * @param input the input node list + * @param root the root node + * @return the resulting node list after the segment has been evaluated + * + * @see JsonNode + * @see Segment + */ fun Segment.evaluate( input: List, root: JsonNode, diff --git a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt index 138d7bc..3164081 100644 --- a/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt +++ b/src/main/kotlin/com/kobil/vertx/jsonpath/interpreter/Selectors.kt @@ -6,9 +6,22 @@ import com.kobil.vertx.jsonpath.get import io.vertx.core.json.JsonArray import io.vertx.core.json.JsonObject +/** + * Applies the selector to the given [input] node in the context of the [root] node. If + * any selector within the segments contains nested absolute queries, they are evaluated on [root]. + * + * @receiver the selector to apply + * @param input the input node + * @param root the root node. When omitted, `input == root` is assumed. + * @return the resulting node list after the selector has been applied + * + * @see JsonNode + * @see Selector + */ +@JvmOverloads fun Selector.select( input: JsonNode, - root: JsonNode, + root: JsonNode = input, ): List = when (this) { is Selector.Name -> select(input) diff --git a/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathErrorTest.kt b/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathErrorTest.kt index 6109df0..2779686 100644 --- a/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathErrorTest.kt +++ b/src/test/kotlin/com/kobil/vertx/jsonpath/error/JsonPathErrorTest.kt @@ -4,7 +4,6 @@ import com.kobil.vertx.jsonpath.compiler.Token import io.kotest.assertions.throwables.shouldThrow import io.kotest.core.spec.style.ShouldSpec import io.kotest.matchers.shouldBe -import io.kotest.matchers.types.shouldBeInstanceOf import io.kotest.matchers.types.shouldBeSameInstanceAs import io.kotest.property.checkAll import java.io.IOException @@ -17,9 +16,6 @@ class JsonPathErrorTest : should("return the error wrapped in the exception") { val errors = listOf( - JsonPathError.UnexpectedError(IllegalArgumentException("a")), - JsonPathError.UnexpectedError(IllegalStateException("a")), - JsonPathError.UnexpectedError(NullPointerException("a")), JsonPathError.IllegalCharacter('a', 1U, 1U, "something"), JsonPathError.UnterminatedString(1U, 1U, 1U, 1U), JsonPathError.UnexpectedToken(Token.QuestionMark(1U, 1U), "something"), @@ -62,9 +58,9 @@ class JsonPathErrorTest : ) for (ex in exceptions) { - JsonPathError(ex) - .shouldBeInstanceOf() - .cause shouldBeSameInstanceAs ex + shouldThrow { + JsonPathError(ex) + }.cause shouldBeSameInstanceAs ex } } } @@ -73,7 +69,7 @@ class JsonPathErrorTest : context("The 'PrematureEof' error") { should("produce the correct message from toString") { checkAll { expected, line, col -> - JsonPathError.PrematureEof(expected, line, col).toString() shouldBe + JsonPathError.UnexpectedEof(expected, line, col).toString() shouldBe "Error at [$line:$col]: Premature end of input, expected $expected" } }