add warning about using YAML loaders other than ::XS

[p5sagit/Config-Any.git] / lib / Config / Any / YAML.pm

diff --git a/lib/Config/Any/YAML.pm b/lib/Config/Any/YAML.pm
index 564fc52..9eaa5f7 100644 (file)
--- a/lib/Config/Any/YAML.pm
+++ b/lib/Config/Any/YAML.pm
@@ -1,88 +1,107 @@
-package Config::Any::YAML;\r
-\r
-use strict;\r
-use warnings;\r
-\r
-=head1 NAME\r
-\r
-Config::Any::YAML - Load YAML config files\r
-\r
-=head1 DESCRIPTION\r
-\r
-Loads YAML files. Example:\r
-\r
-    ---\r
-    name: TestApp\r
-    Controller::Foo:\r
-        foo: bar\r
-    Model::Baz:\r
-        qux: xyzzy\r
-    \r
-\r
-=head1 METHODS\r
-\r
-=head2 extensions( )\r
-\r
-return an array of valid extensions (C<yml>, C<yaml>).\r
-\r
-=cut\r
-\r
-sub extensions {\r
-    return qw( yml yaml );\r
-}\r
-\r
-=head2 load( $file )\r
-\r
-Attempts to load C<$file> as a YAML file.\r
-\r
-=cut\r
-\r
-sub load {\r
-    my $class = shift;\r
-    my $file  = shift;\r
-\r
-    eval { require YAML::Syck; };\r
-    if( $@ ) {\r
-        require YAML;\r
-        return YAML::LoadFile( $file );\r
-    }\r
-    else {\r
-        open( my $fh, $file ) or die $!;\r
-        my $content = do { local $/; <$fh> };\r
-        close $fh;\r
-        return YAML::Syck::Load( $content );\r
-    }\r
-}\r
-\r
-=head1 AUTHOR\r
-\r
-=over 4 \r
-\r
-=item * Brian Cassidy E<lt>bricas@cpan.orgE<gt>\r
-\r
-=back\r
-\r
-=head1 COPYRIGHT AND LICENSE\r
-\r
-Copyright 2006 by Brian Cassidy\r
-\r
-This library is free software; you can redistribute it and/or modify\r
-it under the same terms as Perl itself. \r
-\r
-=head1 SEE ALSO\r
-\r
-=over 4 \r
-\r
-=item * L<Catalyst>\r
-\r
-=item * L<Config::Any>\r
-\r
-=item * L<YAML>\r
-\r
-=item * L<YAML::Syck>\r
-\r
-=back\r
-\r
-=cut\r
-\r
-1;
\ No newline at end of file
+package Config::Any::YAML;
+
+use strict;
+use warnings;
+
+use base 'Config::Any::Base';
+
+use Carp ();
+
+=head1 NAME
+
+Config::Any::YAML - Load YAML config files
+
+=head1 DESCRIPTION
+
+Loads YAML files. Example:
+
+    ---
+    name: TestApp
+    Controller::Foo:
+        foo: bar
+    Model::Baz:
+        qux: xyzzy
+    
+
+=head1 METHODS
+
+=head2 extensions( )
+
+return an array of valid extensions (C<yml>, C<yaml>).
+
+=cut
+
+sub extensions {
+    return qw( yml yaml );
+}
+
+=head2 load( $file )
+
+Attempts to load C<$file> as a YAML file.
+
+=cut
+
+sub load {
+    my $class = shift;
+    my $file  = shift;
+
+    eval { require YAML::XS };
+    unless ( $@ ) {
+        return YAML::XS::LoadFile( $file );
+    }
+
+    Carp::carp
+"Using YAML::Syck or YAML to parse configs is DEPRECATED. Please install ".
+"YAML::XS for proper YAML support";
+
+    eval { require YAML::Syck; YAML::Syck->VERSION( '0.70' ) };
+    unless ( $@ ) {
+        open( my $fh, $file ) or die $!;
+        my $content = do { local $/; <$fh> };
+        close $fh;
+        return YAML::Syck::Load( $content );
+    }
+
+    require YAML;
+    return YAML::LoadFile( $file );
+}
+
+=head2 requires_any_of( )
+
+Specifies that this modules requires one of L<YAML::XS>, L<YAML::Syck> (0.70) or
+L<YAML> in order to work.
+
+=cut
+
+sub requires_any_of { 'YAML::XS', [ 'YAML::Syck', '0.70' ], 'YAML' }
+
+=head1 AUTHOR
+
+Brian Cassidy E<lt>bricas@cpan.orgE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright 2006-2009 by Brian Cassidy
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself. 
+
+=head1 SEE ALSO
+
+=over 4 
+
+=item * L<Catalyst>
+
+=item * L<Config::Any>
+
+=item * L<YAML::XS>
+
+=item * L<YAML>
+
+=item * L<YAML::Syck>
+
+=back
+
+=cut
+
+1;