ruby-dbus 0.14.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 95dfa24c76e4ed5aeb5997bd160a4efd69a8c146
-  data.tar.gz: 244e215c35cff67f53c7f7ac51a699c2fec22b2d
+SHA256:
+  metadata.gz: ee629ce8a78d7cd23f718103cfd622d2a5fd67c51dab6b2a88e453c512c608f3
+  data.tar.gz: a8995a9526e3b957d32c503de7ad5ef781e5c464925fec8e2107eda4529aa447
 SHA512:
-  metadata.gz: f020e993e5a6777c7ea540cf1197200aa6f1c3c7003f331b42b73cea3d5937925243bf46d2668488e8854bb7ac34d88a20934a18e90a2bb46d9fca7bcb8de764
-  data.tar.gz: 160ebb98a13e02b982c7b634a02aa271b5899d54be289c9f5d71c0a2f8b9fcfc1190e4e19854a1a236a237f875cd108bad280a6bdbe571e68cb38afaad10b6b4
+  metadata.gz: 531e01c12aed4aeedaa5ce55fec2fee0c3da714211adc768c8990d2ce79509e6b925bc06d4308e9628cff109b9880dbea72878e7aeaf23c8e5fb19ddf8a249e2
+  data.tar.gz: 6449aa2798ed78d29c430423a92d7c8a921fd4ea244eea11fb8a84ca2eb880a4e6860325dc6a05254dc432b971d4929fc4d3a5057e423939c0574a687e7680f7

data/NEWS.md

@@ -2,6 +2,50 @@
 
 ## 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:
