RuboCop: trivial autocorrections

Author: mvidner

.rubocop_todo.yml

@@ -30,39 +30,6 @@ Gemspec/RequireMFA:
   Exclude:
     - 'ruby-dbus.gemspec'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: leading, trailing
-Layout/LineContinuationLeadingSpace:
-  Exclude:
-    - 'lib/dbus/object.rb'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: space, no_space
-Layout/LineContinuationSpacing:
-  Exclude:
-    - 'lib/dbus/proxy_object.rb'
-    - 'spec/property_spec.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: aligned, indented
-Layout/LineEndStringConcatenationIndentation:
-  Exclude:
-    - 'lib/dbus/message.rb'
-
-# Offense count: 9
-# This cop supports safe autocorrection (--autocorrect).
-Lint/AmbiguousOperatorPrecedence:
-  Exclude:
-    - 'lib/dbus/marshall.rb'
-    - 'lib/dbus/proxy_object.rb'
-    - 'spec/data_spec.rb'
-
 # Offense count: 3
 # Configuration parameters: AllowComments, AllowEmptyLambdas.
 Lint/EmptyBlock:
@@ -77,29 +44,6 @@ Lint/IncompatibleIoSelectWithFiberScheduler:
   Exclude:
     - 'lib/dbus/message_queue.rb'
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-Lint/RedundantCopDisableDirective:
-  Exclude:
-    - 'lib/dbus/object.rb'
-    - 'lib/dbus/proxy_object.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: strict, consistent
-Lint/SymbolConversion:
-  Exclude:
-    - 'lib/dbus/object.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: Keywords, RequireColon.
-# Keywords: TODO, FIXME, OPTIMIZE, HACK, REVIEW, NOTE
-Style/CommentAnnotation:
-  Exclude:
-    - 'spec/node_spec.rb'
-
 # Offense count: 3
 # This cop supports unsafe autocorrection (--autocorrect-all).
 Style/EnvHome:
@@ -175,13 +119,6 @@ Style/RedundantEach:
   Exclude:
     - 'spec/type_spec.rb'
 
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantLineContinuation:
-  Exclude:
-    - 'lib/dbus/type.rb'
-    - 'spec/property_spec.rb'
-
 # Offense count: 3
 # This cop supports safe autocorrection (--autocorrect).
 Style/RedundantRegexpArgument:

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:

lib/dbus/object.rb

@@ -116,7 +116,7 @@ def self.dbus_interface(name)
 
     # 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 @@ def self.dbus_reader(ruby_name, type, dbus_name: nil, emits_changed_signal: nil)
       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 @@ def self.dbus_watcher(ruby_name, dbus_name: nil, emits_changed_signal: nil)
       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)
@@ -517,8 +517,8 @@ def interfaces_and_properties
             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
 

lib/dbus/proxy_object.rb

@@ -129,7 +129,7 @@ def has_iface?(name)
     # @return [void]
     def on_signal(name, &block)
       unless @default_iface && has_iface?(@default_iface)
-        raise NoMethodError, "undefined signal #{OPEN_QUOTE}#{name}' for DBus interface "\
+        raise NoMethodError, "undefined signal #{OPEN_QUOTE}#{name}' for DBus interface " \
                              "#{OPEN_QUOTE}#{@default_iface}' on object #{OPEN_QUOTE}#{@path}'"
       end
 
@@ -139,13 +139,6 @@ def on_signal(name, &block)
     ####################################################
     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)
@@ -154,7 +147,7 @@ def method_missing(name, *args, &reply_handler)
         # - di not specified
         # TODO
         # - di is specified but not found in introspection data
-        raise NoMethodError, "undefined method #{OPEN_QUOTE}#{name}' for DBus interface "\
+        raise NoMethodError, "undefined method #{OPEN_QUOTE}#{name}' for DBus interface " \
                              "#{OPEN_QUOTE}#{@default_iface}' on object #{OPEN_QUOTE}#{@path}'"
       end
 
@@ -166,16 +159,15 @@ def method_missing(name, *args, &reply_handler)
         raise unless e.to_s =~ /undefined method #{OPEN_QUOTE}#{name}'/
 
         # BTW e.exception("...") would preserve the class.
-        raise NoMethodError, "undefined method #{OPEN_QUOTE}#{name}' for DBus interface "\
+        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

lib/dbus/type.rb

@@ -163,7 +163,7 @@ def <<(item)
       if @sigtype == DICT_ENTRY
         case @members.size
         when 2
-          raise SignatureException, \
+          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)

spec/data_spec.rb

@@ -223,43 +223,43 @@
 
   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
 

spec/node_spec.rb

@@ -25,7 +25,7 @@
     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",

spec/property_spec.rb

@@ -33,7 +33,7 @@
 
   context "when reading a property fails" do
     it "gets an error, mentioning the qualified property name" do
-      expect { @iface["Explosive"] } \
+      expect { @iface["Explosive"] }
         .to raise_error(DBus::Error, /getting.*SampleInterface.Explosive.*Something failed/)
     end
   end
@@ -50,14 +50,14 @@
 
     context "when writing a read-only property" do
       it "gets an error, mentioning the qualified property name" do
-        expect { @iface["ReadMe"] = "WROTE" }  \
+        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" } \
+        expect { @iface["WriteMe"] = "Bruno is a city in Czechia" }
           .to raise_error(DBus::Error, /setting.*SampleInterface.WriteMe/)
       end
     end