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

package/lib/src/model/types.g.dart

@@ -1,111 +0,0 @@
-// GENERATED CODE - DO NOT MODIFY BY HAND
-
-part of 'types.dart';
-
-// **************************************************************************
-// JsonSerializableGenerator
-// **************************************************************************
-
-ClassModel _$ClassModelFromJson(Map<String, dynamic> json) {
-  return ClassModel(
-    name: json['name'] as String,
-    docComment: json['docComment'] as String?,
-    accessModifiers: (json['access_modifiers'] as List<dynamic>)
-        .map((e) => e as String)
-        .toList(),
-    extendedClass: json['extended_class'] as String?,
-    implementedInterfaces: (json['implemented_interfaces'] as List<dynamic>)
-        .map((e) => e as String)
-        .toList(),
-  )
-    ..rawDocComment = json['rawDocComment'] as String?
-    ..typeName = json['type_name'] as String
-    ..methods = (json['methods'] as List<dynamic>)
-        .map((e) => Method.fromJson(e as Map<String, dynamic>))
-        .toList()
-    ..properties = (json['properties'] as List<dynamic>)
-        .map((e) => Property.fromJson(e as Map<String, dynamic>))
-        .toList()
-    ..fields = (json['fields'] as List<dynamic>)
-        .map((e) => Field.fromJson(e as Map<String, dynamic>))
-        .toList()
-    ..constructors = (json['constructors'] as List<dynamic>)
-        .map((e) => Constructor.fromJson(e as Map<String, dynamic>))
-        .toList()
-    ..enums = (json['enums'] as List<dynamic>)
-        .map((e) => EnumModel.fromJson(e as Map<String, dynamic>))
-        .toList()
-    ..interfaces = (json['interfaces'] as List<dynamic>)
-        .map((e) => InterfaceModel.fromJson(e as Map<String, dynamic>))
-        .toList()
-    ..classes = (json['classes'] as List<dynamic>)
-        .map((e) => ClassModel.fromJson(e as Map<String, dynamic>))
-        .toList();
-}
-
-Map<String, dynamic> _$ClassModelToJson(ClassModel instance) =>
-    <String, dynamic>{
-      'access_modifiers': instance.accessModifiers,
-      'rawDocComment': instance.rawDocComment,
-      'docComment': instance.docComment,
-      'name': instance.name,
-      'type_name': instance.typeName,
-      'methods': instance.methods,
-      'extended_class': instance.extendedClass,
-      'implemented_interfaces': instance.implementedInterfaces,
-      'properties': instance.properties,
-      'fields': instance.fields,
-      'constructors': instance.constructors,
-      'enums': instance.enums,
-      'interfaces': instance.interfaces,
-      'classes': instance.classes,
-    };
-
-InterfaceModel _$InterfaceModelFromJson(Map<String, dynamic> json) {
-  return InterfaceModel(
-    name: json['name'] as String,
-    docComment: json['docComment'] as String?,
-    accessModifiers: (json['access_modifiers'] as List<dynamic>)
-        .map((e) => e as String)
-        .toList(),
-    extendedInterfaces: (json['extended_interfaces'] as List<dynamic>)
-        .map((e) => e as String)
-        .toList(),
-  )
-    ..rawDocComment = json['rawDocComment'] as String?
-    ..typeName = json['type_name'] as String
-    ..methods = (json['methods'] as List<dynamic>)
-        .map((e) => Method.fromJson(e as Map<String, dynamic>))
-        .toList();
-}
-
-Map<String, dynamic> _$InterfaceModelToJson(InterfaceModel instance) =>
-    <String, dynamic>{
-      'access_modifiers': instance.accessModifiers,
-      'rawDocComment': instance.rawDocComment,
-      'docComment': instance.docComment,
-      'name': instance.name,
-      'type_name': instance.typeName,
-      'methods': instance.methods,
-      'extended_interfaces': instance.extendedInterfaces,
-    };
-
-EnumModel _$EnumModelFromJson(Map<String, dynamic> json) {
-  return EnumModel(
-    name: json['name'] as String,
-    docComment: json['docComment'] as String?,
-    accessModifiers: (json['access_modifiers'] as List<dynamic>)
-        .map((e) => e as String)
-        .toList(),
-  )
-    ..rawDocComment = json['rawDocComment'] as String?
-    ..typeName = json['type_name'] as String;
-}
-
-Map<String, dynamic> _$EnumModelToJson(EnumModel instance) => <String, dynamic>{
-      'access_modifiers': instance.accessModifiers,
-      'rawDocComment': instance.rawDocComment,
-      'docComment': instance.docComment,
-      'name': instance.name,
-      'type_name': instance.typeName,
-    };

