Adds support for Perl::Tidy::Sweetened

Author: mvgrimes

Changes

@@ -3,6 +3,9 @@
 - The JSON plugin now uses JSON::MaybeXS instead of JSON.pm. Patch by Greg
   Oschwald. GitHub #37.
 
+- Added a new plugin, PerlTidySweet, which uses perltidy-sweet instead of
+  perltidy. Implemented by Mark Grimes. GitHub #26.
+
 
 0.27     2015-07-04
 

README.md

@@ -127,6 +127,7 @@ You can call this API from your own program instead of executing `tidyall`.
 - George Hartzell <[email protected]>
 - Gregory Oschwald <[email protected]>
 - Joe Crotty <[email protected]>
+- Mark Grimes <[email protected]>
 - Olaf Alders <[email protected]>
 - Pedro Melo <[email protected]>
 

bin/tidyall

@@ -238,7 +238,8 @@ distribution comes with plugins for:
 =item *
 
 Perl: L<perlcritic|Code::TidyAll::Plugin::PerlCritic>,
-L<perltidy|Code::TidyAll::Plugin::PerlTidy>
+L<perltidy|Code::TidyAll::Plugin::PerlTidy>,
+L<perltidy-sweet|Code::TidyAll::Plugin::PerlTidy::Sweetened>
 
 =item *
 

cpanfile

