ruby-dbus 0.17.0 → 0.18.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee629ce8a78d7cd23f718103cfd622d2a5fd67c51dab6b2a88e453c512c608f3
-  data.tar.gz: a8995a9526e3b957d32c503de7ad5ef781e5c464925fec8e2107eda4529aa447
+  metadata.gz: 491efa855b01f946194979c90d4bb4c1bb6bc4c33e342cd9d3dd76cbd53111cd
+  data.tar.gz: d2c1acaa46d04a7f4799b95722b71f4449c2d39fd87fd993c1c1140dbb5d0732
 SHA512:
-  metadata.gz: 531e01c12aed4aeedaa5ce55fec2fee0c3da714211adc768c8990d2ce79509e6b925bc06d4308e9628cff109b9880dbea72878e7aeaf23c8e5fb19ddf8a249e2
-  data.tar.gz: 6449aa2798ed78d29c430423a92d7c8a921fd4ea244eea11fb8a84ca2eb880a4e6860325dc6a05254dc432b971d4929fc4d3a5057e423939c0574a687e7680f7
+  metadata.gz: 340b53e7aa449c84705668db9b753ced7c9d24a3229b1d7bafcc95d29508f1b4418001cc5f2749566b9edb8c2068a8d99565c251054c413252ed68450490208b
+  data.tar.gz: 8c6dafbd226ae516dc8aef3ad5f01cabb9850455f3f3866cfe66548b7ece22ac1865272bb17fd9af138e52d69b647e4d8ef824ebd2999605e0de28e688710ff8

data/NEWS.md

@@ -2,6 +2,21 @@
 
 ## Unreleased
 
