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

lib/src/boilerplate_suggestors/boilerplate_utilities.dart

@@ -20,11 +20,40 @@ import 'package:over_react_codemod/src/util.dart';
 typedef YieldPatch = void Function(
     int startingOffset, int endingOffset, String replacement);
 
-@visibleForTesting
-bool isPublicForTest = false;
+SemverHelper semverHelper;
 
-// Stub while <https://jira.atl.workiva.net/browse/CPLAT-9308> is in progress
-bool isPublic(ClassDeclaration node) => isPublicForTest;
+/// Returns whether or not [node] is publicly exported.
+bool isPublic(ClassDeclaration node) {
+  assert(semverHelper != null);
+  return semverHelper.getPublicExportLocations(node) != null;
+}
+
+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) {
+    assert(_exportList != null);
+
+    final className = node.name.name;
+
+    for (final key in _exportList.keys) {
+      final value = _exportList[key];
+
+      if (value['type'] == 'class' && value['grammar']['name'] == className) {
+        return value;
+      }
+    }
+
+    return null;
+  }
+}
 
 /// Returns the annotation node associated with the provided [classNode]
 /// that matches the provided [annotationName], if one exists.
@@ -57,7 +86,6 @@ bool shouldMigratePropsAndStateMixin(ClassDeclaration classNode) =>
 bool shouldMigratePropsAndStateClass(ClassDeclaration node) {
   return isAssociatedWithComponent2(node) &&
       isAPropsOrStateClass(node) &&
-      // Stub while <https://jira.atl.workiva.net/browse/CPLAT-9308> is in progress
       !isPublic(node);
 }
 

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';
@@ -32,7 +33,7 @@ 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);
@@ -42,6 +43,10 @@ void main(List<String> args) {
 
   final classToMixinConverter = ClassToMixinConverter();
 
+  // TODO: determine file path of semver report
+  semverHelper = 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

test/boilerplate_suggestors/boilerplate_utilities_test.dart

@@ -267,5 +267,96 @@ main() {
         });
       });
     });
+
+    group('isPublic() and getPublicExportLocations()', () {
+      test('if props class is not in export list', () {
+        semverHelper = SemverHelper({
+          'exports': {
+            'lib/web_skin_dart.dart/ButtonProps': {
+              'type': 'class',
+              'grammar': {
+                'name': 'ButtonProps',
+                'meta': ['@Props()']
+              }
+            }
+          }
+        });
+
+        final input = '''
+          @Props()
+          class _\$FooProps extends UiProps{
+            String foo;
+            int bar;
+          }
+        ''';
+
+        CompilationUnit unit = parseString(content: input).unit;
+        expect(unit.declarations.whereType<ClassDeclaration>().length, 1);
+
+        unit.declarations.whereType<ClassDeclaration>().forEach((classNode) {
+          expect(semverHelper.getPublicExportLocations(classNode), null);
+          expect(isPublic(classNode), false);
+        });
+      });
+    });
+
+    test('if props class is in export list', () {
+      semverHelper = 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()"]
+            }
+          }
+        }
+      });
+
+      final input = '''
+        @Props()
+        class DropdownSelectProps extends UiProps{
+          String foo;
+          int bar;
+        }
+      ''';
+      final expectedResult = {
+        "type": "class",
+        "grammar": {
+          "name": "DropdownSelectProps",
+          "meta": ["@Props()"]
+        }
+      };
+
+      CompilationUnit unit = parseString(content: input).unit;
+      expect(unit.declarations.whereType<ClassDeclaration>().length, 1);
+
+      unit.declarations.whereType<ClassDeclaration>().forEach((classNode) {
+        expect(
+            semverHelper.getPublicExportLocations(classNode), expectedResult);
+        expect(isPublic(classNode), true);
+      });
+    });
   });
 }

test/boilerplate_suggestors/props_mixin_migrator_test.dart

@@ -12,6 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import 'dart:convert';
+import 'dart:io';
+
 import 'package:over_react_codemod/src/boilerplate_suggestors/boilerplate_utilities.dart';
 import 'package:over_react_codemod/src/boilerplate_suggestors/props_mixins_migrator.dart';
 import 'package:test/test.dart';
