clean up and add NAME sections

[gitmo/Moo.git] / lib / Sub / Defer.pm

diff --git a/lib/Sub/Defer.pm b/lib/Sub/Defer.pm
index 50688c5..7a41e8f 100644 (file)
--- a/lib/Sub/Defer.pm
+++ b/lib/Sub/Defer.pm
@@ -25,9 +25,9 @@ sub defer_sub {
   my ($target, $maker) = @_;
   my $undeferred;
   my $deferred_string;
-  my $deferred = bless(sub {
+  my $deferred = sub {
     goto &{$undeferred ||= undefer_sub($deferred_string)};
-  }, 'Sub::Defer::Deferred');
+  };
   $deferred_string = "$deferred";
   $DEFERRED{$deferred} = [ $target, $maker, \$undeferred ];
   *{_getglob $target} = $deferred if defined($target);
@@ -35,3 +35,48 @@ sub defer_sub {
 }
 
 1;
+
+=pod
+
+=head1 NAME
+
+Sub::Defer - defer generation of subroutines until they are first called
+
+=head1 SYNOPSIS
+
+ use Sub::Defer;
+
+ my $deferred = defer_sub 'Logger::time_since_first_log' => sub {
+    my $t = time;
+    sub { time - $t };
+ };
+
+  Logger->time_since_first_log; # returns 0 and replaces itself
+  Logger->time_since_first_log; # returns time - $t
+
+=head1 DESCRIPTION
+
+These subroutines provide the user with a convenient way to defer creation of
+subroutines and methods until they are first called.
+
+=head1 SUBROUTINES
+
+=head2 defer_sub
+
+ my $coderef = defer_sub $name => sub { ... };
+
+This subroutine returns a coderef that encapsulates the provided sub - when
+it is first called, the provided sub is called and is -itself- expected to
+return a subroutine which will be goto'ed to on subsequent calls.
+
+If a name is provided, this also installs the sub as that name - and when
+the subroutine is undeferred will re-install the final version for speed.
+
+=head2 undefer_sub
+
+ my $coderef = undefer_sub \&Foo::name;
+
+If the passed coderef has been L<deferred|/defer_sub> this will "undefer" it.
+If the passed coderef has not been deferred, this will just return it.
+
+If this is confusing, take a look at the example in the L</SYNOPSIS>.