rubocop-openproject 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b7762dbbe159ef129537b0da6ca121fde8f6417a92ae9d55acff9af82002456
-  data.tar.gz: f1193f7c4cf3b908b52a29649927a6e73a5f39376a79e69e0c0540461600ed01
+  metadata.gz: 9cfe3bab3bbbc3032190c71f7e824eb2d451f854248d076aca30db79723f346b
+  data.tar.gz: b265782c32033cd8315f9a0b3bef3cb4cf7c0bdcf01d3fb85de59559fa9a9935
 SHA512:
-  metadata.gz: 8d78e20f34afc1d1ac0ffcafa68a1a0953e49b7952d62e0ced2f78866500c43708294f5131796e0e2583c0aa0eab031fdfe818f063184313ef5747642ffcca21
-  data.tar.gz: 0d590796e0332ab1679f46062f967d4ab0bee76a97f7f7dc85617dc1186e60437e08071c4c1b6e6981a17fd2262e834fcd9294eb53c1751f9c31d81f1d85a5ff
+  metadata.gz: cde9e717e29db386ab61514b4533f0861956fe2aefe5eeadc9b5baf0c12fb4fa3851f565c0cab2ca9919ed652c27623a45ef1f41ed9c6f2f9bce81fcf2f9aff7
+  data.tar.gz: 690ebd432e8719ba28f5bd2e146304883626dde1cdd8fab45a6dc518cf16401615c3cdab7382c258db7cc166b40baac9e512c915a26a59aafe5fbb0897d74d22

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [0.4.0] - 2026-03-27
+
+- Add NoNotImplementedError cop
+
+## [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

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/NoNotImplementedError:
+  Description: 'Do not raise `NotImplementedError` to signal an unimplemented abstract method.'
+  Enabled: true
+  VersionAdded: '0.4.0'
+
 OpenProject/NoSleepInFeatureSpecs:
   Description: 'Avoid using `sleep` greater than 1 second in feature specs.'
   Enabled: true

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module OpenProject
+      # Warns against using a `NotImplementedError` exception when a method
+      # should be implemented by a subclass or including module. Ruby's
+      # `NotImplementedError` is reserved for platform-specific missing
+      # features (e.g., methods depending on `fsync` or `fork`), not for
+      # abstract method patterns.
+      #
+      # @example
+      #   # bad
+      #   raise NotImplementedError
+      #
+      #   # bad
+      #   raise NotImplementedError, "Subclasses must implement #foo"
+      #
+      #   # bad
+      #   raise NotImplementedError.new("Subclasses must implement #foo")
+      #
+      #   # bad
+      #   fail NotImplementedError
+      #
+      #   # good
+      #   raise NotYetImplementedError
+      #
+      #   # good
+      #   raise SubclassResponsibilityError, "#{self.class} must implement #foo"
+      #
+      class NoNotImplementedError < Base
+        MSG = "Do not raise `NotImplementedError` to signal an unimplemented abstract method. " \
+              "Ruby's `NotImplementedError` is reserved for platform-specific missing features. " \
+              "Raise a descriptive custom error class instead."
+
+        RESTRICT_ON_SEND = %i[raise fail].freeze
+
+        def_node_matcher :raises_not_implemented_error?, <<~PATTERN
+          {
+            (send nil? {:raise :fail} (const nil? :NotImplementedError) ...)
+            (send nil? {:raise :fail} (send (const nil? :NotImplementedError) :new ...) ...)
+          }
+        PATTERN
+
+        def on_send(node)
+          return unless raises_not_implemented_error?(node)
+
+          add_offense(node)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/open_project_cops.rb

@@ -1,6 +1,6 @@
 # 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/no_not_implemented_error"
 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.2.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-openproject
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - OpenProject GmbH
 bindir: exe
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -39,7 +39,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_not_implemented_error.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
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.6.9
 specification_version: 4
 summary: RuboCop cops for OpenProject
 test_files: []

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