[D7] Panels Lock Region

Fixed the git clone URL in the issue summary for non-maintainer users.

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.

Hi Zequi,
I am unable to install your module due to the dependancy module.
dependencies[] = panels_ipe
No release history was found for the requested project (Panels_ipe).

Automated Review

Fix errors in automated review

Manual Review

Individual user account

Yes: Follows 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

Coding style & Drupal API usage

* Implements hook_help()
It is recommended to get the basic understanding of the module to new users.

Hi Zequi

It looks like CodeSniffer is complaining about not using lowerCamel format in those method names. I understand that it may be out of your control since you're overriding other methods. Where do those methods originate, and is there a reason they aren't using the format CodeSniffer expects?

Using those method names is the correct approach even though it's not fitting the ideal coding standards. Marking as RTBC.

Will take a look at this today or tomorrow.

Automated Review

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

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

  
  FILE: ...temp/plugins/display_renderers/PanelsLockRegionSelectiveIpe.class.php
  ---------------------------------------------------------------------------
  FOUND 3 ERRORS AFFECTING 3 LINES
  ---------------------------------------------------------------------------
   15 | ERROR | Public method name
      |       | "PanelsLockRegionSelectiveIpe::render_region" is not in
      |       | lowerCamel format
   77 | ERROR | Public method name
      |       | "PanelsLockRegionSelectiveIpe::render_pane" is not in
      |       | lowerCamel format
   88 | ERROR | Public method name
      |       | "PanelsLockRegionSelectiveIpe::ajax_change_lock" is not in
      |       | lowerCamel format
  ---------------------------------------------------------------------------
  
  Time: 252ms; Memory: 6Mb
  

• 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.

You can ignore the errors; they are false positive because of the way ctools wants things named.

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

Not seeing anything.

Coding style & Drupal API usage

PanelsLockRegionSelectiveIpe::render_region(), you can use drupal_attributes() instead of imploding yourself.

Can you add the CSS in PanelsLockRegionSelectiveIpe::render_region() instead of through the module .info?

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.

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.

Not seeing anything. Assigning to heddn for a second look if he has time. If he doesn't in the next few days, I will approve this.

Licensing

Maybe: Follows the licensing requirements.

Coding style & Drupal API usage

1. The permissions use the phrase "Selective IPE", like that is a thing. But I don't see a module by that name. This module is called something different. Re-wording things to tie Lock Region (name of the module) to Selective IPE (name of the IPE) would make it more clear. Maybe just rename the IPE?
2. Adding a drupal_alter into the theme layer isn't really necessary. Themes can be modified in preprocess pretty easily. Or overriden entirely. drupal_alter('panels_lock_region_region_links', $vars['links'], $context);
3. * How are the graphics in the images folder licensed? Do you have rights to use them?

Postponing on #3. If the answer is that full rights are available, then +1 on the RTBC.

Thanks for your contribution, Zequi! The only blocker was 18.3, so let's promote you. You can continue to improve the code as you see fit.

Re IPE naming: If the module is named panels lock region, I'd assume the IPE would have a similar name. Not too important though.

I updated your account so you can promote this to a full project and also create new projects as either a sandbox or 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

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.

Thanks to the dedicated reviewer(s) as well.