Views GSA Feed

Drupal Core Version: 7
Sandbox Project link: http://drupal.org/sandbox/tmctighe/1935524
git repo: git clone --branch 7.x-1.x http://git.drupal.org/sandbox/tmctighe/1935524.git views_gsa_feed

Pareview Errors

As klausi pointed out, this modules has pareview errors. I know about these, however I cannot fix them. The module extends the Views module's views_plugin_display class which does not follow the drupal standards for lowerCamel format. If you notice other pareview errors at any point, or any other coding standards I am breaking, I am happy to fix them.

Overview:

This module is a plugin for the Views module that allows the user to make an XML feed for the Google Search Appliance (GSA) to be able to index. This module is solely for an external Google Search Appliance to index as it does not attempt to connect to the appliance itself.

Documentation

How to use Views GSA Feed

Reviews I've done

Entity List Field: http://drupal.org/node/1939962#comment-7169764
default user picture styles: http://drupal.org/node/1935836#comment-7170454
Vocabulary image: http://drupal.org/node/1637566#comment-7174772

Comments

klausi’s picture

Status: Needs review » Needs work

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

We are currently quite busy with all the project applications and I can only review projects with a review bonus. Please help me reviewing and put yourself on the PAReview: review bonus high priority list. Then I'll take a look at your project right away :-)

tmctighe’s picture

Status: Needs work » Needs review

klausi,

As for pareview, I cannot fix those errors. The only errors I get are improper use of lowerCamel format on function names. I cannot fix these function names because they are defined in the Views module and I am extending them. As the Views module is not following the drupal standards I cannot follow them.

I'm in the process of reviewing an application at the moment and hope to get more done soon (as I'm still learning how to best do this).

Thank you!

tmctighe’s picture

Issue summary: View changes

Adding the "Pareview Errors" section to my Issue details so that it won't get mentioned in every review...

tmctighe’s picture

Issue summary: View changes

simple error with HTML

jared_sprague’s picture

Nice module Travis!
Here is my manual review:

Project Page
- Looks good!

README.txt
- I would modify your README.txt to match the following sections of your project page: Overview, Features, Requirements, Installation, Documentation, Known Problems.

Documentation
- I would put a link back to your project page from your documentation page.

Misc.
- your files have group write permissions, chmod 644 on all files

views_gsa_feed.info
- remove line 14-15 remove core= "7.x":

views_gsa_feed.install
- consider merging line 25 into single if: if (is_numeric($max_allowed_packet) && $max_allowed_packet < ( )) {
- extract 16 * 1024 * 1024 into a define statements for reputability and configurability

  define('VIEWS_GSA_FEED_MB', 1024 * 1024);
  define('VIEWS_GSA_FEED_MB_MIN_PACKET_MB', 16)
  ...
   .. max_allowed_packet < (VIEWS_GSA_FEED_MB * VIEWS_GSA_FEED_MB_MIN_PACKET_MB)  ..
  ...

- That way you can easily change up or down the minimum packet size without thinking about it

views_gsa_feed.module
- remove white space on line 12 - just a style thing

Testing
- Install instructions says "Save & continue" Should be "Continue & Edit".
- Step 1 of configuring, what is a datasource be? What are it's legal values?
- In configure steps merge step 3 - 4.
- module performs without errors and functions as documented!

The code clean and well written, nice module!

jared_sprague’s picture

Issue summary: View changes

adding in my first review

tmctighe’s picture

Jared,

I have implemented every comment you made.

Thanks for the review!

tmctighe’s picture

Issue summary: View changes

putting in the second link to reviews I have done

tmctighe’s picture

Issue tags: +PAreview: review bonus

Completed my third review!

klausi’s picture

Assigned: Unassigned » patrickd
Status: Needs review » Reviewed & tested by the community
Issue tags: -PAreview: review bonus

manual review:

  1. "module_load_include('inc', 'views_gsa_feed', 'theme/views_gsa_feed.theme');": Also, no need to use module_load_include as you are including files from your own module which you already know where they are. Use something like require_once 'mymodule.inc';
  2. views_gsa_feed_views_api(): Views version 2 does not exist on Drupal 7.
  3. views_gsa_feed_query_alter(): why is that function needed? Please add a comment.
  4. "htmlspecialchars($view->style_plugin->rendered_fields[$num][$id]);": use check_plain() instead.
  5. "public function get_style_type() {return 'gsa_feed';}": function body should be on a line by itself.
  6. I think you should add a dependency to views_data_export so that you don't have to copy so much code. Overriding a custom XML feed template should be fairly easy.

But that are not application blockers, so I guess this is RTBC. Removing review bonus tag, you can add it again if you have done another 3 reviews of other projects.

Assigning to patrickd as he might have time to take a final look at this.

tmctighe’s picture

klausi,

I have fixed 1-5 from your review.

Commenting on 3 - views_gsa_feed_query_alter is needed because views would not automatically pull the nid back with the query being run - it only pulls back the fields included in the feed. If the user decided they did not want a field in the feed that specified the nid, then the feed would have no way of creating the url to the node. There might be a better way of doing this - this is a bug I only discovered Wednesday.

6 - Valid point. I'll start moving functionality to that, although I do find it nice to not have it be a dependency.

Thanks for the review!

klausi’s picture

Status: Reviewed & tested by the community » Fixed

No objections for more than a week, so ...

Thanks for your contribution, tmctighe!

I updated your account to let you 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 get 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.

Status: Fixed » Closed (fixed)

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

Anonymous’s picture

Issue summary: View changes

Adding in my third review