Port ::Replicated from Moose to Moo+Type::Tiny

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI / Replicated / Balancer.pm

diff --git a/lib/DBIx/Class/Storage/DBI/Replicated/Balancer.pm b/lib/DBIx/Class/Storage/DBI/Replicated/Balancer.pm
index 279ad51..8226ff7 100644 (file)
--- a/lib/DBIx/Class/Storage/DBI/Replicated/Balancer.pm
+++ b/lib/DBIx/Class/Storage/DBI/Replicated/Balancer.pm
@@ -1,15 +1,17 @@
 package DBIx::Class::Storage::DBI::Replicated::Balancer;
 
-use Moose::Role;
+use Moo::Role;
 requires 'next_storage';
-use MooseX::Types::Moose qw/Int/;
+use Types::Standard qw/Int/;
+use Type::Utils qw/class_type/;
+use Scalar::Util qw/blessed/;
 use DBIx::Class::Storage::DBI::Replicated::Pool;
 use DBIx::Class::Storage::DBI::Replicated::Types qw/DBICStorageDBI/;
-use namespace::clean -except => 'meta';
+use namespace::clean;
 
 =head1 NAME
 
-DBIx::Class::Storage::DBI::Replicated::Balancer - A Software Load Balancer 
+DBIx::Class::Storage::DBI::Replicated::Balancer - A Software Load Balancer
 
 =head1 SYNOPSIS
 
@@ -27,9 +29,10 @@ This class defines the following attributes.
 
 =head2 auto_validate_every ($seconds)
 
-If auto_validate has some sort of value, run the L<validate_replicants> every
-$seconds.  Be careful with this, because if you set it to 0 you will end up
-validating every query.
+If auto_validate has some sort of value, run
+L<DBIx::Class::Storage::DBI::Replicated::Pool/validate_replicants>
+every $seconds.  Be careful with this, because if you set it to 0 you
+will end up validating every query.
 
 =cut
 
@@ -62,7 +65,7 @@ balance.
 
 has 'pool' => (
   is=>'ro',
-  isa=>'DBIx::Class::Storage::DBI::Replicated::Pool',
+  isa=>class_type('DBIx::Class::Storage::DBI::Replicated::Pool'),
   required=>1,
 );
 
@@ -70,7 +73,7 @@ has 'pool' => (
 
 Replicant storages (slaves) handle all read only traffic.  The assumption is
 that your database will become readbound well before it becomes write bound
-and that being able to spread your read only traffic around to multiple 
+and that being able to spread your read only traffic around to multiple
 databases is going to help you to scale traffic.
 
 This attribute returns the next slave to handle a read request.  Your L</pool>
@@ -82,7 +85,10 @@ via its balancer object.
 has 'current_replicant' => (
   is=> 'rw',
   isa=>DBICStorageDBI,
-  lazy_build=>1,
+  lazy=>1,
+  builder=>1,
+  predicate=>1,
+  clearer=>1,
   handles=>[qw/
     select
     select_single
@@ -96,7 +102,7 @@ This class defines the following methods.
 
 =head2 _build_current_replicant
 
-Lazy builder for the L</current_replicant_storage> attribute.
+Lazy builder for the L</current_replicant> attribute.
 
 =cut
 
@@ -110,8 +116,8 @@ sub _build_current_replicant {
 This method should be defined in the class which consumes this role.
 
 Given a pool object, return the next replicant that will serve queries.  The
-default behavior is to grab the first replicant it finds but you can write 
-your own subclasses of L<DBIx::Class::Storage::DBI::Replicated::Balancer> to 
+default behavior is to grab the first replicant it finds but you can write
+your own subclasses of L<DBIx::Class::Storage::DBI::Replicated::Balancer> to
 support other balance systems.
 
 This returns from the pool of active replicants.  If there are no active
@@ -123,7 +129,7 @@ Advice on next storage to add the autovalidation.  We have this broken out so
 that it's easier to break out the auto validation into a role.
 
 This also returns the master in the case that none of the replicants are active
-or just just forgot to create them :)
+or just forgot to create them :)
 
 =cut
 
@@ -135,9 +141,9 @@ around 'next_storage' => sub {
 
   ## Do we need to validate the replicants?
   if(
-     $self->has_auto_validate_every && 
+     $self->has_auto_validate_every &&
      ($self->auto_validate_every + $self->pool->last_validated) <= $now
-  ) {   
+  ) {
       $self->pool->validate_replicants;
   }
 
@@ -179,7 +185,7 @@ around 'select' => sub {
 
   if (my $forced_pool = $args[-1]->{force_pool}) {
     delete $args[-1]->{force_pool};
-    return $self->_get_forced_pool($forced_pool)->select(@args); 
+    return $self->_get_forced_pool($forced_pool)->select(@args);
   } elsif($self->master->{transaction_depth}) {
     return $self->master->select(@args);
   } else {
@@ -201,7 +207,7 @@ around 'select_single' => sub {
 
   if (my $forced_pool = $args[-1]->{force_pool}) {
     delete $args[-1]->{force_pool};
-    return $self->_get_forced_pool($forced_pool)->select_single(@args); 
+    return $self->_get_forced_pool($forced_pool)->select_single(@args);
   } elsif($self->master->{transaction_depth}) {
     return $self->master->select_single(@args);
   } else {
@@ -238,17 +244,20 @@ sub _get_forced_pool {
   } elsif(my $replicant = $self->pool->replicants->{$forced_pool}) {
     return $replicant;
   } else {
-    $self->master->throw_exception("$forced_pool is not a named replicant.");
-  }   
+    $self->master->throw_exception("'$forced_pool' is not a named replicant.");
+  }
 }
 
-=head1 AUTHOR
+=head1 FURTHER QUESTIONS?
 
-John Napiorkowski <jjnapiork@cpan.org>
+Check the list of L<additional DBIC resources|DBIx::Class/GETTING HELP/SUPPORT>.
 
-=head1 LICENSE
+=head1 COPYRIGHT AND LICENSE
 
-You may distribute this code under the same terms as Perl itself.
+This module is free software L<copyright|DBIx::Class/COPYRIGHT AND LICENSE>
+by the L<DBIx::Class (DBIC) authors|DBIx::Class/AUTHORS>. You can
+redistribute it and/or modify it under the same terms as the
+L<DBIx::Class library|DBIx::Class/COPYRIGHT AND LICENSE>.
 
 =cut