@@ -1,5 +1,29 @@
Revision history for JSON-MaybeXS
+1.003002 - 2014-11-16
+ - correctly fix boolean interoperability with older Cpanel::JSON::MaybeXS
+
+1.003001 - 2014-11-13
+ - fix boolean interoperability with older Cpanel::JSON::MaybeXS
+
+1.003_000 - 2014-10-30
+ - add :legacy tag to support legacy apps
+
+1.002006 - 2014-10-22
+ - add some additional test diagnostics, to help find bad version combinations
+ of JSON backends
+
+1.002005 - 2014-10-12
+ - fix "can I haz XS?" logic precedence in Makefile.PL
+ - added the ':all' export tag
+ - removed dependency on Safe::Isa
+ - repository moved to git://git.shadowcat.co.uk/p5sagit/JSON-MaybeXS.git
+
+1.002004 - 2014-10-11
+ - support use of PUREPERL_ONLY in Makefile.PL to avoid adding an XS
+ dependency
+ - new is_bool() interface
+
1.002003 - 2014-10-07
- document how to use booleans
@@ -4,11 +4,17 @@ maint/Makefile.PL.include
Makefile.PL
MANIFEST This list of files
t/cpanel.t
+t/legacy.t
+t/lib/is_bool.pm
t/none.t
t/pp.t
t/preload_cpanel.t
t/preload_xs.t
t/xs.t
+xt/json_pm.t
+xt/json_pm_legacy.t
+xt/json_pp_legacy.t
+xt/json_xs_legacy.t
META.yml Module YAML meta-data (added by MakeMaker)
META.json Module JSON meta-data (added by MakeMaker)
README README file (added by Distar)
@@ -4,7 +4,7 @@
"mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>"
],
"dynamic_config" : 1,
- "generated_by" : "ExtUtils::MakeMaker version 6.98, CPAN::Meta::Converter version 2.142690",
+ "generated_by" : "ExtUtils::MakeMaker version 7.02, CPAN::Meta::Converter version 2.142690",
"license" : [
"perl_5"
],
@@ -33,7 +33,9 @@
"Cpanel::JSON::XS" : "2.3310"
},
"requires" : {
+ "Carp" : "0",
"JSON::PP" : "2.27202",
+ "Scalar::Util" : "0",
"perl" : "5.006"
}
},
@@ -52,9 +54,9 @@
},
"repository" : {
"type" : "git",
- "url" : "https://github.com/karenetheridge/JSON-MaybeXS.git",
- "web" : "https://github.com/karenetheridge/JSON-MaybeXS"
+ "url" : "git://git.shadowcat.co.uk/p5sagit/JSON-MaybeXS.git",
+ "web" : "http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/JSON-MaybeXS.git"
}
},
- "version" : "1.002003"
+ "version" : "1.003002"
}
@@ -11,7 +11,7 @@ configure_requires:
File::Spec: '0'
File::Temp: '0'
dynamic_config: 1
-generated_by: 'ExtUtils::MakeMaker version 6.98, CPAN::Meta::Converter version 2.142690'
+generated_by: 'ExtUtils::MakeMaker version 7.02, CPAN::Meta::Converter version 2.142690'
license: perl
meta-spec:
url: http://module-build.sourceforge.net/META-spec-v1.4.html
@@ -24,9 +24,11 @@ no_index:
recommends:
Cpanel::JSON::XS: '2.3310'
requires:
+ Carp: '0'
JSON::PP: '2.27202'
+ Scalar::Util: '0'
perl: '5.006'
resources:
bugtracker: https://rt.cpan.org/Public/Dist/Display.html?Name=JSON-MaybeXS
- repository: https://github.com/karenetheridge/JSON-MaybeXS.git
-version: '1.002003'
+ repository: git://git.shadowcat.co.uk/p5sagit/JSON-MaybeXS.git
+version: '1.003002'
@@ -11,9 +11,10 @@ my %WriteMakefileArgs = (
'meta-spec' => { version => 2 },
dynamic_config => 1,
resources => {
+ # r/w: p5sagit@git.shadowcat.co.uk:JSON-MaybeXS.git
repository => {
- url => 'https://github.com/karenetheridge/JSON-MaybeXS.git',
- web => 'https://github.com/karenetheridge/JSON-MaybeXS',
+ url => 'git://git.shadowcat.co.uk/p5sagit/JSON-MaybeXS.git',
+ web => 'http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=p5sagit/JSON-MaybeXS.git',
type => 'git',
},
bugtracker => {
@@ -35,6 +36,8 @@ my %WriteMakefileArgs = (
},
runtime => {
requires => {
+ 'Scalar::Util' => '0',
+ 'Carp' => '0',
'JSON::PP' => '2.27202',
# we may also add a runtime prereq for Cpanel::JSON::XS, on the
# installer's machine
@@ -70,7 +73,9 @@ for (qw(configure build test runtime)) {
# we require Cpanel::JSON::XS, except if JSON::XS is already installed.
# (we also always recommend Cpanel::JSON::XS, just to make sure.)
$WriteMakefileArgs{PREREQ_PM}{'Cpanel::JSON::XS'} = '2.3310'
- if can_xs() && !eval { require JSON::XS; 1; };
+ if not parse_args()->{PUREPERL_ONLY}
+ and not eval { require JSON::XS; 1; }
+ and can_xs();
$WriteMakefileArgs{MIN_PERL_VERSION} = delete $WriteMakefileArgs{PREREQ_PM}{perl} || 0;
@@ -101,6 +106,19 @@ delete $WriteMakefileArgs{LICENSE}
WriteMakefile(%WriteMakefileArgs);
+
+sub parse_args {
+ # copied from EUMM
+ require ExtUtils::MakeMaker;
+ require Text::ParseWords;
+ ExtUtils::MakeMaker::parse_args(
+ my $tmp = {},
+ Text::ParseWords::shellwords($ENV{PERL_MM_OPT} || ''),
+ @ARGV,
+ );
+ return $tmp->{ARGS} || {};
+}
+
# can we locate a (the) C compiler
sub can_cc {
my @chunks = split(/ /, $Config::Config{cc}) or return;
@@ -28,14 +28,32 @@ DESCRIPTION
mutators, so we provide our own "new" method that supports that.
EXPORTS
- All of "encode_json", "decode_json" and "JSON" are exported by default.
+ "encode_json", "decode_json" and "JSON" are exported by default;
+ "is_bool" is exported on request.
To import only some symbols, specify them on the "use" line:
- use JSON::MaybeXS qw(encode_json decode_json); # functions only
+ use JSON::MaybeXS qw(encode_json decode_json is_bool); # functions only
use JSON::MaybeXS qw(JSON); # JSON constant only
+ To import all available sensible symbols ("encode_json", "decode_json",
+ and "is_bool"), use ":all":
+
+ use JSON::MaybeXS ':all';
+
+ To import all symbols including those needed by legacy apps that use
+ JSON::PP:
+
+ use JSON::MaybeXS ':legacy';
+
+ This imports the "to_json" and "from_json" symbols as well as everything
+ in ":all". NOTE: This is to support legacy code that makes extensive use
+ of "to_json" and "from_json" which you are not yet in a position to
+ refactor. DO NOT use this import tag in new code, in order to avoid the
+ crawling horrors of getting UTF8 support subtly wrong. See the
+ documentation for JSON for further details.
+
encode_json
This is the "encode_json" function provided by the selected
implementation module, and takes a perl data structure which is
@@ -50,6 +68,9 @@ EXPORTS
my $data_structure = decode_json($json_text);
+ to_json, from_json
+ See JSON for details. These are included to support legacy code only.
+
JSON
The "JSON" constant returns the selected implementation module's name
for use as a class name - so:
@@ -60,6 +81,18 @@ EXPORTS
my $data_structure = $json_obj->decode($json_text); # etc.
+ is_bool
+ $is_boolean = is_bool($scalar)
+
+ Returns true if the passed scalar represents either "true" or "false",
+ two constants that act like 1 and 0, respectively and are used to
+ represent JSON "true" and "false" values in Perl.
+
+ Since this is a bare sub in the various backend classes, it cannot be
+ called as a class method like the other interfaces; it must be called as
+ a function, with no invocant. It supports the representation used in all
+ JSON backends.
+
CONSTRUCTOR
new
With JSON::PP, JSON::XS and Cpanel::JSON::XS you are required to call
@@ -90,6 +123,8 @@ CONTRIBUTORS
* Karen Etheridge <ether@cpan.org>
+ * Kieren Diment <diment@gmail.com>
+
COPYRIGHT
Copyright (c) 2013 the "JSON::MaybeXS" "AUTHOR" and "CONTRIBUTORS" as
listed above.
@@ -4,7 +4,8 @@ use strict;
use warnings FATAL => 'all';
use base qw(Exporter);
-our $VERSION = '1.002003';
+our $VERSION = '1.003002';
+$VERSION = eval $VERSION;
sub _choose_json_module {
return 'Cpanel::JSON::XS' if $INC{'Cpanel/JSON/XS.pm'};
@@ -31,6 +32,11 @@ BEGIN {
}
our @EXPORT = qw(encode_json decode_json JSON);
+my @EXPORT_ALL = qw(is_bool);
+our @EXPORT_OK = qw(is_bool to_json from_json);
+our %EXPORT_TAGS = ( all => [ @EXPORT, @EXPORT_ALL ],
+ legacy => [ @EXPORT, @EXPORT_OK ],
+ );
sub JSON () { our $JSON_Class }
@@ -42,6 +48,55 @@ sub new {
return $new;
}
+use Scalar::Util ();
+
+sub is_bool {
+ die 'is_bool is not a method' if $_[1];
+
+ Scalar::Util::blessed($_[0])
+ and ($_[0]->isa('JSON::XS::Boolean')
+ or $_[0]->isa('Cpanel::JSON::XS::Boolean')
+ or $_[0]->isa('JSON::PP::Boolean'));
+}
+
+# (mostly) CopyPasta from JSON.pm version 2.90
+use Carp ();
+
+sub from_json ($@) {
+ if ( ref($_[0]) =~ /^JSON/ or $_[0] =~ /^JSON/ ) {
+ Carp::croak "from_json should not be called as a method.";
+ }
+ my $json = JSON()->new;
+
+ if (@_ == 2 and ref $_[1] eq 'HASH') {
+ my $opt = $_[1];
+ for my $method (keys %$opt) {
+ $json->$method( $opt->{$method} );
+ }
+ }
+
+ return $json->decode( $_[0] );
+}
+
+sub to_json ($@) {
+ if (
+ ref($_[0]) =~ /^JSON/
+ or (@_ > 2 and $_[0] =~ /^JSON/)
+ ) {
+ Carp::croak "to_json should not be called as a method.";
+ }
+ my $json = JSON()->new;
+
+ if (@_ == 2 and ref $_[1] eq 'HASH') {
+ my $opt = $_[1];
+ for my $method (keys %$opt) {
+ $json->$method( $opt->{$method} );
+ }
+ }
+
+ $json->encode($_[0]);
+}
+
1;
=head1 NAME
@@ -77,14 +132,31 @@ we provide our own C<new> method that supports that.
=head1 EXPORTS
-All of C<encode_json>, C<decode_json> and C<JSON> are exported by default.
+C<encode_json>, C<decode_json> and C<JSON> are exported by default; C<is_bool>
+is exported on request.
To import only some symbols, specify them on the C<use> line:
- use JSON::MaybeXS qw(encode_json decode_json); # functions only
+ use JSON::MaybeXS qw(encode_json decode_json is_bool); # functions only
use JSON::MaybeXS qw(JSON); # JSON constant only
+To import all available sensible symbols (C<encode_json>, C<decode_json>, and
+C<is_bool>), use C<:all>:
+
+ use JSON::MaybeXS ':all';
+
+To import all symbols including those needed by legacy apps that use L<JSON::PP>:
+
+ use JSON::MaybeXS ':legacy';
+
+This imports the C<to_json> and C<from_json> symbols as well as everything in
+C<:all>. NOTE: This is to support legacy code that makes extensive
+use of C<to_json> and C<from_json> which you are not yet in a position to
+refactor. DO NOT use this import tag in new code, in order to avoid
+the crawling horrors of getting UTF8 support subtly wrong. See the
+documentation for L<JSON> for further details.
+
=head2 encode_json
This is the C<encode_json> function provided by the selected implementation
@@ -99,6 +171,11 @@ module, and takes a string of JSON text to deserialise to a perl data structure.
my $data_structure = decode_json($json_text);
+=head2 to_json, from_json
+
+See L<JSON> for details. These are included to support legacy code
+B<only>.
+
=head2 JSON
The C<JSON> constant returns the selected implementation module's name for
@@ -110,6 +187,18 @@ and that object can then be used normally:
my $data_structure = $json_obj->decode($json_text); # etc.
+=head2 is_bool
+
+ $is_boolean = is_bool($scalar)
+
+Returns true if the passed scalar represents either C<true> or
+C<false>, two constants that act like C<1> and C<0>, respectively
+and are used to represent JSON C<true> and C<false> values in Perl.
+
+Since this is a bare sub in the various backend classes, it cannot be called as
+a class method like the other interfaces; it must be called as a function, with
+no invocant. It supports the representation used in all JSON backends.
+
=head1 CONSTRUCTOR
=head2 new
@@ -146,6 +235,8 @@ mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
=item * Karen Etheridge <ether@cpan.org>
+=item * Kieren Diment <diment@gmail.com>
+
=back
=head1 COPYRIGHT
@@ -5,10 +5,10 @@ use JSON::MaybeXS;
unless ( eval { require Cpanel::JSON::XS; 1 } ) {
plan skip_all => 'No Cpanel::JSON::XS';
- done_testing;
- exit;
}
+diag 'Using Cpanel::JSON::XS ', Cpanel::JSON::XS->VERSION;
+
is( JSON, 'Cpanel::JSON::XS', 'Correct JSON class' );
is( \&encode_json,
@@ -21,4 +21,6 @@ is( \&decode_json,
'Correct encode_json function'
);
+require 't/lib/is_bool.pm';
+
done_testing;
@@ -0,0 +1,50 @@
+use strict;
+use warnings FATAL => 'all';
+
+use Test::Without::Module 'Cpanel::JSON::XS';
+use Test::More;
+use JSON::MaybeXS qw/:legacy/;
+
+my $in = '[1, 2, 3, 4]';
+
+my $arr = from_json($in);
+my $j = to_json($arr);
+is($j, '[1,2,3,4]');
+is(ref($arr), 'ARRAY');
+
+my $json = 'JSON::MaybeXS';
+diag "using invocant: $json";
+like(
+ do { eval { $json->from_json($in) }; $@ },
+ qr/from_json should not be called as a method/,
+ 'blessed invocant detected in from_json',
+);
+
+like(
+ do { eval { $json->to_json($arr, { blah => 1 } ) }; $@ },
+ qr/to_json should not be called as a method/,
+ 'blessed invocant detected in to_json',
+);
+
+done_testing;
+
+__END__
+
+ to_json
+ $json_text = to_json($perl_scalar)
+
+ Converts the given Perl data structure to a json string.
+
+ This function call is functionally identical to:
+
+ $json_text = JSON->new->encode($perl_scalar)
+
+ from_json
+ $perl_scalar = from_json($json_text)
+
+ The opposite of "to_json": expects a json string and tries to parse it,
+ returning the resulting reference.
+
+ This function call is functionally identical to:
+
+ $perl_scalar = JSON->decode($json_text)
@@ -0,0 +1,24 @@
+use strict;
+use warnings;
+
+use Test::More;
+use JSON::MaybeXS;
+
+my $data = JSON::MaybeXS->new->decode('{"foo": true, "bar": false, "baz": 1}');
+diag 'true is: ', explain $data->{foo};
+diag 'false is: ', explain $data->{bar};
+
+ok(
+ JSON::MaybeXS::is_bool($data->{foo}),
+ JSON() . ': true decodes to a bool',
+);
+ok(
+ JSON::MaybeXS::is_bool($data->{bar}),
+ JSON() . ': false decodes to a bool',
+);
+ok(
+ !JSON::MaybeXS::is_bool($data->{baz}),
+ JSON() . ': int does not decode to a bool',
+);
+
+1;
@@ -1,10 +1,13 @@
use strict;
use warnings FATAL => 'all';
+
use Test::Without::Module 'Cpanel::JSON::XS', 'JSON::XS';
use if !eval { require JSON::PP; 1; }, 'Test::More', skip_all => 'No JSON::PP';
use Test::More;
use JSON::MaybeXS;
+diag 'Using JSON::PP ', JSON::PP->VERSION;
+
is(JSON, 'JSON::PP', 'Correct JSON class');
is(
@@ -17,4 +20,6 @@ is(
'Correct encode_json function'
);
+require 't/lib/is_bool.pm';
+
done_testing;
@@ -4,6 +4,8 @@ use if !eval { require Cpanel::JSON::XS; 1; }, 'Test::More', skip_all => 'No Cpa
use Test::More;
use JSON::MaybeXS;
+diag 'Using Cpanel::JSON::XS ', Cpanel::JSON::XS->VERSION;
+
is(JSON, 'Cpanel::JSON::XS', 'Correct JSON class');
is(
@@ -16,4 +18,6 @@ is(
'Correct encode_json function'
);
+require 't/lib/is_bool.pm';
+
done_testing;
@@ -1,12 +1,17 @@
use strict;
use warnings FATAL => 'all';
+
use if !eval { require JSON::XS; 1; }, 'Test::More', skip_all => 'No JSON::XS';
use Test::More;
use JSON::MaybeXS;
+diag 'Using JSON::XS ', JSON::XS->VERSION;
+
is( JSON, 'JSON::XS', 'Correct JSON class' );
is( \&encode_json, \&JSON::XS::encode_json, 'Correct encode_json function' );
is( \&decode_json, \&JSON::XS::decode_json, 'Correct encode_json function' );
+require 't/lib/is_bool.pm';
+
done_testing;
@@ -7,13 +7,15 @@ use JSON::MaybeXS;
unless ( eval { require JSON::XS; 1 } ) {
plan skip_all => 'No JSON::XS';
- done_testing;
- exit;
}
+diag 'Using JSON::XS ', JSON::XS->VERSION;
+
is( JSON, 'JSON::XS', 'Correct JSON class' );
is( \&encode_json, \&JSON::XS::encode_json, 'Correct encode_json function' );
is( \&decode_json, \&JSON::XS::decode_json, 'Correct encode_json function' );
+require 't/lib/is_bool.pm';
+
done_testing;
@@ -0,0 +1,24 @@
+use strict;
+use warnings FATAL => 'all';
+use Test::More;
+
+unless ( eval { require JSON; 1 } ) {
+ plan skip_all => 'No JSON';
+}
+
+my $data = JSON->new->decode('{"foo": true, "bar": false, "baz": 1}');
+
+ok(
+ JSON::is_bool($data->{foo}),
+ 'JSON.pm: true decodes to a bool',
+);
+ok(
+ JSON::is_bool($data->{bar}),
+ 'JSON.pm:: false decodes to a bool',
+);
+ok(
+ !JSON::is_bool($data->{baz}),
+ 'JSON.pm: int does not decode to a bool',
+);
+
+done_testing;
@@ -0,0 +1,47 @@
+use warnings FATAL => 'all';
+use strict;
+use Test::More;
+
+# some tests to check JSON::PP versus JSON::MaybeXS for legacy methods
+
+unless ( eval { require JSON; 1 }) {
+ plan skip_all => 'No JSON';
+}
+
+use JSON::MaybeXS qw/:legacy/;
+use Encode;
+use utf8;
+
+my @hovercraft = (
+ 'My hovercraft is full of eels',
+ 'Automjeti im është plot me ngjala',
+ 'حَوّامتي مُمْتِلئة بِأَنْقَلَيْسون',
+ ' Маё судна на паветранай падушцы поўна вуграмі',
+ '我的氣墊船裝滿了鱔魚 ',
+ 'Il mio hovercraft/aeroscivolante è pieno di anguille',
+ 'សុទ្ធតែឣន្ចងពេញទូកហាះយើង ។',
+ "Tá m'árthach foluaineach lán d'eascanna."
+);
+
+foreach my $h (@hovercraft) {
+ $h = '["' . $h . '"]';
+ my $j_perl = JSON::from_json($h);
+ my $j_json = JSON::to_json($j_perl);
+
+ my $h_enc = Encode::encode_utf8($h);
+ my $j_perl_enc = JSON::from_json($h_enc);
+ my $j_json_enc = JSON::to_json($j_perl_enc);
+
+ my $jm_perl = from_json($h);
+ my $jm_json = to_json($jm_perl);
+
+ my $jm_perl_enc = from_json($h_enc);
+ my $jm_json_enc = to_json($jm_perl_enc);
+
+ is_deeply($j_perl, $jm_perl);
+ is_deeply($j_perl_enc, $jm_perl_enc);
+ is ($j_json, $jm_json);
+ is ($j_json_enc, $jm_json_enc);
+}
+
+done_testing();
@@ -0,0 +1,6 @@
+use strict;
+use warnings;
+
+$ENV{PERL_JSON_BACKEND} = 'JSON::PP';
+
+require 'xt/json_pm_legacy.t';
@@ -0,0 +1,6 @@
+use strict;
+use warnings;
+
+$ENV{PERL_JSON_BACKEND} = 'JSON::XS';
+
+require 'xt/json_pm_legacy.t';