Dist::Zilla — raaaaaaaaar!

Dist::Zilla raaaaaaaaar!

What is Dist::Zilla?

AWESOME

Any Questions?

RJBS - cake and pie (and doughnuts)

RJBS - cake and pie (and doughnuts) - cocktails and
beer

beer - shooting zombies

beer - shooting zombies - giving away useful software

being a CPAN author is hard! let’s go gemming!

./Changes ./LICENSE ./MANIFEST.SKIP ./Makefile.PL ./README ./lib/YourApp.pm ./lib/YourApp/Reticulator.pm ./lib/YourApp/Util/mtfnpy.pm ./lib/YourApp/Xyzzy.pm ./t/unit-tests.t
./t/pod-coverage.t ./t/pod.t

ExtUtils::MakeMaker

WriteMakefile( NAME => ‘YourApp’, AUTHOR => ‘You <[email protected]>’, VERSION_FROM =>
‘lib/YourApp.pm’, ABSTRACT_FROM => ‘lib/YourApp.pm’, LICENSE => ‘perl’, PREREQ_PM => { ‘Lingua::EN::Inflect’ => 1.86, ‘Sub::Override’ => 0.07, ‘Test::More’ => 0, }, );

WriteMakefile( NAME => ‘YourApp’, AUTHOR => ‘You <[email protected]>’, VERSION_FROM =>
‘lib/YourApp.pm’, ABSTRACT_FROM => ‘lib/YourApp.pm’, LICENSE => ‘perl’, PREREQ_PM => { ‘Lingua::EN::Inflect’ => 1.86, ‘Sub::Override’ => 0.07, ‘Test::More’ => 0, }, (eval { ExtUtils::MakeMaker->VERSION(6.46) } ? (META_MERGE => { resources => { Repository => ‘...’ } }) : ()), );

Module::Install

use inc::Module::Install; all_from(‘lib/YourApp.pm’); requires(‘Lingua::EN::Inflect’ => 1.86); requires(‘Sub::Override’ => 0.07); requires(‘Test::More’
=> 0); repository(...); WriteAll();

Module::Starter

./Changes ./LICENSE ./MANIFEST.SKIP ./Makefile.PL ./README ./lib/YourApp.pm ./lib/YourApp/Reticulator.pm ./lib/YourApp/Util/mtfnpy.pm ./lib/YourApp/Xyzzy.pm ./t/boilerplate.t

./t/pod-coverage.t ./t/pod.t ./LICENSE

./t/pod-coverage.t ./t/pod.t ./LICENSE ./MANIFEST.SKIP

./t/pod-coverage.t ./t/pod.t ./LICENSE ./MANIFEST.SKIP ./Makefile.PL

./t/pod-coverage.t ./t/pod.t ./LICENSE ./MANIFEST.SKIP ./Makefile.PL ./README

./t/pod-coverage.t ./t/pod.t ./LICENSE ./MANIFEST.SKIP ./Makefile.PL ./README ./lib/YourApp.pm

./t/pod-coverage.t ./t/pod.t ./LICENSE ./MANIFEST.SKIP ./Makefile.PL ./README ./lib/YourApp.pm ./lib/YourApp/Reticulator.pm

./t/pod-coverage.t ./t/pod.t ./LICENSE ./MANIFEST.SKIP ./Makefile.PL ./README ./lib/YourApp.pm ./lib/YourApp/Reticulator.pm ./lib/YourApp/Util/mtfnpy.pm

./t/pod-coverage.t ./t/pod.t ./LICENSE ./MANIFEST.SKIP ./Makefile.PL ./README ./lib/YourApp.pm ./lib/YourApp/Reticulator.pm ./lib/YourApp/Util/mtfnpy.pm ./lib/YourApp/Xyzzy.pm

./t/pod-coverage.t ./t/pod.t ./LICENSE ./MANIFEST.SKIP ./Makefile.PL ./README ./lib/YourApp.pm ./lib/YourApp/Reticulator.pm ./lib/YourApp/Util/mtfnpy.pm ./lib/YourApp/Xyzzy.pm ./t/unit-tests.t

