ruby-dbus 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8a530c6d561a17c6179bda15319036a806f1a42b427033e96caccfc738ebf7b
-  data.tar.gz: 959143cab388b528354cc569c698a8c99dc79bbca1b21dbdcc064e212b8794a2
+  metadata.gz: ee629ce8a78d7cd23f718103cfd622d2a5fd67c51dab6b2a88e453c512c608f3
+  data.tar.gz: a8995a9526e3b957d32c503de7ad5ef781e5c464925fec8e2107eda4529aa447
 SHA512:
-  metadata.gz: 41d4ff1294958f67efac62ae0d1b326728617976ea944f3c3374f7156bf33632e9e072260f002c11ca44b099113d75e5ecc58f67c3d2c9d34666f6abe92bdbb3
-  data.tar.gz: c93e54662d3cf01a9b0ac0a2e5c70d0efc78da1758349cfe6209cba37fa707b7334503518a7e0b4f53d754aff22d5ff53c2d7f8c2d8c32e6df9b097a1bf0f34b
+  metadata.gz: 531e01c12aed4aeedaa5ce55fec2fee0c3da714211adc768c8990d2ce79509e6b925bc06d4308e9628cff109b9880dbea72878e7aeaf23c8e5fb19ddf8a249e2
+  data.tar.gz: 6449aa2798ed78d29c430423a92d7c8a921fd4ea244eea11fb8a84ca2eb880a4e6860325dc6a05254dc432b971d4929fc4d3a5057e423939c0574a687e7680f7

data/NEWS.md

@@ -2,6 +2,22 @@
 
 ## Unreleased
 
