ruby-dbus 0.14.0 → 0.17.0

data/spec/main_loop_spec.rb

@@ -70,7 +70,7 @@ describe "MainLoopTest" do
     @obj.on_signal "LongTaskEnd"
   end
 
-  it "tests loop quit" do
+  it "tests loop quit", slow: true do
     test_loop_quit 1
   end
 

data/spec/object_path_spec.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env rspec
+require_relative "spec_helper"
+require "dbus"
+
+describe DBus::ObjectPath do
+  describe ".valid?" do
+    it "recognizes valid paths" do
+      expect(described_class.valid?("/")).to be_truthy
+      expect(described_class.valid?("/99Numbers/_And_Underscores/anywhere")).to be_truthy
+      long_name = "/A23456789" * 42
+      # no 255 character limit for object paths
+      expect(described_class.valid?(long_name)).to be_truthy
+    end
+
+    it "recognizes invalid paths" do
+      expect(described_class.valid?("")).to be_falsey
+      expect(described_class.valid?("/Empty//Component")).to be_falsey
+      expect(described_class.valid?("/EmptyLastComponent/")).to be_falsey
+      expect(described_class.valid?("/Invalid Character")).to be_falsey
+      expect(described_class.valid?("/Invalid-Character")).to be_falsey
+    end
+  end
+end

data/spec/property_spec.rb

@@ -4,8 +4,8 @@ require "dbus"
 
 describe "PropertyTest" do
   before(:each) do
-    session_bus = DBus::ASessionBus.new
-    @svc = session_bus.service("org.ruby.service")
+    @session_bus = DBus::ASessionBus.new
+    @svc = @session_bus.service("org.ruby.service")
     @obj = @svc.object("/org/ruby/MyInstance")
     @iface = @obj["org.ruby.SampleInterface"]
   end
@@ -21,6 +21,10 @@ describe "PropertyTest" do
     expect(iface["ReadMe"]).to eq("READ ME")
   end
 
+  it "gets an error when reading a property whose implementation raises" do
+    expect { @iface["Explosive"] }.to raise_error(DBus::Error, /Something failed/)
+  end
+
   it "tests property nonreading" do
     expect { @iface["WriteMe"] }.to raise_error(DBus::Error, /not readable/)
   end
@@ -31,7 +35,7 @@ describe "PropertyTest" do
   end
 
   # https://github.com/mvidner/ruby-dbus/pull/19
-  it "tests service select timeout" do
+  it "tests service select timeout", slow: true do
     @iface["ReadOrWriteMe"] = "VALUE"
     expect(@iface["ReadOrWriteMe"]).to eq("VALUE")
     # wait for the service to become idle
@@ -64,4 +68,50 @@ describe "PropertyTest" do
   it "tests unknown property writing" do
     expect { @iface["Spoon"] = "FPRK" }.to raise_error(DBus::Error, /not found/)
   end
+
+  it "errors for a property on an unknown interface" do
+    # our idiomatic way would error out on interface lookup already,
+    # so do it the low level way
+    prop_if = @obj[DBus::PROPERTY_INTERFACE]
+    expect { prop_if.Get("org.ruby.NoSuchInterface", "SomeProperty") }.to raise_error(DBus::Error) do |e|
+      expect(e.name).to match(/UnknownProperty/)
+      expect(e.message).to match(/no such interface/)
+    end
+  end
+
+  it "errors for GetAll on an unknown interface" do
+    # no idiomatic way?
+    # so do it the low level way
+    prop_if = @obj[DBus::PROPERTY_INTERFACE]
+    expect { prop_if.GetAll("org.ruby.NoSuchInterface") }.to raise_error(DBus::Error) do |e|
+      expect(e.name).to match(/UnknownProperty/)
+      expect(e.message).to match(/no such interface/)
+    end
+  end
+
+  it "receives a PropertiesChanged signal", slow: true do
+    received = {}
+
+    # TODO: for client side, provide a helper on_properties_changed,
+    # or automate it even more in ProxyObject, ProxyObjectInterface
+    prop_if = @obj[DBus::PROPERTY_INTERFACE]
+    prop_if.on_signal("PropertiesChanged") do |_interface_name, changed_props, _invalidated_props|
+      received.merge!(changed_props)
+    end
+
+    @iface["ReadOrWriteMe"] = "VALUE"
+
+    # loop to process the signal. complicated :-( see signal_spec.rb
+    loop = DBus::Main.new
+    loop << @session_bus
+    quitter = Thread.new do
+      sleep 1
+      loop.quit
+    end
+    loop.run
+    # quitter has told loop.run to quit
+    quitter.join
+
+    expect(received["ReadOrWriteMe"]).to eq("VALUE")
+  end
 end

