Pojďte otestovat Nette 2.4 RC

Včera vyšla první testovací verze nového Nette 2.4!

Přináší řadu novinek, nicméně k těm se dostanu až v příštím příspěvku. Verze 2.4 je trošku jiná, než předchozí:

• 2.4 bude poslední v řadě 2.x
• měla by být na 99 % kompatibilní s 2.3, nicméně generuje řadu deprecation notices, viz níže
• vyžaduje PHP 5.6
• nebudou žádné setinkové verze

Smyslem Nette 2.4 je na další roky zajistit podporu pro řadu 2.x a zároveň připravit uživatele na některé změny, které přijdou s Nette 3. Proto je minimální verzí PHP právě 5.6, které sice ještě dnes není úplně všude, ale pro příští roky nemá smysl podporovat nic staršího (support PHP 5.5 končí v červenci 2016). Pokud zatím na hostingu 5.6 nemáte, s přechodem na Nette 2.4 klidně počkejte.

Před testováním nebo nasazováním doporučuji nejprve vypnout hlášení chyb E_USER_DEPRECATED. Zapněte jej, až když vše bude fungovat.

$configurator->enableDebugger();
error_reporting(~E_USER_DEPRECATED);

Verzování

Nette je tvořeno sadou samostatných komponent, které mají vlastní verzování. Vycházejí tedy nové verze jednotlivých komponent, které si můžete libovolně namixovat, a s nástupem Composeru postupně ztratilo smysl vydávat verze Nette jako celku. Proto vyšla jen jedna verze 2.4 (obdobně i 2.3.10 a 2.2.13 jsou poslední balíčky „celého“ Nette).

Uživatelé Composeru jednotlivé balíčky zaktualizují příkazem composer update i pokud používají metabalíček nette/nette. A jestli s Composerem dosud nekamarádíte, můžete stahovat Nette jako archívy, které se budou lišit datem sestavení a verze v něm obsažených komponent zjistíte v souboru version.txt.

Deprecation notices

Nette 2.4 by mělo být téměř úplně kompatibilní s 2.3 (změny jsou vypsány níže), nicméně v některých situacích generuje upozornění, pokud používáte funkčnost, se kterou se do budoucna nepočítá, nebo dochází k chybě, která dříve procházela. Tyto upozornění lze samozřejmě potlačit zavináčem, pokud třeba nechcete kompatibilitu řešit hned, ale je dobré jim věnovat pozornost kvůli dopředné kompatibilitě s Nette 3.

Jde zejména o tyto situace:

Nette\Object

Třída Nette\Object má novějšího a dosti jednoduššího brášku v podobně traity Nette\SmartObject. Ten se liší v několika věcech:

