From e30c1b2c7eb0a0a4deaa508179f616e1867c6325 Mon Sep 17 00:00:00 2001 From: LambdAurora Date: Sat, 26 Oct 2024 15:54:42 +0200 Subject: [PATCH] Rework task structure to allow configuration cache (#4). --- .github/workflows/test.yml | 3 +- CHANGELOG.md | 9 + README.md | 10 +- build.gradle.kts | 8 +- gradle/wrapper/gradle-wrapper.jar | Bin 43453 -> 43583 bytes gradle/wrapper/gradle-wrapper.properties | 2 +- gradlew | 5 +- gradlew.bat | 2 + .../ConfigurationCacheFunctionalTest.java | 85 +++++++++ .../configuration_cache/build.gradle | 8 + .../src/main/java/test/TestClass.java | 7 + .../main/java/test/TestClassCrlfApply.java | 8 + .../main/java/test/TestClassCrlfCheck.java | 14 ++ .../main/java/test/TestClassWithOptional.java | 15 ++ .../src/main/java/test/package-info.java | 9 + .../licenser/YumiLicenserGradlePlugin.java | 10 +- .../api/comment/CStyleHeaderComment.java | 6 +- .../api/comment/HeaderCommentManager.java | 173 ++++++++++++------ .../gradle/licenser/api/rule/HeaderLine.java | 5 +- .../gradle/licenser/api/rule/HeaderRule.java | 12 +- .../api/rule/LicenseYearSelectionMode.java | 31 ++-- .../licenser/api/rule/token/RuleToken.java | 6 +- .../compat/KotlinMultiplatformCompat.java | 10 +- .../gradle/licenser/impl/LicenseHeader.java | 97 ++++++++-- .../licenser/task/ApplyLicenseTask.java | 80 ++++++-- .../licenser/task/CheckLicenseTask.java | 108 ++++++++--- .../gradle/licenser/task/SourceConsumer.java | 19 +- .../task/SourceDirectoryBasedTask.java | 128 +++++++++---- .../yumi/gradle/licenser/util/GitUtils.java | 13 +- .../dev/yumi/gradle/licenser/util/Utils.java | 12 +- 30 files changed, 680 insertions(+), 215 deletions(-) create mode 100644 src/functionalTest/java/dev/yumi/gradle/licenser/test/ConfigurationCacheFunctionalTest.java create mode 100644 src/functionalTest/resources/scenarios/configuration_cache/build.gradle create mode 100644 src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClass.java create mode 100644 src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClassCrlfApply.java create mode 100644 src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClassCrlfCheck.java create mode 100644 src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClassWithOptional.java create mode 100644 src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/package-info.java diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 6c60d03..c323356 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -24,7 +24,6 @@ jobs: run: ./gradlew build check --stacktrace --parallel - name: "Upload artifacts" uses: actions/upload-artifact@v4 - if: matrix.java == 17 with: - name: Artifacts + name: Artifacts_j${{ matrix.java }} path: ./build/libs/ diff --git a/CHANGELOG.md b/CHANGELOG.md index 128cc09..f3c2676 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,4 +26,13 @@ - Added some extra default file-types for C-style header comments, specifically for common web languages and stylesheet formats ([#3]). +## 2.0.0 + +- Reworked tasks to work with the configuration cache. + - Tasks now use inputs. + - Source files input is now much more flexible. +- Made several data structures serializable. +- Switched from `PatternFilterable` to `Set` for file matching in `HeaderCommentManager` as only extensions are matched. +- Adapted `LicenseYearSelectionMode` to not consume `Project` arguments anymore. + [#3]: https://github.com/YumiProject/yumi-gradle-licenser/pull/3 diff --git a/README.md b/README.md index a89cd19..1a5688a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Yumi Licenser Gradle Plugin -![Java 17](https://img.shields.io/badge/language-Java%2017-9B599A.svg?style=flat-square) +![Java 17](https://img.shields.io/badge/language-Java%2017-9115ff.svg?style=flat-square) [![GitHub license](https://img.shields.io/github/license/YumiProject/yumi-gradle-licenser?style=flat-square)](https://raw.githubusercontent.com/YumiProject/yumi-gradle-licenser/main/LICENSE) ![Version](https://img.shields.io/github/v/tag/YumiProject/yumi-gradle-licenser?label=version&style=flat-square) @@ -17,7 +17,7 @@ For a project you need to apply the plugin to your project: ```groovy plugins { - id "dev.yumi.gradle.licenser" version "1.2.+" + id "dev.yumi.gradle.licenser" version "2.0.+" } ``` @@ -39,11 +39,11 @@ The plugin can be configured using the `license` extension on the project. ```groovy license { // Add a license header rule, at least one must be present. - rule file("codeformat/HEADER") + rule(file("codeformat/HEADER")) // Exclude/include certain file types, defaults are provided to easily deal with Java/Kotlin projects. - include "**/*.java" // Include Java files into the file resolution. - exclude "**/*.properties" // Exclude properties files from the file resolution. + include("**/*.java") // Include Java files into the file resolution. + exclude("**/*.properties") // Exclude properties files from the file resolution. } ``` diff --git a/build.gradle.kts b/build.gradle.kts index 2d0c685..50e2fcf 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -1,15 +1,15 @@ plugins { - id("dev.yumi.gradle.licenser") version "1.1.+" + id("dev.yumi.gradle.licenser") version "1.2.+" id("com.gradle.plugin-publish") version "1.2.0" - kotlin("jvm") version "1.9.24" + kotlin("jvm") version "2.0.0" `maven-publish` signing } group = "dev.yumi" -version = "1.2.0" +version = "2.0.0" val javaVersion = 17 repositories { @@ -25,6 +25,8 @@ dependencies { // Use JUnit Jupiter for testing. testImplementation(libs.junit.jupiter) testRuntimeOnly(libs.junit.launcher) + "functionalTestImplementation"(libs.junit.jupiter) + "functionalTestRuntimeOnly"(libs.junit.launcher) } gradlePlugin { diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar index e6441136f3d4ba8a0da8d277868979cfbc8ad796..a4b76b9530d66f5e68d973ea569d8e19de379189 100644 GIT binary patch delta 12612 zcmY+pRa6|n(lttO3GVLh?(Xh3xVuAe26uONcL=V5;I6?T_zdn2`Oi5I_gl9gx~lft zRjVKRp?B~8Wyrx5$mS3|py!Njy{0Wt4i%@s8v88pK z6fPNA45)|*9+*w5kcg$o)}2g}%JfXe6l9ig4T8ia3Hlw#3f^fAKW63%<~GZJd-0YA z9YjleCs~#Y?V+`#nr+49hhsr$K$k!lg}AZDw@>2j=f7t~5IW6#K|lAX7|^N}lJ)I!km`nrwx> z))1Es16__aXGVzQM0EC8xH+O!nqTFBg9Ci{NwRK*CP<6s`Gq(~#lqb(zOlh6ZDBK* zr$|NDj^s6VanrKa+QC;5>twePaexqRI%RO~OY075y?NN90I|f^(P# zF=b>fZ73b5JzD`#GC3lTQ_B3lMeBWgQUGYnFw*HQC}^z{$6G4j(n4y-pRxPT(d2Wgb%vCH(?+t&Pj z)QM`zc`U`+<~D+9E{4Uj2kc#*6eZMU$4Oj6QMfA^K!rbl`iBix=2sPrs7j@aqIrE zTaZJ2M09>rp$mgyUZ!r2$UK{+DGqgl`n;*qFF~M(r#eh`T{MO?2&j?xgr8FU$u3-` zhRDc_I23LL4)K&xg$^&l-W=!Jp-P(_Ie07q>Je;QLxi8LaEc%;WIacJD_T69egF?7 z;I_Sg_!+qrur8$Hq4grigaiVF>U7uWJ@Hkd&%kmFnQN-P^fq0gB1|uRt!U#X;DnlV zo?yHWTw7g5B;#xxY`adhi4yZn@f(7-Xa(J6S=#d@&rlFw!qfvholE>MEb|VWn^g}G zMSrK&zQ^vDId&ojL!{%{o7?s{7;{+u%L{|tar(gp?Uxq3p?xAysB>0E$eG#$tvkk9 z2Q2gEP17{U6@UD*v({5MP-CTZfvWMItVjb4c;i~WLq&{?Q1(koX&vt7+$z}10{^Id z{KDjGi0JpD7@;~odF__0m|p;5rIrHidOP9^mwKe#-&JX-X@acc)06G{LO1Wu)#gvZ za~y9(fhA%UwkDOVU1LBJ`0ROE z4&)dJKK%mG@+CIm?+wt9f~@xIMr8}UH*K1j| z0pppo{7gv3v{URwxVMeg>Ps!L5IKxm zjac2egjgb0vH5i75$s|sY_RYec#>faqJk|AGgV;v=^%BM(^p{p;(^SVt-88G9f!q; z>p}9E4^f0=01S2pQBE4}9YqE%TV)*hlU^8k9{&=K76+*Ax^r=AkBb%OCP^P2nm0Ri z;D-|Zk?gGeU<12ti2CnPVNA(Pb)02+r|&yTWW-OJO7 zNLb0pps6aN?A~NJp5kj{{IOlf!5KWMleV@-hYLift)D>-7K+tgs=7Ake}oBnIy-y1 z(Hn@Hjw=_(x>dO5ysQsrnE%A*bk0K<-j{1Yqz@#n#jOL^AzCr#wR|WYzqk6i7v)Lf zkXdKxzuu20aP{Tbg$(+9&oh7cd(Uoqqf<#ujb$q4sZ~gxFbQfS zS)kNklyL*{2AELgjZ(LBu*>S(oH5AaJ;YiB@;l@=O%F6B?oanzoYRM^fQ9-<~^=3$H0g^JPMLQo@SZ@QuNvy)tyJ)LSj`+()#fy?{aV4Yg^7dlQ7AQM^3GLCR2dAFR zJjtfKiVqF`l-H_fz0HD|9g>)pOxn}k!vdZ=DO!7Sikm{Z%P6BrRkBS6W?ZB5W&7rT z@uYpf@M@a!z7H&o@-yrcCL^Ff3e7p3T`R9p?@o-acXmbTSa0>ZANzCSgovsd%;i$| zVus`not!oL#(W`L-!9w0jdaECaG4hk{V7IOs676ZquZH~0TX5hDq|)x z6T497l|E?f4)LA>j=S8}b$0LS=I4h|hUFJYJODT8Li@#6kF$k0)@*l{RnM1HQ%?VT ze-Pqlc!~t(oumVC*?5fwR;P6u{tHaZ~*LlD;B)4f? z?lpWfa2P@)g57flVl83Ej%P`2)gGyaPjhvD(%i~{`2b>#3!+y&` z!2nuwHMFA-zUY}f1^0B8<`N)Gr=A4TS@b1qykmd0Pq{?r)+1^^+D(=xasb^Tf!oK9 zBLL+*p6M_#ufgLzgq1zcSwZsZnQWFLC3`Yxdg-2=*tT`J9nrfYt)RF)YryBf8_gW{ zvKbB+oZLehfT)S#<|y1)E0hW^?+AnqPXq9Hu;v3dsMGdr{SVyF63;K<8VcgI#~}1i zLYSBL0K;RTT(;>2x=*!1Di9w0mwr;`CN}kM65|Ay{~z}_^JKOsRaN<~#9O^iiW<5P zYN7r~HV!#Nz~IZU`P>1Xe%4f~K}KcF#X&5kO*G}-)74S*tQ8CietdPcA1Yl;S=Mr# z`#MYY!{s^uo=jn7;k6O%(}fN+*0cWMpt~#n9DR<3NyU?+3D^AgI}S)Cu-Tljg`VY} zX1=fq$?8$DtOeGxE6f8lbS_6Q3C4+LDTO$}_IpM$Xv<|QSC%+Oll^q$y`7o@jD{dp zNDl|&X)r7wETa-#h*d`KXntxI(Y{vLha{$0i7@G8xx^m=c<{lJ9?p-i!^W{%j7-oo z0W^SzZ^(Wkyz*We{lEn%Yhu-ycUOHtrRiVJL4~&S91*D0MrLu}Q>v-Mc?GcWfpyz% zX|UvcN@krFO#@v|CtYM}g|=L3%aMo$E5<@CM%c*;?u>LOTz00@+dt1{yg1y=$h+{|D17U}$*^fE^H&8b431EUE z<9tv0V_#%#&1N#j7AKCj!tTK@J%oFW*ESW<(#Gl#Xs%v<@AitI?s92nLzm<)w3Wkkom1f$gcdUi%g_*jofy&}N#luL<$GVIe{iQkQ)sIHVy zBgItnPBFamrv6Kb{eE($Q(f`ZPeW!Hm%Y@F*OF1sKB{Yy|C>WEv_mfvv-N-jh)B-5 z4a!1WcT@9a+hGaBrc~sz=>G?Q!*Zp^JFRUvBMyNR1;`)j$RhH$6gEyVKhd$&K-CFT zXaWC-Y=fyOnqT84iMn9o5oLEOI(_3fk!W^8-74|q1QhQ|CmT0i=b;6Z3u?E{p7V{? z;f#Q-33!L+4&QQcZ~GAqu$NS{M;u%`+#9=7^Oa5PKvCCCWNG_~l(CidS!+xr-*gg{ z$UQ`_1tLT_9jB=Hckkwu>G{s0b0F4bnR7GibmHo?>TR&<3?D;5Fb#gd8*wYa$$~ar z7epl1qM)L{kwiNjQk}?)CFpNTd?0wAOUZ|gC{Ub|c-7h~+Rm(JbdoRe!RNVBQi!M8 z+~U6E2X&KSA*T6KJvsqwqZl#1&==Dm(#b^&VAKQ>7ygv*Fyr;)q9*^F@dCTg2g!w~ z%hg)UXAUyIpIbLXJv1nZX+a_C)BOH2hUim|>=JHCRf(!dtTidb&*~I!JrfRe+PO>w z@ox$G2a3i9d_N9J=|2$y2m-P&#PTNwe!oLBZFs;z|F5kXvBDn<)WwE0E3$ow=zg3R zK(9;sf0t;VEV3@gAg7jRtnj%-6O@!Hvg*;XcUAw}!=2*aErvB(eQIm(-UGmq^J=XN zTqJo$Y|WKo^HlBF3BXJrA#}7ZLg=r*w`I*~Ix`o&2k8^(0mt8Rp=A>F`&gehhp@Jy z^e^#B2!~$LvNCKugg)8)-G%&THdk~kfextilegP9?#C#()F59U$&eo(h|5>ceo*Em z{PEE79T$YP|Kr7K`WBHbtQwyxFkCl6xX&+oUf90B5xoi3_5KHHCyEE*oPbOQkfMz& z6^hT8_NXd2iWk{q9IKae1{_7hMPH8I7_BMtVOM4 z6jm?E0QJOn$qrgsJ`9w##GB9?G})-GXSQo6(tYS(Q0-Ct$co?Zzl0?NHsDRron?;_ zZZgQg)%XW>P?8_&zoGuF(>Och2kEJXsu1_X&~w87x!b z>~h!a>e7{`p@+#hXF88wI*JeWRZ;J4ev4<}HWf|Z;(7$E!S5l9wzBHFe>^I{2`a;a)QnAwa2xv1e(bq$<}!8o^ofGvYpk7dBR+`*%iE;hUY5 zaHF}OjGO9r*{%lmcK^uFiTHgoUD`^9Nx@~;Bg!V* zuuJ&ti{DQiq7RyJAR94wem{}cPK1J(Yxnn_{=>?USqz-~&QXRStS^s-7TksZ$AEI! z#og36s3JGtGU{CnDHRFtipFqvrE*gw7_K@NN0h+ItTq@4fqN!HeQU1y7*X?9+IfZT4Vxebpt z%#VzgdDK~-&+=Z*#>=n#XUhNvBZp3=Cr41jMqwJkHLf3L7Vm~V#GgJ(Jpii~PmJ#s zA7Ft!{xD@z>9DUb4JbiUBdNEcU4BO$651iN*mp*f)HbRRM`Cx5cR?5IfEcU{IZWwf zz(M6CDv)>xa3x}K6%tP^i15P1&&DOLK=k~+jNR$UK3frSl+|PjSC-dBItvD~LL! z>_g(YYdO4k(5EbPOw+v+;G7~jYm>F@Ai|o`gs%F)F8tDz$dl7Q%aCe|v|$UkAul_R zNlA-beBX^IJU?kgS`E$it7nF4DaI!SJAGq)2P&Few(-|tp z?K+%D3e4{pfkayrcbm0ftu6Ol2ZzdKM+4i!hNP3NRL`EvvZJ3yvNr2MV%igZ4kj``Qrdb_OI$7jWP z;l0DYf&0(-*QcP5zrP`HVznW+SbH63Qx$7_9~NjRNg7eKqI!UJ=XH`g^=t8GiFTu( z?2L{JKEu%jJx&XjNzU(*!ZNmL1@RlJA0G$2_LrAb_7lmjil(GSlSM zwTes`m+3R;3#N~Xg#9owh3ycXV8@ZlaY_16kpPFA={721b~URO4HD3sp%fmkZM}k) zZB0#)kP=RkNB~R-MCk8aljG_bagt4vIb~8)BV%(b8_;)&Kf9GX+%O_cNG|(D$!3&D zL(I8}*LqN5NntipFlN13=`D>6!{D@CFMBH0kW3=HccJV+xW~|$qeFR5i-2{X+iWMu zI2$gepQ)H_B%ip_BlWOQ*|pErXs|4ir{IHccgaIJ84irE{?+$KDABXr&f`jB^V-c% z$$u`uU1YB^{<+UN2cNg#7&0bz@yF?5>j|;)5&IV3wIQp58X#OE-M^$HdyvL|Um5t? zhZlAG!Mz%XkUe3t471JM*Yur}o30vzu6RN7gJyNcf!IItsDO730mcJ*O!~V``y5=3 zNJGp34DZ}wd1H6V`Uuy%es>BiO_aE-S8jzir#$& zyk)@2a5tP$@g%jW^b^JGdo)X@Q%sE`^lDQmY9m%uDFpPX`w9%=yQ+nneMm#OaXcD` z9}{tn5A2b2z9783vL2_jSao?uxJhWJoq%47*RafM4o0@gY(p)F>qT4^XM5GLzV#6j zC+HoGhAne7o_w{WUo(B++z7lU3Y0k1rYv9|TSv0vR-Du(5=VakbbelgZTeDn+a_Wv zq_j-^+Qz1WAl;Zg>ahX|CERbX1V%B!hTKN?M}fGoA07M(WU&NfT&TmN`P@56U2 z^)vLDs|Ln~0iTtn-?KTeQl@T&bskJFuTUS!m+$CS9vnd}8(UMO|Kv6TCfGN9NUu&4 zL{)GTxPq>fwsJ~aU=4Qhuq8*RzDsP(LZh$BHezq&9gK$IS<|DYbm})$QTGCS6T;Dr zEkLct!b+#<1r9OKG@P!f1wm8>=Nz!7OzJm!g<+`?N3;YaA3(P@EL=(sTaRMDD!c8=-XN^4BXp(eVkj$NmEMYPP>YJ4bJ3yUud z<3BeJAJ$6z^TuywnfH5lv#$lgwraNw{IV=tIznPH1DT`v-5yS=!)J<}xxl}uZf9azA2A97Haf!;<3y01hlw?dWNEv@TLi1s-mO4vmIT%O_42nS z$VRWrs9NngqRRkWAnWkn%`Rw@?wH|)7XL`EL5EZu$qyJW31&CB^T_)qwIv!{;E_6 zo-9XAryQRlk-O0>o#-SZO>|6OYq;}<*>Wu1AsVRiXY4f8qb;+sItv3AyS!4Ry+q}) zA!pAB|BmC;=RIOk^^vlsEH(!Q!7_1FK~ZB2err*o!+b(r=m1b?$6d!%zmN+69LXnT z&gRmM+n_R-F@sT*IYv0_mGPvur!u`iWbQO7SqiGFLeY&yga zf`lM&B74FA2C?N@8_z652fjhBEoDUKbP8hL{0{HAF%qDo7)o3=3rg#6)T7%%5^wl% z9R0*S*<~>nzYOdQk2l`9h#t+gJy_xujw6xjV(8S<_DbVg61&pT%Hi42l%D73G?adn znB%UdNM0p}lEF-P2%TAMam2zpQev71e>a$$%i+r~b+D9G9pF|oY_*(-u*89oKsXLY+UIbqq)MQ%(GYS{(*n_S_*RN$*~`zUtab%0aKwhx znc)Yo?{xq1sJCgQD)TeTci1ucvbez9q=A72H(-SB18Kl&6^vHV8^i!p@>iF!DIw17 z+8Q)TNisB7>pwyww4y)yJx*wX6SJO78eLBC-ar1+k$Z9fy;wBD|3kzI{<+l*>PSY^ z_?nLOZaeWbU@C3hfK?X;Di*8CHCPkx2qco6(ZyJdqSzp^TJ_5Lpa0UP{Gy+!b0Lr% z@xYxSjUKoY6L#>$qx~KD$-0=|OF7zhVP~ntMgEALYPIfhj@+ z!;JJ7te>CcovruwHsJH6Lta$nm|%^C@=V-rmhU{+I~0(|XHQ9jt@L7pb{gx#{4r!) zg($FyFTslcgu(~6lYr$nW?)%*l#VJ=R-jxK(x=t1bWlu(nL66T#qj%3aZ@uVhy}Co zDU_q61DD5FqqJ*#c|(M5tV)XBN?Ac^12*q)VN4yKPJ|#==S_`_QD9|0ls!`2)SwuHDRA_OfXQDq3%qW&MZB}Z!=k-9xqev8jHz(H z{^D@cIB~QiK>~wa)A&^Ll^Wi6QgCzU;iv-BHsLBs zH7=jN%|>0S`SjP%M&AF1PNVDp_FZ?2Bm@7`DC&v(pYrw!!yD#4 z6+<=HS0Ln6MhoKxF<%~H`y20{vf#pxh=;j{zY381gvAFekgG|>G1zo8$&az{V=;JR zy_puF4$L$?EMhT?;TpQoR*j16ll`#AS4e96C}yp_aGKkBe?1H|k_;gG-~Xorc<;lI zkB}fB{$c-D2mGA&{rm<*@F5)c3X+6??g~XoEwuzSuch0D@W~P5(2I8v8F$c2$Vw51 zP#YLSBDqtWW^EYBl^QYHF+MA7am6f4DOhwnJM=W9$uvMOsZ%_~?)2C#wb?CkI$7{K zEi)=#|5pFvg^){zK5kpBLjB2kZ+$ZB|L=W|aNwyyb(gC2l7bcpx{E-H@)q6@D6N^xh`{1E%ItF2$eeB_SjI@b2WgTpS1thwg&n`jiIzw^TtXUyB{00($GIq>vbj|}bav}}Q_~wp3>k8!E@hVC;OMUTu|= zAy#vXH*GrUHu7^cNZWe1>y;2(51js9wbu+R3Aa*(wzH9+X0dIsf&gc_x|_LP z>~CF^?(~U}+l~ehe|i>?4eo!xkq&Lk+RR-1duNP#o~>@1x)s&i&u zRaYL@+D&_M|JLI6fHbEr_`U;HgPTh#E3?sB)A$*gqyBgg*ql|a-m*TX5rACbWKCE6 zdeQ`v8m6>g^ugv`p|HY^#1QZrGGUj0^HVDc@{?Q0yhalbBEV{+|HzC^-{&e{5K%z9 z6Bxtnfu1!@Mp+Q&*&~;FOg&*Vm<@4b;{FG0-!UUXX!|)1w}op!B_|7_s~d(+=9Gba zKp8`LaB4D(H=cGcspJ_TjYaOwMb=sGn^gtUVhK!UI~2KKYEE-NC}F>+BEY7IVvy%KRvm00tg!Q`y=er}wpEetX}K@;}(}{s9AzV#q2@ zBy7}->|N?13POrs`;U?(qAG(I$~Gt+Rgw%aNZ_0fs_utVvRJT-7z4!@x36v@=NBX=IqkK{#Kg0w48de@?#Yb4M(Svj5=T+<ONr8-oh7l?Cji@+erqur zFhZ=9|Lk=$`c}v4u`)-!!UI=!9Jo@h&7p4RlS#u! zZ7-prn75JkV?VjptX;@$#`U`{vB!=Z?V`T*FBF>J?vsML7e6@2GbUteMFfX-TUu{2 zLNIG*;dV)8GV8gAgEf#)X3A>p3^CRka1v?~8x^anBhQ=L=LsOl=&pcOYHo98m##ye z34MtGCDK!`ptl?taGMr5q{!zVc? zG00e){TV?`YA9eB;(lA3lXI?RrB4BYQGk?vOmTIUJED=(`_*gtn2DB-t4WW54as*W zb2kD-lWX>lb$+W!VFakki>B^Vc+u$?NLF>)!U%b@Y}gYJ>m2H=^x0=nsE0TF^Yu0h ztgH8-o1%+jCk(+&`|)tTfEVHq0cMeFa{Uz)X$;fCq%Y=SOWML6bYfeP8j5hktL`KK z(18`XrUn&WN9PtFxh&dX`y~YBsmdhi7Kw%tKzM%^VEhdD<_XkulW-x=JN6OPbFI4@ zzDDRN+f=@{0h*MswwOqG6gJ?{NuHx(y-|FUGsxyZ*x0~$MW(eY>vqq4Fh#t7uzw=- zKB?|!0N~!h^AMdLa)oR!Ca#HZ9&Zf)ghuO<^RN)4twRlygHnQG(BE{cDc5E}OF4;xss6gYyV~EcJvJkX)xNWb=@yw!uq0v-sf^rvkp-;?DPWK@*SEw|V;IH=7 zfQqEV_>DjOPT~8X*J|H8=&RnzK4~S7ML~nLX^%s-Vqc^aWy7N$y57qciZGcqy#=zU zs8hcHiI=D$+RB{|62{ohCTiaML6FI4Uhzo5D{Jik@poCs0w7F)*w}F4r0sJ~#u-72 z5bK=ANt=M$Dh5NKnxGsg9NRR?WD-x|FhTwBjd zD<-K>44DB~i%frJOfnzh1R>PRY34kw!6~p3M$JLaD1r@`=h)~Ngks-(gdXh^Q?BTP zZ^Zj5w1AwtuR2$~E7s9iZdF}z%pv1em^V2rM{1tLUY@-+Sc0(9jA|iZWml1;v13=U zHf?y@#mb--7z6$ue>`qjhE~brk$AY-RG90~5wcBbDReXR2)pKg{L>;H(DI`U!MLNQ zY9rFJP@ZQ}jlcMh%WSCo%vf+nd0Gmd*F%KMIe>slCUh)8Ma|;M_I+v#;|ueg9oLg; zq2HtZX%&#F7vdpNlkX?}(C7dGC^y#NB#m4%69RzTNrk%4ol~hSI%>2r6B|*ZkW(*P z;u#s;+faHo{tfy+1L^RzWDi*^JR0iY(zJDB36y_QJ+|E-2x+cY z!V8uLNktH~q>WQZuY!Ap66WP|E!0PA1jK~)^8oJVGbspJs6QL!!-5Qm7 zHYI|_`Actg?vDzdg5{86w@GS$G6ANzff7->6i5pB$T4O}`fZ_;{217Om0gN5zTr12 z5mW{hCzCE-QubjxN$TAE-XgI-8dTY@OZmq`y+y_>dk*(qXF0{nam|q@~i}Utp*k{yurq(DW54hkDT4bbg z=_etM?Nf5W^o-HEu9_?&xEqPg^P^mTxLH8n%u$!mWvFG|{&)jtnU&6|5-`~eaNz0%D1BDo`{ zS1N5(KW5v^2eLdd_%`uaRndF@h0Uo6=M|8?b~KbOLZk{HXEnGmtgZXf2inI*1r%n! zQ3&%RI4r{f&dwW~HwH0Ked9b!k6{>_19H z_Ai>5IChDMY(FfMyG%;30?SQ{iV9KyGru62+Y)~qSQ91}b~}w<&*}R&1c#$O`H@~c z5)2S_eXx}M#N{MuGeQS9@#UJB@;W_j50b}jIhxMPloEFQZdvwxiU^RYycTzgK)-vl3LT&$L8~@68$C8~5_U{cR$E#w*x65(qw&eoL@>%ZHvj zWnEMlSh*(o&oy|J7eJ5OD`ssy%F?*Vp?`Cq;FShyl{ZoKCG5g{y}>usznni#8ki(i zO{w@n{iAj1_ooX@+s*!uW60WcH~*bNOT6z%0jVML5};wVrQp~`Uss_{cO2oud_nNA8^B$?07fJ6?iI)Q zuo9G)O-z)DqstrBqf>B%S05hf-wep0@$BFHKSrkZ{za3D)yVzRz)2{wf8(Wp+xyAM z$rtyx$gi3A=V~V!`Q3;BM0$>*VVtxEM|xDL^gew7ydy3Q6YzD&THRz*q33Ms_D;M- zbCx1Ft#UNB)V3bf`~{ImI72OTp^|bF8?G8#FRj+Biy8ET5#rA3sd|0FR@U(LAJ%w8 zS1%n8Z=Amhw)92rIsof=YVWF4jw&F*j1LG@-`+cR0-~2LqXRH8(Ccne{y#MCPncF64U`0uO zWmi$dlii~1D0rLR{qc|_2M!C$t8^=G7xQY)9!#Y331A|>N)EhmyVdLWL9I3YLJ`7? zZmpqUJB>Ni9oiL)^1IK1UoMyhWE{$9M2M6Xi zPKk7GpMsA6vjZbU7~i+u|J6Nk|Ci!Y3UMUT2|`M;JsNQACdJ%ooo9Yt{?A+0hMpxi znEa~~sxC>rKrU6bd=WRb;%wsH>A#j4{({&1GYSNR57Gama(3)2A;SM>qop}l>Jk2* zn1+C$fIxuwzg3mCU#SOqb-wOCb6mBcYlA5+mt<&_J~sBxc(GQtBFINUO~Mr7<-uu($>P HJ4oML2Lo<@i8BwbL^1~GkG`E7C$SEa_ zF^}Ea+#Je`Xy6;#D0FPnSrR%Y!QGA~NA^{oWmW8C<3dr{x6wWQ{4+bzemqV5W$i5~ z=J0jXZ>uZb>DT@0Ks?4QJ{`z?8JWl3$y;2pj#$XP*pv$>$g(z43{YH9KmmR6<#sIn zA`#=0#sgycaBQ^&}Xba!|KaZ8~b30v~nLt z9%#gz_*=~KD{3t^X~l>480*}PhKN=??g`RV|4Ud{Gyyl187MJ}r(#e+H$GEdI+p1s zq_25h;fV)$EPK%Dw-(G=f`yHB-_tttsC!?k7*#!|4a>`Ahj8nm?&n>NRs%jkZW^3-0P_yMP5&*6a26{MRj1&TPF zyE#|c)5uUHzMWx=rMKpuPih*V=S;W3MzIZTw2uTbr}8`p2bm+Z6Sa%vvWAWSf4H)p(+ zSQ8;EvUa#wqWV+9vmIio(%7wukK2SwjUS8Yl%Rq%=~PU)2$Tvm6`1!r3H@U#_|bB0 zmlT1PS3wPB(b&^+@YY7Y$n4l3mV3-X0$>z|gZp6O*Lhzn&?Gad2ZCF;+#95-Y?#y+ z?*l@Yf=a4w{Px=o!N|3~_XKfk&G;fN>Ps&dp2FpA~qD=0~=!NOS@B#XAKKkND>Y{4>rqxrViKD7;?>j8`R` z&G)3FN|dfsxnaI^!d1G%=>AbTTxZWo;n-DLrQ!sj=f~VAOe5zhGS(dgx|!ls62fbX zV@<7Ck^!}R=`Swr?(7w1rY6Nmq~sfXJ?TiKJLn=&SQdEt9$@0 zA+h1Wbwbri0s-stc8yVq;mRa6@kEf8^KXUz&jcic!+avDvvJFa>k0ioWug=T3oPw; zyj4it&0@>_*uI@2=^+T7sL1_!^aJW@Xfo8aC#3^WtQC7fET8b9C} z*u^ue6Ojn z7@(eskJ2+cNnH9~VyfIh<-|7!je~vGy*odz(sk-u$~SrYF3glruZ*W`{sqnS+9=;Z zh{D@MSG91%lr&ua8%$sJF%y1I<|e;EdfJykY8#D$Hc_81n5`$7;1N|b0tvvPLzSg& zn7!5x?T*@rQUKcUhTIjV(rw*5oQYlm5DbEO?60#mohHfbR$3_x#+PZoYi@Vd4`#YgKyTd^!4n{fN~WZDY61sAOm6 zl!d^i*a01QxpWM9Pcl?&{RgO}uq%ErOk5WpECvnfEh!*YP&1Sl)uTN4hg??Vqs~i5 zYsfufz3?{TtwuBN=`0~Qg1PlWH#OGG$ zLLWU17$v``)CE1cds_7kj8mJ{-+l8{DS|zAQ&3|qpOY=!J|kXUhXue9|H>4gqk|n) z-i34GmxLFj8asb3D#D&=ya*a5`C<=o?G;Ev^LV%;l#nH#O=7Nh@z1Do>j6Q;I5S2P zhg|AZbC&|c7}uSJt57s2IK#rSWuararn-02dkptTjo*R{c5o(bWV}_k3BBnKcE|6l zrHl&ezUyw^DmaMdDFVn<8ZY=7_{u{uW&*F<7Al6};lD(u;SB=RpIwI)PTyL=e25h* zGi{lRT}snjbMK~IUx|EGonH+w;iC2Ws)x>=5_{5$m?K z5(*1jMn%u0V1Y%m@`YS3kskt~`1p(rA4uk;Cs!w^KL$w>MH)+cP6|XKr4FfHIATJH z!EGAK4N>1yFR`-zW|w%ByRe#=&kA&#WyUldDGpt!wf-8SFWiSi!5QZL+l7*CE?u!NW1T$<1rdLJ9y3u{_zvHaM?#Rm4 zFk}^1!ffcrB|XK3gsO-s=wr*sUe&^$yN|KxrA)uW00Gu60%pw_+DcUjW`oW<35OC8 zq2{j8SgC}W$?10pvFU83(SL$%C?Kctu3*cs0aa%q!fjn1%xD*Jrm!F3HGR9-C{b?- zHp(cL;ezXMpL@0-1v0DMWddSDNZ5h?q50cOZyVi#bU3&PWE=(hpVn|M4_KYG5h9LffKNRsfhr^=SYiKg?#r&HNMi2@cd4aYL9lw(5_IvQJ zcB*DD()hUSAD^PdA0y|QrVnqwgI@pUXZXjHq3lG2OU&7sPOxxU$Y3&ytj6Qb=2#cC z;{d-{k|xI*bu+Vy&N+}{i(+1me!M;nshY_*&ZQLTGG*xNw#{RpI`3^eGfHck+*38NRgiGahkFethtVY=czJs#)VVc{T65rhU#3Vf?X)8f0)X{w!J3J{z|Sq|%?)nA+zo?$>L9@o`Kc|*7sJo4UjIqu0Ir~S5k^vEH};6K?-dZ0h*m%-1L zf!VC%YbM1~sZOG5zu&Sh>R;(md*_)kGHP)<;OA44W?y53PI%{&@MEN}9TOiqu+1a3AGetBr$c)Ao3OX>iGxmA;^^_alwS818r4Pn&uYe^;z6dh z)68T|AN=hjNdGpF7n>y+RTAZc9&opTXf zqWfK_dUv=mW{p_vN>|(cIkd(+Jy}qnK{IW%X*3!l`^H~FbAHwof+vLZ0C2ZXN1$v7 zgN&R9c8IO`fkR{6U%ERq8FN<1DQYbAN0-pH7EfcA{A&nhT!Be>jj>J!bNRw4NF|}! z1c70_#fkk!VQ!q1h2ff@`yDyrI1`np>*e#D4-Z~*!T^8#o*$V~!8bWQaie?P@KGBb z8rXc!YDL!$3ZgZZ%;-%~0Kn<+d+{xJ$stQbtN8GWV?MCJvzPU|(E(1z;rFw{&6vy) z3*@y%7Tx8rH-p$boS>bLyod?OKRE8v`QSBvGfY6f}_{Zo1q85xoyOF16n~yHx2W ziydUoYLkJmzq|n&2S(O!ZmLdP1(o1Jsq88cX)x3V-BK5eF&0e_0G!5?U7&3KN0`mc zH&Lt)q8!d_VgzxyL^(@xrbp2y)Hmr^V48));RSfE=*Ly0uh9!$3dv-vMZr2URf@l5zdwLjGZB zugY>7_fd_vbV*Qv1?H~>Z%RD%nEeFSI$n$$Lrpc6g>i4+XdBB!%zM$Bhrz5Swzyg? z$~I~n@~-wTBY3-T&pr+|gC+OHDoR?I(eLWa{Z#Rsh>lc~%u0!&R|s0pA*w<7QZ}{i z*AFr~0F3y~f$MGh_HDL7J_1?SxKL}fWIk!$G}`^{)xh*dZ5kK>xGL9>V`WZZg_ z)^Vm)EQK`yfh5KiR(vb&aHvhich z_5o+{d~0+4BEBqYJXyXBIEb1UgVDs;a!N2$9WA>CbfrWryqT25)S4E4)QXBd*3jN} z?phkAt`1rKW?xoLzEm!*IfkH|P>BtECVr0l8-IGk_`UjE#IWkUGqvyS+dMrCnFl<7RCgSMX^qn|Ld_4iYRldO zY&cHhv)GDo8nKvKwAbfyLR%t?9gG?R7~PSD#4D-;?F&!kV59O}neYut5AGbKwy-(U zqyBi=&Mgj|VIo>$u!DHM`R7O?W8-idbePuxiJMH``6c_5L-chKd}=rGC5Gfrc{f!* zWFEBm?l@_b7kzY7%1RQQbG5V<4=ZlkZ%sF74Q|mKOc7Ak7dP2#quiGcZ0_J%7Q?j{ zv9{WFw;n5G-Mn%r#0R;{jLt{yy}9J6rQ(>X9pJ`7Xy?Zv z=lNit#qXaq?CnElK^zF~sG}U5oCpR0T>FH=ZX}Prju$);?;VOhFH8L3I><9P_A|C+ z{;>~dk%9rrq(snjsEm}oUz2FQ21MCG*e?g)?{!&|eg7PX@I+Q0!hL6C7ZVY|g2E>i zr!Ri2@OfEu$)d52+>+cpgh6Z;cLYCZ&EMR0i<^~4&wEu_bdo;y^6}+U2GIQgW$|Od z_jg{O=pU>0-H$P-EOlWyQy#W0r@@_uT}Lg+!d5NxMii7aT1=|qm6BRaWOf{Pws54v zTu=}LR!V(JzI07>QR;;px0+zq=(s+XH-0~rVbmGp8<)7G+Jf)UYs<$Dd>-K+4}CsD zS}KYLmkbRvjwBO3PB%2@j(vOpm)!JABH_E7X^f#V-bzifSaKtE)|QrczC1$sC<<*Y z$hY*3E10fYk`2W09gM_U<2>+r^+ro$Bqh-O7uSa)cfPE_<#^O) zF+5V;-8LaCLKdIh3UB@idQZL`0Vx8`OE#6*1<;8(zi&E7MWB1S%~HAm%axyIHN2vd zA(pJGm_PraB0Aat3~?obWBs?iSc*NhM!{-l_WNCx4@F7I?)5&oI|z{o@JKd1HZ}zf*#}JjK3$ z-;3V*WJZvUcKvSOBH4c7C{fl8oRw8-vfgKQjNiR|KhQ%k6hWNEke(k8w-Ro| z7Y3)FsY-?7%;VT64vRM)l0%&HI~BXkSAOV#F3Bf#|3QLZM%6C{paqLTb3MU-_)`{R zRdfVQ)uX90VCa3ja$8m;cdtxQ*(tNjIfVb%#TCJWeH?o4RY#LWpyZBJHR| z6G-!4W5O^Z8U}e5GfZ!_M{B``ve{r0Z#CXV0x@~X#Pc;}{{ClY_uw^=wWurj0RKnoFzeY` z;gS!PCLCo*c}-hLc?C&wv&>P1hH75=p#;D3{Q8UZ0ctX!b)_@Ur=WCMEuz>pTs$@s z#7bIutL9Pm2FDb~d+H}uBI#pu6R}T{nzpz9U0XLb9lu@=9bTY&PEyFwhHHtXFX~6C zrcg|qqTk(|MIM%KQ<@j=DOjt|V)+8K26wE_CBNnZTg+Z+s}AU|jp6CFoIptG1{J*# z7Ne~l;ba*=bSwAMQ|Vq#fW~+je4PXA91YFzBubNF?ovIOw-$C-8=Ehed{lGD0}(Id zRe4sh8L>&T%{>8o))he}eE;5_ zxoXk3wX?MyNl-xF!q1d$G?=wp^`@09(jU&X zOqZIBI#dN`2PJNdATR3ivtub|nO$dulSaP|e4)WXF1YAGN1pDQIbIjXFG!oC85Mt; zW$eteoL{y^5t4TMRwP$jNPjZFpGsWnGe=jMMqKtcZm9Y9PFZLi*1p@qoKKub^T@2+ zk$@*KYdQ?Z`}<%4ALwk*Yc{(WTf@#u;as(fvE^9{Gk)lWbJP*SjttWofV0s?AB({~l zZI1hZVWFT~W-T?nfMMcnCS4-#6H-MU7H$KxD;yaM46K4Kc@~Q>xzB+QnD_I`b_l3m zo9pRx46b!p?a^&zCDwygqqV3epjs(s0NQI6ARA1n!Yy-qduipxQ& zUAlqRpNjBS+y-ZheD(!R;F}&^V_}b_gqH%tVZ5%%ziO7k^w=es+wZtK^i*vmrWNLMs{oWu_CIov|s1raZiS)>38>pYu;i+-t zI_DiNe6aA4KTZ2P09qPj(0~K4nUq^0+f(2$g`229zkG4jLzRvJUWE0oF1XHL4t3UN zDH466G56sy9hTZoAJB!C3;@F;ONxEk5u6Mv%zdo}Rq`=* zw1n7MOhfNSV48TS989ArIcj`C%Gk8~93~u>)!Yt2b4ZriKj9x2d`H2HQNJ=I>hkDlcZn zqRj>!;oRMTIOu zx|Zfsu~v76T{z7AC(jxj^c@tnJHZtGPsq$DE!8kqvkDx5W?KUJPL+!Ffpwfa+|5z5 zKPCiOPqZZrAG;2%OH0T$W|`C@C*!Z`@Wkop{CTjB&Tk`+{XPnt`ND`Haz;xV`H^RS zyXYtw@WlqTvToi;=mq1<-|IQ(gcOpU%)b#_46|IuWL#4$oYLbqwuk6=Q@xZaJSKVF zZcHs~ZBl;&lF3=+nK; zF`4gSCeZXlwmC_t4I`#PUNQ*)Uv&oGxMALip|sxv^lyVV73tKI7)+QY5=tEMas{vTD-BaTJ^*Y6gq~PU;F5X!sxqiq$iFCo+Uv7m%1w((=e}Vf*=dtds|6 zbX}91!G?C*KG03eHoN}RZS9DJxa&8YwNCT8?JxMXyZqZr13NA|GB{+vG`08C{V(yy zf*Lw$+tYSU_+dI`3n{bMrPdDb`A=Mkg!O=k>1|*3MC8j~- zXL79J4E=U^H=iBLTeHE_OKzE&dws8RNynsSJ!d;`zK?P92U{f)xvD7VQVosrXZrL+ z6lMVdD1YgL;%(1cq{#bS6yXmp|DS@nax#AqqlZhtUQdh<^2vr5`EpAO

LGYq)sa(w9^3-f}NHy=GR4v%t2YZly3m1G@5y`xBh_HGrD%f z>;|Ty?9FiJAc&UVD(StT4I` zfVQwxhE9bXE6r2mKO8Ag7{L^jCyqQb0QqKDPE=RAgqn8q1O^>(z7h5kE(6va%QqRZ zkIOmp(})rLSS(2{=C12e&@!W2=Jel-^_R``0xHO^+t!(oXbcv5yhD4g*$t_F)_5Dl zSVCgesW%;DtYPCFs{G;GX_o?1J3;QQPPv)rWw;>} zJ&KwnUqwNXloNXlK_+pNDfI~hON#SokVJb&ilg8d7^NWo2ZQymCqQMnjfi>ePibjr z-Z@q!?RGN$Mj}Nk){X_vaj6?Mj$>ACR*z|6MsXy3VZ^PFn@yHkPo(>m(iWepn8SC@ z>D2;R4m+gDRZ=SIX!b+CP(qE=JDIUkn=D$aUu+Ihn9-+k1LS3PreQg0N5eWIG@x${nC3v^7caS>1!PKNAY9J z#}E}Q9w#SP>(GY7Hbj&z4$Li6o5taBO|4+F`yS9zq*LJ<38wy4I>HA9(&GYrk4dLajKGww))BWli6Ln1A^Lda@N~p+snkb9C z@OthI+<##vp8!HVQT4Wk(=@zQ{OvZ$EKWS73+JHb)eYLGD-cqi6^|vd$<+IHuc?Nq zW7JertT~3))4?J|28n$I@nAD0c1%9C&IVhEZX~mUsf{efyS(XNG%ch;!N~d7S(Ri7 zb&=BuON95aVA&kLn6&MVU|x}xPMp7xwWxNU1wS+F6#y}1@^wQZB*(&ecT?RnQcI}Y z2*z!^!D?gDUhc@;M^OpLs4mq>C&p{}OWVv<)S9KMars@0JQ{c_ScGsFo3BJ)Irg++ zAWwypJdTO-_{Uh8m(Z!3KL7K{ZZzKHj;{M8I$mV>k znTM?sa0);^=X^cglL`uC+^J)M7nEa$w=VwFULg~%DJllw+7dJAj3{qnP5i3@wr7%y zjXp?Wl2%Th=my&3u?Q$RV6N5tzKMSPTsc#J+-cDDp~qFB6bL2C8AS7Y3PKtVhdhl) zIaLqH5+OnWPWSt(lQCgkN8lczc-V%_iZ{>#1%Z$N*>lu#S;0MZ$T2Y8Kg!U;hAZj> z6S#%$DQ_`Ic%Zr@?}GgjRXg@qTj^17n`65oJ@Wj0u1X8&+UVd|Xs?J+i_^GZ94m6= zUc96~Q`OJvlKB_Lr15*Yw_PUPEr?f?H&00b^-W%26mD)(n(rGGNfK9~2h=C>p-7BZ zFd&*&Msdu{w~(eyFOglwCPH^Rb}O(N7LtS+nnEwDx*pGD?|&9Si~M43a+*L(b0$5A zv`T`(G3xO;I_sx;FwTP21ZlfDpz zOo?}Vlgf~fo{YWm@n_JyD*frOg{XsvBA~|Tn4V6hu>Gd>89-rblfVJUaGvj6X%NZ} z$tFF9sx=4_$*c~G`9iPLGh@=sV+O{D2-t*K@J7H=`V+oVt}8?04WwU3h1BgS!f%1P zFak-T#7`TtLcR=Yz>g0R!ZQrH!YiZOQN=_V-UyncN1Rc18?KY?#O`v#JK+pq0K$~H z3D@v9DZF42R)b9#BBX{^$DOMlJ!g)Gc za{o-1e%F6NvgKq9tC8pV+9S$;9*zNv{J*)n&dmf~anP1)4~N%~h#c(=B#3*KgzhCKhFdgDoWi2IDog{RVyzK|Y`rCUs3T~pJMmdZJy4?b z&s5G=zhf**(t7Y^oC_mcTsE-{^}wiaoUu&?kojLKs>SJPxjcP>{a5CbXCx92AcBE) zHtqP}LjZ{W>PH?Tu(E0X=%{PBMW@F_?#7b&#!^q`<-5$ur+-q6 z{dn=(^UZw6*3-XM_(=@<1_*i&XM4=0t5u!gm6 z{UlmNGPKgO_;e;q9|#esq~Sq`<}%d{+sRmhvsA{5i*91=tub>OZZ%)xUA#4q$dDyy z1`w4%?OPLg3JeZb#cqSMO?*Xn%|-FCcuH2i2fn_{IFusub6;NQdN|7TD1N?%E8*g? z$apAt@cEe!I%jB=*q$p_3=t_5R0ph%{qaq+QDg!c99Y!Xa!&oDZOeis_ot)gNXr{l zdY$|So2Qed2Y7KMNBrS^E169kG%h<+z{Z_p_;shB!uY)>yAVcK=&!bg`lVg)4T1|7 z0}7FpfydVH4F87K@c!nEG+WGKm{Ouo)Slpl;#qcEIQ0zdMfLA#;dBxYw;p;KoVv6| z3_D5&7rJdG12CnDSvZUW?$UC6^UVSW^|vw|o-_4bz)(w5(3AiVhpeT(|=f#x_}E?s#qHZF#xA6AF_ujl$G z-jHD%q(d2}v2PhXx&6YWps~m(^+RXl91Q#xRRJBhjKl$FG4bk);|ag;ieUZ&!Ii3$ z(iGz1+0m7#g5>ASldBbNZL=ZHh=tmmJt$!71; zIML2GhEz1pg@1rQN(M^_691wAGkJ@Pga_05WuQ6! zG5RkGY2^`@(H~pp7&Ga+Pwh3L!Njj!-rc;^bTIfo5hP@H##1X8xUZJckrx>id`bAd3QUx9GuomqBYZ!uN1-&o zvTxC?;p8vL67&fW8fw(YOqt>L@bdLrEF*3OgYe$4n4{ zEB40LiU#6-0@5jdN`0w}N0qi@c0~oT2FP z)LNk&a82my?jv(tQpiMi$TK_L@lub#lsM$R{Dk?Ya@%%%huZkct~tSWM714c!45k}-ZLVA-bVM`>|_ZBbW_m-7| z3U%xrAhi}n?T(2F{_n4EZ10inkIFl#y09?7$uwBoJgqY8vylwev)fDOn;>0R!aEnV zBz%j0Mqpx~EZU3q@%+oV7;}|vt7$~ou@faEIq{p?FY$XXg&6*K)b_LP=}gi9`Bij3 zN`zEo|B6*|-;>S`rNa^BKRDbDAk>X#MsR`EvL>6bqU@SaDDs z8>bu@3YdRaWs*Te@G-UHjU%F~kTHw5(0PVJ+pwh#ha2u;DB+UMo@A5UYIl#5rtBV- zGX_hIpw}3C@H*Us(Cc-d#-gNrG#w$(9+S=GxO>3SR`SE2fHZ2KrDc#_C^$jI>Y}#; zMwY=R6@+dWi~0RXw(c@3GZ&%~9K(q&ee0Zw;pwL`E_tZak-#8^_b)Dpyi73^he?xV zXJ08&wh5-M&}qy4f7!D&=E)puDD(Nmg1d_(j`4LvxM5x_huNg-pGG%9rYqO6mImyJ@}*3Y>^3OvcnTG%EV1) zq_Ap?Z!Iw__7#D=pOWnQN$gB!Mr0!9yx|g<4icJh{cFOu3B8}&RiYm+Mb;VEK``LK zL(NcpcTiGieOIssSjr?ob}^``nNf&UcJhXyncO9m{6gD$kqSD`S69(aF8dkWz5>!9 zBLe4Sib7Hs2x_L2Ls6Ish$MGVKrGt5+_2zCyP1byaCg3upo+-I}R4&$m)8 zQ7|jc1Z^VWggpuQj*cP;>Zo9LS!VSzrqmZczaf;u`d0J(f%Z9r%An@s!e>n9%y=n!IZ_tVGu{Jmsbp}Fk%HJIU?a+-~bjfLTuH|JExA8EROowzr zqW9{YyZhR0a4clRK>1I4Ncx&WER~{iE;F^$T7K%X@3PGOA%6#Z%p3TS^&M;Dnjw@i z^o!$9nhcsmcHcY4?4j9+ofL_CWsZ4Hcch(rjsGfGD(nsH>w}^ERqGnz%iGj0j{g}h z7wMkJ-2Z2~eS>2!i}0~B63i;>SyFJU2+>VCS^AxaDOx%g6-t0eM^P<3+*z`ztvOqrG3)&#$K?& z_Y0wbWID47@cU`E1A6A&!`aZk0ZE@z-h#l1NqX2#`$Uev2gepW`rf8*!=rD5&;Jb{ zl08rU>dPo=K%-1Ao1~G-@4ve~y5#9E8x;TE0k5d^TC(=Zc>mwjW^c=+U-<9}b0ku~}gj z3sbW>R2M6DR!g#NUP;nxo>)@7*=RP{U18SDop6b2&PHce^&h97@xx3t+VK+!keE#} z;(Uf&89as9k8{$nkLbuB!-d7TP`_VJpL^Xs8OKB~ri$YUbW8fch64}7|0EWoT(TRj{ z*GT<7Y<7DsrCi79ZsM)z#c(!nNOGySOCkY1fAuQOq12&iUVC!a`#O;dBLf=d?&4*B zI~LgAO7E0qxK(uRTM;IgJ}+z^gD+bi-6I!3x{r9`l~%8TRP%UE0V8E*Sz>Nl1NVG<<7(wDHZ+HcOkQm$O&k+vyx)y)x{Pz!U8hS$*m zByc0h6BUI*BOpuL==P+H|Hx%`>7!W+1H!l9vi&)`V zyn2o9{z=lc+VX*!Vh~SF=)L}Z40XeG>LF6cP^b+R$NxSeUqbK^Q*UTalKzP8X%{9@RSCXm_NhF>{=S2 zi}ezam_^P`S!!-cyEW9y7DBbK93roz@Raccy*v}?mKXScU9E_4g;hBU7}zSofAFda zKYEe?{{I54 diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties index a441313..79eb9d0 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-all.zip networkTimeout=10000 validateDistributionUrl=true zipStoreBase=GRADLE_USER_HOME diff --git a/gradlew b/gradlew index b740cf1..f5feea6 100755 --- a/gradlew +++ b/gradlew @@ -15,6 +15,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +# SPDX-License-Identifier: Apache-2.0 +# ############################################################################## # @@ -84,7 +86,8 @@ done # shellcheck disable=SC2034 APP_BASE_NAME=${0##*/} # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) -APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s +' "$PWD" ) || exit # Use the maximum available, or set MAX_FD != -1 to use that value. MAX_FD=maximum diff --git a/gradlew.bat b/gradlew.bat index 25da30d..9d21a21 100644 --- a/gradlew.bat +++ b/gradlew.bat @@ -13,6 +13,8 @@ @rem See the License for the specific language governing permissions and @rem limitations under the License. @rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem @if "%DEBUG%"=="" @echo off @rem ########################################################################## diff --git a/src/functionalTest/java/dev/yumi/gradle/licenser/test/ConfigurationCacheFunctionalTest.java b/src/functionalTest/java/dev/yumi/gradle/licenser/test/ConfigurationCacheFunctionalTest.java new file mode 100644 index 0000000..a81cde9 --- /dev/null +++ b/src/functionalTest/java/dev/yumi/gradle/licenser/test/ConfigurationCacheFunctionalTest.java @@ -0,0 +1,85 @@ +/* + * Copyright 2024 Yumi Project + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at https://mozilla.org/MPL/2.0/. + */ + +package dev.yumi.gradle.licenser.test; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.io.TempDir; + +import java.io.File; +import java.io.IOException; +import java.nio.file.Files; +import java.nio.file.Path; + +import static org.junit.jupiter.api.Assertions.assertFalse; +import static org.junit.jupiter.api.Assertions.assertTrue; + +/** + * A configuration cache functional test for the 'dev.yumi.gradle.licenser' plugin. + *

+ * Based on the {@link BaseJavaFunctionalTest base java functional test}. + */ +public class ConfigurationCacheFunctionalTest { + @TempDir + File projectDir; + + @Test + public void canRunTask() throws IOException { + var runner = new ScenarioRunner("configuration_cache", projectDir.toPath()); + runner.setup(); + + Path testClassPath = runner.path("src/main/java/test/TestClass.java"); + Path testCrlfCheckClassPath = runner.path("src/main/java/test/TestClassCrlfCheck.java"); + Path testCrlfApplyClassPath = runner.path("src/main/java/test/TestClassCrlfApply.java"); + Path testClassWithOptionalPath = runner.path("src/main/java/test/TestClassWithOptional.java"); + Path testPackageInfoPath = runner.path("src/main/java/test/package-info.java"); + + var result = runner.run("--configuration-cache", "applyLicenses", "--stacktrace"); + + // Verify the result + assertTrue( + result.getOutput().contains("- Updated file " + testClassPath), + "Missing updated file string in output log." + ); + assertTrue( + result.getOutput().contains("- Updated file " + testCrlfApplyClassPath), + "Missing updated file string in output log." + ); + assertTrue( + result.getOutput().contains("- Updated file " + testPackageInfoPath), + "Missing updated package-info file string in output log." + ); + assertFalse( + result.getOutput().contains("- Updated file " + testCrlfCheckClassPath), + "Found updated Java with CRLF linefeed file string in output log while it's supposed to not change." + ); + assertFalse( + result.getOutput().contains("- Updated file " + testClassWithOptionalPath), + "Found updated Java with optional line file string in output log while it's supposed to not change." + ); + assertTrue( + result.getOutput().contains("Updated 3 out of 5 files."), + "Missing update status string in output log." + ); + + assertTrue(Files.readString(testClassPath).contains("Sample header ")); + assertTrue(Files.readString(testPackageInfoPath).contains("Sample header ")); + String testClassWithOptionalResult = Files.readString(testClassWithOptionalPath); + assertTrue(testClassWithOptionalResult.contains("Sample header ")); + assertTrue(testClassWithOptionalResult.contains("Optional sample line.")); + + assertTrue( + Files.readString(testCrlfApplyClassPath).contains("\r\n"), + "TestClassCrlfApply.java is missing CRLF linefeed." + ); + + runner.runCheck(); + // Test the caching. + runner.runCheck(); + } +} diff --git a/src/functionalTest/resources/scenarios/configuration_cache/build.gradle b/src/functionalTest/resources/scenarios/configuration_cache/build.gradle new file mode 100644 index 0000000..de53da6 --- /dev/null +++ b/src/functionalTest/resources/scenarios/configuration_cache/build.gradle @@ -0,0 +1,8 @@ +plugins { + id 'dev.yumi.gradle.licenser' + id 'java' +} + +license { + rule rootProject.file("HEADER") +} diff --git a/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClass.java b/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClass.java new file mode 100644 index 0000000..23b38fa --- /dev/null +++ b/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClass.java @@ -0,0 +1,7 @@ +package test; + +public class TestClass { + public static void main(String[] args) { + System.out.println("Hello world."); + } +} diff --git a/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClassCrlfApply.java b/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClassCrlfApply.java new file mode 100644 index 0000000..dec87d7 --- /dev/null +++ b/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClassCrlfApply.java @@ -0,0 +1,8 @@ +package test; + +// This source file is in CRLF to test proper Windows compatibility. +public class TestClassCrlfApply { + public static void main(String[] args) { + System.out.println("Hello world."); + } +} diff --git a/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClassCrlfCheck.java b/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClassCrlfCheck.java new file mode 100644 index 0000000..97c48f3 --- /dev/null +++ b/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClassCrlfCheck.java @@ -0,0 +1,14 @@ +/* + * Sample header 2023. + * + * File: TestClassCrlfCheck.java + */ + +package test; + +// This source file is in CRLF to test proper Windows compatibility. +public class TestClassCrlfCheck { + public static void main(String[] args) { + System.out.println("Hello world."); + } +} diff --git a/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClassWithOptional.java b/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClassWithOptional.java new file mode 100644 index 0000000..cf46bbb --- /dev/null +++ b/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/TestClassWithOptional.java @@ -0,0 +1,15 @@ +/* + * Sample header 2023. + * + * File: TestClassWithOptional.java + * + * Optional sample line. + */ + +package test; + +public class TestClassWithOptional { + public static void main(String[] args) { + System.out.println("Hello world."); + } +} diff --git a/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/package-info.java b/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/package-info.java new file mode 100644 index 0000000..640f951 --- /dev/null +++ b/src/functionalTest/resources/scenarios/configuration_cache/src/main/java/test/package-info.java @@ -0,0 +1,9 @@ +/* + * meow meow + */ + +/** + * A test package info! + */ + +package test; diff --git a/src/main/java/dev/yumi/gradle/licenser/YumiLicenserGradlePlugin.java b/src/main/java/dev/yumi/gradle/licenser/YumiLicenserGradlePlugin.java index 14ca27b..ffbd889 100644 --- a/src/main/java/dev/yumi/gradle/licenser/YumiLicenserGradlePlugin.java +++ b/src/main/java/dev/yumi/gradle/licenser/YumiLicenserGradlePlugin.java @@ -25,7 +25,7 @@ * Represents the Yumi Licenser Gradle plugin. * * @author LambdAurora - * @version 1.1.1 + * @version 2.0.0 * @since 1.0.0 */ public class YumiLicenserGradlePlugin implements Plugin { @@ -51,12 +51,12 @@ public void apply(Project project) { .all(sourceSet -> { project.getTasks().register( getTaskName("check", sourceSet), CheckLicenseTask.class, - sourceSet.getAllSource(), ext - ).configure(task -> task.onlyIf(t -> !ext.isSourceSetExcluded(sourceSet))); + ext + ).configure(CheckLicenseTask.configureDefault(ext, project, sourceSet.getAllSource(), sourceSet.getName())); project.getTasks().register( getTaskName("apply", sourceSet), ApplyLicenseTask.class, - sourceSet.getAllSource(), ext - ).configure(task -> task.onlyIf(t -> !ext.isSourceSetExcluded(sourceSet))); + ext + ).configure(ApplyLicenseTask.configureDefault(ext, project, sourceSet.getAllSource(), sourceSet.getName())); }); }); diff --git a/src/main/java/dev/yumi/gradle/licenser/api/comment/CStyleHeaderComment.java b/src/main/java/dev/yumi/gradle/licenser/api/comment/CStyleHeaderComment.java index 0da3125..6c79020 100644 --- a/src/main/java/dev/yumi/gradle/licenser/api/comment/CStyleHeaderComment.java +++ b/src/main/java/dev/yumi/gradle/licenser/api/comment/CStyleHeaderComment.java @@ -19,15 +19,17 @@ * Represents the license comment reader and writer for C-style files. * * @author LambdAurora - * @version 1.0.0 + * @version 2.0.0 * @since 1.0.0 */ -public class CStyleHeaderComment implements HeaderComment { +public final class CStyleHeaderComment implements HeaderComment { /** * The implementation instance of this header comment type. */ public static final CStyleHeaderComment INSTANCE = new CStyleHeaderComment(); + private CStyleHeaderComment() {} + @Override public @NotNull Result readHeaderComment(@NotNull String source) { int start = 0, end; diff --git a/src/main/java/dev/yumi/gradle/licenser/api/comment/HeaderCommentManager.java b/src/main/java/dev/yumi/gradle/licenser/api/comment/HeaderCommentManager.java index 27fb3f9..57b13d6 100644 --- a/src/main/java/dev/yumi/gradle/licenser/api/comment/HeaderCommentManager.java +++ b/src/main/java/dev/yumi/gradle/licenser/api/comment/HeaderCommentManager.java @@ -8,78 +8,84 @@ package dev.yumi.gradle.licenser.api.comment; -import org.gradle.api.file.FileTreeElement; -import org.gradle.api.tasks.util.PatternSet; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; +import java.io.*; +import java.nio.file.Path; import java.util.HashMap; +import java.util.HashSet; import java.util.Map; +import java.util.Set; /** * Manages the different header comment implementations for given file types. * * @author LambdAurora - * @version 1.0.0 + * @version 2.0.0 * @since 1.0.0 */ -public class HeaderCommentManager { - private final Map headers = new HashMap<>(); +public class HeaderCommentManager implements Serializable { + private Map, HeaderComment> headers = new HashMap<>(); public HeaderCommentManager() { - this.register(new PatternSet() - .include( - // C/++ - "**/*.c", - "**/*.cpp", - "**/*.cxx", - "**/*.h", - "**/*.hpp", - "**/*.hxx", - - // Java - "**/*.java", - - // Kotlin - "**/*.kt", - "**/*.kts", - - // Scala - "**/*.scala", - - // Web languages - "**/*.dart", // Dart language - "**/*.js", // JavaScript - "**/*.jsx", // JavaScript XML - "**/*.ts", // TypeScript - "**/*.tsx", // TypeScript XML - - // Stylesheets - "**/*.css", // CSS stylesheets - "**/*.less", // Less (Extended CSS) - "**/*.scss", // SCSS (CSS syntax for SASS) - "**/*.styl" // Stylus (Alternative CSS syntax) - ), + this.register( + Set.of( + // C/++ + "c", + "cpp", + "cxx", + "h", + "hpp", + "hxx", + + // Java + "java", + + // Kotlin + "kt", + "kts", + + // Scala + "scala", + + // Groovy + "groovy", + "gradle", + + // Web languages + "dart", // Dart language + "js", // JavaScript + "jsx", // JavaScript XML + "ts", // TypeScript + "tsx", // TypeScript XML + + // Stylesheets + "css", // CSS stylesheets + "less", // Less (Extended CSS) + "scss", // SCSS (CSS syntax for SASS) + "styl" // Stylus (Alternative CSS syntax) + ), CStyleHeaderComment.INSTANCE ); - this.register(new PatternSet() - .include( - // Web markup - "**/*.htm", - "**/*.html", - "**/*.xhtml", + this.register( + Set.of( + // Web markup + "htm", + "html", + "xhtml", - // Extended HTML - "**/*.svelte", - "**/*.vue", + // Extended HTML + "svelte", + "vue", - // Data formats - "**/*.xml", + // Data formats + "xml", - // Image formats - "**/*.svg" - ), + // Image formats + "svg" + ), XmlStyleHeaderComment.INSTANCE ); } @@ -87,26 +93,77 @@ public HeaderCommentManager() { /** * Registers a header comment implementation for a given file pattern. * - * @param filePattern the file pattern to match files for which the given header comment implementation applies + * @param extensions the extensions to match files for which the given header comment implementation applies * @param headerComment the header comment implementation + * @since 2.0.0 */ - public void register(@NotNull PatternSet filePattern, @NotNull HeaderComment headerComment) { - this.headers.put(filePattern, headerComment); + public void register(@NotNull Set extensions, @NotNull HeaderComment headerComment) { + this.headers.put(extensions, headerComment); } /** * Finds the header comment implementation to use for the given file. * - * @param file the file + * @param path the file * @return the header comment implementation if a suitable one could be found, or {@code null} otherwise */ - public @Nullable HeaderComment findHeaderComment(@NotNull FileTreeElement file) { + public @Nullable HeaderComment findHeaderComment(@NotNull Path path) { + var fileName = path.getFileName().toString(); + int indexOfExtSeparator = fileName.lastIndexOf('.'); + var fileExt = indexOfExtSeparator >= 0 ? fileName.substring(indexOfExtSeparator + 1).toLowerCase() : ""; + for (var entry : this.headers.entrySet()) { - if (entry.getKey().getAsSpec().isSatisfiedBy(file)) { + if (entry.getKey().contains(fileExt)) { return entry.getValue(); } } return null; } + + @Serial + private void writeObject(ObjectOutputStream out) throws IOException { + out.writeInt(this.headers.size()); + + for (var entry : this.headers.entrySet()) { + out.writeInt(entry.getKey().size()); + for (var ext : entry.getKey()) { + out.writeUTF(ext); + } + + if (entry.getValue() instanceof CStyleHeaderComment) { + out.writeUTF("c_style"); + } else if (entry.getValue() instanceof XmlStyleHeaderComment) { + out.writeUTF("xml_style"); + } else { + out.writeUTF("unknown"); + out.writeObject(entry.getValue()); + } + } + } + + @Serial + private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { + var map = new HashMap, HeaderComment>(); + int entries = in.readInt(); + + for (int i = 0; i < entries; i++) { + int extensionsLength = in.readInt(); + var extensions = new HashSet(extensionsLength); + + for (int j = 0; j < extensionsLength; j++) { + extensions.add(in.readUTF()); + } + + HeaderComment comment = switch (in.readUTF()) { + case "c_style" -> CStyleHeaderComment.INSTANCE; + case "xml_style" -> XmlStyleHeaderComment.INSTANCE; + default -> (HeaderComment) in.readObject(); + }; + + map.put(Set.copyOf(extensions), comment); + } + + this.headers = map; + } } diff --git a/src/main/java/dev/yumi/gradle/licenser/api/rule/HeaderLine.java b/src/main/java/dev/yumi/gradle/licenser/api/rule/HeaderLine.java index 1b59672..04d0313 100644 --- a/src/main/java/dev/yumi/gradle/licenser/api/rule/HeaderLine.java +++ b/src/main/java/dev/yumi/gradle/licenser/api/rule/HeaderLine.java @@ -11,6 +11,7 @@ import dev.yumi.gradle.licenser.api.rule.token.RuleToken; import dev.yumi.gradle.licenser.api.rule.token.TextToken; +import java.io.Serializable; import java.util.List; /** @@ -19,10 +20,10 @@ * @param tokens the tokens of this line * @param optional {@code true} if this line is optional, or {@code false} otherwise * @author LambdAurora - * @version 1.0.0 + * @version 2.0.0 * @since 1.0.0 */ -public record HeaderLine(List tokens, boolean optional) { +public record HeaderLine(List tokens, boolean optional) implements Serializable { /** * {@return {@code true} if this line is empty, or {@code false} otherwise} */ diff --git a/src/main/java/dev/yumi/gradle/licenser/api/rule/HeaderRule.java b/src/main/java/dev/yumi/gradle/licenser/api/rule/HeaderRule.java index af8a4a4..33bb9e2 100644 --- a/src/main/java/dev/yumi/gradle/licenser/api/rule/HeaderRule.java +++ b/src/main/java/dev/yumi/gradle/licenser/api/rule/HeaderRule.java @@ -24,7 +24,7 @@ * Represents a header rule which describes how a header should look like. * * @author LambdAurora - * @version 1.0.0 + * @version 2.0.0 * @since 1.0.0 */ public class HeaderRule { @@ -61,6 +61,16 @@ public HeaderRule( return Collections.unmodifiableList(this.lines); } + /** + * {@return a view of the variables of this header} + * + * @since 2.0.0 + */ + @Contract(pure = true) + public @UnmodifiableView @NotNull Map> getVariables() { + return Collections.unmodifiableMap(this.variables); + } + /** * {@return the year selection mode} */ diff --git a/src/main/java/dev/yumi/gradle/licenser/api/rule/LicenseYearSelectionMode.java b/src/main/java/dev/yumi/gradle/licenser/api/rule/LicenseYearSelectionMode.java index f9a5466..a1e7055 100644 --- a/src/main/java/dev/yumi/gradle/licenser/api/rule/LicenseYearSelectionMode.java +++ b/src/main/java/dev/yumi/gradle/licenser/api/rule/LicenseYearSelectionMode.java @@ -8,9 +8,7 @@ package dev.yumi.gradle.licenser.api.rule; -import dev.yumi.gradle.licenser.YumiLicenserGradleExtension; import dev.yumi.gradle.licenser.util.GitUtils; -import org.gradle.api.Project; import org.jetbrains.annotations.Contract; import org.jetbrains.annotations.NotNull; @@ -27,18 +25,18 @@ * Represents the mode in which the year should be fetched. * * @author LambdAurora - * @version 1.0.0 + * @version 2.0.0 * @since 1.0.0 */ public enum LicenseYearSelectionMode { /** * The license year is project-wide, a change in any file of the project will update every file. */ - PROJECT((project, path) -> project.getRootProject().getProjectDir().toPath()), + PROJECT((rootPath, path) -> rootPath), /** * Each file has its own year. */ - FILE((project, path) -> path); + FILE((rootDir, path) -> path); private static final List VALUES = List.of(values()); private final CommitPathReference commitPathReference; @@ -52,18 +50,17 @@ public enum LicenseYearSelectionMode { *

* In the case of {@link #PROJECT} the last creation year isn't file dependent. * - * @param project the project the file is in + * @param rootPath the root directory of the project the path is in + * @param projectCreationYear the creation year of the project * @param path the path to the file * @return the creation year * @throws IOException if the file attributes cannot be read */ - public int getCreationYear(@NotNull Project project, @NotNull Path path) throws IOException { - Path commitPath = this.commitPathReference.getPathForCommitFetching(project, path); + public int getCreationYear(@NotNull Path rootPath, int projectCreationYear, @NotNull Path path) throws IOException { + Path commitPath = this.commitPathReference.getPathForCommitFetching(rootPath, path); if (commitPath != path) { - return project.getExtensions().getByType(YumiLicenserGradleExtension.class) - .getProjectCreationYear() - .get(); + return projectCreationYear; } else { Instant instant = Files.readAttributes(commitPath, BasicFileAttributes.class).creationTime().toInstant(); LocalDate localDate = LocalDate.ofInstant(instant, ZoneId.systemDefault()); @@ -77,13 +74,13 @@ public int getCreationYear(@NotNull Project project, @NotNull Path path) throws *

* In the case of {@link #PROJECT} the last modification year isn't file dependent. * - * @param project the project the file is in + * @param rootPath the root directory of the project the path is in * @param path the path to the file * @return the last modification year */ - public int getModificationYear(@NotNull Project project, @NotNull Path path) { - Path commitPath = this.commitPathReference.getPathForCommitFetching(project, path); - return GitUtils.getModificationYear(project, commitPath); + public int getModificationYear(@NotNull Path rootPath, @NotNull Path path) { + Path commitPath = this.commitPathReference.getPathForCommitFetching(rootPath, path); + return GitUtils.getModificationYear(rootPath, commitPath); } /** @@ -106,10 +103,10 @@ interface CommitPathReference { /** * Gets the path to use to fetch the latest commit. * - * @param project the project the path is in + * @param rootPath the root directory of the project the path is in * @param path the path * @return the path to use to get the latest commit */ - @NotNull Path getPathForCommitFetching(Project project, Path path); + @NotNull Path getPathForCommitFetching(Path rootPath, Path path); } } \ No newline at end of file diff --git a/src/main/java/dev/yumi/gradle/licenser/api/rule/token/RuleToken.java b/src/main/java/dev/yumi/gradle/licenser/api/rule/token/RuleToken.java index 0749124..5691b2c 100644 --- a/src/main/java/dev/yumi/gradle/licenser/api/rule/token/RuleToken.java +++ b/src/main/java/dev/yumi/gradle/licenser/api/rule/token/RuleToken.java @@ -8,12 +8,14 @@ package dev.yumi.gradle.licenser.api.rule.token; +import java.io.Serializable; + /** * Represents a token in a header rule definition. * * @author LambdAurora - * @version 1.0.0 + * @version 2.0.0 * @since 1.0.0 */ -public interface RuleToken { +public sealed interface RuleToken extends Serializable permits TextToken, VarToken { } diff --git a/src/main/java/dev/yumi/gradle/licenser/compat/KotlinMultiplatformCompat.java b/src/main/java/dev/yumi/gradle/licenser/compat/KotlinMultiplatformCompat.java index a21e4a5..5b259fc 100644 --- a/src/main/java/dev/yumi/gradle/licenser/compat/KotlinMultiplatformCompat.java +++ b/src/main/java/dev/yumi/gradle/licenser/compat/KotlinMultiplatformCompat.java @@ -26,7 +26,7 @@ * No direct reference to the Kotlin multiplatform plugin is made due to classloader isolation issues. * * @author LambdAurora - * @version 1.1.1 + * @version 2.0.0 * @since 1.1.0 */ @ApiStatus.Internal @@ -58,12 +58,12 @@ public static void applyTasksForKotlinMultiplatform(Project project, YumiLicense project.getTasks().register( getTaskName("check", name), CheckLicenseTask.class, - kotlinSet, ext - ).configure(task -> task.onlyIf(t -> !ext.isSourceSetExcluded(name))); + ext + ).configure(CheckLicenseTask.configureDefault(ext, project, kotlinSet, name)); project.getTasks().register( getTaskName("apply", name), ApplyLicenseTask.class, - kotlinSet, ext - ).configure(task -> task.onlyIf(t -> !ext.isSourceSetExcluded(name))); + ext + ).configure(ApplyLicenseTask.configureDefault(ext, project, kotlinSet, name)); } catch (Throwable e) { throw new RuntimeException(e); } diff --git a/src/main/java/dev/yumi/gradle/licenser/impl/LicenseHeader.java b/src/main/java/dev/yumi/gradle/licenser/impl/LicenseHeader.java index 76ad895..3315836 100644 --- a/src/main/java/dev/yumi/gradle/licenser/impl/LicenseHeader.java +++ b/src/main/java/dev/yumi/gradle/licenser/impl/LicenseHeader.java @@ -10,28 +10,30 @@ import dev.yumi.gradle.licenser.YumiLicenserGradlePlugin; import dev.yumi.gradle.licenser.api.rule.HeaderFileContext; +import dev.yumi.gradle.licenser.api.rule.HeaderLine; import dev.yumi.gradle.licenser.api.rule.HeaderRule; -import org.gradle.api.Project; +import dev.yumi.gradle.licenser.api.rule.LicenseYearSelectionMode; +import dev.yumi.gradle.licenser.api.rule.token.RuleToken; +import dev.yumi.gradle.licenser.api.rule.token.TextToken; +import dev.yumi.gradle.licenser.api.rule.token.VarToken; +import dev.yumi.gradle.licenser.api.rule.variable.VariableType; import org.gradle.api.logging.Logger; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; -import java.io.IOException; +import java.io.*; import java.nio.file.Path; -import java.util.ArrayList; -import java.util.Collections; -import java.util.List; -import java.util.Map; +import java.util.*; /** * Represents the valid license headers for this project. * * @author LambdAurora - * @version 1.0.0 + * @version 2.0.0 * @since 1.0.0 */ -public final class LicenseHeader { - private final List rules; +public final class LicenseHeader implements Serializable { + private List rules; public LicenseHeader(HeaderRule... rules) { this(new ArrayList<>(List.of(rules))); @@ -81,13 +83,14 @@ public void addRule(HeaderRule rule) { /** * Formats the given file to contain the correct license header. * - * @param project the project the file is in + * @param rootPath the root directory of the project the path is in + * @param projectCreationYear the creation year of the project * @param logger the logger * @param path the path of the file * @param readComment the read header comment if successful, or {@code null} otherwise * @return {@code true} if files changed, otherwise {@code false} */ - public @Nullable List format(Project project, Logger logger, Path path, @Nullable List readComment) { + public @Nullable List format(Path rootPath, int projectCreationYear, Logger logger, Path path, @Nullable List readComment) { List newHeader = null; if (readComment == null) { @@ -96,7 +99,7 @@ public void addRule(HeaderRule rule) { } newHeader = this.format( - project, path, this.rules.get(0), + rootPath, projectCreationYear, path, this.rules.get(0), new HeaderRule.ParsedData(Map.of(), Collections.emptySet(), null) ); } else { @@ -110,7 +113,7 @@ public void addRule(HeaderRule rule) { logger.lifecycle(" => Found rule in lookup.", path); } - newHeader = this.format(project, path, rule, data); + newHeader = this.format(rootPath, projectCreationYear, path, rule, data); break; } @@ -124,7 +127,7 @@ public void addRule(HeaderRule rule) { logger.lifecycle(" => Could not find rule in lookup. Using default rule.", path); } - newHeader = this.format(project, path, this.rules.get(0), first); + newHeader = this.format(rootPath, projectCreationYear, path, this.rules.get(0), first); } } @@ -135,14 +138,74 @@ public void addRule(HeaderRule rule) { } } - private List format(Project project, Path path, HeaderRule rule, HeaderRule.ParsedData parsed) { + private List format(Path rootPath, int projectCreationYear, Path path, HeaderRule rule, HeaderRule.ParsedData parsed) { try { - int creationYear = rule.getYearSelectionMode().getCreationYear(project, path); - int lastModifiedYear = rule.getYearSelectionMode().getModificationYear(project, path); + int creationYear = rule.getYearSelectionMode().getCreationYear(rootPath, projectCreationYear, path); + int lastModifiedYear = rule.getYearSelectionMode().getModificationYear(rootPath, path); var context = new HeaderFileContext(path.getFileName().toString(), creationYear, lastModifiedYear); return rule.apply(parsed, context); } catch (IOException e) { throw new RuntimeException(e); } } + + @Serial + private void writeObject(ObjectOutputStream out) throws IOException { + out.writeInt(this.rules.size()); + for (var rule : this.rules) { + this.writeRule(out, rule); + } + } + + @Serial + private void readObject(ObjectInputStream in) throws IOException, ClassNotFoundException { + int ruleCount = in.readInt(); + this.rules = new ArrayList<>(ruleCount); + for (int i = 0; i < ruleCount; i++) { + this.rules.add(this.readRule(in)); + } + } + + private void writeRule(ObjectOutput out, HeaderRule rule) throws IOException { + out.writeUTF(rule.getName()); + + out.writeObject(rule.getLines()); + + var variables = rule.getVariables(); + out.writeInt(variables.size()); + for (var entry : variables.entrySet()) { + out.writeUTF(entry.getKey()); + + for (var knownEntry : VariableType.TYPES.entrySet()) { + if (knownEntry.getValue() == entry.getValue()) { + out.writeUTF(knownEntry.getKey()); + } + } + } + + out.writeObject(rule.getYearSelectionMode()); + } + + @SuppressWarnings("unchecked") + private HeaderRule readRule(ObjectInput in) throws IOException, ClassNotFoundException { + String name = in.readUTF(); + + var lines = (List) in.readObject(); + + int variableCount = in.readInt(); + var variables = new HashMap>(variableCount); + for (int i = 0; i < variableCount; i++) { + String variableName = in.readUTF(); + String variableType = in.readUTF(); + + variables.put(variableName, VariableType.TYPES.get(variableType)); + } + + return new HeaderRule( + name, + lines, + variables, + (LicenseYearSelectionMode) in.readObject() + ); + } } diff --git a/src/main/java/dev/yumi/gradle/licenser/task/ApplyLicenseTask.java b/src/main/java/dev/yumi/gradle/licenser/task/ApplyLicenseTask.java index f1fe883..424a9bc 100644 --- a/src/main/java/dev/yumi/gradle/licenser/task/ApplyLicenseTask.java +++ b/src/main/java/dev/yumi/gradle/licenser/task/ApplyLicenseTask.java @@ -11,13 +11,17 @@ import dev.yumi.gradle.licenser.YumiLicenserGradleExtension; import dev.yumi.gradle.licenser.YumiLicenserGradlePlugin; import dev.yumi.gradle.licenser.api.comment.HeaderComment; -import dev.yumi.gradle.licenser.api.comment.HeaderCommentManager; import dev.yumi.gradle.licenser.impl.LicenseHeader; import dev.yumi.gradle.licenser.util.Utils; +import org.gradle.api.Action; import org.gradle.api.GradleException; import org.gradle.api.Project; +import org.gradle.api.file.ConfigurableFileCollection; import org.gradle.api.file.SourceDirectorySet; import org.gradle.api.logging.Logger; +import org.gradle.api.tasks.IgnoreEmptyDirectories; +import org.gradle.api.tasks.InputFiles; +import org.gradle.api.tasks.SkipWhenEmpty; import org.gradle.api.tasks.TaskAction; import org.jetbrains.annotations.ApiStatus; @@ -34,33 +38,63 @@ * Represents the task that applies license headers to project files. * * @author LambdAurora - * @version 1.1.2 + * @version 2.0.0 * @since 1.0.0 */ @ApiStatus.Internal -public class ApplyLicenseTask extends SourceDirectoryBasedTask { - private final LicenseHeader licenseHeader; - private final HeaderCommentManager headerCommentManager; - +public abstract class ApplyLicenseTask extends SourceDirectoryBasedTask { @Inject - public ApplyLicenseTask(SourceDirectorySet sourceDirectorySet, YumiLicenserGradleExtension extension) { - super(sourceDirectorySet, extension.asPatternFilterable(), extension.getExcludeBuildDirectory().get()); - this.licenseHeader = extension.getLicenseHeader(); - this.headerCommentManager = extension.getHeaderCommentManager(); - this.setDescription("Applies the correct license headers to source files in the " - + sourceDirectorySet.getName() - + " source set." - ); + public ApplyLicenseTask(YumiLicenserGradleExtension extension) { + super(extension); + this.setDescription("Applies the correct license headers to source files."); this.setGroup("generation"); - if (!this.licenseHeader.isValid()) { + if (!this.getLicenseHeader().get().isValid()) { this.setEnabled(false); } } @TaskAction public void execute() { - this.execute(this.headerCommentManager, new Consumer(this.licenseHeader)); + this.execute(this.getHeaderCommentManager().get(), new Consumer(this.getLicenseHeader().get())); + } + + /** + * Configures an apply task with default values. + * + * @param ext the licenser extension + * @param project the project + * @param sourceSet the source set of the files to apply to + * @param sourceSetName the name of the source set + * @return the configuration action + * @since 2.0.0 + */ + public static Action configureDefault( + YumiLicenserGradleExtension ext, + Project project, + SourceDirectorySet sourceSet, + String sourceSetName + ) { + return task -> { + task.setDescription("Applies the correct license headers to source files in the " + + sourceSet.getName() + + " source set." + ); + task.getSourceFiles().from( + SourceDirectoryBasedTask.extractFromSourceSet( + ext, + project.getLayout().getBuildDirectory().get().getAsFile().toPath(), + sourceSet + ) + ); + task.getReportFile().fileValue( + project.getLayout().getBuildDirectory().get().getAsFile().toPath() + .resolve("yumi/licenser/apply_report_" + sourceSetName + ".txt") + .toFile() + ); + boolean excluded = ext.isSourceSetExcluded(sourceSetName); + task.onlyIf(t -> !excluded); + }; } static class Consumer implements SourceConsumer { @@ -73,7 +107,15 @@ public Consumer(LicenseHeader licenseHeader) { } @Override - public void consume(Project project, Logger logger, Path rootPath, HeaderComment headerComment, Path path) throws IOException { + public void consume( + Path rootDir, + int projectCreationYear, + Path buildPath, + Logger logger, + Path projectPath, + HeaderComment headerComment, + Path path + ) throws IOException { if (YumiLicenserGradlePlugin.DEBUG_MODE) { logger.lifecycle("=> Visiting {}...", path); } @@ -81,7 +123,7 @@ public void consume(Project project, Logger logger, Path rootPath, HeaderComment String read = Files.readString(path, StandardCharsets.UTF_8); var readComment = headerComment.readHeaderComment(read); - List lines = this.licenseHeader.format(project, logger, path, readComment.existing()); + List lines = this.licenseHeader.format(rootDir, projectCreationYear, logger, path, readComment.existing()); if (lines != null) { this.updatedFiles.add(path); @@ -103,7 +145,7 @@ public void consume(Project project, Logger logger, Path rootPath, HeaderComment String content = start + headerComment.writeHeaderComment(lines, readComment.separator()) + end; try { - var backupPath = Utils.getBackupPath(project, rootPath, path); + var backupPath = Utils.getBackupPath(buildPath, projectPath, path); if (backupPath == null) { throw new GradleException("Cannot backup file " + path + ", abandoning formatting."); diff --git a/src/main/java/dev/yumi/gradle/licenser/task/CheckLicenseTask.java b/src/main/java/dev/yumi/gradle/licenser/task/CheckLicenseTask.java index eda7081..da6c04a 100644 --- a/src/main/java/dev/yumi/gradle/licenser/task/CheckLicenseTask.java +++ b/src/main/java/dev/yumi/gradle/licenser/task/CheckLicenseTask.java @@ -10,13 +10,17 @@ import dev.yumi.gradle.licenser.YumiLicenserGradleExtension; import dev.yumi.gradle.licenser.api.comment.HeaderComment; -import dev.yumi.gradle.licenser.api.comment.HeaderCommentManager; import dev.yumi.gradle.licenser.impl.LicenseHeader; import dev.yumi.gradle.licenser.impl.ValidationError; +import org.gradle.api.Action; import org.gradle.api.GradleException; import org.gradle.api.Project; +import org.gradle.api.file.ConfigurableFileCollection; import org.gradle.api.file.SourceDirectorySet; import org.gradle.api.logging.Logger; +import org.gradle.api.tasks.IgnoreEmptyDirectories; +import org.gradle.api.tasks.InputFiles; +import org.gradle.api.tasks.SkipWhenEmpty; import org.gradle.api.tasks.TaskAction; import org.jetbrains.annotations.ApiStatus; @@ -31,36 +35,66 @@ * Represents a task that checks the validity of license headers in project files. * * @author LambdAurora - * @version 1.1.2 + * @version 2.0.0 * @since 1.0.0 */ @ApiStatus.Internal -public class CheckLicenseTask extends SourceDirectoryBasedTask { - private final LicenseHeader licenseHeader; - private final HeaderCommentManager headerCommentManager; - +public abstract class CheckLicenseTask extends SourceDirectoryBasedTask { @Inject - public CheckLicenseTask(SourceDirectorySet sourceDirectorySet, YumiLicenserGradleExtension extension) { - super(sourceDirectorySet, extension.asPatternFilterable(), extension.getExcludeBuildDirectory().get()); - this.licenseHeader = extension.getLicenseHeader(); - this.headerCommentManager = extension.getHeaderCommentManager(); - this.setDescription("Checks whether source files in the " - + sourceDirectorySet.getName() - + " source set contain a valid license header." - ); + public CheckLicenseTask(YumiLicenserGradleExtension extension) { + super(extension); + this.setDescription("Checks whether source files contain a valid license header."); this.setGroup("verification"); - if (!this.licenseHeader.isValid()) { + if (!this.getLicenseHeader().get().isValid()) { this.setEnabled(false); } } @TaskAction public void execute() { - this.execute(this.headerCommentManager, new Consumer(this.licenseHeader)); + this.execute(this.getHeaderCommentManager().get(), new Consumer(this.getLicenseHeader().get())); + } + + /** + * Configures a check task with default values. + * + * @param ext the licenser extension + * @param project the project + * @param sourceSet the source set of the files to check + * @param sourceSetName the name of the source set + * @return the configuration action + * @since 2.0.0 + */ + public static Action configureDefault( + YumiLicenserGradleExtension ext, + Project project, + SourceDirectorySet sourceSet, + String sourceSetName + ) { + return task -> { + task.setDescription("Checks whether source files in the " + + sourceSet.getName() + + " source set contain a valid license header." + ); + task.getSourceFiles().from( + SourceDirectoryBasedTask.extractFromSourceSet( + ext, + project.getLayout().getBuildDirectory().get().getAsFile().toPath(), + sourceSet + ) + ); + task.getReportFile().fileValue( + project.getLayout().getBuildDirectory().get().getAsFile().toPath() + .resolve("yumi/licenser/check_report_" + sourceSetName + ".txt") + .toFile() + ); + boolean excluded = ext.isSourceSetExcluded(sourceSetName); + task.onlyIf(t -> !excluded); + }; } - static class Consumer implements SourceConsumer { + class Consumer implements SourceConsumer { private final LicenseHeader licenseHeader; private final List failedChecks = new ArrayList<>(); private int total = 0; @@ -70,16 +104,25 @@ public Consumer(LicenseHeader licenseHeader) { } @Override - public void consume(Project project, Logger logger, Path rootPath, HeaderComment headerComment, Path path) throws IOException { + public void consume( + Path rootDir, + int projectCreationYear, + Path buildPath, + Logger logger, + Path projectPath, + HeaderComment headerComment, + Path path + ) throws IOException { + var displayPath = projectPath.relativize(path); var result = headerComment.readHeaderComment(Files.readString(path)); if (result.existing() == null) { - this.failedChecks.add(new FailedCheck(path, List.of("Missing header comment."))); + this.failedChecks.add(new FailedCheck(displayPath, List.of("Missing header comment."))); } else { List errors = this.licenseHeader.validate(result.existing()); if (!errors.isEmpty()) { this.failedChecks.add(new FailedCheck( - path, + displayPath, errors.stream() .map(error -> error.headerRule() + ": " + error.error().getMessage()) .toList() @@ -93,22 +136,43 @@ public void consume(Project project, Logger logger, Path rootPath, HeaderComment @Override public void end(Logger logger) { if (this.failedChecks.isEmpty()) { - logger.lifecycle("All license header checks passed ({} files).", this.total); + var message = String.format("All license header checks passed (%d files).", this.total); + logger.lifecycle(message); + this.writeReportFile(message + "\n"); } else { + var builder = new StringBuilder(); + for (var failedCheck : this.failedChecks) { logger.error(" - {} - license checks have failed.", failedCheck.path()); + builder.append(String.format("- %s - license checks have failed.\n", failedCheck.path)); for (var error : failedCheck.errors()) { logger.error(" -> {}", error); + builder.append(String.format("\t-> %s\n", error)); } } + this.writeReportFile(String.format("License header checks have failed on %d out of %d files.\n\n%s", + this.failedChecks.size(), this.total, + builder + )); + throw new GradleException( - String.format("License header checks have failed on %s out of %d files.", + String.format("License header checks have failed on %d out of %d files.", this.failedChecks.size(), this.total ) ); } } + + private void writeReportFile(CharSequence content) { + var reportFilePath = CheckLicenseTask.this.getReportFile().get().getAsFile().toPath(); + try { + Files.createDirectories(reportFilePath.getParent()); + Files.writeString(reportFilePath, content); + } catch (IOException e) { + CheckLicenseTask.this.getLogger().error("Failed to create report file.", e); + } + } } record FailedCheck(Path path, List errors) {} diff --git a/src/main/java/dev/yumi/gradle/licenser/task/SourceConsumer.java b/src/main/java/dev/yumi/gradle/licenser/task/SourceConsumer.java index 4368b52..27fcf71 100644 --- a/src/main/java/dev/yumi/gradle/licenser/task/SourceConsumer.java +++ b/src/main/java/dev/yumi/gradle/licenser/task/SourceConsumer.java @@ -9,7 +9,6 @@ package dev.yumi.gradle.licenser.task; import dev.yumi.gradle.licenser.api.comment.HeaderComment; -import org.gradle.api.Project; import org.gradle.api.logging.Logger; import org.jetbrains.annotations.ApiStatus; @@ -20,7 +19,7 @@ * Represents a source consumer to execute an action on project files. * * @author LambdAurora - * @version 1.0.0 + * @version 2.0.0 * @since 1.0.0 */ @ApiStatus.Internal @@ -28,14 +27,24 @@ interface SourceConsumer { /** * Called with a project file to process. * - * @param project the project + * @param rootDir the root directory + * @param projectCreationYear the project's creation year + * @param buildPath the build directory path * @param logger the logger - * @param sourceSetPath the path to the processed source set + * @param projectPath the path to the project * @param headerComment the header comment type used for this file type * @param path the path to the file to process * @throws IOException if read or writing the file fails */ - void consume(Project project, Logger logger, Path sourceSetPath, HeaderComment headerComment, Path path) throws IOException; + void consume( + Path rootDir, + int projectCreationYear, + Path buildPath, + Logger logger, + Path projectPath, + HeaderComment headerComment, + Path path + ) throws IOException; /** * Called when the task has finished processing all matching files. diff --git a/src/main/java/dev/yumi/gradle/licenser/task/SourceDirectoryBasedTask.java b/src/main/java/dev/yumi/gradle/licenser/task/SourceDirectoryBasedTask.java index e7f8c0c..1f1c96b 100644 --- a/src/main/java/dev/yumi/gradle/licenser/task/SourceDirectoryBasedTask.java +++ b/src/main/java/dev/yumi/gradle/licenser/task/SourceDirectoryBasedTask.java @@ -8,36 +8,89 @@ package dev.yumi.gradle.licenser.task; +import dev.yumi.gradle.licenser.YumiLicenserGradleExtension; import dev.yumi.gradle.licenser.api.comment.HeaderComment; import dev.yumi.gradle.licenser.api.comment.HeaderCommentManager; +import dev.yumi.gradle.licenser.impl.LicenseHeader; import org.gradle.api.DefaultTask; import org.gradle.api.GradleException; +import org.gradle.api.file.ConfigurableFileCollection; +import org.gradle.api.file.RegularFileProperty; import org.gradle.api.file.SourceDirectorySet; -import org.gradle.api.tasks.util.PatternFilterable; +import org.gradle.api.provider.Property; +import org.gradle.api.tasks.*; import org.jetbrains.annotations.ApiStatus; +import java.io.File; import java.io.IOException; import java.nio.file.Path; +import java.util.Set; /** * Represents a task that acts on a given source directory set. * * @author LambdAurora - * @version 1.1.2 + * @version 2.0.0 * @since 1.0.0 */ @ApiStatus.Internal public abstract class SourceDirectoryBasedTask extends DefaultTask { - protected final SourceDirectorySet sourceDirectorySet; - protected final PatternFilterable patternFilterable; - protected final boolean excludeBuildDirectory; - - protected SourceDirectoryBasedTask(SourceDirectorySet sourceDirectorySet, PatternFilterable patternFilterable, boolean excludeBuildDirectory) { - this.sourceDirectorySet = sourceDirectorySet; - this.patternFilterable = patternFilterable; - this.excludeBuildDirectory = excludeBuildDirectory; + protected SourceDirectoryBasedTask(YumiLicenserGradleExtension extension) { + this.getLicenseHeader().convention(extension.getLicenseHeader()); + this.getHeaderCommentManager().convention(extension.getHeaderCommentManager()); + this.getRootDirectory().convention(this.getProject().getRootDir().toString()); + this.getProjectDirectory().convention(this.getProject().getProjectDir().toString()); + this.getProjectCreationYear().convention(extension.getProjectCreationYear()); + this.getBuildDirectory().convention(this.getProject().getLayout().getBuildDirectory().get().toString()); } + /** + * {@return the source files property that will be affected by this task} + */ + @InputFiles + @SkipWhenEmpty + @IgnoreEmptyDirectories + public abstract ConfigurableFileCollection getSourceFiles(); + + /** + * {@return the license header property to use for this task} + */ + @Input + public abstract Property getLicenseHeader(); + + /** + * {@return the header comment manager property} + */ + @Input + public abstract Property getHeaderCommentManager(); + + /** + * {@return the root directory path property} + */ + @Input + public abstract Property getRootDirectory(); + + /** + * {@return the project's directory path property} + */ + @Input + public abstract Property getProjectDirectory(); + + /** + * {@return the project's creation year property} + */ + @Input + public abstract Property getProjectCreationYear(); + + /** + * {@return the build directory path property} + */ + @Input + public abstract Property getBuildDirectory(); + + @OutputFile + public abstract RegularFileProperty getReportFile(); + /** * Executes the given action to all matched files. * @@ -45,31 +98,40 @@ protected SourceDirectoryBasedTask(SourceDirectorySet sourceDirectorySet, Patter * @param consumer the action to execute on a given file */ void execute(HeaderCommentManager headerCommentManager, SourceConsumer consumer) { - Path buildDir = this.getProject().getLayout().getBuildDirectory().get().getAsFile().toPath(); - - this.sourceDirectorySet.matching(this.patternFilterable) - .visit(fileVisitDetails -> { - if (fileVisitDetails.isDirectory()) return; - - Path sourcePath = fileVisitDetails.getFile().toPath(); + Path rootDir = Path.of(this.getRootDirectory().get()); + Path projectDir = Path.of(this.getProjectDirectory().get()); + Path buildDir = Path.of(this.getBuildDirectory().get()); - // Exclude the build directory unless it's forcefully included. - if (this.excludeBuildDirectory && sourcePath.startsWith(buildDir)) return; + for (var file : this.getSourceFiles()) { + Path sourcePath = file.toPath(); + HeaderComment headerComment = headerCommentManager.findHeaderComment(sourcePath); - HeaderComment headerComment = headerCommentManager.findHeaderComment(fileVisitDetails); - - if (headerComment != null) { - try { - consumer.consume( - this.getProject(), this.getLogger(), this.getProject().getProjectDir().toPath(), - headerComment, sourcePath - ); - } catch (IOException e) { - throw new GradleException("Failed to load file " + sourcePath, e); - } - } - }); + if (headerComment != null) { + try { + consumer.consume( + rootDir, + this.getProjectCreationYear().get(), + buildDir, + this.getLogger(), + projectDir, + headerComment, + sourcePath + ); + } catch (IOException e) { + throw new GradleException("Failed to load file " + sourcePath, e); + } + } + } consumer.end(this.getLogger()); } -} \ No newline at end of file + + public static Set extractFromSourceSet(YumiLicenserGradleExtension ext, Path buildPath, SourceDirectorySet sourceDirectorySet) { + boolean excludeBuildDir = ext.getExcludeBuildDirectory().get(); + return sourceDirectorySet + .matching(ext.asPatternFilterable()) + // Exclude the build directory unless it's forcefully included. + .filter(file -> !excludeBuildDir || !file.toPath().startsWith(buildPath)) + .getFiles(); + } +} diff --git a/src/main/java/dev/yumi/gradle/licenser/util/GitUtils.java b/src/main/java/dev/yumi/gradle/licenser/util/GitUtils.java index a080bb0..3da1204 100644 --- a/src/main/java/dev/yumi/gradle/licenser/util/GitUtils.java +++ b/src/main/java/dev/yumi/gradle/licenser/util/GitUtils.java @@ -20,7 +20,6 @@ import org.eclipse.jgit.treewalk.CanonicalTreeParser; import org.eclipse.jgit.treewalk.FileTreeIterator; import org.gradle.api.GradleException; -import org.gradle.api.Project; import org.jetbrains.annotations.ApiStatus; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; @@ -36,7 +35,7 @@ /** * Provides various Git-related utilities. * - * @version 1.0.0 + * @version 2.0.0 * @since 1.0.0 */ @ApiStatus.Internal @@ -55,10 +54,6 @@ private GitUtils() { return strValue; } - private static Git openGit(Project project) throws IOException { - return Git.open(project.getRootDir()); - } - private static Path getRepoRoot(Git git) { return git.getRepository().getDirectory().toPath().getParent(); } @@ -153,12 +148,12 @@ private static int getLatestCommitYear(Git git, Path path) { /** * Gets the latest modified year of the given path in the Git history. * - * @param project the project + * @param rootDir the root directory of the project * @param path the file path to check the latest modified year of * @return the latest modified year */ - public static int getModificationYear(@NotNull Project project, @NotNull Path path) { - try (var git = openGit(project)) { + public static int getModificationYear(@NotNull Path rootDir, @NotNull Path path) { + try (var git = Git.open(rootDir.toFile())) { Path repoRoot = getRepoRoot(git); path = repoRoot.relativize(path); var pathString = getStandardizedPath(path); diff --git a/src/main/java/dev/yumi/gradle/licenser/util/Utils.java b/src/main/java/dev/yumi/gradle/licenser/util/Utils.java index 542b218..04385d4 100644 --- a/src/main/java/dev/yumi/gradle/licenser/util/Utils.java +++ b/src/main/java/dev/yumi/gradle/licenser/util/Utils.java @@ -32,7 +32,7 @@ * Provides various utilities. * * @author LambdAurora - * @version 1.1.1 + * @version 2.0.0 * @since 1.0.0 */ @ApiStatus.Internal @@ -134,19 +134,19 @@ public static void trimLines(@NotNull List list, @NotNull Predicate em /** * Gets the backup path for a given source file in the specified project. * - * @param project the project - * @param rootPath the root path + * @param buildPath the build directory path + * @param projectPath the root path * @param path the path of the file to back up * @return the backup path, or {@code null} if something went wrong * @throws IOException if the backup directories couldn't be created */ - public static @Nullable Path getBackupPath(Project project, Path rootPath, Path path) throws IOException { - Path backupDir = project.getLayout().getBuildDirectory().getAsFile().get().toPath().resolve("yumi/licenser"); + public static @Nullable Path getBackupPath(Path buildPath, Path projectPath, Path path) throws IOException { + Path backupDir = buildPath.resolve("yumi/licenser/backup"); Files.createDirectories(backupDir); var pathAsString = path.toAbsolutePath().toString(); - var rootPathAsString = rootPath.toString(); + var rootPathAsString = projectPath.toString(); if (pathAsString.startsWith(rootPathAsString)) { return backupDir.resolve(Paths.get(pathAsString.substring(rootPathAsString.length() + 1)))