feat: Support must_include and must_exclude regex as an array (#575)

* Support must_include array on changeset

* Add changelog entry

* Add array support for `must_exclude`

* Fix wrong changelog entry for this branch

* Added documentation for must_exclude and must_include

* Add must_exclude array support for changeset

* Add string, array support to other validators

* Changelog reflect PR title

Author: bbugh

__tests__/unit/validators/changeset.test.js

@@ -18,6 +18,29 @@ test('validate returns correctly', async () => {
   expect(validation.status).toBe('fail')
 })
 
+test('supports arrays', async () => {
+  const changeset = new Changeset()
+  const settings = {
+    do: 'changeset',
+    must_include: {
+      regex: [
+        'a.js',
+        'b.js',
+        'c.md'
+      ]
+    }
+  }
+
+  let validation = await changeset.processValidate(createMockContext(['package-lock.json', 'yarn.lock', 'package.json', 'a.js']), settings)
+  expect(validation.status).toBe('pass')
+
+  validation = await changeset.processValidate(createMockContext(['package-lock.json', 'yarn.lock', 'package.json', 'b.js']), settings)
+  expect(validation.status).toBe('pass')
+
+  validation = await changeset.processValidate(createMockContext(['package-lock.json', 'yarn.lock', 'package.json']), settings)
+  expect(validation.status).toBe('fail')
+})
+
 test('fail gracefully if invalid regex', async () => {
   const changeset = new Changeset()
   const settings = {

__tests__/unit/validators/options_processor/options/must_exclude.test.js

@@ -56,3 +56,17 @@ test('that regex_flag works as expected', async () => {
   const res = mustExclude.process(validatorContext, input, rule)
   expect(res.status).toBe('pass')
 })
+
+test('return pass if input array meets the criteria', async () => {
+  const rule = { must_exclude: { regex: ['test', 'D'] } }
+  const input = ['A', 'B', 'C']
+  const res = mustExclude.process(validatorContext, input, rule)
+  expect(res.status).toBe('pass')
+})
+
+test('return fail if input array does not meet the criteria', async () => {
+  const rule = { must_exclude: { regex: ['^the', 'F', 'G'] } }
+  const input = ['A', 'B', 'the test']
+  const res = mustExclude.process(validatorContext, input, rule)
+  expect(res.status).toBe('fail')
+})

__tests__/unit/validators/options_processor/options/must_include.test.js

@@ -57,3 +57,18 @@ test('that regex_flag works as expected', async () => {
   const res = mustInclude.process(validatorContext, input, rule)
   expect(res.status).toBe('fail')
 })
+
+test('return pass if input array meets the criteria', async () => {
+  const rule = { must_include: { regex: ['^the\\stest$', 'nothing'] } }
+  const input = ['A', 'B', 'the test']
+  const res = mustInclude.process(validatorContext, input, rule)
+  expect(res.status).toBe('pass')
+})
+
+test('return fail if input array does not meet the criteria', async () => {
+  const rule = { must_include: { regex: ['test', 'another'], message: 'failed array Test' } }
+  const input = ['E', 'F']
+  const res = mustInclude.process(validatorContext, input, rule)
+  expect(res.status).toBe('fail')
+  expect(res.description).toBe('failed array Test')
+})

docs/changelog.rst

@@ -1,5 +1,6 @@
 CHANGELOG
 =====================================
+| August 6, 2021 : feat: Support must_include and must_exclude regex as an array `#575 <https://github.com/mergeability/mergeable/pull/575>`_
 | July 19, 2021 : feat: Add ignore_drafts option to ignore drafts in stale validator `#565 <https://github.com/mergeability/mergeable/issues/565>`_
 | July 12, 2021 : feat: Filter specific status of files in changeset `#550 <https://github.com/mergeability/mergeable/issues/550>`_
 | June 26, 2021 : feat: Add `payload` filter `#398 <https://github.com/mergeability/mergeable/issues/398>`_

docs/options/must_exclude.rst

@@ -11,6 +11,19 @@ MustExclude
         message: |
             Your pull request doesn't adhere to the branch naming convention described <a href="some link">there</a>!k
 
+You can also use an array of regex matchers. If any of them match, the validation will fail.
+
+::
+
+    - do: headRef
+      must_exclude:
+        regex:
+          - "^bug"
+          - "^breaking"
+          - "^test"
+        message: |
+            Your pull request doesn't adhere to the branch naming convention described <a href="some link">there</a>!k
+
 .. list-table:: Supported Params
    :widths: 25 50 25 25
    :header-rows: 1
@@ -20,9 +33,9 @@ MustExclude
      - Required
      - Default Message
    * - regex
-     - Regex enabled message to validate input with
+     - Regex or array enabled message to validate input with
      - Yes
-     - 
+     -
    * - message
      - Message to show if the validation fails
      - No

docs/options/must_include.rst

@@ -11,6 +11,19 @@ MustInclude
         message: |
             Your pull request doesn't adhere to the branch naming convention described <a href="some link">there</a>!k
 
+You can also use an array of regex matchers. If any of them match, the validation will pass.
+
+::
+
+    - do: headRef
+      must_include:
+        regex:
+          - "^feature"
+          - "^hotfix"
+          - "^fix"
+        message: |
+            Your pull request doesn't adhere to the branch naming convention described <a href="some link">there</a>!k
+
 .. list-table:: Supported Params
    :widths: 25 50 25 25
    :header-rows: 1
@@ -20,9 +33,9 @@ MustInclude
      - Required
      - Default Message
    * - regex
-     - Regex enabled message to validate input with
+     - Regex or array enabled message to validate input with
      - Yes
-     - 
+     -
    * - message
      - Message to show if the validation fails
      - No

lib/validators/baseRef.js

@@ -9,12 +9,12 @@ class BaseRef extends Validator {
     ]
     this.supportedSettings = {
       must_include: {
-        regex: 'string',
+        regex: ['string', 'array'],
         regex_flag: 'string',
         message: 'string'
       },
       must_exclude: {
-        regex: 'string',
+        regex: ['string', 'array'],
         regex_flag: 'string',
         message: 'string'
       }

lib/validators/changeset.js

@@ -13,12 +13,12 @@ class Changeset extends Validator {
         message: 'string'
       },
       must_include: {
-        regex: 'string',
+        regex: ['string', 'array'],
         regex_flag: 'string',
         message: 'string'
       },
       must_exclude: {
-        regex: 'string',
+        regex: ['string', 'array'],
         regex_flag: 'string',
         message: 'string'
       },

lib/validators/contents.js

@@ -19,12 +19,12 @@ class Contents extends Validator {
         ignore: 'array'
       },
       must_include: {
-        regex: 'string',
+        regex: ['string', 'array'],
         regex_flag: 'string',
         message: 'string'
       },
       must_exclude: {
-        regex: 'string',
+        regex: ['string', 'array'],
         regex_flag: 'string',
         message: 'string'
       },

lib/validators/description.js

@@ -19,12 +19,12 @@ class Description extends Validator {
         message: 'string'
       },
       must_include: {
-        regex: 'string',
+        regex: ['string', 'array'],
         regex_flag: 'string',
         message: 'string'
       },
       must_exclude: {
-        regex: 'string',
+        regex: ['string', 'array'],
         regex_flag: 'string',
         message: 'string'
       },