Preparing for Tripal Gold Metal Status

[laceysanderson]

Documentation

Description

This issue is in preparation for request for a gold Tripal extension module badge.

Repository: https://github.com/tripal/private_biodata
Documentation: https://github.com/tripal/private_biodata/blob/master/README.md

Make individual pages private while others of the same Tripal Content Type remain public! This module provides an additional permission, [Content type]: View Private Content for each Tripal Content Type and a TripalField to indicate which exact pages should be private.

Bronze

Requirement	Status
Has a public release.	Yes
Should install on a Tripal site appropriate for the versions it supports.	Yes as shown by TravisCI
Defines any custom tables or materialized views in the install file (if applicable).	No Custom Chado tables. Uses the Drupal Schema API for data storage.
Adds any needed controlled vocabulary terms in the install file (Tripal3).	Yes
Provides Installation and admin instructions README.md (or RTD).	Yes, in Readme
Has a license (distributed with module).	Yes

Silver

Requirement	Status
Follows basic Drupal Coding standards; specifically, code format and API documentation.	Yes
Uses Tripal API functions. Specifically, it should use the Chado Query API for querying chado (if using chado as the storage system).	Yes, using TripalFields API
Tripal Jobs API for long running processes.	No long running processes.
TripalField class to add data to pages (Tripal3).	Yes
Provides ways to customize the module (e.g. drush options, field/formatter settings, admin UI).	Field widget and formatter settings.
Latest releases should follow Drupal naming best practices. e.g. first release for Drupal 7 should be: 7.x-1.x.	Yes, 7.x-3.2

Gold

Requirement	Status
Extensive documentation for the module (similar to Tripal User’s Guide).	Not needed for such a simple module. Usage documentation in readme.
Unit testing is implemented using PHPUnit with the TripalTestSuite or something similar.	Yes
Continuous integration is setup (e.g. such as with TravisCI).	Yes
Imports data via Tripal’s importer class (Tripal3).	Doesn't import data.
Tripal 3 fields are Fully compatible with web services.	Yes: this field restricts access to the page through WS and through the UI.
The elementInfo function is fully implemented.	Yes but this field doesn't support filtering
The query and queryOrder functions fully implemented.	No as this field doesn't support filtering.
Web Services uses Tripal’s Web Service Classes (Tripal3).	n/a
Code sniffing and testing coverage reports (optional but encouraged).	Test coverage through codeclimate
Drupal.org vetted release (optional but encouraged).	No

[laceysanderson]

Submitted