package/lib/src/service/apex_listener.dart

@@ -1,226 +0,0 @@
-import 'dart:collection';
-
-import 'package:apexdocs_dart/src/antlr/lib/apex/ApexParser.dart';
-import 'package:apexdocs_dart/src/antlr/lib/apex/ApexParserBaseListener.dart';
-import 'package:apexdocs_dart/src/builders/builders.dart';
-import 'package:apexdocs_dart/src/model/members.dart';
-import 'package:apexdocs_dart/src/model/types.dart';
-import 'package:apexdocs_dart/src/service/utils/parsing/parsing_utils.dart';
-
-class DeclarationDescriptor {
-  List<String> accessModifiers = [];
-  String? docComment;
-
-  DeclarationDescriptor({required this.accessModifiers, this.docComment});
-}
-
-class ApexClassListener extends ApexParserBaseListener {
-  final Stack<DeclarationDescriptor> _declaratorDescriptorStack;
-  final Stack<Type> generatedTypes;
-  late Type generatedType;
-
-  ApexClassListener()
-      : generatedTypes = Stack<Type>(),
-        _declaratorDescriptorStack = Stack<DeclarationDescriptor>();
-
-  @override
-  void enterTypeClassDeclaration(TypeClassDeclarationContext ctx) {
-    final accessModifiers = getAccessModifiers(ctx);
-    final docComment = ctx.DOC_COMMENT()?.text;
-    _declaratorDescriptorStack.push(DeclarationDescriptor(
-        accessModifiers: accessModifiers, docComment: docComment));
-  }
-
-  @override
-  void enterTypeEnumDeclaration(TypeEnumDeclarationContext ctx) {
-    final accessModifiers = getAccessModifiers(ctx);
-    final docComment = ctx.DOC_COMMENT()?.text;
-    _declaratorDescriptorStack.push(DeclarationDescriptor(
-        accessModifiers: accessModifiers, docComment: docComment));
-  }
-
-  @override
-  void enterTypeInterfaceDeclaration(TypeInterfaceDeclarationContext ctx) {
-    final accessModifiers = getAccessModifiers(ctx);
-    final docComment = ctx.DOC_COMMENT()?.text;
-    _declaratorDescriptorStack.push(DeclarationDescriptor(
-        accessModifiers: accessModifiers, docComment: docComment));
-  }
-
-  @override
-  void enterClassDeclaration(ClassDeclarationContext ctx) {
-    final declarationDescriptor = _declaratorDescriptorStack.pop();
-    generatedTypes.push(buildClass(declarationDescriptor, ctx));
-  }
-
-  @override
-  void enterInterfaceDeclaration(InterfaceDeclarationContext ctx) {
-    final declarationDescriptor = _declaratorDescriptorStack.pop();
-    generatedTypes.push(buildInterface(declarationDescriptor, ctx));
-  }
-
-  @override
-  void enterEnumDeclaration(EnumDeclarationContext ctx) {
-    final declarationDescriptor = _declaratorDescriptorStack.pop();
-    final enumName = ctx.id().text;
-    final enumModel = EnumModel(
-        name: enumName,
-        docComment: declarationDescriptor.docComment,
-        accessModifiers: declarationDescriptor.accessModifiers);
-    generatedTypes.push(enumModel);
-  }
-
-  @override
-  void enterMemberClassBodyDeclaration(MemberClassBodyDeclarationContext ctx) {
-    final accessModifiers = getAccessModifiers(ctx);
-    final docComment = ctx.DOC_COMMENT()?.text;
-    _declaratorDescriptorStack.push(DeclarationDescriptor(
-        accessModifiers: accessModifiers, docComment: docComment));
-  }
-
-  @override
-  void enterPropertyDeclaration(PropertyDeclarationContext ctx) {
-    final declarationDescriptor = _declaratorDescriptorStack.pop();
-    final propertyName = ctx.id().text;
-    final type = ctx.typeRef().text;
-
-    final property = Property(
-        name: propertyName,
-        docComment: declarationDescriptor.docComment,
-        type: type,
-        accessModifiers: declarationDescriptor.accessModifiers);
-    (generatedTypes.peak() as ClassModel).addProperty(property);
-  }
-
-  @override
-  void enterFieldDeclaration(FieldDeclarationContext ctx) {
-    final declarationDescriptor = _declaratorDescriptorStack.pop();
-    final typeName = ctx.typeRef().text;
-    final fieldNames =
-        ctx.variableDeclarators().variableDeclarators().map((e) => e.text);
-    (generatedTypes.peak() as ClassModel).fields.addAll(fieldNames.map((e) =>
-        Field(
-            name: e,
-            docComment: declarationDescriptor.docComment,
-            type: typeName,
-            accessModifiers: declarationDescriptor.accessModifiers)));
-  }
-
-  @override
-  void enterMethodDeclaration(MethodDeclarationContext ctx) {
-    final declarationDescriptor = _declaratorDescriptorStack.pop();
-    final methodName = ctx.id().text;
-    final typeName = ctx.typeRef() != null ? ctx.typeRef().text : 'void';
-
-    List<Parameter>? parameters = parseParameters(ctx);
-
-    final method = Method(
-        name: methodName,
-        docComment: declarationDescriptor.docComment,
-        type: typeName,
-        accessModifiers: declarationDescriptor.accessModifiers);
-    method.parameters = parameters ?? [];
-
-    (generatedTypes.peak() as MethodsAwareness).methods.add(method);
-  }
-
-  @override
-  void enterInterfaceMethodDeclaration(InterfaceMethodDeclarationContext ctx) {
-    final docComment = ctx.DOC_COMMENT()?.text;
-    // Interface methods inherit the access modifiers of the parent declaration.
-    final accessModifiers = generatedTypes.peak().accessModifiers;
-    final methodName = ctx.id().text;
-    final typeName = ctx.typeRef() != null ? ctx.typeRef()!.text : 'void';
-
-    List<Parameter>? parameters = parseParameters(ctx);
-
-    final method = Method(
-        name: methodName,
-        docComment: docComment,
-        type: typeName,
-        accessModifiers: accessModifiers);
-    method.parameters = parameters ?? [];
-
-    (generatedTypes.peak() as MethodsAwareness).methods.add(method);
-  }
-
-  @override
-  void enterConstructorDeclaration(ConstructorDeclarationContext ctx) {
-    final declaratorDescriptor = _declaratorDescriptorStack.pop();
-    List<Parameter>? parameters = parseParameters(ctx);
-    final constructorGenerated = Constructor(
-        docComment: declaratorDescriptor.docComment,
-        accessModifiers: declaratorDescriptor.accessModifiers);
-    constructorGenerated.parameters = parameters ?? [];
-
-    (generatedTypes.peak() as ClassModel)
-        .constructors
-        .add(constructorGenerated);
-  }
-
-  @override
-  void exitClassDeclaration(ClassDeclarationContext ctx) {
-    _onExitDeclaration();
-  }
-
-  @override
-  void exitEnumDeclaration(EnumDeclarationContext ctx) {
-    _onExitDeclaration();
-  }
-
-  @override
-  void exitInterfaceDeclaration(InterfaceDeclarationContext ctx) {
-    _onExitDeclaration();
-  }
-
-  void _onExitDeclaration() {
-    if (_atTheTopOfTheStack()) {
-      // If we are at the top level of the class, then parsing has finalized,
-      // so we want to pop the last item of the stack and set that as the
-      // generated type.
-      generatedType = generatedTypes.pop();
-      return;
-    }
-
-    // Otherwise then we want to add this as an inner class to whoever is on top.
-    final currentGeneratedType = generatedTypes.pop();
-    var topLevelClass = generatedTypes.peak() as ClassModel;
-    if (currentGeneratedType.isClass()) {
-      topLevelClass.addClass(currentGeneratedType as ClassModel);
-    } else if (currentGeneratedType.isEnum()) {
-      topLevelClass.addEnum(currentGeneratedType as EnumModel);
-    } else {
-      topLevelClass.addInterface(currentGeneratedType as InterfaceModel);
-    }
-  }
-
-  bool _atTheTopOfTheStack() {
-    return generatedTypes.length == 1;
-  }
-}
-
-class Stack<T> {
-  final _stack = Queue<T>();
-
-  int get length => _stack.length;
-
-  bool canPop() => _stack.isNotEmpty;
-
-  void clearStack() {
-    while (_stack.isNotEmpty) {
-      _stack.removeLast();
-    }
-  }
-
-  void push(T element) {
-    _stack.addLast(element);
-  }
-
-  T pop() {
-    T lastElement = _stack.last;
-    _stack.removeLast();
-    return lastElement;
-  }
-
-  T peak() => _stack.last;
-}

