Fix: TypeError: can't convert ImageOptim::Timer into Float

[yahonda]

This pull request addresses TypeError: can't convert ImageOptim::Timer into Float
when the timeout is an instance of ImageOptim::Timer with Ruby 3.0.2.

Refer to the original issue at Discourse https://meta.discourse.org/t/optimizedimage-specs-are-failing-with-ruby-3-0-2/204930

Current behavior

• Reverting this code from this pull request to see how it fails.

$ git diff
diff --git a/lib/image_optim/cmd.rb b/lib/image_optim/cmd.rb
index 4957f8d..ea00a28 100644
--- a/lib/image_optim/cmd.rb
+++ b/lib/image_optim/cmd.rb
@@ -17,7 +17,7 @@ class ImageOptim
           pid = Process.spawn(*args)

           waiter = Process.detach(pid)
-          if waiter.join(timeout.to_f)
+          if waiter.join(timeout)
             status = waiter.value

             check_status!(status)
$

• Ruby 3.0.2 raises TypeError

$ ruby -v
ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux]
$ bundle exec rspec ./spec/image_optim/cmd_spec.rb:52
Run options: include {:locations=>{"./spec/image_optim/cmd_spec.rb"=>[52]}}

Randomized with seed 32230
F

Failures:

  1) ImageOptim::Cmd.run with timeout returns process success status when timeout is instance of ImageOptim::Timer
     Failure/Error: if waiter.join(timeout)

     TypeError:
       can't convert ImageOptim::Timer into Float
     # ./lib/image_optim/cmd.rb:20:in `join'
     # ./lib/image_optim/cmd.rb:20:in `run'
     # ./spec/image_optim/cmd_spec.rb:54:in `block (4 levels) in <top (required)>'

Finished in 0.0023 seconds (files took 0.09478 seconds to load)
1 example, 1 failure

Failed examples:

rspec ./spec/image_optim/cmd_spec.rb:52 # ImageOptim::Cmd.run with timeout returns process success status when timeout is instance of ImageOptim::Timer

Randomized with seed 32230

$

• Ruby 2.7.4 works fine

$ ruby -v
ruby 2.7.4p191 (2021-07-07 revision a21a3b7d23) [x86_64-linux]
yahonda@myryzen:~/src/github.com/toy/image_optim$ bundle exec rspec ./spec/image_optim/cmd_spec.rb:52
Run options: include {:locations=>{"./spec/image_optim/cmd_spec.rb"=>[52]}}

Randomized with seed 21473
.

Finished in 0.00287 seconds (files took 0.09183 seconds to load)
1 example, 0 failures

Randomized with seed 21473

$

[toy]

Can confirm on 3.0.0, 3.0.1 and 3.0.2. Something got broken in the rb_to_float C method for converting objects to float, from documentation having #to_f should be enough (1, 2), but following is broken in all 3.0 versions:

class KindOfFloat
  def initialize(value)
    @value = value.to_f
  end

  def to_f
    @value
  end
end

Thread.new{ }.join(KindOfFloat.new(0.1))

[toy]

Thank you for contribution! I will submit an issue to ruby and check this PR

[toy]

I've temporarily fixed the issue caused by rubocop (false positive fixed in rubocop/rubocop#10141) and created an issue in ruby bug tracker.

PR looks good, please add an entry to changelog and rebase.

[yahonda]

Thanks for the review. Added a changelog entry and rebased and squashed from the latest master branch.

[toy]

Thanks again, released v0.31.0