Joomag filter

This input filter simplifies the embedding of Joomag publications in Drupal nodes. It is a Drupal implementation of the original Joomla extension.

7.x version only.
drupalcs-compliant.

Sandbox URL:
https://www.drupal.org/sandbox/mariano.barcia/2426193

Git clone:

git clone --branch 7.x-1.x http://git.drupal.org/sandbox/mariano.barcia/2426193.git joomag_filter
cd joomag_filter

Manual reviews of other projects

#2371073-6: [D7] Backup and Migrate WebDAV
#2426991-8: [D7] Features Default Tab
#2445345-4: [D7] Component Cache Expiration

Comments

PA robot’s picture

Status: Active » Needs work

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

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.

mariano.barcia’s picture

The review at the excellent tool/resource online
http://pareview.sh/pareview/httpgitdrupalorgsandboxmarianobarcia2426193git
passes now.

Next step, find the time to review 3 projects and add some _real_ unit tests.

mariano.barcia’s picture

Status: Needs work » Needs review
naveenvalecha’s picture

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 :-)

vbouchet’s picture

Hola Mariano,

Please find my findings, all may not be applicable but it's probably interesting to have it:

  • Ticket is not following "requirements" - title is missing [D7], git command is missing - we are lazy ;-)
  • The repository is containing a .gitignore
  • It may be a good idea to rename joomag_filter.inc into joomag_filter.filter.inc, so without opening the file we almost already know what it's containing.
  • I don't think it's really useful to have a separate _joomag_filter_information() to return a string which is used only once in joomag_filter_help().
  • In _joomag_filter_information(), as per the l() documentation you should use t() and embed the HTML anchor tag directly in the translated string.
  • In joomag_filter_filter_info(), it would be better for readability to close the array on a new line:
    function joomag_filter_filter_info() {
      $filters['joomag'] = array(
        'title' => t('Joomag filter'),
        'description' => t('For more info visit joomag.com.'),
        'process callback' => '_joomag_filter_filter_joomag_process',
      );
      return $filters;
    }
  • In joomag_filter_filter_info(), the joomag.com may be a link.
  • Maybe it's because I'm not used to Joomla but I think you should improve functions comment into joomag_filter.inc
  • It seems the test file is work in progress, it may be a good idea to move it into a separate git branch during the development.

Thanks,

vbouchet’s picture

Status: Needs review » Needs work
mariano.barcia’s picture

Title: Joomag filter » [D7] Joomag filter
Issue summary: View changes

Thank you vbouchet, for your detailed and accurate feedback.

I'm hereby fixing the ticket as you pointed out, and will be working on the remaining issues as soon as possible.

mariano.barcia’s picture

Status: Needs work » Needs review

Hello @vbouchet, I've fixed all the issues you've pointed out, and http://pareview.sh/pareview/httpgitdrupalorgsandboxmarianobarcia2426193git keeps a pass. Thank you.

PA robot’s picture

Status: Needs review » Closed (duplicate)
Multiple Applications
It appears that there have been multiple project applications opened under your username:

Project 1: https://www.drupal.org/node/2452759

Project 2: https://www.drupal.org/node/2426211

As successful completion of the project application process results in the applicant being granted the 'Create Full Projects' permission, there is no need to take multiple applications through the process. Once the first application has been successfully approved, then the applicant can promote other projects without review. Because of this, posting multiple applications is not necessary, and results in additional workload for reviewers ... which in turn results in longer wait times for everyone in the queue. With this in mind, your secondary applications have been marked as 'closed(duplicate)', with only one application left open (chosen at random).

If you prefer that we proceed through this review process with a different application than the one which was left open, then feel free to close the 'open' application as a duplicate, and re-open one of the project applications which had been closed.

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

mariano.barcia’s picture

Status: Closed (duplicate) » Needs review

Re-opening (closed the other one).

mariano.barcia’s picture

Issue summary: View changes
Issue tags: +PAreview: review bonus
naveenvalecha’s picture

Issue tags: -PAreview: review bonus

Removing review bonus tag.you have not done manual review you just pasted the output of the phpcbf and phpcs here https://www.drupal.org/node/2426991#comment-9726309 https://www.drupal.org/node/2445345#comment-9725859
Do manual reviews there and if you have not found anything then specify there and set the issue status accordingly.Then Add the review bonus again.

mariano.barcia’s picture

Issue tags: +PAreview: review bonus

Er..., I have not done any "copy and paste", I believe @naveenvalecha judgement is misguided.

Actually, to be able to detect what I'm pointing out in #2445345-4: [D7] Component Cache Expiration, you have to, at least, checkout the code and import it in Eclipse. And that's exactly what I did for the manual review (and my Eclipse ran the Validation automatically).

Both reviews are as a good as any, and a month later they are still valid. #2426991: [D7] Features Default Tab is a small project that had been reviewed and corrected before. BTW, the quality of both projects reviewed is, I must say, higher than most of the code you can see in the official contrib releases.

Please note that I'm already contributing another module in #2452759: [D7] RESTful web services support for files and images, and another (restws_i18n) is on its way. If you still feel that I must submit further contributions, just ask, and I'll find a project. So, tagging again, thank you in advance.

mqanneh’s picture

Status: Needs review » Reviewed & tested by the community

tested and reviewed, no problems were found during the test.
this module does what is said in the description + simple backend.

mariano.barcia’s picture

Thank you very much @mqanneh.

On another note, I've shared restws_i18n in my sandbox.

naveenvalecha’s picture

Issue summary: View changes

updated git command.
#13
We usually judge on the basis of the review comment.

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

    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.

Manual Review :

  1. Remove the extra 7.x-1.x-tests branch if not needed.
  2. joomag_filter_help : Avoid use of html in translatable strings
  3. Need to do cleanup in JoomagFilterTests.php Is it needs work ?
  4. Readme.txt : Go to "MY ACCOUNT" > "MY MAGAZINES" and select a magazine from the list. I have not found this path because the module is not registering the path.Are you talking about the www.joomag website here. Please add a comment.
  5. hook_help is nice.Add a helping text about the regex in this function do _joomag_filter_get_value_with_default

Otherwise looks good to me.

mariano.barcia’s picture

@naveenvalecha,

Thank you for your review.

Here's my reaction to your comments:

  1. Deleted test branch.
  2. This is actually the best practice, as per #2426211-5: [D7] Joomag filter. Kept it as it is.
  3. Deleted the test folder altogether, as I will add a complete version later on.
  4. Done, as per your suggestion.
  5. Done.

One more thing:
Following a PHPDepend warning, telling the cyclomatic complexity level of joomag_filter_get_magazine() was too high (11), I spinned off 2 new functions to reduce joomag_filter_get_magazine() complexity. I'm glad that I did this, as the code and comments are looking much better now.

naveenvalecha’s picture

Assigned: mariano.barcia » Dave Reid

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

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

  1. 1. Sign-in at joomnag.com.Seems type in website address ?
  2. Project page needs more information.See the tips https://www.drupal.org/node/997024
  3. joomag_filter_help : Avoid use of html in translatable strings

Rest looks good to me.No more blocker.
Assigning to Dave reid to take a final look at this if he has time.

klausi’s picture

Assigned: Dave Reid » klausi
klausi’s picture

Assigned: klausi » Unassigned
Status: Reviewed & tested by the community » Fixed

Thanks you for your reviews. If you did not find any problems with an applications please set it to "Reviewed & Tested by the community" after your review.

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

  • Coder Sniffer has found some issues with your code (please check the Drupal coding standards).
    FILE: /home/klausi/pareview_temp/joomag_filter.module
    ---------------------------------------------------------------------------
    FOUND 3 ERRORS AFFECTING 3 LINES
    ---------------------------------------------------------------------------
     18 | ERROR | [x] Closing parenthesis of array declaration must be on a
        |       |     new line
     31 | ERROR | [x] Closing parenthesis of array declaration must be on a
        |       |     new line
     32 | ERROR | [x] Closing parenthesis of array declaration must be on a
        |       |     new line
    ---------------------------------------------------------------------------
    PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    ---------------------------------------------------------------------------
    
  • 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.

manual review:

  • I looked at the regex replacement code and wondered whether an attacker could inject some XSS into the magazine URL or other parts, but could not come up with a working exploit if a limited text format such as filtered HTML is used.

Otherwise looks good to me, so ...

Thanks for your contribution, mariano.barcia!

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:

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.

mariano.barcia’s picture

Good news!

BTW, I've fixed the phpcs warnings, enriched to the project page contents and added a 1.0 release.

Thank you all for your help.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

apaderno’s picture

Issue tags: -#D7, -joomla