From 061ea5ea55d879efad11e4ede6a58dcefdd1a306 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ste=CC=81phane=20Goetz?= Date: Mon, 20 Jul 2015 15:59:52 +0200 Subject: [PATCH] Code Style and refactorings --- daux.phar | Bin 715082 -> 716480 bytes generate | 2 - index.php | 2 - libs/Daux.php | 101 +++++++++--------- libs/DauxHelper.php | 15 ++- libs/Format/Base/CommonMark/LinkRenderer.php | 11 ++ .../Confluence/CommonMark/LinkRenderer.php | 11 ++ libs/Format/Confluence/Generator.php | 3 + libs/Format/Confluence/Publisher.php | 2 +- libs/Format/HTML/Generator.php | 12 +-- libs/Generator/Command.php | 4 +- libs/Generator/Helper.php | 7 +- libs/Server/Server.php | 6 +- libs/Tree/Builder.php | 37 ++----- libs/Tree/Directory.php | 4 +- templates/content.php | 20 ++-- templates/error.php | 4 +- templates/home.php | 28 +++-- templates/layout/00_layout.php | 44 +++++--- templates/layout/05_page.php | 23 ++-- templates/partials/navbar_content.php | 2 +- 21 files changed, 193 insertions(+), 145 deletions(-) mode change 100644 => 100755 daux.phar diff --git a/daux.phar b/daux.phar old mode 100644 new mode 100755 index 3621bae04c8e581fcbca7b8a0d5ac3c1962d0bf3..20e5f6b63010de61a74533a80eed8f552ca9688e GIT binary patch delta 8401 zcmbVR33yZ0w$5&wq&=O|CY{^#bWGE9E-jr03Z>8)T80j^X?mIl(j-mNGE^qfB8n8c zm7|CZSM(|%SFMsyLGa;K0SCYfS3prwyb356o)dys-#&XK)PeW$zSr+NU1#sT_8R}S z_D*v2ea&m)euLHYcY*mt1SB#lvnB-H8(Xnp=VFW2bC^ z%6u*kW5zv~E>^h5=d0X6oIodin5El`2p9SDC6Ce2WlNu|9axlR>9zC+0i!@){9u(A z-sT=H`z{711^UGy(?xvDJ(i08&b=Lr^sdS%IiNE8J(1iDK#$BtXP(kRmdUg@&E5?B=I=2r@P z@KLV>8Sep;0zLF|XfFQM3j!L?q{+T_=1QOoUc53BcQHv++=EO3rAHZ!EZh$y2sGiC zox@`97};STm=x$cbF1rcu6F|6G0!`L(hc4zl)mPjOzAh?8cHL4N-1skDWY_zc*gv z7f2bl_|2dUKa+Gn-za?vqiBI4hE9%>;N84F`Z11)jKgOC1Uk8jc(?Xx-ytWbH-67Q zn2P$+zlJjSM~Xxq4>ZJ6hS~sMY?dkL!V3g}EeqCUVU~@itP6j1iyr!5;XGv9O6lL zSA~Gekr0q}I%FE1j}L`HHiiNKPRK=~Z;n40j2lTVKMj}Q3!#w9pF#mKg<;_N7O_ZF z-Tt+KhEZU2ghfyjHj!knp5L^UqCr@YhC@hV!mFrCV>qaM(Mf*}pGY^VNo`#AOnmrO z6uKfJ>4udNVC%aPARsgniryGGg>F1ZI&Npql(+FgUt)74gzb9dbh>#;6o7Xms*Exh z66RxPxw~w{m838srNBoNy9 zPiROE+y453J;A6$gQB@#5m*7VwUrA`7v^)`_ur?7aIFksLC99xOuTViXzDeZx88-~# znv`UGFj0(|q$nyNISEW&;-p8DU?Z!ZL)VAYFg~FMmy(jTbbf6zRPgy^n9tJy-#QJ< zf39h#d=)9pls@L9-=;tsi&7zU>r>~_^{-RGq0%&{u&OYT=+)C`6F$)<$9vMCBVI{^ zMt6?%mVnl51-{lK#~ta}G*sQ>@V@%bS2wwGJ(}r*&8bp+EFDgk^XafzN|Nxx3DtGd zD&%-+Trg(SJ+UQ2Muli(B2j_)#``qou;7W`$Oxb|p2?`7G&-|{(#}jL6f*()KV^as zHCZs;m<8jDSy0oOY$&9AN%wf>p|H1|z)PaSUde{efhIuftDgYEw@iSH{(AycXJHP^ z-=71CJDUTUSLH&zn4Q#-3o-jK7nJ8u1pYNndd5lBd62MWc_8=QJm8DUhgNLPhyBmz zLyPt<&{2E)3m~ya3Shsou#rYEL@E;P|EKZ{o)@pgofCaVi=}vXA#|9x3ujTDc9McU z63t=?^|B&>dL~Kg#t(<5jBoVihs{zyZ{bGsFu^Z5IPtqh0GpU%u(H1xw7*#lA(xdv zG}=p`eSS&0g597yPn%tPqBq`F;e*eX1W_}>h^ePfZ4GfECYAbCQrbf4W2GSZYAJMV zJxSVvq^PAhKqtqoX&}i^2F-XKIeyftxRT$gd8G{0tR{tR`&2uds<~1IYLw+r2l{eQ zv%ee+P9@CQ8_Pby8M#VoZ2qJ`YERuH$nVBUa4R@F3G$Ot0Uj@|fGgPk3doCMatGZv zI2jbYJsH5LoC0Mq(@P}s+7Av`dDmcyFse&6q^0e8MF@d0D$F8qd;gz-NxUNcyU!N9A{rq?u zFcwV*jP(#k&T?=KX&`DWNIW?mn)kKokl?y%0BjIJ!G+I*?!U!&z8V;RsRoH{H4w=I zHPEWUYhiv-Ettd;O{eq{HIAB`j-RV#u%a%C+NvW9MZP!wgQKfpVXzKt-B1V3@mihJ zlzNc7vmT=H0onMErhgo#^)b>IjPn~JsFSlBAo-6qK+?ZzfTU|0p|jMHj4fmCb8~Kl z!ipjemVT01ikDAT&*J? zqqEBJxn{`pkIkLbvX)tGl)gL*lzGhtu(i*I@w2m`A^zeV*UbUYZJz^2T|be%sE{Q34%j4&X^;`|89j#r>qTfYiWZzJlqDkjcb!Vw;$1r1BI5Wu5a==5P-FgA2S0QYyn3FE1Q0MB*OojTzE$w{laA(@-H;hN+} zE?G}6_kWu9w|XuDE4e^w=`gW0>=nfx=RzvAayeH-=>ZNPBI$wt)Y=1p+};EI)}3^S zto9djNlQ(`N__y`l%)q#R_bB%5j|Y~N(t`mM|dfYnGuec^^kjBF9dB)ZxuDAoG={y zI`h&khEBZ~KHKXB&bWIj%S4(8bjTIP4D_ASz+=0n%Ob;auD? zA5NYt^Px1e7Qne{T>yOh7QnjL2qxDW0nXcvDb%tJ1d%y^U)zSy7(rn`Um;ao-v_ll z+E+jse<0}mZpBA-e7a8~%L;}TEl|z&v(@;qz66|S0)M8OqLTZ`aV20{pfB(H@v!R~ z1JVmbHPb4l)XkhyPXr1*c%7+B(rfQCs@m}t({i^V2KSkBluJ3Ijbn!xPS_$%2UdSxP`^?KwF)p{fNdEuFa?rUedMSISZAyH0jSrq+4Imo>Y%$nm?Imv? zTQ#V7EWpMhmnrG?%z$D+u~pk=YgK`PV;1{;NYHhCK;uTN=pRkS^$W##*OCl;cCiM3 zI^gSV=p(kO+SSB%{Q6)&u;pRn!o7hYq*Z0*EM_N1@}hK?#@UN1(Nes5QHG%4okcUq zAZqaiYGyDV7@a^w_~FhaFT40dhWcEu1?wV&OytX(F@D=ZR>?s_)OrPIF9 zV7GHtqE@i1$86=ax?VQv4-VqTN5aM~+~tnEiSNByQ@4>TWbxJYy0O+}I}x$Pcg5u3 z--N}k)f){aAtx;ETaio{wytO-k-WYln#L*Q?jj)oGw+@**!TF|g~I6c-LC{OtfA-6 z+PAFIxm@~nRXJjD**y^o=60O+dsdcAf}1Y)r7y)}Zix%bW?A$;y$6$~=5 z=WraENFL56X3kq3fmaM;VM)H4=CWjUD4id63A-%bqlFP3Y(uorc>Der!4VOrnH2?SC(j8rt2S6 zCj2?^>|J+_n*_^v(}N= z5N^SWfc0T`-blGq+}PtIlm3XM3u(Urkju&*qghL$MuMiIuc?CuZlQ{XYwXtz@4698 zoqWjV?!mAO%QwI05#u4?7>_&>!cT7z`vwa0PE45xIjhys&7W%(N5;5j4Ym%g)v8^b z6mRb}*jnQkaEnQb5))Z|L#J55kF<-$5}4(0*u7ZSyVBtvh97<;h~JpN`18-1y?n-A ze+b00db9&ZyNxYod$go^6*3I-M;^PCMM z4d#EfF%s`?v(DCG(b{{}3{Kk~g=cSVz&E$vh~{6lyDvAUtV*Ac7uYim6t@!Ds+Lcu(} z>-%s44%9yWm0F~Xx}B+{8TSd`FLWf=p>qf|@tzH+GQ?#Xw~(bOY=B+7?PwA&YepXY zVJ-3>Juc=yi9_D_&7EQVI}IpQZsoePHm<^K>M`gC$XD_Pvxy&4p-%p$3bjdWb~2;m zwModv-;8BK@DDqyX^Q>Gsbn(`SV>S-Y#PHi#Ca%~G*)Hr<@(4Jzw!enT>kshkaU7x z4lmwS;#w(ACe>g}DD0_1ND|zE$TTY~$~riW2y` zTqMCee~sdIHy|(m@i=r;l0v0EoPm;F>O;PW#|daN^`Fm9M9qAmoG^|iqIdZ0FmWV* zISI8z3qPS$aYhSgEhxBMa9h;qd%>Szz9|_kza#sPNoM`R8P@J=9C#ED2%^ajo5I8VdJ|= z1O!?1Cmybe^sppS1N>jAQI5d8$KNd^*$HA=RJS(#rXF1&XN&pmA#RE|7eCa}xDNZR zUy_pe&IY96zc2Do@QF1jfY;WdN~$d5Rt>BESAF9w?M{`U<5N(O3 zm{8L;{!k4n;bXNZUO>>ZfRpw{6z{{t8_hbcu|p^|p)|q*e^Wjwq&ty@Oy_-nGta2` z4VR<}K79bm93MBL9a5Rfs5R*agbO2ETte;ujumrJl_%fwnp+I6el(iDswH)vJ`n{8 zZB?u$bbT4>ll;c$xruN2LJ; zqM7lxy0WV&r!d}Mcr_&Iz{=y}BF*_mL+>t@vA##h+L(HLb#*>UmYibBqpR@I=^Xy_(aL3&~7 z;1-d4i;bK(Hj*8S6`d3hSPi7W)>%>H>R}rqj~jX1$>TvDF?l59k&?%gJYJ4r8}pYc zmdhtTcTLdcP3+Fk%GOTI%E`&k$mHd=jY}-s`fLFqC2yp15Ey%+4z=&%%gV} zCV!3bcDo}RUvh}azay7}Kg4JPrQ}lDV=!{O`4p4Le|wVYcg;A+%njrk3F|q0!D%Lx z*PLRK_=_Jf0l!;wkhK&a$GQv5Hjl_zuMX?3>5uP7kQ_*x;`r>n8Jwk=e5WItI;nQj F{{TTFYsmlr delta 7561 zcma)A2Y6J~ww|3flS!Lo((4HXCcTp0Ne?Nc(ULGsCMU^|$;@PCLJ}YXB0*G&tS3hi z5UyT9kP^am?22A2=v7pnNc)1K*zk$h@|3Ii_StKa==;3S=l2~~_FiSL@~^e`@Z#mT z)9=O|GZN?cK8d6ktRziw#!(`fv+_`jNXK>u?gbl(P`oU`O_3f5kDUqENVsCe4L3#l zQOfL>!Pg;H@wE&$MH;c>wOXiih*r4SB}IBTuI*_Ub;xw2hro*tIf_s0wnZ9vbJ04G zJ7zFuiDOjuFhO%7Z9ee8;wLB-|MQ@qUe{qsD%A`OC7OCnBi?prD1CD6P9yAfj8M$t za8snipO;m@+m17s>F*qC@Cc_eM(=jYbQgnepytn!qA%d6ED)lcgBY{OIhD}?=X6F7 zJEQZTI%l!<3>RFtxiqr%m`ekr&eA4ETcz_DeN39q=;zWRM&o6;*2~fq?)D6c^r}JS zMIA^`JZ;aVNIy^qNQwx8wM!ss^7Dn>7PVhvKfYT0_7R|6~TdQXYuo&z4M zpg&p(+Y}0D_i_Vwg+F7Cgi0h06Dux&cZU*Ic_Xt;;m4R>l<9Q${3yF-3fnwRak8X$ zQz{fkD&dL(WAX5=XJ@MIbj%xlAU+G&{t_Sb?Wj*HTYD%MGGlUQiNrttxdezTQNldG z0NAMvWdctr5jav`OhSWiHQV3gTg((ETqF|X^W-W-W+>s7FP1#XuapU`@I&Rl`&F{F zmw!2)bHv0 zg65F|HZp;opqNq0EFYmk>XS44X^=56GE)lMW_UBkOI{MmhnEgL1O2K=hAUi~fwjFk zqmEgbHxmPVXeOfb`b>mikMa1}) z(`+Qc=~>u%T3Y6{|2Jy2Iu4`sv)Td{o3jr#0tw)6u z_<0p}rXm_o?TJPgpR`k149YEyS;Rtm%D(oBZD#APSPi46W3huH;xM%DX$^&AZXC@| zEc_ZLhw(Vbmxsl08DPE4hqxw;-s>nZ*tYG|;$rx-v3if1s zN&(y7lVXQZ3Qn8MRP^PpRP0d+MalX7cj=%gH5I(l{Fss|4I5dPhF~2_!v_D+P7CK? z7i^w`#xKpm$|R&?YYwO5{%h%2k-!YBAfJKu4%_MX8Tl-zaXO8AZ$D87$!Rgro$0|g zuhHA4PT}WD!4nRq9C!FSOA2F|O2$m3Lo(=yuJ(6Kl7&oVyhQTl50S~gV>VQvsH(t^hOmpnd&G z0rp06A!dAa;S%QM`9jo7EGl8%bkp+oMu&|6rwZR*bDi+$X8SB zzq~*AAege4{0GGm%4i-&woLTGg<1BQ7tDl{ z=3$NQnTM`lnTKN_uLh0mtihc8T!Z_IYFk+jI%p1Fb%{=)Cnv$ST37h*TFil>PR#_g z^wd0$o4?RlvS7R}h@JL!9S*6adi$yMX!W!DB~0lYReG=ay)&?nW_EBs27ljtEZ_P0 zShm>>STM2-PxF%CxzZR|+vW-HF7aU=#M1IPzH@d2 zK3tj%Tr0kS>J;>K`0&O|hHFv!j#jMc?pDO}eY8AgljdPq*CJ|3VNM$cSl5PiJ<`^~ z%s)xZca^MDQ^=uUd3z9JR8z*c@#YIq?5Tv?+OwJ0Pq(A@K}&I}tyzjue6SQzVWP)& z!upx)Sc5v8DQ#72n8iw(%db|+~ z9;CsZ3ZHl#zR@Ovp%Y&kFCLOevd>ELYJ_Oo$ z^r4@}vG^RH$1?CUj~FfOLfk*lg}9&S!ZGVeeN1gXo&gW_Btl!aH&Zfo;|=pdH#SEp z_0exgTg#q$7rP_fE#j-EknV~e z>h(L%FspC&`oMn;av9y+hm+z=Uk=myfwn{Snup|*S`k!B8BwCw zSS&S0O($;_W1s7fzcxks`G0&B2n~jmYVpiQnv~T`Kl<0CHoe6p-MoP}YpnbObRo)! zG_K^#-zH@!o+LF@C1rI@W%c+w7~V8=K!$Mye(6sS;`J7uXN563R_Qki6Z=Nfd;QrW4bPy#5#d)K0F92E`76&E`$hivUa9^kTC) z5;`rvLa#MRF)1$kWY+Xq#t&KVB#^!$4vZ^f!3fT9X_Ff$R@R7q!1WdW;567zdFAlj z-~pMLHyKs!F&qpICBc!QQuvP2S;LKBT3HLP4DS$?{C^v=)@ZQu2CEpfY2_`MUT5gF zPy?`aODODIRRM8ZgTZNa6&yDOgKqWVFzcYsYURyTB!*ih?=qTsjkYIx($~_FP~tru zL664JspoUy%)Q$2w{AN~rXwC+TN*kohmq3!Yr3fetODqt$!MVS9pT?4j%})qn^^jh{DMfwyJuJ78)X#!>Op_x$+UNus{yp zD+1u^9gFGb4J{j#VA>EwIJj#=4J;W=0oPF#q>j#}e>cOi(bTE);rzxBxHSp@8{^=` zje);qjQ(K-;gI#EaowgNN7%BN1INutKK69As?2=<057@*pKj)y86K(7?0+Kw+%{iG z-0lKPR{269Es%Cg0NlQ1GrYA*DHh6w6;=hFtFxUt%mpeKGX=p~lZzcG9$r>scekEb zYmJ>W#}p(dw(4la+_v`d4cm(TxNslGO_gb~%B`v{y-`D*F2p|)R_ORaRgOv(Gyc)` ze>hAfWc=8D7RL}>7Z)96T)~^ox=xbb!~CuywduGb?UN3&9uF%>g$@o z@Zf#Ih9Q}cu&s@FK-aFlLdBO30pU7>&RSwLP-_Nigo4TG(ro7WXyHnpLnu7DyIj_%G52;F2MzG;?ncryzHrZ* z1d8_tI>(41(Z7;?o47=d#gI_YY1CTOCXKZR_B|X9f7?615#z|o`S*cv`CJrrQ8S>o z(oz|^blt706&k&+Q$2aKnjfM~YthlD#Kv{pcZ@o6YF{j&ggpEn5e}V_DaNlpQbwTS z(RtC<9=?xHFlhRC6_;Ny>6+1G6%Ej?6WOZvcsbnr=J1;uNy}5BdK}Asy6%_Ech}Vpmg1HzjRpBw6^$-&p}$FUo|+(ulY1WE#07 z75mrp}XXxaIRKhz~h|+elg8bql1a}c7a6d|6 z>mg4Wr?GIA&9ybcU2$X^pcCrXC`=+cs&T08%U7wxJ~9N zi>H{T$&81S7yTUNa!yEYBJ=5EC$^e-NQ2g(6 zg~TROkr!oee52XIT9LZVl0TI!Iz@8nl%khkpTC}6Bcy>XB?M+$}J+A#$sEm{yq;E1^J~vpPDaR#JrK3iUm- z0j)h`i=#iosk)aRrZ+G}2f{X2__3EZ!`s=!5B41Q7fgDRE*#dA>~J=ACSL@)KKd}D zdXer_l_EfVt{wD7> zY6d6Xq-7dPQi*ez;Bm@9A#gr27a^dJj5>Ge%oeNgmp&2)cRl7NY`vREZ4-UOndHg2 zY5dT`#EMP@|6ukKlOS#akG;AisC&FHXq2EcdciUzDFBzu#Q;`=!cu zowNZtr&Q$R{QhzA#24~MoI?AzoF3kKVf0Sb+3oMYDm}krQ2WF;^f$DmVs7o+ F{{iA4MHK)5 diff --git a/generate b/generate index 146dd5b..9c5d154 100755 --- a/generate +++ b/generate @@ -66,7 +66,5 @@ software, even if advised of the possibility of such damage. require_once("vendor/autoload.php"); -\Todaymade\Daux\Daux::initConstants(); - $application = new \Todaymade\Daux\Generator\Application(); $application->run(); diff --git a/index.php b/index.php index 5dd44fe..350e1f4 100644 --- a/index.php +++ b/index.php @@ -84,6 +84,4 @@ if (file_exists('vendor/autoload.php')) { throw new Exception("Impossible to load Daux, missing vendor and phar"); } -\Todaymade\Daux\Daux::initConstants(); - \Todaymade\Daux\Server\Server::serve($_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'], $_REQUEST); diff --git a/libs/Daux.php b/libs/Daux.php index c654ba2..14815ba 100644 --- a/libs/Daux.php +++ b/libs/Daux.php @@ -53,22 +53,32 @@ class Daux } } - public static function initConstants() - { - define("DS", DIRECTORY_SEPARATOR); - } - /** * @param string $override_file * @throws Exception */ public function initialize($override_file = 'config.json') { - //global.json (docs dir, markdown files) - $this->loadConfig(); + // global.json + $this->loadBaseConfiguration(); - //config.json - $this->loadConfigOverrides($override_file); + // Check the documentation path + $this->docs_path = $this->options['docs_directory']; + if (!is_dir($this->docs_path) && + !is_dir($this->docs_path = $this->local_base . DIRECTORY_SEPARATOR . $this->docs_path) + ) { + throw new Exception('The Docs directory does not exist. Check the path again : ' . $this->docs_path); + } + + // /config.json, + $this->loadConfigurationOverrides($override_file); + + // Set a valid default timezone + if (isset($this->options['timezone'])) { + date_default_timezone_set($this->options['timezone']); + } elseif (!ini_get('date.timezone')) { + date_default_timezone_set('GMT'); + } } /** @@ -76,31 +86,18 @@ class Daux * * @throws Exception */ - private function loadConfig() + protected function loadBaseConfiguration() { - $default_config = [ + $this->options = new Config(); + + // Set the default configuration + $this->options->merge([ 'docs_directory' => 'docs', 'valid_content_extensions' => ['md', 'markdown'] - ]; + ]); - $global_config_file = $this->local_base . DS . 'global.json'; - - if (!file_exists($global_config_file)) { - throw new Exception('The Global Config file is missing. Requested File : ' . $global_config_file); - } - - $default_config = array_merge($default_config, json_decode(file_get_contents($global_config_file), true)); - if (!isset($default_config)) { - throw new Exception('The Global Config file is corrupt. Check that the JSON encoding is correct'); - } - - $this->docs_path = $default_config['docs_directory']; - if (!is_dir($this->docs_path) && !is_dir($this->docs_path = $this->local_base . DS . $this->docs_path)) { - throw new Exception('The Docs directory does not exist. Check the path again : ' . $this->docs_path); - } - - $this->options = new Config(); - $this->options->merge($default_config); + // Load the global configuration + $this->loadConfiguration($this->local_base . DIRECTORY_SEPARATOR . 'global.json', false); } /** @@ -111,33 +108,37 @@ class Daux * @param string $override_file * @throws Exception */ - private function loadConfigOverrides($override_file) + protected function loadConfigurationOverrides($override_file) { // Read documentation overrides - $config_file = $this->docs_path . DS . 'config.json'; - if (file_exists($config_file)) { - $config = json_decode(file_get_contents($config_file), true); - if (!isset($config)) { - throw new Exception('The local config file is missing. Check path : ' . $config_file); - } - $this->options->merge($config); - } + $this->loadConfiguration($this->docs_path . DIRECTORY_SEPARATOR . 'config.json'); // Read command line overrides - $config_file = $this->local_base . DS . $override_file; - if (!is_null($override_file) && file_exists($config_file)) { - $config = json_decode(file_get_contents($config_file), true); - if (!isset($config)) { - throw new Exception('The local config file is missing. Check path : ' . $config_file); + if (!is_null($override_file)) { + $this->loadConfiguration($this->local_base . DIRECTORY_SEPARATOR . $override_file); + } + } + + /** + * @param string $config_file + * @param bool $optional + * @throws Exception + */ + protected function loadConfiguration($config_file, $optional = true) + { + if (!file_exists($config_file)) { + if ($optional) { + return; } - $this->options->merge($config); + + throw new Exception('The configuration file is missing. Check path : ' . $config_file); } - if (isset($this->options['timezone'])) { - date_default_timezone_set($this->options['timezone']); - } elseif (!ini_get('date.timezone')) { - date_default_timezone_set('GMT'); + $config = json_decode(file_get_contents($config_file), true); + if (!isset($config)) { + throw new Exception('The configuration file "' . $config_file . '" is corrupt. Is your JSON well-formed ?'); } + $this->options->merge($config); } /** @@ -169,7 +170,7 @@ class Daux 'mode' => $this->mode, 'local_base' => $this->local_base, 'docs_path' => $this->docs_path, - 'templates' => $this->internal_base . DS . 'templates', + 'templates' => $this->internal_base . DIRECTORY_SEPARATOR . 'templates', ]; $this->options->conservativeMerge($default); diff --git a/libs/DauxHelper.php b/libs/DauxHelper.php index 1671442..f826fd1 100644 --- a/libs/DauxHelper.php +++ b/libs/DauxHelper.php @@ -4,6 +4,12 @@ use Todaymade\Daux\Tree\Directory; class DauxHelper { + /** + * Set a new base_url for the configuration + * + * @param Config $config + * @param string $base_url + */ public static function rebaseConfiguration(Config $config, $base_url) { // Avoid changing the url if it is already correct @@ -24,12 +30,13 @@ class DauxHelper */ public static function getTheme($params, $current_url) { - $theme_folder = $params['local_base'] . DS . 'resources' . DS . 'themes' . DS . $params['html']['theme']; + $theme_folder = $params['local_base'] . DIRECTORY_SEPARATOR . 'resources' . + DIRECTORY_SEPARATOR . 'themes' . DIRECTORY_SEPARATOR . $params['html']['theme']; $theme_url = $params['base_url'] . "resources/themes/" . $params['html']['theme'] . '/'; $theme = array(); - if (is_file($theme_folder . DS . "config.json")) { - $theme = json_decode(file_get_contents($theme_folder . DS . "config.json"), true); + if (is_file($theme_folder . DIRECTORY_SEPARATOR . "config.json")) { + $theme = json_decode(file_get_contents($theme_folder . DIRECTORY_SEPARATOR . "config.json"), true); if (!$theme) { $theme = array(); } @@ -44,7 +51,7 @@ class DauxHelper 'require-jquery' => false, 'bootstrap-js' => false, 'favicon' => 'resources/img/favicon.png', - 'templates' => $theme_folder . DS . 'templates', + 'templates' => $theme_folder . DIRECTORY_SEPARATOR . 'templates', ]; $substitutions = [ diff --git a/libs/Format/Base/CommonMark/LinkRenderer.php b/libs/Format/Base/CommonMark/LinkRenderer.php index 3411dfd..06c7ebd 100644 --- a/libs/Format/Base/CommonMark/LinkRenderer.php +++ b/libs/Format/Base/CommonMark/LinkRenderer.php @@ -49,6 +49,17 @@ class LinkRenderer extends \League\CommonMark\Inline\Renderer\LinkRenderer */ public function render(AbstractInline $inline, HtmlRendererInterface $htmlRenderer) { + // This can't be in the method type as + // the method is an abstract and should + // have the same interface + if (!$inline instanceof Link) { + throw new \RuntimeException( + "Wrong type passed to " . __CLASS__ . "::" . __METHOD__ . + " the expected type was 'League\\CommonMark\\Inline\\Element\\Link' but '" . + get_class($inline) . "' was provided" + ); + } + $element = parent::render($inline, $htmlRenderer); $url = $inline->getUrl(); diff --git a/libs/Format/Confluence/CommonMark/LinkRenderer.php b/libs/Format/Confluence/CommonMark/LinkRenderer.php index 2ae066f..5b6bfd2 100644 --- a/libs/Format/Confluence/CommonMark/LinkRenderer.php +++ b/libs/Format/Confluence/CommonMark/LinkRenderer.php @@ -15,6 +15,17 @@ class LinkRenderer extends \Todaymade\Daux\Format\Base\CommonMark\LinkRenderer */ public function render(AbstractInline $inline, HtmlRendererInterface $htmlRenderer) { + // This can't be in the method type as + // the method is an abstract and should + // have the same interface + if (!$inline instanceof Link) { + throw new \RuntimeException( + "Wrong type passed to " . __CLASS__ . "::" . __METHOD__ . + " the expected type was 'League\\CommonMark\\Inline\\Element\\Link' but '" . + get_class($inline) . "' was provided" + ); + } + // Default handling $element = parent::render($inline, $htmlRenderer); $url = $inline->getUrl(); diff --git a/libs/Format/Confluence/Generator.php b/libs/Format/Confluence/Generator.php index d159e10..779220a 100644 --- a/libs/Format/Confluence/Generator.php +++ b/libs/Format/Confluence/Generator.php @@ -31,6 +31,9 @@ class Generator implements \Todaymade\Daux\Format\Base\Generator $this->converter = new CommonMarkConverter(['daux' => $this->daux->getParams()]); } + /** + * {@inheritdoc} + */ public function generateAll(InputInterface $input, OutputInterface $output, $width) { $params = $this->daux->getParams(); diff --git a/libs/Format/Confluence/Publisher.php b/libs/Format/Confluence/Publisher.php index 03e63df..8da36ce 100644 --- a/libs/Format/Confluence/Publisher.php +++ b/libs/Format/Confluence/Publisher.php @@ -25,7 +25,7 @@ class Publisher protected $previous_title; /** - * @var string terminal width + * @var integer terminal width */ public $width; diff --git a/libs/Format/HTML/Generator.php b/libs/Format/HTML/Generator.php index 9be5276..de00af6 100644 --- a/libs/Format/HTML/Generator.php +++ b/libs/Format/HTML/Generator.php @@ -39,14 +39,14 @@ class Generator implements \Todaymade\Daux\Format\Base\Generator, LiveGenerator $params = $this->daux->getParams(); if (is_null($destination)) { - $destination = $this->daux->local_base . DS . 'static'; + $destination = $this->daux->local_base . DIRECTORY_SEPARATOR . 'static'; } $this->runAction( "Copying Static assets ...", $output, $width, - function () use ($destination) { + function() use ($destination) { Helper::copyAssets($destination, $this->daux->local_base); } ); @@ -76,7 +76,7 @@ class Generator implements \Todaymade\Daux\Format\Base\Generator, LiveGenerator foreach ($tree->getEntries() as $key => $node) { if ($node instanceof Directory) { - $new_output_dir = $output_dir . DS . $key; + $new_output_dir = $output_dir . DIRECTORY_SEPARATOR . $key; mkdir($new_output_dir); $this->generateRecursive($node, $new_output_dir, $params, $output, $width, '../' . $base_url); @@ -87,14 +87,14 @@ class Generator implements \Todaymade\Daux\Format\Base\Generator, LiveGenerator "- " . $node->getUrl(), $output, $width, - function () use ($node, $output_dir, $key, $params) { + function() use ($node, $output_dir, $key, $params) { if (!$node instanceof Content) { - copy($node->getPath(), $output_dir . DS . $key); + copy($node->getPath(), $output_dir . DIRECTORY_SEPARATOR . $key); return; } $generated = $this->generateOne($node, $params); - file_put_contents($output_dir . DS . $key, $generated->getContent()); + file_put_contents($output_dir . DIRECTORY_SEPARATOR . $key, $generated->getContent()); } ); } diff --git a/libs/Generator/Command.php b/libs/Generator/Command.php index 312df2c..620f0c1 100644 --- a/libs/Generator/Command.php +++ b/libs/Generator/Command.php @@ -5,8 +5,6 @@ use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; use Todaymade\Daux\Daux; -use Todaymade\Daux\Format\HTML\Generator as HTMLGenerator; -use Todaymade\Daux\Format\Confluence\Generator as ConfluenceGenerator; class Command extends SymfonyCommand { @@ -53,7 +51,7 @@ class Command extends SymfonyCommand } $class = $daux->getProcessorClass(); - if ($class) { + if (!empty($class)) { $daux->setProcessor(new $class($daux, $output, $width)); } } diff --git a/libs/Generator/Helper.php b/libs/Generator/Helper.php index 167dead..48f50d6 100644 --- a/libs/Generator/Helper.php +++ b/libs/Generator/Helper.php @@ -16,8 +16,11 @@ class Helper mkdir($path); } - mkdir($path . DS . 'resources'); - static::copyRecursive($local_base . DS . 'resources', $path . DS . 'resources'); + mkdir($path . DIRECTORY_SEPARATOR . 'resources'); + static::copyRecursive( + $local_base . DIRECTORY_SEPARATOR . 'resources', + $path . DIRECTORY_SEPARATOR . 'resources' + ); } /** diff --git a/libs/Server/Server.php b/libs/Server/Server.php index bf98728..f1ee380 100644 --- a/libs/Server/Server.php +++ b/libs/Server/Server.php @@ -25,7 +25,7 @@ class Server $daux->initialize(); $class = $daux->getProcessorClass(); - if ($class) { + if (!empty($class)) { $daux->setProcessor(new $class($daux, new NullOutput(), 0)); } @@ -101,7 +101,7 @@ class Server * Handle an incoming request * * @param array $query - * @return \Todaymade\Daux\Tree\Entry + * @return \Todaymade\Daux\Format\Base\Page * @throws Exception * @throws NotFoundException */ @@ -120,7 +120,7 @@ class Server /** * @param string $request - * @return \Todaymade\Daux\Tree\Entry + * @return \Todaymade\Daux\Format\Base\Page * @throws NotFoundException */ private function getPage($request) diff --git a/libs/Tree/Builder.php b/libs/Tree/Builder.php index 230264a..6d1e88d 100644 --- a/libs/Tree/Builder.php +++ b/libs/Tree/Builder.php @@ -27,7 +27,7 @@ class Builder continue; } - $path = $node->getPath() . DS . $file; + $path = $node->getPath() . DIRECTORY_SEPARATOR . $file; if (is_dir($path) && in_array($file, $ignore['folders'])) { continue; @@ -37,9 +37,9 @@ class Builder } if (is_dir($path)) { - $new = new Directory($node, static::getUriFromFilename(static::getFilename($path)), $path); + $new = new Directory($node, static::removeSortingInformations(static::getFilename($path)), $path); $new->setName(DauxHelper::pathinfo($path)['filename']); - $new->setTitle(static::getTitleFromFilename($new->getName())); + $new->setTitle(static::removeSortingInformations($new->getName(), ' ')); static::build($new, $ignore); } else { static::createContent($node, $path); @@ -61,14 +61,14 @@ class Builder $config = $parent->getConfig(); if (!in_array(pathinfo($path, PATHINFO_EXTENSION), $config['valid_content_extensions'])) { - $entry = new Raw($parent, static::getUriFromFilename(static::getFilename($path)), $path, filemtime($path)); - $entry->setTitle(static::getTitleFromFilename($name)); + $entry = new Raw($parent, static::removeSortingInformations(static::getFilename($path)), $path, filemtime($path)); + $entry->setTitle(static::removeSortingInformations($name, ' ')); $entry->setName($name); return $entry; } - $uri = static::getUriFromFilename($name); + $uri = static::removeSortingInformations($name); if ($config['mode'] === Daux::STATIC_MODE) { $uri .= '.html'; } @@ -82,7 +82,7 @@ class Builder $entry->setTitle($parent->getTitle()); } } else { - $entry->setTitle(static::getTitleFromFilename($name)); + $entry->setTitle(static::removeSortingInformations($name, ' ')); } $entry->setName($name); @@ -104,7 +104,7 @@ class Builder * @param string $filename * @return string */ - protected static function getTitleFromFilename($filename) + protected static function removeSortingInformations($filename, $separator = '_') { $filename = explode('_', $filename); if ($filename[0] == '' || is_numeric($filename[0])) { @@ -115,26 +115,7 @@ class Builder $filename[0] = substr($t, 1); } } - $filename = implode(' ', $filename); - return $filename; - } - - /** - * @param string $filename - * @return string - */ - protected static function getUriFromFilename($filename) - { - $filename = explode('_', $filename); - if ($filename[0] == '' || is_numeric($filename[0])) { - unset($filename[0]); - } else { - $t = $filename[0]; - if ($t[0] == '-') { - $filename[0] = substr($t, 1); - } - } - $filename = implode('_', $filename); + $filename = implode($separator, $filename); return $filename; } diff --git a/libs/Tree/Directory.php b/libs/Tree/Directory.php index 1e1851c..a994b79 100644 --- a/libs/Tree/Directory.php +++ b/libs/Tree/Directory.php @@ -58,7 +58,7 @@ class Directory extends Entry } /** - * @return Content|false + * @return Content|null */ public function getFirstPage() { @@ -87,7 +87,7 @@ class Directory extends Entry } } - return false; + return null; } /** diff --git a/templates/content.php b/templates/content.php index 585b92a..525165c 100644 --- a/templates/content.php +++ b/templates/content.php @@ -3,27 +3,33 @@

get_breadcrumb_title($page, $base_page); - else echo $page['title']; + if ($page['breadcrumbs']) { + echo $this->get_breadcrumb_title($page, $base_page); + } else { + echo $page['title']; + } ?>

- + - +

get_breadcrumb_title($page, $base_page); - else echo $page['title']; + if ($page['breadcrumbs']) { + echo $this->get_breadcrumb_title($page, $base_page); + } else { + echo $page['title']; + } ?>

- + diff --git a/templates/error.php b/templates/error.php index 67d16a4..b56c671 100644 --- a/templates/error.php +++ b/templates/error.php @@ -2,8 +2,8 @@
-

+

- +
diff --git a/templates/home.php b/templates/home.php index 3975562..a2ffff9 100644 --- a/templates/home.php +++ b/templates/home.php @@ -5,19 +5,23 @@ - Fork me on GitHub + Fork me on GitHub
- ' . $params['tagline'] . ''; ?> + ' . $params['tagline'] . ''; + } ?>
- '; ?> + '; + } ?>
@@ -28,8 +32,12 @@
View On GitHub'; - foreach ($page['entry_page'] as $key => $node) echo '' . $key . ''; + if ($params['html']['repo']) { + echo 'View On GitHub'; + } + foreach ($page['entry_page'] as $key => $node) { + echo '' . $key . ''; + } ?>
@@ -40,7 +48,7 @@
- +
@@ -52,7 +60,9 @@
@@ -60,10 +70,10 @@
- <?php echo $page['title']; ?> - - + <?= $page['title']; ?> + + - + - "; ?> + "; + } ?> - "; ?> + "; + } ?> '; - if ($params['theme']['bootstrap-js']) echo ''; + if ($params['theme']['require-jquery']) { + echo ''; + } + if ($params['theme']['bootstrap-js']) { + echo ''; + } ?> - + - '; ?> + '; + } ?> - + diff --git a/templates/layout/05_page.php b/templates/layout/05_page.php index b34b276..bae70d7 100644 --- a/templates/layout/05_page.php +++ b/templates/layout/05_page.php @@ -1,7 +1,7 @@ layout('theme::layout/00_layout') ?> - Fork me on GitHub + Fork me on GitHub
@@ -22,29 +22,38 @@
-
+
section('content'); ?>
diff --git a/templates/partials/navbar_content.php b/templates/partials/navbar_content.php index 7932a42..9017004 100644 --- a/templates/partials/navbar_content.php +++ b/templates/partials/navbar_content.php @@ -1,2 +1,2 @@ - +

Generated by Daux.io