ruby-dbus 0.17.0 → 0.18.0.beta1

data/lib/dbus/object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of the ruby-dbus project
 # Copyright (C) 2007 Arnaud Cornet and Paul van Tilburg
 #
@@ -6,11 +8,10 @@
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
 
-require "thread"
 require_relative "core_ext/class/attribute"
 
 module DBus
-  PROPERTY_INTERFACE = "org.freedesktop.DBus.Properties".freeze
+  PROPERTY_INTERFACE = "org.freedesktop.DBus.Properties"
 
   # Exported object type
   # = Exportable D-Bus object class
@@ -20,6 +21,7 @@ module DBus
   class Object
     # The path of the object.
     attr_reader :path
+
     # The interfaces that the object supports. Hash: String => Interface
     my_class_attribute :intfs
     self.intfs = {}
@@ -43,11 +45,13 @@ module DBus
       when Message::METHOD_CALL
         reply = nil
         begin
-          if !intfs[msg.interface]
+          iface = intfs[msg.interface]
+          if !iface
             raise DBus.error("org.freedesktop.DBus.Error.UnknownMethod"),
                   "Interface \"#{msg.interface}\" of object \"#{msg.path}\" doesn't exist"
           end
-          meth = intfs[msg.interface].methods[msg.member.to_sym]
+          member_sym = msg.member.to_sym
+          meth = iface.methods[member_sym]
           if !meth
             raise DBus.error("org.freedesktop.DBus.Error.UnknownMethod"),
                   "Method \"#{msg.member}\" on interface \"#{msg.interface}\" of object \"#{msg.path}\" doesn't exist"
@@ -57,11 +61,20 @@ module DBus
           retdata = [*retdata]
 
           reply = Message.method_return(msg)
-          meth.rets.zip(retdata).each do |rsig, rdata|
-            reply.add_param(rsig.type, rdata)
+          if iface.name == PROPERTY_INTERFACE && member_sym == :Get
+            # Use the specific property type instead of the generic variant
+            # returned by Get.
+            # TODO: GetAll and Set still missing
+            property = dbus_lookup_property(msg.params[0], msg.params[1])
+            rsigs = [property.type]
+          else
+            rsigs = meth.rets.map(&:type)
+          end
+          rsigs.zip(retdata).each do |rsig, rdata|
+            reply.add_param(rsig, rdata)
           end
-        rescue StandardError => ex
-          dbus_msg_exc = msg.annotate_exception(ex)
+        rescue StandardError => e
+          dbus_msg_exc = msg.annotate_exception(e)
           reply = ErrorMessage.from_exception(dbus_msg_exc).reply_to(msg)
         end
         @service.bus.message_queue.push(reply)
@@ -70,17 +83,19 @@ module DBus
 
     # Select (and create) the interface that the following defined methods
     # belong to.
-    def self.dbus_interface(s)
+    # @param name [String] interface name like "org.example.ManagerManager"
+    # @see https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface
+    def self.dbus_interface(name)
       @@intfs_mutex.synchronize do
-        @@cur_intf = intfs[s]
+        @@cur_intf = intfs[name]
         if !@@cur_intf
-          @@cur_intf = Interface.new(s)
+          @@cur_intf = Interface.new(name) # validates the name
           # As this is a mutable class_attr, we cannot use
-          #   self.intfs[s] = @@cur_intf                      # Hash#[]=
+          #   self.intfs[name] = @@cur_intf                      # Hash#[]=
           # as that would modify parent class attr in place.
           # Using the setter lets a subclass have the new value
           # while the superclass keeps the old one.
-          self.intfs = intfs.merge(s => @@cur_intf)
+          self.intfs = intfs.merge(name => @@cur_intf)
         end
         yield
         @@cur_intf = nil
@@ -110,6 +125,7 @@ module DBus
     # @return [void]
     def self.dbus_attr_accessor(ruby_name, type, dbus_name: nil)
       attr_accessor(ruby_name)
+
       dbus_accessor(ruby_name, type, dbus_name: dbus_name)
     end
 
@@ -129,6 +145,7 @@ module DBus
     # @return (see .dbus_attr_accessor)
     def self.dbus_attr_reader(ruby_name, type, dbus_name: nil)
       attr_reader(ruby_name)
+
       dbus_reader(ruby_name, type, dbus_name: dbus_name)
     end
 
@@ -139,6 +156,7 @@ module DBus
     # @return (see .dbus_attr_accessor)
     def self.dbus_attr_writer(ruby_name, type, dbus_name: nil)
       attr_writer(ruby_name)
