[D8] Feedbacks

There are some errors reported by automated review tools, did you already check them? See http://pareview.sh/pareview/httpsgitdrupalorgsandboxshamas42856278git

We are currently quite busy with all the project applications and we prefer projects with a review bonus. Please help reviewing and put yourself on the high priority list, then we will take a look at your project right away :-)

Also, you should get your friends, colleagues or other community members involved to review this application. Let them go through the review checklist and post a comment that sets this issue to "needs work" (they found some problems with the project) or "reviewed & tested by the community" (they found no major flaws).

I'm a robot and this is an automated message from Project Applications Scraper.

Please do not set the issue status back to 'Needs Review' before completing any work flagged by either a member of the community OR and automated tool.

Review of the 8.x-1.x branch (commit 9b7a4ce):

• Remove all .DS_Store files from your repository.
• Remove all .idea files from your repository.
• Bad line endings were found, always use unix style terminators. See https://www.drupal.org/coding-standards#indenting
  

  ./.idea/.name:                                ASCII text, with no line terminators
  
  

• Coder Sniffer has found some issues with your code (please check the Drupal coding standards). See attachment.
• ESLint has found some issues with your code (please check the JavaScript coding standards).
  

  /root/repos/pareviewsh/pareview_temp/js/feedback.js: line 5, col 30, Error - Parsing error: Unterminated string constant
  
  1 problem
  

• DrupalPractice has found some issues with your code, but could be false positives.
  

  
  FILE: /root/repos/pareviewsh/pareview_temp/src/Form/AddFeedback.php
  --------------------------------------------------------------------------
  FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 3 LINES
  --------------------------------------------------------------------------
   32 | WARNING | \Drupal calls should be avoided in classes, use
      |         | dependency injection instead
   39 | WARNING | \Drupal calls should be avoided in classes, use
      |         | dependency injection instead
   79 | WARNING | \Drupal calls should be avoided in classes, use
      |         | dependency injection instead
  --------------------------------------------------------------------------
  
  Time: 58ms; Memory: 4Mb
  

• No automated test cases were found, did you consider writing Simpletests or PHPUnit tests? This is not a requirement but encouraged for professional software development.

This automated report was generated with PAReview.sh, your friendly project application review script. You can also use the online version to check your project. You have to get a review bonus to get a review from me.

FILE: /root/repos/pareviewsh/pareview_temp/feedbacks.info.yml
--------------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
--------------------------------------------------------------------------
 1 | WARNING | [ ] Remove "version" from the info file, it will be added
   |         |     by drupal.org packaging automatically
 6 | ERROR   | [x] Expected 1 newline at end of file; 0 found
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------


FILE: /root/repos/pareviewsh/pareview_temp/feedbacks.libraries.yml
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 5 | ERROR | [x] Expected 1 newline at end of file; 0 found
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: /root/repos/pareviewsh/pareview_temp/feedbacks.permissions.yml
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 9 | ERROR | [x] Expected 1 newline at end of file; 0 found
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: /root/repos/pareviewsh/pareview_temp/README.txt
-----------------------------------------------------------------------
FOUND 1 ERROR AND 1 WARNING AFFECTING 2 LINES
-----------------------------------------------------------------------
 12 | WARNING | [ ] Line exceeds 80 characters; contains 92 characters
 21 | ERROR   | [x] Expected 1 newline at end of file; 2 found
-----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
-----------------------------------------------------------------------


FILE: /root/repos/pareviewsh/pareview_temp/src/Form/AddFeedback.php
--------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 6 LINES
--------------------------------------------------------------------------
  7 | ERROR | [x] There must be one blank line after the last USE
    |       |     statement; 0 found;
  9 | ERROR | [x] Doc comment short description must end with a full stop
 17 | ERROR | [ ] Missing short description in doc comment
 24 | ERROR | [ ] Missing short description in doc comment
 68 | ERROR | [ ] Missing short description in doc comment
 75 | ERROR | [ ] Missing short description in doc comment
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------


