ruby-dbus 0.16.0 → 0.25.0

data/spec/type_spec.rb

@@ -1,18 +1,226 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 require_relative "spec_helper"
 require "dbus"
 
 describe DBus do
   describe ".type" do
-    ["i", "ai", "a(ii)", "aai"].each do |s|
-      it "parses some type #{s}" do
-        expect(DBus.type(s).to_s).to be_eql s
+    good = [
+      "i",
+      "ai",
+      "a(ii)",
+      "aai"
+    ]
+
+    context "valid single types" do
+      good.each do |s|
+        it "#{s.inspect} is parsed" do
+          expect(DBus.type(s).to_s).to eq(s)
+        end
+      end
+    end
+
+    bad = [
+      ["\x00", "Unknown type code"],
+      ["!", "Unknown type code"],
+
+      # ARRAY related
+      ["a", "Empty ARRAY"],
+      ["aa", "Empty ARRAY"],
+
+      # STRUCT related
+      ["r", "Abstract STRUCT"],
+      ["()", "Empty STRUCT"],
+      ["(ii", "STRUCT not closed"],
+      ["a{i)", "STRUCT unexpectedly closed"],
+
+      # TODO: deep nesting arrays, structs, combined
+
+      # DICT_ENTRY related
+      ["e", "Abstract DICT_ENTRY"],
+      ["a{}", "DICT_ENTRY must have 2 subtypes, found 0"],
+      ["a{s}", "DICT_ENTRY must have 2 subtypes, found 1"],
+      ["a{sss}", "DICT_ENTRY must have 2 subtypes, found 3"],
+      ["a{vs}", "DICT_ENTRY key must be basic (non-container)"],
+      ["{sv}", "DICT_ENTRY not an immediate child of an ARRAY"],
+      ["a({sv})", "DICT_ENTRY not an immediate child of an ARRAY"],
+      ["a{s", "DICT_ENTRY not closed"],
+      ["a{sv", "DICT_ENTRY not closed"],
+      ["}", "DICT_ENTRY unexpectedly closed"],
+
+      # Too long
+      ["(#{"y" * 254})", "longer than 255"],
+
+      # not Single Complete Types
+      ["", "expecting a Single Complete Type"],
+      ["ii", "more than a Single Complete Type"]
+    ]
+    context "invalid single types" do
+      bad.each.each do |s, msg|
+        it "#{s.inspect} raises an exception mentioning: #{msg}" do
+          rx = Regexp.new(Regexp.quote(msg))
+          expect { DBus.type(s) }.to raise_error(DBus::Type::SignatureException, rx)
+        end
+      end
+    end
+  end
+
+  describe ".types" do
+    good = [
+      "",
+      "ii"
+    ]
+
+    context "valid signatures" do
+      good.each do |s|
+        it "#{s.inspect} is parsed" do
+          expect(DBus.types(s).map(&:to_s).join).to eq(s)
+        end
       end
     end
