Changeset 2101 for lang/perl/Class-Hookable

Timestamp:

11/28/07 13:13:20 (14 months ago)

Author:

nyarla

Message:

lang/perl/Class-Hookable: I rewrote register_hook and run_hook so that hookable_call_filter might be used.

Location:

lang/perl/Class-Hookable/trunk

Files:

• Changes (modified) (1 diff)
• lib/Class/Hookable.pm (modified) (10 diffs)
• t/02_register/00_register_hook.t (modified) (2 diffs)
• t/04_call/00_run_hook.t (modified) (2 diffs)

lang/perl/Class-Hookable/trunk/Changes

@@ -3 +3 @@
 0.03 
         * Substantial change *
-        * renamed method
-          context -> hookable_context
-        * added new method
-          hookable_stash        : stash in Class::Hookable.
-          hookable_set_filter   :
+        * Change in the filtering of plugin
+          It was changed substantially about a way of filtering of a plugin.        
+          It was possible to rewrite a filter only by inheriting of Class::Hookable before,
+          but this change could change it now every instance.
+          The previous filter_register_hook and filter_run_hook method
+          weren't used any more by this change.
+          added methods:
+            hookable_set_filter
+            hookable_call_filter
+            hookable_filter_prefix
 
 0.02  Wed Nov 11 13:00:00 JST 2007

lang/perl/Class-Hookable/trunk/lib/Class/Hookable.pm

@@ -112 +112 @@
         };
 
-        if ( $self->filter_register_hook( $hook, $action ) ) {
+        if ( $self->hookable_call_filter( 'register_hook', $hook, $action ) ) {
             $self->hooks->{$hook} = []
                 if ( ref $self->hooks->{$hook} ne 'ARRAY' );
@@ -120 +120 @@
     }
 }
