ruby-dbus 0.12.0 → 0.13.0

data/lib/dbus/matchrule.rb

@@ -16,7 +16,7 @@ module DBus
   # FIXME
   class MatchRule
     # The list of possible match filters. TODO argN, argNpath
-    FILTERS = [:sender, :interface, :member, :path, :destination, :type]
+    FILTERS = [:sender, :interface, :member, :path, :destination, :type].freeze
     # The sender filter.
     attr_accessor :sender
     # The interface filter.
@@ -38,35 +38,31 @@ module DBus
     # Set the message types to filter to type _t_.
     # Possible message types are: signal, method_call, method_return, and error.
     def type=(t)
-      if not ['signal', 'method_call', 'method_return', 'error'].member?(t)
+      if !["signal", "method_call", "method_return", "error"].member?(t)
         raise MatchRuleException, t
       end
       @type = t
     end
 
-    # Returns a match rule string version of the object.
-    # E.g.:  "type='signal',sender='org.freedesktop.DBus',interface='org.freedesktop.DBus',member='Foo',path='/bar/foo',destination=':452345.34',arg2='bar'"
+    # Returns a match rule string version of the object. E.g.:
+    # "type='signal',sender='org.freedesktop.DBus'," +
+    # "interface='org.freedesktop.DBus',member='Foo'," +
+    # "path='/bar/foo',destination=':452345.34',arg2='bar'"
     def to_s
-      FILTERS.select do |sym|
-        not method(sym).call.nil?
-      end.collect do |sym|
-        "#{sym.to_s}='#{method(sym).call}'"
-      end.join(",")
+      present_rules = FILTERS.select { |sym| method(sym).call }
+      present_rules.map! { |sym| "#{sym}='#{method(sym).call}'" }
+      present_rules.join(",")
     end
 
     # Parses a match rule string _s_ and sets the filters on the object.
     def from_s(str)
       str.split(",").each do |eq|
-        if eq =~ /^(.*)='([^']*)'$/
-# "
-          name = $1
-          val = $2
-          if FILTERS.member?(name.to_sym)
-            method(name + "=").call(val)
-          else
-            raise MatchRuleException, name
-          end
-        end
+        next unless eq =~ /^(.*)='([^']*)'$/
+        # "
+        name = Regexp.last_match(1)
+        val = Regexp.last_match(2)
+        raise MatchRuleException, name unless FILTERS.member?(name.to_sym)
+        method(name + "=").call(val)
       end
       self
     end
@@ -85,16 +81,16 @@ module DBus
     # Determines whether a message _msg_ matches the match rule.
     def match(msg)
       if @type
-        if {Message::SIGNAL => "signal", Message::METHOD_CALL => "method_call",
-          Message::METHOD_RETURN => "method_return",
-          Message::ERROR => "error"}[msg.message_type] != @type
+        if { Message::SIGNAL => "signal", Message::METHOD_CALL => "method_call",
+             Message::METHOD_RETURN => "method_return",
+             Message::ERROR => "error" }[msg.message_type] != @type
           return false
         end
       end
-      return false if @interface and @interface != msg.interface
-      return false if @member and @member != msg.member
-      return false if @path and @path != msg.path
-      # FIXME sender and destination are ignored
+      return false if @interface && @interface != msg.interface
+      return false if @member && @member != msg.member
+      return false if @path && @path != msg.path
+      # FIXME: sender and destination are ignored
       true
     end
   end # class MatchRule

data/lib/dbus/message.rb

@@ -27,7 +27,7 @@ module DBus
     # Mutex that protects updates on the serial number.
     @@serial_mutex = Mutex.new
     # Type of a message (by specification).
-    MESSAGE_SIGNATURE = "yyyyuua(yv)"
+    MESSAGE_SIGNATURE = "yyyyuua(yv)".freeze
 
     # FIXME: following message type constants should be under Message::Type IMO
     # well, yeah sure
@@ -45,7 +45,7 @@ module DBus
 
     # Message flag signyfing that no reply is expected.
     NO_REPLY_EXPECTED = 0x1
-    # Message flag signifying that no automatic start is required/must be 
+    # Message flag signifying that no automatic start is required/must be
     # performed.
     NO_AUTO_START = 0x2
 
@@ -83,26 +83,26 @@ module DBus
       @flags = 0
       @protocol = 1
       @body_length = 0
-      @signature = String.new
+      @signature = ""
       @@serial_mutex.synchronize do
         @serial = @@serial
         @@serial += 1
       end
-      @params = Array.new
+      @params = []
       @destination = nil
       @interface = nil
       @error_name = nil
       @member = nil
       @path = nil
       @reply_serial = nil
-
-      if mtype == METHOD_RETURN
-        @flags = NO_REPLY_EXPECTED
-      end
+      @flags = NO_REPLY_EXPECTED if mtype == METHOD_RETURN
     end
 
     def to_s
-      "#{message_type} sender=#{sender} -> dest=#{destination} serial=#{serial} reply_serial=#{reply_serial} path=#{path}; interface=#{interface}; member=#{member} error_name=#{error_name}"
+      "#{message_type} sender=#{sender} -> dest=#{destination} " \
+      "serial=#{serial} reply_serial=#{reply_serial} " \
+      "path=#{path}; interface=#{interface}; member=#{member} " \
+      "error_name=#{error_name}"
     end
 
     # Create a regular reply to a message _m_.
@@ -111,7 +111,7 @@ module DBus
     end
 
     # Create an error reply to a message _m_.
-    def self.error(m, error_name, description=nil)
+    def self.error(m, error_name, description = nil)
       ErrorMessage.new(error_name, description).reply_to(m)
     end
 
@@ -126,7 +126,7 @@ module DBus
 
     # Add a parameter _val_ of type _type_ to the message.
     def add_param(type, val)
-      type = type.chr if type.kind_of?(Fixnum)
+      type = type.chr if type.is_a?(Fixnum)
       @signature += type.to_s
       @params << [type, val]
     end
@@ -187,18 +187,19 @@ module DBus
     # Unmarshall a packet contained in the buffer _buf_ and set the
     # parameters of the message object according the data found in the
     # buffer.
-    # Return the detected message and the index pointer of the buffer where
-    # the message data ended.
+    # @return [Array(Message,Integer)]
+    #   the detected message (self) and
+    #   the index pointer of the buffer where the message data ended.
     def unmarshall_buffer(buf)
       buf = buf.dup
-      if buf[0] == ?l
-        endianness = LIL_END
-      else
-        endianness = BIG_END
-      end
+      endianness = if buf[0] == "l"
+                     LIL_END
+                   else
+                     BIG_END
+                   end
       pu = PacketUnmarshaller.new(buf, endianness)
       mdata = pu.unmarshall(MESSAGE_SIGNATURE)
-      _, @message_type, @flags, @protocol, @body_length, @serial, 
+      _, @message_type, @flags, @protocol, @body_length, @serial,
         headers = mdata
 
       headers.each do |struct|
@@ -222,18 +223,10 @@ module DBus
         end
       end
       pu.align(8)
-      if @body_length > 0 and @signature
+      if @body_length > 0 && @signature
         @params = pu.unmarshall(@signature, @body_length)
       end
       [self, pu.idx]
-    end # def unmarshall_buf
-
-    # Unmarshall the data of a message found in the buffer _buf_ using
-    # Message#unmarshall_buf.
-    # Return the message.
-    def unmarshall(buf)
-      ret, _ = unmarshall_buffer(buf)
-      ret
     end
 
     # Make a new exception from ex, mark it as being caused by this message
@@ -252,12 +245,10 @@ module DBus
   end
 
   class ErrorMessage < Message
-    def initialize(error_name, description=nil)
+    def initialize(error_name, description = nil)
       super(ERROR)
       @error_name = error_name
-      unless description.nil?
-        add_param(Type::STRING, description)
-      end
+      add_param(Type::STRING, description) unless description.nil?
     end
 
     def self.from_exception(ex)
@@ -268,7 +259,7 @@ module DBus
                # ex.class.to_s # RuntimeError is not a valid name, has no dot
              end
       description = ex.message
-      msg = self.new(name, description)
+      msg = new(name, description)
       msg.add_param(DBus.type("as"), ex.backtrace)
       msg
     end

data/lib/dbus/message_queue.rb

@@ -22,7 +22,7 @@ module DBus
       connect
     end
 
-    # TODO failure modes
+    # TODO: failure modes
     #
     # If _non_block_ is true, return nil instead of waiting
     # EOFError may be raised
@@ -32,8 +32,8 @@ module DBus
       unless non_block
         # we can block
         while message.nil?
-          r, d, d = IO.select([@socket])
-          if r and r[0] == @socket
+          r, _d, _d = IO.select([@socket])
+          if r && r[0] == @socket
             buffer_from_socket_nonblock
             message = message_from_buffer_nonblock
           end
@@ -45,7 +45,7 @@ module DBus
     def push(message)
       @socket.write(message.marshall)
     end
-    alias :<< :push
+    alias << push
 
     private
 
@@ -56,20 +56,20 @@ module DBus
       worked = addresses.find do |a|
         transport, keyvaluestring = a.split ":"
         kv_list = keyvaluestring.split ","
-        kv_hash = Hash.new
+        kv_hash = {}
         kv_list.each do |kv|
           key, escaped_value = kv.split "="
-          value = escaped_value.gsub(/%(..)/) {|m| [$1].pack "H2" }
+          value = escaped_value.gsub(/%(..)/) { |_m| [Regexp.last_match(1)].pack "H2" }
           kv_hash[key] = value
         end
         case transport
-          when "unix"
+        when "unix"
           connect_to_unix kv_hash
-          when "tcp"
+        when "tcp"
           connect_to_tcp kv_hash
-          when "launchd"
+        when "launchd"
           connect_to_launchd kv_hash
-          else
+        else
           # ignore, report?
         end
       end
@@ -80,46 +80,46 @@ module DBus
 
     # Connect to a bus over tcp and initialize the connection.
     def connect_to_tcp(params)
-      #check if the path is sufficient
-      if params.key?("host") and params.key?("port")
+      # check if the path is sufficient
+      if params.key?("host") && params.key?("port")
         begin
-          #initialize the tcp socket
-          @socket = TCPSocket.new(params["host"],params["port"].to_i)
+          # initialize the tcp socket
+          @socket = TCPSocket.new(params["host"], params["port"].to_i)
           @socket.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
           init_connection
           @is_tcp = true
         rescue Exception => e
           puts "Oops:", e
           puts "Error: Could not establish connection to: #{@path}, will now exit."
-          exit(1) #a little harsh
+          exit(1) # a little harsh
         end
       else
-        #Danger, Will Robinson: the specified "path" is not usable
+        # Danger, Will Robinson: the specified "path" is not usable
         puts "Error: supplied path: #{@path}, unusable! sorry."
       end
     end
 
     # Connect to an abstract unix bus and initialize the connection.
     def connect_to_unix(params)
-      @socket = Socket.new(Socket::Constants::PF_UNIX,Socket::Constants::SOCK_STREAM, 0)
+      @socket = Socket.new(Socket::Constants::PF_UNIX, Socket::Constants::SOCK_STREAM, 0)
       @socket.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
-      if ! params['abstract'].nil?
-        if HOST_END == LIL_END
-          sockaddr = "\1\0\0#{params['abstract']}"
-        else
-          sockaddr = "\0\1\0#{params['abstract']}"
-        end
-      elsif ! params['path'].nil?
-        sockaddr = Socket.pack_sockaddr_un(params['path'])
+      if !params["abstract"].nil?
+        sockaddr = if HOST_END == LIL_END
+                     "\1\0\0#{params["abstract"]}"
+                   else
+                     "\0\1\0#{params["abstract"]}"
+                   end
+      elsif !params["path"].nil?
+        sockaddr = Socket.pack_sockaddr_un(params["path"])
       end
       @socket.connect(sockaddr)
       init_connection
     end
 
     def connect_to_launchd(params)
-      socket_var = params['env']
+      socket_var = params["env"]
       socket = `launchctl getenv #{socket_var}`.chomp
-      connect_to_unix 'path' => socket
+      connect_to_unix "path" => socket
     end
 
     # Initialize the connection to the bus.
@@ -128,7 +128,7 @@ module DBus
       @client.authenticate
     end
 
-    public                      # FIXME: fix Main loop instead
+    public # FIXME: fix Main loop instead
 
     # Get and remove one message from the buffer.
     # Return the message or nil.
@@ -153,12 +153,12 @@ module DBus
     def buffer_from_socket_nonblock
       @buffer += @socket.read_nonblock(MSG_BUF_SIZE)
     rescue EOFError
-      raise                     # the caller expects it
+      raise # the caller expects it
     rescue Errno::EAGAIN
       # fine, would block
     rescue Exception => e
       puts "Oops:", e
-      raise if @is_tcp          # why?
+      raise if @is_tcp # why?
       puts "WARNING: read_nonblock failed, falling back to .recv"
       @buffer += @socket.recv(MSG_BUF_SIZE)
     end

data/lib/dbus/proxy_object.rb

@@ -34,14 +34,18 @@ module DBus
     # Creates a new proxy object living on the given _bus_ at destination _dest_
     # on the given _path_.
     def initialize(bus, dest, path, api: ApiOptions::CURRENT)
-      @bus, @destination, @path = bus, dest, path
-      @interfaces = Hash.new
-      @subnodes = Array.new
+      @bus = bus
+      @destination = dest
+      @path = path
+      @introspected = false
+      @interfaces = {}
+      @subnodes = []
       @api = api
     end
 
     # Returns the interfaces of the object.
     def interfaces
+      introspect unless introspected
       @interfaces.keys
     end
 
@@ -49,6 +53,7 @@ module DBus
     # @param [String] intfname
     # @return [ProxyObjectInterface]
     def [](intfname)
+      introspect unless introspected
       @interfaces[intfname]
     end
 
@@ -56,6 +61,7 @@ module DBus
     # @param [String] intfname
     # @param [ProxyObjectInterface] intf
     # @return [ProxyObjectInterface]
+    # @api private
     def []=(intfname, intf)
       @interfaces[intfname] = intf
     end
@@ -66,7 +72,7 @@ module DBus
       # Synchronous call here.
       xml = @bus.introspect_data(@destination, @path)
       ProxyObjectFactory.introspect_into(self, xml)
-      define_shortcut_methods()
+      define_shortcut_methods
       xml
     end
 
@@ -76,14 +82,15 @@ module DBus
     # introspected.
     def define_shortcut_methods
       # builds a list of duplicated methods
-      dup_meths, univocal_meths = [],{}
+      dup_meths = []
+      univocal_meths = {}
       @interfaces.each_value do |intf|
         intf.methods.each_value do |meth|
           name = meth.name.to_sym
           # don't overwrite instance methods!
-          if dup_meths.include? name or self.class.instance_methods.include? name
-            next
-          elsif univocal_meths.include? name
+          next if dup_meths.include?(name)
+          next if self.class.instance_methods.include?(name)
+          if univocal_meths.include? name
             univocal_meths.delete name
             dup_meths << name
           else
@@ -95,7 +102,7 @@ module DBus
         # creates a shortcut function that forwards each call to the method on
         # the appropriate intf
         singleton_class.class_eval do
-          define_method name do |*args, &reply_handler|
+          redefine_method name do |*args, &reply_handler|
             intf.method(name).call(*args, &reply_handler)
           end
         end
@@ -104,20 +111,17 @@ module DBus
 
     # Returns whether the object has an interface with the given _name_.
     def has_iface?(name)
-      raise "Cannot call has_iface? if not introspected" if not @introspected
-      @interfaces.member?(name)
+      introspect unless introspected
+      @interfaces.key?(name)
     end
 
     # Registers a handler, the code block, for a signal with the given _name_.
     # It uses _default_iface_ which must have been set.
     # @return [void]
     def on_signal(name, &block)
-      if @default_iface and has_iface?(@default_iface)
-        @interfaces[@default_iface].on_signal(name, &block)
-      else
-        # TODO improve
-        raise NoMethodError
-      end
+      # TODO: improve
+      raise NoMethodError unless @default_iface && has_iface?(@default_iface)
+      @interfaces[@default_iface].on_signal(name, &block)
     end
 
     ####################################################
@@ -126,23 +130,23 @@ module DBus
     # Handles all unkown methods, mostly to route method calls to the
     # default interface.
     def method_missing(name, *args, &reply_handler)
-      if @default_iface and has_iface?(@default_iface)
-        begin
-          @interfaces[@default_iface].method(name).call(*args, &reply_handler)
-        rescue NameError => e
-          # interesting, foo.method("unknown")
-          # raises NameError, not NoMethodError
-          raise unless e.to_s =~ /undefined method `#{name}'/
-          # BTW e.exception("...") would preserve the class.
-          raise NoMethodError,"undefined method `#{name}' for DBus interface `#{@default_iface}' on object `#{@path}'"
-        end
-      else
-        # TODO distinguish:
+      unless @default_iface && has_iface?(@default_iface)
+        # TODO: distinguish:
         # - di not specified
-        #TODO
+        # TODO
         # - di is specified but not found in introspection data
         raise NoMethodError, "undefined method `#{name}' for DBus interface `#{@default_iface}' on object `#{@path}'"
       end
+
+      begin
+        @interfaces[@default_iface].method(name).call(*args, &reply_handler)
+      rescue NameError => e
+        # interesting, foo.method("unknown")
+        # raises NameError, not NoMethodError
+        raise unless e.to_s =~ /undefined method `#{name}'/
+        # BTW e.exception("...") would preserve the class.
+        raise NoMethodError, "undefined method `#{name}' for DBus interface `#{@default_iface}' on object `#{@path}'"
+      end
     end
   end # class ProxyObject
 end