EditHub provides a fully configurable, discrete and easy to use administration menu.
Each feature is displayed in a section and has a set of actions. Each action is displayed according to the current user's permissions.
Sections, features and actions are configurable with the hook_edithub and editable with hook_edithub_alter
It is different from other modules because you can configure actions/buttons to simplify the menu (a feature can have multiple actions/buttons displayed if current user have access)

Drupal SandBox : https://drupal.org/sandbox/radiofrance/2210437
Git repo : git clone --branch 7.x-1.x http://git.drupal.org/sandbox/RadioFrance/2210437.git edithub

Thanx a lot for your validation !

Comments

gobinathm’s picture

Status: Needs review » Needs work

Based on the description found Sandbox page, it looks like you have raised this project application request on a non-individual account. Please note that organization accounts cannot be approved for git commit access. Refer https://drupal.org/node/1966218 and https://drupal.org/node/1863498 for details on what is/isn't allowed. Please update your user profile so that we don't have to assume that this is a group account.

After enabling this module, i'm not seeing any features and actions as mentioned in sandbox description

  1. You still have Master Branch, this needs to be major release branch. Guide for changing your default branch
  2. README.txt : Your project is missing this. Its advisable to have a readme file. This file should contain a basic overview of what the module does and how someone may use it. Guidelines for in-project documentation.
  3. edithub.html.inc & edithub.views_default.inc ,both these files have unused variables. Its advisable to remove unused variables (let us know if its a false positive, I'm not able to identify the usage of these variables).

I consider above once as important, but not application blocker. In-contrast the below once can be categories as nice to have, its you choice to change it.

Please manually review 3-4 Projects & have a review bonus tag added to your application. Project applications with review bonus always get priority
Also please go thru the application submission checklist which would be of great help.
Additionally you can also check Apply for permission to create full projectspage for clear instruction on how to have your project description updated.

Once you are done with necessary changes please change the status to Needs Review so that other contributors would start looking at this project.

Radio France’s picture

Status: Needs work » Needs review

1. "Master" branch deleted.
2. "README.txt" file added
3. I don't find any unused variable in these two files. Can you help me found these unused variables ?

Thanx a lot, and hope you will like this module !

draenen’s picture

Status: Needs review » Needs work

Automatic review still returns issues. See http://pareview.sh/pareview/httpgitdrupalorgsandboxradiofrance2210437git

Manual Review

edithub.html.inc:39 - HTML should be generated using a hook_theme function See https://api.drupal.org/api/drupal/modules!system!system.api.php/function...
edithub.html.inc:42 - It is safer to make a copy of global variables ($user = $GLOBALS['user']) to avoid accidentally overwriting or change the global value.

Radio France’s picture

Status: Needs work » Needs review

Hi,
Fixes a lot of issues !

Thanx a lot for your help !

Radio France’s picture

Hi,
this module is ready to test :)

Janke Consulting’s picture

Status: Needs review » Needs work

An automated review of your project has found some issues with your code; As coding standards make sure projects are coded in a consistent style we please you to have a look at the report and try to fix them. Anyway, note that issues found are possibly false positives and fixing all issues is not a requirement for getting through the application process.

You can find the results of the automated report at http://pareview.sh/pareview/httpgitdrupalorgsandboxradiofrance2210437git.

Radio France’s picture

Status: Needs work » Needs review

Are you sure for comments indentation ? Core modules indent comments.

  • I've limited README lines.
  • I've deleted remote "master" branch.
  • I've replaced "stdClass" by "object".

Ready to publish :)
Many thanx.

znaeff’s picture

Status: Needs review » Needs work

Hi!

1. Fix git link in description.

Change
git.drupal.org:sandbox/RadioFrance/2210437.git
to
git clone --branch 7.x-1.x http://git.drupal.org/sandbox/RadioFrance/2210437.git edithub

2. I see http://pareview.sh/pareview/httpgitdrupalorgsandboxradiofrance2210437git still returns issues about 2 files, please fix them all.

3. Remove admin callback function - it is empty. And edithub.callbacks.inc file.

Radio France’s picture

Issue summary: View changes
Radio France’s picture

Status: Needs work » Needs review

Thanx znaeff.
All changes done.

Many thanx for review.

subhojit777’s picture

Status: Needs review » Needs work

Pareview.sh found these issues: http://pareview.sh/pareview/httpgitdrupalorgsandboxradiofrance2210437git

Manual review:
- In edit-button tpl, you should display the link through theme variable. Add the l() function code in a preprocess function and display it in tpl. This ensures absolute link.
- Some comments are written in French, they should be in English.

I enabled the module in a fresh Drupal installation (Drupal 7.28) and seems like the module is not working. I am checking the installation as admin and I dont see any changes. Tried disabling overlay and toolbar module, but I dont see any menu as shown in https://www.drupal.org/sandbox/radiofrance/2210437. Am I missing some setting?

Radio France’s picture

Status: Needs work » Needs review

Hi,
thank you subhojit777 for review !

