Merge pull request #1 from oposs/initial

initial commit

.gitignore

@@ -0,0 +1,10 @@
+.idea
+*.in
+_Deparsed_XSubs.pm
+*.log
+*.status
+Makefile
+*.tar.gz
+cover_db
+MYMETA.*
+*.iml

CHANGES

@@ -0,0 +1,3 @@
+0.0.1 2022-01-25 13:30:48 +0100 Tobias Bossert <tobib at cpan.org>
+ - initial release
+

MANIFEST

@@ -0,0 +1,12 @@
+CHANGES
+cpanfile
+lib/Mojolicious/Command/coverage.pm
+LICENSE
+Makefile.PL
+MANIFEST			This list of files
+MANIFEST.SKIP
+MANIFEST.skip
+Mojolicious-Command-coverage-0.0.1/META.json
+Mojolicious-Command-coverage-0.0.1/META.yml
+README.md
+VERSION

MANIFEST.SKIP

@@ -0,0 +1,18 @@
+.*\.old$
+\.tar\.gz$
+^Makefile$
+^MYMETA\.
+^blib
+^pm_to_blib
+\.idea
+\.debian
+\.git
+_build
+\.gitignore
+.*.am
+\.perl-version
+configure\.ac
+^_Deparsed_XSubs\.pm
+dist.sh
+MANIFEST.bak
+.*.iml

Makefile.PL

@@ -0,0 +1,65 @@
+use v5.20.0;
+
+use strict;
+use warnings;
+use ExtUtils::MakeMaker;
+use FindBin;
+
+sub get_version() {
+    open my $fh, 'VERSION';
+    chomp(my $v = <$fh>);
+    close $fh;
+    return $v;
+}
+
+my $version = get_version();
+
+WriteMakefile(
+    NAME           => 'Mojolicious::Command::coverage',
+    VERSION        => $version,
+    ABSTRACT       => 'Start you mojo app in coverage mode',
+    AUTHOR         => 'Tobias Bossert <tobib at cpan.org>',
+    LICENSE        => 'mit',
+    PREREQ_PM      => {
+        'Mojolicious'        => '>=8.0',
+        'Devel::Cover'       => '>=1.35',
+        'Devel::Deanonymize' => '>=0.1.2'
+    },,
+    BUILD_REQUIRES => {},
+    MAKE           => 'gmake',
+    META_MERGE     => {
+        requires  => { perl => '5.020000' },
+        resources => {
+            license    => 'https://opensource.org/licenses/mit',
+            repository => 'https://github.com/oposs/mojolicious_coverage',
+            bugtracker => 'https://github.com/oposs/mojolicious_coverage/issues'
+        },
+        no_index  => { directory => [ 't' ] },
+        homepage   => 'https://www.oetiker.ch',
+    },
+    test           => { TESTS => 't/*.t' }
+);
+
+sub MY::postamble {
+    my $self = shift;
+    return <<"EOF";
+
+VERSION_FILES := \$(shell grep -Rl 'our \$\$VERSION = ' .)
+\$(VERSION_FILES): VERSION
+	\$(PERL) -i -p -e 's/\$VERSION\\s*=\\s*"[\\d|\.]*[A-z]*"/\$VERSION = "\$(VERSION)"/;' \$\@
+
+# # Unfortunately, this is (gnu-)make specific...
+# ifeq (\$(EDITOR),)
+# EDITOR=/usr/bin/vi
+# endif
+
+CHANGES: VERSION
+	echo $self->{VERSION} `date +"%Y-%m-%d %H:%M:%S %z"` `git config user.name` '<'`git config user.email`'>' >> CHANGES.new
+	\@echo >> CHANGES.new
+	\@echo ' -' >> CHANGES.new
+	\@echo >> CHANGES.new
+	\@cat CHANGES >> CHANGES.new && mv CHANGES.new CHANGES
+	\$(EDITOR) CHANGES
+
+EOF
+}

README.md

@@ -1,2 +1,52 @@
 # mojolicious_coverage
+
 Start you Mojo app in coverage mode
+
+# SYNOPSIS
+
+```text
+Usage: APPLICATION coverage [OPTIONS] [APPLICATION_OPTIONS]
+
+./myapp.pl coverage [application arguments]
+
+Options:
+-h, --help                Shows this help
+-c, --cover-args <args>   Options for Devel::Cover
+-d, --deanon-args <args>  Options for Devel::Deanonymize (set to 0 to disable Devel::Deanonymize)
+
+Application Options
+- All parameters not matching [OPTIONS] are forwarded to the mojo application
+```
+
+# USAGE
+
+Runtime configuration for both modules are either passed through the command-line arguments or by specifying
+`has` sections in your application:
+
+```perl5
+has coverageConfig => sub {
+    return "-ignore,t/,+ignore,prove,+ignore,thirdparty/,-coverage,statement,branch,condition,path,subroutine";
+};
+
+has deanonymizeConfig => sub {
+    return "<Include-pattern>"
+};
+```
+
+If both are present, command-line args are preferred. If none of them are present, we fall-back to these default values:
+
+- **Devel::Cover**`-ignore,t/,-coverage,statement,branch,condition,path,subroutine`
+- **Devel::Deanonymize** `ref $self->app` ( -> Resolves to your application name)
+
+# EXAMPLES
+
+```shell
+# EXAMPLE (with `has` sections or default config)
+./myapp.pl coverage daemon --listen "http://*:8888"
+
+# EXAMPLE (with args)
+./myapp.pl coverage -d MyPattern* daemon --listen "http://*:8888"
+```
+
+
+

