@cparra/apex-reflection 0.1.0-alpha.0 → 0.1.1-alpha.10

package/test/apexdoc_parser_test.dart

@@ -1,179 +0,0 @@
-// Disabling null safety since this test relies on the antrl4 package
-// @dart=2.10
-
-import 'package:apexdocs_dart/src/service/parsers.dart';
-import 'package:test/test.dart';
-
-main() {
-  test('Can parse a single line simple doc comment', () {
-    final docBody = '/** This is a description */';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.description, 'This is a description');
-  });
-
-  test('Can parse a multi line simple doc comment', () {
-    final docBody = '''
-    /**
-      * This is a description
-      */
-    ''';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.description, 'This is a description');
-  });
-
-  test('Can parse a multi line simple doc comment with multiple blank lines',
-      () {
-    final docBody = '''
-      /**
-        *
-        * This is a description
-        *
-        */
-      ''';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.description, 'This is a description');
-  });
-
-  test('Can parse description of multiple lines.', () {
-    final docBody = '''
-    /**
-      * This is a description.
-      * The description continues here.
-      */
-    ''';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.description,
-        'This is a description. The description continues here.');
-  });
-
-  test('Can parse tagged description', () {
-    final docBody = '''
-    /**
-      * @description This is a description
-      */
-    ''';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.description, 'This is a description');
-  });
-
-  test('Can parse tagged description with multiple lines', () {
-    final docBody = '''
-    /**
-      * @description This is a description.
-      * The description continues here
-      */
-    ''';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.descriptionLines.length, equals(2));
-    expect(docComment.description,
-        equals('This is a description. The description continues here'));
-  });
-
-  test('Can parse a tag', () {
-    final docBody = '''
-    /**
-      * @description This is a description.
-      * @param param1 description
-      */
-    ''';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.paramAnnotations.length, equals(1));
-    expect(docComment.paramAnnotations.first.paramName, equals('param1'));
-    expect(docComment.paramAnnotations.first.body, equals('description'));
-  });
-
-  test('Can parse multiple of the same tag', () {
-    final docBody = '''
-    /**
-      * @description This is a description.
-      * @param param1 description1
-      * @param param2 description2
-      */
-    ''';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.paramAnnotations.length, equals(2));
-    expect(docComment.paramAnnotations.first.paramName, equals('param1'));
-    expect(docComment.paramAnnotations.first.body, equals('description1'));
-    expect(docComment.paramAnnotations[1].paramName, equals('param2'));
-    expect(docComment.paramAnnotations[1].body, equals('description2'));
-  });
-
-  test('Can parse a param with a multi line body', () {
-    final docBody = '''
-    /**
-      * @description This is a description.
-      * @param param1 description1
-      * The description continues here.
-      */
-    ''';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.paramAnnotations.length, equals(1));
-    expect(docComment.paramAnnotations.first.paramName, equals('param1'));
-    expect(docComment.paramAnnotations.first.body,
-        equals('description1 The description continues here.'));
-  });
-
-  test('Can parse a return tag', () {
-    final docBody = '''
-    /**
-      * @description This is a description.
-      * @param param1 description1
-      * @return Returns something
-      */
-    ''';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.returnAnnotation, isNotNull);
-    expect(docComment.returnAnnotation.body, equals('Returns something'));
-  });
-
-  test('Can parse a throws tag', () {
-    final docBody = '''
-    /**
-      * @description This is a description.
-      * @param param1 description1
-      * @return Returns something
-      * @throws ExceptionName1 description1
-      * @throws ExceptionName2 description2
-      */
-    ''';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.throwsAnnotations.length, equals(2));
-    expect(docComment.throwsAnnotations.first.exceptionName,
-        equals('ExceptionName1'));
-    expect(docComment.throwsAnnotations.first.body, equals('description1'));
-    expect(docComment.throwsAnnotations[1].exceptionName,
-        equals('ExceptionName2'));
-    expect(docComment.throwsAnnotations[1].body, equals('description2'));
-  });
-
-  test('Can parse an example tag', () {
-    final docBody = '''
-    /**
-      * @description This is a description.
-      * @param param1 description1
-      * @return Returns something
-      * @throws ExceptionName1 description1
-      * @throws ExceptionName2 description2
-      * @example
-      * String testString = 'MyString';
-      */
-    ''';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.exampleAnnotation, isNotNull);
-    expect(docComment.exampleAnnotation.bodyLines.length, equals(1));
-    expect(docComment.exampleAnnotation.body,
-        equals("String testString = 'MyString';"));
-  });
-
-  test('Can parse custom tags', () {
-    final docBody = '''
-    /**
-      * @author Some Author
-      */
-    ''';
-    final docComment = ApexdocParser.parseFromBody(docBody);
-    expect(docComment.annotationsByName('author').length, equals(1));
-    expect(docComment.annotationsByName('author').first.body,
-        equals('Some Author'));
-  });
-}

