ruby-dbus 0.23.1 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2465a9a90d0b4837640d475566edfde23aee4dc1d7d439d76d1f861b71f13033
-  data.tar.gz: 906288ee9d180ff0bfd4e53f45982040f240da983e23c818acd91d449d9f7f05
+  metadata.gz: 48184aac3dc75bb3407fb52dff9f10628b2dc5e38208270d756212b1ae026931
+  data.tar.gz: c345834e8cbc03a55b34f7b8bb63151d3770749213bf7afa73be73ee6038dca6
 SHA512:
-  metadata.gz: f2939e81cff3f5db2dd768f9e0f1c04159b0285501c73840f14dd8f61ad9f539fbbbf35d7e408cca11847dcd31848131c1c4df69705798860f03e4255f02dedf
-  data.tar.gz: 553f1d4c97a284371d7a10a0f439a40d2861ff8c40c2318c09f6f818f5911644db05142dc7a8d5e377dac355ddc389fcc9858647a568184e8598fd3d3bb71154
+  metadata.gz: c376083a3b761223d5b8f37b9fbb2f1383a874ac0f26c6c5ae92d2385fc936e8145aa20dfe4b327e1551a70030c4a1ffacfd289884e06e9bec2bc5ba9e9fb56c
+  data.tar.gz: 460a6e5bc96b6a2b0d4b227de8b8b34595102c67c40f62cf520947b4a394d3dc101af98e6147e5ced15143a0fb5ddf9aeec0764c4a74f9e83ee8b4730a12d544

data/NEWS.md

@@ -2,6 +2,22 @@
 
 ## Unreleased
 