@@ -64,6 +64,7 @@ on 'develop' => sub {
   requires "Perl::Critic" => "1.123";
   requires "Perl::Critic::Policy::Moose::RequireMakeImmutable" => "0";
   requires "Perl::Tidy" => "20140711";
+  requires "Perl::Tidy::Sweetened" => "1.00";
   requires "Pod::Checker" => "0";
   requires "Pod::Spell" => "0";
   requires "Pod::Tidy" => "0";

dist.ini

@@ -11,6 +11,7 @@ prereqs_skip = JSON
 prereqs_skip = Mason::Tidy
 prereqs_skip = Mason::Tidy::App
 prereqs_skip = Perl::Tidy
+prereqs_skip = Perl::Tidy::Sweetened
 prereqs_skip = Pod::Checker
 prereqs_skip = Pod::Spell
 prereqs_skip = Pod::Tidy
@@ -47,6 +48,7 @@ Mason::Tidy::App = 0
 Perl::Critic = 0
 Perl::Critic::Policy::Moose::RequireMakeImmutable = 0
 Perl::Tidy = 0
+Perl::Tidy::Sweetened = 1.00
 Pod::Checker = 0
 Pod::Spell = 0
 Pod::Tidy = 0

lib/Code/TidyAll/Plugin/PerlTidySweet.pm

@@ -0,0 +1,82 @@
+package Code::TidyAll::Plugin::PerlTidySweet;
+
+use Capture::Tiny qw(capture_merged);
+use Perl::Tidy::Sweetened 1.00;
+use Moo;
+extends 'Code::TidyAll::Plugin';
+
+our $VERSION = '0.28';
+
+sub transform_source {
+    my ( $self, $source ) = @_;
+
+    # perltidy reports errors in two different ways.
+    # Argument/profile errors are output and an error_flag is returned.
+    # Syntax errors are sent to errorfile or stderr, depending on the
+    # the setting of -se/-nse (aka --standard-error-output).  These flags
+    # might be hidden in other bundles, e.g. -pbp.  Be defensive and
+    # check both.
+    my ( $output, $error_flag, $errorfile, $stderr, $destination );
+    $output = capture_merged {
+        $error_flag = Perl::Tidy::Sweetened::perltidy(
+            argv        => $self->argv,
+            source      => \$source,
+            destination => \$destination,
+            stderr      => \$stderr,
+            errorfile   => \$errorfile
+        );
+    };
+    die $stderr          if $stderr;
+    die $errorfile       if $errorfile;
+    die $output          if $error_flag;
+    print STDERR $output if defined($output);
+    return $destination;
+}
+
+1;
+
+# ABSTRACT: Use perltidy-sweet with tidyall
+
+__END__
+
+=pod
+
+=head1 SYNOPSIS
+
+   # In configuration:
+
+   ; Configure in-line
+   ;
+   [PerlTidySweet]
+   select = lib/**/*.pm
+   argv = --noll
+
+   ; or refer to a .perltidyrc in the same directory
+   ;
+   [PerlTidySweet]
+   select = lib/**/*.pm
+   argv = --profile=$ROOT/.perltidyrc
+
+=head1 DESCRIPTION
+
+Runs L<perltidy-sweet>, a Perl tidier based on Perl::Tidy that also supports
+new syntactic sugar as provided by L<Method::Signature::Simple>,
+L<MooseX::Method::Signatures> and the p5-mop.
+
+=head1 INSTALLATION
+
+Install perltidy-sweet from CPAN.
+
+    cpanm Perl::Tidy::Sweet
+
+=head1 CONFIGURATION
+
+=over
+
+=item argv
+
+Arguments to pass to perltidy-sweet
+
+=back
+
+=cut

t/lib/Test/Code/TidyAll/Plugin/PerlTidySweet.pm

@@ -0,0 +1,39 @@
+package Test::Code::TidyAll::Plugin::PerlTidySweet;
+
+use Test::Class::Most parent => 'Test::Code::TidyAll::Plugin';
+
+sub test_main : Tests {
+    my $self = shift;
+
+    my $source = 'if (  $foo) {\nmy   $bar =  $baz;\n}\n';
+    $self->tidyall(
+        conf        => { argv => '-npro' },
+        source      => $source,
+        expect_tidy => 'if ($foo) {\n    my $bar = $baz;\n}\n'
+    );
+    $self->tidyall(
+        conf        => { argv => '-npro -bl' },
+        source      => $source,
+        expect_tidy => 'if ($foo)\n{\n    my $bar = $baz;\n}\n'
+    );
+    $self->tidyall(
+        conf      => { argv => '-npro' },
+        source    => 'if ($foo) {\n    my $bar = $baz;\n}\n',
+        expect_ok => 1
+    );
+    $self->tidyall(
+        source      => 'method  foo  ($x,$y){\nmy  $x=$self->x;}\n',
+        expect_tidy => 'method foo ($x,$y) {\n    my $x = $self->x;\n}\n',
+    );
+    $self->tidyall(
+        source       => 'if ($foo) {\n    my $bar = $baz;\n',
+        expect_error => qr/Final nesting depth/
+    );
+    $self->tidyall(
+        conf         => { argv => '--badoption' },
+        source       => $source,
+        expect_error => qr/Unknown option: badoption/
+    );
+}
+
+1;

tidyall.ini

@@ -6,6 +6,14 @@ ignore = t/00-report-prereqs.t
 ignore = t/author-*
 ignore = t/release-*
 
+[PerlTidySweet]
+argv = --pro=$ROOT/perltidyrc
+except_modes = dzil
+select = {bin,lib,t}/**/{tidyall,*.{pl,pm,t}}
+ignore = t/00-report-prereqs.t
+ignore = t/author-*
+ignore = t/release-*
+
 [PodTidy]
 select = {bin,lib}/**/{tidyall,*.{pl,pm,pod}}
 ignore = t/00-report-prereqs.t

xt/author/Plugin-PerlTidySweet.t

@@ -0,0 +1,10 @@
+#!/usr/bin/perl
+
+use Test::More;
+
+plan skip_all => 'This plugin requires Perl 5.10+'
+    unless $] >= 5.010;
+
+use lib 't/lib';
+use Test::Code::TidyAll::Plugin::PerlTidySweet;
+Test::Code::TidyAll::Plugin::PerlTidySweet->runtests;

xt/author/self-tidyall.t

@@ -4,6 +4,9 @@ use warnings;
 use Test::Code::TidyAll;
 use Test::More;
 
+plan skip_all => 'This plugin requires Perl 5.10+'
+    unless $] >= 5.010;
+
 tidyall_ok( verbose => 1 );
 
 done_testing();