+ * An invalid service name or an invalid object path will raise
+   instead of being sent to the bus. The bus would then drop the connection,
+   producing EOFError here ([#80][]).
+
+[#80]: https://github.com/mvidner/ruby-dbus/issues/80
+
+## Ruby D-Bus 0.15.0 - 2018-04-30
+
+API:
+ * Accessing an unknown interface will raise instead of returning nil ([#74][]).
+
+Bug fixes:
+ * Fixed a conflict with activesupport 5.2 ([#71])
+
+[#71]: https://github.com/mvidner/ruby-dbus/issues/71
+[#74]: https://github.com/mvidner/ruby-dbus/pull/74
+
+## Ruby D-Bus 0.14.1 - 2018-01-05
+
+Bug fixes:
+ * Allow registering signal handlers while a signal is being handled
+   ([#70][], Jan Biniok).
+
+[#70]: https://github.com/mvidner/ruby-dbus/pull/70
+
 ## Ruby D-Bus 0.14.0 - 2017-10-13
 
 Bug fixes:

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
+[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|
@@ -29,7 +35,7 @@ task test: :spec
 
 RSpec::Core::RakeTask.new("bare:spec")
 
-%w(spec).each do |tname|
+["spec"].each do |tname|
   desc "Run bare:#{tname} in the proper environment"
   task tname do |_t|
     cd "spec/tools" do
@@ -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.14.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
 
@@ -226,7 +227,7 @@ class DBusUI
 
   def introspect_services(model, bus)
     el = @introspect_array.shift
-    if !(el =~ /^:/)
+    if el !~ /^:/
       iter = model.append(nil)
       iter[0] = el
       puts "introspecting: #{el}"

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) == 0
+        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
@@ -28,7 +28,7 @@ module DBus
 
     # Create a new service with a given _name_ on a given _bus_.
     def initialize(name, bus)
-      @name = name
+      @name = BusName.new(name)
       @bus = bus
       @root = Node.new("/")
     end
@@ -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>"
@@ -387,7 +389,7 @@ module DBus
         # introspect in synchronous !
         data = introspect_data(dest, path)
         pof = DBus::ProxyObjectFactory.new(data, self, dest, path)
-        return pof.build
+        pof.build
       else
         introspect_data(dest, path) do |async_data|
           yield(DBus::ProxyObjectFactory.new(async_data, self, dest, path).build)
@@ -458,6 +460,9 @@ module DBus
         retm = wait_for_message
         process(retm)
       end
+    rescue EOFError
+      new_err = DBus::Error.new("Connection dropped after we sent #{m.inspect}")
+      raise new_err
     end
 
     # @api private
@@ -529,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
@@ -538,7 +544,8 @@ module DBus
         end
       when DBus::Message::SIGNAL
         # the signal can match multiple different rules
-        @signal_matchrules.each do |mrs, slot|
+        # clone to allow new signale handlers to be registered
+        @signal_matchrules.dup.each do |mrs, slot|
           if DBus::MatchRule.new.from_s(mrs).match(m)
             slot.call(m)
           end
@@ -562,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
@@ -664,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/bus_name.rb

@@ -0,0 +1,27 @@
+# This file is part of the ruby-dbus project
+# Copyright (C) 2019 Martin Vidner
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License, version 2.1 as published by the Free Software Foundation.
+# See the file "COPYING" for the exact licensing terms.
+
+module DBus
+  # A {::String} that validates at initialization time
+  # @see https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus
+  class BusName < String
+    # @raise Error if not a valid bus name
+    def initialize(s)
+      unless self.class.valid?(s)
+        raise DBus::Error, "Invalid bus name #{s.inspect}"
+      end
+      super
+    end
+
+    def self.valid?(s)
+      s.size <= 255 &&
+        (s =~ /\A:[A-Za-z0-9_-]+(\.[A-Za-z0-9_-]+)+\z/ ||
+         s =~ /\A[A-Za-z_-][A-Za-z0-9_-]*(\.[A-Za-z_-][A-Za-z0-9_-]*)+\z/)
+    end
+  end
+end

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

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
 # copied from activesupport/core_ext from Rails, MIT license
-# https://github.com/rails/rails/tree/5aa869861c192daceafe3a3ee50eb93f5a2b7bd2/activesupport/lib/active_support/core_ext
-require 'dbus/core_ext/kernel/singleton_class'
-require 'dbus/core_ext/module/remove_method'
-require 'dbus/core_ext/array/extract_options'
+# https://github.com/rails/rails/tree/9794e85351243cac6d4e78adaba634b8e4ecad0a/activesupport/lib/active_support/core_ext
+
+require_relative "../module/redefine_method"
 
 class Class
   # Declare a class-level attribute whose value is inheritable by subclasses.
   # Subclasses can change their own value and it will not impact parent class.
   #
+  # ==== Examples
+  #
   #   class Base
-  #     class_attribute :setting
+  #     my_class_attribute :setting
   #   end
   #
   #   class Subclass < Base
@@ -22,14 +24,14 @@ class Class
   #   Base.setting                # => true
   #
   # In the above case as long as Subclass does not assign a value to setting
-  # by performing <tt>Subclass.setting = _something_ </tt>, <tt>Subclass.setting</tt>
+  # by performing <tt>Subclass.setting = _something_</tt>, <tt>Subclass.setting</tt>
   # would read value assigned to parent class. Once Subclass assigns a value then
   # the value assigned by Subclass would be returned.
   #
   # This matches normal Ruby method inheritance: think of writing an attribute
   # on a subclass as overriding the reader method. However, you need to be aware
   # when using +class_attribute+ with mutable structures as +Array+ or +Hash+.
-  # In such cases, you don't want to do changes in places but use setters:
+  # In such cases, you don't want to do changes in place. Instead use setters:
   #
   #   Base.setting = []
   #   Base.setting                # => []
@@ -59,39 +61,25 @@ class Class
   #   object.setting = false
   #   object.setting          # => false
   #   Base.setting            # => true
-  #
-  # To opt out of the instance reader method, pass <tt>instance_reader: false</tt>.
-  #
-  #   object.setting          # => NoMethodError
-  #   object.setting?         # => NoMethodError
-  #
-  # To opt out of the instance writer method, pass <tt>instance_writer: false</tt>.
-  #
-  #   object.setting = false  # => NoMethodError
-  #
-  # To opt out of both instance methods, pass <tt>instance_accessor: false</tt>.
-  def class_attribute(*attrs)
-    options = attrs.extract_options!
-    instance_reader = options.fetch(:instance_accessor, true) && options.fetch(:instance_reader, true)
-    instance_writer = options.fetch(:instance_accessor, true) && options.fetch(:instance_writer, true)
-    instance_predicate = options.fetch(:instance_predicate, true)
+  def my_class_attribute(*attrs)
+    instance_reader    = true
+    instance_writer    = true
 
     attrs.each do |name|
+      singleton_class.silence_redefinition_of_method(name)
       define_singleton_method(name) { nil }
-      define_singleton_method("#{name}?") { !!public_send(name) } if instance_predicate
 
-      ivar = "@#{name}"
+      ivar = "@#{name}".to_sym
 
+      singleton_class.silence_redefinition_of_method("#{name}=")
       define_singleton_method("#{name}=") do |val|
         singleton_class.class_eval do
-          remove_possible_method(name)
-          define_method(name) { val }
+          redefine_method(name) { val }
         end
 
         if singleton_class?
           class_eval do
-            remove_possible_method(name)
-            define_method(name) do
+            redefine_method(name) do
               if instance_variable_defined? ivar
                 instance_variable_get ivar
               else
@@ -104,26 +92,20 @@ class Class
       end
 
       if instance_reader
-        remove_possible_method name
-        define_method(name) do
+        redefine_method(name) do
           if instance_variable_defined?(ivar)
             instance_variable_get ivar
           else
             self.class.public_send name
           end
         end
-        define_method("#{name}?") { !!public_send(name) } if instance_predicate
       end
 
-      attr_writer name if instance_writer
-    end
-  end
-
-  private
-
-    unless respond_to?(:singleton_class?)
-      def singleton_class?
-        ancestors.first != self
+      if instance_writer
+        redefine_method("#{name}=") do |val|
+          instance_variable_set ivar, val
+        end
       end
     end
+  end
 end