+  end
+
+  describe DBus::Type do
+    let(:as1) { DBus.type("as") }
+    let(:as2) { DBus.type("as") }
+    let(:aas) { DBus.type("aas") }
+
+    describe "#==" do
+      it "is true for same types" do
+        expect(as1).to eq(as2)
+      end
+
+      it "is true for a type and its string representation" do
+        expect(as1).to eq("as")
+      end
+
+      it "is false for different types" do
+        expect(as1).to_not eq(aas)
+      end
+
+      it "is false for a type and a different string" do
+        expect(as1).to_not eq("aas")
+      end
+    end
+
+    describe "#eql?" do
+      it "is true for same types" do
+        expect(as1).to eql(as2)
+      end
+
+      it "is false for a type and its string representation" do
+        expect(as1).to_not eql("as")
+      end
+
+      it "is false for different types" do
+        expect(as1).to_not eql(aas)
+      end
+
+      it "is false for a type and a different string" do
+        expect(as1).to_not eql("aas")
+      end
+    end
+
+    describe "#<<" do
+      it "raises if the argument is not a Type" do
+        t = DBus::Type.new(DBus::Type::ARRAY)
+        expect { t << "s" }.to raise_error(ArgumentError)
+      end
+
+      # TODO: the following raise checks do not occur in practice, as there are
+      # parallel checks in the parses. The code could be simplified?
+      it "raises if adding too much to an array" do
+        t = DBus::Type.new(DBus::Type::ARRAY)
+        b = DBus::Type.new(DBus::Type::BOOLEAN)
+        t << b
+        expect { t << b }.to raise_error(DBus::Type::SignatureException)
+      end
+
+      it "raises if adding too much to a dict_entry" do
+        t = DBus::Type.new(DBus::Type::DICT_ENTRY, abstract: true)
+        b = DBus::Type.new(DBus::Type::BOOLEAN)
+        t << b
+        t << b
+        expect { t << b }.to raise_error(DBus::Type::SignatureException)
+      end
+
+      it "raises if adding to a non-container" do
+        t = DBus::Type.new(DBus::Type::STRING)
+        b = DBus::Type.new(DBus::Type::BOOLEAN)
+        expect { t << b }.to raise_error(DBus::Type::SignatureException)
+
+        t = DBus::Type.new(DBus::Type::VARIANT)
+        expect { t << b }.to raise_error(DBus::Type::SignatureException)
+      end
+    end
+
+    describe DBus::Type::Array do
+      describe ".[]" do
+        it "takes Type argument" do
+          t = DBus::Type::Array[DBus::Type.new("s")]
+          expect(t.to_s).to eq "as"
+        end
+
+        it "takes 's':String argument" do
+          t = DBus::Type::Array["s"]
+          expect(t.to_s).to eq "as"
+        end
+
+        it "takes String:Class argument" do
+          t = DBus::Type::Array[String]
+          expect(t.to_s).to eq "as"
+        end
+
+        it "rejects Integer:Class argument" do
+          expect { DBus::Type::Array[Integer] }.to raise_error(ArgumentError)
+        end
+
+        it "rejects /./:Regexp argument" do
+          expect { DBus::Type::Array[/./] }.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    describe DBus::Type::Hash do
+      describe ".[]" do
+        it "takes Type arguments" do
+          t = DBus::Type::Hash[DBus::Type.new("s"), DBus::Type.new("v")]
+          expect(t.to_s).to eq "a{sv}"
+        end
+
+        it "takes 's':String arguments" do
+          t = DBus::Type::Hash["s", "v"]
+          expect(t.to_s).to eq "a{sv}"
+        end
+
+        it "takes String:Class argument" do
+          t = DBus::Type::Hash[String, DBus::Type::VARIANT]
+          expect(t.to_s).to eq "a{sv}"
+        end
+      end
+    end
+
+    describe DBus::Type::Struct do
+      describe ".[]" do
+        it "takes Type arguments" do
+          t = DBus::Type::Struct[DBus::Type.new("s"), DBus::Type.new("v")]
+          expect(t.to_s).to eq "(sv)"
+        end
+
+        it "takes 's':String arguments" do
+          t = DBus::Type::Struct["s", "v"]
+          expect(t.to_s).to eq "(sv)"
+        end
+
+        it "takes String:Class argument" do
+          t = DBus::Type::Struct[String, DBus::Type::VARIANT]
+          expect(t.to_s).to eq "(sv)"
+        end
 
