[D7] Kalastatic

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.

Automated Review

[Best practice issues identified by pareview.sh.]

http://pareview.sh/pareview/httpgitdrupalorgsandboxmoshnoi2637294git

Note that perfect adherence to Drupal Coding Standard is NOT a reason to block an application, except for total disregard of them. However, modules should follow them as closely as possible.

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.

Code long/complex enough for review

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

Secure code

[Yes: Meets the security requirements.]

If added, please don't remove the security tag, we keep that for statistics and to show examples of security problems.

This review uses the Project Application Review Template.

Automated Review

I ran your code against auto code sniffer at 'http://pareview.sh/pareview/httpgitdrupalorgsandboxsonictruth2624634git'.

Review of the 7.x-1.x branch (commit 1e828be):

Coder Sniffer has found some issues with your code (please check the Drupal coding standards).
FILE: /var/www/drupal-7-pareview/pareview_temp/README.md
----------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
----------------------------------------------------------------------
88 | WARNING | Line exceeds 80 characters; contains 99 characters
----------------------------------------------------------------------

Time: 110ms; Memory: 7Mb

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.

Note that perfect adherence to Drupal Coding Standard is NOT a reason to block an application, except for total disregard of them. However, modules should follow them as closely as possible.

Manual Review

Observation :
• In hook_menu at line no. 49
  

   // Menu callback for styleguide. Note that this just does a drupal_goto to
    // redirect to the proper url for the styleguide. If we implemented a callback
    // for 'kalastatic/prototype/styleguide' that was of type MENU_LOCAL_TASK then
    // Drupal would assume that the local task was to appear on
    // kalastatic/prototype which of course isn't a Drupal page. This way we can
    // have the style guide link on /kalastatic and everyone nguyens.

  It would be good, if you use block comment instead of line comment.

• There is white page of death, in this url
  kalastatic/styleguide

@Rahul Seth: can you post the PHP error that you got on white screen of death? Please enable PHP error reporting in your dev environment, see https://www.drupal.org/node/158043

Not possible to reproduce that PHP error. But it seems that it was due to file permissions. because in watchdog it create such kind of entry while visit this url "kalastatic/prototype".

Warning: file_get_contents(themes/kalatheme/kalastatic/build/index.html): failed to open stream: No such file or directory in kalastatic_serve_ks_files() (line 232 of kalastatic\kalastatic.module).

I can add some extra checks to the page callback to try and give a better UX when the lib isn't present but it seems silly to hold up the promotion of the module due to this.

That might improve the UX. Created an issue to track that change: https://github.com/kalamuna/kalastatic_dot_module/issues/6

Closing due to lack of activity. If you are still working on this application, you should fix all known problems and then set the status to "Needs review". (See also the project application workflow).

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

We've been using this on a number of sites. It is working well.

Overall code looks good! A few errors from PHP Code Sniffer Drupal coding standards / coder module (see below). @sonictruth, I recommend addressing them but they are minor and I don't consider them blockers to project status.

As @RobLoach mentioned, we have been using this module on several production sites and is effective, secure, and efficient. Confirming RTBC status!

kalastatic.module|49 col 3 error| Inline doc block comments are not allowed; use \"/* Comment */\" or \"// Comment\" instead [php/phpcs]

kalastatic.module|237 col 8 error| Use \"elseif\" in place of \"else if\" [php/phpcs]

kalastatic.module|237 col 8 error| Expected 1 space after IF keyword; 0 found [php/phpcs]

kalastatic.module|241 col 18 error| The $text argument to l() should be enclosed within t() so that it is translatable [php/phpcs]

kalastatic.module|241 col 46 warning| A comma should follow the last multiline array item. Found: ) [php/phpcs]

kalastatic.module|244 col 82 warning| Avoid backslash escaping in translatable strings when possible, use \"\" quotes instead [php/phpcs]

Thanks for your contribution! Congratulations, you are now a vetted Git user. You can promote this to a full project.

When you create new projects (typically as a sandbox to start) you can then promote them to a full project.

Here 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 (here you get to ask fans of your project to help you!)

You can find lots more contributors chatting on IRC in #drupal-contribute. So, come hang out and stay involved!

Thanks, 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.