proc_spy: expose to library users

Author: pigoz

lib/mpv.rb

@@ -10,6 +10,7 @@ module MPV
 require_relative "ass/text"
 
 require_relative "mpv/exceptions"
+require_relative "mpv/proc_spy"
 require_relative "mpv/multi_queue"
 require_relative "mpv/utils"
 require_relative "mpv/client"

lib/mpv/proc_spy.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module MPV
+  # Utility class to test threaded asyncronous code that calls blocks/procs.
+  # Exposed as production code for the sake of the users who want to TDD their
+  # mpv Ruby scripts (since it's not trivial code to write).
+  class ProcSpy
+    def initialize
+      @mutex = Mutex.new
+      @resource = ConditionVariable.new
+      @queue = []
+    end
+
+    def to_proc
+      proc do |*args|
+        @mutex.synchronize do
+          @queue << args.dup
+          @resource.signal
+        end
+      end
+    end
+
+    DEFAULT_TIMEOUT = 5
+
+    # Waits until the spy has been run at least "runs" times or the timeout is
+    # triggered, and returns the calls performed on the spy
+    # @return [Array<Array<Object>>] array of calls to the spy, containing
+    #  arguments of each call
+    def wait(runs: 1, timeout: DEFAULT_TIMEOUT)
+      start = Concurrent.monotonic_time
+      @mutex.synchronize do
+        loop do
+          break if @queue.size >= runs
+          break if (Concurrent.monotonic_time - start) >= timeout
+
+          @resource.wait(@mutex, 0.05) # sleep 50ms and poll again
+        end
+        result = @queue.dup
+        @queue.clear
+        result
+      end
+    end
+
+    # Clears the calls history
+    def clear!
+      @mutex.synchronize do
+        @queue.clear
+      end
+    end
+  end
+end

spec/mpv_client_spec.rb

@@ -32,15 +32,15 @@
   end
 
   it "can observe properties" do
-    spy = ProcSpy.new
+    spy = MPV::ProcSpy.new
     @mpv.observe_property(:volume, &spy)
     @mpv.set_property(:volume, 10)
     result = spy.wait(runs: 2)
     expect(result.map(&:first).map(&:data)).to eql([100.0, 10.0])
   end
 
   it "can handle client-message" do
-    spy = ProcSpy.new
+    spy = MPV::ProcSpy.new
     m = "cool-message"
     @mpv.register_message_handler(m, &spy)
     @mpv.command("script-message", m, "a", "b")
@@ -50,7 +50,7 @@
   end
 
   it "can register a binding" do
-    spy = ProcSpy.new
+    spy = MPV::ProcSpy.new
     section = @mpv.register_keybindings(%w[b c d], &spy)
     @mpv.command("keypress", "g")
     @mpv.command("keypress", "c")
@@ -74,7 +74,7 @@
   end
 
   it "doesn't deadlock" do
-    spy = ProcSpy.new
+    spy = MPV::ProcSpy.new
     section = @mpv.register_keybindings(%w[b]) do
       volume = @mpv.get_property("volume").data
       spy.to_proc.call(volume)
@@ -106,7 +106,7 @@
   end
 
   it "handles modal keypresses" do
-    spy = ProcSpy.new
+    spy = MPV::ProcSpy.new
     @mpv.enter_modal_mode("really delete?", %w[y n], &spy)
     expect(@mpv.osd_messages.size).to eql(1)
     @mpv.command("keypress", "y")
@@ -115,7 +115,7 @@
   end
 
   it "handles modal exit key" do
-    spy = ProcSpy.new
+    spy = MPV::ProcSpy.new
     @mpv.enter_modal_mode("really delete?", %w[y n], &spy)
     expect(@mpv.osd_messages.size).to eql(1)
     @mpv.command("keypress", "ESC")

spec/spec_helper.rb

@@ -6,41 +6,3 @@
 def test_instance
   MPV::Session.new(user_args: %w[--no-config])
 end
-
-class ProcSpy
-  def initialize
-    @mutex = Mutex.new
-    @resource = ConditionVariable.new
-    clear
-  end
-
-  def clear
-    @queue = []
-  end
-
-  def to_proc
-    proc do |*args|
-      @mutex.synchronize do
-        @queue << args.dup
-        @resource.signal
-      end
-    end
-  end
-
-  DEFAULT_TIMEOUT = 5
-
-  def wait(runs: 1, timeout: DEFAULT_TIMEOUT)
-    start = Time.now
-    @mutex.synchronize do
-      loop do
-        break if @queue.size >= runs
-        break if (Time.now - start) >= timeout
-
-        @resource.wait(@mutex, 0.05) # sleep 50ms and poll again
-      end
-    end
-    result = @queue.dup
-    clear
-    result
-  end
-end