Merge remote-tracking branch 'origin/main' into cookie-semicolon

Author: yanick

Changes

@@ -1,5 +1,24 @@
 {{$NEXT}}
 
+    [ BUG FIXES ]
+    * None
+
+    [ ENHANCEMENTS ]
+    * GH #1723: Enable use of a different Template Toolkit base class
+      (Andy Beverley)
+    * PR #1727: Don't create CPAN package files when generating new apps
+      (Jason A. Crome)
+
+    [ DOCUMENTATION ]
+    * GH #1342: Document skipping private methods in pod coverage tests
+      (Jason A. Crome)
+
+    [ DEPRECATED ]
+    * None
+
+    [ MISC ]
+    * None
+
 1.1.2     2024-11-25 08:34:51-05:00 America/New_York
 
     [ BUG FIXES ]

lib/Dancer2/CLI/Gen.pm

@@ -74,8 +74,8 @@ option skel => (
     format_doc => 'directory',
     required   => 0,
     default    => sub{
-        my $self = shift; 
-        path( $self->parent_command->_dist_dir, 'skel' ); 
+        my $self = shift;
+        path( $self->parent_command->_dist_dir, 'skel' );
     },
 );
 
@@ -95,7 +95,7 @@ option git => (
     default    => 0,
 );
 