+## Ruby D-Bus 0.18.0.beta1 - 2022-02-24
+
+API:
+ * D-Bus structs have been passed as Ruby arrays. Now these arrays are frozen.
+ * Ruby structs can be used as D-Bus structs.
+
+Bug fixes:
+ * Returning the value for o.fd.DBus.Properties.Get, use the specific property
+   signature, not the generic Variant ([#97][]).
+
+Requirements:
+ * Require Ruby 2.4, because of RuboCop 1.0.
+
+[#97]: https://github.com/mvidner/ruby-dbus/issues/97
+
 ## Ruby D-Bus 0.17.0 - 2022-02-11
 
 API:

data/README.md

@@ -41,7 +41,7 @@ via [UPower](http://upower.freedesktop.org/docs/UPower.html#UPower:OnBattery)
 
 ## Requirements
 
-- Ruby 2.1 or newer.
+- Ruby 2.4 or newer.
 
 
 ## Installation

data/Rakefile

@@ -1,7 +1,8 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
+
 require "rake"
 require "fileutils"
-include FileUtils
 require "tmpdir"
 require "rspec/core/rake_task"
 begin
@@ -69,16 +70,7 @@ namespace :doc do
 end
 
 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
+  RuboCop::RakeTask.new
 else
   desc "Run RuboCop (dummy)"
   task :rubocop do

data/VERSION

@@ -1 +1 @@
-0.17.0
+0.18.0.beta1

data/doc/Reference.md

@@ -153,7 +153,7 @@ To receive signals for a specific object and interface, use
 
 D-Bus booleans, numbers, strings, arrays and dictionaries become their straightforward Ruby counterparts.
 
-Structs become arrays.
+Structs become frozen arrays.
 
 Object paths become strings.
 
@@ -190,11 +190,18 @@ If the signature expects a Variant
    type. This will hit you when you rely on method (2) but happen to have
    a particular string value in an array.
 
+##### Structs
+
+If a **STRUCT** `(...)` is expected you may pass
+
+- an [Array](https://ruby-doc.org/core/Array.html) (frozen is fine)
+- a [Struct](https://ruby-doc.org/core/Struct.html)
+
 ##### Byte Arrays
 
 If a byte array (`ay`) is expected you can pass a String too.
 The bytes sent are according to the string's
-[encoding](http://ruby-doc.org/core-2.0.0/Encoding.html).
+[encoding](http://ruby-doc.org/core/Encoding.html).
 
 ##### nil
 

data/examples/doc/_extract_examples

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 if ARGV[0].nil?
   puts "Usage: #{$PROGRAM_NAME} file.md"
   exit

data/examples/gdbus/gdbus

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 # This is a quite complex example using internal lower level API.
 # Not a good starting point, but might be usefull if you want to do tricky
@@ -103,11 +105,12 @@ class DBusUI
 
   def beautify_method(meth)
     # Damn, this need to be rewritten :p
-    s = meth.name + "("
-    if meth.is_a?(DBus::Method)
+    s = "#{meth.name}("
+    case meth
+    when DBus::Method
       s += (meth.params.collect { |a| "in #{a[0]}:#{a[1]}" } +
             meth.rets.collect { |a| "out #{a[0]}:#{a[1]}" }).join(", ")
-    elsif meth.is_a?(DBus::Signal)
+    when DBus::Signal
       s += (meth.params.collect { |a| "in #{a[0]}:#{a[1]}" }).join(", ")
     end
     s += ")"
@@ -146,11 +149,12 @@ class DBusUI
     name = view.model.get_iter(path)[0]
     puts "Clicked on: #{name.inspect}"
     type = view.model.get_iter(path)[1]
-    if type == "M"
+    case type
+    when "M"
       method = view.model.get_iter(path)[2]
       intf = view.model.get_iter(path)[3]
       MethodCallWindow.new(@window, intf, method).run
-    elsif type == "S"
+    when "S"
       signal = view.model.get_iter(path)[2]
       intf = view.model.get_iter(path)[3]
       mr = DBus::MatchRule.new.from_signal(intf, signal)
@@ -205,6 +209,7 @@ class DBusUI
     end
 
     return unless ENABLE_SYSTEM
+
     DBus::SystemBus.instance.proxy.ListNames do |_msg, names|
       fill_treeview(DBus::SystemBus.instance, @systemtreeview, names)
     end
@@ -218,6 +223,7 @@ class DBusUI
     end
 
     return if node.object.nil?
+
     node.object.interfaces.sort.each do |ifname|
       subiter = model.append(iter)
       subiter[0] = ifname

data/examples/no-introspect/nm-test.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 # Trivial network interface lister using NetworkManager.
 # NetworkManager does not support introspection, so the api is not that sexy.

data/examples/no-introspect/tracker-test.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 # Trivial network interface lister using NetworkManager.
 # NetworkManager does not support introspection, so the api is not that sexy.
@@ -11,4 +13,4 @@ tracker_service = bus.service("org.freedesktop.Tracker")
 tracker_manager = tracker_service.object("/org/freedesktop/tracker")
 poi = DBus::ProxyObjectInterface.new(tracker_manager, "org.freedesktop.Tracker.Files")
 poi.define_method("GetMetadataForFilesInFolder", "in live_query_id:i, in uri:s, in fields:as, out values:aas")
-p poi.GetMetadataForFilesInFolder(-1, ENV["HOME"] + "/Desktop", ["File:Name", "File:Size"])
+p poi.GetMetadataForFilesInFolder(-1, "#{ENV["HOME"]}/Desktop", ["File:Name", "File:Size"])

data/examples/rhythmbox/playpause.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "dbus"
 bus = DBus::SessionBus.instance
@@ -13,7 +14,7 @@ mr.type = "signal"
 mr.interface = "org.gnome.Rhythmbox.Player"
 mr.path = "/org/gnome/Rhythmbox/Player"
 bus.add_match(mr) do |msg, first_param|
-  print msg.member + " "
+  print "#{msg.member} "
   puts first_param
 end
 

data/examples/service/call_service.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "dbus"
 

data/examples/service/service_newapi.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "dbus"
-require "thread"
 Thread.abort_on_exception = true
 
 class Test < DBus::Object

data/examples/simple/call_introspect.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "dbus"
 

data/examples/simple/get_id.rb

@@ -1,7 +1,8 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
 
 # find the library without external help
-$LOAD_PATH.unshift File.expand_path("../../../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 
 require "dbus"
 

data/examples/simple/properties.rb

@@ -1,4 +1,6 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
+
 require "dbus"
 
 bus = DBus::SystemBus.instance

data/examples/utils/listnames.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "dbus"
 

data/examples/utils/notify.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "dbus"
 

data/lib/dbus/api_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of the ruby-dbus project
 # Copyright (C) 2016 Martin Vidner
 #
@@ -9,6 +11,13 @@
 module DBus
   class ApiOptions
     # https://github.com/mvidner/ruby-dbus/issues/30
+    # @return [Boolean]
+    #   - true: a proxy (client-side) method will return an array
+    #     even for the most common case where the method is declared
+    #     to have only one 'out parameter'
+    #   - false: a proxy (client-side) method will return
+    #     - one value for the only 'out parameter'
+    #     - an array with more 'out parameters'
     attr_accessor :proxy_method_returns_array
 
     A0 = ApiOptions.new

data/lib/dbus/auth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of the ruby-dbus project
 # Copyright (C) 2007 Arnaud Cornet and Paul van Tilburg
 #
@@ -100,14 +102,15 @@ module DBus
     # encode plain to hex
     def hex_encode(plain)
       return nil if plain.nil?
-      plain.to_s.unpack("H*")[0]
+
+      plain.to_s.unpack1("H*")
     end
 
     # decode hex to plain
     def hex_decode(encoded)
       encoded.scan(/[[:xdigit:]]{2}/).map { |h| h.hex.chr }.join
     end
-  end # DBusCookieSHA1 class ends here
+  end
 
   # Note: this following stuff is tested with External authenticator only!
 
@@ -148,12 +151,13 @@ module DBus
     # server.
     def send(meth, *args)
       o = ([meth] + args).join(" ")
-      @socket.write(o + "\r\n")
+      @socket.write("#{o}\r\n")
     end
 
     # Try authentication using the next authenticator.
     def next_authenticator
       raise AuthenticationFailed if @auth_list.empty?
+
       @authenticator = @auth_list.shift.new
       auth_msg = ["AUTH", @authenticator.name, @authenticator.authenticate]
       DBus.logger.debug "auth_msg: #{auth_msg.inspect}"
@@ -169,9 +173,10 @@ module DBus
       data = ""
       crlf = "\r\n"
       left = 1024 # 1024 byte, no idea if it's ever getting bigger
-      while left > 0
+      while left.positive?
         buf = @socket.read(left > 1 ? 1 : left)
         break if buf.nil?
+
         left -= buf.bytesize
         data += buf
         break if data.include? crlf # crlf means line finished, the TCP socket keeps on listening, so we break
@@ -262,6 +267,6 @@ module DBus
         end
       end
       true
-    end # def next_state
-  end # class Client
-end # module D-Bus
+    end
+  end
+end