rubocop-iotventure 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d7b5e0864c57af9dfe62005ea09865ac27c92fcc5fcc34d4019045aa7d54946
-  data.tar.gz: 0c4174349f69ab40a37a476e1613c8a564ce8eb2982d15f05f4de821fb6a6544
+  metadata.gz: beea57247dc2b420f2cdff17108b0b0b4a7f542e242b4a01d3515ae3f16d5337
+  data.tar.gz: 4ce49ecad2def1b3879ea73cfa6c147af01c606e0a5ffc237812e3dcc3bb394c
 SHA512:
-  metadata.gz: bab135bc00dc0221d376696da3adc36dad336635ad85209cc4a32eab525646ecbd69e0f77f85d5c9fc5de32fec8278970ff987152ff58697b78a68dc6ad76c78
-  data.tar.gz: 3a91e6bf9c5cb446919b89409ef921561d615466c27fd590edd3170c47915970b0bd8a3f7125d09e0968aee662a702831e87fbea6530eacbf9e88a77d0fa2e71
+  metadata.gz: 9d55967ddcd84b5c83e12c2e27efbc80d628c4de15cb187f9aebd954a042eff85f5260fe7967db59e4a077156395fd6ea5f6b82a81bf5167691a9225ea15257c
+  data.tar.gz: 543147561c54fc3bdbe7d6009773df9a65a8c951271125b6d907b7ad0a2753c0380fed021331c24d440780bf6652b89cfa653db1c018403a3d19e756650e6ae6

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## [Unreleased]
+# Changelog
+
+## [0.3.0] - 2023-06-01
+
+- BU-64 Add AdditionalProperties cop
+
+## [0.2.1] - 2023-04-21
+
+- Fix SchemaDefinitionPerResponse cop for 204 No Content responses
 
 ## [0.2.0] - 2022-05-12
 

data/Gemfile.lock

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

data/README.md

@@ -12,14 +12,45 @@ 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
 
+### IotVenture/AdditionalProperties
+
+```ruby
+# bad
+{
+    type: :object,
+    properties: {
+        prop1: { type: :string },
+        prop2: { type: :string }
+    }
+}
+
+# good
+{
+    type: :object,
+    properties: {
+        prop1: { type: :string },
+        prop2: { type: :string }
+    },
+    additionalProperties: false
+}
+```
+
+This cop checks that all object schemas have the `additionalProperties` property set to `false` or a useful matcher (not `true`). This is to prevent unexpected properties from being added to the object.
+
+Note: This only works for schemas defined as Ruby hashes.
+
 ### Iotventure/DuplicateResponseCode
 
 ```ruby
@@ -69,7 +100,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 +110,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/additional_properties.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Iotventure
+      # This cop checks that every array and object schema has additionalProperties (defined or set to false).
+      # Note: This only works for schemas defined as Ruby hashes.
+      #
+      # @example
+      #
+      #   # bad
+      #
+      #     {
+      #       type: :object,
+      #       properties: {
+      #         foo: { type: :string },
+      #         bar: { type: :boolean }
+      #       }
+      #     }
+      #   
+      # @example
+      #
+      #   # bad
+      #
+      #     {
+      #       type: :object,
+      #       properties: {
+      #         foo: { type: :string },
+      #         bar: { type: :boolean }
+      #       },
+      #       additionalProperties: true
+      #     }
+      #
+      #
+      # @example
+      #
+      #   # good
+      #
+      #     {
+      #       type: :object,
+      #       properties: {
+      #         foo: { type: :string },
+      #         bar: { type: :boolean }
+      #       },
+      #       additionalProperties: false
+      #     }
+      #     
+      #
+      #
+      class AdditionalProperties < Base
+        MISSING_MSG = 'Schema is missing additionalProperties. ' \
+                      'Please add it to the schema at %<current>s'
+        ALWAYS_TRUE_MSG = 'Schema has additionalProperties set to true. ' \
+                          'Please set it to false or define a rule at %<current>s'
+
+        # @!method schema_definition_with_properties?(node)
+        def_node_matcher :schema_object_definition_with_properties?, <<~PATTERN
+          (hash<
+            (pair
+              (sym :type)
+              {(sym :object) (str "object")}
+            )
+            (pair
+              <{(sym :properties) (sym :patternProperties)}>
+              ...
+            )
+            ...
+          >)
+        PATTERN
+
+        # @!method always_true_schema?(node)
+        def_node_matcher :always_true_schema?, <<~PATTERN
+          {
+            (true)
+            (hash) # Empty hash is also always true in JSON Schema
+          }
+        PATTERN
+
+        def on_hash(node)
+          return unless schema_object_definition_with_properties?(node)
+
+          additional_properties = node.pairs.find { |pair| pair.key.value == :additionalProperties }
+          return add_missing_offense(node) unless additional_properties
+
+          add_always_true_offense(node) if always_true_schema?(additional_properties.value)
+        end
+
+        private
+
+        def add_missing_offense(node)
+          add_offense(node, message: format(MISSING_MSG, current: source_location(node)))
+        end
+
+        def add_always_true_offense(node)
+          add_offense(node, message: format(ALWAYS_TRUE_MSG, current: source_location(node)))
+        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/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/cop/iotventure_cops.rb

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

data/lib/rubocop/iotventure/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Iotventure
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   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.3.0
 platform: ruby
 authors:
 - Fynn Starke
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2023-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -128,6 +128,7 @@ files:
 - bin/setup
 - config/default.yml
 - lib/rubocop-iotventure.rb
+- lib/rubocop/cop/iotventure/additional_properties.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
@@ -159,7 +160,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.