rubocop-iotventure 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d7b5e0864c57af9dfe62005ea09865ac27c92fcc5fcc34d4019045aa7d54946
-  data.tar.gz: 0c4174349f69ab40a37a476e1613c8a564ce8eb2982d15f05f4de821fb6a6544
+  metadata.gz: 8b8a1f840812e93ae9174569844d2aa5d0f76aa7992bb3644d952c062e6182df
+  data.tar.gz: 3991d6ec7f5d7ffce8ac15f6f774b1693ffaa793cee07c2fc6928acfbf78bf49
 SHA512:
-  metadata.gz: bab135bc00dc0221d376696da3adc36dad336635ad85209cc4a32eab525646ecbd69e0f77f85d5c9fc5de32fec8278970ff987152ff58697b78a68dc6ad76c78
-  data.tar.gz: 3a91e6bf9c5cb446919b89409ef921561d615466c27fd590edd3170c47915970b0bd8a3f7125d09e0968aee662a702831e87fbea6530eacbf9e88a77d0fa2e71
+  metadata.gz: 03cd8ba07eff16ae6291f202f3f9de70e8eead68bcfe15623edcdaf9a832ae370f4d3b4a316282162b2a5ee3db92adc636a68058a18c37318a11303548dbdbb3
+  data.tar.gz: 77de6184ef30e9ccd0473c16e5e9a75ad618df38bf57eb3c7a779f853c8bd8989499fb3ce12daccd64477eb5f6f7e1208f354fe43f9049189acd96a759197de3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
+# Changelog
+
 ## [Unreleased]
 
+## [0.2.1] - 2023-04-21
+
+- Fix SchemaDefinitionPerResponse cop for 204 No Content responses
+
 ## [0.2.0] - 2022-05-12
 
 - FB-111 Add SchemaDefinitionPerResponse cop

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-iotventure (0.2.0)
+    rubocop-iotventure (0.2.1)
       rubocop (~> 1.0)
       rubocop-rake (~> 0.6.0)
 

data/README.md

@@ -12,11 +12,15 @@ gem 'rubocop-iotventure', require: false
 
 And then execute:
 
-    $ bundle install
+```shell
+bundle install
+```
 
-Or install it yourself as:
+Or install it yourself using:
 
-    $ gem install rubocop-iotventure
+```shell
+gem install rubocop-iotventure
+```
 
 ## Usage
 
@@ -69,7 +73,7 @@ response 200, 'response description' do
 end
 ```
 
-This cop checks that there is exactly one top-level schema definition per response block. This makes sure that they do not overwrite each other.
+This cop checks that there is exactly one top-level schema definition per response block (except 204 No Content blocks, those should not have any schema definitions). Multiple or misplaced schema definitions might overwrite each other.
 
 ## Development
 
@@ -79,7 +83,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on Bitbucket at https://bitbucket.org/iotventure/rubocop-iotventure. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://bitbucket.org/iotventure/rubocop-iotventure/src/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on Bitbucket at <https://bitbucket.org/iotventure/rubocop-iotventure>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://bitbucket.org/iotventure/rubocop-iotventure/src/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/rubocop/cop/iotventure/schema_definition_per_response.rb

@@ -43,6 +43,15 @@ module RuboCop
       #
       # @example
       #
+      #   # bad
+      #
+      #   response 204, 'response description' do
+      #     schema '$ref' => '#/components/schemas/object'
+      #   end
+      #
+      #
+      # @example
+      #
       #   # good
       #
       #   response 200, 'response description' do
@@ -50,6 +59,14 @@ module RuboCop
       #   end
       #
       #
+      # @example
+      #
+      #   # good
+      #
+      #   response 204, 'response description' do
+      #   end
+      #
+      #
       class SchemaDefinitionPerResponse < Base
         MISSING_MSG = 'Schema definition is missing for response declaration at %<current>s.'
         DUPLICATED_MSG = 'Schema definition is defined both at %<first>s and %<second>s '\
@@ -58,6 +75,8 @@ module RuboCop
                         'but should be defined immediately after response declaration at %<other>s.'
         MISPLACED_WITHOUT_RESPONSE_DEFINITION_MSG = 'Schema definition for %<schema_name>s is '\
                                                     'outside of response declaration.'
+        NO_CONTENT_SCHEMA_MSG = 'Schema definition for %<schema_name>s is defined at %<current>s, '\
+                                'but 204 response should not have schema.'
 
         # @!method response_block?(node)
         def_node_matcher :response_block, <<~PATTERN
@@ -69,6 +88,18 @@ module RuboCop
           )
         PATTERN
 
+        # @!method no_content_response(node)
+        def_node_matcher :no_content_response, <<~PATTERN
+          (block
+            (send nil? :response
+              (:int 204)
+              (:str _)
+              ...
+            )
+            ...
+          )
+        PATTERN
+
         # @!method schema_definition?(node)
         def_node_matcher :schema_definition, <<~PATTERN
           (send nil? :schema
@@ -119,6 +150,7 @@ module RuboCop
         # that will be picked up by check_for_misplaced_schema
         def check_schema_definition_count(node)
           schema_definitions = schema_definitions(node)
+          return check_no_schemas(schema_definitions) if no_content_response(node)
 
           return if schema_definitions.count == 1
 
@@ -127,6 +159,14 @@ module RuboCop
           add_duplicated_offense(node, schema_definitions)
         end
 
+        def check_no_schemas(schema_definitions)
+          schema_definitions.each do |schema_definition|
+            message = format(NO_CONTENT_SCHEMA_MSG, schema_name: find_schema_name(schema_definition),
+                                                    current: source_location(schema_definition))
+            add_offense(schema_definition.loc.expression, message: message)
+          end
+        end
+
         def add_missing_offense(node)
           message = format(MISSING_MSG, current: source_location(node))
           add_offense(node.loc.expression, message: message)

data/lib/rubocop/iotventure/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Iotventure
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-iotventure
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Fynn Starke
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -159,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Rswag cops.