[GR-17457] Add Ruby linter policy for space around = for a method default parameter

PullRequest: truffleruby/3690

Author: andrykonchin

.rubocop.yml

@@ -384,4 +384,9 @@ Layout/SpaceBeforeBlockBraces:
 Layout/SpaceInsideBlockBraces:
   Enabled: true
   EnforcedStyle: space
-  EnforcedStyleForEmptyBraces: space
+  EnforcedStyleForEmptyBraces: space
+
+# Supports --auto-correct
+Layout/SpaceAroundEqualsInParameterDefault:
+  Description: Checks that the equals signs in parameter default assignments have or don't have surrounding space depending on configuration.
+  Enabled: true

lib/truffle/digest/bubblebabble.rb

@@ -22,7 +22,7 @@ def self.bubblebabble(message)
       digest.bubblebabble
     end
 
-    def bubblebabble(message=NO_MESSAGE)
+    def bubblebabble(message = NO_MESSAGE)
       Digest.bubblebabble(digest(message))
     end
 

lib/truffle/pathname.rb

@@ -374,7 +374,7 @@ def prepend_prefix(prefix, relpath)
   # entries than absolutely necessary, but without accessing the filesystem,
   # this can't be avoided.  See #realpath.
   #
-  def cleanpath(consider_symlink=false)
+  def cleanpath(consider_symlink = false)
     if consider_symlink
       cleanpath_conservative
     else
@@ -478,7 +478,7 @@ def cleanpath_conservative
   # All components of the pathname must exist when this method is
   # called.
   #
-  def realpath(basedir=nil)
+  def realpath(basedir = nil)
     self.class.new(File.realpath(@path, basedir))
   end
 
@@ -488,7 +488,7 @@ def realpath(basedir=nil)
   #
   # The last component of the real pathname can be nonexistent.
   #
-  def realdirpath(basedir=nil)
+  def realdirpath(basedir = nil)
     self.class.new(File.realdirpath(@path, basedir))
   end
 
@@ -707,7 +707,7 @@ def join(*args)
   #
   # This method has existed since 1.8.1.
   #
-  def children(with_directory=true)
+  def children(with_directory = true)
     with_directory = false if @path == '.'
     result = []
     Dir.foreach(@path) do |e|
@@ -747,7 +747,7 @@ def children(with_directory=true)
   #   #   #<Pathname:src>
   #   #   #<Pathname:man>
   #
-  def each_child(with_directory=true, &b)
+  def each_child(with_directory = true, &b)
     children(with_directory).each(&b)
   end
 

lib/truffle/socket/ip_socket.rb

@@ -35,7 +35,7 @@ def addr(reverse_lookup = nil)
     Truffle::Socket.address_info(:getsockname, self, reverse_lookup)
   end
 
-  def peeraddr(reverse_lookup=nil)
+  def peeraddr(reverse_lookup = nil)
     Truffle::Socket.address_info(:getpeername, self, reverse_lookup)
   end
 

lib/truffle/stringio.rb

@@ -41,7 +41,7 @@ def readbyte
     readchar.getbyte(0)
   end
 
-  def readline(sep=$/, limit=::Undefined, chomp: false)
+  def readline(sep = $/, limit = ::Undefined, chomp: false)
     check_readable
     raise EOFError, 'end of file reached' if eof?
 
@@ -138,7 +138,7 @@ def self.open(*args)
 
   attr_reader :__data__
 
-  def initialize(string=nil, mode=nil, **options)
+  def initialize(string = nil, mode = nil, **options)
     if block_given?
       warn 'StringIO::new() does not take block; use StringIO::open() instead'
     end
@@ -190,7 +190,7 @@ def initialize_copy(from)
     raise IOError, 'unable to modify data' if @__data__.string.frozen?
   end
 
-  def set_encoding(external, internal=nil, options=nil)
+  def set_encoding(external, internal = nil, options = nil)
     encoding = external || Encoding.default_external
     d = @__data__
     TruffleRuby.synchronized(d) do
@@ -257,7 +257,7 @@ def each_codepoint(&block)
     self
   end
 
