package Class::Usul;
use 5.010001;
use namespace::autoclean;
use version; our $VERSION = qv( sprintf '0.75.%d', q$Rev: 1 $ =~ /\d+/gmx );
use Class::Usul::Constants qw( FALSE TRUE );
use Class::Usul::Functions qw( data_dumper ns_environment );
use Class::Usul::Types qw( Bool ConfigProvider HashRef
Localiser LoadableClass Locker Logger );
use Moo;
# Attribute constructors
my $_build_debug = sub {
return !!ns_environment( $_[ 0 ]->config->appclass, 'debug' ) ? TRUE : FALSE;
};
# Public attributes
has 'config' => is => 'lazy', isa => ConfigProvider,
builder => sub { $_[ 0 ]->config_class->new( $_[ 0 ]->_config_attr)},
init_arg => undef;
has '_config_attr' => is => 'ro', isa => HashRef, builder => sub { {} },
init_arg => 'config';
has 'config_class' => is => 'ro', isa => LoadableClass, coerce => TRUE,
default => 'Class::Usul::Config';
has 'debug' => is => 'lazy', isa => Bool, builder => $_build_debug;
has 'l10n' => is => 'lazy', isa => Localiser,
builder => sub { $_[ 0 ]->l10n_class->new( builder => $_[ 0 ] ) },
handles => [ 'loc', 'localize' ];
has 'l10n_class' => is => 'lazy', isa => LoadableClass, coerce => TRUE,
default => 'Class::Usul::L10N';
has 'lock' => is => 'lazy', isa => Locker,
builder => sub { $_[ 0 ]->lock_class->new( builder => $_[ 0 ] ) };
has 'lock_class' => is => 'lazy', isa => LoadableClass, coerce => TRUE,
default => 'IPC::SRLock';
has 'log' => is => 'lazy', isa => Logger,
builder => sub { $_[ 0 ]->log_class->new( builder => $_[ 0 ] ) };
has 'log_class' => is => 'lazy', isa => LoadableClass, coerce => TRUE,
default => 'Class::Usul::Log';
# Public methods
sub dumper { # Damm handy for development
my $self = shift; return data_dumper( @_ );
}
1;
__END__
=pod
=encoding utf-8
=begin html
<a href="https://travis-ci.org/pjfl/p5-class-usul"><img src="https://travis-ci.org/pjfl/p5-class-usul.svg?branch=master" alt="Travis CI Badge"></a>
<a href="http://badge.fury.io/pl/Class-Usul"><img src="https://badge.fury.io/pl/Class-Usul.svg" alt="CPAN Badge"></a>
<a href="http://cpants.cpanauthors.org/dist/Class-Usul"><img src="http://cpants.cpanauthors.org/dist/Class-Usul.png" alt="Kwalitee Badge"></a>
=end html
=head1 Name
Class::Usul - A base class providing config, locking, logging, and l10n
=head1 Version
Describes Class::Usul version v0.75.$Rev: 1 $
=head1 Synopsis
use Class::Usul;
use Class::Usul::Constants qw( FALSE );
use Class::Usul::Functions qw( find_apphome get_cfgfiles );
my $attr = { config => {} }; my $conf = $attr->{config};
$conf->{appclass } or die "Application class not specified";
$attr->{config_class} //= $conf->{appclass}.'::Config';
$conf->{home } = find_apphome $conf->{appclass};
$conf->{cfgfiles } = get_cfgfiles $conf->{appclass}, $conf->{home};
return Class::Usul->new( $attr );
=head1 Description
These modules provide a set of base classes for Perl modules and
applications. It provides configuration file loading
L<Class::Usul::Config>, locking to single thread processes
L<IPC::SRLock>, logging L<Class::Usul::Log> and localisation
L<Class::Usul::L10N>
The class L<Class::Usul::Programs> is a base class for command line interfaces
Interprocess communication is handled by L<Class::Usul::IPC>
L<Class::Usul::File> makes the functionality of L<File::DataClass> available
=head1 Configuration and Environment
Defines the following attributes;
=over 3
=item C<config>
The C<config> attribute should be a hash reference that may define key / value
pairs that provide filesystem paths for the temporary directory etc.
=item C<config_class>
Defaults to L<Class::Usul::Config> and is of type C<LoadableClass>. An
instance of this class is loaded and instantiated using the hash reference
in the C<config> attribute. It provides accessor methods with symbol
inflation and smart defaults. Add configuration attributes by
subclassing this class
=item C<debug>
A boolean which defaults to false. Usually an instance of this class is passed
into the constructors of other classes which set their own debug state to this
value
=item C<l10n>
A lazily evaluated instance of the C<l10n_class>. This object reference is a
L<Localiser|Class::Usul::Types/Localiser> which handles the C<localize> method
=item C<l10n_class>
A lazy loadable class which defaults to L<Class::Usul::L10N>
=item C<lock>
A lazily evaluated instance of the C<lock_class>. This object reference is a
L<Locker|Class::Usul::Types/Locker>
=item C<lock_class>
A lazy loadable class which defaults to L<IPC::SRLock>
=item C<log>
A lazily evaluated instance of the C<log_class>. This object reference is a
L<Logger|Class::Usul::Types/Logger>
=item C<log_class>
A lazy loadable class which defaults to L<Class::Usul::Log>
=back
=head1 Subroutines/Methods
=head2 C<dumper>
$self->dumper( $some_var );
Use L<Data::Printer> to dump arguments for development purposes
=head1 Diagnostics
Setting the I<debug> attribute to true causes messages to be logged at the
debug level
=head1 Dependencies
=over 3
=item L<Class::Usul::Config>
=item L<Class::Usul::Constants>
=item L<Class::Usul::Functions>
=item L<Class::Usul::L10N>
=item L<Class::Usul::Log>
=item L<Class::Usul::Types>
=item L<IPC::SRLock>
=item L<Moo>
=back
=head1 Incompatibilities
There are no known incompatibilities in this module
=head1 Bugs and Limitations
There are no known bugs in this module. Please report problems to
http://rt.cpan.org/NoAuth/Bugs.html?Dist=Class-Usul. Patches are
welcome
=head1 Author
Peter Flanigan, C<< <pjfl@cpan.org> >>
=head1 Acknowledgements
Larry Wall - For the Perl programming language
=head1 License and Copyright
Copyright (c) 2016 Peter Flanigan. All rights reserved
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself. See L<perlartistic>
This program is distributed in the hope that it will be useful,
but WITHOUT WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
=cut
# Local Variables:
# mode: perl
# tab-width: 3
# End: