From: Karen Etheridge <ether@cpan.org>
Date: Thu, 30 Oct 2014 18:55:51 +0000 (-0700)
Subject: Merge branch 'topic/legacy'
X-Git-Tag: v1.003_000~1
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=6771a9272889cc14068057ff32bc6b6b86554faf;hp=7dc5a995d08d118bfe7caf41709a95c5b5a7e039;p=p5sagit%2FJSON-MaybeXS.git

Merge branch 'topic/legacy'
---

diff --git a/Changes b/Changes
index 2de7a32..0c6d1b0 100644
--- a/Changes
+++ b/Changes
@@ -1,5 +1,7 @@
 Revision history for JSON-MaybeXS
 
+ - 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
diff --git a/Makefile.PL b/Makefile.PL
index 3b8f406..8bb9ae0 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -37,6 +37,7 @@ 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
diff --git a/lib/JSON/MaybeXS.pm b/lib/JSON/MaybeXS.pm
index 69a940d..354fba3 100644
--- a/lib/JSON/MaybeXS.pm
+++ b/lib/JSON/MaybeXS.pm
@@ -4,7 +4,8 @@ use strict;
 use warnings FATAL => 'all';
 use base qw(Exporter);
 
-our $VERSION = '1.002006';
+our $VERSION = '1.003_000';   # TRIAL RELEASE
+$VERSION = eval $VERSION;
 
 sub _choose_json_module {
     return 'Cpanel::JSON::XS' if $INC{'Cpanel/JSON/XS.pm'};
@@ -31,8 +32,11 @@ BEGIN {
 }
 
 our @EXPORT = qw(encode_json decode_json JSON);
-our @EXPORT_OK = qw(is_bool);
-our %EXPORT_TAGS = ( all => [ @EXPORT, @EXPORT_OK ] );
+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 }
 
@@ -54,6 +58,44 @@ sub is_bool {
       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
@@ -98,10 +140,22 @@ To import only some symbols, specify them on the C<use> line:
 
   use JSON::MaybeXS qw(JSON); # JSON constant only
 
-To import all available symbols, use C<:all>:
+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
@@ -116,6 +170,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
@@ -175,6 +234,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
diff --git a/t/legacy.t b/t/legacy.t
new file mode 100644
index 0000000..fc28334
--- /dev/null
+++ b/t/legacy.t
@@ -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)
diff --git a/xt/json_pm_legacy.t b/xt/json_pm_legacy.t
new file mode 100644
index 0000000..716790c
--- /dev/null
+++ b/xt/json_pm_legacy.t
@@ -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();
diff --git a/xt/json_pp_legacy.t b/xt/json_pp_legacy.t
new file mode 100644
index 0000000..b69b5c9
--- /dev/null
+++ b/xt/json_pp_legacy.t
@@ -0,0 +1,6 @@
+use strict;
+use warnings;
+
+$ENV{PERL_JSON_BACKEND} = 'JSON::PP';
+
+require 'xt/json_pm_legacy.t';
diff --git a/xt/json_xs_legacy.t b/xt/json_xs_legacy.t
new file mode 100644
index 0000000..ae672c5
--- /dev/null
+++ b/xt/json_xs_legacy.t
@@ -0,0 +1,6 @@
+use strict;
+use warnings;
+
+$ENV{PERL_JSON_BACKEND} = 'JSON::XS';
+
+require 'xt/json_pm_legacy.t';