-  def each(sep=$/, limit=Undefined, chomp: false)
+  def each(sep = $/, limit = Undefined, chomp: false)
     return to_enum :each, sep, limit, chomp: chomp unless block_given?
     check_readable
 
@@ -385,7 +385,7 @@ def getbyte
     end
   end
 
-  def gets(sep=$/, limit=Undefined, chomp: false)
+  def gets(sep = $/, limit = Undefined, chomp: false)
     check_readable
 
     # Truffle: $_ is thread and frame local, so we use a primitive to
@@ -474,7 +474,7 @@ def read(length = nil, buffer = nil)
     end
   end
 
-  def readlines(sep=$/, limit=Undefined, chomp: false)
+  def readlines(sep = $/, limit = Undefined, chomp: false)
     check_readable
 
     ary = []
@@ -485,7 +485,7 @@ def readlines(sep=$/, limit=Undefined, chomp: false)
     ary
   end
 
-  def reopen(string=nil, mode=Undefined)
+  def reopen(string = nil, mode = Undefined)
     if string and not string.kind_of? String and mode.equal? Undefined
       stringio = Truffle::Type.coerce_to(string, StringIO, :to_strio)
 
@@ -699,7 +699,7 @@ def yaml_initialize(type, val)
     d.string.replace('') if (mode & IO::TRUNC) != 0
   end
 
-  private def getline(arg_error, sep, limit, chomp=false)
+  private def getline(arg_error, sep, limit, chomp = false)
     if limit != Undefined
       limit = Primitive.rb_to_int limit if limit
       sep = Truffle::Type.coerce_to sep, String, :to_str if sep

lib/truffle/timeout.rb

@@ -180,7 +180,7 @@ def timeout(sec, exception = Error, message = nil)
 # Defined for backwards compatibility with earlier versions of timeout.rb, see
 # Timeout#timeout.
 
-def timeout(n, e=Timeout::Error, &block) # :nodoc:
+def timeout(n, e = Timeout::Error, &block) # :nodoc:
   Timeout.timeout(n, e, &block)
 end
 

spec/truffle/arguments_descriptor_spec.rb

@@ -150,7 +150,7 @@ def posn_kws_defaults(a, b: 101, c: 102)
   end
 
   it "contain the name of present optional keyword arguments without the optional positional" do
-    def opt_and_kws(a, b=2, c: nil)
+    def opt_and_kws(a, b = 2, c: nil)
       info([a, b, c], Primitive.arguments_descriptor, Primitive.arguments)
     end
 

src/main/ruby/truffleruby/core/argf.rb

@@ -125,7 +125,7 @@ def default_value
     #
     # @see  #gets.
     #
-    def each_line(sep=$/)
+    def each_line(sep = $/)
       return to_enum :each_line, sep unless block_given?
       return nil unless advance!
 
@@ -283,7 +283,7 @@ def getc
     # The mechanism does track the line numbers,
     # and updates $. accordingly.
     #
-    def gets(sep=$/)
+    def gets(sep = $/)
       while advance!
         line = @stream.gets(sep)
 
@@ -375,7 +375,7 @@ def readbyte
     # is provided, as by default, a String with the data is
     # returned instead.
     #
-    def read(bytes=nil, output=nil)
+    def read(bytes = nil, output = nil)
       # The user might try to pass in nil, so we have to check here
       if Primitive.nil? output
         output = default_value
@@ -454,11 +454,11 @@ def getpartial(bytes, output, is_blocking, exception: true)
     end
     private :getpartial
 
-    def readpartial(bytes, output=nil)
+    def readpartial(bytes, output = nil)
       getpartial(bytes, output, true)
     end
 
-    def read_nonblock(bytes, output=nil, exception: true)
+    def read_nonblock(bytes, output = nil, exception: true)
       getpartial(bytes, output, false, exception: exception)
     end
 
@@ -470,7 +470,7 @@ def read_nonblock(bytes, output=nil, exception: true)
     #
     # @see  #gets
     #
-    def readline(sep=$/)
+    def readline(sep = $/)
       raise EOFError, 'ARGF at end' unless advance!
 
       if line = gets(sep)
@@ -488,7 +488,7 @@ def readline(sep=$/)
     #
     # @see  #gets
     #
-    def readlines(sep=$/)
+    def readlines(sep = $/)
       return [] unless advance!
 
       lines = []

