rubocop-openproject 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32626e1f367406ced02e2379b7a390a9c8d9012ce29174a7aefa3cfae33375d9
-  data.tar.gz: 31d990582ddf0efa6ae5f3905d2024bb4dc525160061315a983ea510f45f9fe2
+  metadata.gz: 1b7762dbbe159ef129537b0da6ca121fde8f6417a92ae9d55acff9af82002456
+  data.tar.gz: f1193f7c4cf3b908b52a29649927a6e73a5f39376a79e69e0c0540461600ed01
 SHA512:
-  metadata.gz: 2b488bcfd9c6dd063ef385c69afe15ba12e5a7ea0419065796e392e8564d1c42e02ca9f78288e9f7b6fcb7c8ed0e81ea03a179c886f0742faf42ca4dd8346d43
-  data.tar.gz: 0b913ebb1d53d3c90f9faa66cc21c044d4b076d23495dbd37042c5b91c78e9d41b212db7972b38502c7cf09dd7040104d15774094c312819eec15c379e1a8ff7
+  metadata.gz: 8d78e20f34afc1d1ac0ffcafa68a1a0953e49b7952d62e0ced2f78866500c43708294f5131796e0e2583c0aa0eab031fdfe818f063184313ef5747642ffcca21
+  data.tar.gz: 0d590796e0332ab1679f46062f967d4ab0bee76a97f7f7dc85617dc1186e60437e08071c4c1b6e6981a17fd2262e834fcd9294eb53c1751f9c31d81f1d85a5ff

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-10-18
+
+- Add `OpenProject/NoSleepInFeatureSpecs` cop to check that `sleep` calls in
+  feature specs are not greater than 1 second.
+
 ## [0.1.0] - 2024-07-05
 
 - Initial release

data/config/default.yml

@@ -8,6 +8,11 @@ OpenProject/NoDoEndBlockWithRSpecCapybaraMatcherInExpect:
   Enabled: true
   VersionAdded: '0.1.0'
 
+OpenProject/NoSleepInFeatureSpecs:
+  Description: 'Avoid using `sleep` greater than 1 second in feature specs.'
+  Enabled: true
+  VersionAdded: '0.1.0'
+
 OpenProject/UseServiceResultFactoryMethods:
   Description: 'Use ServiceResult factory methods instead of ServiceResult.new.'
   Enabled: true

data/lib/rubocop/cop/open_project/no_sleep_in_feature_specs.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module OpenProject
+      # Checks that feature specs do not use `sleep` greater than 1 second.
+      #
+      # Relying on `sleep` for synchronization reduces overall performance of
+      # the test suite. Consider using Capybara `have_*` matchers or
+      # rspec-wait `wait_for` method instead.
+      #
+      # @example
+      #
+      #   # bad
+      #   sleep 20
+      #
+      #   # bad
+      #   sleep 1.5
+      #
+      #   # bad
+      #   delay = 15
+      #   sleep delay
+      #
+      #   # good (use sparingly)
+      #   sleep 1
+      #
+      #   # good
+      #   expect(page).not_to have_text("please wait")
+      #
+      #   # good
+      #   expect(page).to have_text("success")
+      #
+      #   good
+      #   wait_for { work_package.reload.subject }.to eq("Updated name")
+      class NoSleepInFeatureSpecs < Base
+        MSG = "Avoid using `sleep` greater than 1 second in feature specs. " \
+              "It will reduce overall performance of the test suite. " \
+              "Consider using Capybara `have_*` matchers or rspec-wait " \
+              "`wait_for` method instead."
+
+        def_node_matcher :on_sleep_call, "(send nil? :sleep $...)"
+
+        def on_send(node)
+          return unless feature_spec?(processed_source)
+
+          on_sleep_call(node) do |args|
+            add_offense(node, message: MSG) if sleeping_too_much?(args[0])
+          end
+        end
+
+        private
+
+        def sleeping_too_much?(arg)
+          return false if arg&.numeric_type? && arg.value.between?(0, 1)
+
+          true
+        end
+
+        def feature_spec?(source)
+          source.file_path.include?("_spec.rb") && source.file_path.include?("features/")
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/open_project_cops.rb

@@ -3,3 +3,4 @@
 require_relative "open_project/add_preview_for_view_component"
 require_relative "open_project/no_do_end_block_with_rspec_capybara_matcher_in_expect"
 require_relative "open_project/use_service_result_factory_methods"
+require_relative "open_project/no_sleep_in_feature_specs"

data/lib/rubocop/open_project/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module OpenProject
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-openproject
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - OpenProject GmbH
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -41,6 +40,7 @@ files:
 - lib/rubocop-openproject.rb
 - lib/rubocop/cop/open_project/add_preview_for_view_component.rb
 - lib/rubocop/cop/open_project/no_do_end_block_with_rspec_capybara_matcher_in_expect.rb
+- lib/rubocop/cop/open_project/no_sleep_in_feature_specs.rb
 - lib/rubocop/cop/open_project/use_service_result_factory_methods.rb
 - lib/rubocop/cop/open_project_cops.rb
 - lib/rubocop/open_project.rb
@@ -54,7 +54,6 @@ metadata:
   source_code_uri: https://github.com/opf/rubocop-openproject
   changelog_uri: https://github.com/opf/rubocop-openproject/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -69,8 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
-signing_key:
+rubygems_version: 3.6.0.dev
 specification_version: 4
 summary: RuboCop cops for OpenProject
 test_files: []