rubocop-iotventure 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d0d7b568c5726071030b7e7726c8b23c03a6169e717faf47112d76b6c375fc5
-  data.tar.gz: 229e07f5b7b072d3fcaca91b735227c2e639814f3efc949c135b2c47f8df3d8f
+  metadata.gz: 8b8a1f840812e93ae9174569844d2aa5d0f76aa7992bb3644d952c062e6182df
+  data.tar.gz: 3991d6ec7f5d7ffce8ac15f6f774b1693ffaa793cee07c2fc6928acfbf78bf49
 SHA512:
-  metadata.gz: 8c79b83a2cb794ffe161438753b0e161e09afec8b9b845b54d62affe8ed25189efc2932932fd56eee60575c98f0631f944502f55853bed59c52a70fe76e2cde0
-  data.tar.gz: cc8f99a6df08bab9d5351aee184403086d6466727b66df22624187ebae6ff2d226f65f82dc2e17289bb18dc96b27f1b5d762b0183f50adc82ea702deb2fa460a
+  metadata.gz: 03cd8ba07eff16ae6291f202f3f9de70e8eead68bcfe15623edcdaf9a832ae370f4d3b4a316282162b2a5ee3db92adc636a68058a18c37318a11303548dbdbb3
+  data.tar.gz: 77de6184ef30e9ccd0473c16e5e9a75ad618df38bf57eb3c7a779f853c8bd8989499fb3ce12daccd64477eb5f6f7e1208f354fe43f9049189acd96a759197de3

data/.rubocop.yml

@@ -15,6 +15,9 @@ Metrics/BlockLength:
     - '**/spec/**/*'
     - 'rubocop-iotventure.gemspec'
 
+Metrics/ClassLength:
+  CountAsOne: ['array', 'hash', 'heredoc']
+
 Naming/FileName:
  Exclude:
    - lib/rubocop-iotventure.rb

data/CHANGELOG.md

@@ -1,5 +1,19 @@
+# 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
+
+## [0.1.1] - 2022-04-18
+
+- Fix error for nonexistent response definition
+
 ## [0.1.0] - 2022-04-18
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-iotventure (0.1.1)
+    rubocop-iotventure (0.2.1)
       rubocop (~> 1.0)
       rubocop-rake (~> 0.6.0)
 
@@ -71,4 +71,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.2.32
+   2.3.13

data/README.md

@@ -1,8 +1,6 @@
 # Rubocop::Iotventure
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rubocop/iotventure`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is a gem running some internal checks for IoTVenture. All of the existing cops are for RSwag, but that might change in the future.
 
 ## Installation
 
@@ -14,15 +12,19 @@ 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
 
-### Rswag/DuplicateResponseCode
+### Iotventure/DuplicateResponseCode
 
 ```ruby
 # bad
@@ -36,7 +38,7 @@ response 401, 'response description 2' {}
 
 This cop prevents duplicated response code blocks. Those would overwrite each other when generating the `swagger.yaml` file.
 