-option remote => ( 
+option remote => (
     is         => 'ro',
     short      => 'r',
     doc        => 'URI for git repository (implies -g)',
@@ -104,12 +104,19 @@ option remote => (
     required   => 0,
 );
 
+option no_package_files => (
+    is       => 'ro',
+    doc      => "don't create files needed for CPAN packaging",
+    required => 0,
+    default  => 0,
+);
+
 # Last chance to validate args before we attempt to do something with them
 sub BUILD {
     my ( $self, $args ) = @_;
 
-    $self->osprey_usage( 1, qq{ 
-Invalid application name. Application names must not contain single colons, 
+    $self->osprey_usage( 1, qq{
+Invalid application name. Application names must not contain single colons,
 dots, hyphens or start with a number.
     }) unless is_module_name( $self->application );
 
@@ -165,8 +172,10 @@ sub run {
     };
 
     $self->_copy_templates( $files_to_copy, $vars, $self->overwrite );
-    $self->_create_manifest( $files_to_copy, $app_path );
-    $self->_add_to_manifest_skip( $app_path);
+    unless( $self->no_package_files ) {
+        $self->_create_manifest( $files_to_copy, $app_path );
+        $self->_add_to_manifest_skip( $app_path );
+    }
 
     $self->_check_git( $vars );
     $self->_check_yaml;
@@ -183,7 +192,7 @@ sub _check_git {
 
 WARNING: Couldn't initialize a git repo despite being asked to do so.
 
-To resolve this, cd to your application directory and run the following 
+To resolve this, cd to your application directory and run the following
 commands:
 
   git init
@@ -200,13 +209,13 @@ commands:
         path( $gitignore )->copy( $app_path );
 
         chdir File::Spec->rel2abs( $app_path ) or die "Can't cd to $app_path: $!";
-        if( _run_shell_cmd( 'git', 'init') != 0 or 
-            _run_shell_cmd( 'git', 'add', '.') != 0 or 
+        if( _run_shell_cmd( 'git', 'init') != 0 or
+            _run_shell_cmd( 'git', 'add', '.') != 0 or
             _run_shell_cmd( 'git', 'commit', "-m 'Initial commit of $app_name by Dancer2'" ) != 0 ) {
             print $git_error;
         }
         else {
-            if( $self->remote && 
+            if( $self->remote &&
                 _run_shell_cmd( 'git', 'remote', 'add', 'origin', $self->remote ) != 0 ) {
                 print $git_error;
                 print "  git remote add origin " . $self->remote . "\n";
@@ -290,7 +299,7 @@ sub _build_file_list {
         warn "File not found: $file" unless $file->exists; # Paranoia
         next if $file->basename =~ m{^\.git(/|$)};
         next if $file->is_dir;
-        
+
         my $filename = $file->relative( $from );
         push @result, [ $file, path( $to, $filename )];
     }
@@ -302,6 +311,9 @@ sub _copy_templates {
 
     foreach my $pair (@$files) {
         my ( $from, $to ) = @{$pair};
+        next if $self->no_package_files && $from =~ /MANIFEST\.SKIP$/;
+        next if $self->no_package_files && $from =~ /Makefile.PL$/;
+
         if ( -f $to && !$overwrite ) {
             print "! $to exists, overwrite? (or rerun this command with -o) [N/y/a]: ";
             my $res = <STDIN>; chomp($res);
@@ -315,7 +327,7 @@ sub _copy_templates {
             $to_dir->mkpath;
         }
 
-        # Skeleton files whose names are prefixed with + need to be executable, but we must strip 
+        # Skeleton files whose names are prefixed with + need to be executable, but we must strip
         # that from the name when copying them
         my $to_file = path( $to )->basename;
         my $ex      = ( $to_file =~ s/^\+// );
@@ -378,7 +390,7 @@ sub _process_template {
     return $engine->render( \$template, $tokens );
 }
 
-# These are good candidates to move to Dancer2::CLI if other commands 
+# These are good candidates to move to Dancer2::CLI if other commands
 # need them later.
 sub _get_app_path {
     my ( $self, $path, $appname ) = @_;
@@ -431,8 +443,8 @@ sub _run_shell_cmd {
 
     my $exit_status = try {
         my $pid = IPC::Open3::open3(
-            my $stdin, 
-            my $stdout, 
+            my $stdin,
+            my $stdout,
             my $stderr = Symbol::gensym,
             @cmds,
         );

lib/Dancer2/Plugin.pm

@@ -1083,4 +1083,21 @@ to call C<plugin_keywords> after the attribute definition.
 
     plugin_keywords 'bar';
 
+=head3 Coverage for Dancer2::Plugin::<Name> is 0.0%, with 15 naked subroutines
+
+To avoid errors caused by missing pod for private plugin methods, write your
+pod coverage test like so:
+
+    pod_coverage_ok(
+        "Dancer2::Plugin::MyAwesomePlugin", {
+            also_private => [
+                qw/
+                  BUILDARGS BUILD ClassHooks PluginKeyword dancer_app
+                  execute_plugin_hook hook keywords on_plugin_import plugin_args
+                  plugin_setting realms realm realm_providers register register_hook
+                  register_plugin request var
+                  /
+            ]
+        });
+
 =cut

lib/Dancer2/Template/TemplateToolkit.pm

@@ -9,6 +9,9 @@ use Dancer2::FileUtils qw<path>;
 use Scalar::Util ();
 use Template;
 
+# Override to use a different Template::Toolkit base class
+has 'template_class' => ( is => 'ro', default => 'Template' );
+
 with 'Dancer2::Core::Role::Template';
 
 has '+engine' => ( isa => InstanceOf ['Template'], );
@@ -37,7 +40,7 @@ sub _build_engine {
         sub { [ $ttt->views ] },
     ];
 
-    my $tt = Template->new(%tt_config);
+    my $tt = $self->template_class->new(%tt_config);
     $Template::Stash::PRIVATE = undef if $self->config->{show_private_variables};
     return $tt;
 }
@@ -190,6 +193,22 @@ PARSER (L<Template::Parser>) and GRAMMAR (L<Template::Grammar>). If you intend t
 several of these components in your app, it is suggested to create an app-specific subclass
 that handles all of them at the same time.
 
+=head2 Custom Template::Toolkit class
+
+When subclassing this module it is possible to use a different
+Template::Toolkit class (for example if you have also subclassed that). To do
+that simply define a different C<template_class> property:
+
+    package Dancer2::Template::TemplateToolkit::FooBar;
+    
+    use Moo;
+    
+    extends 'Dancer2::Template::TemplateToolkit';
+    
+    has '+template_class' => ( default => 'TemplateFooBar' );
+    
+    1;
+
 =head2 Template Caching
 
 L<Template>::Tookit templates can be cached by adding the C<COMPILE_EXT> property to your

t/lib/Dancer2/Template/TemplateToolkitFoo.pm

@@ -0,0 +1,15 @@
+package Dancer2::Template::TemplateToolkitFoo;
+
+# Custom Template::Toolkit template engine that uses a custom Template class
+
+use strict;
+use warnings;
+
+use Moo;
+use TemplateFoo;
+
+extends 'Dancer2::Template::TemplateToolkit';
+
+has '+template_class' => ( default => 'TemplateFoo' );
+
+1;

t/lib/TemplateFoo.pm

@@ -0,0 +1,13 @@
+package TemplateFoo;
+
+# Custom Template::Toolkit class
+
+use base 'Template';
+
+sub process
+{   my ($self, $template, $vars, $outstream, @opts) = @_;
+    $$outstream = "Custom Render Template";
+    1;
+}
+
+1;

t/template.t

@@ -8,10 +8,13 @@ use HTTP::Request::Common;
 use File::Spec;
 use File::Basename 'dirname';
 
+use lib 't/lib';
+
 eval { require Template; Template->import(); 1 }
   or plan skip_all => 'Template::Toolkit probably missing.';
 
 use_ok('Dancer2::Template::TemplateToolkit');
+use_ok('Dancer2::Template::TemplateToolkitFoo');
 
 my $views =
   File::Spec->rel2abs( File::Spec->catfile( dirname(__FILE__), 'views' ) );
@@ -109,6 +112,28 @@ content added in after_layout_render";
     is $res->content, $result, '[GET /global] Correct content with template hooks';
 };
 
+# Test that a custom class can be used for Template::Toolkit
+my $tt_custom = Dancer2::Template::TemplateToolkitFoo->new;
+
+isa_ok $tt_custom, 'Dancer2::Template::TemplateToolkit';
+isa_ok $tt_custom, 'Dancer2::Template::TemplateToolkitFoo';
+
+{
+    package CustomFoo;
+    use Dancer2;
+
+    Dancer2->runner->apps->[1]->set_template_engine($tt_custom);
+
+    get '/' => sub { template 'index' };
+}
+
+subtest 'custom template render' => sub {
+
+    my $test = Plack::Test->create( CustomFoo->to_app );
+    my $res = $test->request( GET '/' );
+    is $res->content, 'Custom Render Template', 'Custom Render Template';
+};
+
 {
 
     package Foo;