+
       dbus_writer(ruby_name, type, dbus_name: dbus_name)
     end
 
@@ -211,6 +229,7 @@ module DBus
     # @return [void]
     def self.dbus_watcher(ruby_name, dbus_name: nil)
       raise UndefinedInterface, ruby_name if @@cur_intf.nil?
+
       cur_intf = @@cur_intf
 
       ruby_name = ruby_name.to_s.sub(/=$/, "").to_sym
@@ -235,6 +254,7 @@ module DBus
     # @param prototype [Prototype]
     def self.dbus_method(sym, prototype = "", &block)
       raise UndefinedInterface, sym if @@cur_intf.nil?
+
       @@cur_intf.define(Method.new(sym.to_s).from_prototype(prototype))
 
       ruby_name = Object.make_method_name(@@cur_intf.name, sym.to_s)
@@ -254,6 +274,7 @@ module DBus
     # Defines a signal for the object with a given name _sym_ and _prototype_.
     def self.dbus_signal(sym, prototype = "")
       raise UndefinedInterface, sym if @@cur_intf.nil?
+
       cur_intf = @@cur_intf
       signal = Signal.new(sym.to_s).from_prototype(prototype)
       cur_intf.define(Signal.new(sym.to_s).from_prototype(prototype))

data/lib/dbus/object_path.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of the ruby-dbus project
 # Copyright (C) 2019 Martin Vidner
 #
@@ -8,17 +10,19 @@
 
 module DBus
   # A {::String} that validates at initialization time
+  # @see https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-marshaling-object-path
   class ObjectPath < String
     # @raise Error if not a valid object path
-    def initialize(s)
-      unless self.class.valid?(s)
-        raise DBus::Error, "Invalid object path #{s.inspect}"
+    def initialize(str)
+      unless self.class.valid?(str)
+        raise DBus::Error, "Invalid object path #{str.inspect}"
       end
+
       super
     end
 
-    def self.valid?(s)
-      s == "/" || s =~ %r{\A(/[A-Za-z0-9_]+)+\z}
+    def self.valid?(str)
+      str == "/" || str =~ %r{\A(/[A-Za-z0-9_]+)+\z}
     end
   end
 end

data/lib/dbus/proxy_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of the ruby-dbus project
 # Copyright (C) 2007 Arnaud Cornet and Paul van Tilburg
 # Copyright (C) 2009-2014 Martin Vidner
@@ -57,6 +59,7 @@ module DBus
       introspect unless introspected
       ifc = @interfaces[intfname]
       raise DBus::Error, "no such interface `#{intfname}' on object `#{@path}'" unless ifc
+
       ifc
     end
 
@@ -93,6 +96,7 @@ module DBus
           # don't overwrite instance methods!
           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
@@ -124,14 +128,17 @@ module DBus
     def on_signal(name, &block)
       # TODO: improve
       raise NoMethodError unless @default_iface && has_iface?(@default_iface)
+
       @interfaces[@default_iface].on_signal(name, &block)
     end
 
     ####################################################
     private
 
-    # rubocop:disable Style/MethodMissing
-    # but https://github.com/rubocop-hq/ruby-style-guide#no-method-missing
+    # rubocop:disable Lint/MissingSuper
+    # as this should forward everything
+    #
+    # https://github.com/rubocop-hq/ruby-style-guide#no-method-missing
     # and http://blog.marc-andre.ca/2010/11/15/methodmissing-politely/
     # have a point to be investigated
 
@@ -152,10 +159,17 @@ module DBus
         # 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
-    # rubocop:enable Style/MethodMissing
-  end # class ProxyObject
+    # rubocop:enable Lint/MissingSuper
+
+    def respond_to_missing?(name, _include_private = false)
+      @default_iface &&
+        has_iface?(@default_iface) &&
+        @interfaces[@default_iface].methods.key?(name) or super
+    end
+  end
 end

data/lib/dbus/proxy_object_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of the ruby-dbus project
 # Copyright (C) 2007 Arnaud Cornet and Paul van Tilburg
 # Copyright (C) 2009-2014 Martin Vidner
@@ -22,17 +24,19 @@ module DBus
       @api = api
     end
 
-    # Investigates the sub-nodes of the proxy object _po_ based on the
+    # Investigates the sub-nodes of the proxy object _pobj_ based on the
     # introspection XML data _xml_ and sets them up recursively.