src/main/ruby/truffleruby/core/array.rb

@@ -399,7 +399,7 @@ def empty?
     size == 0
   end
 
-  def fetch(idx, default=undefined)
+  def fetch(idx, default = undefined)
     orig = idx
     idx = Primitive.rb_num2int idx
 
@@ -420,7 +420,7 @@ def fetch(idx, default=undefined)
     at(idx)
   end
 
-  private def fill_internal(a=undefined, b=undefined, c=undefined)
+  private def fill_internal(a = undefined, b = undefined, c = undefined)
     Primitive.check_frozen self
 
     if block_given?
@@ -492,7 +492,7 @@ def first(n = undefined)
     Array.new self[0, n]
   end
 
-  def flatten(level=-1)
+  def flatten(level = -1)
     level = Primitive.rb_num2int level
     return Array.new(self) if level == 0
 
@@ -501,7 +501,7 @@ def flatten(level=-1)
     out
   end
 
-  def flatten!(level=-1)
+  def flatten!(level = -1)
     Primitive.check_frozen self
 
     level = Primitive.rb_num2int level
@@ -572,7 +572,7 @@ def hash
   end
   Truffle::Graal.always_split instance_method(:hash)
 
-  def find_index(obj=undefined)
+  def find_index(obj = undefined)
     super
   end
   alias_method :index, :find_index
@@ -650,7 +650,7 @@ def intersection(*others)
     common.keys
   end
 
-  def join(sep=nil)
+  def join(sep = nil)
     return ''.encode(Encoding::US_ASCII) if size == 0
 
     out = +''
@@ -702,7 +702,7 @@ def keep_if(&block)
     self
   end
 
-  def last(n=undefined)
+  def last(n = undefined)
     if Primitive.undefined?(n)
       return at(-1)
     elsif size < 1
@@ -718,7 +718,7 @@ def last(n=undefined)
     Array.new self[-n..-1]
   end
 
-  def permutation(num=undefined, &block)
+  def permutation(num = undefined, &block)
     unless block_given?
       return to_enum(:permutation, num) do
         permutation_size(num)
@@ -756,11 +756,11 @@ def permutation(num=undefined, &block)
     self
   end
 
-  def max(n=undefined)
+  def max(n = undefined)
     super(n)
   end
 
-  def min(n=undefined)
+  def min(n = undefined)
     super(n)
   end
 
@@ -998,7 +998,7 @@ def reverse_each
     self
   end
 
-  def rindex(obj=undefined)
+  def rindex(obj = undefined)
     if Primitive.undefined?(obj)
       return to_enum(:rindex, obj) unless block_given?
 
@@ -1023,7 +1023,7 @@ def rindex(obj=undefined)
     nil
   end
 
-  def rotate(n=1)
+  def rotate(n = 1)
     n = Primitive.rb_num2int n
 
     len = self.length
@@ -1034,7 +1034,7 @@ def rotate(n=1)
     Primitive.array_rotate self, n
   end
 
-  def rotate!(n=1)
+  def rotate!(n = 1)
     n = Primitive.rb_num2int n
     Primitive.check_frozen self
 
@@ -1612,7 +1612,7 @@ def reverse!
     self
   end
 
-  def slice!(start, length=undefined)
+  def slice!(start, length = undefined)
     Primitive.check_frozen self
 
     if Primitive.undefined? length

src/main/ruby/truffleruby/core/complex.rb

@@ -55,13 +55,13 @@ def Complex.generic?(other) # :nodoc:
     (defined?(Rational) and Primitive.object_kind_of?(other, Rational))
   end
 
-  def Complex.rect(real, imag=0)
+  def Complex.rect(real, imag = 0)
     raise TypeError, 'not a real' unless Primitive.check_real?(real) && Primitive.check_real?(imag)
     new(real, imag)
   end
   class << self; alias_method :rectangular, :rect end
 
-  def Complex.polar(r, theta=0)
+  def Complex.polar(r, theta = 0)
     raise TypeError, 'not a real' unless Primitive.check_real?(r) && Primitive.check_real?(theta)
 
     Complex(r*Math.cos(theta), r*Math.sin(theta))