package/test/doc_comment_test.dart

@@ -1,89 +0,0 @@
-import 'package:apexdocs_dart/src/model/doc_comment.dart';
-import 'package:test/test.dart';
-
-main() {
-  group('Doc Comment', () {
-    test('Has a description', () {
-      final comment = DocComment('Any Description');
-      expect(comment.description, equals('Any Description'));
-    });
-
-    test(
-        'Supports the description being a tag when there is no default description',
-        () {
-      final comment = DocComment('');
-      comment.annotations.add(DocCommentAnnotation('description', 'some body'));
-      expect(comment.description, equals('some body'));
-    });
-
-    test('Can have param annotations', () {
-      final comment = DocComment('Any Description');
-      comment.paramAnnotations
-          .add(ParamDocCommentAnnotation('param1', 'Some description'));
-      expect(comment.paramAnnotations.length, equals(1));
-      expect(comment.paramAnnotations.first.paramName, equals('param1'));
-    });
-
-    test('Can have a return annotation', () {
-      final comment = DocComment('Any Description');
-      comment.returnAnnotation = ReturnDocCommentAnnotation('description');
-      expect(comment.returnAnnotation, isNotNull);
-    });
-
-    test('Can have annotations', () {
-      final comment = DocComment('Any Description');
-      comment.annotations.add(DocCommentAnnotation('see', 'body'));
-      expect(comment.annotations.length, equals(1));
-      expect(comment.annotations.first.name, equals('see'));
-    });
-  });
-
-  group('Doc Comment Annotation', () {
-    test('Has a name', () {
-      final annotation = DocCommentAnnotation('description', 'body');
-      expect(annotation.name, equals('description'));
-    });
-
-    test('Can have a body', () {
-      final annotation = DocCommentAnnotation('description', ['body']);
-      expect(annotation.body, equals('body'));
-    });
-  });
-
-  group('Param annotations', () {
-    test('Has an annotation name of param, the parameter name, and a body', () {
-      final paramAnnotation =
-          ParamDocCommentAnnotation('param1', 'Some description');
-      expect(paramAnnotation.name, equals('param'));
-      expect(paramAnnotation.paramName, equals('param1'));
-      expect(paramAnnotation.body, equals('Some description'));
-    });
-  });
-
-  group('Return annotations', () {
-    test('Has a body', () {
-      final returnAnnotation = ReturnDocCommentAnnotation('Some description');
-      expect(returnAnnotation.name, equals('return'));
-      expect(returnAnnotation.body, equals('Some description'));
-    });
-  });
-
-  group('Throws annotations', () {
-    test('Has an annotation name of throws, the exception name, and a body',
-        () {
-      final throwsAnnotation =
-          ThrowsDocCommentAnnotation('ExceptionName', 'Some description');
-      expect(throwsAnnotation.name, equals('throws'));
-      expect(throwsAnnotation.exceptionName, equals('ExceptionName'));
-      expect(throwsAnnotation.body, equals('Some description'));
-    });
-  });
-
-  group('Example annotations', () {
-    test('Has a body', () {
-      final exampleAnnotation = ExampleDocCommentAnnotation('Some description');
-      expect(exampleAnnotation.name, equals('example'));
-      expect(exampleAnnotation.body, equals('Some description'));
-    });
-  });
-}

