rubocop-iotventure 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b8a1f840812e93ae9174569844d2aa5d0f76aa7992bb3644d952c062e6182df
-  data.tar.gz: 3991d6ec7f5d7ffce8ac15f6f774b1693ffaa793cee07c2fc6928acfbf78bf49
+  metadata.gz: beea57247dc2b420f2cdff17108b0b0b4a7f542e242b4a01d3515ae3f16d5337
+  data.tar.gz: 4ce49ecad2def1b3879ea73cfa6c147af01c606e0a5ffc237812e3dcc3bb394c
 SHA512:
-  metadata.gz: 03cd8ba07eff16ae6291f202f3f9de70e8eead68bcfe15623edcdaf9a832ae370f4d3b4a316282162b2a5ee3db92adc636a68058a18c37318a11303548dbdbb3
-  data.tar.gz: 77de6184ef30e9ccd0473c16e5e9a75ad618df38bf57eb3c7a779f853c8bd8989499fb3ce12daccd64477eb5f6f7e1208f354fe43f9049189acd96a759197de3
+  metadata.gz: 9d55967ddcd84b5c83e12c2e27efbc80d628c4de15cb187f9aebd954a042eff85f5260fe7967db59e4a077156395fd6ea5f6b82a81bf5167691a9225ea15257c
+  data.tar.gz: 543147561c54fc3bdbe7d6009773df9a65a8c951271125b6d907b7ad0a2753c0380fed021331c24d440780bf6652b89cfa653db1c018403a3d19e756650e6ae6

data/CHANGELOG.md

@@ -1,6 +1,8 @@
 # Changelog
 
-## [Unreleased]
+## [0.3.0] - 2023-06-01
+
+- BU-64 Add AdditionalProperties cop
 
 ## [0.2.1] - 2023-04-21
 

data/Gemfile.lock

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

data/README.md

@@ -24,6 +24,33 @@ 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

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_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.1'
+    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.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Fynn Starke
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-21 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