Service side properties

[mvidner]

Until https://www.rubydoc.info/gems/ruby-dbus renders it, see Reference.md and the API comments in DBus::Object

Example

(rake doc:examples; cat examples/doc/exporting_properties.rb)

#! /usr/bin/env ruby
require "dbus"
# https://github.com/mvidner/ruby-dbus/blob/master/doc/Reference.md#exporting-properties
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

Tests

• pass locally, rake spec
• pass with rake osc:build on Tumbleweed (local problems with non-matching abuild user? edit /etc/passwd and chown home!)
• reintroduce CI on GItHub instead of the discontinued Travis-CI.org: CI with GitHub Actions #93

Documentation

• Review the doc/ files to update them regarding properties
• make the example/ work

[lslezak]

Thanks, LGTM so far.

[jreidinger]

👍

[coveralls]

Coverage decreased (-1.04%) to 84.32% when pulling 4d2a82e on service-properties into da3c1de on master.

[mvidner]

Coverage check fails because the new CI misses the code covered by the asynchronously started service and counts only the code run directly by RSpec. Locally it works :-/