package/test/members_serialization_test.dart

@@ -1,158 +0,0 @@
-import 'dart:convert';
-
-import 'package:test/test.dart';
-import 'package:apexdocs_dart/src/model/members.dart';
-
-void main() {
-  group('Property serialization', () {
-    test('Properties can be serialized', () {
-      final property = Property(
-          name: 'PropName',
-          type: 'String',
-          accessModifiers: ['namespaceaccessible', 'public']);
-
-      String encodedProperty = jsonEncode(property);
-      expect(encodedProperty, isNotNull);
-      final decodedProperty = Property.fromJson(jsonDecode(encodedProperty));
-      expect(property.name, equals(decodedProperty.name));
-    });
-
-    test('Properties can be deserialized', () {
-      final propertyAsJson = '''
-      {
-        "name": "PropName",
-        "type": "String",
-        "access_modifiers": ["namespaceaccessible", "public"]
-      }
-      ''';
-
-      final property = Property.fromJson(jsonDecode(propertyAsJson));
-      expect(property.name, equals('PropName'));
-      expect(property.type, equals('String'));
-      expect(
-          property.accessModifiers, equals(['namespaceaccessible', 'public']));
-    });
-  });
-
-  group('Field serialization', () {
-    test('Fields can be serialized', () {
-      var field = Field(
-          name: 'FieldNAme',
-          type: 'String',
-          accessModifiers: ['namespaceaccessible', 'public']);
-
-      String encodedField = jsonEncode(field);
-      expect(encodedField, isNotNull);
-      final decodedField = Field.fromJson(jsonDecode(encodedField));
-      expect(field.name, equals(decodedField.name));
-    });
-
-    test('Fields can be deserialized', () {
-      final fieldAsJson = '''
-      {
-        "name": "FieldName",
-        "type": "String",
-        "access_modifiers": ["namespaceaccessible", "public"]
-      }
-      ''';
-
-      final field = Field.fromJson(jsonDecode(fieldAsJson));
-      expect(field.name, equals('FieldName'));
-      expect(field.type, equals('String'));
-      expect(field.accessModifiers, equals(['namespaceaccessible', 'public']));
-    });
-  });
-
-  group('Method serialization', () {
-    test('Methods can be serialized', () {
-      var method = Method(
-          name: 'MethodName',
-          type: 'String',
-          accessModifiers: ['namespaceaccessible', 'public']);
-      method.addParameter(Parameter(name: 'Param1', type: 'String'));
-
-      String encodedMethod = jsonEncode(method);
-      expect(encodedMethod, isNotNull);
-      final decodedMethod = Method.fromJson(jsonDecode(encodedMethod));
-      expect(method.name, equals(decodedMethod.name));
-    });
-
-    test('Methods can be deserialized', () {
-      final methodAsJson = '''
-      {
-        "name":"MethodName",
-        "type":"String",
-        "access_modifiers":["namespaceaccessible","public"],
-        "parameters":[{"name":"Param1","type":"String","access_modifiers":[]}]
-      }
-      ''';
-
-      final method = Method.fromJson(jsonDecode(methodAsJson));
-      expect(method.name, equals('MethodName'));
-      expect(method.type, equals('String'));
-      expect(method.accessModifiers, equals(['namespaceaccessible', 'public']));
-      expect(method.parameters.length, equals(1));
-      expect(method.parameters.first.name, equals('Param1'));
-    });
-  });
-
-  group('Parameter serialization', () {
-    test('Parameters can be serialized', () {
-      var parameter = Parameter(
-          name: 'ParameterName',
-          type: 'String',
-          accessModifiers: ['namespaceaccessible', 'public']);
-
-      String encodedParameter = jsonEncode(parameter);
-      expect(encodedParameter, isNotNull);
-      final decodedParameter = Parameter.fromJson(jsonDecode(encodedParameter));
-      expect(parameter.name, equals(decodedParameter.name));
-    });
-
-    test('Parameters can be deserialized', () {
-      final parameterAsJson = '''
-      {
-        "name": "ParameterName",
-        "type": "String",
-        "access_modifiers": ["namespaceaccessible", "public"]
-      }
-      ''';
-
-      final parameter = Parameter.fromJson(jsonDecode(parameterAsJson));
-      expect(parameter.name, equals('ParameterName'));
-      expect(parameter.type, equals('String'));
-      expect(
-          parameter.accessModifiers, equals(['namespaceaccessible', 'public']));
-    });
-  });
-
-  group('Constructor serialization', () {
-    test('Constructors can be serialized', () {
-      var constructor =
-          Constructor(accessModifiers: ['namespaceaccessible', 'public']);
-      constructor.addParameter(Parameter(name: 'Param1', type: 'String'));
-
-      String encodedConstructor = jsonEncode(constructor);
-      expect(encodedConstructor, isNotNull);
-      final decodedConstructor =
-          Constructor.fromJson(jsonDecode(encodedConstructor));
-      expect(constructor.accessModifiers,
-          equals(decodedConstructor.accessModifiers));
-    });
-
-    test('Constructors can be deserialized', () {
-      final constructorAsJson = '''
-      {
-        "access_modifiers":["namespaceaccessible","public"],
-        "parameters":[{"name":"Param1","type":"String","access_modifiers":[]}]
-      }
-      ''';
-
-      final constructor = Constructor.fromJson(jsonDecode(constructorAsJson));
-      expect(constructor.accessModifiers,
-          equals(['namespaceaccessible', 'public']));
-      expect(constructor.parameters.length, equals(1));
-      expect(constructor.parameters.first.name, equals('Param1'));
-    });
-  });
-}

