Rename *Golden to *File (kevmoo#31)

alexeyinkin · Jan 21, 2023 · e0e5959 · e0e5959
1 parent 4e2f155
commit e0e5959
Show file tree

Hide file tree

Showing 14 changed files with 51 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -23,12 +23,12 @@ const TestClass1NameLowerCase = 'testclass1';
 class TestClass1 {}
 ```
 
-Test against a golden output if you also want to write tests on the output itself.
+Test against a golden output file if you also want to write tests on the output itself.
 
 ```dart
 part 'goldens/testclass2.dart';
 
-@ShouldGenerateGolden(
+@ShouldGenerateFile(
   'goldens/testclass2.dart',
   partOfCurrent: true,
   configurations: ['default', 'no-prefix-required'],

diff --git a/lib/annotations.dart b/lib/annotations.dart
@@ -2,4 +2,4 @@
 library source_gen_test.annotations;
 
 export 'src/annotations.dart'
-    show ShouldGenerate, ShouldGenerateGolden, ShouldThrow;
+    show ShouldGenerate, ShouldGenerateFile, ShouldThrow;
diff --git a/lib/src/annotations.dart b/lib/src/annotations.dart
@@ -63,13 +63,13 @@ class ShouldGenerate extends TestExpectation {
 /// To update a golden, the directory for its file must exist.
 ///
 /// Must be used with [testAnnotatedElements].
-class ShouldGenerateGolden extends TestExpectation {
+class ShouldGenerateFile extends TestExpectation {
   final String expectedOutputFileName;
   final bool contains;
   final String? partOf;
   final bool partOfCurrent;
 
-  const ShouldGenerateGolden(
+  const ShouldGenerateFile(
     this.expectedOutputFileName, {
     this.contains = false,
     this.partOf,
@@ -84,7 +84,7 @@ class ShouldGenerateGolden extends TestExpectation {
 
   @override
   TestExpectation replaceConfiguration(Iterable<String> newConfiguration) =>
-      ShouldGenerateGolden(
+      ShouldGenerateFile(
         expectedOutputFileName,
         contains: contains,
         partOf: partOf,

diff --git a/lib/src/expectation_element.dart b/lib/src/expectation_element.dart
@@ -65,7 +65,7 @@ List<ExpectationElement> genAnnotatedElements(
 
 const _mappers = {
   TypeChecker.fromRuntime(ShouldGenerate): _shouldGenerate,
-  TypeChecker.fromRuntime(ShouldGenerateGolden): _shouldGenerateGolden,
+  TypeChecker.fromRuntime(ShouldGenerateFile): _shouldGenerateFile,
   TypeChecker.fromRuntime(ShouldThrow): _shouldThrow,
 };
 
@@ -95,11 +95,11 @@ ShouldGenerate _shouldGenerate(DartObject obj) {
   );
 }
 
-ShouldGenerateGolden _shouldGenerateGolden(DartObject obj) {
+ShouldGenerateFile _shouldGenerateFile(DartObject obj) {
   final reader = ConstantReader(obj);
   final partOf = reader.read('partOf');
   final partOfCurrent = reader.read('partOfCurrent');
-  return ShouldGenerateGolden(
+  return ShouldGenerateFile(
     reader.read('expectedOutputFileName').stringValue,
     contains: reader.read('contains').boolValue,
     partOf: partOf.isString ? partOf.stringValue : null,

diff --git a/lib/src/test_annotated_classes.dart b/lib/src/test_annotated_classes.dart
@@ -230,8 +230,8 @@ class AnnotatedTest<T> {
     if (expectation is ShouldGenerate) {
       test(_testName, _shouldGenerateTest);
       return;
-    } else if (expectation is ShouldGenerateGolden) {
-      test(_testName, _shouldGenerateGoldenTest);
+    } else if (expectation is ShouldGenerateFile) {
+      test(_testName, _shouldGenerateFileTest);
       return;
     } else if (expectation is ShouldThrow) {
       test(_testName, _shouldThrowTest);
@@ -267,9 +267,9 @@ class AnnotatedTest<T> {
     clearBuildLog();
   }
 
-  Future<void> _shouldGenerateGoldenTest() async {
+  Future<void> _shouldGenerateFileTest() async {
     final output = await _generate();
-    final exp = expectation as ShouldGenerateGolden;
+    final exp = expectation as ShouldGenerateFile;
 
     if (_libraryReader is! PathAwareLibraryReader) {
       throw TestFailure(
@@ -281,7 +281,7 @@ class AnnotatedTest<T> {
 
     final reader = _libraryReader as PathAwareLibraryReader;
     final path = p.join(reader.directory, exp.expectedOutputFileName);
-    final testOutput = _padOutputForGolden(output);
+    final testOutput = _padOutputForFile(output);
 
     try {
       if (Platform.environment[_updateGoldensVariable] == '1') {
@@ -319,8 +319,8 @@ class AnnotatedTest<T> {
     clearBuildLog();
   }
 
-  String _padOutputForGolden(String output) {
-    final exp = expectation as ShouldGenerateGolden;
+  String _padOutputForFile(String output) {
+    final exp = expectation as ShouldGenerateFile;
 
     if (exp.partOf != null) {
       return "part of '${exp.partOf}';\n\n$output";

diff --git a/test/generate_for_element_test.dart b/test/generate_for_element_test.dart
@@ -127,12 +127,12 @@ const TestClass2NameLowerCase = 'testclass2';
       'TestClass1',
       'TestClass2',
       'TestClass2',
-      'TestClassGoldenNoPart',
-      'TestClassGoldenNoPart',
-      'TestClassGoldenPartOf',
-      'TestClassGoldenPartOf',
-      'TestClassGoldenPartOfCurrent',
-      'TestClassGoldenPartOfCurrent',
+      'TestClassFileNoPart',
+      'TestClassFileNoPart',
+      'TestClassFilePartOf',
+      'TestClassFilePartOf',
+      'TestClassFilePartOfCurrent',
+      'TestClassFilePartOfCurrent',
       'TestClassWithBadMember',
       'badTestField',
       'badTestField',
@@ -311,9 +311,9 @@ const TestClass2NameLowerCase = 'testclass2';
             '`BadTestClass`: "no-prefix-required", "vague"; '
             '`TestClass1`: "no-prefix-required", "vague"; '
             '`TestClass2`: "vague"; '
-            '`TestClassGoldenNoPart`: "no-prefix-required", "vague"; '
-            '`TestClassGoldenPartOf`: "no-prefix-required", "vague"; '
-            '`TestClassGoldenPartOfCurrent`: "no-prefix-required", "vague"; '
+            '`TestClassFileNoPart`: "no-prefix-required", "vague"; '
+            '`TestClassFilePartOf`: "no-prefix-required", "vague"; '
+            '`TestClassFilePartOfCurrent`: "no-prefix-required", "vague"; '
             '`badTestField`: "vague"; '
             '`badTestFunc`: "vague"',
           ),

diff --git a/test/init_library_reader_test.dart b/test/init_library_reader_test.dart
@@ -26,9 +26,9 @@ void main() {
           'badTestFunc',
           'TestClass1',
           'TestClass2',
-          'TestClassGoldenNoPart',
-          'TestClassGoldenPartOf',
-          'TestClassGoldenPartOfCurrent',
+          'TestClassFileNoPart',
+          'TestClassFilePartOf',
+          'TestClassFilePartOfCurrent',
           'TestClassWithBadMember',
         ]),
       );

diff --git a/test/src/goldens/test_library_file_no_part.dart b/test/src/goldens/test_library_file_no_part.dart
@@ -0,0 +1,3 @@
+const TestClassFileNoPartNameLength = 19;
+
+const TestClassFileNoPartNameLowerCase = 'testclassfilenopart';
diff --git a/test/src/goldens/test_library_file_part_of.dart b/test/src/goldens/test_library_file_part_of.dart
@@ -0,0 +1,5 @@
+part of 'test_part_owner.dart';
+
+const TestClassFilePartOfNameLength = 19;
+
+const TestClassFilePartOfNameLowerCase = 'testclassfilepartof';
diff --git a/test/src/goldens/test_library_file_part_of_current.dart b/test/src/goldens/test_library_file_part_of_current.dart
@@ -0,0 +1,5 @@
+part of '../test_library.dart';
+
+const TestClassFilePartOfCurrentNameLength = 26;
+
+const TestClassFilePartOfCurrentNameLowerCase = 'testclassfilepartofcurrent';
diff --git a/test/src/goldens/test_library_golden_no_part.dart b/test/src/goldens/test_library_golden_no_part.dart
diff --git a/test/src/goldens/test_library_golden_part_of.dart b/test/src/goldens/test_library_golden_part_of.dart
diff --git a/test/src/goldens/test_library_golden_part_of_current.dart b/test/src/goldens/test_library_golden_part_of_current.dart
diff --git a/test/src/test_library.dart b/test/src/test_library.dart
@@ -3,7 +3,7 @@ import 'package:source_gen_test/annotations.dart';
 import 'test_annotation.dart';
 
 part 'test_part.dart';
-part 'goldens/test_library_golden_part_of_current.dart';
+part 'goldens/test_library_file_part_of_current.dart';
 
 @ShouldGenerate(
   r'''
@@ -21,8 +21,8 @@ const TestClass1NameLowerCase = 'testclass1';
 @TestAnnotation()
 class TestClass1 {}
 
-@ShouldGenerateGolden(
-  'goldens/test_library_golden_no_part.dart',
+@ShouldGenerateFile(
+  'goldens/test_library_file_no_part.dart',
   configurations: ['default', 'no-prefix-required'],
 )
 @ShouldThrow(
@@ -31,10 +31,10 @@ class TestClass1 {}
   element: false,
 )
 @TestAnnotation()
-class TestClassGoldenNoPart {}
+class TestClassFileNoPart {}
 
-@ShouldGenerateGolden(
-  'goldens/test_library_golden_part_of.dart',
+@ShouldGenerateFile(
+  'goldens/test_library_file_part_of.dart',
   partOf: 'test_part_owner.dart',
   configurations: ['default', 'no-prefix-required'],
 )
@@ -44,10 +44,10 @@ class TestClassGoldenNoPart {}
   element: false,
 )
 @TestAnnotation()
-class TestClassGoldenPartOf {}
+class TestClassFilePartOf {}
 
-@ShouldGenerateGolden(
-  'goldens/test_library_golden_part_of_current.dart',
+@ShouldGenerateFile(
+  'goldens/test_library_file_part_of_current.dart',
   partOfCurrent: true,
   configurations: ['default', 'no-prefix-required'],
 )
@@ -57,7 +57,7 @@ class TestClassGoldenPartOf {}
   element: false,
 )
 @TestAnnotation()
-class TestClassGoldenPartOfCurrent {}
+class TestClassFilePartOfCurrent {}
 
 @ShouldGenerate(
   r'''
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		const TestClassFileNoPartNameLength = 19;

		const TestClassFileNoPartNameLowerCase = 'testclassfilenopart';