-    def self.introspect_into(po, xml)
-      intfs, po.subnodes = IntrospectXMLParser.new(xml).parse
+    # @param pobj [ProxyObject]
+    # @param xml [String]
+    def self.introspect_into(pobj, xml)
+      intfs, pobj.subnodes = IntrospectXMLParser.new(xml).parse
       intfs.each do |i|
-        poi = ProxyObjectInterface.new(po, i.name)
+        poi = ProxyObjectInterface.new(pobj, i.name)
         i.methods.each_value { |m| poi.define(m) }
         i.signals.each_value { |s| poi.define(s) }
-        po[i.name] = poi
+        pobj[i.name] = poi
       end
-      po.introspected = true
+      pobj.introspected = true
     end
 
     # Generates, sets up and returns the proxy object.
@@ -41,5 +45,5 @@ module DBus
       ProxyObjectFactory.introspect_into(po, @xml)
       po
     end
-  end # class ProxyObjectFactory
+  end
 end

data/lib/dbus/proxy_object_interface.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of the ruby-dbus project
 # Copyright (C) 2007 Arnaud Cornet and Paul van Tilburg
 # Copyright (C) 2009-2014 Martin Vidner
@@ -36,27 +38,28 @@ module DBus
       @name
     end
 
-    # Defines a method on the interface from the Method descriptor _m_.
-    def define_method_from_descriptor(m)
-      m.params.each do |fpar|
+    # Defines a method on the interface from the Method descriptor _method_.
+    # @param method [Method]
+    def define_method_from_descriptor(method)
+      method.params.each do |fpar|
         par = fpar.type
         # This is the signature validity check
         Type::Parser.new(par).parse
       end
 
       singleton_class.class_eval do
-        define_method m.name do |*args, &reply_handler|
-          if m.params.size != args.size
-            raise ArgumentError, "wrong number of arguments (#{args.size} for #{m.params.size})"
+        define_method method.name do |*args, &reply_handler|
+          if method.params.size != args.size
+            raise ArgumentError, "wrong number of arguments (#{args.size} for #{method.params.size})"
           end
 
           msg = Message.new(Message::METHOD_CALL)
           msg.path = @object.path
           msg.interface = @name
           msg.destination = @object.destination
-          msg.member = m.name
+          msg.member = method.name
           msg.sender = @object.bus.unique_name
-          m.params.each do |fpar|
+          method.params.each do |fpar|
             par = fpar.type
             msg.add_param(par, args.shift)
           end
@@ -64,30 +67,31 @@ module DBus
           if ret.nil? || @object.api.proxy_method_returns_array
             ret
           else
-            m.rets.size == 1 ? ret.first : ret
+            method.rets.size == 1 ? ret.first : ret
           end
         end
       end
 
-      @methods[m.name] = m
+      @methods[method.name] = method
     end
 
-    # Defines a signal from the descriptor _s_.
-    def define_signal_from_descriptor(s)
-      @signals[s.name] = s
+    # Defines a signal from the descriptor _sig_.
+    # @param sig [Signal]
+    def define_signal_from_descriptor(sig)
+      @signals[sig.name] = sig
     end
 
-    # Defines a signal or method based on the descriptor _m_.
-    def define(m)
-      if m.is_a?(Method)
-        define_method_from_descriptor(m)
-      elsif m.is_a?(Signal)
-        define_signal_from_descriptor(m)
+    # Defines a signal or method based on the descriptor _ifc_el_.
+    def define(ifc_el)
+      case ifc_el
+      when Method
+        define_method_from_descriptor(ifc_el)
+      when Signal
+        define_signal_from_descriptor(ifc_el)
       end
     end
 
     # Defines a proxied method on the interface.
-    # Better name: declare_method
     def define_method(methodname, prototype)
       m = Method.new(methodname)
       m.from_prototype(prototype)
@@ -110,7 +114,7 @@ module DBus
       end
     end
 
-    PROPERTY_INTERFACE = "org.freedesktop.DBus.Properties".freeze
+    PROPERTY_INTERFACE = "org.freedesktop.DBus.Properties"
 
     # Read a property.
     # @param propname [String]
@@ -142,5 +146,5 @@ module DBus
         ret
       end
     end
-  end # class ProxyObjectInterface
+  end
 end

data/lib/dbus/type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # dbus/type.rb - module containing low-level D-Bus data type information
 #
 # This file is part of the ruby-dbus project
@@ -33,7 +35,7 @@ module DBus
   # protocol.
   module Type
     # Mapping from type number to name and alignment.