+## Ruby D-Bus 0.17.0 - 2022-02-11
+
+API:
+ * Export properties with `dbus_attr_accessor`, `dbus_reader` etc. ([#86][]).
+
+Bug fixes:
+ * Depend on rexml which is separate since Ruby 3.0 ([#87][],
+   by Toshiaki Asai).
+   Nokogiri is faster but bigger so it remains optional.
+ * Fix connection in case ~/.dbus-keyrings has multiple cookies, showing
+   as "Oops: undefined method `zero?' for nil:NilClass".
+ * Add the missing name to the root introspection node.
+
+[#86]: https://github.com/mvidner/ruby-dbus/pull/86
+[#87]: https://github.com/mvidner/ruby-dbus/pull/87
+
 ## Ruby D-Bus 0.16.0 - 2019-10-15
 
 API:

data/README.md

@@ -11,14 +11,13 @@ Ruby D-Bus is a pure Ruby library for writing clients and services for D-Bus.
 [![Coverage Status][CS img]][Coverage Status]
 
 [Gem Version]: https://rubygems.org/gems/ruby-dbus
-[Build Status]: https://travis-ci.org/mvidner/ruby-dbus
-[travis pull requests]: https://travis-ci.org/mvidner/ruby-dbus/pull_requests
+[Build Status]: https://github.com/mvidner/ruby-dbus/actions?query=branch%3Amaster
 [Dependency Status]: https://gemnasium.com/mvidner/ruby-dbus
 [Code Climate]: https://codeclimate.com/github/mvidner/ruby-dbus
 [Coverage Status]: https://coveralls.io/r/mvidner/ruby-dbus
 
 [GV img]: https://badge.fury.io/rb/ruby-dbus.png
-[BS img]: https://travis-ci.org/mvidner/ruby-dbus.png?branch=master
+[BS img]: https://github.com/mvidner/ruby-dbus/workflows/CI/badge.svg?branch=master
 [DS img]: https://gemnasium.com/mvidner/ruby-dbus.png
 [CC img]: https://codeclimate.com/github/mvidner/ruby-dbus.png
 [CS img]: https://coveralls.io/repos/mvidner/ruby-dbus/badge.png?branch=master
@@ -32,7 +31,6 @@ via [UPower](http://upower.freedesktop.org/docs/UPower.html#UPower:OnBattery)
     sysbus = DBus.system_bus
     upower_service   = sysbus["org.freedesktop.UPower"]
     upower_object    = upower_service["/org/freedesktop/UPower"]
-    upower_object.introspect
     upower_interface = upower_object["org.freedesktop.UPower"]
     on_battery       = upower_interface["OnBattery"]
     if on_battery
@@ -43,7 +41,7 @@ via [UPower](http://upower.freedesktop.org/docs/UPower.html#UPower:OnBattery)
 
 ## Requirements
 
-- Ruby 2.0 or newer.
+- Ruby 2.1 or newer.
 
 
 ## Installation

data/Rakefile

@@ -9,6 +9,12 @@ begin
 rescue LoadError
   nil
 end
+begin
+  require "yard"
+rescue LoadError
+  nil
+end
+
 require "packaging"
 
 Packaging.configuration do |conf|
@@ -38,12 +44,6 @@ RSpec::Core::RakeTask.new("bare:spec")
   end
 end
 
-if ENV["TRAVIS"]
-  require "coveralls/rake/task"
-  Coveralls::RakeTask.new
-  task default: "coveralls:push"
-end
-
 # remove tarball implementation and create gem for this gemfile
 Rake::Task[:tarball].clear
 
@@ -68,4 +68,22 @@ namespace :doc do
   end
 end
 
-RuboCop::RakeTask.new if Object.const_defined? :RuboCop
+if Object.const_defined? :RuboCop
+  if RUBY_VERSION.start_with?("2.")
+    RuboCop::RakeTask.new
+  else
+    desc "Run RuboCop (dummy)"
+    task :rubocop do
+      warn "The code is not adapted to recent RuboCop yet,\n" \
+           "and the old one no longer works with Ruby 3.x.\n" \
+           "Switch back to Ruby 2.x to run it."
+    end
+  end
+else
+  desc "Run RuboCop (dummy)"
+  task :rubocop do
+    warn "RuboCop not installed"
+  end
+end
+
+YARD::Rake::YardocTask.new if Object.const_defined? :YARD

data/VERSION

@@ -1 +1 @@
-0.16.0
+0.17.0

data/doc/Reference.md

@@ -179,7 +179,7 @@ If the signature expects a Variant
    ISSUE: using something else than cryptic signatures is even more painful
    than remembering the signatures!
 
-        foo_i["Bar"] = DBus.variant("au", [0, 1, 1, 2, 3, 5, 8])
+   `foo_i["Bar"] = DBus.variant("au", [0, 1, 1, 2, 3, 5, 8])`
 
 2. Other values are tried to fit one of these:
    Boolean, Double, Array of Variants, Hash of String keyed Variants,
@@ -244,14 +244,97 @@ When you want to provide a DBus API.
 (check that client and service side have their counterparts)
 
 ### Basic
+
 #### Exporting a Method
+
 ##### Interfaces
+
 ##### Methods
+
 ##### Bus Names
+
 ##### Errors
+
 #### Exporting Properties
+
+Similar to plain Ruby attributes, declared with
+
+- {https://docs.ruby-lang.org/en/3.1/Module.html#method-i-attr_accessor attr_accessor}
+- {https://docs.ruby-lang.org/en/3.1/Module.html#method-i-attr_reader attr_reader}
+- {https://docs.ruby-lang.org/en/3.1/Module.html#method-i-attr_writer attr_writer}
+
+These methods declare the attributes and export them as properties:
+
+- {DBus::Object.dbus_attr_accessor}
+- {DBus::Object.dbus_attr_reader}
+- {DBus::Object.dbus_attr_writer}
+
+For making properties out of Ruby methods (which are not attributes), use:
+
+- {DBus::Object.dbus_accessor}
+- {DBus::Object.dbus_reader}
+- {DBus::Object.dbus_writer}
+
+Note that the properties are declared in the Ruby naming convention with
+`snake_case` and D-Bus sees them `CamelCased`. Use the `dbus_name` argument
+for overriding this.
+
+ 
+
+    class Note < DBus::Object
+      dbus_interface "net.vidner.Example.Properties" do
+        # A read-write property "Title",
+        # with `title` and `title=` accessing @title.
+        dbus_attr_accessor :title, DBus::Type::STRING
+
+        # A read-only property "Author"
+        # (type specified via DBus signature)
+        # with `author` reading `@author`
+        dbus_attr_reader :author, "s"
+
+        # A read-only property `Clock`
+        def clock
+          Time.now.to_s
+        end
+        dbus_reader :clock, "s"
+
+        # Name mapping: `CreationTime`
+        def creation_time
+          "1993-01-01 00:00:00 +0100"
+        end
+        dbus_reader :creation_time, "s"
+
+        dbus_attr_accessor :book_volume, DBus::Type::VARIANT, dbus_name: "Volume"
+      end
+
+      dbus_interface "net.vidner.Example.Audio" do
+        dbus_attr_accessor :speaker_volume, DBus::Type::BYTE, dbus_name: "Volume"
+      end
+
+      # Must assign values because `nil` would crash our connection
+      def initialize(opath)
+        super
+        @title = "Ahem"
+        @author = "Martin"
+        @book_volume = 1
+        @speaker_volume = 11
+      end
+    end
+
+    obj = Note.new("/net/vidner/Example/Properties")
+
+    bus = DBus::SessionBus.instance
+    service = bus.request_service("net.vidner.Example")
+    service.export(obj)
+
+    main = DBus::Main.new
+    main << bus
+    main.run
+
 ### Advanced
+
 #### Inheritance
+
 #### Names
 
 Specification Conformance

data/examples/doc/_extract_examples

@@ -4,6 +4,9 @@ if ARGV[0].nil?
   exit
 end
 
+base_url = "https://github.com/mvidner/ruby-dbus/blob/master/"
+base_url += ARGV[0].gsub("../", "")
+
 File.open(ARGV[0]) do |f|
   title = nil
   setup = ""
@@ -20,7 +23,9 @@ File.open(ARGV[0]) do |f|
           setup = example
         else
           File.open("#{basename}.rb", "w") do |e|
+            anchor = title.downcase.gsub(/ +/, "-")
             e.write setup
+            e.write "# #{base_url}##{anchor}\n"
             e.write example
             e.chmod(0o755)
           end

data/examples/gdbus/gdbus

@@ -119,25 +119,26 @@ class DBusUI
     model = Gtk::ListStore.new(String, String, DBus::Method,
                                DBus::ProxyObjectInterface)
     @methsigtreeview.model = model
-    if selected
-      if (intf = selected[1])
-        intf.methods.keys.sort.each do |mi|
-          m = intf.methods[mi]
-          subiter = model.append
-          subiter[0] = beautify_method(m)
-          subiter[1] = "M"
-          subiter[2] = m
-          subiter[3] = intf
-        end
-        intf.signals.keys.sort.each do |mi|
-          m = intf.signals[mi]
-          subiter = model.append
-          subiter[0] = beautify_method(m)
-          subiter[1] = "S"
-          subiter[2] = m
-          subiter[3] = intf
-        end
-      end
+    return unless selected
+
+    intf = selected[1]
+    return unless intf
+
+    intf.methods.keys.sort.each do |mi|
+      m = intf.methods[mi]
+      subiter = model.append
+      subiter[0] = beautify_method(m)
+      subiter[1] = "M"
+      subiter[2] = m
+      subiter[3] = intf
+    end
+    intf.signals.keys.sort.each do |mi|
+      m = intf.signals[mi]
+      subiter = model.append
+      subiter[0] = beautify_method(m)
+      subiter[1] = "S"
+      subiter[2] = m
+      subiter[3] = intf
     end
   end
 

data/examples/service/call_service.rb

@@ -14,7 +14,7 @@ player.test_variant(["s", "coucou"])
 player.on_signal("SomethingJustHappened") do |u, v|
   puts "SomethingJustHappened: #{u} #{v}"
 end
-player.hello("8=======D", "(_._)")
+player.hello("Hey", "there!")
 p player["org.ruby.AnotherInterface"].Reverse("Hello world!")
 
 main = DBus::Main.new

data/lib/dbus/auth.rb

@@ -73,7 +73,7 @@ module DBus
       path = File.join(ENV["HOME"], ".dbus-keyrings", context)
       DBus.logger.debug "path: #{path.inspect}"
       File.foreach(path) do |line|
-        if line.index(id).zero?
+        if line.start_with?(id)
           # Right line of file, read cookie
           cookie = line.split(" ")[2].chomp
           DBus.logger.debug "cookie: #{cookie.inspect}"
@@ -87,14 +87,14 @@ module DBus
           return response
         end
       end
+      return if @retries <= 0
+
       # a little rescue magic
-      unless @retries <= 0
-        puts "ERROR: Could not auth, will now exit."
-        puts "ERROR: Unable to locate cookie, retry in 1 second."
-        @retries -= 1
-        sleep 1
-        data(hexdata)
-      end
+      puts "ERROR: Could not auth, will now exit."
+      puts "ERROR: Unable to locate cookie, retry in 1 second."
+      @retries -= 1
+      sleep 1
+      data(hexdata)
     end
 
     # encode plain to hex

data/lib/dbus/bus.rb

@@ -17,7 +17,7 @@ require "singleton"
 # Module containing all the D-Bus modules and classes.
 module DBus
   # This represents a remote service. It should not be instantiated directly
-  # Use {Bus#service}
+  # Use {Connection#service}
   class Service
     # The service name.
     attr_reader :name
@@ -148,20 +148,22 @@ module DBus
 
     # Return an XML string representation of the node.
     # It is shallow, not recursing into subnodes
-    def to_xml
+    # @param node_opath [String]
+    def to_xml(node_opath)
       xml = '<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
-<node>
 '
+      xml += "<node name=\"#{node_opath}\">\n"
       each_pair do |k, _v|
-        xml += "<node name=\"#{k}\" />"
+        xml += "  <node name=\"#{k}\" />\n"
       end
       if @object
         @object.intfs.each_pair do |_k, v|
-          xml += %(<interface name="#{v.name}">\n)
+          xml += "  <interface name=\"#{v.name}\">\n"
           v.methods.each_value { |m| xml += m.to_xml }
           v.signals.each_value { |m| xml += m.to_xml }
-          xml += "</interface>\n"
+          v.properties.each_value { |m| xml += m.to_xml }
+          xml += "  </interface>\n"
         end
       end
       xml += "</node>"
@@ -532,7 +534,8 @@ module DBus
               m.member == "Introspect"
           reply = Message.new(Message::METHOD_RETURN).reply_to(m)
           reply.sender = @unique_name
-          reply.add_param(Type::STRING, node.to_xml)
+          xml = node.to_xml(m.path)
+          reply.add_param(Type::STRING, xml)
           @message_queue.push(reply)
         else
           obj = node.object
@@ -566,6 +569,11 @@ module DBus
     # @api private
     # Emit a signal event for the given _service_, object _obj_, interface
     # _intf_ and signal _sig_ with arguments _args_.
+    # @param service [Service]
+    # @param obj [DBus::Object]
+    # @param intf [Interface]
+    # @param sig [Signal]
+    # @param args arguments for the signal
     def emit(service, obj, intf, sig, *args)
       m = Message.new(DBus::Message::SIGNAL)
       m.path = obj.path
@@ -668,7 +676,7 @@ module DBus
   # (for Unix-socket) unix:path=/tmp/my_funky_bus_socket
   #
   # you'll need to take care about authentification then, more info here:
-  # http://github.com/pangdudu/ruby-dbus/blob/master/README.rdoc
+  # https://gitlab.com/pangdudu/ruby-dbus/-/blob/master/README.rdoc
   class RemoteBus < Connection
     # Get the remote bus.
     def initialize(socket_name)

data/lib/dbus/core_ext/class/attribute.rb

@@ -2,7 +2,7 @@
 # copied from activesupport/core_ext from Rails, MIT license
 # https://github.com/rails/rails/tree/9794e85351243cac6d4e78adaba634b8e4ecad0a/activesupport/lib/active_support/core_ext
 
-require "dbus/core_ext/module/redefine_method"
+require_relative "../module/redefine_method"
 
 class Class
   # Declare a class-level attribute whose value is inheritable by subclasses.

data/lib/dbus/introspect.rb

@@ -26,19 +26,23 @@ module DBus
   # 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. String
+    # @return [String] The name of the interface.
     attr_reader :name
-    # The methods that are part of the interface. Hash: Symbol => DBus::Method
+    # @return [Hash{Symbol => DBus::Method}] The methods that are part of the interface.
     attr_reader :methods
-    # The signals that are part of the interface. Hash: Symbol => Signal
+    # @return [Hash{Symbol => Signal}] The signals that are part of the interface.
     attr_reader :signals
 
+    # @return [Hash{Symbol => Property}]
+    attr_reader :properties
+
     # Creates a new interface with a given _name_.
     def initialize(name)
       validate_name(name)
       @name = name
       @methods = {}
       @signals = {}
+      @properties = {}
     end
 
     # Validates a service _name_.
@@ -52,23 +56,31 @@ module DBus
       end
     end
 
-    # Helper method for defining a method _m_.
-    def define(m)
-      if m.is_a?(Method)
-        @methods[m.name.to_sym] = m
-      elsif m.is_a?(Signal)
-        @signals[m.name.to_sym] = m
-      end
+    # Add _ie_ as a known {Method}, {Signal} or {Property}
+    # @param ie [InterfaceElement]
+    def define(ie)
+      name = ie.name.to_sym
+      category = if ie.is_a?(Method)
+                   @methods
+                 elsif ie.is_a?(Signal)
+                   @signals
+                 elsif ie.is_a?(Property)
+                   @properties
+                 end
+      category[name] = ie
     end
+    alias declare define
     alias << define
 
     # Defines a method with name _id_ and a given _prototype_ in the
     # interface.
+    # Better name: declare_method
     def define_method(id, prototype)
       m = Method.new(id)
       m.from_prototype(prototype)
       define(m)
     end
+    alias declare_method define_method
   end # class Interface
 
   # = A formal parameter has a name and a type
@@ -144,6 +156,7 @@ module DBus
     end
 
     # Add parameter types by parsing the given _prototype_.
+    # @param prototype [Prototype]
     def from_prototype(prototype)
       prototype.split(/, */).each do |arg|
         arg = arg.split(" ")
@@ -167,16 +180,16 @@ module DBus
 
     # Return an XML string representation of the method interface elment.
     def to_xml
-      xml = %(<method name="#{@name}">\n)
+      xml = "    <method name=\"#{@name}\">\n"
       @params.each do |param|
-        name = param.name ? %(name="#{param.name}" ) : ""
-        xml += %(<arg #{name}direction="in" type="#{param.type}"/>\n)
+        name = param.name ? "name=\"#{param.name}\" " : ""
+        xml += "      <arg #{name}direction=\"in\" type=\"#{param.type}\"/>\n"
       end
       @rets.each do |param|
-        name = param.name ? %(name="#{param.name}" ) : ""
-        xml += %(<arg #{name}direction="out" type="#{param.type}"/>\n)
+        name = param.name ? "name=\"#{param.name}\" " : ""
+        xml += "      <arg #{name}direction=\"out\" type=\"#{param.type}\"/>\n"
       end
-      xml += %(</method>\n)
+      xml += "    </method>\n"
       xml
     end
   end # class Method
@@ -201,13 +214,49 @@ module DBus
 
     # Return an XML string representation of the signal interface elment.
     def to_xml
-      xml = %(<signal name="#{@name}">\n)
+      xml = "    <signal name=\"#{@name}\">\n"
       @params.each do |param|
-        name = param.name ? %(name="#{param.name}" ) : ""
-        xml += %(<arg #{name}type="#{param.type}"/>\n)
+        name = param.name ? "name=\"#{param.name}\" " : ""
+        xml += "      <arg #{name}type=\"#{param.type}\"/>\n"
       end
-      xml += %(</signal>\n)
+      xml += "    </signal>\n"
       xml
     end
   end # class Signal
+
+  # An (exported) property
+  # https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties
+  class Property
+    # @return [String] The name of the property, for example FooBar.
+    attr_reader :name
+    attr_reader :type
+    # @return [Symbol] :read :write or :readwrite
+    attr_reader :access
+
+    # @return [Symbol] What to call at Ruby side.
+    #   (Always without the trailing `=`)
+    attr_reader :ruby_name
+
+    def initialize(name, type, access, ruby_name:)
+      @name = name
+      @type = type
+      @access = access
+      @ruby_name = ruby_name
+    end
+
+    # @return [Boolean]
+    def readable?
+      access == :read || access == :readwrite
+    end
+
+    # @return [Boolean]
+    def writable?
+      access == :write || access == :readwrite
+    end
+
+    # Return introspection XML string representation of the property.
+    def to_xml
+      "    <property type=\"#{@type}\" name=\"#{@name}\" access=\"#{@access}\"/>\n"
+    end
+  end
 end # module DBus

data/lib/dbus/marshall.rb

@@ -422,7 +422,7 @@ module DBus
         ["s", value.to_str]
       elsif value.respond_to? :to_int
         i = value.to_int
-        if -2_147_483_648 <= i && i < 2_147_483_648
+        if (-2_147_483_648...2_147_483_648).cover?(i)
           ["i", i]
         else
           ["x", i]

data/lib/dbus/message_queue.rb

@@ -81,22 +81,23 @@ 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") && params.key?("port")
+      host = params["host"]
+      port = params["port"]
+      if host && port
         begin
           # initialize the tcp socket
-          @socket = TCPSocket.new(params["host"], params["port"].to_i)
+          @socket = TCPSocket.new(host, 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."
+          puts "Error: Could not establish connection to: #{host}:#{port}, will now exit."
           exit(1) # a little harsh
         end
       else
         # Danger, Will Robinson: the specified "path" is not usable
-        puts "Error: supplied path: #{@path}, unusable! sorry."
+        puts "Error: supplied params: #{@params}, unusable! sorry."
       end
     end