mpv 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea6d35a3a33ee0a2c43ef89db78ee50c884ee409
-  data.tar.gz: ed777b88977141913a4fe3dd3ca5291965e7c78d
+  metadata.gz: 3a818d6765d547de2c4b2762fad829c88d276727
+  data.tar.gz: b086dab6ac928bbd5922b9c23fa2d651bc854b03
 SHA512:
-  metadata.gz: 662082205917a74a09ec38442465cc08673416055501563b35939931753b963ea01c97a8620f8845ae8e73f03fd8f03c0441f5dcd488576e23a0c7ecb3f44b20
-  data.tar.gz: 20b649d5ff70c59417b9c0dc959fe3c72428ebae61be4fd6a4fea24da9faa7a742d8789aa8481bf063abc4b99f0e17e791e9950e7a5c40fc01fcbefd7712955b
+  metadata.gz: 6b31aaf4f3cbc0945d1520267f4d97ad7703790cace3f0acd9f0faa4fc0e05329570b13d2b659cc2f58271f3fd498f1464ab5c59fc3a4cefc5f19e4a9f61b30c
+  data.tar.gz: 2c6ba98059b02017d69e64f51161628cc56b29df54ee8286133f310dfb10df2d9430da9169593733f11b01d81dfe200fed30a934b64acce3e22760df4232f41e

data/README.md

@@ -18,12 +18,12 @@ For full documentation, please see the
 
 ```ruby
 # this will be called every time mpv sends an event back over the socket
-def event(event)
-  puts "look ma! a callback: #{event}"
+def something_happened(event)
+  puts "look ma! a callback: #{event.to_s}"
 end
 
 session = MPV::Session.new # contains both a MPV::Server and a MPV::Client
-session.client.callbacks << self
+session.client.callbacks << MPV::Callback.new(self, :something_happened)
 session.client.get_property "pause"
 session.client.command "get_version"
 session.client.command "loadlist", "my_huge_playlist.txt", "append"

data/lib/mpv.rb

@@ -1,3 +1,4 @@
+require_relative "mpv/callback"
 require_relative "mpv/client"
 require_relative "mpv/server"
 require_relative "mpv/session"
@@ -5,5 +6,5 @@ require_relative "mpv/session"
 # The toplevel namespace for ruby-mpv.
 module MPV
   # The current version of ruby-mpv.
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0".freeze
 end

data/lib/mpv/callback.rb

@@ -0,0 +1,36 @@
+module MPV
+  # Encapsulates an object-method pair that will be invoked whenever
+  # an {MPV::Client} receives an event.
+  class Callback
+    # @return [Object] the object that the callback will be issued to
+    attr_accessor :object
+
+    # @return [Symbol] the method that the callback will invoke
+    attr_accessor :method
+
+    # @param object [Object] the object that the callback will be issued to
+    # @param method [Symbol] the method that the callback will invoke
+    def initialize(object, method)
+      @object = object
+      @method = method
+    end
+
+    # Determines the validity of the instantiated callback. A callback
+    # is said to be valid if the object responds to the given method
+    # and the method has an arity of 1 (for the event data).
+    # @return [Boolean] whether or not the callback is valid
+    def valid?
+      object.respond_to?(method) && object.method(method).arity == 1
+    end
+
+    # Dispatches the callback. Does nothing unless {#valid?} is true.
+    # @param event [string] the event name
+    # @return [void]
+    def dispatch!(event)
+      return unless valid?
+
+      puts "dispatch #{event}"
+      object.send method, event
+    end
+  end
+end

data/lib/mpv/client.rb

@@ -13,7 +13,7 @@ module MPV
     # @return [String] the path of the socket used to communicate with mpv
     attr_reader :socket_path
 
-    # @return [Array<Object>] objects whose #event method will be called
+    # @return [Array<MPV::Callback>] callback objects that will be invoked
     #  whenever mpv emits an event
     attr_accessor :callbacks
 
@@ -22,6 +22,7 @@ module MPV
       @socket_path = path
 
       @socket = UNIXSocket.new(@socket_path)
+      @alive = true
 
       @callbacks = []
 
@@ -34,12 +35,20 @@ module MPV
       @events_thread = Thread.new { dispatch_events! }
     end
 
+    # @return [Boolean] whether or not the player is currently active
+    # @note When false, most methods will cease to function.
+    def alive?
+      @alive
+    end
+
     # Sends a command to the mpv process.
     # @param args [Array] the individual command arguments to send
     # @return [Hash] mpv's response to the command
     # @example
     #  client.command "loadfile", "mymovie.mp4", "append-play"
     def command(*args)
+      return unless alive?
+
       payload = {
         "command" => args
       }
@@ -55,6 +64,8 @@ module MPV
     # @example
     #  client.set_property "pause", true
     def set_property(*args)
+      return unless alive?
+
       command "set_property", *args
     end
 
@@ -64,6 +75,8 @@ module MPV
     # @example
     #  client.get_property "pause" # => true
     def get_property(*args)
+      return unless alive?
+
       command("get_property", *args)["data"]
     end
 
@@ -71,23 +84,29 @@ module MPV
     # @return [void]
     # @note this object becomes garbage once this method is run
     def quit!
+      return unless alive?
       command "quit"
+    ensure
+      @alive = false
       @socket = nil
       File.delete(@socket_path) if File.exist?(@socket_path)
     end
 
     private
 
+    # Pumps commands from the command queue to the socket.
     def pump_commands!
       loop do
         begin
           @socket.puts(@command_queue.pop)
         rescue # the player is deactivating
+          @alive = false
           Thread.exit
         end
       end
     end
 
+    # Pumps results from the socket to the result and event queues.
     def pump_results!
       loop do
         begin
@@ -99,18 +118,20 @@ module MPV
             @result_queue << response
           end
         rescue # the player is deactivating
+          @alive = false
           Thread.exit
         end
       end
     end
 
+    # Takes events from the event queue and dispatches them to callbacks.
     def dispatch_events!
       loop do
         event = @event_queue.pop
 
         callbacks.each do |callback|
           Thread.new do
-            callback.send :event, event if callback.respond_to?(:event)
+            callback.dispatch! event
           end
         end
       end

data/lib/mpv/session.rb

@@ -46,5 +46,20 @@ module MPV
     #  @return (see MPV::Client#quit!)
     #  @see MPV::Client#quit!
     def_delegators :@client, :quit!
+
+    # @!method command
+    #  @return (see MPV::Client#command)
+    #  @see MPV::Client#command
+    def_delegators :@client, :command
+
+    # @!method get_property
+    #  @return (see MPV::Client#get_property)
+    #  @see MPV::Client#get_property
+    def_delegators :@client, :get_property
+
+    # @!method set_property
+    #  @return (see MPV::Client#set_property)
+    #  @see MPV::Client#set_property
+    def_delegators :@client, :set_property
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mpv
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - William Woodruff
@@ -20,6 +20,7 @@ files:
 - LICENSE
 - README.md
 - lib/mpv.rb
+- lib/mpv/callback.rb
 - lib/mpv/client.rb
 - lib/mpv/server.rb
 - lib/mpv/session.rb