Api Design

API Design Shawn M Moore Best Practical Solutions http://sartak.org

Google API

CC-BY-SA Yuval Kogman, 2006

CC-BY-SA Hans Dieter Pearcey, 2009

Moose Path::Dispatcher HTTP::Engine Dist::Zilla IM::Engine API

CC-BY-SA-NC Will Spaetzel, 2005

THE SECRET

THE WRITE TESTS

WRITE TESTS WRITEWRITE TESTSTESTS WRITEWRITE TESTSTESTS

DO THIS WRITE WRITE RITE WRITE WRITE W WRITE WRITE WRI WRITE WRI TE WRITE TE WRITE WRIT E WR ITE

Test! use base 'Class::Accessor::Fast'; __PACKAGE__->mk_ro_accessors('birthday'); use Moose; has birthday => (is => 'ro'); API

Moose package Point; use Moose; has x => ( is => 'ro', isa => 'Num', ); Moose

Metaobject Protocol Class::MOP Moose Class::MOP

Metaobject Protocol has cache => ( is => 'ro', );

Metaobject Protocol has cache => ( is => 'ro', ); Moose::Meta::Attribute has Moose::Meta::Attribute

Metaobject Protocol has cache => ( is => 'ro', ); Moose::Meta::Method::Accessor cache

Metaobject Protocol class PersistentAttr extends Moose::Meta::Attribute { … } has cache => ( metaclass => 'PersistentAttr', is => 'ro', ); Moose

Metaobject Protocol role PersistentAttr { … } has cache => ( traits => ['PersistentAttr'], is => 'ro', );

Moose X MooseX MOP

Sugar Layer Moose

Sugar Layer my $class = get_class();

Sugar Layer my $class = get_class(); $class->has( birthday => ( is => 'ro', ) ); has

Sugar Layer my $class = get_class(); no strict 'refs'; *{$class.'::has'}->( birthday => ( is => 'ro', ) ); has

Sugar Layer my $class = get_class(); no strict 'refs'; *{$class.'::has'}->( birthday => ( is => 'ro', ) );

Sugar Layer Class::MOP::Class ->initialize($class) ->add_attribute( $name, %options); has add_attribute

Sugar Layer my $class = get_class(); $class->meta->add_attribute( birthday => ( is => 'ro', ) );

Sugar Layer use MooseX::Declare; class Point3D extends Point { has z => (…); after clear { $self->z(0); } }

Path::Dispatcher use Path::Dispatcher::Declarative -base; on ['wield', qr/^w+$/] => sub { wield_weapon($2); } under display => sub { on inventory => sub { show_inventory }; on score => sub { show_score }; }; YourDispatcher->run('display score'); Jifty::Dispatcher Prophet

Path::Dispatcher::Declar use Sub::Exporter -setup => { exports => [ on => &build_on, under => &build_under, …, ], }; Sub::Exporter

Path::Dispatcher::Declar use Sub::Exporter -setup => { exports => [ on => &build_on, under => &build_under, …, ], };

Path::Dispatcher::Builder Robert Krimen "grink" Robert Krimen

Path::Dispatcher::Builder return { on => sub { $builder->on(@_) }, under => sub { $builder->under(@_) }, …, };

grink++ OO

HTTP::Engine HTTP::Engine->new( interface => { module => 'ServerSimple', args => { … }, request_handler => sub { … }, }, )->run; HTTP::Engine

HTTP::Engine HTTP::Engine->new( interface => { module => 'ModPerl', args => { … }, request_handler => sub { … }, }, )->run; mod_perl

HTTP::Engine HTTP::Engine->new( interface => { module => 'FCGI', args => { … }, request_handler => sub { … }, }, )->run; FastCGI

HTTP::Engine request_handler => sub { my $request = shift; return $response; } HTTP::Engine IO

HTTP::Engine request_handler => sub { my $request = shift; return $response; } HTTP::Engine OK

HTTP::Engine request_handler => sub { my $request = shift; return $response; }

HTTP::Engine++ 1

Dist::Zilla AllFiles ExtraTests InstallDirs License MakeMaker Manifest ManifestSkip MetaYAML PkgVersion PodTests PodVersion PruneCruft Readme UploadToCPAN

Dist::Zilla AllFiles ExtraTests InstallDirs License $_->gather_ﬁles MakeMaker for Manifest $self->plugins_with( ManifestSkip -FileGatherer MetaYAML PkgVersion ); PodTests PodVersion PruneCruft Readme UploadToCPAN Dist::Zilla

Dist::Zilla AllFiles ExtraTests InstallDirs License $_->gather_ﬁles MakeMaker for Manifest $self->plugins_with( ManifestSkip -FileGatherer MetaYAML PkgVersion ); PodTests PodVersion PruneCruft Readme UploadToCPAN plugins_with

Dist::Zilla AllFiles ExtraTests InstallDirs License $_->gather_ﬁles MakeMaker for Manifest $self->plugins_with( ManifestSkip -FileGatherer MetaYAML PkgVersion ); PodTests PodVersion PruneCruft Readme UploadToCPAN

