http://drupal.org/sandbox/greenrover33/1271020

git clone --recursive --branch 7.x-2.x http://git.drupal.org/sandbox/greenrover33/1271020.git archibald_2
cd archibald_2

Archbiald2 an acquisition and administrative interface for electronic learning resources.
It allows to collect bibliographical and educational meta data.
It implements a work flow to let several people create the meta data of learning resource together.
In frontend there is a SQL or Apache Solr powerd search with allot of possible filters.
For example filtering by curriculum or operational useage area.
Translation for german and french are included.
All meta data are based on IEEE LOM http://ltsc.ieee.org/wg12/files/LOM_1484_12_1_v1_Final_Draft.pdf

REVIEWS I HAVE DONE:
http://drupal.org/node/1330454#comment-5354220
http://drupal.org/node/1599236#comment-6051580
http://drupal.org/node/1431366#comment-6051672
http://drupal.org/node/1408912#comment-6052384
http://drupal.org/node/1203208#comment-6055764
http://drupal.org/node/1408912#comment-6060640

CommentFileSizeAuthor
#14 drupalcs-result.txt494.12 KBklausi
#11 drupalcs-result.txt743.52 KBklausi
#1 archibald.txt247.37 KBpgogy

Comments

pgogy’s picture

StatusFileSize
new247.37 KB

Hello,

