ruby-dbus 0.15.0 → 0.18.0.beta1

data/lib/dbus/type.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # dbus/type.rb - module containing low-level D-Bus data type information
 #
 # This file is part of the ruby-dbus project
@@ -9,13 +11,31 @@
 # See the file "COPYING" for the exact licensing terms.
 
 module DBus
+  # Like a {Signature} but containing only a single complete type.
+  #
+  # For documentation purposes only.
+  class SingleCompleteType < String; end
+
+  # Zero or more {SingleCompleteType}s; its own type code is "g".
+  # For example "ssv" for a method taking two Strings and a Variant/
+  #
+  # For documentation purposes only.
+  class Signature < String; end
+
+  # Similar to {Signature} but for {DBus::Object.define_method},
+  # contains names and direction of the parameters.
+  # For example "in query:s, in case_sensitive:b, out results:ao".
+  #
+  # For documentation purposes only.
+  class Prototype < String; end
+
   # = D-Bus type module
   #
   # This module containts the constants of the types specified in the D-Bus
   # protocol.
   module Type
     # Mapping from type number to name and alignment.
-    TypeMapping = {
+    TYPE_MAPPING = {
       0 => ["INVALID", nil],
       "y" => ["BYTE", 1],
       "b" => ["BOOLEAN", 4],
@@ -36,7 +56,7 @@ module DBus
       "h" => ["UNIX_FD", 4]
     }.freeze
     # Defines the set of constants
-    TypeMapping.each_pair do |key, value|
+    TYPE_MAPPING.each_pair do |key, value|
       Type.const_set(value.first, key)
     end
 
@@ -55,16 +75,17 @@ module DBus
 
       # Create a new type instance for type number _sigtype_.
       def initialize(sigtype)
-        if !TypeMapping.keys.member?(sigtype)
+        if !TYPE_MAPPING.keys.member?(sigtype)
           raise SignatureException, "Unknown key in signature: #{sigtype.chr}"
         end
+
         @sigtype = sigtype
         @members = []
       end
 
       # Return the required alignment for the type.
       def alignment
-        TypeMapping[@sigtype].last
+        TYPE_MAPPING[@sigtype].last
       end
 
       # Return a string representation of the type according to the
@@ -72,36 +93,38 @@ module DBus
       def to_s
         case @sigtype
         when STRUCT
-          "(" + @members.collect(&:to_s).join + ")"
+          "(#{@members.collect(&:to_s).join})"
         when ARRAY
-          "a" + child.to_s
+          "a#{child}"
         when DICT_ENTRY
-          "{" + @members.collect(&:to_s).join + "}"
+          "{#{@members.collect(&:to_s).join}}"
         else
-          if !TypeMapping.keys.member?(@sigtype)
+          if !TYPE_MAPPING.keys.member?(@sigtype)
             raise NotImplementedError
           end
+
           @sigtype.chr
         end
       end
 
-      # Add a new member type _a_.
-      def <<(a)
+      # Add a new member type _item_.
+      def <<(item)
         if ![STRUCT, ARRAY, DICT_ENTRY].member?(@sigtype)
           raise SignatureException
         end
         raise SignatureException if @sigtype == ARRAY && !@members.empty?
+
         if @sigtype == DICT_ENTRY
-          if @members.size == 2
+          case @members.size
+          when 2
             raise SignatureException, "Dict entries have exactly two members"
-          end
-          if @members.empty?
-            if [STRUCT, ARRAY, DICT_ENTRY].member?(a.sigtype)
+          when 0
+            if [STRUCT, ARRAY, DICT_ENTRY].member?(item.sigtype)
               raise SignatureException, "Dict entry keys must be basic types"
             end
           end
         end
-        @members << a
+        @members << item
       end
 
       # Return the first contained member type.
@@ -110,19 +133,20 @@ module DBus
       end
 
       def inspect
-        s = TypeMapping[@sigtype].first
+        s = TYPE_MAPPING[@sigtype].first
         if [STRUCT, ARRAY].member?(@sigtype)
-          s += ": " + @members.inspect
+          s += ": #{@members.inspect}"
         end
         s
       end
-    end # class Type
+    end
 
     # = D-Bus type parser class
     #
     # Helper class to parse a type signature in the protocol.
     class Parser
       # Create a new parser for the given _signature_.
+      # @param signature [Signature]
       def initialize(signature)
         @signature = signature
         @idx = 0
@@ -135,30 +159,31 @@ module DBus
         c
       end
 
-      # Parse one character _c_ of the signature.
-      def parse_one(c)
+      # Parse one character _char_ of the signature.
+      def parse_one(char)
         res = nil
-        case c
+        case char
         when "a"
           res = Type.new(ARRAY)
-          c = nextchar
-          raise SignatureException, "Parse error in #{@signature}" if c.nil?
-          child = parse_one(c)
+          char = nextchar
+          raise SignatureException, "Parse error in #{@signature}" if char.nil?
+
+          child = parse_one(char)
           res << child
         when "("
           res = Type.new(STRUCT)
-          while (c = nextchar) && c != ")"
-            res << parse_one(c)
+          while (char = nextchar) && char != ")"
+            res << parse_one(char)
           end
-          raise SignatureException, "Parse error in #{@signature}" if c.nil?
+          raise SignatureException, "Parse error in #{@signature}" if char.nil?
         when "{"
           res = Type.new(DICT_ENTRY)
-          while (c = nextchar) && c != "}"
-            res << parse_one(c)
+          while (char = nextchar) && char != "}"
+            res << parse_one(char)
           end
-          raise SignatureException, "Parse error in #{@signature}" if c.nil?
+          raise SignatureException, "Parse error in #{@signature}" if char.nil?
         else
-          res = Type.new(c)
+          res = Type.new(char)
         end
         res
       end
@@ -172,8 +197,8 @@ module DBus
         end
         ret
       end
-    end # class Parser
-  end # module Type
+    end
+  end
 
   # shortcuts
 
@@ -188,4 +213,4 @@ module DBus
     [type(string_type), value]
   end
   module_function :variant
-end # module DBus
+end

data/lib/dbus/xml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # dbus/xml.rb - introspection parser, rexml/nokogiri abstraction
 #
 # This file is part of the ruby-dbus project
@@ -26,14 +28,23 @@ module DBus
       attr_accessor :backend
     end
     # Creates a new parser for XML data in string _xml_.
+    # @param xml [String]
     def initialize(xml)
       @xml = xml
     end
 
     class AbstractXML
+      # @!method initialize(xml)
+      # @abstract
+
+      # @!method each(xpath)
+      # @abstract
+      # yields nodes which match xpath of type AbstractXML::Node
+
       def self.have_nokogiri?
         Object.const_defined?("Nokogiri")
       end
+
       class Node
         def initialize(node)
           @node = node
@@ -46,12 +57,6 @@ module DBus
         # yields child nodes which match xpath of type AbstractXML::Node
         def each(xpath); end
       end
-      # required methods
-      # initialize parser with xml string
-      def initialize(xml); end
-
-      # yields nodes which match xpath of type AbstractXML::Node
-      def each(xpath); end
     end
 
     class NokogiriParser < AbstractXML
@@ -64,7 +69,9 @@ module DBus
           @node.search(path).each { |node| block.call NokogiriNode.new(node) }
         end
       end
+
       def initialize(xml)
+        super()
         @doc = Nokogiri.XML(xml)
       end
 
@@ -83,7 +90,9 @@ module DBus
           @node.elements.each(path) { |node| block.call REXMLNode.new(node) }
         end
       end
+
       def initialize(xml)
+        super()
         @doc = REXML::Document.new(xml)
       end
 
@@ -136,28 +145,30 @@ module DBus
     ######################################################################
     private
 
-    # Parses a method signature XML element _e_ and initialises
-    # method/signal _m_.
-    def parse_methsig(e, m)
-      e.each("arg") do |ae|
+    # Parses a method signature XML element *elem* and initialises
+    # method/signal *methsig*.
+    # @param elem [AbstractXML::Node]
+    def parse_methsig(elem, methsig)
+      elem.each("arg") do |ae|
         name = ae["name"]
         dir = ae["direction"]
         sig = ae["type"]
-        if m.is_a?(DBus::Signal)
+        case methsig
+        when DBus::Signal
           # Direction can only be "out", ignore it
-          m.add_fparam(name, sig)
-        elsif m.is_a?(DBus::Method)
+          methsig.add_fparam(name, sig)
+        when DBus::Method
           case dir
           # This is a method, so dir defaults to "in"
           when "in", nil
-            m.add_fparam(name, sig)
+            methsig.add_fparam(name, sig)
           when "out"
-            m.add_return(name, sig)
+            methsig.add_return(name, sig)
           end
         else
           raise NotImplementedError, dir
         end
       end
     end
-  end # class IntrospectXMLParser
-end # module DBus
+  end
+end

data/lib/dbus.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # dbus.rb - Module containing the low-level D-Bus implementation
 #
 # This file is part of the ruby-dbus project
@@ -11,14 +13,16 @@
 require_relative "dbus/api_options"
 require_relative "dbus/auth"
 require_relative "dbus/bus"
+require_relative "dbus/bus_name"
 require_relative "dbus/error"
-require_relative "dbus/export"
 require_relative "dbus/introspect"
 require_relative "dbus/logger"
 require_relative "dbus/marshall"
 require_relative "dbus/matchrule"
 require_relative "dbus/message"
 require_relative "dbus/message_queue"
+require_relative "dbus/object"
+require_relative "dbus/object_path"
 require_relative "dbus/proxy_object"
 require_relative "dbus/proxy_object_factory"
 require_relative "dbus/proxy_object_interface"
@@ -26,22 +30,20 @@ require_relative "dbus/type"
 require_relative "dbus/xml"
 
 require "socket"
-require "thread"
-
 # = D-Bus main module
 #
 # Module containing all the D-Bus modules and classes.
 module DBus
   # Default socket name for the system bus.
-  SystemSocketName = "unix:path=/var/run/dbus/system_bus_socket".freeze
+  SYSTEM_BUS_ADDRESS = "unix:path=/var/run/dbus/system_bus_socket"
 
   # Byte signifying big endianness.
-  BIG_END = "B".freeze
+  BIG_END = "B"
   # Byte signifying little endianness.
-  LIL_END = "l".freeze
+  LIL_END = "l"
 
   # Byte signifying the host's endianness.
-  HOST_END = if [0x01020304].pack("L").unpack("V")[0] == 0x01020304
+  HOST_END = if [0x01020304].pack("L").unpack1("V") == 0x01020304
                LIL_END
              else
                BIG_END
@@ -67,4 +69,4 @@ module DBus
   # Exception raised when invalid introspection data is parsed/used.
   class InvalidIntrospectionData < Exception
   end
-end # module DBus
+end

data/ruby-dbus.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -*- ruby -*-
 require "rubygems"
 
@@ -7,7 +9,7 @@ GEMSPEC = Gem::Specification.new do |s|
   s.summary = "Ruby module for interaction with D-Bus"
   s.description = "Pure Ruby module for interaction with D-Bus IPC system"
   s.version = File.read("VERSION").strip
-  s.license = "LGPL v2.1"
+  s.license = "LGPL-2.1"
   s.author = "Ruby DBus Team"
   s.email = "martin.github@vidner.net"
   s.homepage = "https://github.com/mvidner/ruby-dbus"
@@ -18,15 +20,17 @@ GEMSPEC = Gem::Specification.new do |s|
   ]
   s.require_path = "lib"
 
