CPLAT-9308 Codemod Utility to tell if Something is Public API

lib/src/boilerplate_suggestors/advanced_props_and_state_class_migrator.dart

@@ -28,13 +28,19 @@ import 'boilerplate_utilities.dart';
 class AdvancedPropsAndStateClassMigrator extends GeneralizingAstVisitor
     with AstVisitingSuggestorMixin
     implements Suggestor {
+  final SemverHelper helper;
+
+  AdvancedPropsAndStateClassMigrator(this.helper);
+
   @override
   visitClassDeclaration(ClassDeclaration node) {
     super.visitClassDeclaration(node);
 
-    if (!shouldMigrateAdvancedPropsAndStateClass(node)) return;
+    if (!shouldMigrateAdvancedPropsAndStateClass(node, helper)) return;
   }
 }
 
-bool shouldMigrateAdvancedPropsAndStateClass(ClassDeclaration node) =>
-    shouldMigratePropsAndStateClass(node) && isAdvancedPropsOrStateClass(node);
+bool shouldMigrateAdvancedPropsAndStateClass(
+        ClassDeclaration node, SemverHelper helper) =>
+    shouldMigratePropsAndStateClass(node, helper) &&
+    isAdvancedPropsOrStateClass(node);

lib/src/boilerplate_suggestors/annotations_remover.dart

@@ -16,10 +16,16 @@ import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
 import 'package:codemod/codemod.dart';
 