I fixed your manual review.
I fixed the Pareview report (http://pareview.sh/pareview/httpgitdrupalorgsandboxradiofrance2210437git), I think the 2 remaining issues are false-positive.

dbt102’s picture

Automated Review

Best practice issues identified by pareview.sh / drupalcs / coder. Please don't copy/paste all of the results unless they are short. If there are a lot, then post a link to the automated review and mention that problems should be addressed.

Manual Review

Individual user account
Yes
No duplication
Yes.
Master Branch

(*) or (+)

Yes...but After download via 'git clone' I don't see app_link, rather "2289011" ... IMO ==> needs fixed
Licensing
Yes
3rd party code
Yes
README.txt/README.md

(*)

No ==> Needs better installation instructions --> Needs some kind of instructions to user on how to 'enable/activate the feature/use' the module
Code long/complex enough for review
Yes
Secure code
Yes - I find no issues identified, but I'm not an expert here.
Coding style & Drupal API usage
  1. (*) Major finding
  2. Minor finding ==> See comment under "Master Branch" above.
  3. (+) Release blocker
  4. (*) Major finding

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.

dbt102’s picture

Status: Needs review » Needs work
Radio France’s picture

Status: Needs work » Needs review

Hi dbt102,
Thanx for your review.
I don't understand the part "app_link" of this review ? Is it a branch to create ?
For the readme, all informations are here, there is nothing to activate out of the box, you have to create your own features. Do you want a better exemple in the .api.php ?

albertski’s picture

1. It looks like the Views module is a dependency to this module. Please add it as a dependency to your .info file.

2. It looks like there is some code in French. To be consistent can you translate these to English (not sure if I found all of them):
$items['myContainer']['label'] = 'Mises en avant';

/* Filter criterion: Contenu: Titre */
$handler->display->display_options['filters']['title']['expose']['label'] = 'Titre';
$view->description = 'Vue d\'administration';
$handler->display->display_options['pager']['options']['tags']['previous'] = '‹ précédent';
$handler->display->display_options['pager']['options']['tags']['next'] = 'suivant ›';
$handler->display->display_options['pager']['options']['tags']['last'] = 'dernier »';
$handler->display->display_options['arguments']['type']['title'] = 'Les %1s';

3. Remove extra spaces (Line 84 -86 edithub.html.inc):

$html_subentries .= theme('edithub_subentry', array(
  'label' => $entry['label'],
  'buttons' => $html_buttons,
));

4. Remove extra spaces (Line 94 -96 edithub.html.inc):

$html_entries .= theme('edithub_entry', array(
  'label' => $item['label'],
  'subentries' => $html_subentries,
));
jlbellido’s picture

Status: Needs review » Needs work

Hi,
You should add a @file document block to edithub.js file acording to:

FILE: /var/www/drupal-7-pareview/pareview_temp/js/edithub.js
--------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------
1 | ERROR | Missing file doc comment
--------------------------------------------------------------------------------

Please, fix the suggested comments at #16 and the @file document block, you can check it at http://pareview.sh/pareview/httpgitdrupalorgsandboxradiofrance2210437git

Regards!

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.

Radio France’s picture

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

Changes pushed.

@albertski : It's not a dependency, but if you have views module, Edithub add a new view. The module works fine without Views.

Anonymous’s picture

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

  • Coder Sniffer has found some issues with your code (please check the Drupal coding standards).
    
    FILE: /var/www/drupal-7-pareview/pareview_temp/js/edithub.js
    ---------------------------------------------------------------------------
    FOUND 2 ERRORS AFFECTING 2 LINES
    ---------------------------------------------------------------------------
     3 | ERROR | [x] Doc comment short description must end with a full stop
     4 | ERROR | [ ] There must be exactly one blank line after the file
       |       |     comment
    ---------------------------------------------------------------------------
    PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
    ---------------------------------------------------------------------------
    
    Time: 216ms; Memory: 8Mb
    
  • DrupalPractice has found some issues with your code, but could be false positives.
    
    FILE: /var/www/drupal-7-pareview/pareview_temp/edithub.html.inc
    ----------------------------------------------------------------------
    FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
    ----------------------------------------------------------------------
     44 | WARNING | Variable $user is undefined.
    ----------------------------------------------------------------------
    
    Time: 84ms; Memory: 5.5Mb
    
  • 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.

Source: http://pareview.sh/ - PAReview.sh online service

Radio France’s picture

Hi,
I've fixed the CodeSniffer's issues.

pablitt’s picture

Status: Needs review » Needs work

Manual review:

  1. As @gobinathm mentioned in #1, I enable the module and I can't tell what should be happening next. You should add a .install file as suggested in the recommended practices and provide some guidance after the module is enabled.
  2. This module is definitely using Views features, please add the views module as a dependency in the edthub.info file:
        name = EditHub
        description = Fully configurable, discrete and easy to use administration menu
        core = 7.x
        package = Administration
        
        dependencies[] = views
      
  3. That being said, the edithub.views_default.inc still has some texts in French (like 'Titre'). You should translate them to English.
  4. I think the README file and the information about this module (this page and the project page) are misleading.

    By reading the introduction/description, it looks that this module provides a UI to manipulate the administration menu. But then if I keep reading the README file and the code, it actually looks that this module provides a hook and a template variable to show a manipulated menu. Is that correct?.

    Either way, you should definitely assemble a more appropriate description and clear examples (don't just reference to the edithub.api.php file, that's even more confusing) about how to use this module.

It looks that this module has something interesting to offer, but his purpose is lost because the documentation is not clear (you should definitely add Roadmap, Known Issues, and the Dependencies sections). Take a look at the Project page template for more information.

It would help a lot if you also explain in a very few lines some context (in the Synopsis section) about why this module was created.

I hope this helps.

Cheers!

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.