Activity

1. gnugat

   added

   RFC

   on Oct 5, 2016
2. gnugat

   self-assigned this

   on Oct 6, 2016
3. gnugat commented on Oct 6, 2016

   

   gnugat

   on Oct 6, 2016

   Last edited by gnugat

   MemberAuthor

   More actions

   Here's a first draft:

   • Placeholders using %placeholder% or alternatively :placeholder
   • Optional placeholders using placeholder?, if it is falsey then replace it with an empty string (and remove the next whitespace?)

   So for example:

   <?php
   
   namespace_statement?
   
   use_statements?
   
   abstractness? finalness? class :name extend? inherit?
   {
       constant_statements?
       property_statements?
       method_statements?
   }
   

   In the above example, we have some whitespace issues:

   • if there are no namespace statement, the use statements will have 2 empty lines above it, when we'd expect only one
   • if the class doesn't extend anything and if it doesn't inherit anything, then we have a trailing space after name
   • if the class doesn't have any constants but does have properties, the first property will be indented with 8 spaces (same issue with properties and methods)
4. gnugat commented on Oct 16, 2016

   

   gnugat

   on Oct 16, 2016

   MemberAuthor

   More actions

   Second draft without alternative syntax, and optional placeholders use a similar syntax to the required ones:

   • Placeholders: %placeholder%
   • Optional placehodlers: ?optional placeholder?

   PhpSpec uses templates without optional placeholders, so it should work perfectly:

       public static function %methodName%(%arguments%)
       {
           %returnVar% = new %className%(%constructorArguments%);
   
           // TODO: write logic here
   
           return %returnVar%;
       }
   

   Pretty Printer should rely on templates that mirror PHP Parser's nodes:

   <?php
   
   namesapce %name%;
   
   ?Stmt_Uses?
   
   ?Stmt_Interfaces?
   
   ?Stmt_Classes?
   
   ?Stmt_Traits?
   

   With deeper templates:

   interface %name% ?extends?
   {
       ?Stmt_Constants?
   
       ?Stmt_Functions?
   }
   

   But once again optional placeholders are problematic regarding surrounding whitespaces when they shouldn't print anything:

   • if there are no Stmt_Uses, then we expect it to be removed with its two new lines characters
   • if there are no extends, then we expect the previous space to be removed
   • if there are no Stmt_Constants, then we expect its indentation to be removed as well as its two new lines characters
5. gnugat commented on Oct 19, 2016

   

   gnugat

   on Oct 19, 2016

   MemberAuthor

   More actions

   Third draft adding up a collection placeholder:

   • Collection placeholder: +collection placeholder+

   Collection placeholders should received an array:

   • if it's empty, then remove its line, as well as the surrounding empty lines
   • otherwise replace the placeholder with the concatenation of each elements, separated with the same whitespaces on the placeholder's line

   So for example the Stmt_Interface template would look like:

   interface %name% ?extends?
   {
       +Stmt_Constant+
   
       +Stmt_Function+
   }
   

   And Stmt_Constant:

   const %name% = %value%;
   

   If there are no Stmt_Constant, interface should look like:

   interface FindLatestLocation
   {
       public function find() : array;
   } 
   

   If there's one constant:

   interface FindLatestLocation
   {
       const MY_CONSTANT = 42;
   
       public function find() : array;
   } 
   

   If there's more than one constants:

   interface FindLatestLocation
   {
       const MY_CONSTANT = 42;
   
       public function find() : array;
   }