@@ -23,6 +26,12 @@ main() {
     final converter = ClassToMixinConverter();
     final testSuggestor = getSuggestorTester(PropsMixinMigrator(converter));
 
+    setUpAll(() async {
+      semverHelper = SemverHelper(jsonDecode(
+          await File('test/boilerplate_suggestors/report.json')
+              .readAsString()));
+    });
+
     tearDown(() {
       converter.setConvertedClassNames({});
     });
@@ -297,33 +306,28 @@ main() {
         });
 
         test('is deprecated if the class is part of the public API', () {
-          addTearDown(() {
-            isPublicForTest = false;
-          });
-          isPublicForTest = true;
-
           testSuggestor(
             expectedPatchCount: 5,
             input: '''
             /// Some doc comment
             @${typeStr}Mixin()
-            abstract class Foo${typeStr}Mixin implements Ui${typeStr} {
+            abstract class Bar${typeStr}Mixin implements Ui${typeStr} {
               // To ensure the codemod regression checking works properly, please keep this
               // field at the top of the class!
               // ignore: undefined_identifier, undefined_class, const_initialized_with_non_constant_value
-              static const ${typeStr}Meta meta = _\$metaForFoo${typeStr}Mixin;
+              static const ${typeStr}Meta meta = _\$metaForBar${typeStr}Mixin;
 
               String foo;
             }
           ''',
             expectedOutput: '''
             /// Some doc comment
-            mixin Foo${typeStr}Mixin on Ui${typeStr} {
+            mixin Bar${typeStr}Mixin on Ui${typeStr} {
               // To ensure the codemod regression checking works properly, please keep this
               // field at the top of the class!
               // ignore: undefined_identifier, undefined_class, const_initialized_with_non_constant_value
-              @Deprecated('Use `propsMeta.forMixin(Foo${typeStr}Mixin)` instead.')
-              static const ${typeStr}Meta meta = _\$metaForFoo${typeStr}Mixin;
+              @Deprecated('Use `propsMeta.forMixin(Bar${typeStr}Mixin)` instead.')
+              static const ${typeStr}Meta meta = _\$metaForBar${typeStr}Mixin;
 
               String foo;
             }

test/boilerplate_suggestors/report.json

@@ -0,0 +1,32 @@
+{
+  "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()"]
+      }
+    },
+    "lib/web_skin_dart.dart/BarPropsMixin": {
+      "type": "class",
+      "grammar": {
+        "name": "BarPropsMixin",
+        "meta": ["@Props()"]
+      }
+    },
+    "lib/web_skin_dart.dart/BarStateMixin": {
+      "type": "class",
+      "grammar": {
+        "name": "BarStateMixin",
+        "meta": ["@Props()"]
+      }
+    }
+  }
+}

test/boilerplate_suggestors/simple_props_and_state_class_migrator_test.dart

@@ -12,6 +12,9 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import 'dart:convert';
+import 'dart:io';
+
 import 'package:over_react_codemod/src/boilerplate_suggestors/boilerplate_utilities.dart';
 import 'package:over_react_codemod/src/boilerplate_suggestors/simple_props_and_state_class_migrator.dart';
 import 'package:test/test.dart';
@@ -24,6 +27,12 @@ main() {
     final testSuggestor =
         getSuggestorTester(SimplePropsAndStateClassMigrator(converter));
 
+    setUpAll(() async {
+      semverHelper = SemverHelper(jsonDecode(
+          await File('test/boilerplate_suggestors/report.json')
+              .readAsString()));
+    });
+
     tearDown(() {
       converter.setConvertedClassNames({});
     });
@@ -116,7 +125,36 @@ main() {
         expect(converter.convertedClassNames, isEmpty);
       });
 
-      // TODO add a test for when the class is publicly exported
+      test('when the props class is publicly exported', () {
+        testSuggestor(
+          expectedPatchCount: 0,
+          input: '''
+            @Factory()
+            UiFactory<BarProps> Bar =
+                // ignore: undefined_identifier
+                \$Bar;
+
+            @Props()
+            class BarProps extends UiProps {
+              String foo;
+              int bar;
+            }
+
+            @Component2()
+            class BarComponent extends UiComponent2<BarProps> {
+              @override
+              render() {
+                return Dom.ul()(
+                  Dom.li()('Foo: ', props.foo),
+                  Dom.li()('Bar: ', props.bar),
+                );
+              }
+            }
+          ''',
+        );
+
+        expect(converter.convertedClassNames, isEmpty);
+      });
 
       group('the classes are not simple', () {
         test('and there are both a props and a state class', () {

test/boilerplate_suggestors/stubbed_props_and_state_class_remover_test.dart

@@ -12,6 +12,10 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+import 'dart:convert';
+import 'dart:io';
+
+import 'package:over_react_codemod/src/boilerplate_suggestors/boilerplate_utilities.dart';
 import 'package:over_react_codemod/src/boilerplate_suggestors/stubbed_props_and_state_class_remover.dart';
 import 'package:test/test.dart';
 
@@ -23,6 +27,12 @@ main() {
       StubbedPropsAndStateClassRemover(),
     );
 
+    setUpAll(() async {
+      semverHelper = SemverHelper(jsonDecode(
+          await File('test/boilerplate_suggestors/report.json')
+              .readAsString()));
+    });
+
     group('does not perform a migration', () {
       test('when it encounters an empty file', () {
         testSuggestor(expectedPatchCount: 0, input: '');
@@ -84,7 +94,39 @@ main() {
       });
 
       test('when the stubbed "companion" class(es) are publicly exported', () {
-        // TODO add a test for when the class is publicly exported
+        testSuggestor(
+          expectedPatchCount: 0,
+          input: '''
+          @Factory()
+          UiFactory<BarProps> Bar =
+              // ignore: undefined_identifier
+              \$Bar;
+
+          @Props()
+          class _\$_BarProps extends UiProps {
+            String foo;
+            int bar;
+          }
+
+          @Component2()
+          class BarComponent extends UiComponent2<BarProps> {
+            @override
+            render() {
+              return Dom.ul()(
+                Dom.li()('Foo: ', props.foo),
+                Dom.li()('Bar: ', props.bar),
+              );
+            }
+          }
+
+          // AF-3369 This will be removed once the transition to Dart 2 is complete.
+          // ignore: mixin_of_non_class, undefined_class
+          class BarProps extends _\$_BarProps with _\$_BarPropsAccessorsMixin {
+            // ignore: undefined_identifier, undefined_class, const_initialized_with_non_constant_value
+            static const PropsMeta meta = _\$metaFor_BarProps;
+          }
+        ''',
+        );
       });
     });