-    TypeMapping = {
+    TYPE_MAPPING = {
       0 => ["INVALID", nil],
       "y" => ["BYTE", 1],
       "b" => ["BOOLEAN", 4],
@@ -54,7 +56,7 @@ module DBus
       "h" => ["UNIX_FD", 4]
     }.freeze
     # Defines the set of constants
-    TypeMapping.each_pair do |key, value|
+    TYPE_MAPPING.each_pair do |key, value|
       Type.const_set(value.first, key)
     end
 
@@ -73,16 +75,17 @@ module DBus
 
       # Create a new type instance for type number _sigtype_.
       def initialize(sigtype)
-        if !TypeMapping.keys.member?(sigtype)
+        if !TYPE_MAPPING.keys.member?(sigtype)
           raise SignatureException, "Unknown key in signature: #{sigtype.chr}"
         end
+
         @sigtype = sigtype
         @members = []
       end
 
       # Return the required alignment for the type.
       def alignment
-        TypeMapping[@sigtype].last
+        TYPE_MAPPING[@sigtype].last
       end
 
       # Return a string representation of the type according to the
@@ -90,36 +93,38 @@ module DBus
       def to_s
         case @sigtype
         when STRUCT
-          "(" + @members.collect(&:to_s).join + ")"
+          "(#{@members.collect(&:to_s).join})"
         when ARRAY
-          "a" + child.to_s
+          "a#{child}"
         when DICT_ENTRY
-          "{" + @members.collect(&:to_s).join + "}"
+          "{#{@members.collect(&:to_s).join}}"
         else
-          if !TypeMapping.keys.member?(@sigtype)
+          if !TYPE_MAPPING.keys.member?(@sigtype)
             raise NotImplementedError
           end
+
           @sigtype.chr
         end
       end
 
-      # Add a new member type _a_.
-      def <<(a)
+      # Add a new member type _item_.
+      def <<(item)
         if ![STRUCT, ARRAY, DICT_ENTRY].member?(@sigtype)
           raise SignatureException
         end
         raise SignatureException if @sigtype == ARRAY && !@members.empty?
+
         if @sigtype == DICT_ENTRY
-          if @members.size == 2
+          case @members.size
+          when 2
             raise SignatureException, "Dict entries have exactly two members"
-          end
-          if @members.empty?
-            if [STRUCT, ARRAY, DICT_ENTRY].member?(a.sigtype)
+          when 0
+            if [STRUCT, ARRAY, DICT_ENTRY].member?(item.sigtype)
               raise SignatureException, "Dict entry keys must be basic types"
             end
           end
         end
-        @members << a
+        @members << item
       end
 
       # Return the first contained member type.
@@ -128,19 +133,20 @@ module DBus
       end
 
       def inspect
-        s = TypeMapping[@sigtype].first
+        s = TYPE_MAPPING[@sigtype].first
         if [STRUCT, ARRAY].member?(@sigtype)
-          s += ": " + @members.inspect
+          s += ": #{@members.inspect}"
         end
         s
       end
-    end # class Type
+    end
 
     # = D-Bus type parser class
     #
     # Helper class to parse a type signature in the protocol.
     class Parser
       # Create a new parser for the given _signature_.
+      # @param signature [Signature]
       def initialize(signature)
         @signature = signature
         @idx = 0
@@ -153,30 +159,31 @@ module DBus
         c
       end
 
-      # Parse one character _c_ of the signature.
-      def parse_one(c)
+      # Parse one character _char_ of the signature.
+      def parse_one(char)
         res = nil
-        case c
+        case char
         when "a"
           res = Type.new(ARRAY)
-          c = nextchar
-          raise SignatureException, "Parse error in #{@signature}" if c.nil?
-          child = parse_one(c)
+          char = nextchar
+          raise SignatureException, "Parse error in #{@signature}" if char.nil?
+
+          child = parse_one(char)
           res << child
         when "("
           res = Type.new(STRUCT)
-          while (c = nextchar) && c != ")"
-            res << parse_one(c)
+          while (char = nextchar) && char != ")"
+            res << parse_one(char)
           end
-          raise SignatureException, "Parse error in #{@signature}" if c.nil?
+          raise SignatureException, "Parse error in #{@signature}" if char.nil?
         when "{"
           res = Type.new(DICT_ENTRY)
-          while (c = nextchar) && c != "}"
-            res << parse_one(c)
+          while (char = nextchar) && char != "}"
+            res << parse_one(char)
           end
-          raise SignatureException, "Parse error in #{@signature}" if c.nil?
+          raise SignatureException, "Parse error in #{@signature}" if char.nil?
         else
-          res = Type.new(c)
+          res = Type.new(char)
         end
         res
       end
@@ -190,8 +197,8 @@ module DBus
         end
         ret
       end
-    end # class Parser
-  end # module Type
+    end
+  end
 
   # shortcuts
 
@@ -206,4 +213,4 @@ module DBus
     [type(string_type), value]
   end
   module_function :variant
-end # module DBus
+end

data/lib/dbus/xml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # dbus/xml.rb - introspection parser, rexml/nokogiri abstraction
 #
 # This file is part of the ruby-dbus project
@@ -26,14 +28,23 @@ module DBus
       attr_accessor :backend
     end
     # Creates a new parser for XML data in string _xml_.
+    # @param xml [String]
     def initialize(xml)
       @xml = xml
     end
 
     class AbstractXML
+      # @!method initialize(xml)
+      # @abstract
+
+      # @!method each(xpath)
+      # @abstract
+      # yields nodes which match xpath of type AbstractXML::Node
+
       def self.have_nokogiri?
         Object.const_defined?("Nokogiri")
       end
+
       class Node
         def initialize(node)
           @node = node
@@ -46,12 +57,6 @@ module DBus
         # yields child nodes which match xpath of type AbstractXML::Node
         def each(xpath); end
       end
-      # required methods
-      # initialize parser with xml string
-      def initialize(xml); end
-
-      # yields nodes which match xpath of type AbstractXML::Node
-      def each(xpath); end
     end
 
     class NokogiriParser < AbstractXML
@@ -64,7 +69,9 @@ module DBus
           @node.search(path).each { |node| block.call NokogiriNode.new(node) }
         end
       end
+
       def initialize(xml)
+        super()
         @doc = Nokogiri.XML(xml)
       end
 
@@ -83,7 +90,9 @@ module DBus
           @node.elements.each(path) { |node| block.call REXMLNode.new(node) }
         end
       end
+
       def initialize(xml)
+        super()
         @doc = REXML::Document.new(xml)
       end
 
@@ -136,28 +145,30 @@ module DBus
     ######################################################################
     private
 
-    # Parses a method signature XML element _e_ and initialises
-    # method/signal _m_.
-    def parse_methsig(e, m)
-      e.each("arg") do |ae|
+    # Parses a method signature XML element *elem* and initialises
+    # method/signal *methsig*.
+    # @param elem [AbstractXML::Node]
+    def parse_methsig(elem, methsig)
+      elem.each("arg") do |ae|
         name = ae["name"]
         dir = ae["direction"]
         sig = ae["type"]
-        if m.is_a?(DBus::Signal)
+        case methsig
+        when DBus::Signal
           # Direction can only be "out", ignore it
-          m.add_fparam(name, sig)
-        elsif m.is_a?(DBus::Method)
+          methsig.add_fparam(name, sig)
+        when DBus::Method
           case dir
           # This is a method, so dir defaults to "in"
           when "in", nil
-            m.add_fparam(name, sig)
+            methsig.add_fparam(name, sig)
           when "out"
-            m.add_return(name, sig)
+            methsig.add_return(name, sig)
           end
         else
           raise NotImplementedError, dir
         end
       end
     end
-  end # class IntrospectXMLParser
-end # module DBus
+  end
+end

data/lib/dbus.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # dbus.rb - Module containing the low-level D-Bus implementation
 #
 # This file is part of the ruby-dbus project
@@ -28,22 +30,20 @@ require_relative "dbus/type"
 require_relative "dbus/xml"
 
 require "socket"
-require "thread"
-
 # = D-Bus main module
 #
 # Module containing all the D-Bus modules and classes.
 module DBus
   # Default socket name for the system bus.
-  SystemSocketName = "unix:path=/var/run/dbus/system_bus_socket".freeze
+  SYSTEM_BUS_ADDRESS = "unix:path=/var/run/dbus/system_bus_socket"
 
   # Byte signifying big endianness.
-  BIG_END = "B".freeze
+  BIG_END = "B"
   # Byte signifying little endianness.
-  LIL_END = "l".freeze
+  LIL_END = "l"
 
   # Byte signifying the host's endianness.
-  HOST_END = if [0x01020304].pack("L").unpack("V")[0] == 0x01020304
+  HOST_END = if [0x01020304].pack("L").unpack1("V") == 0x01020304
                LIL_END
              else
                BIG_END
@@ -69,4 +69,4 @@ module DBus
   # Exception raised when invalid introspection data is parsed/used.
   class InvalidIntrospectionData < Exception
   end
-end # module DBus
+end