Module integrates drupal installation with Visual Website Editor (http://tidioelements.com/) which enable to edit drupal site with our easy to use editor.

Git clone command:
git clone git.drupal.org:sandbox/tytus-tytus/2298777.git visual_website_editor

Project page: https://www.drupal.org/sandbox/tytus-tytus/2298777

Comments

PA robot’s picture

Status: Needs review » Needs work

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

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.

howto’s picture

Your issue is missing:

  • Project link
  • PA Review link

You should change your git clone command because it's a personal git clone command.
Please see this: https://www.drupal.org/node/1011698

gisle’s picture

Better fix this as well:

tytus-tytus’s picture

Issue summary: View changes
tytus-tytus’s picture

Status: Needs work » Needs review

Hi, I just made an update for mentioned issues. Is there is anything more to do please let me know through comments I will try to do that asap.

Thanks

gisle’s picture

Status: Needs review » Needs work

Hi, I just made an update for mentioned issues.

You've fixed some. Please fix them all before requesting a review.

tytus-tytus’s picture

Issue summary: View changes
Status: Needs work » Needs review

I made more changes.

Please let me know what I am missing. Also should I write here about the changes which I made from last review?

ethant’s picture

It would be helpful tytus-tytus, if you could go through all items listed by gisle, and give a brief response to the solution you implemented for each. Example:

Your issue summary is missing a lot of stuff, including a link to your project page: https://www.drupal.org/sandbox/tytus-tytus/2298777

Project link page added.

It appears you are working in the "master" branch in git. You should really be working in a version specific branch. The most direct documentation on this is Moving from a master branch to a version branch. For additional resources please see the documentation about release naming conventions and creating a branch in git.

Switched to branch xyz

Your project page is very brief. Please take a moment to make your project page follow the Project page template and it may be a good idea to also read tips for a great project page.

Added {.....} to project page.

Several sections in your README.txt, including "Configuration" are currently empty.

Added {.....} to README.txt

Please also make sure your project follows the guidelines for documentation.

Per documentation guidelines, added {.....} and changed {.....}.

tytus-tytus’s picture

Your issue summary is missing a lot of stuff, including a link to your project page: https://www.drupal.org/sandbox/tytus-tytus/2298777

Project link page added.

It appears you are working in the "master" branch in git. You should really be working in a version specific branch. The most direct documentation on this is Moving from a master branch to a version branch. For additional resources please see the documentation about release naming conventions and creating a branch in git.

Switched to branch 7.x-1.x

Your project page is very brief. Please take a moment to make your project page follow the Project page template and it may be a good idea to also read tips for a great project page.

Added Features, Requirements, Known problems, Credits and Instruction after installation to project page. Recommended modules was left with "None" because of none of these.

Several sections in your README.txt, including "Configuration" are currently empty.

Added Requirements, Configuration, Troubleshooting and Maintainers section to README.txt

Please also make sure your project follows the guidelines for documentation.

Per documentation guidelines, added screenshot, better description to project page. Fill up readme file, add more comments to functions in project code.

tytus-tytus’s picture

Assigned: Unassigned » tytus-tytus
tytus-tytus’s picture

Priority: Normal » Major

Please review.

mpdonadio’s picture

@tytus-tytus, see the comment in #1 about a review bonus. This will get your module looked at quicker.

mxr576’s picture

Priority: Major » Normal
Status: Needs review » Needs work

Pareview still containing several warnings, please fix them.
http://pareview.sh/pareview/httpgitdrupalorgsandboxtytus-tytus2298777git

If you aren't doing anything on visual_website_editor.install, then why you have this file on your module? FYI: it is not necessary to implements hook_install() and hook_uninstall() on your module if your module not necessary to do sth when it's installed or uninstalled. (Moreover the proper DOxygen comments missing form your implementations...)

Also please comment/indent your code properly:

function visual_webiste_editor_redirect() {


  global $user;
  $visual = new VisualEditor();

  // Check to see if $user has the administrator role.
  if ($visual->isAdmin()) {

    $url = $visual->getEditorUrl();
    header("Location: " . $url);
  }
  exit;
}

(Double line breaks before global $user is wrong, which do not visible here.)

Are you sure, that you want to use hook_boot() instead of hook_init()? FYI:

hook_boot(): Only use this hook if your code must run even for cached page views.

Is this really necessary for your module?

I've tried to test your module on http://simplytest.me/project/2298777, but something weird happened. First of all I can not switch on the your module several times, after all I've got this error:

Parse error: syntax error, unexpected T_STRING in /home/s23bed938eef8cea/www/sites/default/modules/2298777/TidioElementsParser/PhpQuery.php on line 3753

I think it isn't any affect that you have set the status to major, please try to get review bonus (just as I doing it right now) for faster reviews. But first, please fixed the mentioned bugs, improve your code!

Regards, mxr576

tytus-tytus’s picture

Thanks mxr576 for a review. Below is my list of changes with notes for your review:

Pareview still containing several warnings, please fix them.
http://pareview.sh/pareview/httpgitdrupalorgsandboxtytus-tytus2298777git

Most of the errors was fixed. Our module use extra library where we is one more error with function name. Should we change nam of this function in this library?

If you aren't doing anything on visual_website_editor.install, then why you have this file on your module? FYI: it is not necessary to implements hook_install() and hook_uninstall() on your module if your module not necessary to do sth when it's installed or uninstalled.

Files was deleted.

(Moreover the proper DOxygen comments missing form your implementations...)

We added extra comments for methods. Should we add something else?

(Double line breaks before global $user is wrong, which do not visible here.)

We removed it.

Are you sure, that you want to use hook_boot() instead of hook_init()?

We need it. With hook_init our plugin does not work properly.

I've tried to test your module on http://simplytest.me/project/2298777, but something weird happened. First of all I can not switch on the your module several times, after all I've got this error:

After update our module is installed and works ok.

tytus-tytus’s picture

Status: Needs work » Needs review
mxr576’s picture

Status: Needs review » Needs work

I recommend you that if you made some changes on your code then always re-test your project in http://pareview.sh/pareview/httpgitdrupalorgsandboxtytus-tytus2298777git before you change the project status to "needs review". While this page contains errors your project never get full project application I think. (If you need some help to solve this problems feel free to ask, of course.)

So this page still contains lot of errors, mostly in your external library:

  • First of all you should correct all your spelling errors.
  • Codespell has found some spelling errors in your code.

    ./TidioElementsParser/PhpQuery.php:340: agains ==> against
    ./TidioElementsParser/PhpQuery.php:1170: realy ==> really
    ./TidioElementsParser/PhpQuery.php:1228: doesnt ==> doesn't
    ./TidioElementsParser/PhpQuery.php:1325: refering ==> referring
    ./TidioElementsParser/PhpQuery.php:1935: DESCENDANDS ==> DESCENDANTS
    ./TidioElementsParser/PhpQuery.php:1939: DESCENDANDS ==> DESCENDANTS
    ./TidioElementsParser/PhpQuery.php:2406: doesnt ==> doesn't
    ./TidioElementsParser/PhpQuery.php:3430: doesnt ==> doesn't
    ./TidioElementsParser/PhpQuery.php:3987: futher ==> further
    ./TidioElementsParser/PhpQuery.php:3988: futher ==> further
    ./TidioElementsParser/PhpQuery.php:4096: choosed ==> chose, chosen
    ./TidioElementsParser/PhpQuery.php:4231: Usefull ==> Useful
    ./TidioElementsParser/PhpQuery.php:4286: Usefull ==> Useful
    ./TidioElementsParser/PhpQuery.php:4387: DOESNT ==> DOESN'T
    ./TidioElementsParser/PhpQuery.php:4822: agains ==> against
    ./TidioElementsParser/PhpQuery.php:5414: doesnt ==> doesn't
    ./TidioElementsParser/PhpQuery.php:5582: doesnt ==> doesn't

  • After that you should fix code style errors, like these:

FILE: /var/www/drupal-7-pareview/pareview_temp/TidioElementsParser.php
--------------------------------------------------------------------------------
FOUND 53 ERRORS AND 2 WARNINGS AFFECTING 45 LINES
--------------------------------------------------------------------------------
1 | ERROR | [ ] Missing file doc comment
3 | ERROR | [x] Inline control structures are not allowed
8 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE"
| | but found "false"
9 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "NULL"
| | but found "null"
16 | ERROR | [ ] Missing function doc comment
16 | ERROR | [ ] Variable "projectPublicKey" is camel caps format. do not
| | use mixed case (camelCase), use lower case and _
24 | ERROR | [ ] Variable "projectPublicKey" is camel caps format. do not
| | use mixed case (camelCase), use lower case and _
28 | ERROR | [x] Inline control structures are not allowed
29 | ERROR | [x] TRUE, FALSE and NULL must be uppercase; expected "FALSE"
| | but found "false"
34 | ERROR | [ ] Missing function doc comment

  • And finnaly, if your external library is clean: if you want to use external libraries in your Drupal module, than do it in the right way with Libraries API. (Here is a how-to.) In this way you can get rid of this type of error massages:

./TidioElementsParser/PhpQuery.php: all functions should be prefixed with your module/theme name to avoid name clashes. See https://www.drupal.org/node/318#naming

function pq($arg1, $context = null) {

FILE: ...ar/www/drupal-7-pareview/pareview_temp/TidioElementsParser/PhpQuery.php
--------------------------------------------------------------------------------
FOUND 0 ERRORS AND 41 WARNINGS AFFECTING 37 LINES
--------------------------------------------------------------------------------
31 | WARNING | Class name must be prefixed with the project name
| | "Visualeditor"
140 | WARNING | Class name must be prefixed with the project name
| | "Visualeditor"
478 | WARNING | Variable $matches is undefined.
517 | WARNING | Variable $hltml is undefined.
814 | WARNING | Class name must be prefixed with the project name
| | "Visualeditor"
966 | WARNING | Interface name must be prefixed with the project name
| | "Visualeditor"
993 | WARNING | Class name must be prefixed with the project name
| | "Visualeditor"
1030 | WARNING | Class name must be prefixed with the project name

gisle’s picture

3rd party code/content
No.

The module comes bundled with phpQuery.php, which appears to be third party code created by Tobiasz Cudnik. Third party code is not generally allowed on Drupal.org and should be deleted.
This particular code is made available under the MIT license. This license may be compatible with GPL V2+, but all third party content must be explicitly approved by Drupal.org webmasters to be hosted on Drupal.org.
This policy is described in the 3rd party libraries and content on Drupal.org. It also appears in the Drupal Git Repository Usage policy you agreed to when you signed up for Git access, which you may want to re-read, to be sure you're not violating other terms.
The Libraries API module is a recommended method for adding 3rd party dependencies without directly including the code on Drupal.org.
PA robot’s picture

Status: Needs work » Closed (won't fix)

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.