data/spec/proxy_object_spec.rb

@@ -38,5 +38,14 @@ describe DBus::ProxyObject do
         end
       end
     end
+
+    describe "#[]" do
+      it "raises when the interface is not found" do
+        obj = svc["/org/ruby/MyInstance"]
+        expect { obj["org.ruby.NoSuchInterface"] }.to raise_error(DBus::Error) do |e|
+          expect(e.message).to match(/no such interface/)
+        end
+      end
+    end
   end
 end

data/spec/service_newapi.rb

@@ -59,6 +59,26 @@ class Test < DBus::Object
     dbus_method :mirror_byte_array, "in bytes:ay, out mirrored:ay" do |bytes|
       [bytes]
     end
+
+    # Properties:
+    # ReadMe:string, returns "READ ME" at first, then what WriteMe received
+    # WriteMe:string
+    # ReadOrWriteMe:string, returns "READ OR WRITE ME" at first
+    dbus_attr_accessor :read_or_write_me, "s"
+    dbus_attr_reader :read_me, "s"
+
+    def write_me=(value)
+      @read_me = value
+    end
+    dbus_writer :write_me, "s"
+
+    dbus_attr_writer :password, "s"
+
+    # a property that raises when client tries to read it
+    def explosive
+      raise "Something failed"
+    end
+    dbus_reader :explosive, "s"
   end
 
   # closing and reopening the same interface
@@ -118,72 +138,6 @@ class Test < DBus::Object
     dbus_signal :LongTaskStart
     dbus_signal :LongTaskEnd
   end
-
-  # Properties:
-  # ReadMe:string, returns "READ ME" at first, then what WriteMe received
-  # WriteMe:string
-  # ReadOrWriteMe:string, returns "READ OR WRITE ME" at first
-  dbus_interface PROPERTY_INTERFACE do
-    dbus_method :Get, "in interface:s, in propname:s, out value:v" do |interface, propname|
-      unless interface == INTERFACE
-        raise DBus.error("org.freedesktop.DBus.Error.UnknownInterface"),
-              "Interface '#{interface}' not found on object '#{@path}'"
-      end
-
-      case propname
-      when "ReadMe"
-        [@read_me]
-      when "ReadOrWriteMe"
-        [@read_or_write_me]
-      when "WriteMe"
-        raise DBus.error("org.freedesktop.DBus.Error.InvalidArgs"),
-              "Property '#{interface}.#{propname}' (on object '#{@path}') is not readable"
-      else
-        # what should happen for unknown properties
-        # plasma: InvalidArgs (propname), UnknownInterface (interface)
-        raise DBus.error("org.freedesktop.DBus.Error.InvalidArgs"),
-              "Property '#{interface}.#{propname}' not found on object '#{@path}'"
-      end
-    end
-
-    dbus_method :Set, "in interface:s, in propname:s, in  value:v" do |interface, propname, value|
-      unless interface == INTERFACE
-        raise DBus.error("org.freedesktop.DBus.Error.UnknownInterface"),
-              "Interface '#{interface}' not found on object '#{@path}'"
-      end
-
-      case propname
-      when "ReadMe"
-        raise DBus.error("org.freedesktop.DBus.Error.InvalidArgs"),
-              "Property '#{interface}.#{propname}' (on object '#{@path}') is not writable"
-      when "ReadOrWriteMe"
-        @read_or_write_me = value
-        self.PropertiesChanged(interface, { propname => value }, [])
-      when "WriteMe"
-        @read_me = value
-        self.PropertiesChanged(interface, { "ReadMe" => value }, [])
-      else
-        raise DBus.error("org.freedesktop.DBus.Error.InvalidArgs"),
-              "Property '#{interface}.#{propname}' not found on object '#{@path}'"
-      end
-    end
-
-    dbus_method :GetAll, "in interface:s, out value:a{sv}" do |interface|
-      unless interface == INTERFACE
-        raise DBus.error("org.freedesktop.DBus.Error.UnknownInterface"),
-              "Interface '#{interface}' not found on object '#{@path}'"
-      end
-
-      [
-        {
-          "ReadMe" => @read_me,
-          "ReadOrWriteMe" => @read_or_write_me
-        }
-      ]
-    end
-
-    dbus_signal :PropertiesChanged, "interface:s, changed_properties:a{sv}, invalidated_properties:as"
-  end
 end
 
 class Derived < Test

