lib/Config/Any/General.pm

   1 package Config::Any::General;
   2
   3 use strict;
   4 use warnings;
   5
   6 use base 'Config::Any::Base';
   7
   8 =head1 NAME
   9
  10 Config::Any::General - Load Config::General files
  11
  12 =head1 DESCRIPTION
  13
  14 Loads Config::General files. Example:
  15
  16     name = TestApp
  17     <Component Controller::Foo>
  18         foo bar
  19         bar [ arrayref-value ]
  20     </Component>
  21     <Model Baz>
  22         qux xyzzy
  23     </Model>
  24
  25 =head1 METHODS
  26
  27 =head2 extensions( )
  28
  29 return an array of valid extensions (C<cnf>, C<conf>).
  30
  31 =cut
  32
  33 sub extensions {
  34     return qw( cnf conf );
  35 }
  36
  37 =head2 load( $file )
  38
  39 Attempts to load C<$file> via Config::General.
  40
  41 =cut
  42
  43 sub load {
  44     my $class = shift;
  45     my $file  = shift;
  46     my $args  = shift || {};
  47
  48     # work around bug (?) in Config::General
  49     #   return if $class->_test_perl($file);
  50
  51     $args->{ -ConfigFile } = $file;
  52
  53     $args->{ -ForceArray } = 1 unless exists $args->{ -ForceArray };
  54
  55     require Config::General;
  56     my $configfile = Config::General->new( %$args );
  57     my $config     = { $configfile->getall };
  58
  59     return $config;
  60 }
  61
  62 # this is a bit of a hack but necessary, because Config::General is *far* too lax
  63 # about what it will load -- specifically, it seems to be quite happy to load a Perl
  64 # config file (ie, a file which is valid Perl and creates a hashref) as if it were
  65 # an Apache-style configuration file, presumably due to laziness on the part of the
  66 # developer.
  67
  68 sub _test_perl {
  69     my ( $class, $file ) = @_;
  70     my $is_perl_src;
  71     eval { $is_perl_src = do "$file"; };
  72     delete $INC{ $file };    # so we don't screw stuff later on
  73     return defined $is_perl_src;
  74 }
  75
  76 =head2 requires_all_of( )
  77
  78 Specifies that this module requires L<Config::General> in order to work.
  79
  80 =cut
  81
  82 sub requires_all_of { 'Config::General' }
  83
  84 =head1 AUTHOR
  85
  86 Brian Cassidy E<lt>bricas@cpan.orgE<gt>
  87
  88 =head1 CONTRIBUTORS
  89
  90 Joel Bernstein C<< <rataxis@cpan.org> >>
  91
  92 =head1 COPYRIGHT AND LICENSE
  93
  94 Copyright 2006-2010 by Brian Cassidy
  95
  96 Portions Copyright 2006 Portugal Telecom
  97
  98 This library is free software; you can redistribute it and/or modify
  99 it under the same terms as Perl itself.
 100
 101 =head1 SEE ALSO
 102
 103 =over 4
 104
 105 =item * L<Catalyst>
 106
 107 =item * L<Config::Any>
 108
 109 =item * L<Config::General>
 110
 111 =back
 112
 113 =cut
 114
 115 1;
 116