+## Ruby D-Bus 0.25.0 - 2025-04-03
+
+Bug fixes:
+ * Mention qualified property name in Get or Set errors ([#147][]).
+ * Fix declaring logger and ostruct gems for Ruby 3.5
+
+[#147]: https://github.com/mvidner/ruby-dbus/pull/147
+
+## Ruby D-Bus 0.24.0 - 2025-01-02
+
+Bug fixes:
+ * Adapted for Ruby 3.4, which uses a single quote instead of a backtick
+   in exceptions ([#145][], by Mamoru TASAKA).
+
+[#145]: https://github.com/mvidner/ruby-dbus/pull/145
+
 ## Ruby D-Bus 0.23.1 - 2023-10-03
 
 API:

data/Rakefile

@@ -4,7 +4,7 @@
 require "rake"
 require "fileutils"
 require "tmpdir"
-require "rspec/core/rake_task"
+require "shellwords"
 begin
   require "rubocop/rake_task"
 rescue LoadError
@@ -34,13 +34,18 @@ desc "Default: run specs in the proper environment"
 task default: [:spec, :rubocop]
 task test: :spec
 
-RSpec::Core::RakeTask.new("bare:spec")
+desc "Run RSpec code examples"
+task "bare:spec", [:options] do |_t, args|
+  args.with_defaults(options: "")
+  sh "rspec #{args[:options]}"
+end
 
 ["spec"].each do |tname|
   desc "Run bare:#{tname} in the proper environment"
-  task tname do |_t|
+  task tname, [:options] do |_t, args|
+    args.with_defaults(options: "")
     cd "spec/tools" do
-      sh "./test_env rake bare:#{tname}"
+      sh "./test_env rake bare:#{tname}[#{args[:options].shellescape}]"
     end
   end
 end

data/VERSION

@@ -1 +1 @@
-0.23.1
+0.25.0

data/lib/dbus/logger.rb

@@ -17,7 +17,7 @@ module DBus
   # The default one logs to STDERR,
   # with DEBUG if $DEBUG is set, otherwise INFO.
   def logger
-    if @logger.nil?
+    if !defined?(@logger) || @logger.nil?
       debug = $DEBUG || ENV["RUBY_DBUS_DEBUG"]
       @logger = Logger.new($stderr)
       @logger.level = debug ? Logger::DEBUG : Logger::INFO

data/lib/dbus/marshall.rb

@@ -180,7 +180,7 @@ module DBus
       case alignment
       when 1, 2, 4, 8
         bits = alignment - 1
-        num + bits & ~bits
+        (num + bits) & ~bits
       else
         raise ArgumentError, "Unsupported alignment #{alignment}"
       end

data/lib/dbus/message.rb

@@ -103,9 +103,9 @@ module DBus
 
     def to_s
       "#{message_type} sender=#{sender} -> dest=#{destination} " \
-      "serial=#{serial} reply_serial=#{reply_serial} " \
-      "path=#{path}; interface=#{interface}; member=#{member} " \
-      "error_name=#{error_name}"
+        "serial=#{serial} reply_serial=#{reply_serial} " \
+        "path=#{path}; interface=#{interface}; member=#{member} " \
+        "error_name=#{error_name}"
     end
 
     # @return [String] name of message type, as used in match rules:

data/lib/dbus/object.rb

@@ -116,7 +116,7 @@ module DBus
 
     # Forgetting to declare the interface for a method/signal/property
     # is a ScriptError.
-    class UndefinedInterface < ScriptError # rubocop:disable Lint/InheritException
+    class UndefinedInterface < ScriptError
       def initialize(sym)
         super "No interface specified for #{sym}. Enclose it in dbus_interface."
       end
@@ -253,7 +253,7 @@ module DBus
       property = Property.new(dbus_name, type, :read, ruby_name: ruby_name)
       @@cur_intf.define(property)
 
-      ruby_name_eq = "#{ruby_name}=".to_sym
+      ruby_name_eq = :"#{ruby_name}="
       return unless method_defined?(ruby_name_eq)
 
       dbus_watcher(ruby_name, dbus_name: dbus_name, emits_changed_signal: emits_changed_signal)
@@ -294,7 +294,7 @@ module DBus
       interface_name = @@cur_intf.name
 
       ruby_name = ruby_name.to_s.sub(/=$/, "").to_sym
-      ruby_name_eq = "#{ruby_name}=".to_sym
+      ruby_name_eq = :"#{ruby_name}="
       original_ruby_name_eq = "_original_#{ruby_name_eq}"
 
       dbus_name = make_dbus_name(ruby_name, dbus_name: dbus_name)
@@ -455,11 +455,16 @@ module DBus
         property = dbus_lookup_property(interface_name, property_name)
 
         if property.readable?
-          ruby_name = property.ruby_name
-          value = public_send(ruby_name)
-          # may raise, DBus.error or https://ruby-doc.com/core-3.1.0/TypeError.html
-          typed_value = Data.make_typed(property.type, value)
-          [typed_value]
+          begin
+            ruby_name = property.ruby_name
+            value = public_send(ruby_name)
+            # may raise, DBus.error or https://ruby-doc.com/core-3.1.0/TypeError.html
+            typed_value = Data.make_typed(property.type, value)
+            [typed_value]
+          rescue StandardError => e
+            msg = "When getting '#{interface_name}.#{property_name}': " + e.message
+            raise e.exception(msg)
+          end
         else
           raise DBus.error("org.freedesktop.DBus.Error.PropertyWriteOnly"),
                 "Property '#{interface_name}.#{property_name}' (on object '#{@path}') is not readable"
@@ -470,11 +475,16 @@ module DBus
         property = dbus_lookup_property(interface_name, property_name)
 
         if property.writable?
-          ruby_name_eq = "#{property.ruby_name}="
-          # TODO: declare dbus_method :Set to take :exact argument
-          # and type check it here before passing its :plain value
-          # to the implementation
-          public_send(ruby_name_eq, value)
+          begin
+            ruby_name_eq = "#{property.ruby_name}="
+            # TODO: declare dbus_method :Set to take :exact argument
+            # and type check it here before passing its :plain value
+            # to the implementation
+            public_send(ruby_name_eq, value)
+          rescue StandardError => e
+            msg = "When setting '#{interface_name}.#{property_name}': " + e.message
+            raise e.exception(msg)
+          end
         else
           raise DBus.error("org.freedesktop.DBus.Error.PropertyReadOnly"),
                 "Property '#{interface_name}.#{property_name}' (on object '#{@path}') is not writable"
@@ -507,8 +517,8 @@ module DBus
             typed_value = Data.make_typed(property.type, value)
             p_hash[p_name.to_s] = typed_value
           rescue StandardError
-            DBus.logger.debug "Property '#{interface_name}.#{p_name}' (on object '#{@path}')" \
-                              " has raised during GetAll, omitting it"
+            DBus.logger.debug "Property '#{interface_name}.#{p_name}' (on object '#{@path}') " \
+                              "has raised during GetAll, omitting it"
           end
         end
 

data/lib/dbus/proxy_object.rb

@@ -33,6 +33,8 @@ module DBus
     # @return [ApiOptions]
     attr_reader :api
 
+    OPEN_QUOTE = RUBY_VERSION >= "3.4" ? "'" : "`"
+
     # Creates a new proxy object living on the given _bus_ at destination _dest_
     # on the given _path_.
     def initialize(bus, dest, path, api: ApiOptions::CURRENT)
@@ -58,7 +60,7 @@ module DBus
     def [](intfname)
       introspect unless introspected
       ifc = @interfaces[intfname]
-      raise DBus::Error, "no such interface `#{intfname}' on object `#{@path}'" unless ifc
+      raise DBus::Error, "no such interface #{OPEN_QUOTE}#{intfname}' on object #{OPEN_QUOTE}#{@path}'" unless ifc
 
       ifc
     end
@@ -127,7 +129,8 @@ module DBus
     # @return [void]
     def on_signal(name, &block)
       unless @default_iface && has_iface?(@default_iface)
-        raise NoMethodError, "undefined signal `#{name}' for DBus interface `#{@default_iface}' on object `#{@path}'"
+        raise NoMethodError, "undefined signal #{OPEN_QUOTE}#{name}' for DBus interface " \
+                             "#{OPEN_QUOTE}#{@default_iface}' on object #{OPEN_QUOTE}#{@path}'"
       end
 
       @interfaces[@default_iface].on_signal(name, &block)
@@ -136,13 +139,6 @@ module DBus
     ####################################################
     private
 
-    # 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
-
     # Handles all unkown methods, mostly to route method calls to the
     # default interface.
     def method_missing(name, *args, &reply_handler)
@@ -151,7 +147,8 @@ module DBus
         # - di not specified
         # TODO
         # - di is specified but not found in introspection data
-        raise NoMethodError, "undefined method `#{name}' for DBus interface `#{@default_iface}' on object `#{@path}'"
+        raise NoMethodError, "undefined method #{OPEN_QUOTE}#{name}' for DBus interface " \
+                             "#{OPEN_QUOTE}#{@default_iface}' on object #{OPEN_QUOTE}#{@path}'"
       end
 
       begin
@@ -159,18 +156,18 @@ module DBus
       rescue NameError => e
         # interesting, foo.method("unknown")
         # raises NameError, not NoMethodError
-        raise unless e.to_s =~ /undefined method `#{name}'/
+        raise unless e.to_s =~ /undefined method #{OPEN_QUOTE}#{name}'/
 
         # BTW e.exception("...") would preserve the class.
-        raise NoMethodError, "undefined method `#{name}' for DBus interface `#{@default_iface}' on object `#{@path}'"
+        raise NoMethodError, "undefined method #{OPEN_QUOTE}#{name}' for DBus interface " \
+                             "#{OPEN_QUOTE}#{@default_iface}' on object #{OPEN_QUOTE}#{@path}'"
       end
     end
-    # rubocop:enable Lint/MissingSuper
 
     def respond_to_missing?(name, _include_private = false)
-      @default_iface &&
+      (@default_iface &&
         has_iface?(@default_iface) &&
-        @interfaces[@default_iface].methods.key?(name) or super
+        @interfaces[@default_iface].methods.key?(name)) or super
     end
   end
 end

data/lib/dbus/type.rb

@@ -163,7 +163,8 @@ module DBus
       if @sigtype == DICT_ENTRY
         case @members.size
         when 2
-          raise SignatureException, "DICT_ENTRY must have 2 subtypes, found 3 or more in #{@signature}"
+          raise SignatureException,
+                "DICT_ENTRY must have 2 subtypes, found 3 or more: #{@members.inspect} << #{item.inspect}"
         when 0
           if [STRUCT, ARRAY, DICT_ENTRY, VARIANT].member?(item.sigtype)
             raise SignatureException, "DICT_ENTRY key must be basic (non-container)"

data/ruby-dbus.gemspec

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 # -*- ruby -*-
-require "rubygems"
 
 GEMSPEC = Gem::Specification.new do |s|
   s.name = "ruby-dbus"
@@ -22,16 +21,19 @@ GEMSPEC = Gem::Specification.new do |s|
 
   s.required_ruby_version = ">= 2.4.0"
 
+  s.add_runtime_dependency "logger"
   # Either of rexml and nokogiri is required
   # but AFAIK gemspec cannot express that.
   # Nokogiri is recommended as rexml is dead slow.
   s.add_runtime_dependency "rexml"
   # s.add_runtime_dependency "nokogiri"
 
+  # workaround: rubocop-1.0 needs base64 which is no longer in stdlib in newer rubies
+  s.add_development_dependency "base64"
+  s.add_development_dependency "ostruct"
   s.add_development_dependency "packaging_rake_tasks"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec", "~> 3"
-  s.add_development_dependency "rubocop", "= 1.0"
   s.add_development_dependency "simplecov"
   s.add_development_dependency "simplecov-lcov"
 end

data/spec/data_spec.rb

@@ -223,43 +223,43 @@ describe DBus::Data do
 
   describe DBus::Data::Byte do
     include_examples "#== and #eql? work for basic types"
-    include_examples "constructor accepts numeric range", 0, 2**8 - 1
+    include_examples "constructor accepts numeric range", 0, (2**8) - 1
     include_examples "constructor accepts plain or typed values", 42
   end
 
   describe DBus::Data::Int16 do
     include_examples "#== and #eql? work for basic types"
-    include_examples "constructor accepts numeric range", -2**15, 2**15 - 1
+    include_examples "constructor accepts numeric range", -2**15, (2**15) - 1
     include_examples "constructor accepts plain or typed values", 42
   end
 
   describe DBus::Data::UInt16 do
     include_examples "#== and #eql? work for basic types"
-    include_examples "constructor accepts numeric range", 0, 2**16 - 1
+    include_examples "constructor accepts numeric range", 0, (2**16) - 1
     include_examples "constructor accepts plain or typed values", 42
   end
 
   describe DBus::Data::Int32 do
     include_examples "#== and #eql? work for basic types"
-    include_examples "constructor accepts numeric range", -2**31, 2**31 - 1
+    include_examples "constructor accepts numeric range", -2**31, (2**31) - 1
     include_examples "constructor accepts plain or typed values", 42
   end
 
   describe DBus::Data::UInt32 do
     include_examples "#== and #eql? work for basic types"
-    include_examples "constructor accepts numeric range", 0, 2**32 - 1
+    include_examples "constructor accepts numeric range", 0, (2**32) - 1
     include_examples "constructor accepts plain or typed values", 42
   end
 
   describe DBus::Data::Int64 do
     include_examples "#== and #eql? work for basic types"
-    include_examples "constructor accepts numeric range", -2**63, 2**63 - 1
+    include_examples "constructor accepts numeric range", -2**63, (2**63) - 1
     include_examples "constructor accepts plain or typed values", 42
   end
 
   describe DBus::Data::UInt64 do
     include_examples "#== and #eql? work for basic types"
-    include_examples "constructor accepts numeric range", 0, 2**64 - 1
+    include_examples "constructor accepts numeric range", 0, (2**64) - 1
     include_examples "constructor accepts plain or typed values", 42
   end
 

data/spec/mock-service/spaghetti-monster.rb

@@ -122,6 +122,8 @@ class Test < DBus::Object
     dbus_attr_reader :read_me, "s"
 
     def write_me=(value)
+      raise "We don't talk about Bruno" if value =~ /Bruno/
+
       @read_me = value
     end
     dbus_writer :write_me, "s"

data/spec/node_spec.rb

@@ -25,7 +25,7 @@ describe DBus::Node do
     let(:manager_path) { "/org/example/FooManager" }
     let(:child_paths) do
       [
-        # note that "/org/example/FooManager/good"
+        # NOTE: "/org/example/FooManager/good"
         # is a path under a managed object but there is no object there
         "/org/example/FooManager/good/1",
         "/org/example/FooManager/good/2",

data/spec/property_spec.rb

@@ -31,17 +31,36 @@ 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/)
+  context "when reading a property fails" do
+    it "gets an error, mentioning the qualified property name" do
+      expect { @iface["Explosive"] }
+        .to raise_error(DBus::Error, /getting.*SampleInterface.Explosive.*Something failed/)
+    end
   end
 
   it "tests property nonreading" do
     expect { @iface["WriteMe"] }.to raise_error(DBus::Error, /not readable/)
   end
 
-  it "tests property writing" do
-    @iface["ReadOrWriteMe"] = "VALUE"
-    expect(@iface["ReadOrWriteMe"]).to eq("VALUE")
+  context "writing properties" do
+    it "tests property writing" do
+      @iface["ReadOrWriteMe"] = "VALUE"
+      expect(@iface["ReadOrWriteMe"]).to eq("VALUE")
+    end
+
+    context "when writing a read-only property" do
+      it "gets an error, mentioning the qualified property name" do
+        expect { @iface["ReadMe"] = "WROTE" }
+          .to raise_error(DBus::Error, /SampleInterface.ReadMe.*not writable/)
+      end
+    end
+
+    context "when writing a property fails" do
+      it "gets an error, mentioning the qualified property name" do
+        expect { @iface["WriteMe"] = "Bruno is a city in Czechia" }
+          .to raise_error(DBus::Error, /setting.*SampleInterface.WriteMe/)
+      end
+    end
   end
 
   # https://github.com/mvidner/ruby-dbus/pull/19
@@ -54,10 +73,6 @@ describe "PropertyTest" do
     expect(@iface["ReadOrWriteMe"]).to eq("VALUE")
   end
 
-  it "tests property nonwriting" do
-    expect { @iface["ReadMe"] = "WROTE" }.to raise_error(DBus::Error, /not writable/)
-  end
-
   it "tests get all" do
     all = @iface.all_properties
     expect(all.keys.sort).to eq(["MyArray", "MyByte", "MyDict", "MyStruct", "MyVariant", "ReadMe", "ReadOrWriteMe"])

data/spec/signal_spec.rb

@@ -107,9 +107,10 @@ describe "SignalHandlerTest" do
   describe DBus::ProxyObject do
     describe "#on_signal" do
       it "raises a descriptive error when the default_iface is wrong" do
+        open_quote = RUBY_VERSION >= "3.4" ? "'" : "`"
         @obj.default_iface = "org.ruby.NoSuchInterface"
         expect { @obj.on_signal("Foo") {} }
-          .to raise_error(NoMethodError, /undefined signal.*interface `org.ruby.NoSuchInterface'/)
+          .to raise_error(NoMethodError, /undefined signal.*interface #{open_quote}org.ruby.NoSuchInterface'/)
       end
     end
   end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dbus
 version: !ruby/object:Gem::Version
-  version: 0.23.1
+  version: 0.25.0
 platform: ruby
 authors:
 - Ruby DBus Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-10-03 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: packaging_rake_tasks
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,33 +67,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: packaging_rake_tasks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -239,7 +267,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Ruby module for interaction with D-Bus