Devel::PerlySense::Config::Project - A Project's configuration

use strict;
use warnings;

package Devel::PerlySense::Config::Project;
our $VERSION = '0.01';





use Spiffy -Base;

use Data::Dumper;
use Carp;

use File::Basename;
use File::Path;
use Path::Class;
use YAML::Tiny ();
use HTTP::Date qw/ time2iso /;

use Devel::PerlySense::Util;

field "nameFileConfig" => ".PerlySenseProject/project.yml";

field "textConfigDefault" => q{#PerlySense Project Config

#What's this all about? See: http://search.cpan.org/dist/Devel-PerlySense/

project:

    #The human readable name of the Project
    moniker: 'The Project Without a Name'

    #Extra @INC directories, relative to the project root
    #These come before the default inc directories "." and "lib"
    inc_dir: []


#Bookmarks are regexes that may match against a single line.
#
#The "rex" is either a qr regex declaration, or an array ref of
#regexes (any of them could match to make a bookmark for the line).
#
#The line, or $1 if captured, is displayed.
bookmark:
    -
        moniker: Todo
        rex:
            - "qr/\# \s* TODO \s* : \s* (.+?) \s*$/x"


external:
    editor:

        #Emacs specific configuration
        emacs:

            #To enable flymake in Emacs, configure this in your .emacs file
            #(setq perly-sense-load-flymake t)
            #
            #For more details, settings and colors, see:
            #http://search.cpan.org/dist/Devel-PerlySense/lib/Devel/PerlySense.pm#Emacs_installation
            #
            flymake:

                #During a flymake compilation, perly_sense can run:

                #Check Syntax (perl -c)
                #
                #!!!NOTE!!!
                #   Running perl -c on random Perl code will execute
                #   the BEGIN blocks! Any funny business in them and you're toast!
                #!!!NOTE!!!
                syntax: 0

                #Perl Critic
                #PerlySense will point Critic to a .perlcritic file in this
                #directory. A default config file with fairly lenient rules is
                #provided.
                critic: 0



#These are evaluated in order to find a way to run a file. First
#match is used.
run_file:
    -
        command: "prove --nocolor -v ${INC} \"${SOURCE_FILE}\""
        moniker: Test
        rex: \.t$
        run_from: source_root_directory
    -
        command: "perl -c ${INC} \"${SOURCE_FILE}\" 2>&1| perl -ne \"/Subroutine \\w+ redefined at/ or print\""
        moniker: Module
        rex: \.pm$
        run_from: source_root_directory
    -
        command: "perl ${INC} \"${SOURCE_FILE}\""
        moniker: Script
        rex: \.pl$
        run_from: file_directory

    #This is a catch-all for all other types of files
    -
        command: "perl ${INC} \"${SOURCE_FILE}\""
        moniker: 'Script (no .pl)'
        rex: .
        run_from: file_directory



#These are evaluated in order to find a way to debug a file. First
#match is used.
debug_file:
    -
        command: "perl -d ${INC} \"${SOURCE_FILE}\""
        moniker: Test
        rex: \.t$
        debug_from: source_root_directory
    -
        command: "perl -d ${INC} \"${SOURCE_FILE}\""
        moniker: Script
        rex: \.pl$
        debug_from: file_directory

    -
        command: "perl -d ${INC} \"${SOURCE_FILE}\""
        moniker: Module
        rex: \.pm$
        debug_from: source_root_directory

    #This is a catch-all for all other types of files
    -
        command: "perl -d ${INC} \"${SOURCE_FILE}\""
        moniker: 'Script (no .pl)'
        rex: .
        debug_from: file_directory




#EOF
};

field "dirRoot" => undef;

field "rhConfig" => { };

sub new(@) {
    my $pkg = shift;

    my $self = $pkg->SUPER::new(@_);

    $self->dirRoot and $self->loadConfig(dirRoot => $self->dirRoot);

    return($self);
}

sub loadConfig {
    my ($dirRoot) = Devel::PerlySense::Util::aNamedArg(["dirRoot"], @_);

    my $fileConfig = file($dirRoot, $self->nameFileConfig);
    my $sourceConfig = slurp($fileConfig) or
            die("Could not open config file ($fileConfig)\n");
    my ($rhConfig) = YAML::Tiny::Load($sourceConfig);
    $rhConfig or die($YAML::Tiny::errstr);

    $self->dirRoot($dirRoot);
    $self->rhConfig($rhConfig);

    return 1;
}

sub createFileConfigDefault {
    my ($dirRoot) = Devel::PerlySense::Util::aNamedArg(["dirRoot"], @_);

    my $fileConfig = file($dirRoot, $self->nameFileConfig);
    my $dirConfig = dirname($fileConfig);
    mkpath($dirConfig);
    -d $dirConfig or die("Could not create config directory ($dirConfig)\n");

    if(-e $fileConfig) {
        my $textTime = time2iso( time() );
        $textTime =~ s/\W+/_/g;
        my $fileConfigBackup = $fileConfig . "." . $textTime;

        rename($fileConfig, $fileConfigBackup)
                or die("Could not rename ($fileConfig) -> ($fileConfigBackup)\n");
    }

    spew($fileConfig, $self->textConfigDefault) or
            die("Could not create config file ($fileConfig)\n");

    $self->loadConfig(dirRoot => $dirRoot);

    return 1;
}





1;





__END__