You might need to download the code_review module (http://drupal.org/project/coder)

As it picks up a lot of coding issues with this module (some of which might be in library files)

I've attached a list.

greenrover33’s picture

Ohnn no, i used the code module from:
http://git.drupal.org/sandbox/klausi/1339220.git

drush coder-review minor no-empty dsb_client
Severity minor

Status Messages:
 Coder found 1 projects, 83 files, 0 warnings were flagged to be ignored

But now i fixed all errors!

miro_dietiker’s picture

Status: Needs review » Needs work

That's great work.

I have skimmed through most of the PHP code in the repo (module, includes, inc, ...) and it looks it's most cleanly following the standards and is well structured.
We've been discussing the project with the origin already a bit and they have a lot of documentation around (non-english, but on a very detailled level). There's strong interest in further maintenance and improvement of the project.
I consider it a sane base and a future proof one and thus i'd love to vote for a public go. BUT..

Few Details about the code formatting: It's not yet fully clean and there are quite a few obvious things left..
Long SQL statements are not uniform indented. Some outer left, some +2 spaces indented, some +n+2.
There are some places where i see +4 indents that should be fixed to +2 only.
Some watchdogs are not cleanly formatted (multiline also). Same for log() method. It seems, second line +4, laters +2 only... This should be inverted...

Back to work atm. Will you take the time to fix this too?

greenrover33’s picture

Status: Needs work » Needs review

Is it now better? I tryed to change every thing to 2 indents.

miro_dietiker’s picture

Status: Needs review » Reviewed & tested by the community

OK, much better now. I can read this now much faster.
And it's awesome work in the learning area.

Some (lower prio) followup additions:
Checked your tpl.php and they contain quite a bit code. I thought we should use preprocess functions here to prepare stuff instead of using theme() functions inside of the .tpl.php variables...
http://drupalcode.org/sandbox/greenrover33/1271020.git/blob/refs/heads/7...
Here you have an "a href"... that doesn't follow our standard formattings
http://drupalcode.org/sandbox/greenrover33/1271020.git/blob/refs/heads/7...
Sometimes still if you open two brackets on one line, you indent +4 (and you close it on two lines). This is not standard. If you need two levels of indentation, open them on separate lines.
(i hope i'm right with most of this wisdom ;-) )

As i see here fast progress, i now vote for going public. I'm sure you will work a lot on this software in future.

klausi’s picture

Multiple Applications
It appears that there have been multiple project applications opened under your username:

Project 1: http://drupal.org/node/1270872
Project 2: http://drupal.org/node/1598666

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.

miro_dietiker’s picture

The issue description has been updated above, 3 bonus reviews done by greenrover33 as requested by klausi.

miro_dietiker’s picture

Issue summary: View changes

Add reviews

patrickd’s picture

Issue tags: +PAreview: review bonus

you also have to tag your issue with "PAReview: review bonus"

greenrover33’s picture

@miro
I put now as mutch code as possible fomr *.tpl.php files to template_preprocess _* methodes.

The href was swaped to l()

We work with 3 develoeprs for 8 hours through the whole code. And now we have hoply and finaly found all indet issues.

And now we will work further on our to do lists. With the new features.

greenrover33’s picture

Issue summary: View changes

Add review

greenrover33’s picture

Issue summary: View changes

change git link to non maintainer

miro_dietiker’s picture

Wow, great work! Amazing speed. Hope klausi will pick it up. :-)

klausi’s picture

Status: Reviewed & tested by the community » Needs work
Issue tags: -PAreview: review bonus
StatusFileSize
new743.52 KB

Review of the 7.x-2.x branch:

  • Remove the translations folder, translations are done on http://localize.drupal.org
  • ./form/form_life_cycle.inc: all functions should be prefixed with your module/theme name to avoid name clashes. See http://drupal.org/node/318#naming
    function ajax_dsb_client_content_form_life_cycle_add_empty_contribute($form, $form_state) {
    
  • ./form/form_relation.inc: all functions should be prefixed with your module/theme name to avoid name clashes. See http://drupal.org/node/318#naming
    function ajax_dsb_client_content_form_relations_release_relation() {
    function ajax_dsb_client_content_form_relations_add_empty_relation($form, $form_state) {
    
  • ./form/form_keywords.inc: all functions should be prefixed with your module/theme name to avoid name clashes. See http://drupal.org/node/318#naming
    function ajax_dsb_client_content_form_general_add_empty_keyword($form, $form_state) {
    function ajax_dsb_client_content_form_general_add_empty_coverage($form, $form_state) {
    
  • ./form/form_general.inc: all functions should be prefixed with your module/theme name to avoid name clashes. See http://drupal.org/node/318#naming
    function ajax_dsb_client_content_form_general_add_empty_identifier($form, $form_state) {
    
  • Bad line endings were found, always use unix style terminators. See http://drupal.org/coding-standards#indenting
    ./css/curriculum_educa.css:                                             ASCII text, with CRLF line terminators
    
  • Drupal Code Sniffer has found some issues with your code (please check the Drupal coding standards). See attachment.

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. Get a review bonus and we will come back to your application sooner.

manual review:

  1. project name is "Archibald 2" but the module machine name is "dsb_client"? Very confusing, what does dsb_client mean?
  2. dsb_client.install: do not globally mess with PHP settings! This is currently a security problem for production sites where you should never set "ini_set('display_errors', 'on');" as potential private information could be leaked with those error messages. Remove those ini_set() and error_reporting() calls everywhere.
  3. do not declare files in the info if they do not contain a class/interface
  4. "class DbStruct": all class names need to be prefixed with your module's name to avoid name collisions. Same for all the other classes.
  5. do you really want to depend on the shortcut module? why?
  6. dsb_client_uninstall(): drupal_uninstall_schema() is not needed in Drupal 7, so remove that function.
  7. dsb_client_update_7201(): doc block: the first line should contain a short description what the update does, because that will be displayed on update.php or un drush updb. Also on the other hook_update_N() functions.
  8. dsb_client_update_7205(): use db_update() instead of db_query('UPDATE ...'). Also elsewhere.
  9. "define('RES_FIELD_OPTIONAL', '0');": all constants that your module defines should be prefixed with your module's name to avoid name collisions.
  10. dsb_client.module: classes are autoloaded, do not require_once them here again globally for every single page request. Same for places where you uase classes: no need for require_once or module_load_include() as the classes will get autoloaded.
  11. dsb_client_user_view_alter(): this is a hook implementation and should be documented as such, see http://drupal.org/node/1354#hookimpl
  12. dsb_client.module is huge. Have you considered splitting it up into several modules for better maintainability?
  13. theme_dsb_client_content_publish_central_status(): put Javascript into a dedicated JS file and pass variables with Drupal.settings to it, see http://drupal.org/node/756722
  14. theme_dsb_client_choose_contributer_search_form(): do not build form markup yourself, use theme('button', ...) or whatever fits here.

Otherwise I did not find any severe issues (also because of the overwhelming complexitiy). Point 2 and 4 of my manual review are blockers right now. Point 1 is also important, so I suggest you rename your project to "DSB client" and come up with a clever idea what that means, or you will have to rename all kind of stuff like functions, classes, constants in your project to archibald2 ;-)

Removing review bonus tag, you can add it again if you have done another 3 reviews of other projects.

greenrover33’s picture

Issue summary: View changes

add review

greenrover33’s picture

Issue tags: -PAreview: review bonus

Hello Klausi,
thanks for reviewing.

Today we fixed some of your issues

  1. renamed everything to archibald. Because in the beginning of the project this sofware was only for record ressource for central catalog (dsb -> Digital School Libary). But now it runs standalone. Cause of this the name change.
  2. we removed the ini_set and error_reporting lines
  3. Ok, declared only files which containing classes. But i no where found documentation about, wjhat wfor that is.
  4. We changed all constans, global vars, function, classes and methodes, prefixt them with module name and make them drupal coding standart conform
  5. it is currently no more used, cause of this we removed the depends shortcut
  6. we removed all hook_uninstall()
  7. we changed the doc block of all hook_update()
  8. we use now db_update every where insted of db_query
  9. All constans are now prefixed and in drupal conveniens
  10. We changed the *.info files. But not removed the requre statements, because currently we dont understand how it should work (should this also work for drush?)
  11. Ok dok type was addet
  12. I know that the dsb_client.module is huge, but we allready splited it up. We will try further but it is a dificult job
  13. Tomorrow i will move all inline js into *.js files
  14. We use the form api, see function above archibald_choose_contributer_search_form(). We only style it with HTML. The most fields are drupal rendert. Only some small things are done with plain HTML

We also absolved a small functionalety test. The full test will done tomorrow.

greenrover33’s picture

Status: Needs work » Needs review
Issue tags: +PAreview: review bonus

I have in total 6 reviews, hope this is enouph for another PAReview: review bonus

klausi’s picture

Status: Needs review » Reviewed & tested by the community
StatusFileSize
new494.12 KB

Dokumentation for "files[]" in info files: http://drupal.org/node/542202
Drush will bootstrap Drupal which means that the class registry is also loaded. Therefore you don't need the require_once statements.

Review of the 7.x-2.x branch:

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. Get a review bonus and we will come back to your application sooner.

manual review:

  1. there are still quite a lot of errors from the automated review script, please take a look at those.
  2. Info file errors:
    FILE: .../drupal-7/sites/all/modules/pareview_temp/test_candidate/archibald.info
    --------------------------------------------------------------------------------
    FOUND 2 ERROR(S) AFFECTING 2 LINE(S)
    --------------------------------------------------------------------------------
     26 | ERROR | Declared file was not found
     27 | ERROR | Declared file was not found
    --------------------------------------------------------------------------------
    
  3. The name dsb_client is still used quite often: grep -rin dsb_client *
    includes/file_uploader/uploader.ftp.class.php:417:    $ftp_config = (array) variable_get('dsb_client_uploader_plugin_config_ftp_' . $content_partner_id,
    includes/archibald.translate.inc:265:      ':solr_enabled' => variable_get('dsb_client_solr_search_activ', 0),
    
  4. "Implements of hook_disable()." should be "Implements hook_disable().". Also elsewhere.
  5. archibald_disable(): will throw fatal errors if the shortcut module is not enabled.
  6. the older table name "dsbc_settings_content_partner" is still used in the install file and will throw fatal errors on installation.

That should definitively be fixed, but otherwise looks RTBC to me. Removing review bonus tag, you can add it again if you have done another 3 reviews of other projects.

greenrover33’s picture

Hi Klausi,
i am for 1 week in Holidays, but one of my team mates will follow up your issues, for this time.

patrickd’s picture

Status: Reviewed & tested by the community » Fixed

Your project page is not very detailed, please have a look at the tips for a great project page, you may also use HTML-tags for better structure.

Thanks for your contribution and welcome to the community of project contributors on drupal.org!

I've granted you the git vetted user role which will let you promote this to a full project and also create new projects as either sandbox or "full" projects depending on which you feel is best.

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.

As you continue to work on your module, keep in mind: Commit messages - providing history and credit and Release naming conventions.

Thanks to the dedicated reviewer(s) as well.

miro_dietiker’s picture

Thank you, patrickd. I'm really happy, that archibald is now part of our community and we have a valueable new contributor.
Welcome, greenrover33!

greenrover33’s picture

Thanks to patrik, klausi and miro.

We will do the rest of the work, as fast as possible. The Projekt description is only a temporery from me. The real One is currently in spellchecking.

Best regards Heiko

greenrover33’s picture

Thanks to patrik, klausi and miro.

We will do the rest of the work, as fast as possible. The Projekt description is only a temporery from me. The real One is currently in spellchecking.

Best regards Heiko

Status: Fixed » Closed (fixed)

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

Anonymous’s picture

Issue summary: View changes

add review

avpaderno’s picture

Title: Archibald2 » [D7] Archibald2
Issue summary: View changes