package/test/members_test.dart

@@ -1,178 +0,0 @@
-import 'package:test/test.dart';
-import 'package:apexdocs_dart/src/model/members.dart';
-
-void main() {
-  group('Properties tests', () {
-    test('Properties have a name', () {
-      var property = Property(name: 'MyProperty', type: 'String');
-      expect(property.name, 'MyProperty');
-    });
-
-    test('Properties have a type', () {
-      var property = Property(name: 'MyProperty', type: 'String');
-      expect(property.type, 'String');
-    });
-
-    test('Do not have doc comments by default', () {
-      final property = Property(name: 'AnyName', type: 'String');
-      expect(property.rawDocComment, isNull);
-    });
-
-    test('Can receive doc comments', () {
-      final property = Property(
-          name: 'AnyName',
-          type: 'String',
-          docComment: '@description Some description');
-      expect(property.rawDocComment, isNotNull);
-    });
-
-    test('Properties can have access modifiers', () {
-      var property = Property(
-          name: 'MyProp',
-          type: 'String',
-          accessModifiers: ['namespaceaccessible', 'public']);
-      expect(property.isNamespaceAccessible, isTrue);
-      expect(property.isPublic, isTrue);
-    });
-  });
-
-  group('Fields tests', () {
-    test('Fields have a name', () {
-      var field = Field(name: 'MyField', type: 'String');
-      expect(field.name, 'MyField');
-    });
-
-    test('Fields have a type', () {
-      var field = Field(name: 'MyField', type: 'String');
-      expect(field.type, 'String');
-    });
-
-    test('Do not have doc comments by default', () {
-      final field = Field(name: 'AnyName', type: 'String');
-      expect(field.rawDocComment, isNull);
-    });
-
-    test('Can receive doc comments', () {
-      final field = Field(
-          name: 'AnyName',
-          type: 'String',
-          docComment: '@description Some description');
-      expect(field.rawDocComment, isNotNull);
-    });
-
-    test('Fields can have access modifiers', () {
-      var field = Field(
-          name: 'MyField',
-          type: 'String',
-          accessModifiers: ['namespaceaccessible', 'public']);
-      expect(field.isNamespaceAccessible, isTrue);
-      expect(field.isPublic, isTrue);
-    });
-  });
-
-  group('Methods tests', () {
-    test('Methods have a name', () {
-      var method = Method(name: 'myMethod', type: 'String');
-      expect(method.name, 'myMethod');
-    });
-
-    test('Do not have doc comments by default', () {
-      final method = Method(name: 'AnyName', type: 'String');
-      expect(method.rawDocComment, isNull);
-    });
-
-    test('Can receive doc comments', () {
-      final method = Method(
-          name: 'AnyName',
-          type: 'String',
-          docComment: '@description Some description');
-      expect(method.rawDocComment, isNotNull);
-    });
-
-    test('Methods without a type are void', () {
-      var method = Method(name: 'myMethod');
-      expect(method.isVoid, isTrue);
-    });
-
-    test('Methods have a type', () {
-      var method = Method(name: 'myMethod', type: 'String');
-      expect(method.type, 'String');
-    });
-
-    test('Methods can have access modifiers', () {
-      var method = Method(
-          name: 'myMethod',
-          type: 'String',
-          accessModifiers: ['namespaceaccessible', 'public']);
-      expect(method.isNamespaceAccessible, isTrue);
-      expect(method.isPublic, isTrue);
-    });
-
-    test('Methods have no parameters by default', () {
-      var method = Method(name: 'myMethod');
-      expect(method.parameters.isEmpty, isTrue);
-    });
-
-    test('Can receive parameters', () {
-      var method = Method(name: 'myMethod');
-      var parameter = Parameter(name: 'Param', type: 'String');
-      method.addParameter(parameter);
-      expect(method.parameters.length, equals(1));
-      expect(method.parameters.first, equals(parameter));
-    });
-  });
-
-  group('Parameter tests', () {
-    test('Parameters have a name', () {
-      var parameter = Parameter(name: 'Param', type: 'String');
-      expect(parameter.name, 'Param');
-    });
-
-    test('Parameters have a type', () {
-      var parameter = Parameter(name: 'Param', type: 'String');
-      expect(parameter.type, 'String');
-    });
-
-    test('Parameters can have access modifiers', () {
-      var parameter = Parameter(
-          name: 'Param',
-          type: 'String',
-          accessModifiers: ['namespaceaccessible', 'public']);
-      expect(parameter.isNamespaceAccessible, isTrue);
-      expect(parameter.isPublic, isTrue);
-    });
-  });
-
-  group('Constructor tests', () {
-    test('Can have access modifiers', () {
-      var constructor =
-          Constructor(accessModifiers: ['namespaceaccessible', 'public']);
-      expect(constructor.isNamespaceAccessible, isTrue);
-      expect(constructor.isPublic, isTrue);
-    });
-
-    test('Do not have doc comments by default', () {
-      final constructor = Constructor();
-      expect(constructor.rawDocComment, isNull);
-    });
-
-    test('Can receive doc comments', () {
-      final constructor =
-          Constructor(docComment: '@description Some description');
-      expect(constructor.rawDocComment, isNotNull);
-    });
-
-    test('Have no parameters by default', () {
-      var constructor = Constructor();
-      expect(constructor.parameters.isEmpty, isTrue);
-    });
-
-    test('Can receive parameters', () {
-      var constructor = Constructor();
-      var parameter = Parameter(name: 'Param', type: 'String');
-      constructor.addParameter(parameter);
-      expect(constructor.parameters.length, equals(1));
-      expect(constructor.parameters.first, equals(parameter));
-    });
-  });
-}