4 use warnings FATAL => 'all';
7 our $VERSION = '1.004000';
10 sub _choose_json_module {
11 return 'Cpanel::JSON::XS' if $INC{'Cpanel/JSON/XS.pm'};
12 return 'JSON::XS' if $INC{'JSON/XS.pm'};
16 return 'Cpanel::JSON::XS' if eval { require Cpanel::JSON::XS; 1; };
17 push @err, "Error loading Cpanel::JSON::XS: $@";
19 return 'JSON::XS' if eval { require JSON::XS; JSON::XS->VERSION(3.0); 1; };
20 push @err, "Error loading JSON::XS: $@";
22 return 'JSON::PP' if eval { require JSON::PP; 1 };
23 push @err, "Error loading JSON::PP: $@";
25 die join( "\n", "Couldn't load a JSON module:", @err );
30 our $JSON_Class = _choose_json_module();
31 $JSON_Class->import(qw(encode_json decode_json));
33 *$_ = $JSON_Class->can($_)
37 our @EXPORT = qw(encode_json decode_json JSON);
38 my @EXPORT_ALL = qw(is_bool);
39 our @EXPORT_OK = qw(is_bool to_json from_json);
40 our %EXPORT_TAGS = ( all => [ @EXPORT, @EXPORT_ALL ],
41 legacy => [ @EXPORT, @EXPORT_OK ],
44 sub JSON () { our $JSON_Class }
48 my %args = @_ == 1 ? %{$_[0]} : @_;
49 my $new = (our $JSON_Class)->new;
50 $new->$_($args{$_}) for keys %args;
57 die 'is_bool is not a method' if $_[1];
59 Scalar::Util::blessed($_[0])
60 and ($_[0]->isa('JSON::XS::Boolean')
61 or $_[0]->isa('Cpanel::JSON::XS::Boolean')
62 or $_[0]->isa('JSON::PP::Boolean'));
65 # (mostly) CopyPasta from JSON.pm version 2.90
69 if ( ref($_[0]) =~ /^JSON/ or $_[0] =~ /^JSON/ ) {
70 Carp::croak "from_json should not be called as a method.";
72 my $json = JSON()->new;
74 if (@_ == 2 and ref $_[1] eq 'HASH') {
76 for my $method (keys %$opt) {
77 $json->$method( $opt->{$method} );
81 return $json->decode( $_[0] );
87 or (@_ > 2 and $_[0] =~ /^JSON/)
89 Carp::croak "to_json should not be called as a method.";
91 my $json = JSON()->new;
93 if (@_ == 2 and ref $_[1] eq 'HASH') {
95 for my $method (keys %$opt) {
96 $json->$method( $opt->{$method} );
100 $json->encode($_[0]);
107 JSON::MaybeXS - Use L<Cpanel::JSON::XS> with a fallback to L<JSON::XS> and L<JSON::PP>
113 my $data_structure = decode_json($json_input);
115 my $json_output = encode_json($data_structure);
117 my $json = JSON()->new;
119 my $json_with_args = JSON::MaybeXS->new(utf8 => 1); # or { utf8 => 1 }
123 This module first checks to see if either L<Cpanel::JSON::XS> or
124 L<JSON::XS> is already loaded, in which case it uses that module. Otherwise
125 it tries to load L<Cpanel::JSON::XS>, then L<JSON::XS>, then L<JSON::PP>
126 in order, and either uses the first module it finds or throws an error.
128 It then exports the C<encode_json> and C<decode_json> functions from the
129 loaded module, along with a C<JSON> constant that returns the class name
130 for calling C<new> on.
132 If you're writing fresh code rather than replacing L<JSON.pm|JSON> usage, you might
133 want to pass options as constructor args rather than calling mutators, so
134 we provide our own C<new> method that supports that.
138 C<encode_json>, C<decode_json> and C<JSON> are exported by default; C<is_bool>
139 is exported on request.
141 To import only some symbols, specify them on the C<use> line:
143 use JSON::MaybeXS qw(encode_json decode_json is_bool); # functions only
145 use JSON::MaybeXS qw(JSON); # JSON constant only
147 To import all available sensible symbols (C<encode_json>, C<decode_json>, and
148 C<is_bool>), use C<:all>:
150 use JSON::MaybeXS ':all';
152 To import all symbols including those needed by legacy apps that use L<JSON::PP>:
154 use JSON::MaybeXS ':legacy';
156 This imports the C<to_json> and C<from_json> symbols as well as everything in
157 C<:all>. NOTE: This is to support legacy code that makes extensive
158 use of C<to_json> and C<from_json> which you are not yet in a position to
159 refactor. DO NOT use this import tag in new code, in order to avoid
160 the crawling horrors of getting UTF-8 support subtly wrong. See the
161 documentation for L<JSON> for further details.
165 This is the C<encode_json> function provided by the selected implementation
166 module, and takes a perl data structure which is serialised to JSON text.
168 my $json_text = encode_json($data_structure);
172 This is the C<decode_json> function provided by the selected implementation
173 module, and takes a string of JSON text to deserialise to a perl data structure.
175 my $data_structure = decode_json($json_text);
177 =head2 to_json, from_json
179 See L<JSON> for details. These are included to support legacy code
184 The C<JSON> constant returns the selected implementation module's name for
185 use as a class name - so:
187 my $json_obj = JSON()->new; # returns a Cpanel::JSON::XS or JSON::PP object
189 and that object can then be used normally:
191 my $data_structure = $json_obj->decode($json_text); # etc.
193 The use of parentheses here is optional, and only used as a hint to the reader
194 that this use of C<JSON> is a I<subroutine> call, I<not> a class name.
198 $is_boolean = is_bool($scalar)
200 Returns true if the passed scalar represents either C<true> or
201 C<false>, two constants that act like C<1> and C<0>, respectively
202 and are used to represent JSON C<true> and C<false> values in Perl.
204 Since this is a bare sub in the various backend classes, it cannot be called as
205 a class method like the other interfaces; it must be called as a function, with
206 no invocant. It supports the representation used in all JSON backends.
208 Available since version 1.002004.
214 With L<JSON::PP>, L<JSON::XS> and L<Cpanel::JSON::XS> you are required to call
215 mutators to set options, such as:
217 my $json = $class->new->utf8(1)->pretty(1);
219 Since this is a trifle irritating and noticeably un-perlish, we also offer:
221 my $json = JSON::MaybeXS->new(utf8 => 1, pretty => 1);
223 which works equivalently to the above (and in the usual tradition will accept
224 a hashref instead of a hash, should you so desire).
226 The resulting object is blessed into the underlying backend, which offers (at
227 least) the methods C<encode> and C<decode>.
231 To include JSON-aware booleans (C<true>, C<false>) in your data, just do:
234 my $true = JSON()->true;
235 my $false = JSON()->false;
237 The booleans are also available as subs or methods on JSON::MaybeXS.
239 use JSON::MaybeXS ();
240 my $true = JSON::MaybeXS::true;
241 my $true = JSON::MaybeXS->true;
242 my $false = JSON::MaybeXS::false;
243 my $false = JSON::MaybeXS->false;
245 =head1 CONVERTING FROM JSON::Any
247 L<JSON::Any> used to be the favoured compatibility layer above the various
248 JSON backends, but over time has grown a lot of extra code to deal with legacy
249 backends (e.g. L<JSON::Syck>) that are no longer needed. This is a rough guide of translating such code:
254 my $json = JSON::Any->new->objToJson($data); # or to_json($data), or Dump($data)
259 my $json = encode_json($data);
265 my $data = JSON::Any->new->jsonToObj($json); # or from_json($json), or Load($json)
270 my $json = decode_json($data);
274 The C<new()> method in this module is technically a factory, not a
275 constructor, because the objects it returns will I<NOT> be blessed into the
276 C<JSON::MaybeXS> class.
278 If you are using an object returned by this module as a Moo(se) attribute,
279 this type constraint code:
281 is 'json' => ( isa => 'JSON::MaybeXS' );
283 will I<NOT> do what you expect. Instead, either rely on the C<JSON> class
284 constant described above, as so:
286 is 'json' => ( isa => JSON::MaybeXS::JSON() );
288 Alternatively, you can use duck typing:
290 use Moose::Util::TypeConstraints 'duck_type';
291 is 'json' => ( isa => Object , duck_type([qw/ encode decode /]));
295 At installation time, F<Makefile.PL> will attempt to determine if you have a
296 working compiler available, and therefore whether you are able to run XS code.
297 If so, L<Cpanel::JSON::XS> will be added to the prerequisite list, unless
298 L<JSON::XS> is already installed at a high enough version. L<JSON::XS> may
299 also be upgraded to fix any incompatibility issues.
301 Because running XS code is not mandatory and L<JSON::PP> (which is in perl
302 core) is used as a fallback backend, this module is safe to be used in a suite
303 of code that is fatpacked or installed into a restricted-resource environment.
305 You can also prevent any XS dependencies from being installed by setting
306 C<PUREPERL_ONLY=1> in F<Makefile.PL> options (or in the C<PERL_MM_OPT>
307 environment variable), or using the C<--pp> or C<--pureperl> flags with the
308 L<cpanminus client|cpanm>.
312 mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
318 =item * Clinton Gormley <drtech@cpan.org>
320 =item * Karen Etheridge <ether@cpan.org>
322 =item * Kieren Diment <diment@gmail.com>
328 Copyright (c) 2013 the C<JSON::MaybeXS> L</AUTHOR> and L</CONTRIBUTORS>
333 This library is free software and may be distributed under the same terms