-### Rswag/SaveRequestExample
+### Iotventure/SaveRequestExample
 
 ```ruby
 # bad
@@ -50,6 +52,29 @@ response 200, 'response description', save_request_example: :param1 {}
 
 This cop enforces usage of the `save_request_example` parameter in `api` files (saves the body parameter). This should only be enabled when there is custom logic reacting to this parameter.
 
+### Iotventure/SchemaDefinitionPerResponse
+
+```ruby
+# bad
+response 200, 'response description' do
+    context 'context' do
+        schema '$ref' => '#/components/schemas/object'
+    end
+end
+
+# bad
+schema '$ref' => '#/components/schemas/object'
+response 200, 'response description' {}
+
+
+# good
+response 200, 'response description' do
+    schema '$ref' => '#/components/schemas/object'
+end
+```
+
+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
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -58,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

@@ -0,0 +1,233 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Iotventure
+      # This cop checks that there is exactly one top-level schema definition per response declaration.
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   response 200, 'response description' {}
+      #
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   response 200, 'response description' do
+      #     context 'context' do
+      #       schema '$ref' => '#/components/schemas/object'
+      #     end
+      #   end
+      #
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   response 200, 'response description' do
+      #       schema '$ref' => '#/components/schemas/object1'
+      #       schema '$ref' => '#/components/schemas/object2'
+      #   end
+      #
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   schema '$ref' => '#/components/schemas/object'
+      #   response 200, 'response description' {}
+      #
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #   response 204, 'response description' do
+      #     schema '$ref' => '#/components/schemas/object'
+      #   end
+      #
+      #
+      # @example
+      #
+      #   # good
+      #
+      #   response 200, 'response description' do
+      #     schema '$ref' => '#/components/schemas/object'
+      #   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 '\
+                         'for response declaration at %<current>s.'
+        MISPLACED_MSG = 'Schema definition for %<schema_name>s is defined at %<current>s, '\
+                        '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
+          (block
+            (send nil? :response
+              (int _)
+              ...)
+            ...
+          )
+        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
+            (hash
+              ...
+            )
+          )
+        PATTERN
+
+        # @!method schema_name(node)
+        def_node_matcher :schema_name, <<~PATTERN
+          (send nil? :schema
+            (hash
+              (pair
+                (str "$ref")
+                (str $_)
+              )
+            )
+          )
+        PATTERN
+
+        # @!method schema_definition_by_child?(node)
+        def_node_matcher :schema_definition_by_child, <<~PATTERN
+          ({block | begin}
+            <
+              $(send nil? :schema
+                (hash
+                  ...
+                )
+              )
+              ...
+            >
+          )
+        PATTERN
+
+        def on_block(node)
+          return check_schema_definition_count(node) if response_block(node)
+
+          return if begin_inside_response_block?(node)
+
+          check_for_misplaced_schema(node)
+        end
+        alias on_begin on_block
+
+        private
+
+        # Checks that schema is missing completely. Does not check where schema is defined exactly,
+        # 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
+
+          return add_missing_offense(node) if schema_definitions.empty?
+
+          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)
+        end
+
+        def add_duplicated_offense(node, schema_definitions)
+          message = format(
+            DUPLICATED_MSG,
+            current: source_location(node),
+            first: source_location(schema_definitions[0]),
+            second: source_location(schema_definitions[1])
+          )
+          add_offense(node.loc.expression, message: message)
+        end
+
+        def check_for_misplaced_schema(node)
+          schema_definition = schema_definition_by_child(node)
+          return unless schema_definition
+
+          correct_node = response_definition_ancestor(node)
+          message = message_for_misplaced(schema_definition, correct_node)
+          add_offense(schema_definition.loc.expression, message: message)
+        end
+
+        def message_for_misplaced(schema_definition, correct_node)
+          if correct_node
+            return format(MISPLACED_MSG,
+                          schema_name: find_schema_name(schema_definition),
+                          other: source_location(correct_node),
+                          current: source_location(schema_definition))
+          end
+
+          format(MISPLACED_WITHOUT_RESPONSE_DEFINITION_MSG, schema_name: find_schema_name(schema_definition))
+        end
+
+        def begin_inside_response_block?(node)
+          node.begin_type? && response_block(node.parent)
+        end
+
+        def schema_definitions(node)
+          node.each_descendant.filter do |d|
+            schema_definition(d)
+          end
+        end
+
+        def response_definition_ancestor(node)
+          ancestor = node.parent
+          ancestor = ancestor.parent until ancestor.nil? || response_block(ancestor)
+          ancestor
+        end
+
+        def find_schema_name(schema_definition)
+          schema_name(schema_definition) || 'composite schema declaration'
+        end
+
+        def source_location(node)
+          range = node.location.expression
+          path = smart_path(range.source_buffer.name)
+          "#{path}:#{range.line}"
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/iotventure_cops.rb

@@ -2,3 +2,4 @@
 
 require_relative 'iotventure/duplicate_response_code'
 require_relative 'iotventure/save_request_example'
+require_relative 'iotventure/schema_definition_per_response'

data/lib/rubocop/iotventure/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Iotventure
-    VERSION = '0.1.1'
+    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.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Fynn Starke
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-18 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -130,6 +130,7 @@ files:
 - lib/rubocop-iotventure.rb
 - lib/rubocop/cop/iotventure/duplicate_response_code.rb
 - lib/rubocop/cop/iotventure/save_request_example.rb
+- lib/rubocop/cop/iotventure/schema_definition_per_response.rb
 - lib/rubocop/cop/iotventure_cops.rb
 - lib/rubocop/iotventure.rb
 - lib/rubocop/iotventure/inject.rb
@@ -158,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Rswag cops.