workitcop 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79371e45e2687e40b8c948ff054876d913874e37afec5976a0a87321b8d366fd
-  data.tar.gz: 1b7d4eb18afc0e5aacb18858b5fde8528afd27e37c06d12153ce44da043772f5
+  metadata.gz: 80347b4fb04c9aa32c22b82b23dbbd0e5a2fd03ef88b315f1f1c01dfc8c93e26
+  data.tar.gz: 1dd7d9093b765e52c835df19e0bd433cf88a67cad7d54750d52df70347bbb919
 SHA512:
-  metadata.gz: abf0954f07328af9294526a90d474ece1b2a385e43424daabc6e975c2c3ff9199a3d86666cdbc71224ed9da878d71958cf1123e053b469c19f8f3b9b04c8609d
-  data.tar.gz: fc02dae95dda1045deaa1fe766a43249435a8f3afe4234714aa80622cacfc28f6eb4e288b80a55f0d55fad9451d0ec5858619f26b6cb3ede6f147265585663e7
+  metadata.gz: 5b3e06a38ae5d726881aaa11c9913f3dad29b53c28b8b8faf99be48f56fa8bdf53c270a081310a8bee6c8aadd8f09b7c57a247abe20ef6aea673bb23a9d7f4f9
+  data.tar.gz: e2e06375856be038f064a4e4c26f61b12190c4ff4a3a3e5abada637fa74535572f4a1463e1e634012c2f22e6d86474f8c03dfd486593759571fc26fb9c7c1895

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+## 0.5.0 - 2022-12-27
+
+- Deprecate `Workit/ComitteeAssertSchemaConfirm`. ([@ydah])
+- Add new `Workit/CommitteeExpectedResponseStatusCode` and `Workit/RSpecRedundantHttpStatus`. ([@ydah])
+
 ## 0.4.2 - 2022-12-12
 
 - Fix a false negative for `Workit/ComitteeAssertSchemaConfirm`. ([@ydah])

data/README.md

