App::DBCritic::Policy - Role for criticizing database schemas
version 0.020
package App::DBCritic::Policy::MyPolicy;
use Moo;
has description => ( default => sub{'Follow my policy'} );
has explanation => ( default => {'My way or the highway'} );
has applies_to => ( default => sub { ['ResultSource'] } );
with 'App::DBCritic::Policy';
sub violates { $_[0]->element ne '' }
This is a role consumed by all App::DBCritic policy plugins.
Read-only accessor for the current schema element being examined by App::DBCritic.
Read-only accessor for the current schema object being examined by App::DBCritic.
Given a string description of a violation that has been encountered, creates a new App::DBCritic::Violation object from the current policy.
Returns a short string describing what's wrong.
Returns a string giving further details.
Returns an array reference of types of DBIx::Class objects indicating what part(s) of the schema the policy is interested in.
Role consumers must implement a violates method that returns true if the policy is violated and false otherwise, based on attributes provided by the role. Callers should call the violates method as the following:
$policy->violates($element, $schema);
You can find documentation for this module with the perldoc command.
perldoc bin::dbcritic
The following websites have more information about this module, and may be of help to you. As always, in addition to those websites please use your favorite search engine to discover more resources.
The default CPAN search engine, useful to view POD in HTML format.
The AnnoCPAN is a website that allows community annonations of Perl module documentation.
The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.
The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.
The CPAN Testers is a network of smokers who run automated tests on uploaded CPAN distributions.
The CPAN Testers Matrix is a website that provides a visual way to determine what Perls/platforms PASSed for a distribution.
The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.
Please report any bugs or feature requests through the web interface at https://github.com/mjgardner/dbcritic/issues. You will be automatically notified of any progress on the request by the system.
The code is open to the world, and available for you to hack on. Please feel free to browse it and play with it, or whatever. If you want to contribute patches, please send me a diff or prod me to pull from your repository :)
https://github.com/mjgardner/dbcritic
git clone git://github.com/mjgardner/dbcritic.git
Mark Gardner <mjgardner@cpan.org>
This software is copyright (c) 2011 by Mark Gardner.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
