Merge pull request #169 from devmil/feature/add_readability_and_writa…

…bility_metadata_for_fields adds readability / writability data for fields
bmw-tech · Feb 9, 2024 · 90bec51 · 90bec51
2 parents 324e4e9 + 25f4c50
commit 90bec51
Show file tree

Hide file tree

Showing 30 changed files with 454 additions and 19 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -180,7 +180,7 @@ jobs:
       - name: Install Dependencies
         run: |
           dart pub get
-          dart pub global activate pana
+          dart pub global activate pana 0.21.45 #temporary as the latest version 0.22.0 has issues with the dartdoc interface
 
       - name: Verify Pub Score
         run: |

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## Version 0.18.0
 - add missing export to json output for `extract` command
+- adds analysis of readability and writability of fields.
 - fixes interface equality logic in the differ functionality to be less strict on library renaming (if the entry points are still the same)
 - fix change compatibility check for `dynamic` and `Object?` parameters
 - fix compatibility checks for return types of executables

diff --git a/lib/src/diff/api_change_code.dart b/lib/src/diff/api_change_code.dart
@@ -105,6 +105,12 @@ enum ApiChangeCode {
   /// field experimental status changed
   cf06._('CF06', 'field experimental status changed'),
 
+  /// field readability changed
+  cf07._('CF07', 'field readability changed'),
+
+  /// field writability changed
+  cf08._('CF08', 'field writability changed'),
+
   /// iOS platform added
   cpi01._('CPI01', 'iOS platform added'),
 

diff --git a/lib/src/diff/package_api_differ.dart b/lib/src/diff/package_api_differ.dart
@@ -911,6 +911,30 @@ class PackageApiDiffer {
         context,
         isExperimental: isExperimental,
       ));
+      _comparePropertiesAndAddChange(
+        oldField.isReadable,
+        newField.isReadable,
+        context,
+        newField,
+        'Readablility changed. ${oldField.isReadable} -> ${newField.isReadable}',
+        changes,
+        changeCode: ApiChangeCode.cf07,
+        isExperimental: isExperimental,
+        // the change is compatible if the field gained readablility
+        isCompatibleChange: newField.isReadable,
+      );
+      _comparePropertiesAndAddChange(
+        oldField.isWriteable,
+        newField.isWriteable,
+        context,
+        newField,
+        'Writability changed. ${oldField.isWriteable} -> ${newField.isWriteable}',
+        changes,
+        changeCode: ApiChangeCode.cf08,
+        isExperimental: isExperimental,
+        // the change is compatible if the field gained writability
+        isCompatibleChange: newField.isWriteable,
+      );
 
       return changes;
     });

diff --git a/lib/src/model/executable_declaration.dart b/lib/src/model/executable_declaration.dart
@@ -68,7 +68,7 @@ class ExecutableDeclaration
     /// name of the return type
     required String returnTypeName,
 
-    // fill library name of the return type
+    // full library name of the return type
     required String? returnTypeFullLibraryName,
 
     /// name of the executable

diff --git a/lib/src/model/executable_declaration.freezed.dart b/lib/src/model/executable_declaration.freezed.dart
@@ -354,7 +354,7 @@ abstract class _ExecutableParameterDeclaration
 mixin _$ExecutableDeclaration {
   /// name of the return type
   String get returnTypeName =>
-      throw _privateConstructorUsedError; // fill library name of the return type
+      throw _privateConstructorUsedError; // full library name of the return type
   String? get returnTypeFullLibraryName => throw _privateConstructorUsedError;
 
   /// name of the executable
@@ -604,7 +604,7 @@ class _$ExecutableDeclarationImpl extends _ExecutableDeclaration {
   /// name of the return type
   @override
   final String returnTypeName;
-// fill library name of the return type
+// full library name of the return type
   @override
   final String? returnTypeFullLibraryName;
 
@@ -743,7 +743,7 @@ abstract class _ExecutableDeclaration extends ExecutableDeclaration {
 
   /// name of the return type
   String get returnTypeName;
-  @override // fill library name of the return type
+  @override // full library name of the return type
   String? get returnTypeFullLibraryName;
   @override
 

diff --git a/lib/src/model/field_declaration.dart b/lib/src/model/field_declaration.dart
@@ -39,6 +39,12 @@ class FieldDeclaration with _$FieldDeclaration implements Declaration {
 
     /// the relative path of the library
     required String relativePath,
+
+    /// whether this field is readable
+    required bool isReadable,
+
+    /// whether this field is writeable
+    required bool isWriteable,
   }) = _FieldDeclaration;
 
   /// helper to compute the signature of a field

diff --git a/lib/src/model/field_declaration.freezed.dart b/lib/src/model/field_declaration.freezed.dart
@@ -40,6 +40,12 @@ mixin _$FieldDeclaration {
   /// the relative path of the library
   String get relativePath => throw _privateConstructorUsedError;
 
+  /// whether this field is readable
+  bool get isReadable => throw _privateConstructorUsedError;
+
+  /// whether this field is writeable
+  bool get isWriteable => throw _privateConstructorUsedError;
+
   @JsonKey(ignore: true)
   $FieldDeclarationCopyWith<FieldDeclaration> get copyWith =>
       throw _privateConstructorUsedError;
@@ -59,7 +65,9 @@ abstract class $FieldDeclarationCopyWith<$Res> {
       bool isStatic,
       bool isExperimental,
       Set<String>? entryPoints,
-      String relativePath});
+      String relativePath,
+      bool isReadable,
+      bool isWriteable});
 }
 
 /// @nodoc