Dist::Zilla AllFiles ExtraTests InstallDirs License $_->gather_ﬁles MakeMaker for Manifest $self->plugins_with( ManifestSkip -FileGatherer MetaYAML PkgVersion ); PodTests PodVersion PruneCruft Readme UploadToCPAN gather_ﬁles

Dist::Zilla AllFiles ExtraTests InstallDirs License $_->munge_ﬁles MakeMaker for Manifest $self->plugins_with( ManifestSkip -FileMunger MetaYAML PkgVersion ); PodTests PodVersion PruneCruft Readme UploadToCPAN Dist::Zilla

Request Tracker User/Prefs.html $m->callback( CallbackName => 'FormEnd', UserObj => $UserObj, …, ); RT

Request Tracker User/Prefs.html $m->callback( CallbackName => 'FormEnd', UserObj => $UserObj, …, );

Request Tracker User/Prefs.html $m->callback( CallbackName => 'FormEnd', UserObj => $UserObj, …, ); FormEnd

Request Tracker User/Prefs.html $m->callback( CallbackName => 'FormEnd', UserObj => $UserObj, …, );

Request Tracker commit 4c05a6835eef112701ac58dfd1b133e220059d4f Author: Jesse Vincent <jesse@bestpractical.com> Date: Fri Dec 27 18:50:06 2002 -0500 Attempting mason callouts Ticket/Update.html <& /Elements/Callback, Name => 'BeforeTextarea', %ARGS &> 7

Dist::Zilla Choice ModuleBuild or MakeMaker MetaYAML or MetaJSON

Dist::Zilla Extensibility Dist::Zilla::Plugin::CriticTests Dist::Zilla::Plugin::Repository Dist::Zilla::Plugin::PerlTidy

Dist::Zilla Extensibility Dist::Zilla::Plugin::CriticTests InlineFiles Dist::Zilla::Plugin::Repository MetaProvider Dist::Zilla::Plugin::PerlTidy FileMunger

Dist::Zilla Extensibility Dist::Zilla::Plugin::BPS::Secret

IM::Engine incoming_callback => sub { my $incoming = shift; my $message = $incoming->plaintext; $message =~ tr[a-zA-Z][n-za-mN-ZA-M]; return $incoming->reply($message); } IM::Engine

IM::Engine $self->plugin_collect( role => 'ExtendsObject::User', method => 'traits', ); plugin_collect

IM::Engine $self->plugin_collect( role => 'ExtendsObject::User', method => 'traits', );

IM::Engine $self->plugin_collect( role => 'ExtendsObject::User', method => 'traits', ); traits

IM::Engine my @all_traits = $self->plugin_collect( role => 'ExtendsObject::User', method => 'traits', );

method plugin_collect { my @items; $self->each_plugin( callback => sub { push @items, shift->$method }, ); return @items; } plugin_collect

IM::Engine method new_with_plugins { my %args = ( $self->plugin_collect( role => …, method => 'ctor_args', ), @_, ); $self->new(%args); }

IM::Engine push @{ $args{traits} }, $self->plugin_collect( role => …, method => 'traits', ); $self->new_with_traits(%args);

MooseX::Traits $object = Class->new_with_traits( traits => ['Counter'], ); $other = Class->new; $object->counter; # 0 $other->counter; # Can't locate... new_with_traits MooseX::Traits

MooseX::Traits $object = Class->new_with_traits( traits => ['Counter'], ); $other = Class->new; $object->counter; # 0 $other->counter; # Can't locate...

Role = Trait Moose Role Trait

Moose Path::Dispatcher HTTP::Engine Dist::Zilla IM::Engine

Moose Extensibility Separation of sugar Dist::Zilla IM::Engine Moose

Moose Path::Dispatcher OO sugar layer Dist::Zilla IM::Engine OO

Moose Path::Dispatcher HTTP::Engine Omit inconsequential details IM::Engine

Moose Path::Dispatcher HTTP::Engine Dist::Zilla Explicit pluggability

Moose Path::Dispatcher HTTP::Engine Dist::Zilla IM::Engine Extreme pluggability DRY IM::Engine DRY

WRITEMoose Path::Dispatcher HTTP::Engine TESTS!!! Dist::Zilla IM::Engine

Moose Path::Dispatcher HTTP::Engine Dist::Zilla IM::Engine

Thanks to my Kenichi Ishigaki 83

Api Design

by sartak

Accessibility

Categories

Upload Details

Usage Rights

1 Embed 3

Statistics

Api Design Presentation Transcript

Api Design

by sartak

Accessibility

Categories

Upload Details

Usage Rights

1 Embed 3

Statistics

Api Design Presentation Transcript

Let LinkedIn power your SlideShare experience

Let LinkedIn power your SlideShare experience

Customize SlideShare content based on your interests

Keep up to date when your LinkedIn contacts post on SlideShare