data/spec/session_bus_spec.rb

@@ -37,31 +37,31 @@ describe DBus::ASessionBus do
 
     context "when DBUS_SESSION_BUS_ADDRESS from file is surrounded by quotation marks" do
       it "returns session bus address without single quotation marks" do
-        expect(File).to receive(:open).with(session_bus_file_path) { <<-EOS.gsub(/^\s*/, "") }
+        expect(File).to receive(:open).with(session_bus_file_path) { <<-TEXT.gsub(/^\s*/, "") }
           DBUS_SESSION_BUS_ADDRESS='#{dbus_session_bus_address}'
           DBUS_SESSION_BUS_PID=12345
           DBUS_SESSION_BUS_WINDOWID=12345678
-        EOS
+        TEXT
         expect(DBus::ASessionBus.address_from_file).to eq(dbus_session_bus_address)
       end
 
       it "returns session bus address without double quotation marks" do
-        expect(File).to receive(:open).with(session_bus_file_path) { <<-EOS.gsub(/^\s*/, "") }
+        expect(File).to receive(:open).with(session_bus_file_path) { <<-TEXT.gsub(/^\s*/, "") }
           DBUS_SESSION_BUS_ADDRESS="#{dbus_session_bus_address}"
           DBUS_SESSION_BUS_PID=12345
           DBUS_SESSION_BUS_WINDOWID=12345678
-        EOS
+        TEXT
         expect(DBus::ASessionBus.address_from_file).to eq(dbus_session_bus_address)
       end
     end
 
     context "when DBUS_SESSION_BUS_ADDRESS from file is not surrounded by any quotation marks" do
       it "returns session bus address as it is" do
-        expect(File).to receive(:open).with(session_bus_file_path) { <<-EOS.gsub(/^\s*/, "") }
+        expect(File).to receive(:open).with(session_bus_file_path) { <<-TEXT.gsub(/^\s*/, "") }
           DBUS_SESSION_BUS_ADDRESS=#{dbus_session_bus_address}
           DBUS_SESSION_BUS_PID=12345
           DBUS_SESSION_BUS_WINDOWID=12345678
-        EOS
+        TEXT
         expect(DBus::ASessionBus.address_from_file).to eq(dbus_session_bus_address)
       end
     end

data/spec/signal_spec.rb

@@ -3,6 +3,19 @@
 require_relative "spec_helper"
 require "dbus"
 
+def new_quitter(main_loop)
+  Thread.new do
+    DBus.logger.debug "sleep before quit"
+    # FIXME: if we sleep for too long
+    # the socket will be drained and we deadlock in a select.
+    # It could be worked around by sending ourselves a Unix signal
+    # (with a dummy handler) to interrupt the select
+    sleep 1
+    DBus.logger.debug "will quit"
+    main_loop.quit
+  end
+end
+
 describe "SignalHandlerTest" do
   before(:each) do
     @session_bus = DBus::ASessionBus.new
@@ -16,7 +29,7 @@ describe "SignalHandlerTest" do
   end
 
   # testing for commit 017c83 (kkaempf)
-  it "tests overriding a handler" do
+  it "tests overriding a handler", slow: true do
     DBus.logger.debug "Inside test_overriding_a_handler"
     counter = 0
 
@@ -32,23 +45,14 @@ describe "SignalHandlerTest" do
     DBus.logger.debug "will begin"
     @obj.LongTaskBegin 3
 
-    quitter = Thread.new do
-      DBus.logger.debug "sleep before quit"
-      # FIXME: if we sleep for too long
-      # the socket will be drained and we deadlock in a select.
-      # It could be worked around by sending ourselves a Unix signal
-      # (with a dummy handler) to interrupt the select
-      sleep 1
-      DBus.logger.debug "will quit"
-      @loop.quit
-    end
+    quitter = new_quitter(@loop)
     @loop.run
     quitter.join
 
     expect(counter).to eq(1)
   end
 
-  it "tests on signal overload" do
+  it "tests on signal overload", slow: true do
     DBus.logger.debug "Inside test_on_signal_overload"
     counter = 0
     started = false
@@ -60,12 +64,7 @@ describe "SignalHandlerTest" do
       counter += 1
     end
     @obj.LongTaskBegin 3
-    quitter = Thread.new do
-      DBus.logger.debug "sleep before quit"
-      sleep 1
-      DBus.logger.debug "will quit"
-      @loop.quit
-    end
+    quitter = new_quitter(@loop)
     @loop.run
     quitter.join
 
@@ -75,6 +74,22 @@ describe "SignalHandlerTest" do
     expect { @intf.on_signal "to", "many", "yarrrrr!" }.to raise_error(ArgumentError)
   end
 
+  it "is possible to add signal handlers from within handlers", slow: true do
+    ended = false
+    @intf.on_signal "LongTaskStart" do
+      @intf.on_signal "LongTaskEnd" do
+        ended = true
+      end
+    end
+
+    @obj.LongTaskBegin 3
+    quitter = new_quitter(@loop)
+    @loop.run
+    quitter.join
+
+    expect(ended).to eq(true)
+  end
+
   it "tests too many rules" do
     100.times do
       @obj.on_signal "Whichever" do

data/spec/spec_helper.rb

@@ -2,8 +2,7 @@ coverage = if ENV["COVERAGE"]
              ENV["COVERAGE"] == "true"
            else
              # heuristics: enable for interactive builds (but not in OBS)
-             # or in Travis
-             ENV["DISPLAY"] || ENV["TRAVIS"]
+             ENV["DISPLAY"]
            end
 
 if coverage
@@ -15,11 +14,24 @@ if coverage
   # do not cover the activesupport helpers
   SimpleCov.add_filter "/core_ext/"
 
-  # use coveralls for on-line code coverage reporting at Travis CI
-  if ENV["TRAVIS"]
-    require "coveralls"
-  end
   SimpleCov.start
+
+  # additionally use the LCOV format for on-line code coverage reporting at CI
+  if ENV["COVERAGE_LCOV"] == "true"
+    require "simplecov-lcov"
+
+    SimpleCov::Formatter::LcovFormatter.config do |c|
+      c.report_with_single_file = true
+      # this is the default Coveralls GitHub Action location
+      # https://github.com/marketplace/actions/coveralls-github-action
+      c.single_report_path = "coverage/lcov.info"
+    end
+
+    SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+      SimpleCov::Formatter::HTMLFormatter,
+      SimpleCov::Formatter::LcovFormatter
+    ]
+  end
 end
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
@@ -92,11 +104,11 @@ def with_service_by_activation(&block)
   FileUtils.mkdir_p service_dir
   # file name actually does not need to match the service name
   File.open("#{service_dir}/#{name}.service", "w") do |f|
-    s = <<EOS
-[D-BUS Service]
-Name=#{name}
-Exec=#{exec}
-EOS
+    s = <<-TEXT.gsub(/^\s*/, "")
+      [D-BUS Service]
+      Name=#{name}
+      Exec=#{exec}
+    TEXT
     f.write(s)
   end
 

data/spec/tools/dbus-limited-session.conf

@@ -25,4 +25,8 @@
        Instead, lower some so that we can test resource leaks. -->
   <limit name="max_match_rules_per_connection">50</limit><!-- was 512 -->
 
+  <!--
+dbus-daemon[1700]: [session uid=1001 pid=1700] Unable to set up new connection: Failed to get AppArmor confinement information of socket peer: Protocol not available
+  -->
+  <apparmor mode="disabled"/>
 </busconfig>

data/spec/type_spec.rb

@@ -4,13 +4,13 @@ require "dbus"
 
 describe DBus do
   describe ".type" do
-    %w{i ai a(ii) aai}.each do |s|
+    ["i", "ai", "a(ii)", "aai"].each do |s|
       it "parses some type #{s}" do
         expect(DBus.type(s).to_s).to be_eql s
       end
     end
 
-    %w{aa (ii ii) hrmp}.each do |s|
+    ["aa", "(ii", "ii)", "hrmp"].each do |s|
       it "raises exception for invalid type #{s}" do
         expect { DBus.type(s).to_s }.to raise_error DBus::Type::SignatureException
       end

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dbus
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Ruby DBus Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: 0.50.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: 0.50.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -94,8 +94,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Pure Ruby module for interaction with D-Bus IPC system
-email: ruby-dbus-devel@lists.luon.net
+email: martin.github@vidner.net
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -127,18 +141,18 @@ files:
 - lib/dbus/api_options.rb
 - lib/dbus/auth.rb
 - lib/dbus/bus.rb