package/lib/src/service/apexdoc_listener.dart

@@ -1,82 +0,0 @@
-import 'dart:convert';
-
-import 'package:apexdocs_dart/src/antlr/lib/apexdoc/ApexdocParser.dart';
-import 'package:apexdocs_dart/src/antlr/lib/apexdoc/ApexdocParserBaseListener.dart';
-import 'package:apexdocs_dart/src/model/doc_comment.dart';
-
-class ApexdocListener extends ApexdocParserBaseListener {
-  var descriptionLines = <String>[];
-
-  DocComment generatedDocComment = DocComment('');
-
-  /* Description */
-
-  @override
-  void enterDescriptionLineStart(DescriptionLineStartContext ctx) {
-    var descriptionText = ctx.text;
-    descriptionLines.add(_sanitizeLineStart(descriptionText));
-  }
-
-  @override
-  void exitDescriptionLineStart(DescriptionLineStartContext ctx) {
-    generatedDocComment.descriptionLines = descriptionLines;
-  }
-
-  /* Block tag (annotations) */
-
-  @override
-  void enterDefaultBlockTag(DefaultBlockTagContext ctx) {
-    final tagName = ctx.blockTagName().text;
-    generatedDocComment.annotations.add(DocCommentAnnotation(
-        tagName, _getContentLines(ctx.blockTagContents())));
-  }
-
-  @override
-  void enterParamBlockTag(ParamBlockTagContext ctx) {
-    final paramName = ctx.paramName().text;
-    final contentLines = _getContentLines(ctx.blockTagContents());
-    generatedDocComment.paramAnnotations
-        .add(ParamDocCommentAnnotation(paramName, contentLines));
-  }
-
-  @override
-  void enterReturnBlockTag(ReturnBlockTagContext ctx) {
-    final contentLines = _getContentLines(ctx.blockTagContents());
-    generatedDocComment.returnAnnotation =
-        ReturnDocCommentAnnotation(contentLines);
-  }
-
-  @override
-  void enterThrowsBlockTag(ThrowsBlockTagContext ctx) {
-    final exceptionName = ctx.exceptionName().text;
-    final contentLines = _getContentLines(ctx.blockTagContents());
-    generatedDocComment.throwsAnnotations
-        .add(ThrowsDocCommentAnnotation(exceptionName, contentLines));
-  }
-
-  @override
-  void enterExampleBlockTag(ExampleBlockTagContext ctx) {
-    final contentLines = _getContentLines(ctx.blockTagContents());
-    generatedDocComment.exampleAnnotation =
-        ExampleDocCommentAnnotation(contentLines);
-  }
-
-  List<String> _getContentLines(List<BlockTagContentContext> blockTagContents) {
-    final rawContent = blockTagContents.map((e) => e.text).join('');
-    return LineSplitter.split(rawContent)
-        .map((e) => _sanitizeLineStart(e))
-        .where((element) => element.isNotEmpty)
-        .toList();
-  }
-
-  String _sanitizeLineStart(String line) {
-    var sanitizedLine = line.trimLeft();
-    if (sanitizedLine.startsWith('*')) {
-      sanitizedLine = sanitizedLine.replaceFirst('*', '');
-    }
-    if (sanitizedLine.startsWith(' ')) {
-      sanitizedLine = sanitizedLine.replaceFirst(' ', '');
-    }
-    return sanitizedLine.trimRight();
-  }
-}