FILE: /root/repos/pareviewsh/pareview_temp/src/Form/FeedbackClass.php
--------------------------------------------------------------------------
FOUND 23 ERRORS AFFECTING 15 LINES
--------------------------------------------------------------------------
   8 | ERROR | [x] Doc comment short description must end with a full
     |       |     stop
  12 | ERROR | [ ] Parameter $timestamp is not described in comment
  15 | ERROR | [ ] Missing parameter type
  15 | ERROR | [x] Parameter comment must be on the next line
  16 | ERROR | [ ] Missing parameter type
  16 | ERROR | [x] Parameter comment must be on the next line
  17 | ERROR | [ ] Missing parameter type
  17 | ERROR | [x] Parameter comment must be on the next line
  36 | ERROR | [ ] Description for the @return value must be on the next
     |       |     line
  41 | ERROR | [ ] If the line declaring an array spans longer than 80
     |       |     characters, each element should be broken into its own
     |       |     line
  51 | ERROR | [x] Return type must not contain variable name "$result"
  52 | ERROR | [x] Return comment indentation must be 3 spaces, found 2
     |       |     spaces
  54 | ERROR | [ ] Parameter tags must be defined first in a doc comment
  54 | ERROR | [x] Expected "int" but found "integer" for parameter type
  55 | ERROR | [x] Parameter comment indentation must be 3 spaces, found
     |       |     2 spaces
  55 | ERROR | [ ] Parameter comment must start with a capital letter
  55 | ERROR | [x] Parameter comment must end with a full stop
  70 | ERROR | [ ] Description for the @return value must be on the next
     |       |     line
  86 | ERROR | [ ] Description for the @return value must be on the next
     |       |     line
 108 | ERROR | [x] Expected "int" but found "integer" for parameter type
 109 | ERROR | [x] Parameter comment indentation must be 3 spaces, found
     |       |     1 spaces
 109 | ERROR | [ ] Parameter comment must start with a capital letter
 109 | ERROR | [x] Parameter comment must end with a full stop
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 12 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------


FILE: /root/repos/pareviewsh/pareview_temp/src/Form/EditFeedback.php
--------------------------------------------------------------------------
FOUND 5 ERRORS AFFECTING 5 LINES
--------------------------------------------------------------------------
  12 | ERROR | [x] Doc comment short description must end with a full
     |       |     stop
  24 | ERROR | [ ] Missing short description in doc comment
  31 | ERROR | [ ] Missing short description in doc comment
 102 | ERROR | [ ] Missing short description in doc comment
 109 | ERROR | [ ] Missing short description in doc comment
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------


FILE: /root/repos/pareviewsh/pareview_temp/src/Form/DelFeedback.php
--------------------------------------------------------------------------
FOUND 8 ERRORS AFFECTING 8 LINES
--------------------------------------------------------------------------
 11 | ERROR | [x] Doc comment short description must end with a full stop
 18 | ERROR | [ ] Missing short description in doc comment
 25 | ERROR | [ ] Missing short description in doc comment
 32 | ERROR | [ ] Missing short description in doc comment
 39 | ERROR | [ ] Missing short description in doc comment
 46 | ERROR | [ ] Missing short description in doc comment
 61 | ERROR | [ ] Missing short description in doc comment
 71 | ERROR | [x] Expected 1 newline at end of file; 0 found
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------


FILE: .../pareviewsh/pareview_temp/src/Controller/AdminFeedbackController.php
--------------------------------------------------------------------------
FOUND 6 ERRORS AFFECTING 5 LINES
--------------------------------------------------------------------------
 11 | ERROR | [x] Doc comment short description must end with a full stop
 12 | ERROR | [x] There must be exactly one blank line before the tags in
    |       |     a doc comment
 17 | ERROR | [x] Doc comment short description must end with a full stop
 18 | ERROR | [x] There must be exactly one blank line before the tags in
    |       |     a doc comment
 18 | ERROR | [x] Return type must not contain variable name
    |       |     "$feedback_list"
 19 | ERROR | [x] Return comment indentation must be 3 spaces, found 2
    |       |     spaces
--------------------------------------------------------------------------
PHPCBF CAN FIX THE 6 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------


FILE: /root/repos/pareviewsh/pareview_temp/feedbacks.routing.yml
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 31 | ERROR | [x] Expected 1 newline at end of file; 0 found
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: /root/repos/pareviewsh/pareview_temp/feedbacks.links.task.yml
----------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
----------------------------------------------------------------------
 4 | ERROR | [x] Expected 1 newline at end of file; 0 found
----------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------


FILE: /root/repos/pareviewsh/pareview_temp/feedbacks.module
--------------------------------------------------------------------------
FOUND 3 ERRORS AFFECTING 3 LINES
--------------------------------------------------------------------------
  3 | ERROR | Missing short description in doc comment
 14 | ERROR | Inline doc block comments are not allowed; use "/* Comment
    |       | */" or "// Comment" instead
 46 | ERROR | Doc comment is empty
--------------------------------------------------------------------------


FILE: /root/repos/pareviewsh/pareview_temp/feedbacks.install
----------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
----------------------------------------------------------------------
 3 | ERROR | Missing short description in doc comment
 7 | ERROR | Doc comment is empty
----------------------------------------------------------------------

Time: 260ms; Memory: 6Mb

Again, please carry out any work flagged before changing the issue status back to 'Needs Review'. Changing the status before carrying out the work flagged WILL NOT speed up the approval process.

hi @shamas4
in drupal 7 we have large number of module for feedbacks in my recent search there is no one for D8 so its great you are here for D8
i my initial test steps i found some mistakes.