@@ -83,6 +91,8 @@ class _$FieldDeclarationCopyWithImpl<$Res, $Val extends FieldDeclaration>
     Object? isExperimental = null,
     Object? entryPoints = freezed,
     Object? relativePath = null,
+    Object? isReadable = null,
+    Object? isWriteable = null,
   }) {
     return _then(_value.copyWith(
       typeName: null == typeName
@@ -117,6 +127,14 @@ class _$FieldDeclarationCopyWithImpl<$Res, $Val extends FieldDeclaration>
           ? _value.relativePath
           : relativePath // ignore: cast_nullable_to_non_nullable
               as String,
+      isReadable: null == isReadable
+          ? _value.isReadable
+          : isReadable // ignore: cast_nullable_to_non_nullable
+              as bool,
+      isWriteable: null == isWriteable
+          ? _value.isWriteable
+          : isWriteable // ignore: cast_nullable_to_non_nullable
+              as bool,
     ) as $Val);
   }
 }
@@ -137,7 +155,9 @@ abstract class _$$FieldDeclarationImplCopyWith<$Res>
       bool isStatic,
       bool isExperimental,
       Set<String>? entryPoints,
-      String relativePath});
+      String relativePath,
+      bool isReadable,
+      bool isWriteable});
 }
 
 /// @nodoc
@@ -159,6 +179,8 @@ class __$$FieldDeclarationImplCopyWithImpl<$Res>
     Object? isExperimental = null,
     Object? entryPoints = freezed,
     Object? relativePath = null,
+    Object? isReadable = null,
+    Object? isWriteable = null,
   }) {
     return _then(_$FieldDeclarationImpl(
       typeName: null == typeName
@@ -193,6 +215,14 @@ class __$$FieldDeclarationImplCopyWithImpl<$Res>
           ? _value.relativePath
           : relativePath // ignore: cast_nullable_to_non_nullable
               as String,
+      isReadable: null == isReadable
+          ? _value.isReadable
+          : isReadable // ignore: cast_nullable_to_non_nullable
+              as bool,
+      isWriteable: null == isWriteable
+          ? _value.isWriteable
+          : isWriteable // ignore: cast_nullable_to_non_nullable
+              as bool,
     ));
   }
 }
@@ -208,7 +238,9 @@ class _$FieldDeclarationImpl extends _FieldDeclaration {
       required this.isStatic,
       required this.isExperimental,
       final Set<String>? entryPoints,
-      required this.relativePath})
+      required this.relativePath,
+      required this.isReadable,
+      required this.isWriteable})
       : _entryPoints = entryPoints,
         super._();
 
