CatalystX::Usul::InflateSymbols - Return paths to installation directories

CatalystX-Usul documentation Contained in the CatalystX-Usul distribution.

Index

Code Index:

Name

Top

CatalystX::Usul::InflateSymbols - Return paths to installation directories

Version

Top

0.3.$Revision: 612 $

Synopsis

Top

   package MyApp;

   use Catalyst qw(InflateMore ConfigLoader ...);

   MyApp->config->{InflateMore} = 'MyApp::Config';

   package MyApp::Config;

   use base qw(CatalystX::Usul::InflateSymbols);

Description

Top

The intention here is to demonstrate how to use Catalyst::Plugin::InflateMore. It is unlikely that anyone will find this module useful unless your share my view on application layout. Instead write your own class that implements the methods for the configuration file symbols of your choice.

My applications are divided into three parts by the installer. Since the installer supports multiple layouts these methods will return paths to each of those components. These methods are called from Catalyst::Plugin::InflateMore.

Subroutines/Methods

Top

new

The constructor stores a copy of the application object

appldir

Return absolute path to the directory which defines the phase number

binsdir

Return absolute path to the directory containing the programs

libsdir

Return absolute path to the directory containing the modules

Diagnostics

Top

None

Configuration and Environment

Top

None

Dependencies

Top

CatalystX::Usul::Base

Incompatibilities

Top

There are no known incompatibilities in this module

Bugs and Limitations

Top

There are no known bugs in this module. Please report problems to the address below. Patches are welcome

Author

Top

Peter Flanigan, <Support at RoxSoft.co.uk>

License and Copyright

Top

Copyright (c) 2008 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 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

CatalystX-Usul documentation Contained in the CatalystX-Usul distribution. 
# @(#)$Id: InflateSymbols.pm 612 2009-06-29 13:39:56Z pjf $

package CatalystX::Usul::InflateSymbols;

use strict;
use warnings;
use version; our $VERSION = qv( sprintf '0.3.%d', q$Rev: 612 $ =~ /\d+/gmx );
use parent qw(CatalystX::Usul::Base);

use Config;
use Cwd qw(abs_path);
use File::Spec;

__PACKAGE__->mk_accessors( qw(_application) );

sub new {
   my ($self, $app) = @_;

   return bless { _application => $app }, ref $self || $self;
}

sub appldir {
   my $self = shift; my $conf = $self->_application->config; my $dir;

   if (!$conf->{appldir} || $conf->{appldir} =~ m{ __APPLDIR__ }mx) {
      $dir = $self->dirname( $Config{sitelibexp} );

      if ($conf->{home} =~ m{ \A $dir }mx) {
         $dir = $self->catdir( File::Spec->rootdir,
                               'var', $conf->{prefix}, 'default' );
      }
      else { $dir = $self->home2appl( $conf->{home} ) }

      $conf->{appldir} = abs_path( $dir );
   }

   return $conf->{appldir};
}

sub binsdir {
   my $self = shift; my $conf = $self->_application->config; my $dir;

   if (!$conf->{binsdir} || $conf->{binsdir} =~ m{ __BINSDIR__ }mx) {
      $dir = $self->dirname( $Config{sitelibexp} );

      if ($conf->{home} =~ m{ \A $dir }mx) { $dir = $Config{scriptdir} }
      else { $dir = $self->catdir( $self->home2appl( $conf->{home} ), 'bin' ) }

      $conf->{binsdir} = abs_path( $dir );
   }

   return $conf->{binsdir};
}

sub libsdir {
   my $self = shift; my $conf = $self->_application->config; my $dir;

   if (!$conf->{libsdir} || $conf->{libsdir} =~ m{ __LIBSDIR__ }mx) {
      $dir = $self->dirname( $Config{sitelibexp} );

      if ($conf->{home} =~ m{ \A $dir }mx) { $dir = $Config{sitelibexp} }
      else { $dir = $self->catdir( $self->home2appl( $conf->{home} ), 'lib' ) }

      $conf->{libsdir} = abs_path( $dir );
   }

   return $conf->{libsdir};
}

1;

__END__


# Local Variables:
# mode: perl
# tab-width: 3
# End: