ruby-dbus 0.6.0 → 0.7.0

data/NEWS

@@ -5,6 +5,22 @@ Note about bug numbers:
  Issue#1  - http://github.com/mvidner/ruby-dbus/issues#issue/1
  bnc#1    - https://bugzilla.novell.com/show_bug.cgi?id=1
 
+== Ruby D-Bus 0.7.0 - 2011-07-26
+
+Features:
+ * Added ASystemBus and ASessionBus, non-singletons useful in tests
+   and threads.
+
+Bug fixes:
+ * Fixed handling of multibyte strings (Issue#8, by Takayuki YAMAGUCHI).
+ * Allow reopening of a dbus_interface declaration (Issue#9, by T. YAMAGUCHI).
+ * Fixed ruby-1.9.2 compatibility again (Issue#12).
+ * Fixed authentication on BSD (Issue#11, by Jonathan Walker)
+ * Fixed exiting a nested event loop for synchronous calls
+   (reported by Timo Warns).
+ * Fixed introspection calls leaking reply handlers.
+ * "rake test" now works, doing what was called "rake env:test"
+
 == Ruby D-Bus 0.6.0 - 2010-12-11
 
 Features:

data/README

@@ -5,7 +5,7 @@ D-Bus system can be used in the Ruby programming language.
 
 == Requirements
 
- * Ruby 1.8 (>= 1.8.6?) or 1.9
+ * Ruby 1.8.7 or 1.9
 
 == Installation
 

data/Rakefile

@@ -3,33 +3,32 @@ require 'rake'
 require 'rake/gempackagetask'
 require 'fileutils'
 include FileUtils
+require 'tmpdir'
 require 'rake/rdoctask'
 require 'rake/testtask'
 
 desc 'Default: run tests in the proper environment'
-task :default => "env:test"
+task :default => :test
 
 def common_test_task(t)
     t.libs << "lib"
-    t.test_files = FileList['test/*_test.rb', 'test/t*.rb']
+    t.test_files = FileList['test/*_test.rb', 'test/t[0-9]*.rb']
     t.verbose = true
 end
-Rake::TestTask.new {|t| common_test_task t }
+Rake::TestTask.new("bare:test") {|t| common_test_task t }
 
 begin
   require 'rcov/rcovtask'
-  Rcov::RcovTask.new {|t| common_test_task t }
+  Rcov::RcovTask.new("bare:rcov") {|t| common_test_task t }
 rescue LoadError
   # no rcov, never mind
 end
 
 %w(test rcov).each do |tname|
-  namespace :env do
-    desc "Run #{tname} in the proper environment"
-    task tname do |t|
-      cd "test" do
-        system "./test_env rake #{tname}"
-      end
+  desc "Run bare:#{tname} in the proper environment"
+  task tname do |t|
+    cd "test" do
+      system "./test_env rake bare:#{tname}"
     end
   end
 end
@@ -40,6 +39,17 @@ Rake::GemPackageTask.new(GEMSPEC) do |pkg|
   # no other formats needed
 end
 
+desc "Build a package from a clone of the local Git repo"
+task :package_git do |t|
+  Dir.mktmpdir do |temp|
+    sh "git clone . #{temp}"
+    cd temp do
+      sh "rake package"
+    end
+    cp_r "#{temp}/pkg", "."
+  end
+end
+
 Rake::RDocTask.new do |rd|
   rd.rdoc_dir = 'doc/rdoc'
   rd.rdoc_files.include("README", "lib/**/*.rb")

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/lib/dbus/auth.rb

@@ -8,6 +8,8 @@
 
 $debug = $DEBUG #it's all over the state machine
 
+require 'rbconfig'
+
 module DBus
   # Exception raised when authentication fails somehow.
   class AuthenticationFailed < Exception
@@ -62,7 +64,7 @@ module DBus
       # name of cookie file, id of cookie in file, servers random challenge  
       context, id, s_challenge = data.split(' ')
       # Random client challenge        
-      c_challenge = Array.new(s_challenge.length/2).map{|obj|obj=rand(255).to_s}.join
+      c_challenge = Array.new(s_challenge.bytesize/2).map{|obj|obj=rand(255).to_s}.join
       # Search cookie file for id
       path = File.join(ENV['HOME'], '.dbus-keyrings', context)
       puts "DEBUG: path: #{path.inspect}" if $debug
@@ -118,7 +120,11 @@ module DBus
 
     # Start the authentication process.
     def authenticate
-      @socket.write(0.chr)
+      if (RbConfig::CONFIG["target_os"] =~ /bsd/)
+        @socket.sendmsg(0.chr, 0, nil, [:SOCKET, :SCM_CREDS, ""])
+      else
+        @socket.write(0.chr)
+      end
       next_authenticator
       @state = :Starting
       while @state != :Authenticated
@@ -142,12 +148,12 @@ module DBus
     # Try authentication using the next authenticator.
     def next_authenticator
       begin
-        raise AuthException if @auth_list.size == 0
+        raise AuthenticationFailed if @auth_list.size == 0
         @authenticator = @auth_list.shift.new
         auth_msg = ["AUTH", @authenticator.name, @authenticator.authenticate]
         puts "DEBUG: auth_msg: #{auth_msg.inspect}" if $debug
         send(auth_msg)
-      rescue AuthException
+      rescue AuthenticationFailed
         @socket.close
         raise
       end
@@ -161,7 +167,7 @@ module DBus
       while left > 0
         buf = @socket.read( left > 1 ? 1 : left )
         break if buf.nil?
-        left -= buf.size
+        left -= buf.bytesize
         data += buf
         break if data.include? crlf #crlf means line finished, the TCP socket keeps on listening, so we break 
       end

data/lib/dbus/bus.rb

@@ -140,6 +140,7 @@ module DBus
     end
 
     # Return an XML string representation of the node.
+    # It is shallow, not recursing into subnodes
     def to_xml
       xml = '<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
@@ -383,33 +384,52 @@ module DBus
 '
 # This apostroph is for syntax highlighting editors confused by above xml: "
 
-    def introspect_data(dest, path)
-      m = DBus::Message.new(DBus::Message::METHOD_CALL)
-      m.path = path
-      m.interface = "org.freedesktop.DBus.Introspectable"
-      m.destination = dest
-      m.member = "Introspect"
-      m.sender = unique_name
-      if not block_given?
-        # introspect in synchronous !
-        send_sync(m) do |rmsg|
+    # Send a _message_.
+    # If _reply_handler_ is not given, wait for the reply
+    # and return the reply, or raise the error.
+    # If _reply_handler_ is given, it will be called when the reply
+    # eventually arrives, with the reply message as the 1st param
+    # and its params following
+    def send_sync_or_async(message, &reply_handler)
+      ret = nil
+      if reply_handler.nil?
+        send_sync(message) do |rmsg|
           if rmsg.is_a?(Error)
             raise rmsg
           else
-            return rmsg.params[0] # return value of introspect_data
+            ret = rmsg.params
           end
         end
       else
-        send(m.marshall)
-        on_return(m) do |rmsg|
+        on_return(message) do |rmsg|
           if rmsg.is_a?(Error)
-            yield rmsg
+            reply_handler.call(rmsg)
           else
-            yield rmsg.params[0]
+            reply_handler.call(rmsg, * rmsg.params)
           end
         end
+        send(message.marshall)
+      end
+      ret
+    end
+
+    def introspect_data(dest, path, &reply_handler)
+      m = DBus::Message.new(DBus::Message::METHOD_CALL)
+      m.path = path
+      m.interface = "org.freedesktop.DBus.Introspectable"
+      m.destination = dest
+      m.member = "Introspect"
+      m.sender = unique_name
+      if reply_handler.nil?
+        send_sync_or_async(m).first
+      else
+        send_sync_or_async(m) do |*args|
+          # TODO test async introspection, is it used at all?
+          args.shift            # forget the message, pass only the text
+          reply_handler.call(*args)
+          nil
+        end
       end
-      nil
     end
 
     # Issues a call to the org.freedesktop.DBus.Introspectable.Introspect method
@@ -549,9 +569,7 @@ module DBus
       return if retm.nil? #check if somethings wrong
       
       process(retm)
-      until [DBus::Message::ERROR,
-          DBus::Message::METHOD_RETURN].include?(retm.message_type) and
-          retm.reply_serial == m.serial
+      while @method_call_replies.has_key? m.serial
         retm = wait_for_message
         process(retm)
       end
@@ -695,10 +713,10 @@ module DBus
   # = D-Bus session bus class
   #
   # The session bus is a session specific bus (mostly for desktop use).
-  # This is a singleton class.
-  class SessionBus < Connection
-    include Singleton
-
+  #
+  # Use SessionBus, the non-singleton ASessionBus is
+  # for the test suite.
+  class ASessionBus < Connection
     # Get the the default session bus.
     def initialize
       super(ENV["DBUS_SESSION_BUS_ADDRESS"] || address_from_file)
@@ -719,13 +737,20 @@ module DBus
     end
   end
 
+  # See ASessionBus
+  class SessionBus < ASessionBus
+    include Singleton
+  end
+
+
   # = D-Bus system bus class
   #
   # The system bus is a system-wide bus mostly used for global or
-  # system usages.  This is a singleton class.
-  class SystemBus < Connection
-    include Singleton
-
+  # system usages.
+  #
+  # Use SystemBus, the non-singleton ASystemBus is
+  # for the test suite.
+  class ASystemBus < Connection
     # Get the default system bus.
     def initialize
       super(SystemSocketName)
@@ -755,6 +780,11 @@ module DBus
     end
   end
 
+  # See ASystemBus
+  class SystemBus < ASystemBus
+    include Singleton
+  end
+
   # Shortcut for the SystemBus instance
   def DBus.system_bus
     SystemBus.instance

data/lib/dbus/export.rb

@@ -15,19 +15,20 @@ module DBus
   # = Exportable D-Bus object class
   #
   # Objects that are going to be exported by a D-Bus service
-  # should inherit from this class.
+  # should inherit from this class. At the client side, use ProxyObject.
   class Object
     # The path of the object.
     attr_reader :path
-    # The interfaces that the object supports.
+    # The interfaces that the object supports. Hash: String => Interface
     class_attribute :intfs
     # The service that the object is exported by.
     attr_writer :service
 
-    @@cur_intf = nil
+    @@cur_intf = nil            # Interface
     @@intfs_mutex = Mutex.new
 
     # Create a new object with a given _path_.
+    # Use Service#export to export it.
     def initialize(path)
       @path = path
       @service = nil
@@ -39,7 +40,7 @@ module DBus
       self.intfs = (self.intfs || {}).merge({intf.name => intf})
     end
 
-    # Dispatch a message _msg_.
+    # Dispatch a message _msg_ to call exported methods
     def dispatch(msg)
       case msg.message_type
       when Message::METHOD_CALL
@@ -73,8 +74,10 @@ module DBus
     # belong to.
     def self.dbus_interface(s)
       @@intfs_mutex.synchronize do
-        @@cur_intf = Interface.new(s)
-        self.intfs = (self.intfs || {}).merge({s => @@cur_intf})
+        unless @@cur_intf = (self.intfs && self.intfs[s])
+          @@cur_intf = Interface.new(s)
+          self.intfs = (self.intfs || {}).merge({s => @@cur_intf})
+        end
         yield
         @@cur_intf = nil
       end

data/lib/dbus/introspect.rb

@@ -8,6 +8,7 @@
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
 
+# TODO check if it is slow, make replaceable
 require 'rexml/document'
 
 module DBus
@@ -27,15 +28,16 @@ module DBus
   # = D-Bus interface class
   #
   # This class is the interface descriptor.  In most cases, the Introspect()
-  # method call instanciates and configures this class for us.
+  # method call instantiates and configures this class for us.
   #
   # It also is the local definition of interface exported by the program.
+  # At the client side, see ProxyObjectInterface
   class Interface
-    # The name of the interface.
+    # The name of the interface. String
     attr_reader :name
-    # The methods that are part of the interface.
+    # The methods that are part of the interface. Hash: Symbol => DBus::Method
     attr_reader :methods
-    # The signals that are part of the interface.
+    # The signals that are part of the interface. Hash: Symbol => Signal
     attr_reader :signals
 
     # Creates a new interface with a given _name_.
@@ -47,7 +49,7 @@ module DBus
 
     # Validates a service _name_.
     def validate_name(name)
-      raise InvalidIntrospectionData if name.size > 255
+      raise InvalidIntrospectionData if name.bytesize > 255
       raise InvalidIntrospectionData if name =~ /^\./ or name =~ /\.$/
       raise InvalidIntrospectionData if name =~ /\.\./
       raise InvalidIntrospectionData if not name =~ /\./
@@ -100,14 +102,14 @@ module DBus
   # This is a generic class for entities that are part of the interface
   # such as methods and signals.
   class InterfaceElement
-    # The name of the interface element.
+    # The name of the interface element. Symbol
     attr_reader :name
-    # The parameters of the interface element
+    # The parameters of the interface element. Array: FormalParameter
     attr_reader :params
 
     # Validates element _name_.
     def validate_name(name)
-      if (not name =~ MethodSignalRE) or (name.size > 255)
+      if (not name =~ MethodSignalRE) or (name.bytesize > 255)
         raise InvalidMethodName, name
       end
     end
@@ -135,7 +137,7 @@ module DBus
   #
   # This is a class representing methods that are part of an interface.
   class Method < InterfaceElement
-    # The list of return values for the method.
+    # The list of return values for the method. Array: FormalParameter
     attr_reader :rets
 
     # Creates a new method interface element with the given _name_.
@@ -227,10 +229,9 @@ module DBus
       @xml = xml
     end
 
-    # Recursively parses the subnodes, constructing the tree.
+    # return the names of direct subnodes
     def parse_subnodes
       subnodes = Array.new
-      t = Time.now
       d = REXML::Document.new(@xml)
       d.elements.each("node/node") do |e|
         subnodes << e.attributes["name"]
@@ -238,9 +239,9 @@ module DBus
       subnodes
     end
 
-    # Parses the XML, constructing the tree.
+    # return a pair: [list of Interfaces, list of direct subnode names]
     def parse
-      ret = Array.new
+      interfaces = Array.new
       subnodes = Array.new
       t = Time.now
       d = REXML::Document.new(@xml)
@@ -259,13 +260,13 @@ module DBus
           parse_methsig(se, s)
           i << s
         end
-        ret << i
+        interfaces << i
       end
       d = Time.now - t
       if d > 2
         puts "Some XML took more that two secs to parse. Optimize me!" if $DEBUG
       end
-      [ret, subnodes]
+      [interfaces, subnodes]
     end
 
     ######################################################################
@@ -342,7 +343,7 @@ module DBus
       methdef = "def #{m.name}("
       methdef += (0..(m.params.size - 1)).to_a.collect { |n|
         "arg#{n}"
-      }.join(", ")
+      }.push("&reply_handler").join(", ")
       methdef += %{)
               msg = Message.new(Message::METHOD_CALL)
               msg.path = @object.path
@@ -365,26 +366,7 @@ module DBus
         idx += 1
       end
       methdef += "
-        ret = nil
-        if block_given?
-          @object.bus.on_return(msg) do |rmsg|
-            if rmsg.is_a?(Error)
-              yield(rmsg)
-            else
-              yield(rmsg, *rmsg.params)
-            end
-          end
-          @object.bus.send(msg.marshall)
-        else
-          @object.bus.send_sync(msg) do |rmsg|
-            if rmsg.is_a?(Error)
-              raise rmsg
-            else
-              ret = rmsg.params
-            end
-          end
-        end
-        ret
+        @object.bus.send_sync_or_async(msg, &reply_handler)
       end
       "
       singleton_class.class_eval(methdef)
@@ -448,7 +430,7 @@ module DBus
   # over the bus so that the method is executed remotely on the correctponding
   # object.
   class ProxyObject
-    # The subnodes of the object in the tree.
+    # The names of direct subnodes of the object in the tree.
     attr_accessor :subnodes
     # Flag determining whether the object has been introspected.
     attr_accessor :introspected
@@ -458,7 +440,7 @@ module DBus
     attr_reader :path
     # The bus the object is reachable via.
     attr_reader :bus
-    # The default interface of the object.
+    # The default interface of the object, as String.
     attr_accessor :default_iface
 
     # Creates a new proxy object living on the given _bus_ at destination _dest_
@@ -495,11 +477,12 @@ module DBus
 
     # Returns whether the object has an interface with the given _name_.
     def has_iface?(name)
-      raise "Cannot call has_iface? is not introspected" if not @introspected
+      raise "Cannot call has_iface? if not introspected" if not @introspected
       @interfaces.member?(name)
     end
 
     # Registers a handler, the code block, for a signal with the given _name_.
+    # It uses _default_iface_ which must have been set.
     def on_signal(name, &block)
       if @default_iface and has_iface?(@default_iface)
         @interfaces[@default_iface].on_signal(@bus, name, &block)
@@ -521,10 +504,9 @@ module DBus
         rescue NameError => e
           # interesting, foo.method("unknown")
           # raises NameError, not NoMethodError
-          match = /undefined method `([^']*)' for class `([^']*)'/.match e.to_s
-          raise unless match and match[2] == "DBus::ProxyObjectInterface"
+          raise unless e.to_s =~ /undefined method `#{name}'/
           # BTW e.exception("...") would preserve the class.
-          raise NoMethodError,"undefined method `#{match[1]}' for DBus interface `#{@default_iface}' on object `#{@path}'"
+          raise NoMethodError,"undefined method `#{name}' for DBus interface `#{@default_iface}' on object `#{@path}'"
         end
       else
         # TODO distinguish: