Merge branch 'main' into docs/doc-grant-release

Author: yanick

Changes

@@ -1,5 +1,28 @@
 {{$NEXT}}
 
+    [ BUG FIXES ]
+    * GH #1701: Split cookie values on & only (Yanick Champoux)
+
+    [ ENHANCEMENTS ]
+    * GH #530: Make data censoring configurable (Yanick Champoux, David
+      Precious)
+    * 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)
+    * GH #1737: Add on_hook_exception for errors during hook processing
+      (Andy Beverley)
+
+    [ 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 ]

cpanfile

@@ -3,6 +3,7 @@ requires 'Attribute::Handlers';
 requires 'Carp';
 requires 'Clone';
 requires 'Config::Any';
+requires 'Data::Censor' => '0.04';
 requires 'Digest::SHA';
 requires 'Encode';
 requires 'Exporter', '5.57';

lib/Dancer2.pm

@@ -379,6 +379,7 @@ We are also on IRC: #dancer on irc.perl.org.
     Michael Kröll
     Michał Wojciechowski
     Mike Katasonov
+    Mikko Koivunalho
     Mohammad S Anwar
     mokko
     Nick Patch

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/ConfigReader.pm

@@ -0,0 +1,224 @@
+# ABSTRACT: Config reader for Dancer2 App
+package Dancer2::ConfigReader;
+
+use Moo;
+
+use File::Spec;
+use Config::Any;
+use Hash::Merge::Simple;
+use Carp 'croak';
+use Module::Runtime qw{ use_module };
+
+use Dancer2::Core::Factory;
+use Dancer2::Core;
+use Dancer2::Core::Types;
+use Dancer2::ConfigUtils 'normalize_config_entry';
+
+has location => (
+    is       => 'ro',
+    isa      => Str,
+    required => 1,
+);
+
+has default_config => (
+    is      => 'ro',
+    isa     => HashRef,
+    required => 1,
+);
+
+has config_location => (
+    is      => 'ro',
+    isa     => ReadableFilePath,
+    lazy    => 1,
+    default => sub { $_[0]->location },
+);
+
+# The type for this attribute is Str because we don't require
+# an existing directory with configuration files for the
+# environments.  An application without environments is still
+# valid and works.
+has environments_location => (
+    is      => 'ro',
+    isa     => Str,
+    lazy    => 1,
+    default => sub {
+        $ENV{DANCER_ENVDIR}
+          || File::Spec->catdir( $_[0]->config_location, 'environments' );
+    },
+);
+
+has config => (
+    is      => 'ro',
+    isa     => HashRef,
+    lazy    => 1,
+    builder => '_build_config',
+);
+
+has environment => (
+    is      => 'ro',
+    isa     => Str,
+    required => 1,
+);
+
+has config_readers => (
+    is      => 'ro',
+    lazy    => 1,
+    isa     => ArrayRef,
+    builder => '_build_config_readers',
+);
+
+# The config builder
+sub _build_config {
+    my ($self) = @_;
+
+    my $default  = $self->default_config;
+    my $config = Hash::Merge::Simple->merge(
+        $default,
+        map {
+            warn "Merging config from @{[ $_->name() ]}\n" if $ENV{DANCER_CONFIG_VERBOSE};
+            $_->read_config()
+        } @{ $self->config_readers }
+    );
+
+    $config = $self->_normalize_config($config);
+    return $config;
+}
+
+sub _normalize_config {
+    my ( $self, $config ) = @_;
+
+    foreach my $key ( keys %{$config} ) {
+        my $value = $config->{$key};
+        $config->{$key} = normalize_config_entry( $key, $value );
+    }
+    return $config;
+}
+
+sub _build_config_readers {
+    my ($self) = @_;
+
+    my @config_reader_names = $ENV{'DANCER_CONFIG_READERS'}
+                            ? (split qr{,}msx, $ENV{'DANCER_CONFIG_READERS'})
+                            : ( q{Dancer2::ConfigReader::Config::Any} );
+
+    warn "ConfigReaders to use: @config_reader_names\n" if $ENV{DANCER_CONFIG_VERBOSE};
+    return [
+        map use_module($_)->new(
+            location    => $self->location,
+            environment => $self->environment,
+        ), @config_reader_names
+    ];
+}
+
+1;
+
+__END__
+
+=head1 DESCRIPTION
+
+This class provides a C<config> attribute that - when accessing
+the first time - feeds itself by executing one or more
+B<ConfigReader> packages.
+
+Also provides a C<setting()> method which is supposed to be used by externals to
+read/write config entries.
+
+You can control which B<ConfigReader>
+class or classes to use to create the config.
+
+Use C<DANCER_CONFIG_READERS> environment variable to define
+which class or classes you want.
+
+    DANCER_CONFIG_READERS='Dancer2::ConfigReader::Config::Any,Dancer2::ConfigReader::CustomConfig'
+
+If you want several, separate them with a comma (",").
+Configs are added in left-to-write order where the previous
+config items get overwritten by subsequent ones.
+
+For example, if config
+
+    item1: content1
+    item2: content2
+    item3:
+        subitem1: subcontent1
+        subitem2: subcontent2
+        subitem3:
+            subsubitem1:
+                subsubcontent1
+    item4:
+        subitem1: subcontent1
+        subitem2: subcontent2
+
+was followed by config
+
+    item2: content9
+    item3:
+        subitem2: subcontent8
+        subitem3:
+            subsubitem1:
+                subsubcontent7
+        subitem4:
+            subsubitem5: subsubcontent5
+    item4: content4
+
+then the final config would be
+
+    item1: content1
+    item2: content9
+    item3:
+        subitem1: subcontent1
+        subitem2: subcontent8
+        subitem3:
+            subsubitem1:
+                subsubcontent7
+        subitem4:
+            subsubitem5: subsubcontent5
+    item4: content4
+
+The default B<ConfigReader> is C<Dancer2::ConfigReader::Config::Any>.
+
+You can also create your own custom B<ConfigReader> classes.
+
+If you want, you can also extend class C<Dancer2::ConfigReader::Config::Any>.
+Here is an example:
+
+    package Dancer2::ConfigReader::FileExtended;
+    use Moo;
+    extends 'Dancer2::ConfigReader::Config::Any';
+    has name => (
+        is      => 'ro',
+        default => sub {'FileExtended'},
+    );
+    around read_config => sub {
+        my ($orig, $self) = @_;
+        my $config = $orig->($self, @_);
+        $config->{'dummy'}->{'item'} = 123;
+        return $config;
+    };
+
+Another (more complex) example is in class C<Dancer2::ConfigReader::Config::Any>.
+
+=head1 ATTRIBUTES
+
+=attr location
+
+Absolute path to the directory where the server started.
+
+=attr config_location
+
+Gets the location from the configuration. Same as C<< $object->location >>.
+
+=attr environments_location
+
+Gets the directory where the environment files are stored.
+
+=attr config
+
+Returns the whole configuration.
+This must not be used directly.
+Instead, use this via C<Dancer2::Core::Role::HasConfig> role
+which manages configuration after it is created.
+
+=attr environment
+
+Returns the name of the environment.