-    ["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
+        it "raises on no arguments" do
+          expect { DBus::Type::Struct[] }.to raise_error(ArgumentError)
+        end
       end
     end
   end

data/spec/value_spec.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/env rspec
-# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
 require_relative "spec_helper"
 require "dbus"
 
@@ -91,4 +92,18 @@ describe "ValueTest" do
   it "aligns short integers correctly" do
     expect(@obj.i16_plus(10, -30)[0]).to eq(-20)
   end
+
+  context "structs" do
+    it "they are returned as FROZEN arrays" do
+      struct = @obj.Coordinates[0]
+      expect(struct).to be_an(Array)
+      expect(struct).to be_frozen
+    end
+
+    it "they are returned also from structs" do
+      struct = @obj.Coordinates2[0]
+      expect(struct).to be_an(Array)
+      expect(struct).to be_frozen
+    end
+  end
 end

data/spec/variant_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # Test marshalling variants according to ruby types
 require_relative "spec_helper"
 require "dbus"
@@ -9,8 +11,8 @@ describe "VariantTest" do
     @svc = @bus.service("org.ruby.service")
   end
 
-  def make_variant(a)
-    DBus::PacketMarshaller.make_variant(a)
+  def make_variant(val)
+    DBus::PacketMarshaller.make_variant(val)
   end
 
   it "tests make variant scalar" do

data/spec/zzz_quit_spec.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+describe "Quit the service" do
+  it "Tells the service to quit and waits, to collate coverage data" do
+    session_bus = DBus::ASessionBus.new
+    @svc = session_bus.service("org.ruby.service")
+    @obj = @svc.object("/org/ruby/MyInstance")
+    @obj.default_iface = "org.ruby.SampleInterface"
+    @obj.quit
+    sleep 3
+  end
+end

metadata

@@ -1,17 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dbus
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Ruby DBus Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-15 00:00:00.000000000 Z
+date: 2025-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  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
+    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: base64
+  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: ostruct
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,21 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.41.2
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -110,13 +152,12 @@ files:
 - doc/Tutorial.md
 - examples/doc/README.md
 - examples/doc/_extract_examples
-- examples/gdbus/gdbus
-- examples/gdbus/gdbus.glade
-- examples/gdbus/launch.sh
+- examples/no-bus/pulseaudio.rb
 - examples/no-introspect/nm-test.rb
 - examples/no-introspect/tracker-test.rb
 - examples/rhythmbox/playpause.rb
 - examples/service/call_service.rb
+- examples/service/complex-property.rb
 - examples/service/service_newapi.rb
 - examples/simple/call_introspect.rb
 - examples/simple/get_id.rb
@@ -128,41 +169,73 @@ files:
 - lib/dbus/auth.rb
 - lib/dbus/bus.rb
 - lib/dbus/bus_name.rb
+- lib/dbus/connection.rb
 - lib/dbus/core_ext/class/attribute.rb
 - lib/dbus/core_ext/module/redefine_method.rb
+- lib/dbus/data.rb
+- lib/dbus/emits_changed_signal.rb
 - lib/dbus/error.rb
 - lib/dbus/introspect.rb
 - lib/dbus/logger.rb
+- lib/dbus/main.rb
 - lib/dbus/marshall.rb
 - lib/dbus/matchrule.rb
 - lib/dbus/message.rb
 - lib/dbus/message_queue.rb
+- lib/dbus/node_tree.rb
 - lib/dbus/object.rb
+- lib/dbus/object_manager.rb
 - lib/dbus/object_path.rb
+- lib/dbus/object_server.rb
+- lib/dbus/org.freedesktop.DBus.xml
+- lib/dbus/platform.rb
 - lib/dbus/proxy_object.rb
 - lib/dbus/proxy_object_factory.rb
 - lib/dbus/proxy_object_interface.rb
+- lib/dbus/proxy_service.rb
+- lib/dbus/raw_message.rb
 - lib/dbus/type.rb
 - lib/dbus/xml.rb
 - ruby-dbus.gemspec
 - spec/async_spec.rb
+- spec/auth_spec.rb
 - spec/binding_spec.rb
 - spec/bus_and_xml_backend_spec.rb
-- spec/bus_driver_spec.rb
+- spec/bus_connection_spec.rb
 - spec/bus_name_spec.rb
 - spec/bus_spec.rb
 - spec/byte_array_spec.rb
 - spec/client_robustness_spec.rb
+- spec/connection_spec.rb
+- spec/coverage_helper.rb
+- spec/data/marshall.yaml
+- spec/data_spec.rb
+- spec/dbus_spec.rb
+- spec/emits_changed_signal_spec.rb
 - spec/err_msg_spec.rb
 - spec/introspect_xml_parser_spec.rb
 - spec/introspection_spec.rb
 - spec/main_loop_spec.rb
+- spec/message_spec.rb
+- spec/mock-service/cockpit-dbustests.rb
+- spec/mock-service/com.redhat.Cockpit.DBusTests.xml
+- spec/mock-service/org.ruby.service.service
+- spec/mock-service/org.rubygems.ruby_dbus.DBusTests.service
+- spec/mock-service/spaghetti-monster.rb
+- spec/node_spec.rb
+- spec/object_manager_spec.rb
 - spec/object_path_spec.rb
+- spec/object_server_spec.rb
+- spec/object_spec.rb
+- spec/packet_marshaller_spec.rb
+- spec/packet_unmarshaller_spec.rb
+- spec/platform_spec.rb
 - spec/property_spec.rb
+- spec/proxy_object_interface_spec.rb
 - spec/proxy_object_spec.rb
+- spec/proxy_service_spec.rb
+- spec/raw_message_spec.rb
 - spec/server_robustness_spec.rb
-- spec/server_spec.rb
-- spec/service_newapi.rb
 - spec/session_bus_spec.rb
 - spec/session_bus_spec_manual.rb
 - spec/signal_spec.rb
@@ -171,13 +244,13 @@ files:
 - spec/tools/dbus-launch-simple
 - spec/tools/dbus-limited-session.conf
 - spec/tools/test_env
-- spec/tools/test_server
 - spec/type_spec.rb
 - spec/value_spec.rb
 - spec/variant_spec.rb
+- spec/zzz_quit_spec.rb
 homepage: https://github.com/mvidner/ruby-dbus
 licenses:
-- LGPL-2.1
+- LGPL-2.1-or-later
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -187,15 +260,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Ruby module for interaction with D-Bus