Merge branch 'autointrospect'

Author: mvidner

NEWS.md

@@ -2,10 +2,16 @@
 
 ## Unreleased
 
+Bug fixes:
+ * It is no longer required to explicitly call ProxyObject#introspect,
+   it will be done automatically once ([#28][]).
+
 Requirements:
  * Introduced RuboCop to keep a consistent coding style.
  * Replaced Gemfile.ci with a regular Gemfile.
 
+[#28]: http://github.com/mvidner/ruby-dbus/issue/28
+
 ## Ruby D-Bus 0.12.0 - 2016-09-12
 
 API:

doc/Reference.md

@@ -23,20 +23,15 @@ is simply "dbus"
 #### Calling Methods
 
 1. {DBus.session_bus Connect to the session bus};
-   {DBus::Connection#[] get the screensaver service}
-   {DBus::Service#[] and its screensaver object}.
-2. Perform {DBus::ProxyObject#introspect explicit introspection}
-   to define the interfaces and methods
-   on the {DBus::ProxyObject object proxy}
-([I#28](https://github.com/mvidner/ruby-dbus/issues/28)).
-3. Call one of its methods in a loop, solving [xkcd#196](http://xkcd.com/196).
+2. {DBus::Connection#[] get the screensaver service}
+3. {DBus::Service#[] and its screensaver object}.
+4. Call one of its methods in a loop, solving [xkcd#196](http://xkcd.com/196).
 
  
 
     mybus = DBus.session_bus
     service = mybus["org.freedesktop.ScreenSaver"]
     object = service["/ScreenSaver"]
-    object.introspect
     loop do
       object.SimulateUserActivity
       sleep 5 * 60
@@ -50,7 +45,6 @@ In this example SuspendAllowed returns a boolean:
     mybus = DBus.session_bus
     pm_s = mybus["org.freedesktop.PowerManagement"]
     pm_o = pm_s["/org/freedesktop/PowerManagement"]
-    pm_o.introspect
     pm_i = pm_o["org.freedesktop.PowerManagement"]
 
     if pm_i.CanSuspend
@@ -74,7 +68,6 @@ For nearly all methods you used `Method[0]` or
     pm_s = mybus["org.freedesktop.PowerManagement"]
     # use legacy compatibility API
     pm_o = pm_s.object["/org/freedesktop/PowerManagement"]
-    pm_o.introspect
     pm_i = pm_o["org.freedesktop.PowerManagement"]
 
     # wrong
@@ -97,7 +90,6 @@ an actual Hash of them.
     sysbus = DBus.system_bus
     upower_s = sysbus["org.freedesktop.UPower"]
     upower_o = upower_s["/org/freedesktop/UPower"]
-    upower_o.introspect
     upower_i = upower_o["org.freedesktop.UPower"]
 
     on_battery = upower_i["OnBattery"]
@@ -137,7 +129,6 @@ To receive signals for a specific object and interface, use
     sysbus = DBus.system_bus
     login_s = sysbus["org.freedesktop.login1"] # part of systemd
     login_o = login_s.object "/org/freedesktop/login1"
-    login_o.introspect
     login_o.default_iface = "org.freedesktop.login1.Manager"
 
     main = DBus::Main.new
@@ -148,7 +139,6 @@ To receive signals for a specific object and interface, use
       puts "New session: #{name}"
 
       session_o = login_s.object(opath)
-      session_o.introspect
       session_i = session_o["org.freedesktop.login1.Session"]
       uid, _user_opath = session_i["User"]
       puts "Its UID: #{uid}"
@@ -218,7 +208,6 @@ D-Bus calls can reply with an error instead of a return value. An error is
 translated to a Ruby exception, an instance of {DBus::Error}.
 
     nm_o = DBus.system_bus["org.freedesktop.NetworkManager"]["/org/freedesktop/NetworkManager"]
-    nm_o.introspect
     nm = nm_o["org.freedesktop.NetworkManager"]
     begin
       nm.Sleep(false)

examples/service/call_service.rb

@@ -9,8 +9,6 @@
 # Get the object from this service
 player = ruby_srv.object("/org/ruby/MyInstance")
 
-# Introspect it
-puts player.introspect
 player.default_iface = "org.ruby.SampleInterface"
 player.test_variant(["s", "coucou"])
 player.on_signal("SomethingJustHappened") do |u, v|

examples/simple/call_introspect.rb

@@ -10,8 +10,6 @@
 # Get the object from this service
 player = rhythmbox.object("/org/gnome/Rhythmbox/Player")
 
-# Introspect it
-player.introspect
 if player.has_iface? "org.gnome.Rhythmbox.Player"
   puts "We have Rhythmbox Player interface"
 end

examples/simple/get_id.rb

@@ -10,8 +10,6 @@
 # p driver_svc
 driver_obj = driver_svc["/"]
 # p driver_obj
-driver_obj.introspect
-
 driver_ifc = driver_obj["org.freedesktop.DBus"]
 # p driver_ifc
 

examples/simple/properties.rb

@@ -3,8 +3,7 @@
 
 bus = DBus::SystemBus.instance
 nm_service = bus["org.freedesktop.NetworkManager"]
-network_manager_object = nm_service.object("/org/freedesktop/NetworkManager")
-network_manager_object.introspect
+network_manager_object = nm_service["/org/freedesktop/NetworkManager"]
 nm_iface = network_manager_object["org.freedesktop.NetworkManager"]
 
 # read a property

examples/utils/notify.rb

@@ -9,8 +9,7 @@
 end
 
 d = DBus::SessionBus.instance
-o = d.service("org.freedesktop.Notifications").object("/org/freedesktop/Notifications")
-o.introspect
+o = d["org.freedesktop.Notifications"]["/org/freedesktop/Notifications"]
 
 i = o["org.freedesktop.Notifications"]
 

lib/dbus/proxy_object.rb

@@ -37,27 +37,31 @@ def initialize(bus, dest, path, api: ApiOptions::CURRENT)
       @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
 
     # Retrieves an interface of the proxy object
     # @param [String] intfname
     # @return [ProxyObjectInterface]
     def [](intfname)
+      introspect unless introspected
       @interfaces[intfname]
     end
 
     # Maps the given interface name _intfname_ to the given interface _intf.
     # @param [String] intfname
     # @param [ProxyObjectInterface] intf
     # @return [ProxyObjectInterface]
+    # @api private
     def []=(intfname, intf)
       @interfaces[intfname] = intf
     end
@@ -98,7 +102,7 @@ def define_shortcut_methods
         # 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
@@ -107,8 +111,8 @@ def define_shortcut_methods
 
     # Returns whether the object has an interface with the given _name_.
     def has_iface?(name)
-      raise "Cannot call has_iface? if not introspected" if !@introspected
-      @interfaces.member?(name)
+      introspect unless introspected
+      @interfaces.key?(name)
     end
 
     # Registers a handler, the code block, for a signal with the given _name_.

spec/async_spec.rb

@@ -8,7 +8,6 @@
     @bus = DBus::ASessionBus.new
     @svc = @bus.service("org.ruby.service")
     @obj = @svc.object "/org/ruby/MyInstance"
-    @obj.introspect
     @obj.default_iface = "org.ruby.SampleInterface"
   end
 

spec/binding_spec.rb

@@ -9,14 +9,12 @@
     @bus = DBus::ASessionBus.new
     @svc = @bus.service("org.ruby.service")
     @base = @svc.object "/org/ruby/MyInstance"
-    @base.introspect
     @base.default_iface = "org.ruby.SampleInterface"
   end
 
   # https://trac.luon.net/ruby-dbus/ticket/36#comment:3
   it "tests class inheritance" do
     derived = @svc.object "/org/ruby/MyDerivedInstance"
-    derived.introspect
 
     # it should inherit from the parent
     expect(derived["org.ruby.SampleInterface"]).not_to be_nil
@@ -26,7 +24,6 @@
   # Interfaces and methods/signals appeared on all classes
   it "tests separation of classes" do
     test2 = @svc.object "/org/ruby/MyInstance2"
-    test2.introspect
 
     # it should have its own interface
     expect(test2["org.ruby.Test2"]).not_to be_nil