package/lib/src/service/parsers.dart

@@ -1,33 +0,0 @@
-import 'dart:convert';
-
-import 'package:antlr4/antlr4.dart';
-import 'package:apexdocs_dart/src/model/doc_comment.dart';
-import 'package:apexdocs_dart/src/model/types.dart';
-import 'package:apexdocs_dart/src/service/walker.dart';
-
-class ApexParser {
-  static Future<Type> parseFromPath(String path) async {
-    final input = await InputStream.fromPath(path);
-    return _parse(input);
-  }
-
-  static Type parseFromBody(String body) {
-    final input = InputStream.fromString(body);
-    return _parse(input);
-  }
-
-  static Type _parse(InputStream input) {
-    final walkerDefinition = ApexWalkerDefinition();
-    Walker.walk(input, walkerDefinition);
-    return walkerDefinition.getGeneratedApexType()!;
-  }
-}
-
-class ApexdocParser {
-  static DocComment parseFromBody(String body) {
-    var sanitizedBody = body.trimLeft().trimRight();
-    final walkerDefinition = ApexdocWalkerDefinition();
-    Walker.walk(InputStream.fromString(sanitizedBody), walkerDefinition);
-    return walkerDefinition.getGeneratedDocComment();
-  }
-}

package/lib/src/service/utils/parsing/access_modifiers_parser.dart

@@ -1,33 +0,0 @@
-List<String> getAccessModifiers(dynamic ctx) {
-  bool _hasNoVisibilityModifiers(dynamic ctx) {
-    var modifiers = _allModifiers(ctx);
-    return !modifiers.contains('private') &&
-        !modifiers.contains('public') &&
-        !modifiers.contains('global') &&
-        !modifiers.contains('protected');
-  }
-
-  var accessModifiers = [
-    // In Apex a declaration with no visibility modifier is private by default
-    if (_hasNoVisibilityModifiers(ctx)) 'private',
-    ..._allModifiers(ctx)
-  ];
-  return accessModifiers;
-}
-
-List<String> _allModifiers(dynamic ctx) {
-  String _sanitizeModifier(String modifier) {
-    var sanitizedString = modifier.replaceFirst('@', '').toLowerCase();
-    if (sanitizedString.contains('(')) {
-      sanitizedString = sanitizedString.replaceRange(
-          modifier.indexOf('(') - 1, modifier.indexOf(')'), '');
-    }
-    return sanitizedString;
-  }
-
-  return ctx
-      .modifiers()
-      .map((modifierContext) => _sanitizeModifier(modifierContext.text))
-      .toList()
-      .cast<String>();
-}

package/lib/src/service/utils/parsing/parameters_parser.dart

@@ -1,18 +0,0 @@
-import 'package:apexdocs_dart/src/model/members.dart';
-
-List<Parameter>? parseParameters(dynamic ctx) {
-  final parameters = ctx
-      .formalParameters()
-      ?.formalParameterList()
-      ?.formalParameters()
-      .map((e) => Parameter(
-          name: e.id().text,
-          type: e.typeRef().text,
-          accessModifiers: e
-              .modifiers()
-              .map((e) => e.text as String)
-              .toList()
-              .cast<String>()))
-      .toList();
-  return parameters == null ? <Parameter>[] : parameters.cast<Parameter>();
-}

package/lib/src/service/utils/parsing/parsing_utils.dart

@@ -1,2 +0,0 @@
-export 'access_modifiers_parser.dart';
-export 'parameters_parser.dart';

package/lib/src/service/walker.dart