@@ -253,9 +285,17 @@ class _$FieldDeclarationImpl extends _FieldDeclaration {
   @override
   final String relativePath;
 
+  /// whether this field is readable
+  @override
+  final bool isReadable;
+
+  /// whether this field is writeable
+  @override
+  final bool isWriteable;
+
   @override
   String toString() {
-    return 'FieldDeclaration(typeName: $typeName, typeFullLibraryName: $typeFullLibraryName, name: $name, isDeprecated: $isDeprecated, isStatic: $isStatic, isExperimental: $isExperimental, entryPoints: $entryPoints, relativePath: $relativePath)';
+    return 'FieldDeclaration(typeName: $typeName, typeFullLibraryName: $typeFullLibraryName, name: $name, isDeprecated: $isDeprecated, isStatic: $isStatic, isExperimental: $isExperimental, entryPoints: $entryPoints, relativePath: $relativePath, isReadable: $isReadable, isWriteable: $isWriteable)';
   }
 
   @override
@@ -277,7 +317,11 @@ class _$FieldDeclarationImpl extends _FieldDeclaration {
             const DeepCollectionEquality()
                 .equals(other._entryPoints, _entryPoints) &&
             (identical(other.relativePath, relativePath) ||
-                other.relativePath == relativePath));
+                other.relativePath == relativePath) &&
+            (identical(other.isReadable, isReadable) ||
+                other.isReadable == isReadable) &&
+            (identical(other.isWriteable, isWriteable) ||
+                other.isWriteable == isWriteable));
   }
 
   @override
@@ -290,7 +334,9 @@ class _$FieldDeclarationImpl extends _FieldDeclaration {
       isStatic,
       isExperimental,
       const DeepCollectionEquality().hash(_entryPoints),
-      relativePath);
+      relativePath,
+      isReadable,
+      isWriteable);
 
   @JsonKey(ignore: true)
   @override
@@ -310,7 +356,9 @@ abstract class _FieldDeclaration extends FieldDeclaration
       required final bool isStatic,
       required final bool isExperimental,
       final Set<String>? entryPoints,
-      required final String relativePath}) = _$FieldDeclarationImpl;
+      required final String relativePath,
+      required final bool isReadable,
+      required final bool isWriteable}) = _$FieldDeclarationImpl;
   const _FieldDeclaration._() : super._();
 
   @override
@@ -346,6 +394,14 @@ abstract class _FieldDeclaration extends FieldDeclaration
   /// the relative path of the library
   String get relativePath;
   @override
+
+  /// whether this field is readable
+  bool get isReadable;
+  @override
+
+  /// whether this field is writeable
+  bool get isWriteable;
+  @override
   @JsonKey(ignore: true)
   _$$FieldDeclarationImplCopyWith<_$FieldDeclarationImpl> get copyWith =>
       throw _privateConstructorUsedError;

diff --git a/lib/src/model/internal/internal_field_declaration.dart b/lib/src/model/internal/internal_field_declaration.dart
@@ -22,6 +22,8 @@ class InternalFieldDeclaration implements InternalDeclaration {
   final Set<String>? entryPoints;
   @override
   final String relativePath;
+  final bool isWriteable;
+  final bool isReadable;
 
   InternalFieldDeclaration._({
     required this.id,
@@ -35,6 +37,8 @@ class InternalFieldDeclaration implements InternalDeclaration {
     required this.isStatic,
     required this.entryPoints,
     required this.relativePath,
+    required this.isReadable,
+    required this.isWriteable,
   });
 
   InternalFieldDeclaration.fromPropertyInducingElement(
@@ -57,6 +61,8 @@ class InternalFieldDeclaration implements InternalDeclaration {
           entryPoints: {},
           relativePath:
               InternalDeclarationUtils.getRelativePath(rootPath, fieldElement),
+          isReadable: fieldElement.getter != null,
+          isWriteable: fieldElement.setter != null,
         );
 
   FieldDeclaration toFieldDeclaration() {
@@ -70,6 +76,8 @@ class InternalFieldDeclaration implements InternalDeclaration {
       isStatic: isStatic,
       entryPoints: entryPoints,
       relativePath: relativePath,
+      isReadable: isReadable,
+      isWriteable: isWriteable,
     );
   }
 }
diff --git a/lib/src/storage/v3/field_declaration_storage_v3.dart b/lib/src/storage/v3/field_declaration_storage_v3.dart
@@ -18,6 +18,8 @@ class FieldDeclarationStorageV3 with _$FieldDeclarationStorageV3 {
     required bool isStatic,
     required Set<String> entryPoints,
     required String relativePath,
+    required bool isReadable,
+    required bool isWriteable,
   }) = _FieldDeclarationStorageV3;
 
   factory FieldDeclarationStorageV3.fromJson(Map<String, Object?> json) =>
@@ -33,6 +35,8 @@ class FieldDeclarationStorageV3 with _$FieldDeclarationStorageV3 {
       isStatic: fieldDeclaration.isStatic,
       entryPoints: fieldDeclaration.entryPoints!,
       relativePath: fieldDeclaration.relativePath,
+      isReadable: fieldDeclaration.isReadable,
+      isWriteable: fieldDeclaration.isWriteable,
     );
   }
 }