rubocop-openproject 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32626e1f367406ced02e2379b7a390a9c8d9012ce29174a7aefa3cfae33375d9
-  data.tar.gz: 31d990582ddf0efa6ae5f3905d2024bb4dc525160061315a983ea510f45f9fe2
+  metadata.gz: 216a0869e29d95a92306d0d02e2bc340b7914733f86d56c4f27cce5fbcf8e466
+  data.tar.gz: d3ca3bc8f408a56843a5cbd7f8d69a8a1eadc6bda76c5ea8139201181a1e0de8
 SHA512:
-  metadata.gz: 2b488bcfd9c6dd063ef385c69afe15ba12e5a7ea0419065796e392e8564d1c42e02ca9f78288e9f7b6fcb7c8ed0e81ea03a179c886f0742faf42ca4dd8346d43
-  data.tar.gz: 0b913ebb1d53d3c90f9faa66cc21c044d4b076d23495dbd37042c5b91c78e9d41b212db7972b38502c7cf09dd7040104d15774094c312819eec15c379e1a8ff7
+  metadata.gz: 7041d99b3774a92ae145c93bf64ec52628aee9b04ebd08b04a3803c2d662f956404893306d8274762d0b1050c2f6787b135cc15f58d514e0d508bc8673487881
+  data.tar.gz: 989852deeca12ee26502f448d85e660f6539fca125cd5f174650acf2646da07eef463db5aa025c30d46976484730d2bc0cd363d9953af42fb25f688e24fd3541

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-07-11
+
+- Remove redundant NoDoEndBlockWithRSpecCapybaraMatcherInExpect cop
+
+## [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/README.md

@@ -26,6 +26,15 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+## Releasing
+
+1. Update the version in `lib/rubocop/open_project/version.rb`
+2. Update the changelog in `CHANGELOG.md`
+3. Run `bundle install` to update `Gemfile.lock`
+4. Run `rake` to check everything is fine and fix any issues
+5. Commit your changes (`git commit -am 'Prepare release X.Y.Z'`)
+6. Run `bundle exec rake release`
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/opf/rubocop-openproject.

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

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 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.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-openproject
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - OpenProject GmbH
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2025-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -40,7 +40,7 @@ files:
 - config/default.yml
 - 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
@@ -69,7 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: RuboCop cops for OpenProject

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

@@ -1,89 +0,0 @@
-# frozen_string_literal: true
-
-module RuboCop
-  module Cop
-    module OpenProject
-      # As +do .. end+ block has less precedence than method call, a +do .. end+
-      # block at the end of a rspec matcher will be an argument to the +to+ method,
-      # which is not handled by Capybara matchers (teamcapybara/capybara/#2616).
-      #
-      # @example
-      #
-      #   # bad
-      #   expect(page).to have_selector("input") do |input|
-      #     input.value == "hello world"
-      #   end
-      #
-      #   # good
-      #   expect(page).to have_selector("input") { |input| input.value == "hello world" }
-      #
-      #   # good
-      #   expect(page).to have_selector("input", value: "hello world")
-      #
-      #   # good
-      #   match_input_with_hello_world = have_selector("input") do |input|
-      #     input.value == "hello world"
-      #   end
-      #   expect(page).to match_input_with_hello_world
-      #
-      #   # good
-      #   expect(foo).to have_received(:bar) do |arg|
-      #     arg == :baz
-      #   end
-      #
-      class NoDoEndBlockWithRSpecCapybaraMatcherInExpect < Base
-        CAPYBARA_MATCHER_METHODS = %w[selector css xpath text title current_path link button
-                                      field checked_field unchecked_field select table
-                                      sibling ancestor].flat_map do |matcher_type|
-                                        ["have_#{matcher_type}", "have_no_#{matcher_type}"]
-                                      end
-
-        MSG = "The `do .. end` block is associated with `to` and not with Capybara matcher `%<matcher_method>s`."
-
-        def_node_matcher :expect_to_with_block?, <<~PATTERN
-          # ruby-parse output
-          (block
-            (send
-              (send nil? :expect ...)
-              :to
-              ...
-            )
-            ...
-          )
-        PATTERN
-
-        def_node_matcher :rspec_matcher, <<~PATTERN
-          (send
-            (send nil? :expect...)
-            :to
-            (:send nil? $_matcher_method ...)
-          )
-        PATTERN
-
-        def on_block(node)
-          return unless expect_to_with_block?(node)
-          return unless capybara_matcher?(node)
-
-          add_offense(offense_range(node), message: offense_message(node))
-        end
-
-        private
-
-        def capybara_matcher?(node)
-          matcher_name = node.send_node.arguments.first.method_name.to_s
-          CAPYBARA_MATCHER_METHODS.include?(matcher_name)
-        end
-
-        def offense_range(node)
-          node.send_node.loc.selector.join(node.loc.end)
-        end
-
-        def offense_message(node)
-          rspec_matcher(node.send_node) do |matcher_method|
-            format(MSG, matcher_method:)
-          end
-        end
-      end
-    end
-  end
-end