_posts/2009-05-22-modules-i-like---module-setup.textile


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

---
layout: post
category: perl
title: modules I like Module::Setup
---

"Module::Setup":http://search.cpan.org/perldoc?Module::Setup by "Yappo":http://blog.yappo.jp/ is a really nice module. I don't like "Module::Starter":http://search.cpan.org/perldoc?Module::Starter, it's not easy to create template to make it do what you need. With Module::Setup you can create flavors for any type of modules you want. Most of the modules I create for work use Moose, and I like to use Test::Class too. I've created a Moose flavor for creating this kind of modules.

h3. Creating a Moose flavor for Module::Setup

First, you tell it to init a new flavor:

{% highlight bash %}
module-setup --init moose
{% endhighlight %}

Module::Setup ask what is your favorite SCM. For me, it's git. It will create files in *$HOME/.module-setup/flavors/moose/*.

Start by editing *$HOME/.module-setup/flavors/moose/template/lib/____var-module_path-var____.pm* to make it look like this

{% highlight perl %}
- use strict;
- use warnings;
+ use Moose;
{% endhighlight %}

Add *requires 'Moose'* in *Makefile.PL*. Create a *t/tests/Test/____var-module_path-var____.pm* file with the following content:

{% highlight perl %}
package Test :: [%module %];

use strict;
use warnings;
use base 'Test::Class';
use Test::Exception;
use Test::More;

sub class {'[% module %]'}

sub startup : Tests(startup => 1) {
    my $test = shift;
    use_ok $test->class, "use ok";
}

sub shutdown : Tests(shutdown) {
    my $test = shift;
}

sub constructor : Tests(1) {
    my $test = shift;
    can_ok $test->class, 'new';
}

1;
{% endhighlight %}

You will have a Test::Class test ready with basic tests already implemented.

If you want to share this template at $work, easy:

{% highlight bash %}
module-setup --pack DevMoose moose > DevMoose.pm
{% endhighlight %}

You just have to send DevMoose.pm to who need it, and he will be able to import it with

{% highlight bash %}
module-setup --init --flavor-class=+DevMoose moose
{% endhighlight %}

Now you can create a new module

{% highlight bash %}
module-setup MY::AWESOME::MODULE moose
{% endhighlight %}