-  s.required_ruby_version = ">= 2.0.0"
+  s.required_ruby_version = ">= 2.4.0"
+
+  s.add_dependency "rexml"
 
   # This is optional
   # s.add_runtime_dependency "nokogiri"
 
-  s.add_development_dependency "coveralls"
   s.add_development_dependency "packaging_rake_tasks"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec", "~> 3"
-  s.add_development_dependency "rubocop", "= 0.41.2"
+  s.add_development_dependency "rubocop", "= 1.0"
   s.add_development_dependency "simplecov"
+  s.add_development_dependency "simplecov-lcov"
 end

data/spec/async_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # Test the binding of dbus concepts to ruby concepts
 require_relative "spec_helper"
 require "dbus"

data/spec/binding_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # Test the binding of dbus concepts to ruby concepts
 require_relative "spec_helper"
 

data/spec/bus_and_xml_backend_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # Test the bus class
 require_relative "spec_helper"
 

data/spec/bus_driver_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 require_relative "spec_helper"
 require "dbus"
 

data/spec/bus_name_spec.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+describe DBus::BusName do
+  describe ".valid?" do
+    it "recognizes valid bus names" do
+      expect(described_class.valid?("org.freedesktop.DBus")).to be_truthy
+      expect(described_class.valid?(":1.42")).to be_truthy
+      expect(described_class.valid?("org._7_zip.Archiver")).to be_truthy
+    end
+
+    it "recognizes invalid bus names" do
+      expect(described_class.valid?("")).to be_falsey
+      expect(described_class.valid?("Empty..Component")).to be_falsey
+      expect(described_class.valid?(".Empty.First.Component")).to be_falsey
+      expect(described_class.valid?("Empty.Last.Component.")).to be_falsey
+      expect(described_class.valid?("Invalid.Ch@r@cter")).to be_falsey
+      expect(described_class.valid?("/Invalid-Character")).to be_falsey
+      long_name = "a.#{"long." * 100}name"
+      expect(described_class.valid?(long_name)).to be_falsey
+      expect(described_class.valid?("org.7_zip.Archiver")).to be_falsey
+    end
+  end
+end

