CHANGELOG.md

@@ -1,3 +1,23 @@
+# 2.5.0
+
+_Towards a uniform way to constrain arbitraries - step 2: remaining arbitraries except number related ones_
+[[Code](https://github.com/dubzzz/fast-check/tree/v2.5.0)][[Diff](https://github.com/dubzzz/fast-check/compare/v2.4.0...v2.5.0)]
+
+## Features
+
+- ([PR#1023](https://github.com/dubzzz/fast-check/pull/1023)) Unify signatures on arbitraries: fc.\*\[jJ\]son\* (see [#992](https://github.com/dubzzz/fast-check/issues/992))
+- ([PR#1026](https://github.com/dubzzz/fast-check/pull/1026)) Unify signatures on arbitraries: fc.lorem (see [#992](https://github.com/dubzzz/fast-check/issues/992))
+- ([PR#1063](https://github.com/dubzzz/fast-check/pull/1063)) Rename fc.dedup into fc.clone (older name has been deprecated for the moment)
+- ([PR#1065](https://github.com/dubzzz/fast-check/pull/1065)) Add withDate option on fc.object
+
+## Fixes
+
+- ([PR#1022](https://github.com/dubzzz/fast-check/pull/1022)) Tool: Script udate:examples should not fail on updates
+- ([PR#1024](https://github.com/dubzzz/fast-check/pull/1024)) Doc: Support fc.option in codemod for [#992](https://github.com/dubzzz/fast-check/issues/992)
+- ([PR#1025](https://github.com/dubzzz/fast-check/pull/1025)) Doc: Support fc.commands in codemod for [#992](https://github.com/dubzzz/fast-check/issues/992)
+
+---
+
 # 2.4.0
 
 _Towards a uniform way to constrain arbitraries - step 1: array-like arbitraries_

codemods/unify-signatures/snippet-5.js

@@ -37,3 +37,36 @@ fc.shuffledSubarray([1, 2, 3]);
 fc.shuffledSubarray([1, 2, 3], 1, 2);
 fc.shuffledSubarray(myArray, 1, 2);
 fc.shuffledSubarray(computeArray(), 1, 2);
+
+// json
+
+fc.json();
+fc.json(2);
+fc.json(10);
+fc.json({ maxDepth: 10 });
+
+// option
+
+fc.option(fc.nat());
+fc.option(fc.nat(), 10);
+fc.option(fc.nat(), { freq: 10, nil: null });
+
+// option
+
+fc.commands([]);
+fc.commands([], 10);
+fc.commands([], 50);
+fc.commands([], { maxCommands: 50 });
+
+// lorem
+
+fc.lorem();
+fc.lorem(5);
+fc.lorem(10);
+fc.lorem(num);
+fc.lorem(5, true);
+fc.lorem(10, true);
+fc.lorem(10, false);
+fc.lorem(10, something);
+fc.lorem(num, something);
+fc.lorem({ maxCount: 10 });

codemods/unify-signatures/transform.cjs

@@ -4,6 +4,10 @@
 // Or against the codebase of fast-check itself:
 //    npx jscodeshift --parser=ts --extensions=ts -t transform.cjs ../../example/ ../../src/ ../../test/ --local=true --debug=true --simplifyMin=true --simplifyMax=true
 
+// Useful ressources:
+// - https://astexplorer.net/
+// - https://npmdoc.github.io/node-npmdoc-jscodeshift/build/apidoc.html
+
 /**
  * Find any imports related to fast-check
  * either module as a whole or named imports
@@ -138,7 +142,11 @@ module.exports = function (file, api, options) {
   }
   function isNumeric(argument) {
     // 0              -- Default parser: Literal / TS parser: NumericLiteral
-    return argument.type === 'Literal' || argument.type === 'NumericLiteral';
+    return (argument.type === 'Literal' || argument.type === 'NumericLiteral') && typeof argument.value === 'number';
+  }
+  function isBoolean(argument) {
+    // true           -- Default parser: Literal / TS parser: BooleanLiteral
+    return (argument.type === 'Literal' || argument.type === 'BooleanLiteral') && typeof argument.value === 'boolean';
   }
   function isArray(argument) {
     // [1, 2, 3]      -- Default & TS parser: ArrayExpression
@@ -280,6 +288,67 @@ module.exports = function (file, api, options) {
           }
           break;
         }
+        case 'json':
+        case 'unicodeJson':
+        case 'jsonObject':
+        case 'unicodeJsonObject': {
+          if (p.value.arguments.length === 1 && p.value.arguments[0].type !== 'ObjectExpression') {
+            // fc.json(10) -> fc.json({maxDepth})
+            const simplifyMax = options.simplifyMax && isNumericValue(p.value.arguments[0], 2);
+            p.value.arguments = computeNewArguments(
+              [],
+              [!simplifyMax && j.property('init', j.identifier('maxDepth'), p.value.arguments[0])]
+            );
+          }
+          break;
+        }
+        case 'option': {
+          if (p.value.arguments.length === 2 && p.value.arguments[1].type !== 'ObjectExpression') {
+            // fc.option(arb, 10) -> fc.option(arb, {freq})
+            p.value.arguments = computeNewArguments(
+              [p.value.arguments[0]],
+              [j.property('init', j.identifier('freq'), p.value.arguments[1])]
+            );
+          }
+          break;
+        }
+        case 'commands': {
+          if (p.value.arguments.length === 2 && p.value.arguments[1].type !== 'ObjectExpression') {
+            // fc.commands(commandArbs, maxCommands) -> fc.commands(commandArbs, {maxCommands})
+            const simplifyMax = options.simplifyMax && isNumericValue(p.value.arguments[1], 10);
+            p.value.arguments = computeNewArguments(
+              [p.value.arguments[0]],
+              [!simplifyMax && j.property('init', j.identifier('maxCommands'), p.value.arguments[1])]
+            );
+          }
+          break;
+        }
+        case 'lorem': {
+          if (p.value.arguments.length === 1 && p.value.arguments[0].type !== 'ObjectExpression') {
+            // fc.lorem(maxWordsCount) -> fc.lorem({maxCount})
+            const simplifyMax = options.simplifyMax && isNumericValue(p.value.arguments[0], 5);
+            p.value.arguments = computeNewArguments(
+              [],
+              [!simplifyMax && j.property('init', j.identifier('maxCount'), p.value.arguments[0])]
+            );
+          } else if (p.value.arguments.length === 2) {
+            // fc.lorem(maxWordsCount, sentencesMode) -> fc.lorem({maxCount, mode})
+            const simplifyMax = options.simplifyMax && isNumericValue(p.value.arguments[0], 5);
+            const mode = isBoolean(p.value.arguments[1])
+              ? p.value.arguments[1].value === true
+                ? j.literal('sentences')
+                : j.literal('words')
+              : j.conditionalExpression(p.value.arguments[1], j.literal('sentences'), j.literal('words'));
+            p.value.arguments = computeNewArguments(
+              [],
+              [
+                !simplifyMax && j.property('init', j.identifier('maxCount'), p.value.arguments[0]),
+                j.property('init', j.identifier('mode'), mode),
+              ]
+            );
+          }
+          break;
+        }
       }
       return p;
     })