-- lib/dbus/core_ext/array/extract_options.rb
+- lib/dbus/bus_name.rb
 - lib/dbus/core_ext/class/attribute.rb
-- lib/dbus/core_ext/kernel/singleton_class.rb
-- lib/dbus/core_ext/module/remove_method.rb
+- lib/dbus/core_ext/module/redefine_method.rb
 - lib/dbus/error.rb
-- lib/dbus/export.rb
 - lib/dbus/introspect.rb
 - lib/dbus/logger.rb
 - lib/dbus/marshall.rb
 - lib/dbus/matchrule.rb
 - lib/dbus/message.rb
 - lib/dbus/message_queue.rb
+- lib/dbus/object.rb
+- lib/dbus/object_path.rb
 - lib/dbus/proxy_object.rb
 - lib/dbus/proxy_object_factory.rb
 - lib/dbus/proxy_object_interface.rb
@@ -149,12 +163,15 @@ files:
 - spec/binding_spec.rb
 - spec/bus_and_xml_backend_spec.rb
 - spec/bus_driver_spec.rb
+- spec/bus_name_spec.rb
 - spec/bus_spec.rb
 - spec/byte_array_spec.rb
+- spec/client_robustness_spec.rb
 - spec/err_msg_spec.rb
 - spec/introspect_xml_parser_spec.rb
 - spec/introspection_spec.rb
 - spec/main_loop_spec.rb
+- spec/object_path_spec.rb
 - spec/property_spec.rb
 - spec/proxy_object_spec.rb
 - spec/server_robustness_spec.rb
@@ -172,9 +189,9 @@ files:
 - spec/type_spec.rb
 - spec/value_spec.rb
 - spec/variant_spec.rb
-homepage: https://trac.luon.net/ruby-dbus
+homepage: https://github.com/mvidner/ruby-dbus
 licenses:
-- LGPL v2.1
+- LGPL-2.1
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -184,7 +201,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -192,7 +209,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.7.6.3
 signing_key: 
 specification_version: 4
 summary: Ruby module for interaction with D-Bus

data/lib/dbus/core_ext/array/extract_options.rb

@@ -1,31 +0,0 @@
-# copied from activesupport/core_ext from Rails, MIT license
-# https://github.com/rails/rails/tree/5aa869861c192daceafe3a3ee50eb93f5a2b7bd2/activesupport/lib/active_support/core_ext
-class Hash
-  # By default, only instances of Hash itself are extractable.
-  # Subclasses of Hash may implement this method and return
-  # true to declare themselves as extractable. If a Hash
-  # is extractable, Array#extract_options! pops it from
-  # the Array when it is the last element of the Array.
-  def extractable_options?
-    instance_of?(Hash)
-  end
-end
-
-class Array
-  # Extracts options from a set of arguments. Removes and returns the last
-  # element in the array if it's a hash, otherwise returns a blank hash.
-  #
-  #   def options(*args)
-  #     args.extract_options!
-  #   end
-  #
-  #   options(1, 2)        # => {}
-  #   options(1, 2, a: :b) # => {:a=>:b}
-  def extract_options!
-    if last.is_a?(Hash) && last.extractable_options?
-      pop
-    else
-      {}
-    end
-  end
-end

data/lib/dbus/core_ext/kernel/singleton_class.rb

@@ -1,8 +0,0 @@
-# copied from activesupport/core_ext from Rails, MIT license
-# https://github.com/rails/rails/tree/5aa869861c192daceafe3a3ee50eb93f5a2b7bd2/activesupport/lib/active_support/core_ext
-module Kernel
-  # class_eval on an object acts like singleton_class.class_eval.
-  def class_eval(*args, &block)
-    singleton_class.class_eval(*args, &block)
-  end
-end

data/lib/dbus/core_ext/module/remove_method.rb

@@ -1,14 +0,0 @@
-# copied from activesupport/core_ext from Rails, MIT license
-# https://github.com/rails/rails/tree/5aa869861c192daceafe3a3ee50eb93f5a2b7bd2/activesupport/lib/active_support/core_ext
-class Module
-  def remove_possible_method(method)
-    if method_defined?(method) || private_method_defined?(method)
-      undef_method(method)
-    end
-  end
-
-  def redefine_method(method, &block)
-    remove_possible_method(method)
-    define_method(method, &block)
-  end
-end