@@ -1,82 +0,0 @@
-import 'package:antlr4/antlr4.dart';
-
-import 'package:apexdocs_dart/src/antlr/lib/apex/ApexLexer.dart';
-import 'package:apexdocs_dart/src/antlr/lib/apex/ApexParser.dart';
-import 'package:apexdocs_dart/src/antlr/lib/apexdoc/ApexdocLexer.dart';
-import 'package:apexdocs_dart/src/antlr/lib/apexdoc/ApexdocParser.dart';
-import 'package:apexdocs_dart/src/model/doc_comment.dart';
-import 'package:apexdocs_dart/src/service/apex_listener.dart';
-import 'package:apexdocs_dart/src/model/types.dart';
-
-import 'apexdoc_listener.dart';
-
-class Walker {
-  static walk(InputStream input, WalkerDefinition definition) {
-    final lexer = definition.getLexer(input);
-    final tokens = CommonTokenStream(lexer);
-    final tree = definition.initializeTree(tokens);
-    ParseTreeWalker.DEFAULT.walk(definition.getListener(), tree);
-  }
-}
-
-abstract class WalkerDefinition {
-  Lexer getLexer(InputStream input);
-
-  ParserRuleContext initializeTree(TokenStream stream);
-
-  ParseTreeListener getListener();
-}
-
-class ApexWalkerDefinition extends WalkerDefinition {
-  final ApexClassListener _listener;
-
-  ApexWalkerDefinition() : _listener = ApexClassListener();
-
-  @override
-  Lexer getLexer(InputStream input) {
-    return ApexLexer(input);
-  }
-
-  @override
-  ParserRuleContext initializeTree(TokenStream stream) {
-    final parser = ApexParser(stream);
-    parser.buildParseTree = true;
-    return parser.compilationUnit();
-  }
-
-  @override
-  ParseTreeListener getListener() {
-    return _listener;
-  }
-
-  Type? getGeneratedApexType() {
-    return _listener.generatedType;
-  }
-}
-
-class ApexdocWalkerDefinition extends WalkerDefinition {
-  final ApexdocListener _listener;
-
-  ApexdocWalkerDefinition() : _listener = ApexdocListener();
-
-  @override
-  Lexer getLexer(InputStream input) {
-    return ApexdocLexer(input);
-  }
-
-  @override
-  ParserRuleContext initializeTree(TokenStream stream) {
-    final parser = ApexdocParser(stream);
-    parser.buildParseTree = true;
-    return parser.documentation();
-  }
-
-  @override
-  ParseTreeListener getListener() {
-    return _listener;
-  }
-
-  DocComment getGeneratedDocComment() {
-    return _listener.generatedDocComment;
-  }
-}

package/pubspec.yaml

@@ -1,19 +0,0 @@
-name: apexdocs_dart
-description: A starting point for Dart libraries or applications.
-version: 1.0.0
-publish_to: none
-
-environment:
-    sdk: '>=2.14.1 <3.0.0'
-
-dev_dependencies:
-    lints: ^1.0.0
-    test: ^1.16.5
-    js: ^0.6.3
-    build_runner: ^1.11.5
-    json_serializable: ^4.0.2
-    grinder: ^0.9.0
-dependencies:
-    antlr4:
-        path: antlr4-4.9.2
-    json_annotation: ^4.0.1

package/test/apex_file_manifest_test.dart

@@ -1,16 +0,0 @@
-import 'dart:convert';
-
-import 'package:apexdocs_dart/src/model/apex_file_manifest.dart';
-import 'package:apexdocs_dart/src/model/types.dart';
-import 'package:apexdocs_dart/src/service/parsers.dart';
-import 'package:test/test.dart';
-
-main() {
-  test('Can serialize and deserialize from object', () {
-    var classModel = ClassModel(name: 'ClassName');
-    var manifest = ApexFileManifest([classModel]);
-    final manifestAsJson = jsonEncode(manifest);
-    var decodedManifest = ApexFileManifest.fromJson(jsonDecode(manifestAsJson));
-    expect(decodedManifest.generatedTypes.length, equals(1));
-  });
-}