Merge pull request #72 from andreaselia/feature/custom-rule-support

Fix custom rule usage

Author: tomirons

.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Dependencies
+        run: php /usr/bin/composer install -q --no-ansi --no-interaction --no-scripts --no-suggest --no-progress --prefer-dist
+      - name: Execute tests via PHPUnit
+        run: php vendor/bin/phpunit --stop-on-failure

composer.json

@@ -45,6 +45,7 @@
     "minimum-stability": "dev",
     "prefer-stable": true,
     "require-dev": {
-        "orchestra/testbench": "^6.12"
+        "orchestra/testbench": "^6.12",
+        "phpunit/phpunit": "^9.5"
     }
 }

src/Commands/ExportPostmanCommand.php

@@ -310,7 +310,6 @@ public function makeRequest($route, $method, $routeHeaders, $requestRules)
      */
     protected function parseRulesIntoHumanReadable($attribute, $rules): string
     {
-
         // ... bail if user has asked for non interpreted strings:
         if (! $this->config['rules_to_human_readable']) {
             return is_array($rules) ? implode(', ', $rules) : $this->safelyStringifyClassBasedRule($rules);
@@ -433,10 +432,10 @@ protected function handleEdgeCases(array $messages): array
      */
     protected function safelyStringifyClassBasedRule($probableRule): string
     {
-        if (is_object($probableRule) && (is_subclass_of($probableRule, Rule::class) || method_exists($probableRule, '__toString'))) {
-            return (string) $probableRule;
+        if (!is_object($probableRule) || is_subclass_of($probableRule, Rule::class) || !method_exists($probableRule, '__toString')) {
+            return '';
         }
 
-        return '';
+        return (string) $probableRule;
     }
 }

tests/Feature/ExportPostmanTest.php

@@ -190,7 +190,7 @@ public function test_rules_printing_export_to_human_readable_works()
         $this->assertCount(1, $fields->where('key', 'field_2')->where('description', 'The field 2 field is required., The field 2 must be an integer.'));
         $this->assertCount(1, $fields->where('key', 'field_3')->where('description', '(Optional), The field 3 must be an integer.'));
         $this->assertCount(1, $fields->where('key', 'field_4')->where('description', '(Nullable), The field 4 must be an integer.'));
-        $this->assertCount(1, $fields->where('key', 'field_5')->where('description', 'The field 5 field is required., The field 5 must be an integer., The field 5 may not be greater than 30., The field 5 must be at least 1.'));
+        $this->assertCount(1, $fields->where('key', 'field_5')->where('description', 'The field 5 field is required., The field 5 must be an integer., The field 5 must not be greater than 30., The field 5 must be at least 1.'));
 
         /** This looks bad, but this is the default message in lang/en/validation.php, you can update to:.
          *

tests/Fixtures/ExampleFormRequest.php

@@ -16,6 +16,7 @@ public function rules(): array
             'field_4' => 'nullable|integer',
             'field_5' => 'required|integer|max:30|min:1',
             'field_6' => new In([1, 2, 3]),
+            'field_7' => new UppercaseRule,
         ];
     }
 }

tests/Fixtures/UppercaseRule.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace AndreasElia\PostmanGenerator\Tests\Fixtures;
+
+use Illuminate\Contracts\Validation\Rule;
+
+class UppercaseRule implements Rule
+{
+    /**
+     * Determine if the validation rule passes.
+     *
+     * @param  string  $attribute
+     * @param  mixed  $value
+     * @return bool
+     */
+    public function passes($attribute, $value)
+    {
+        return strtoupper($value) === $value;
+    }
+
+    /**
+     * Get the validation error message.
+     *
+     * @return string
+     */
+    public function message()
+    {
+        return 'The :attribute must be uppercase.';
+    }
+}