NAME

App::DBCritic::Policy - Role for criticizing database schemas

VERSION

version 0.023

SYNOPSIS

    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 '' }

DESCRIPTION

This is a role consumed by all App::DBCritic policy plugins.

ATTRIBUTES

element

Read-only accessor for the current schema element being examined by App::DBCritic.

schema

Read-only accessor for the current schema object being examined by App::DBCritic.

METHODS

description

Required method. Returns a short string describing what's wrong.

explanation

Required method. Returns a string giving further details.

applies_to

Required method. Returns an array reference of types of DBIx::Class objects indicating what part(s) of the schema the policy is interested in.

violates

Required method. 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);

Arguments: $element, $schema

Return value: nothing if the policy passes, or a App::DBCritic::Violation object if it doesn't.

violation

Given a string description of a violation that has been encountered, creates a new App::DBCritic::Violation object from the current policy.

SUPPORT

Perldoc

You can find documentation for this module with the perldoc command.

  perldoc App::DBCritic::Policy

Websites

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.

• Search CPAN

  The default CPAN search engine, useful to view POD in HTML format.

  http://search.cpan.org/dist/App-DBCritic

• CPAN Ratings

  The CPAN Ratings is a website that allows community ratings and reviews of Perl modules.

  http://cpanratings.perl.org/d/App-DBCritic

• CPANTS

  The CPANTS is a website that analyzes the Kwalitee ( code metrics ) of a distribution.

  http://cpants.cpanauthors.org/dist/App-DBCritic

• CPAN Testers

  The CPAN Testers is a network of smoke testers who run automated tests on uploaded CPAN distributions.

  http://www.cpantesters.org/distro/A/App-DBCritic

• CPAN Testers Matrix

  The CPAN Testers Matrix is a website that provides a visual overview of the test results for a distribution on various Perls/platforms.

  http://matrix.cpantesters.org/?dist=App-DBCritic

• CPAN Testers Dependencies

  The CPAN Testers Dependencies is a website that shows a chart of the test results of all dependencies for a distribution.

  http://deps.cpantesters.org/?module=bin::dbcritic

Bugs / Feature Requests

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.

Source Code

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

AUTHOR

Mark Gardner <mjgardner@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2019 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.

cpanm App::DBCritic

perl -MCPAN -e shell
install App::DBCritic