./t/pod-coverage.t ./t/pod.t ./LICENSE ./MANIFEST.SKIP ./Makefile.PL ./README ./lib/YourApp.pm ./lib/YourApp/Reticulator.pm ./lib/YourApp/Util/mtfnpy.pm ./lib/YourApp/Xyzzy.pm ./t/unit-tests.t ./t/pod-coverage.t

./t/pod-coverage.t ./t/pod.t ./LICENSE ./MANIFEST.SKIP ./Makefile.PL ./README ./lib/YourApp.pm ./lib/YourApp/Reticulator.pm ./lib/YourApp/Util/mtfnpy.pm ./lib/YourApp/Xyzzy.pm ./t/unit-tests.t ./t/pod-coverage.t ./t/pod.t

./t/pod-coverage.t ./t/pod.t ./Changes

./t/pod-coverage.t ./t/pod.t ./Changes ./lib/YourApp.pm

./t/pod-coverage.t ./t/pod.t ./Changes ./lib/YourApp.pm ./lib/YourApp/Reticulator.pm

./t/pod-coverage.t ./t/pod.t ./Changes ./lib/YourApp.pm ./lib/YourApp/Reticulator.pm ./lib/YourApp/Util/mtfnpy.pm

./t/pod-coverage.t ./t/pod.t ./Changes ./lib/YourApp.pm ./lib/YourApp/Reticulator.pm ./lib/YourApp/Util/mtfnpy.pm ./lib/YourApp/Xyzzy.pm

- updating version numbers

- updating version numbers - uploading to CPAN

- updating version numbers - uploading to CPAN - committing,
tagging releases in Git (VCS)

tagging releases in Git (VCS) - determine prerequisites

tagging releases in Git (VCS) - determine prerequisites - other stuff that is totally boring

Dist::Zilla is AWESOME

- eating cake and pie (and donuts)

- eating cake and pie (and donuts) - drinking cocktails
and beer

and beer - shooting zombies

and beer - shooting zombies - giving away useful software

Dist::Zilla is HUGE

106 prereqs

106 prereqs (and counting)

- Dist::Zilla only handles “make dist”

- Dist::Zilla only handles “make dist” - it doesn’t handle
“make install”

“make install” - only authors need to install the 106 prereqs

“make install” - only authors need to install the 106 prereqs - your users don’t see Dist::Zilla

“make install” - only authors need to install the 106 prereqs - your users don’t see Dist::Zilla - they just see MakeMaker or Module::Build

Dist::Zilla is also Stupid

It keeps its brains in plugins.

dist.ini

# How Dist::Zilla builds a dist: prepare; gather_files; prune_files; munge_files;
register_prereqs; setup_installer; write_files; finish; name = Your-Dist license = Perl_5 copyright_holder = J. Fred Bloggs [GatherDir] include_dotfiles = 1 [PruneCruft] [MetaYAML] [MakeMaker] [TestRelease] [ConfirmRelease] [UploadToCPAN] user = JFB password = QwardRules

name = Dist-Zilla author = Ricardo SIGNES <[email protected]> license =
Perl_5 copyright_holder = Ricardo SIGNES [@Basic] [AutoPrereq] [AutoVersion] [PkgVersion] [MetaConfig] [MetaJSON] [NextRelease] [PodSyntaxTests] [Repository] [PodWeaver] [@Git]

[GatherDir] [PruneCruft] [ManifestSkip] [MetaYAML] [License] [Readme] [ExtraTests] [ExecDir] [ShareDir] [MakeMaker]
[Manifest] [TestRelease] [ConfirmRelease] [UploadToCPAN]

name = Dist-Zilla author = Ricardo SIGNES <[email protected]> license =
Perl_5 copyright_holder = Ricardo SIGNES [@Basic] [AutoPrereq] [AutoVersion] [PkgVersion] [MetaConfig] [MetaJSON] [NextRelease] [PodSyntaxTests] [Repository] [PodWeaver] [@Git]

Too much!

dzil build

dzil build dzil test