@@ -1,4 +1,6 @@
-# Workitcop [![Gem Version](https://badge.fury.io/rb/workitcop.svg)](https://badge.fury.io/rb/workitcop) [![CI](https://github.com/ydah/workitcop/actions/workflows/ci.yml/badge.svg)](https://github.com/ydah/workitcop/actions/workflows/ci.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/77fd345a1f0e8ab706ed/maintainability)](https://codeclimate.com/github/ydah/workitcop/maintainability)
+# Workitcop
+
+![GitHub top language](https://img.shields.io/github/languages/top/ydah/workitcop?color=39ff14) [![Gem Version](https://badge.fury.io/rb/workitcop.svg)](https://badge.fury.io/rb/workitcop) [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop) [![CI](https://github.com/ydah/workitcop/actions/workflows/ci.yml/badge.svg)](https://github.com/ydah/workitcop/actions/workflows/ci.yml) [![Maintainability](https://api.codeclimate.com/v1/badges/77fd345a1f0e8ab706ed/maintainability)](https://codeclimate.com/github/ydah/workitcop/maintainability)
 
 Custom cops for [RuboCop](https://github.com/rubocop/rubocop).
 
@@ -16,28 +18,13 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install workitcop
 ```
 
-## Usage
-
-You need to tell RuboCop to load the Workitcop extension.
+## Documentation
 
-### RuboCop configuration file
+You can read a lot more about Workitcop in its [official docs](https://ydah.github.io/docs.wkt).
 
-Put this into your `.rubocop.yml`.
-
-```yaml
-require: workitcop
-```
-
-Alternatively, use the following array notation when specifying multiple extensions.
-
-```yaml
-require:
-  - rubocop-other-extension
-  - workitcop
-```
+## Changelog
 
-Now you can run `rubocop` and it will automatically load the Workitcop
-cops together with the standard cops.
+Workitcop's changelog is available [here](https://github.com/ydah/workitcop/blob/main/CHANGELOG.md).
 
 ## License
 

data/config/default.yml

@@ -8,7 +8,7 @@ Workit/ActionArgs:
     Check for controller action must be using `action_args`.
   Enabled: false
   Include:
-    - 'controllers/**/*'
+    - "controllers/**/*"
   ControllerMethods:
     - index
     - show
@@ -22,8 +22,14 @@ Workit/ComitteeAssertSchemaConfirm:
     Check for not pass expected response status code to check it against the corresponding schema explicitly.
   Enabled: false
 
+Workit/CommitteeExpectedResponseStatusCode:
+  Description: |
+    Check if the status code is specified as an argument to the method of the Committee
+    where the expected response status code is required.
+  Enabled: false
+
 Workit/NoopRescue:
-  Description: 'Check for suppress or ignore checked exception.'
+  Description: "Check for suppress or ignore checked exception."
   Enabled: false
 
 Workit/RestrictOnSend:
@@ -48,3 +54,7 @@ Workit/RSpecCapybaraPredicateMatcher:
 Workit/RSpecMinitestAssertions:
   Description: Check if using Minitest matchers.
   Enabled: false
+
+Workit/RSpecRedundantHttpStatus:
+  Description: Check for validation of redundant response HTTP status codes.
+  Enabled: false

data/lib/rubocop/cop/workit/comittee_assert_schema_confirm.rb

@@ -5,52 +5,11 @@ module RuboCop
     module Workit
       # Check for not pass expected response status code to check it against the corresponding schema explicitly.
       #
-      # @example
-      #   # bad
-      #   it 'something' do
-      #     subject
-      #     expect(response).to have_http_status 400
-      #     do_something
-      #     assert_schema_conform
-      #   end
+      # This cop is deprecated.
       #
-      #   # good
-      #   it 'something' do
-      #     subject
-      #     do_something
-      #     assert_schema_conform(400)
-      #   end
+      # @see https://www.rubydoc.info/gems/workitcop/RuboCop/Cop/Workit/CommitteeExpectedResponseStatusCode
       #
-      class ComitteeAssertSchemaConfirm < Base
-        include RangeHelp
-        extend AutoCorrector
-
-        MSG = "Pass expected response status code to check it against the corresponding schema explicitly."
-        RESTRICT_ON_SEND = %i[assert_schema_conform assert_response_schema_confirm].freeze
-
-        # @!method have_http_status(node)
-        def_node_search :have_http_status, <<~PATTERN
-          $(send nil? :have_http_status (:int $_))
-        PATTERN
-
-        def on_send(node)
-          return if node.arguments?
-
-          have_http_status(node.parent) do |child_node, value|
-            return autocorrect(node, child_node, value)
-          end
-
-          add_offense(node)
-        end
-
-        private
-
-        def autocorrect(node, child_node, value)
-          add_offense(node) do |corrector|
-            corrector.remove(range_by_whole_lines(child_node.parent.loc.expression, include_final_newline: true))
-            corrector.insert_after(node, "(#{value})")
-          end
-        end
+      class ComitteeAssertSchemaConfirm < CommitteeExpectedResponseStatusCode
       end
     end
   end

data/lib/rubocop/cop/workit/committee_expected_response_status_code.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Workit
+      # Check if the status code is specified as an argument to the method of the Committee
+      # where the expected response status code is required.
+      #
+      # @example
+      #   # bad
+      #   it 'something' do
+      #     subject
+      #     expect(response).to have_http_status 400
+      #     assert_schema_conform
+      #   end
+      #
+      #   # good
+      #   it 'something' do
+      #     subject
+      #     assert_schema_conform(400)
+      #   end
+      #
+      class CommitteeExpectedResponseStatusCode < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = "Specify the HTTP status code of the expected response as an argument."
+        RESTRICT_ON_SEND = %i[assert_schema_conform assert_response_schema_confirm].freeze
+
+        # @!method have_http_status(node)
+        def_node_search :have_http_status, <<~PATTERN
+          (send nil? :have_http_status (:int $_))
+        PATTERN
+
+        def on_send(node)
+          return if node.arguments?
+
+          have_http_status(node.parent) do |status|
+            return autocorrect(node, status)
+          end
+
+          add_offense(node)
+        end
+
+        private
+
+        def autocorrect(node, status)
+          add_offense(node) do |corrector|
+            corrector.insert_after(node, "(#{status})")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/workit/rspec_redundant_http_status.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Workit
+      # Check for validation of redundant response HTTP status codes.
+      #
+      # @example
+      #   # bad
+      #   it 'something' do
+      #     subject
+      #     expect(response).to have_http_status 400
+      #     assert_schema_conform(400)
+      #   end
+      #
+      #   # good
+      #   it 'something' do
+      #     subject
+      #     assert_schema_conform(400)
+      #   end
+      #
+      class RSpecRedundantHttpStatus < Base
+        include RangeHelp
+        extend AutoCorrector
+
+        MSG = "Remove redundant HTTP response status code validation."
+        RESTRICT_ON_SEND = %i[assert_schema_conform assert_response_schema_confirm].freeze
+
+        # @!method have_http_status(node)
+        def_node_search :have_http_status, <<~PATTERN
+          $(send nil? :have_http_status (:int _))
+        PATTERN
+
+        def on_send(node)
+          return if node.first_argument.nil?
+
+          have_http_status(node.parent) do |http_node|
+            return autocorrect(node, http_node.parent.loc.expression)
+          end
+        end
+
+        private
+
+        def autocorrect(_node, bad_range)
+          add_offense(bad_range) do |corrector|
+            corrector.remove(range_by_whole_lines(bad_range, include_final_newline: true))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/workitcop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Workitcop
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/lib/workitcop.rb

@@ -8,12 +8,16 @@ require_relative "rubocop/cop/workit/mixin/rspec_inflected_help"
 require_relative "rubocop/cop/workit/mixin/rspec_predicate_matcher_base"
 
 require_relative "rubocop/cop/workit/action_args"
-require_relative "rubocop/cop/workit/comittee_assert_schema_confirm"
+require_relative "rubocop/cop/workit/committee_expected_response_status_code"
 require_relative "rubocop/cop/workit/noop_rescue"
 require_relative "rubocop/cop/workit/restrict_on_send"
 require_relative "rubocop/cop/workit/rspec_capybara_match_style"
 require_relative "rubocop/cop/workit/rspec_capybara_predicate_matcher"
 require_relative "rubocop/cop/workit/rspec_minitest_assertions"
+require_relative "rubocop/cop/workit/rspec_redundant_http_status"
+
+# deprecated
+require_relative "rubocop/cop/workit/comittee_assert_schema_confirm"
 
 module Workitcop
   PROJECT_ROOT = ::Pathname.new(__dir__).parent.expand_path.freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workitcop
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - ydah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-12 00:00:00.000000000 Z
+date: 2022-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -40,6 +40,7 @@ files:
 - config/default.yml
 - lib/rubocop/cop/workit/action_args.rb
 - lib/rubocop/cop/workit/comittee_assert_schema_confirm.rb
+- lib/rubocop/cop/workit/committee_expected_response_status_code.rb
 - lib/rubocop/cop/workit/mixin/rspec_explicit_help.rb
 - lib/rubocop/cop/workit/mixin/rspec_inflected_help.rb
 - lib/rubocop/cop/workit/mixin/rspec_predicate_matcher_base.rb
@@ -48,6 +49,7 @@ files:
 - lib/rubocop/cop/workit/rspec_capybara_match_style.rb
 - lib/rubocop/cop/workit/rspec_capybara_predicate_matcher.rb
 - lib/rubocop/cop/workit/rspec_minitest_assertions.rb
+- lib/rubocop/cop/workit/rspec_redundant_http_status.rb
 - lib/workitcop.rb
 - lib/workitcop/inject.rb
 - lib/workitcop/version.rb