Merge pull request #267 from koic/add_new_performance_concurrent_mono…

…tonic_time_cop

Add new `Performance/ConcurrentMonotonicTime` cop

changelog/new_add_new_performance_concurrent_monotonic_time_cop.md

@@ -0,0 +1 @@
+* [#267](https://github.com/rubocop/rubocop-performance/pull/267): Add new `Performance/ConcurrentMonotonicTime` cop. ([@koic][])

config/default.yml

@@ -76,6 +76,12 @@ Performance/CompareWithBlock:
   Enabled: true
   VersionAdded: '0.46'
 
+Performance/ConcurrentMonotonicTime:
+  Description: 'Use `Process.clock_gettime(Process::CLOCK_MONOTONIC)` instead of `Concurrent.monotonic_time`.'
+  Reference: 'https://github.com/rails/rails/pull/43502'
+  Enabled: pending
+  VersionAdded: '1.12'
+
 Performance/ConstantRegexp:
   Description: 'Finds regular expressions with dynamic components that are all constants.'
   Enabled: pending

docs/modules/ROOT/pages/cops.adoc

@@ -23,6 +23,7 @@ Performance cops optimization analysis for your projects.
 * xref:cops_performance.adoc#performancechainarrayallocation[Performance/ChainArrayAllocation]
 * xref:cops_performance.adoc#performancecollectionliteralinloop[Performance/CollectionLiteralInLoop]
 * xref:cops_performance.adoc#performancecomparewithblock[Performance/CompareWithBlock]
+* xref:cops_performance.adoc#performanceconcurrentmonotonictime[Performance/ConcurrentMonotonicTime]
 * xref:cops_performance.adoc#performanceconstantregexp[Performance/ConstantRegexp]
 * xref:cops_performance.adoc#performancecount[Performance/Count]
 * xref:cops_performance.adoc#performancedeleteprefix[Performance/DeletePrefix]

docs/modules/ROOT/pages/cops_performance.adoc

@@ -458,6 +458,36 @@ array.min_by(&:foo)
 array.sort_by { |a| a[:foo] }
 ----
 
+== Performance/ConcurrentMonotonicTime
+
+|===
+| Enabled by default | Safe | Supports autocorrection | Version Added | Version Changed
+
+| Pending
+| Yes
+| Yes
+| 1.12
+| -
+|===
+
+This cop identifies places where `Concurrent.monotonic_time`
+can be replaced by `Process.clock_gettime(Process::CLOCK_MONOTONIC)`.
+
+=== Examples
+
+[source,ruby]
+----
+# bad
+Concurrent.monotonic_time
+
+# good
+Process.clock_gettime(Process::CLOCK_MONOTONIC)
+----
+
+=== References
+
+* https://github.com/rails/rails/pull/43502
+
 == Performance/ConstantRegexp
 
 |===

lib/rubocop/cop/performance/concurrent_monotonic_time.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Performance
+      # This cop identifies places where `Concurrent.monotonic_time`
+      # can be replaced by `Process.clock_gettime(Process::CLOCK_MONOTONIC)`.
+      #
+      # @example
+      #
+      #   # bad
+      #   Concurrent.monotonic_time
+      #
+      #   # good
+      #   Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      #
+      class ConcurrentMonotonicTime < Base
+        extend AutoCorrector
+
+        MSG = 'Use `%<prefer>s` instead of `%<current>s`.'
+        RESTRICT_ON_SEND = %i[monotonic_time].freeze
+
+        def_node_matcher :concurrent_monotonic_time?, <<~PATTERN
+          (send
+            (const {nil? cbase} :Concurrent) :monotonic_time ...)
+        PATTERN
+
+        def on_send(node)
+          return unless concurrent_monotonic_time?(node)
+
+          optional_unit_parameter = ", #{node.first_argument.source}" if node.first_argument
+          prefer = "Process.clock_gettime(Process::CLOCK_MONOTONIC#{optional_unit_parameter})"
+          message = format(MSG, prefer: prefer, current: node.source)
+
+          add_offense(node, message: message) do |corrector|
+            corrector.replace(node, prefer)
+          end
+        end
+      end
+    end
+  end
+end

lib/rubocop/cop/performance_cops.rb

@@ -13,6 +13,7 @@
 require_relative 'performance/casecmp'
 require_relative 'performance/collection_literal_in_loop'
 require_relative 'performance/compare_with_block'
+require_relative 'performance/concurrent_monotonic_time'
 require_relative 'performance/constant_regexp'
 require_relative 'performance/count'
 require_relative 'performance/delete_prefix'

spec/rubocop/cop/performance/concurrent_monotonic_time_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Performance::ConcurrentMonotonicTime, :config do
+  it 'registers an offense when using `Concurrent.monotonic_time`' do
+    expect_offense(<<~RUBY)
+      Concurrent.monotonic_time
+      ^^^^^^^^^^^^^^^^^^^^^^^^^ Use `Process.clock_gettime(Process::CLOCK_MONOTONIC)` instead of `Concurrent.monotonic_time`.
+    RUBY
+
+    expect_correction(<<~RUBY)
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    RUBY
+  end
+
+  it 'registers an offense when using `::Concurrent.monotonic_time`' do
+    expect_offense(<<~RUBY)
+      ::Concurrent.monotonic_time
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `Process.clock_gettime(Process::CLOCK_MONOTONIC)` instead of `::Concurrent.monotonic_time`.
+    RUBY
+
+    expect_correction(<<~RUBY)
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    RUBY
+  end
+
+  it 'registers an offense when using `Concurrent.monotonic_time` with an optional unit parameter' do
+    expect_offense(<<~RUBY)
+      Concurrent.monotonic_time(:float_second)
+      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Use `Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_second)` instead of `Concurrent.monotonic_time(:float_second)`.
+    RUBY
+
+    expect_correction(<<~RUBY)
+      Process.clock_gettime(Process::CLOCK_MONOTONIC, :float_second)
+    RUBY
+  end
+
+  it 'does not register an offense when using `Process.clock_gettime(Process::CLOCK_MONOTONIC)`' do
+    expect_no_offenses(<<~RUBY)
+      Process.clock_gettime(Process::CLOCK_MONOTONIC)
+    RUBY
+  end
+end