Merge pull request #147 from mvidner/propget-error-mention-propname

Mention qualified property name in Get or Set errors

Author: mvidner

.github/workflows/ruby.yml

@@ -29,12 +29,17 @@ jobs:
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
 
     - name: Run tests
-      run: bundle exec rake
+      run: bundle exec rake spec
       # enable code coverage reporting
       env:
         COVERAGE: 'true'
         COVERAGE_LCOV: 'true'
 
+    - name: Run RuboCop
+      # only for latest version, it is dropping Ruby support fster than us
+      if: ${{ matrix.ruby-version == '3.4' }}
+      run: bundle exec rake rubocop
+
     - name: Coveralls Report
       # send it only for the latest version to avoid duplicate submits
       if: ${{ matrix.ruby-version == '3.4' }}

.rubocop.yml

@@ -1,5 +1,9 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   TargetRubyVersion: 2.4
+  SuggestExtensions: false
+  NewCops: enable
   Exclude:
     # Do not check code borrowed from ActiveSupport
     - 'lib/dbus/core_ext/**/*.rb'
@@ -73,6 +77,11 @@ Lint/RescueException:
 Naming/PredicateName:
   NamePrefix:
     # has_ and have_ are allowed
+    - does_
+    - is_
+  ForbiddenPrefixes:
+    # has_ and have_ are allowed
+    - does_
     - is_
 
 # Offense count: 1

.rubocop_todo.yml

@@ -0,0 +1,151 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-04-03 13:59:12 UTC using RuboCop version 1.68.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/AddRuntimeDependency:
+  Exclude:
+    - 'ruby-dbus.gemspec'
+
+# Offense count: 8
+# Configuration parameters: EnforcedStyle, AllowedGems, Include.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+# Include: **/*.gemspec, **/Gemfile, **/gems.rb
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'ruby-dbus.gemspec'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequireMFA:
+  Exclude:
+    - 'ruby-dbus.gemspec'
+
+# Offense count: 3
+# Configuration parameters: AllowComments, AllowEmptyLambdas.
+Lint/EmptyBlock:
+  Exclude:
+    - 'examples/utils/notify.rb'
+    - 'spec/object_spec.rb'
+    - 'spec/signal_spec.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Lint/IncompatibleIoSelectWithFiberScheduler:
+  Exclude:
+    - 'lib/dbus/message_queue.rb'
+
+# Offense count: 3
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/EnvHome:
+  Exclude:
+    - 'examples/no-introspect/tracker-test.rb'
+    - 'lib/dbus/auth.rb'
+    - 'lib/dbus/bus.rb'
+
+# Offense count: 10
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowedVars.
+Style/FetchEnvVar:
+  Exclude:
+    - 'examples/no-introspect/tracker-test.rb'
+    - 'lib/dbus/auth.rb'
+    - 'lib/dbus/bus.rb'
+    - 'lib/dbus/logger.rb'
+    - 'spec/connection_spec.rb'
+    - 'spec/coverage_helper.rb'
+    - 'spec/session_bus_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: AllowSplatArgument.
+Style/HashConversion:
+  Exclude:
+    - 'lib/dbus/data.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/MapIntoArray:
+  Exclude:
+    - 'lib/dbus/marshall.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/MinMaxComparison:
+  Exclude:
+    - 'lib/dbus/auth.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/NegatedIfElseCondition:
+  Exclude:
+    - 'lib/dbus/connection.rb'
+
+# Offense count: 3
+Style/OpenStructUse:
+  Exclude:
+    - 'spec/packet_marshaller_spec.rb'
+    - 'spec/packet_unmarshaller_spec.rb'
+    - 'spec/property_spec.rb'
+
+# Offense count: 5
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: Methods.
+Style/RedundantArgument:
+  Exclude:
+    - 'lib/dbus/auth.rb'
+    - 'lib/dbus/introspect.rb'
+    - 'lib/dbus/object.rb'
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantConstantBase:
+  Exclude:
+    - 'spec/data_spec.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/RedundantEach:
+  Exclude:
+    - 'spec/type_spec.rb'
+
+# Offense count: 3
+# This cop supports safe autocorrection (--autocorrect).
+Style/RedundantRegexpArgument:
+  Exclude:
+    - 'examples/service/service_newapi.rb'
+    - 'lib/dbus/object.rb'
+    - 'spec/mock-service/spaghetti-monster.rb'
+
+# Offense count: 2
+# This cop supports unsafe autocorrection (--autocorrect-all).
+Style/StringChars:
+  Exclude:
+    - 'examples/service/service_newapi.rb'
+    - 'spec/mock-service/spaghetti-monster.rb'
+
+# Offense count: 6
+# This cop supports safe autocorrection (--autocorrect).
+Style/SuperArguments:
+  Exclude:
+    - 'examples/service/complex-property.rb'
+    - 'lib/dbus/data.rb'
+    - 'lib/dbus/introspect.rb'
+    - 'spec/mock-service/spaghetti-monster.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/SuperWithArgsParentheses:
+  Exclude:
+    - 'lib/dbus/object.rb'
+    - 'spec/mock-service/spaghetti-monster.rb'

Gemfile

@@ -4,6 +4,10 @@
 source "https://rubygems.org"
 gemspec
 
+gem "rubocop", "~> 1.68.0" if RUBY_VERSION >= "2.7"
+# newer versions have a noise deprecation warning
+gem "rubocop-ast", "~> 1.36.0" if RUBY_VERSION >= "2.7"
+
 group :test do
   # Optional dependency, we do want to test with it
   gem "nokogiri"

NEWS.md

@@ -2,6 +2,14 @@
 
 ## 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:

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

VERSION

@@ -1 +1 @@
-0.24.0
+0.25.0

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

lib/dbus/marshall.rb

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

lib/dbus/message.rb

@@ -103,9 +103,9 @@ def initialize(mtype = INVALID)
 
     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: