lib/Config/Any/YAML.pm

   1 package Config::Any::YAML;
   2
   3 use strict;
   4 use warnings;
   5
   6 use base 'Config::Any::Base';
   7
   8 =head1 NAME
   9
  10 Config::Any::YAML - Load YAML config files
  11
  12 =head1 DESCRIPTION
  13
  14 Loads YAML files. Example:
  15
  16     ---
  17     name: TestApp
  18     Controller::Foo:
  19         foo: bar
  20     Model::Baz:
  21         qux: xyzzy
  22
  23
  24 =head1 METHODS
  25
  26 =head2 extensions( )
  27
  28 return an array of valid extensions (C<yml>, C<yaml>).
  29
  30 =cut
  31
  32 sub extensions {
  33     return qw( yml yaml );
  34 }
  35
  36 =head2 load( $file )
  37
  38 Attempts to load C<$file> as a YAML file.
  39
  40 =cut
  41
  42 sub load {
  43     my $class = shift;
  44     my $file  = shift;
  45
  46     eval { require YAML::Syck; YAML::Syck->VERSION( '0.70' ) };
  47     unless ( $@ ) {
  48         open( my $fh, $file ) or die $!;
  49         my $content = do { local $/; <$fh> };
  50         close $fh;
  51         return YAML::Syck::Load( $content );
  52     }
  53
  54     require YAML;
  55     return YAML::LoadFile( $file );
  56 }
  57
  58 =head2 requires_any_of( )
  59
  60 Specifies that this modules requires one of L<YAML::Syck> (0.70) or L<YAML> in
  61 order to work.
  62
  63 =cut
  64
  65 sub requires_any_of { [ 'YAML::Syck', '0.70' ], 'YAML' }
  66
  67 =head1 AUTHOR
  68
  69 Brian Cassidy E<lt>bricas@cpan.orgE<gt>
  70
  71 =head1 COPYRIGHT AND LICENSE
  72
  73 Copyright 2007 by Brian Cassidy
  74
  75 This library is free software; you can redistribute it and/or modify
  76 it under the same terms as Perl itself.
  77
  78 =head1 SEE ALSO
  79
  80 =over 4
  81
  82 =item * L<Catalyst>
  83
  84 =item * L<Config::Any>
  85
  86 =item * L<YAML>
  87
  88 =item * L<YAML::Syck>
  89
  90 =back
  91
  92 =cut
  93
  94 1;