• podporuje emulované properties jen pokud je na třídě zapsaná anotace @property typ $nazev.
• nepodporuje extension methods
• nepodporuje getReflection
• nepodporuje získávání metod jako $this->formSubmitted (je třeba nahradit za klasický callback [$this, 'formSubmitted'].

Samotná třída Nette\Object se nijak nezměnila a pokud od ní dědíte, nic se pro vás nemění. Co je ale podstatné, že třídy frameworku teď místo dědění od Nette\Object používají tuto novou traitu, a proto některé konstrukce mohou generovat upozornění (zdůrazňuji, že stále fungují, traita SmartObject plně emuluje chování Nette\Object, jen navíc vygeneruje upozornění).

Samozřejmě cílem je, aby uživatel pokud možno na žádné upozornění nenarážel a všechno fungovalo jako dosud. Analyzoval jsem kód stovek knihoven používajících Nette, pokusil se doplnit všechny smysluplné anotace @property a přidal podporu extension methods pro formulář Form, protože tam se používají drtivě nejvíc.

Teď je důležité, abyste se zapojili do testování a odhalili, kde se ještě upozornění objevují. V případě okrajových situací bude vhodnější, pokud si opravu uděláte přímo v kódu (např. nahradit property $obj->name za metodu $obj->getName() apod), ale běžně se vyskytující situace bych chtěl podchytit přímo v kódu Nette, aby se varování nevyhazovaly.

Je proto opravdu důležité se co nejdřív pokusit otestovat vaše aplikace s Nette 2.4

Latte

V Latte se nově objevuje upozornění, pokud

• konstrukcí {foreach $langs as $lang} přepíšete parameter šablony $lang
• použijete již zastaralou vykříčníkovou konvenci {!$name} namísto preferovaného {$name|noescape}
• použijete v šabloně <?php ?> nebo {? ...} namísto {php ...}
• použijete u bloku či include filtr, který je pro jiný content type (vysvětlení)
• použijete |nosafeurl místo novějšího |nocheck
• použijete makro {includeblock}, které nahrazuje podobné makro {import} (importuje jen bloky a ne obsah okolo)
• dojde k chybě „Incompatible context“ při používání bloků v jiném kontextu (například uvnitř HTML atributu bez uvozovek), než v jakém byl definován (například v běžném HTML textu).
• přistupujete k proměnné $template kvůli volání filtrů, což lze nyní udělat přímo v šabloně pomocí výrazu ($var|trim) nebo v PHP kódu generovaným makrem pomocí call_user_func($this->filters->trim, $val, ...).
• přistupujete k proměnné $template kvůli proměnné, což nahraďte za $this->getParameter('xyz')
• přistupujete k interní podtržítkové proměnné jako $_control, $_form atd.

Pokud na cokoliv narazíte a nebudete si vědět co s tím, napište.

Bootstrap

Takzvané sekce (production, development) v rámci jednoho konfiguračního souboru se už docela dávno ukázaly jako ne příliš pružné řešení a s příchodem Nette 2.0 byly nahrazeny za dvojici konfiguračních souborů config.neon a config.local.neon. V Nette 3.0 se už s jejich podporou nepočítá, proto verze 2.4 při jejich použití vyhodí upozornění.

Taktéž mám za to, že dědičnost služeb se v praxi neuplatnila a lepší je sáhnout po decoratoru, tudíž je deprecated, ale pokud se mýlím a v praxi ji používáte, dejte vědět.

Statement::setEntity() je deprecated.

Formuláře

Negativní validační pravidla jsou deprecated. Alternativou ~Form::FILLED je Form::BLANK, nebo ~Form::EQUAL můžete nahradit za Form::NOT_EQUAL.

Nette před vykreslením formuláře upozorní, pokud nad nějakým prvkem použijete addRule() (tedy je efektivně povinný), ale zapomněli jste jej označit jako povinný pomocí setRequired().

Další

Nette\Utils\Html::add() se mění na addHtml() resp. addText().

V PhpGenerator metody setDocuments(), getDocuments() a addDocument() nahradily obdobné setComment(), getComment() a addComment(),

Změny ve 2.4

Ve verzi 2.4 je i několik změn v chování:

Application

U parametrů typu bool použitých v render/action metodách (tj. s výchozí hodnotou TRUE nebo FALSE) a persistentních parametrech se nyní rozlišuje mezi FALSE a NULL, tj. pokud parametr v URL není uveden, jeho hodnota je nyní NULL, dříve byla FALSE. Viz nette/application#107.

Route i SimpleRouter nyní generují v URL stejné HTTP/HTTPS schéma, s jakým se přistupuje ke stránce. Routy, které vyžadují určitý protokol, se dají napsat se schématem např. Route('http://domain.cz/<presenter>'), čímž zmizel smysl flagu SECURED a potažmo Route::$defaultFlags, které je deprecated. Podrobněji tady.

Třída, kterou vrací Presenter::getReflection(), již není potomkem Nette\Reflection\ClassType a taktéž getReflection()->getMethod() není potomkem Nette\Reflection\Method. Využívání featur původních předků povede k upozornění. Výjimkou jsou metody hasAnnotation a getAnnotation, které by měly nadále fungovat. Nicméně getAnnotation() neparsuje text uvedený za názvem anotace, jako např. abc v @param abc, parsuje totiž jen text uvedený v závorkách @param(abc).

Formuláře

Interní parametr do se nyní u formulářů posílaných přes POST jmenuje _do, aby nedocházelo ke kolizi, a zároveň by nemělo docházet k mixováním formulářových prvků s persistentními parametry.

Třída BaseControl už přímo definuje getControlPart() a getLabelPart() a standardně vracejí totéž, co getControl() a getLabel(). Makra <tag n:name> už rovnou používají tyto -part metody. Pokud tyto metody definujete, bude potřeba případný parametr označit jako nepovinný (= NULL)`

DefaultFormRenderer nyní správně vkládá do skupiny i vnořené komponenty (dříve se vnořené komponenty vykreslily až na konci formuláře), viz nette/forms#96.

Už se nepoužívá interní proměnná $_form, kterou někdy bylo potřeba ručně předávat do inkludovaných šablon, což už není potřeba, nebo kvůli snippetům uvnitř formulářů, což nyní povede k chybě (např. end() expects parameter 1 to be array, null given). Takže pokud si kvůli snippetům předáváte do šablony $template->_form = $form, můžete to nahradit za $template->getLatte()->addProvider('formsStack', [$form]), nicméně jde stále jen o obezličku, korektní je použít {snippetArea xyz} a ten invalidovat společně se snippetem.

Validátory Form::EMAIL, URL a INTEGER automaticky mění HTML atribut type na email, url resp. number.

Pokud používáte vlastní TemplateFactory, aplikujte do ní změny vytvořené v originální továrně.

setRequired(FALSE) nyní udělá prvek volitelný, tj. pokud není vyplněn, neaplikují se validační pravidla. Lze tím nahradit větve addCondition($form::FILLED).

Nezapomeňte zaktualizovat netteForms.js

Latte

Filtry, které mají být aplikovány na blok textu ({block} nebo {_}...{/_}) či {include}, musejí jako první parametr přijímat objekt Latte\Runtime\FilterInfo, viz třeba https://github.com/…/Filters.php#…

{contentType} je povolené pouze v hlavičce šablony a v elementu <script> kvůli nette/latte#71.

Jinak Latte doznalo poměrně zásadních změn pod kapotou, s maximálním úsilím o zpětnou kompatibilitu, ale pokud jste spoléhali na nějaké podtržítkové nebo jiné interní proměnné, nemusí fungovat.

Otestujte své projekty!

Zapojte se prosím do testování Nette 2.4, ať podchytíme všechna varování, kterých se lze zbavit a přechod na novou verzi je co nejjednodušší. Ostrá verze by pak mohla vyjít za měsíc.

Kromě fóra můžete použít i diskusní kanál Gitter, naopak issue tracker na Githubu pro tyto případy prosím nepoužívejte.

---

Aby vám Composer nainstalovat vývojové verze balíčků, doplňte do composer.json "minimum-stability": "dev" (viz také).

(Post budu průběžně doplňovat).