HELP IDEAS

[marcus-campos]

Hi,

I need some ideas for this lib

[DannyvdSluijs]

Hi Marcus,

This library seems a very nice way to get your eloquent data using a GrapQL like API. A few things I noticed I would see as improvement:

• Reading the README it was not clear to me at first what the library offers.
• Your library is PHP 7.1 and up which means the PHP typehint feature is available
• Actually PHP 7.1 is EOL in 1 month and the minimum version PHP should be raised to PHP 7.2
• MarcusCampos\Dealer\Negotiation::parse returns an array which is considered a weak type adding a Value Object that has some setters to get the data out seems like a logical improvement.
• Possibly add the suggested controller and routing to the lib to make integration easier, see Laravel Passport
• The phppackages.org badge is not showing in the readme.
• I would add Code coverage (and it resp. badge) because a potential user of the lib would be triggered to consider using the lib when there is a decent test coverage.
• Adding a static analysis tool such as PHPStan would help in discovering potential future bugs or misalignment in the return types. Currently PHPStan (in its simplest form) has the following output:

 ./vendor/bin/phpstan analyse src/
 5/5 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%

 ------ -------------------------------------------------------------------------------------------------------------------- 
  Line   Dealer.php                                                                                                          
 ------ -------------------------------------------------------------------------------------------------------------------- 
  30     Return typehint of method MarcusCampos\Dealer\Dealer::negociate() has invalid type MarcusCampos\Dealer\Collection.  
 ------ -------------------------------------------------------------------------------------------------------------------- 

 ------ -------------------------------------------------------------------------------------------------------------------- 
  Line   Negotiation.php                                                                                                     
 ------ -------------------------------------------------------------------------------------------------------------------- 
  63     Return typehint of method MarcusCampos\Dealer\Negotiation::only() has invalid type MarcusCampos\Dealer\Collection.  
  175    Return typehint of method MarcusCampos\Dealer\Negotiation::get() has invalid type MarcusCampos\Dealer\Collection.   
 ------ -------------------------------------------------------------------------------------------------------------------- 

 ------ --------------------------------------------------------------------------------------- 
  Line   Parser.php                                                                             
 ------ --------------------------------------------------------------------------------------- 
  33     Method MarcusCampos\Dealer\Parser::parseArgs() invoked with 3 parameters, 2 required.  
  56     Method MarcusCampos\Dealer\Parser::parseArgs() invoked with 3 parameters, 2 required.  
 ------ ---------------------------------------------------------------------------------------                                                                                                                   
 [ERROR] Found 5 errors                                                                                                 

Let me know what you think and if any help is needed/appreciated.

[marcus-campos]

Hello @DannyvdSluijs,

Thank you very much for the considerations, I really enjoyed the way you reviewed it and once again would like to thank you for the time spent.
I'm thinking of writing an improved version of this lib, but I was very clueless and your list will serve as a starting point. I would love help with some PRs to improve this lib. I am thinking too about how to improve README.md, if you have any suggestions I will be very pleased. If you can help on all the other points, I will be very happy :)