-
-sub filter_register_hook { 1 }
 
 sub registered_hooks {
@@ -218 +216 @@
 
     for my $action ( $self->registered_plugins( $hook ) ) {
-        if ( $self->filter_run_hook( $hook, $args, $action ) ) {
+        if ( $self->hookable_call_filter( 'run_hook', $hook, $args, $action ) ) {
             my $plugin = $action->{'plugin'};
             my $result = $action->{'callback'}->( $plugin, $context, $args );
@@ -239 +237 @@
     return $self->run_hook( $hook, $args, 1, $callback );
 }
-
-sub filter_run_hook { 1 }
 
 1;
@@ -271 +267 @@
 I thank Tatsuhiko Miyagawa and Plagger contributors.
 
-B<NOTE>:
-
-B<I made substantial changes in Class::Hookable> from 0.02 to 0.03.
-
-When using Class::Hookable, B<please be careful of Class::Hookable version>.
-
 =head1 BASIC METHOD
 
@@ -310 +300 @@
 the subroutine registered with hook and method.
 
-see also L<"run_hook"> and L<"call_method">.
+see also L<"run_hook">.
 
 =head1 REGISTER METOHDS
@@ -327 +317 @@
 and one after that is specified by the order of C<'hook' =E<gt> \&callabck>.
 
-=head2 filter_register_hook
-
-  sub filter_register_hook {
-      my ( $self, $hook, $action ) = @_;
-      my ( $plugin, $callback ) = @{ $action }{qw( plugin callback )};
-      # your filter code
-  }
-
-When registering a plugin, this method is filtered a plugin.
-Arguments are passed by the order of C<$hook> and C<$action>.
-
-=over 2
-
-=item C<$hook>
-
-The hook name specified as the run_hook method.
-
-=item C<$action>
+Only when C<$hook-E<gt>hookable_call_filter( 'run_hook', $hook, $action )> has returned truth,
+the callback specified by this method is registered with a hook.
+
+Please see L<"hookable_call_filter"> about C<$hook-E<gt>hookable_call_filter>.
+
+B<Arguments of C<$hook-E<gt>hookable_call_filter>>:
+
+  $hook->hookable_call_filter( 'run_hook', $hook, $action );
+
+=over 3
+
+=item 'run_hook'
+
+C<'run_hook'> is filter name.
+
+=item $hook
+
+The hook name specified as the register_hook method.
+
+=item $action
+
+  my ( $plugin, $callback ) = @{ $action }{qw( plugin callback )};
 
 The hash reference including plugin and callback.
 
 =back
-
-When this method has returned ture, plugin and hook are registered,
-and when having returned false, it isn't registered.
-
-This method exists to rewrite when inheriting.
 
 =head1 CALL METHODS
@@ -403 +392 @@
 =back
 
-B<Argument to callback of the registered plugin>:
+B<Arguments of registered callback>:
 
   sub callback {
@@ -433 +422 @@
 =back
 
+
+Only when C<$hook-E<gt>hookable_call_filter( 'run_hook', $hook, $args, $action )> has returned truth,
+this method calls callback.
+
+Please see L<"hookable_call_filter"> about C<$hook-E<gt>hookable_call_filter>.
+
+B<Arguments of C<$hook-E<gt>hookable_call_filter>>:
+
+  $hook->hookable_call_filter( 'run_hook', $hook, $args, $action );
+
+=over 4
+
+=item 'run_hook'
+
+C<'run_hook'> is filter name.
+
+=item C<$hook>
+
+The hook name specified by the run_hook method.
+
+=item C<$args>
+
+The argument specified by the run_hook method.
+
+=item C<$action>
+
+  my ( $plugin, $callback ) = @{ $action }{qw( plugin callback )};
+
+The hash reference including the plugin and the callback.
+
+=back
+
 =head2 run_hook_once
 
@@ -438 +459 @@
 
 This method is an alias of C<$hook-E<gt>run_hook( $hook, $args, 1, \&callback )>.
-
-=head2 filter_run_hook
-
-  sub filter_run_hook {
-      my ( $self, $hook, $args, $action ) = @_;
-      my ( $plugin, $callabck ) = @{ $action }{qw( plugin callback )};
-      # some code
-  }
-
-When calling a hook, this method is filtered a plugin.
-Argument are passed by the order of C<$hook>, C<$args>, C<$action>.
-
-=over 3
-
-=item C<$hook>
-
-The hook name specified by the run_hook method.
-
-=item C<$args>
-
-The argument specified by the run_hook method.
-
-=item C<$action>
-
-The hash reference including the plugin and the callback.
-
-=back
-
-When this method has returned true, callback of a plugin is called, 
-and when having returned false, callback isn't called.
-
-This method exists to rewrite when inheriting.
 
 =head1 FILTER METHODS

lang/perl/Class-Hookable/trunk/t/02_register/00_register_hook.t

@@ -4 +4 @@
 use warnings;
 
-use Test::More tests => 3;
+use Test::More tests => 7;
 use Class::Hookable;
 
@@ -25 +25 @@
 );
 
-{
-    no warnings 'redefine';
-    *Class::Hookable::filter_register_hook = sub { 0 };
-}
+$hook->hookable_set_filter(
+    'register_hook' => sub {
+        my ( $self, $filter, $hook, $action ) = @_;
+        isa_ok( $self, 'Class::Hookable' );
+        is( $filter, 'register_hook' );
+        is( $hook, 'AAA.BBB' );
+        is_deeply(
+            $action,
+            {
+                plugin      => $plugin,
+                callback    => $plugin->can('bar'),
+            },
+        );
+    },
+);
 
 $hook->register_hook(

lang/perl/Class-Hookable/trunk/t/04_call/00_run_hook.t

@@ -4 +4 @@
 use warnings;
 
-use Test::More tests => 5 + 2 + 4;
+use Test::More tests => 5 + 2 + 6;
 use Class::Hookable;
 
@@ -62 +62 @@
 # -- dispatch_plugin test ------------ #
 
-no warnings 'redefine';
-*Class::Hookable::filter_run_hook = sub {
-    my ( $self, $hook, $args, $action ) = @_;
 
-    is( $hook, 'dispatch' );
-    is( $args, undef );
-    is_deeply(
-        $action,
-        {
-            plugin      => $plugin,
-            callback    => $plugin->can('foo'),
-        }
-    );
+$hook->hookable_set_filter(
+    'run_hook' => sub {
+        my ( $self, $filter, $hook, $args, $action ) = @_;
 
-    return 0;
-};
+        isa_ok( $self, 'Class::Hookable' );
+        is( $filter, 'run_hook' );
+        is( $hook, 'dispatch' );
+        is( $args, undef );
+        is_deeply(
+            $action,
+            {
+                plugin      => $plugin,
+                callback    => $plugin->can('foo'),
+            }
+        );
+
+        return 0;
+    },
+);
 
 is(