dzil build dzil test dzil install

dzil build dzil test dzil install dzil release

How Dist::Zilla Builds

sub build { How Dist::Zilla Builds

sub build { my ($self) = @_; How Dist::Zilla Builds

sub build { my ($self) = @_; my @files =
$self->gather_files; How Dist::Zilla Builds

$self->gather_files; $self->munge_files( @files ); How Dist::Zilla Builds

$self->gather_files; $self->munge_files( @files ); $self->collect_metadata; How Dist::Zilla Builds

$self->gather_files; $self->munge_files( @files ); $self->collect_metadata; $self->write_out( @files ); How Dist::Zilla Builds

$self->gather_files; $self->munge_files( @files ); $self->collect_metadata; $self->write_out( @files ); } How Dist::Zilla Builds

How do you pick plugins?

There is no default config.

@Basic

[GatherDir] [PruneCruft] [Manifest] [ManifestSkip] [MakeMaker] [License] [Readme] [MetaYAML] [ExtraTests] [ExecDir]
[ShareDir] [TestRelease] [ConfirmRelease] [UploadToCPAN] The Basics

[ShareDir] [TestRelease] [ConfirmRelease] [UploadToCPAN] MANIFEST The Basics

[ShareDir] [TestRelease] [ConfirmRelease] [UploadToCPAN] MANIFEST Makefile.PL The Basics

[ShareDir] [TestRelease] [ConfirmRelease] [UploadToCPAN] MANIFEST Makefile.PL LICENSE The Basics

[ShareDir] [TestRelease] [ConfirmRelease] [UploadToCPAN] MANIFEST Makefile.PL LICENSE README The Basics

[ShareDir] [TestRelease] [ConfirmRelease] [UploadToCPAN] MANIFEST Makefile.PL LICENSE README META.yml The Basics

Cruft Minimizers

[PkgVersion] Cruft Minimizers

[PkgVersion] [PodSyntaxTests] Cruft Minimizers

[PkgVersion] [PodSyntaxTests] [PodCoverageTests] Cruft Minimizers

[PkgVersion] [PodSyntaxTests] [PodCoverageTests] [AutoPrereq] Cruft Minimizers

[PkgVersion] [PodSyntaxTests] [PodCoverageTests] [AutoPrereq] [AutoVersion] Cruft Minimizers

[PkgVersion] [PodSyntaxTests] [PodCoverageTests] [AutoPrereq] [AutoVersion] [NextRelease] Cruft Minimizers

[@Git] [@Subversion] [@Mercurial] [@SVK] Version Control

Pod::Weaver

package YourApp; =head1 NAME YourApp - my awesome app =head1
VERSION version 1.001 =cut our $VERSION = 0.001; =head1 DESCRIPTION This app is awesome. =head1 METHODS =head2 this_method This method does stuff. =cut method this_method { ... } =head2 that_method Also stuff. =cut method that_method { ... } =head1 AUTHOR Margo Yapp <[email protected]> =head1 LICENSE Copyright (C) 2008, Margo Yapp. This is distributed under the terms of the accidental death and dismemberment license and if you redistribuet this document you will be “accidentally” deathed or dismembered. You have been told. =cut 1;

package YourApp; # ABSTRACT: my awesome app =head1 VERSION version
1.001 =cut our $VERSION = 0.001; =head1 DESCRIPTION This app is awesome. =head1 METHODS =head2 this_method This method does stuff. =cut method this_method { ... } =head2 that_method Also stuff. =cut method that_method { ... } =head1 AUTHOR Margo Yapp <[email protected]> =head1 LICENSE Copyright (C) 2008, Margo Yapp. This is distributed under the terms of the accidental death and dismemberment license and if you redistribuet this document you will be “accidentally” deathed or dismembered. You have been told. =cut 1;

package YourApp; # ABSTRACT: my awesome app our $VERSION =
0.001; =head1 DESCRIPTION This app is awesome. =head1 METHODS =head2 this_method This method does stuff. =cut method this_method { ... } =head2 that_method Also stuff. =cut method that_method { ... } =head1 AUTHOR Margo Yapp <[email protected]> =head1 LICENSE Copyright (C) 2008, Margo Yapp. This is distributed under the terms of the accidental death and dismemberment license and if you redistribuet this document you will be “accidentally” deathed or dismembered. You have been told. =cut 1;

package YourApp; # ABSTRACT: my awesome app =head1 DESCRIPTION This
app is awesome. =head1 METHODS =head2 this_method This method does stuff. =cut method this_method { ... } =head2 that_method Also stuff. =cut method that_method { ... } =head1 AUTHOR Margo Yapp <[email protected]> =head1 LICENSE Copyright (C) 2008, Margo Yapp. This is distributed under the terms of the accidental death and dismemberment license and if you redistribuet this document you will be “accidentally” deathed or dismembered. You have been told. =cut 1;

app is awesome. =method this_method This method does stuff. =cut method this_method { ... } =method that_method Also stuff. =cut method that_method { ... } =head1 AUTHOR Margo Yapp <[email protected]> =head1 LICENSE Copyright (C) 2008, Margo Yapp. This is distributed under the terms of the accidental death and dismemberment license and if you redistribuet this document you will be “accidentally” deathed or dismembered. You have been told. =cut 1;

app is awesome. =method this_method This method does stuff. =cut method this_method { ... } =method that_method Also stuff. =cut method that_method { ... } =head1 LICENSE Copyright (C) 2008, Margo Yapp. This is distributed under the terms of the accidental death and dismemberment license and if you redistribuet this document you will be “accidentally” deathed or dismembered. You have been told. =cut 1;

app is awesome. =method this_method This method does stuff. =cut method this_method { ... } =method that_method Also stuff. method that_method { ... } =head1 LICENSE Copyright (C) 2008, Margo Yapp. This is distributed under the terms of the accidental death and dismemberment license and if you redistribuet this document you will be “accidentally” deathed or dismembered. You have been told. =cut 1;

app is awesome. =method this_method This method does stuff. =cut method this_method { ... } =method that_method Also stuff. =cut method that_method { ... } =cut 1;

app is awesome. =method this_method This method does stuff. =cut method this_method { ... } =method that_method Also stuff. =cut method that_method { ... } 1;

[PodWeaver]

Converting Your Dist

Converting Your Dist - create dist.ini

Converting Your Dist - create dist.ini - remove a bunch
of files

of files - delete a bunch of stuff from leftover files

of files - delete a bunch of stuff from leftover files - and Dist::Zooky, too

Questions so far?

Creating New Dists

dzil build dzil test dzil install dzil release

dzil build dzil test dzil install dzil release dzil new

profile.ini

[GatherDir::Template]

[GatherDir::Template] root = files

[GatherDir::Template] root = files [DistINI]

[GatherDir::Template] root = files [DistINI] [Git::Init]

How Dist::Zilla Mints

sub mint { How Dist::Zilla Mints

sub mint { my ($self) = @_; How Dist::Zilla Mints

sub mint { my ($self) = @_; my @files =
$self->gather_files; How Dist::Zilla Mints

$self->gather_files; $self->munge_files( @files ); How Dist::Zilla Mints

$self->gather_files; $self->munge_files( @files ); $self->make_module( $module ); How Dist::Zilla Mints

$self->gather_files; $self->munge_files( @files ); $self->make_module( $module ); $self->write_out( @files ); How Dist::Zilla Mints

$self->gather_files; $self->munge_files( @files ); $self->make_module( $module ); $self->write_out( @files ); } How Dist::Zilla Mints

[GatherDir::Template]

[GatherDir::Template] root = files

[GatherDir::Template] root = files [DistINI]

[GatherDir::Template] root = files [DistINI] [Git::Init]

config.ini

~/.dzil/config.ini

[%User] name = Ricardo Signes email = [email protected] [%Rights] license_class
= Perl_5 copyright_holder = Ricardo Signes [%PAUSE] username = RJBS password = PeasAreDelicious

dzil setup

Minting a New Dist - create config.ini (in ~/.dzil) -
maybe configure or install a profile - run dzil new

Questions so far?

Writing Plugins!

Writing Plugins is Easy!

Writing Plugins is Easy! (and awesome)

$self->gather_files; $self->munge_files( @files ); $self->collect_metadata; $self->write_out( @files ); } How Dist::Zilla Builds

$self->munge_files( @files ); How Dist::Zilla Builds

my @mungers = grep { $_->does(‘FileMunger’) } $self->plugins; for my
$plugin (@mungers) { $plugin->munge_files( @files ); } How Dist::Zilla Builds

package Some::Class; use Moose; with ‘Some::Role’; $obj->does( $role )

Roles to Make Plugins Go

BeforeBuild Roles to Make Plugins Go

BeforeBuild FileGatherer Roles to Make Plugins Go

BeforeBuild FileGatherer FilePruner Roles to Make Plugins Go

BeforeBuild FileGatherer FilePruner FileMunger Roles to Make Plugins Go

BeforeBuild FileGatherer FilePruner FileMunger PrereqSource Roles to Make Plugins Go

BeforeBuild FileGatherer FilePruner FileMunger PrereqSource MetaProvider Roles to Make Plugins
Go

BeforeBuild FileGatherer FilePruner FileMunger PrereqSource MetaProvider AfterBuild Roles to Make
Plugins Go

BeforeBuild FileGatherer FilePruner FileMunger PrereqSource MetaProvider AfterBuild BeforeArchive Roles to
Make Plugins Go

BeforeBuild FileGatherer FilePruner FileMunger PrereqSource MetaProvider AfterBuild BeforeArchive BeforeRelease Roles
to Make Plugins Go

BeforeBuild FileGatherer FilePruner FileMunger PrereqSource MetaProvider AfterBuild BeforeArchive BeforeRelease Releaser
Roles to Make Plugins Go

BeforeBuild FileGatherer FilePruner FileMunger PrereqSource MetaProvider AfterBuild BeforeArchive BeforeRelease Releaser
AfterRelease Roles to Make Plugins Go

Let’s write a plugin!

BuiltOn

package Dist::Zilla::Plugin::BuiltOn; BuiltOn

package Dist::Zilla::Plugin::BuiltOn; use Moose; BuiltOn

package Dist::Zilla::Plugin::BuiltOn; use Moose; with ‘Dist::Zilla::Role::FileGatherer’; BuiltOn

package Dist::Zilla::Plugin::BuiltOn; use Moose; with ‘Dist::Zilla::Role::FileGatherer’; sub gather_files { BuiltOn

package Dist::Zilla::Plugin::BuiltOn; use Moose; with ‘Dist::Zilla::Role::FileGatherer’; sub gather_files { my
($self) = @_; BuiltOn

($self) = @_; my $file = Dist::Zilla::File::InMemory->new({ BuiltOn

($self) = @_; my $file = Dist::Zilla::File::InMemory->new({ name => ‘built-on.txt’, BuiltOn

($self) = @_; my $file = Dist::Zilla::File::InMemory->new({ name => ‘built-on.txt’, content => scalar `uname -a`, BuiltOn

($self) = @_; my $file = Dist::Zilla::File::InMemory->new({ name => ‘built-on.txt’, content => scalar `uname -a`, }); BuiltOn

($self) = @_; my $file = Dist::Zilla::File::InMemory->new({ name => ‘built-on.txt’, content => scalar `uname -a`, }); $self->add_file( $file ); BuiltOn

($self) = @_; my $file = Dist::Zilla::File::InMemory->new({ name => ‘built-on.txt’, content => scalar `uname -a`, }); $self->add_file( $file ); } BuiltOn

[BuiltOn] BuiltOn

package Dist::Zilla::Plugin::BuiltOn; use Moose; with ‘Dist::Zilla::Role::FileGatherer’; has filename => (
is => ‘ro’, default => ‘built-on.txt’, ); sub gather_files { my ($self) = @_; my $file = Dist::Zilla::File::InMemory->new({ name => $self->filename, content => scalar `uname -a`, }); $self->add_file( $file ); }

[BuiltOn] filename = build-host.txt BuiltOn

[BuiltOn] BuiltOn

Let’s write a another!

AddShebangs

package Dist::Zilla::Plugin::AddShebangs; AddShebangs

package Dist::Zilla::Plugin::AddShebangs; use Moose; AddShebangs

package Dist::Zilla::Plugin::AddShebangs; use Moose; with ‘Dist::Zilla::Role::FileMunger’; AddShebangs

package Dist::Zilla::Plugin::AddShebangs; use Moose; with ‘Dist::Zilla::Role::FileMunger’; sub munge_file { AddShebangs

package Dist::Zilla::Plugin::AddShebangs; use Moose; with ‘Dist::Zilla::Role::FileMunger’; sub munge_file { my
($self, $file) = @_; AddShebangs

($self, $file) = @_; next unless $file->name =~ /\.pl$/; AddShebangs

($self, $file) = @_; next unless $file->name =~ /\.pl$/; my $content = “#!$^X\n” AddShebangs

($self, $file) = @_; next unless $file->name =~ /\.pl$/; my $content = “#!$^X\n” . $file->content; AddShebangs

($self, $file) = @_; next unless $file->name =~ /\.pl$/; my $content = “#!$^X\n” . $file->content; $file->content( $content ); AddShebangs

($self, $file) = @_; next unless $file->name =~ /\.pl$/; my $content = “#!$^X\n” . $file->content; $file->content( $content ); } AddShebangs

AddBlame

package Dist::Zilla::Plugin::AddBlame; AddBlame

package Dist::Zilla::Plugin::AddBlame; use Moose; AddBlame

package Dist::Zilla::Plugin::AddBlame; use Moose; with ‘Dist::Zilla::Role::FileMunger’; AddBlame

package Dist::Zilla::Plugin::AddBlame; use Moose; with ‘Dist::Zilla::Role::FileMunger’; sub munge_file { AddBlame

package Dist::Zilla::Plugin::AddBlame; use Moose; with ‘Dist::Zilla::Role::FileMunger’; sub munge_file { my
($self, $file) = @_; AddBlame

($self, $file) = @_; next unless $file->name =~ /\.p[lm]$/; AddBlame

($self, $file) = @_; next unless $file->name =~ /\.p[lm]$/; my $content = “# BUILD BY $ENV{USER}\n” AddBlame

($self, $file) = @_; next unless $file->name =~ /\.p[lm]$/; my $content = “# BUILD BY $ENV{USER}\n” . $file->content; AddBlame

($self, $file) = @_; next unless $file->name =~ /\.p[lm]$/; my $content = “# BUILD BY $ENV{USER}\n” . $file->content; $file->content( $content ); AddBlame

($self, $file) = @_; next unless $file->name =~ /\.p[lm]$/; my $content = “# BUILD BY $ENV{USER}\n” . $file->content; $file->content( $content ); } AddBlame

[GatherDir] [PruneCruft]

[GatherDir] [PruneCruft] [AddShebangs] [AddBlame]

[GatherDir] [PruneCruft] [AddShebangs] [AddBlame] print “Hello.\n”;

[GatherDir] [PruneCruft] [AddShebangs] [AddBlame] #!/usr/bin/perl print “Hello.\n”;

[GatherDir] [PruneCruft] [AddShebangs] [AddBlame] # built by rjbs #!/usr/bin/perl print
“Hello.\n”;

[GatherDir] [PruneCruft] [AddBlame] [AddShebangs] #!/usr/bin/perl # built by rjbs print
“Hello.\n”;

In Conclusion...

Dist::Zilla is..?

Dist::Zilla is: - judges will accept: - awesome - huge
- stupid

We are Friendly - irc.perl.org #distzilla - http://dzil.org/ - mailing
list - http://rt.cpan.org/

Any Questions?

Thank you! raaaaaaaaar!

Dist::Zilla — raaaaaaaaar!

Dist::Zilla — raaaaaaaaar!

More Decks by Ricardo Signes

Other Decks in Programming

Featured

Transcript