data/spec/bus_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # Test the bus class
 require_relative "spec_helper"
 

data/spec/byte_array_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 require_relative "spec_helper"
 
 require "dbus"

data/spec/client_robustness_spec.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+# Test that a client survives various error cases
+require_relative "spec_helper"
+require "dbus"
+
+describe "ClientRobustnessTest" do
+  before(:each) do
+    @bus = DBus::ASessionBus.new
+    @svc = @bus.service("org.ruby.service")
+  end
+
+  context "when the bus name is invalid" do
+    it "tells the user the bus name is invalid" do
+      # user mistake, should be "org.ruby.service"
+      expect { @bus.service(".org.ruby.service") }.to raise_error(DBus::Error, /Invalid bus name/)
+    end
+  end
+
+  context "when the object path is invalid" do
+    it "tells the user the path is invalid" do
+      # user mistake, should be "/org/ruby/MyInstance"
+      expect { @svc.object("org.ruby.MyInstance") }.to raise_error(DBus::Error, /Invalid object path/)
+    end
+  end
+end

data/spec/err_msg_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # should report it missing on org.ruby.SampleInterface
 # (on object...) instead of on DBus::Proxy::ObjectInterface
 require_relative "spec_helper"

data/spec/introspect_xml_parser_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 require_relative "spec_helper"
 require "dbus"
 

data/spec/introspection_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 require_relative "spec_helper"
 require "dbus"
 

data/spec/main_loop_spec.rb

@@ -1,4 +1,6 @@
 #!/usr/bin/env rspec
+# frozen_string_literal: true
+
 # Test the main loop
 require_relative "spec_helper"
 require "dbus"
@@ -70,7 +72,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/node_spec.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+describe DBus::Node do
+  describe "#inspect" do
+    # the behavior needs improvement
+    it "shows the node, poorly" do
+      parent = described_class.new("parent")
+      parent.object = DBus::Object.new("/parent")
+
+      3.times do |i|
+        child_name = "child#{i}"
+        child = described_class.new(child_name)
+        parent[child_name] = child
+      end
+
+      expect(parent.inspect).to match(/<DBus::Node [0-9a-f]+ {child0 => {},child1 => {},child2 => {}}>/)
+    end
+  end
+end

data/spec/object_path_spec.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+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