1.
after installation and visit admin/content/feedbacks i found Notice in my log messages page admin/reports/dblog
Notice: Notice: Undefined index: processed in Drupal\feedbacks\Controller\AdminFeedbackController->content() (line 72 of MYSITE/htdocs/modules/feedbacks/src/Controller/AdminFeedbackController.php).

i think you have to solve this.

2.
i got some messages and then going to update
after update feedback massage i am going no where
after submit or update feedback message user should land at destination admin/content/feedbacks page

now its looking good for
will happy to see this a full project
for me
RTC

Hi @shahmas4

when i installed this module i got attached screen fatal error.

Symfony\Component\Routing\Exception\RouteNotFoundException: Route "feedbacks_add.form" does not exist. in Drupal\Core\Routing\RouteProvider->getRouteByName() (line 187 of /core/lib/Drupal/Core/Routing/RouteProvider.php).

thanks

Hello @shamas4
First of all, thank you for you module ! It will be very useful for all of us, I'm pretty sure of it.

Automated Review

A lot of warnings about the short array syntax was found by pareview.sh (https://pareview.sh/node/1260)

Manual Review

Individual user account

[Yes: Follows] the guidelines for individual user accounts.

No duplication

[Yes: Does not cause] module duplication and/or fragmentation.

Master Branch

[Yes: Follows] the guidelines for master branch.

Licensing

[Yes: Follows] the licensing requirements.

3rd party assets/code

[Yes: Follows] the guidelines for 3rd party assets/code.

README.txt/README.md

[Yes: Follows] the guidelines for in-project documentation and/or the README Template.

You should add some help for futur developer and maintenances. Also, all but the most trivial modules should implement hook_help().

Code long/complex enough for review

[Yes: Follows] the guidelines for project length and complexity.

Secure code

[Yes: Meets the security requirements.]

Coding style & Drupal API usage

1. (+) FeedbackClass you should use a service for this kind of of usage. Using a service will make your code by fare more structured and easier to maintain.
2. Just a recommendation, Why don't use a custom Entity instead of your own Table ? Because you need to redefine by yourself all the CRUD operations. With and Entity you could achieve the same goals (CRUD & Listing) and much more for future developments (Views listing for e.g.).
3. Just a recommendation, avoid static call such FeedbackClass::exists(), use injection instead (with a service it will be easy to do).
4. Just a recommendation, add some tests for a better readability, scalability & maintainability.

The starred items (*) are fairly big issues and warrant going back to Needs Work. Items marked with a plus sign (+) are important and should be addressed before a stable project release. The rest of the comments in the code walkthrough are recommendations.

This review uses the Project Application Review Template.

@shamas4, if you want some help on refactoring using a Service, adding Entity, coding Tests UnitTestCase, KernelTestBase & BrowserTestBase, and more just let me know, I would be happy to help you on my free time.

Manual Review

Individual user account

Yes: Follows the guidelines for individual user accounts.

No duplication

There are some existing modules with similar functionality but they only work for Drupal 7
https://www.drupal.org/project/feedback
https://www.drupal.org/project/feedback_collect
https://www.drupal.org/project/feedback_simple

Master Branch

Yes: Follows the guidelines for master branch.

Licensing

Yes: Follows the licensing requirements.

3rd party assets/code

Yes: Follows the guidelines for 3rd party assets/code.

README.txt/README.md

Yes: Follows the guidelines for in-project documentation and/or the README Template.

Code long/complex enough for review

Yes: Follows the guidelines for project length and complexity.

Secure code

Yes: Meets the security requirements.

Coding style & Drupal API usage

[List of identified issues in no particular order. Use (*) and (+) to indicate an issue importance. Replace the text below by the issues themselves:

1. (+) There are a lot of places where string are not translated for example
   AdminFeedbackController.php line 110
   AddFeedback.php line 50
2. I agree with @wengerk, I would create Entity instead of using Tables
3. I would add some configuration that will allow to decide on what pages feedback block should be displayed.
   Right now it visible even on administration pages witch is a little bit annoying

The starred items (*) are fairly big issues and warrant going back to Needs Work. Items marked with a plus sign (+) are important and should be addressed before a stable project release. The rest of the comments in the code walkthrough are recommendations.

I have tested this module and it works perfectly. So, I am making it RTBC.

Thank you for your contribution!
I am going to update your account so you can opt into security advisory coverage now.
These are some recommended readings to help with excellent maintainership:

• Dries' post on Responsible maintainers
• Best practices for creating and maintaining projects
• Maintaining a drupal.org project with Git
• Commit messages - providing history and credit
• Release naming conventions.
• Helping maintainers in the issue queues

You can find more contributors chatting on the IRC #drupal-contribute channel. So, come hang out and stay involved.
Thank you, also, for your patience with the review process.
Anyone is welcome to participate in the review process. Please consider reviewing other projects that are pending review. I encourage you to learn more about that process and join the group of reviewers.

I thank all the dedicated reviewers as well.