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