VERSION

@@ -0,0 +1 @@
+0.0.1

cpanfile

@@ -0,0 +1,3 @@
+requires 'Mojolicious';
+requires 'Devel::Cover';
+requires 'Devel::Deanonymize';

lib/Mojolicious/Command/coverage.pm

@@ -0,0 +1,157 @@
+package Mojolicious::Command::coverage;
+use strict;
+use warnings FATAL => 'all';
+use Mojo::Base 'Mojolicious::Command', -signatures;
+use Mojo::Util qw(getopt);
+
+our $VERSION = "0.0.0"; # Do not update manually
+
+# Short description
+has description => 'Start you Mojo app in coverage mode';
+
+# Usage message from SYNOPSIS
+has usage => sub($self) {$self->extract_usage};
+
+
+sub run($self, @args) {
+    my $deanonConfig = "";
+    my $coverageConfig = "";
+    my $appName = ref $self->app;
+    my $n_args = 0;
+    my @orig_args = @args;
+
+    getopt \@args, [ 'pass_through' ],
+        'd|deanon-args=s' => sub {
+            $n_args += 2;
+            $deanonConfig = $_[1]
+        },
+        'c|cover-args=s'  => sub {
+            $n_args += 2;
+            $coverageConfig = $_[1]
+        };
+
+    if ($deanonConfig eq "" && $self->app->can('deanonymizeConfig')) {
+        $deanonConfig = $self->app->deanonymizeConfig;
+        print "Command::coverage: Taking config from `$appName->deanonymizeConfig` for Devel::Deanonymize \n";
+    }
+
+    if ($coverageConfig eq "" && $self->app->can('coverageConfig')) {
+        $coverageConfig = $self->app->coverageConfig;
+        print "Command::coverage: Taking config from `$appName->coverageConfig` for Devel::Cover \n";
+    }
+
+    # if there is no custom config, we fallback to default
+    $deanonConfig = $appName if $deanonConfig eq "";
+    $coverageConfig = "-ignore,t/,-coverage,statement,branch,condition,path,subroutine" if $coverageConfig eq "";
+
+    my @commandline_inject = ();
+    if ($deanonConfig ne "0") {
+        @commandline_inject = ('perl', "-MDevel::Cover=$coverageConfig", "-MDevel::Deanonymize=$deanonConfig", $0);
+    }
+    else {
+        @commandline_inject = ('perl', "-MDevel::Cover=$coverageConfig", $0);
+    }
+    # Merge with application arguments
+    my @full_commandline = (@commandline_inject, @orig_args[$n_args .. $#orig_args]);
+    my $full_commandline_str = join " ", @full_commandline;
+    print "Command::coverage: Starting application with: `$full_commandline_str` \n";
+
+    exec @full_commandline;
+}
+
+=head1 NAME
+
+Mojolicious::Command::coverage - Run your application with coverage statistics
+
+=cut
+
+=head1 SYNOPSIS
+
+    Usage: APPLICATION coverage [OPTIONS] [APPLICATION_OPTIONS]
+
+    ./myapp.pl coverage [application arguments]
+
+    Options:
+    -h, --help                Shows this help
+    -c, --cover-args <args>   Options for Devel::Cover
+    -d, --deanon-args <args>  Options for Devel::Deanonymize (set to 0 to disable Devel::Deanonymize)
+
+    Application Options
+    - All parameters not matching [OPTIONS] are forwarded to the mojo application
+
+
+=cut
+
+=head1 DESCRIPTION
+
+Starts your mojo application with L<Devel::Cover> and optionally L<Devel::Deanonymize>.
+
+=cut
+
+=head1 USAGE
+
+Runtime configuration for both modules are either passed through the command-line arguments or by specifying
+ C<has> sections in your application:
+
+    has coverageConfig => sub{
+        return "-ignore,t/,+ignore,prove,+ignore,thirdparty/,-coverage,statement,branch,condition,path,subroutine";
+    };
+
+    has deanonymizeConfig => sub {
+        return "<Include-pattern>"
+    };
+
+If both are present, command-line args are preferred. If none of them are present, we fall-back to these default values:
+
+=over 1
+
+=item Devel::Cover
+
+C<-ignore,t/,-coverage,statement,branch,condition,path,subroutine>
+
+=item Devel::Deanonymize
+
+C<ref $self->app> ( -> Resolves to your application name)
+
+=back
+
+=head1 EXAMPLES
+
+    # (with `has` sections or default config)
+    ./myapp.pl coverage daemon --listen "http://*:8888"
+
+    # (with args)
+    ./myapp.pl coverage -d MyPattern* daemon --listen "http://*:8888"
+
+
+=head1 AUTHORS
+
+Since there is a lot of spam flooding my mailbox, I had to put spam filtering in place. If you want to make sure
+that your email gets delivered into my mailbox, include C<#im_not_a_bot#> in the B<subject!>
+S<Tobias Bossert E<lt>tobib at cpan.orgE<gt>>
+
+=cut
+
+=head1 COPYRIGHT AND LICENSE
+
+MIT License
+Copyright (c) 2022 Tobias Bossert
+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;