diff options
Diffstat (limited to 'rubocop/cop/rspec')
| -rw-r--r-- | rubocop/cop/rspec/timecop_freeze.rb | 41 | ||||
| -rw-r--r-- | rubocop/cop/rspec/top_level_describe_path.rb | 2 |
2 files changed, 42 insertions, 1 deletions
diff --git a/rubocop/cop/rspec/timecop_freeze.rb b/rubocop/cop/rspec/timecop_freeze.rb new file mode 100644 index 00000000000..508b5df7c7f --- /dev/null +++ b/rubocop/cop/rspec/timecop_freeze.rb @@ -0,0 +1,41 @@ +# frozen_string_literal: true + +module RuboCop + module Cop + module RSpec + # This cop checks for `Timecop.freeze` usage in specs. + # + # @example + # + # # bad + # Timecop.freeze(Time.current) { example.run } + # + # # good + # freeze_time(Time.current) { example.run } + # + class TimecopFreeze < RuboCop::Cop::Cop + include MatchRange + MESSAGE = 'Do not use `Timecop.freeze`, use `freeze_time` instead. ' \ + 'See https://gitlab.com/gitlab-org/gitlab/-/issues/214432 for more info.' + + def_node_matcher :timecop_freeze?, <<~PATTERN + (send (const nil? :Timecop) :freeze ?_) + PATTERN + + def on_send(node) + return unless timecop_freeze?(node) + + add_offense(node, location: :expression, message: MESSAGE) + end + + def autocorrect(node) + -> (corrector) do + each_match_range(node.source_range, /^(Timecop\.freeze)/) do |match_range| + corrector.replace(match_range, 'freeze_time') + end + end + end + end + end + end +end diff --git a/rubocop/cop/rspec/top_level_describe_path.rb b/rubocop/cop/rspec/top_level_describe_path.rb index 61796e23af0..3cc1ee8df90 100644 --- a/rubocop/cop/rspec/top_level_describe_path.rb +++ b/rubocop/cop/rspec/top_level_describe_path.rb @@ -21,7 +21,7 @@ module RuboCop private def acceptable_file_path?(path) - File.fnmatch?('*_spec.rb', path) || File.fnmatch?('*/frontend/fixtures/*', path) + File.fnmatch?('*_spec.rb', path) || File.fnmatch?('*/frontend/fixtures/*', path) || File.fnmatch?('*/docs_screenshots/*_docs.rb', path) end def shared_example?(node) |