+import 'boilerplate_utilities.dart';
+
 /// Suggestor that looks for @Props, @State, and @Component2 and removes them.
 class AnnotationsRemover extends GeneralizingAstVisitor
     with AstVisitingSuggestorMixin
     implements Suggestor {
+  final SemverHelper helper;
+
+  AnnotationsRemover(this.helper);
+
   @override
   visitAnnotatedNode(AnnotatedNode node) {
     super.visitAnnotatedNode(node);

lib/src/boilerplate_suggestors/boilerplate_utilities.dart

@@ -19,15 +19,12 @@ import 'package:over_react_codemod/src/util.dart';
 typedef void YieldPatch(
     int startingOffset, int endingOffset, String replacement);
 
-// Stub while <https://jira.atl.workiva.net/browse/CPLAT-9308> is in progress
-bool _isPublic(ClassDeclaration node) => false;
-
 /// Whether a props or state class class [node] should be migrated as part of the boilerplate codemod.
-bool shouldMigratePropsAndStateClass(ClassDeclaration node) {
+bool shouldMigratePropsAndStateClass(
+    ClassDeclaration node, SemverHelper helper) {
   return isAssociatedWithComponent2(node) &&
       isAPropsOrStateClass(node) &&
-      // Stub while <https://jira.atl.workiva.net/browse/CPLAT-9308> is in progress
-      !_isPublic(node);
+      helper.getPublicExportLocations(node) == null;
 }
 
 /// A simple RegExp against the parent of the class to verify it is `UiProps`
@@ -119,3 +116,29 @@ void migrateClassToMixin(ClassDeclaration node, YieldPatch yieldPatch,
   propsAndStateClassNamesConvertedToNewBoilerplate[originalPublicClassName] =
       newMixinName;
 }
+
+class SemverHelper {
+  Map _exportList;
+
+  SemverHelper(Map jsonReport) {
+    _exportList = jsonReport['exports'];
+  }
+
+  /// Returns semver report information for [node] if it is publicly exported.
+  ///
+  /// If [node] is not publicly exported, returns `null`.
+  Map<String, dynamic> getPublicExportLocations(ClassDeclaration node) {
+    final className = node?.name?.name;
+    String classKey;
+
+    if (className == null || _exportList == null) return null;
+
+    _exportList.forEach((key, value) {
+      if (value['type'] == 'class' && value['grammar']['name'] == className) {
+        classKey = key;
+      }
+    });
+
+    return _exportList[classKey];
+  }
+}

lib/src/boilerplate_suggestors/props_mixins_migrator.dart

@@ -15,11 +15,16 @@
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
 import 'package:codemod/codemod.dart';
+import 'package:over_react_codemod/src/boilerplate_suggestors/boilerplate_utilities.dart';
 
 /// Suggestor that updates stand alone props mixins to be actual mixins.
 class PropsMixinMigrator extends GeneralizingAstVisitor
     with AstVisitingSuggestorMixin
     implements Suggestor {
+  final SemverHelper helper;
+
+  PropsMixinMigrator(this.helper);
+
   @override
   visitClassDeclaration(ClassDeclaration node) {
     super.visitClassDeclaration(node);

lib/src/boilerplate_suggestors/simple_props_and_state_class_migrator.dart

@@ -16,7 +16,6 @@ import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/dart/ast/visitor.dart';
 import 'package:codemod/codemod.dart';
 
-import '../util.dart';
 import 'boilerplate_utilities.dart';
 
 /// Suggestor that updates props and state classes to new boilerplate.
@@ -29,15 +28,21 @@ import 'boilerplate_utilities.dart';
 class SimplePropsAndStateClassMigrator extends GeneralizingAstVisitor
     with AstVisitingSuggestorMixin
     implements Suggestor {
+  final SemverHelper helper;
+
+  SimplePropsAndStateClassMigrator(this.helper);
+
   @override
   visitClassDeclaration(ClassDeclaration node) {
     super.visitClassDeclaration(node);
 
-    if (!shouldMigrateSimplePropsAndStateClass(node)) return;
+    if (!shouldMigrateSimplePropsAndStateClass(node, helper)) return;
 
     migrateClassToMixin(node, yieldPatch);
   }
 }
 
-bool shouldMigrateSimplePropsAndStateClass(ClassDeclaration node) =>
-    shouldMigratePropsAndStateClass(node) && isSimplePropsOrStateClass(node);
+bool shouldMigrateSimplePropsAndStateClass(
+        ClassDeclaration node, SemverHelper helper) =>
+    shouldMigratePropsAndStateClass(node, helper) &&
+    isSimplePropsOrStateClass(node);

lib/src/boilerplate_suggestors/stubbed_props_and_state_class_remover.dart

@@ -18,15 +18,21 @@ import 'package:over_react_codemod/src/boilerplate_suggestors/advanced_props_and
 import 'package:over_react_codemod/src/boilerplate_suggestors/simple_props_and_state_class_migrator.dart';
 import 'package:over_react_codemod/src/dart2_suggestors/props_and_state_companion_class_remover.dart';
 
+import 'boilerplate_utilities.dart';
+
 /// Suggestor that removes every companion class for props and state classes, as
 /// they were only temporarily required for backwards-compatibility with Dart 1.
 class StubbedPropsAndStateClassRemover
     extends PropsAndStateCompanionClassRemover implements Suggestor {
+  final SemverHelper helper;
+
+  StubbedPropsAndStateClassRemover(this.helper);
+
   @override
   bool shouldRemoveCompanionClassFor(
       ClassDeclaration candidate, CompilationUnit node) {
     return super.shouldRemoveCompanionClassFor(candidate, node) &&
-        (shouldMigrateSimplePropsAndStateClass(candidate) ||
-            shouldMigrateAdvancedPropsAndStateClass(candidate));
+        (shouldMigrateSimplePropsAndStateClass(candidate, helper) ||
+            shouldMigrateAdvancedPropsAndStateClass(candidate, helper));
   }
 }

lib/src/executables/boilerplate_upgrade.dart

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import 'dart:convert';
 import 'dart:io';
 
 import 'package:codemod/codemod.dart';
@@ -21,6 +22,7 @@ import 'package:over_react_codemod/src/boilerplate_suggestors/simple_props_and_s
 import 'package:over_react_codemod/src/boilerplate_suggestors/advanced_props_and_state_class_migrator.dart';
 import 'package:over_react_codemod/src/boilerplate_suggestors/props_mixins_migrator.dart';
 import 'package:over_react_codemod/src/boilerplate_suggestors/stubbed_props_and_state_class_remover.dart';
+import 'package:over_react_codemod/src/boilerplate_suggestors/boilerplate_utilities.dart';
 import 'package:over_react_codemod/src/ignoreable.dart';
 
 const _changesRequiredOutput = """
@@ -31,14 +33,18 @@ const _changesRequiredOutput = """
   Then, review the the changes, address any FIXMEs, and commit.
 """;
 
-void main(List<String> args) {
+Future<void> main(List<String> args) async {
   final query = FileQuery.dir(
     pathFilter: (path) {
       return isDartFile(path) && !isGeneratedDartFile(path);
     },
     recursive: true,
   );
 
+  // TODO: determine file path of semver report
+  SemverHelper helper = SemverHelper(jsonDecode(
+      await File('lib/src/boilerplate_suggestors/report.json').readAsString()));
+
   // General plan:
   //  - Things that need to be accomplished (very simplified)
   //    1. Make props / state class a mixin
@@ -75,15 +81,16 @@ void main(List<String> args) {
   //      - If this is needed, it can be used for suggestors 3 and 4
   //
   //
+
   exitCode = runInteractiveCodemodSequence(
     query,
     <Suggestor>[
-      StubbedPropsAndStateClassRemover(),
-      SimplePropsAndStateClassMigrator(),
-      AdvancedPropsAndStateClassMigrator(),
-      PropsMixinMigrator(),
+      StubbedPropsAndStateClassRemover(helper),
+      SimplePropsAndStateClassMigrator(helper),
+      AdvancedPropsAndStateClassMigrator(helper),
+      PropsMixinMigrator(helper),
       PropsMetaMigrator(),
-      AnnotationsRemover(),
+      AnnotationsRemover(helper),
     ].map((s) => Ignoreable(s)),
     args: args,
     defaultYes: true,

test/boilerplate_suggestors/boilerplate_utilities_test.dart

@@ -267,5 +267,116 @@ main() {
         });
       });
     });
+
+    group('getPublicExportLocations()', () {
+      SemverHelper helper;
+
+      group('returns null', () {
+        test('if there is no exports list', () {
+          helper = SemverHelper({'someOtherInfo': 'abc'});
+
+          getPublicExportLocationsTestHelper(
+            helper,
+            input: '''
+              @Props()
+              class _\$FooProps extends UiProps{
+                String foo;
+                int bar;
+              }
+            ''',
+            expectedResult: null,
+          );
+        });
+
+        test('if props class is not in export list', () {
+          helper = SemverHelper({
+            'exports': {
+              'lib/web_skin_dart.dart/ButtonProps': {
+                'type': 'class',
+                'grammar': {
+                  'name': 'ButtonProps',
+                  'meta': ['@Props()']
+                }
+              }
+            }
+          });
+
+          getPublicExportLocationsTestHelper(
+            helper,
+            input: '''
+              @Props()
+              class _\$FooProps extends UiProps{
+                String foo;
+                int bar;
+              }
+            ''',
+            expectedResult: null,
+          );
+        });
+      });
+
+      test('returns correct information if props class is in export list', () {
+        helper = SemverHelper({
+          "exports": {
+            "lib/web_skin_dart.dart/ButtonProps": {
+              "type": "class",
+              "grammar": {
+                "name": "ButtonProps",
+                "meta": ["@Props()"]
+              }
+            },
+            "lib/web_skin_dart.dart/FooProps": {
+              "type": "class",
+              "grammar": {
+                "name": "FooProps",
+                "meta": ["@Props()"]
+              }
+            },
+            "lib/web_skin_dart.dart/BarProps": {
+              "type": "class",
+              "grammar": {
+                "name": "BarProps",
+                "meta": ["@Props()"]
+              }
+            },
+            "lib/web_skin_dart.dart/DropdownSelectProps": {
+              "type": "class",
+              "grammar": {
+                "name": "DropdownSelectProps",
+                "meta": ["@Props()"]
+              }
+            }
+          }
+        });
+
+        getPublicExportLocationsTestHelper(
+          helper,
+          input: '''
+            @Props()
+            class DropdownSelectProps extends UiProps{
+              String foo;
+              int bar;
+            }
+          ''',
+          expectedResult: {
+            "type": "class",
+            "grammar": {
+              "name": "DropdownSelectProps",
+              "meta": ["@Props()"]
+            }
+          },
+        );
+      });
+    });
+  });
+}
+
+void getPublicExportLocationsTestHelper(SemverHelper helper,
+    {String input, Map expectedResult}) {
+  CompilationUnit unit = parseString(content: input).unit;
+  expect(unit.declarations.whereType<ClassDeclaration>().length, 1);
+
+  unit.declarations.whereType<ClassDeclaration>().forEach((classNode) {
+    expect(helper.getPublicExportLocations(classNode), expectedResult);
   });
 }

test/boilerplate_suggestors/report.json

@@ -0,0 +1,18 @@
+{
+  "exports": {
+    "lib/web_skin_dart.dart/ButtonProps": {
+      "type": "class",
+      "grammar": {
+        "name": "ButtonProps",
+        "meta": ["@Props()"]
+      }
+    },
+    "lib/web_skin_dart.dart/BarProps": {
+      "type": "class",
+      "grammar": {
+        "name": "BarProps",
+        "meta": ["@Props()"]
+      }
+    }
+  }
+}