fix: all collect helpers in collectionUtils file

Author: yelizhenden-mdb

tools/spectral/ipa/rulesets/functions/eachCustomMethodMustBeGetOrPost.js

@@ -1,6 +1,10 @@
 import { isCustomMethod } from './utils/resourceEvaluation.js';
-import { collectException, hasException } from './utils/exceptions.js';
-import { collectAdoption, collectAndReturnViolation } from './utils/collectionUtils.js';
+import { hasException } from './utils/exceptions.js';
+import {
+  collectAdoption,
+  collectAndReturnViolation,
+  collectException,
+} from './utils/collectionUtils.js';
 
 const RULE_NAME = 'xgen-IPA-109-custom-method-must-be-GET-or-POST';
 const ERROR_MESSAGE = 'The HTTP method for custom methods must be GET or POST.';

tools/spectral/ipa/rulesets/functions/eachCustomMethodMustUseCamelCase.js

@@ -1,7 +1,11 @@
 import { getCustomMethodName, isCustomMethod } from './utils/resourceEvaluation.js';
-import { collectException, hasException } from './utils/exceptions.js';
+import { hasException } from './utils/exceptions.js';
 import { casing } from '@stoplight/spectral-functions';
-import { collectAdoption, collectAndReturnViolation } from './utils/collectionUtils.js';
+import {
+  collectAdoption,
+  collectAndReturnViolation,
+  collectException,
+} from './utils/collectionUtils.js';
 
 const RULE_NAME = 'xgen-IPA-109-custom-method-must-use-camel-case';
 

tools/spectral/ipa/rulesets/functions/eachEnumValueMustBeUpperSnakeCase.js

@@ -1,7 +1,11 @@
-import { collectException, hasException } from './utils/exceptions.js';
+import { hasException } from './utils/exceptions.js';
 import { resolveObject } from './utils/componentUtils.js';
 import { casing } from '@stoplight/spectral-functions';
-import { collectAdoption, collectAndReturnViolation } from './utils/collectionUtils.js';
+import {
+  collectAdoption,
+  collectAndReturnViolation,
+  collectException,
+} from './utils/collectionUtils.js';
 
 const RULE_NAME = 'xgen-IPA-123-enum-values-must-be-upper-snake-case';
 const ERROR_MESSAGE = 'enum value must be UPPER_SNAKE_CASE.';

tools/spectral/ipa/rulesets/functions/eachPathAlternatesBetweenResourceNameAndPathParam.js

@@ -1,6 +1,10 @@
 import { isPathParam } from './utils/componentUtils.js';
-import { collectException, hasException } from './utils/exceptions.js';
-import { collectAdoption, collectAndReturnViolation } from './utils/collectionUtils.js';
+import { hasException } from './utils/exceptions.js';
+import {
+  collectAdoption,
+  collectAndReturnViolation,
+  collectException,
+} from './utils/collectionUtils.js';
 
 const RULE_NAME = 'xgen-IPA-102-path-alternate-resource-name-path-param';
 const ERROR_MESSAGE = 'API paths must alternate between resource name and path params.';

tools/spectral/ipa/rulesets/functions/eachResourceHasGetMethod.js

@@ -6,8 +6,12 @@ import {
   isSingletonResource,
   getResourcePaths,
 } from './utils/resourceEvaluation.js';
-import { collectException, hasException } from './utils/exceptions.js';
-import { collectAdoption, collectAndReturnViolation } from './utils/collectionUtils.js';
+import { hasException } from './utils/exceptions.js';
+import {
+  collectAdoption,
+  collectAndReturnViolation,
+  collectException,
+} from './utils/collectionUtils.js';
 
 const RULE_NAME = 'xgen-IPA-104-resource-has-GET';
 const ERROR_MESSAGE = 'APIs must provide a get method for resources.';

tools/spectral/ipa/rulesets/functions/singletonHasNoId.js

@@ -5,9 +5,13 @@ import {
   isCustomMethod,
   isSingletonResource,
 } from './utils/resourceEvaluation.js';
-import { collectException, hasException } from './utils/exceptions.js';
+import { hasException } from './utils/exceptions.js';
 import { getAllSuccessfulGetResponseSchemas } from './utils/methodUtils.js';
-import { collectAdoption, collectAndReturnViolation } from './utils/collectionUtils.js';
+import {
+  collectAdoption,
+  collectAndReturnViolation,
+  collectException,
+} from './utils/collectionUtils.js';
 
 const RULE_NAME = 'xgen-IPA-113-singleton-must-not-have-id';
 const ERROR_MESSAGE = 'Singleton resources must not have a user-provided or system-generated ID.';

tools/spectral/ipa/rulesets/functions/utils/collectionUtils.js

@@ -31,3 +31,18 @@ export function collectAndReturnViolation(path, ruleName, errorData) {
 export function collectAdoption(path, ruleName) {
   collector.add(EntryType.ADOPTION, path, ruleName);
 }
+
+/**
+ * Collects an exception entry.
+ *
+ * @param object the object to evaluate
+ * @param {string} path - The JSON path for the object where the rule exception occurred.
+ * @param {string} ruleName - The name of the rule that the exception is defined for.
+ */
+export function collectException(object, ruleName, path) {
+  const EXCEPTION_EXTENSION = 'x-xgen-IPA-exception';
+  let exceptionReason = object[EXCEPTION_EXTENSION][ruleName];
+  if (exceptionReason) {
+    collector.add(EntryType.EXCEPTION, path, ruleName, exceptionReason);
+  }
+}

tools/spectral/ipa/rulesets/functions/utils/exceptions.js

@@ -1,5 +1,3 @@
-import collector, { EntryType } from '../../../metrics/collector.js';
-
 const EXCEPTION_EXTENSION = 'x-xgen-IPA-exception';
 
 /**
@@ -15,17 +13,3 @@ export function hasException(object, ruleName) {
   }
   return false;
 }
-
-/**
- * Collects an exception entry.
- *
- * @param object the object to evaluate
- * @param {string} path - The JSON path for the object where the rule exception occurred.
- * @param {string} ruleName - The name of the rule that the exception is defined for.
- */
-export function collectException(object, ruleName, path) {
-  let exceptionReason = object[EXCEPTION_EXTENSION][ruleName];
-  if (exceptionReason) {
-    collector.add(EntryType.EXCEPTION, path, ruleName, exceptionReason);
-  }
-}