logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

Perlanet::Role::Config - A role to be used in Perlanet traits that read config.

Author

       Dave Cross, <dave@perlhacks.com>

Description

       A role that is used to build Perlanet traits which read config information from various sources.

       This role does two things:

       •   It  exposes a method called "get_config()" which gets the raw config data (using your "read_config()"
           method).

       •   It forces your trait to define a method called "read_config()" which actually reads  the  config  and
           returns it as a hash reference.

   METHODSget_config

       Calls  your  "read_config()" method to actually get the config data (as a hash reference) and then munges
       that data in various ways to get a useful config hash.

       THIRTY_DAYS

       Constant to define the default cache expiration time in seconds.

Name

       Perlanet::Role::Config - A role to be used in Perlanet traits that read config.

Synopsis

          package Perlanet::Trait::MyConfig;

          use Moose::Role;

          with 'Perlanet::Role::Config';

         # Class method to return the config
         sub get_config_from_somewhere {
           my $class = shift;

           # get_config() is defined in this role
           return $class->get_config(@_)
         }

         # get_config() calls this to actually read the config.
         sub read_config {
           my $class = shift;
           my %params = @_;

           my $cfg = ...;

           return $cfg;
         }

See Also