Merge pull request #311 from rock-core/hook_disposable

feat: make hook definition methods return a disposable for de-registration

Author: doudou

lib/roby/hooks.rb

@@ -19,9 +19,21 @@ def self.included(base)
         module ClassMethods
             include ::Hooks::ClassMethods
 
+            def define_hook_writer(name)
+                define_method name do |method = nil, &block|
+                    _hooks[name] << (method || block)
+                    item = _hooks[name].last
+                    Roby.disposable { _hooks[name].delete(item) }
+                end
+            end
+
             def define_hooks(callback, scope: ->(c, s) { s unless c.proc? })
                 super
             end
         end
+
+        module InstanceHooks
+            include ::Hooks::InstanceHooks
+        end
     end
 end

test/test_hooks.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "roby/test/self"
+
+module Roby
+    describe Hooks do
+        it "registers a hook for the given event" do
+            obj = klass.new
+            mock = flexmock
+            mock.should_receive(:called).once
+            obj.on_test { mock.called }
+            obj.run_hook :on_test
+        end
+        it "returns a disposable that deregister the hook" do
+            obj = klass.new
+            mock = flexmock
+            mock.should_receive(:called).never
+            obj.on_test { mock.called }.dispose
+            obj.run_hook :on_test
+        end
+
+        def klass
+            @klass ||= Class.new do
+                include Hooks
+                include Hooks::InstanceHooks
+
+                define_hook :on_test
+            end
+        end
+    end
+end