File Coverage

blib/lib/Mojolicious/Plugin/Module/Loader.pm

Criterion	Covered	Total	%
statement	41	41	100.0
branch			n/a
condition	6	6	100.0
subroutine	9	9	100.0
pod	1	1	100.0
total	57	57	100.0

package Mojolicious::Plugin::Module::Loader 0.02;
use v5.26;
use warnings;

# ABSTRACT: Automatically load mojolicious namespaces

=encoding UTF-8

=head1 NAME

Mojolicious::Plugin::Module::Loader - Automatically load mojolicious namespaces

=head1 SYNOPSIS

    $app->plugin('Module::Loader' => {
      command_namespaces => ['MyApp::Command'],
      plugin_namespaces  => ['MyApp::Plugin']
    });

    # Or
    $app->plugin('Module::Loader');
    ...
    $app->add_command_namespace('Dynamically::Loaded::Module::Command');
    $app->add_plugin_namespace('Dynamically::Loaded::Module::Plugin');

=head1 DESCRIPTION

This module simply adds two mojolicious helpers, L and
L, and calls these automatically at registration time
on the contents of the C and C configuration
parameters, respectively.

=head1 METHODS

L inherits all methods from
L and implements the following new ones

=head2 register( \%config )

Register plugin in L application. Accepts a HashRef of parameters
with two supprted keys:

=head4 command_namespaces

ArrayRef of namespaces to automatically call L on

=head4 controller_namespaces

ArrayRef of namespaces to automatically call L on

=head4 plugin_namespaces

ArrayRef of namespaces to automatically call L on

=head2 add_command_namespace( $str )

Adds the given namespace to the Mojolicious Commands
L array.
Packages inheriting from L in these namespaces are loaded
as runnable commands from the mojo entrypoint script.

=head2 add_controller_namespace( $str )

Adds the given namespace to the Mojolicious routes
L array.

=head2 add_plugin_namespace( $str )

Searches the given namespace for packages inheriting from L
and loads them via L

=cut

use Mojo::Base 'Mojolicious::Plugin';
use Module::Find;

use experimental qw(signatures);

sub register($self, $app, $conf) {
  $app->helper(
    add_command_namespace => sub($c, $ns) {
      push($app->commands->namespaces->@*, $ns);
    }
  );

  $app->helper(
    add_controller_namespace => sub($c, $ns) {
      push($app->routes->namespaces->@*, $ns);
    }
  );

  $app->helper(
    add_plugin_namespace => sub($c, $ns) {
      $app->plugin($_) foreach (map {Module::Find::findallmod($_)} $ns);
    }
  );

  $app->add_command_namespace($_)    foreach (($conf->{command_namespaces}    // [])->@*);
  $app->add_controller_namespace($_) foreach (($conf->{controller_namespaces} // [])->@*);
  $app->add_plugin_namespace($_)     foreach (($conf->{plugin_namespaces}     // [])->@*);
}

=head1 AUTHOR

Mark Tyrrell C<<  >>

=head1 LICENSE

Copyright (c) 2024 Mark Tyrrell

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

=cut

1;

__END__