Merge pull request #221 from jqassistant-plugin/feature/source-providers

SebastianWendorf · web-flow · commit 8c3d13b70981 · 2025-04-28T14:23:28.000+02:00
Add Source Providers
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/ClassDeclarationDescriptor.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/ClassDeclarationDescriptor.java
@@ -2,10 +2,12 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import org.jqassistant.plugin.typescript.api.report.TypeScript;
 
 import java.util.List;
 
 @Label("Class")
+@TypeScript(TypeScript.TypeScriptElement.ClassDeclaration)
 public interface ClassDeclarationDescriptor extends TypeScriptDescriptor, LocalGlobalFqnDescriptor, CodeCoordinateDescriptor {
 
     String getName();
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/ConstructorDeclarationDescriptor.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/ConstructorDeclarationDescriptor.java
@@ -2,10 +2,12 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import org.jqassistant.plugin.typescript.api.report.TypeScript;
 
 import java.util.List;
 
 @Label("Constructor")
+@TypeScript(TypeScript.TypeScriptElement.ConstructorDeclaration)
 public interface ConstructorDeclarationDescriptor extends TypeScriptDescriptor, LocalGlobalFqnDescriptor, CodeCoordinateDescriptor {
 
     @Relation("HAS")
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/EnumDeclarationDescriptor.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/EnumDeclarationDescriptor.java
@@ -2,10 +2,12 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import org.jqassistant.plugin.typescript.api.report.TypeScript;
 
 import java.util.List;
 
 @Label("Enum")
+@TypeScript(TypeScript.TypeScriptElement.EnumDeclaration)
 public interface EnumDeclarationDescriptor extends TypeScriptDescriptor, CodeCoordinateDescriptor, LocalGlobalFqnDescriptor {
 
     String getName();
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/EnumMemberDescriptor.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/EnumMemberDescriptor.java
@@ -2,8 +2,10 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import org.jqassistant.plugin.typescript.api.report.TypeScript;
 
 @Label("EnumMember")
+@TypeScript(TypeScript.TypeScriptElement.EnumMember)
 public interface EnumMemberDescriptor extends TypeScriptDescriptor, LocalGlobalFqnDescriptor, CodeCoordinateDescriptor {
 
     String getName();
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/FunctionDeclarationDescriptor.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/FunctionDeclarationDescriptor.java
@@ -2,10 +2,12 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import org.jqassistant.plugin.typescript.api.report.TypeScript;
 
 import java.util.List;
 
 @Label("Function")
+@TypeScript(TypeScript.TypeScriptElement.FunctionDeclaration)
 public interface FunctionDeclarationDescriptor extends TypeScriptDescriptor, LocalGlobalFqnDescriptor, CodeCoordinateDescriptor {
 
     String getName();
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/InterfaceDeclarationDescriptor.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/InterfaceDeclarationDescriptor.java
@@ -2,10 +2,12 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import org.jqassistant.plugin.typescript.api.report.TypeScript;
 
 import java.util.List;
 
 @Label("Interface")
+@TypeScript(TypeScript.TypeScriptElement.InterfaceDeclaration)
 public interface InterfaceDeclarationDescriptor extends TypeScriptDescriptor, LocalGlobalFqnDescriptor, CodeCoordinateDescriptor {
 
     String getName();
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/MethodDeclarationDescriptor.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/MethodDeclarationDescriptor.java
@@ -2,10 +2,12 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import org.jqassistant.plugin.typescript.api.report.TypeScript;
 
 import java.util.List;
 
 @Label("Method")
+@TypeScript(TypeScript.TypeScriptElement.MethodDeclaration)
 public interface MethodDeclarationDescriptor extends TypeScriptDescriptor, LocalGlobalFqnDescriptor, CodeCoordinateDescriptor {
 
     String getName();
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/ModuleDescriptor.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/ModuleDescriptor.java
@@ -2,10 +2,12 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import org.jqassistant.plugin.typescript.api.report.TypeScript;
 
 import java.util.List;
 
 @Label("Module")
+@TypeScript(TypeScript.TypeScriptElement.Module)
 public interface ModuleDescriptor extends TypeScriptDescriptor, LocalGlobalFqnDescriptor {
 
     @Relation("DECLARES")
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/ParameterDeclarationDescriptor.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/ParameterDeclarationDescriptor.java
@@ -2,10 +2,12 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import org.jqassistant.plugin.typescript.api.report.TypeScript;
 
 import java.util.List;
 
 @Label("Parameter")
+@TypeScript(TypeScript.TypeScriptElement.ParameterDeclaration)
 public interface ParameterDeclarationDescriptor extends TypeScriptDescriptor, CodeCoordinateDescriptor {
 
     Integer getIndex();
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/PropertyDeclarationDescriptor.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/PropertyDeclarationDescriptor.java
@@ -2,10 +2,12 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import org.jqassistant.plugin.typescript.api.report.TypeScript;
 
 import java.util.List;
 
 @Label("Property")
+@TypeScript(TypeScript.TypeScriptElement.PropertyDeclaration)
 public interface PropertyDeclarationDescriptor extends TypeScriptDescriptor, LocalGlobalFqnDescriptor, CodeCoordinateDescriptor {
 
     String getName();
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/TypeAliasDeclarationDescriptor.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/TypeAliasDeclarationDescriptor.java
@@ -2,10 +2,12 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import org.jqassistant.plugin.typescript.api.report.TypeScript;
 
 import java.util.List;
 
 @Label("TypeAlias")
+@TypeScript(TypeScript.TypeScriptElement.TypeAliasDeclaration)
 public interface TypeAliasDeclarationDescriptor extends TypeScriptDescriptor, LocalGlobalFqnDescriptor, CodeCoordinateDescriptor {
 
     String getName();
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/VariableDeclarationDescriptor.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/model/core/VariableDeclarationDescriptor.java
@@ -2,8 +2,10 @@
 
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import org.jqassistant.plugin.typescript.api.report.TypeScript;
 
 @Label("Variable")
+@TypeScript(TypeScript.TypeScriptElement.VariableDeclaration)
 public interface VariableDeclarationDescriptor extends TypeScriptDescriptor, LocalGlobalFqnDescriptor, CodeCoordinateDescriptor {
 
     String getName();
diff --git a/java/src/main/java/org/jqassistant/plugin/typescript/api/report/TypeScript.java b/java/src/main/java/org/jqassistant/plugin/typescript/api/report/TypeScript.java
@@ -0,0 +1,236 @@
+package org.jqassistant.plugin.typescript.api.report;
+
+import com.buschmais.jqassistant.core.report.api.SourceProvider;
+import com.buschmais.jqassistant.core.report.api.model.Language;
+import com.buschmais.jqassistant.core.report.api.model.LanguageElement;
+import com.buschmais.jqassistant.core.report.api.model.source.FileLocation;
+import org.jqassistant.plugin.typescript.api.model.core.*;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+import java.util.Optional;
+
+/**
+ * Defines the language elements for "TypeScript".
+ */
+@Language
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.TYPE)
+public @interface TypeScript {
+
+    TypeScriptElement value();
+
+    enum TypeScriptElement implements LanguageElement {
+        Module {
+            @Override
+            public SourceProvider<ModuleDescriptor> getSourceProvider() {
+                return new SourceProvider<>() {
+                    @Override
+                    public String getName(ModuleDescriptor descriptor) {
+                        return descriptor.getLocalFqn();
+                    }
+
+                    @Override
+                    public Optional<FileLocation> getSourceLocation(ModuleDescriptor descriptor) {
+                        FileLocation.FileLocationBuilder builder = FileLocation.builder();
+                        builder.fileName(descriptor.getGlobalFqn());
+                        return Optional.of(builder.build());
+                    }
+                };
+            }
+        },
+        TypeAliasDeclaration {
+            @Override
+            public SourceProvider<TypeAliasDeclarationDescriptor> getSourceProvider() {
+                return new SourceProvider<>() {
+                    @Override
+                    public String getName(TypeAliasDeclarationDescriptor descriptor) {
+                        return descriptor.getLocalFqn();
+                    }
+
+                    @Override
+                    public Optional<FileLocation> getSourceLocation(TypeAliasDeclarationDescriptor descriptor) {
+                        return TypeScriptElement.getCodeCoordinateFileLocation(descriptor);
+                    }
+                };
+            }
+        },
+        ClassDeclaration {
+            @Override
+            public SourceProvider<ClassDeclarationDescriptor> getSourceProvider() {
+                return new SourceProvider<>() {
+                    @Override
+                    public String getName(ClassDeclarationDescriptor descriptor) {
+                        return descriptor.getLocalFqn();
+                    }
+
+                    @Override
+                    public Optional<FileLocation> getSourceLocation(ClassDeclarationDescriptor descriptor) {
+                        return TypeScriptElement.getCodeCoordinateFileLocation(descriptor);
+                    }
+                };
+            }
+        },
+        ConstructorDeclaration {
+            @Override
+            public SourceProvider<ConstructorDeclarationDescriptor> getSourceProvider() {
+                return new SourceProvider<>() {
+                    @Override
+                    public String getName(ConstructorDeclarationDescriptor descriptor) {
+                        return descriptor.getLocalFqn();
+                    }
+
+                    @Override
+                    public Optional<FileLocation> getSourceLocation(ConstructorDeclarationDescriptor descriptor) {
+                        return TypeScriptElement.getCodeCoordinateFileLocation(descriptor);
+                    }
+                };
+            }
+        },
+        MethodDeclaration {
+            @Override
+            public SourceProvider<MethodDeclarationDescriptor> getSourceProvider() {
+                return new SourceProvider<>() {
+                    @Override
+                    public String getName(MethodDeclarationDescriptor descriptor) {
+                        return descriptor.getLocalFqn();
+                    }
+
+                    @Override
+                    public Optional<FileLocation> getSourceLocation(MethodDeclarationDescriptor descriptor) {
+                        return TypeScriptElement.getCodeCoordinateFileLocation(descriptor);
+                    }
+                };
+            }
+        },
+        PropertyDeclaration {
+            @Override
+            public SourceProvider<PropertyDeclarationDescriptor> getSourceProvider() {
+                return new SourceProvider<>() {
+                    @Override
+                    public String getName(PropertyDeclarationDescriptor descriptor) {
+                        return descriptor.getLocalFqn();
+                    }
+
+                    @Override
+                    public Optional<FileLocation> getSourceLocation(PropertyDeclarationDescriptor descriptor) {
+                        return TypeScriptElement.getCodeCoordinateFileLocation(descriptor);
+                    }
+                };
+            }
+        },
+        // TODO: Add Source Location Support for Accessors (requires reference to AccessorProperty from Getter/Setter/AutoAccessor)
+        ParameterDeclaration {
+            @Override
+            public SourceProvider<ParameterDeclarationDescriptor> getSourceProvider() {
+                return new SourceProvider<>() {
+                    @Override
+                    public String getName(ParameterDeclarationDescriptor descriptor) {
+                        // TODO: Add information about containing construct
+                        return descriptor.getName();
+                    }
+
+                    @Override
+                    public Optional<FileLocation> getSourceLocation(ParameterDeclarationDescriptor descriptor) {
+                        return TypeScriptElement.getCodeCoordinateFileLocation(descriptor);
+                    }
+                };
+            }
+        },
+        InterfaceDeclaration {
+            @Override
+            public SourceProvider<InterfaceDeclarationDescriptor> getSourceProvider() {
+                return new SourceProvider<>() {
+                    @Override
+                    public String getName(InterfaceDeclarationDescriptor descriptor) {
+                        return descriptor.getLocalFqn();
+                    }
+
+                    @Override
+                    public Optional<FileLocation> getSourceLocation(InterfaceDeclarationDescriptor descriptor) {
+                        return TypeScriptElement.getCodeCoordinateFileLocation(descriptor);
+                    }
+                };
+            }
+        },
+        EnumDeclaration {
+            @Override
+            public SourceProvider<EnumDeclarationDescriptor> getSourceProvider() {
+                return new SourceProvider<>() {
+                    @Override
+                    public String getName(EnumDeclarationDescriptor descriptor) {
+                        return descriptor.getLocalFqn();
+                    }
+
+                    @Override
+                    public Optional<FileLocation> getSourceLocation(EnumDeclarationDescriptor descriptor) {
+                        return TypeScriptElement.getCodeCoordinateFileLocation(descriptor);
+                    }
+                };
+            }
+        },
+        EnumMember {
+            @Override
+            public SourceProvider<EnumMemberDescriptor> getSourceProvider() {
+                return new SourceProvider<>() {
+                    @Override
+                    public String getName(EnumMemberDescriptor descriptor) {
+                        return descriptor.getLocalFqn();
+                    }
+
+                    @Override
+                    public Optional<FileLocation> getSourceLocation(EnumMemberDescriptor descriptor) {
+                        return TypeScriptElement.getCodeCoordinateFileLocation(descriptor);
+                    }
+                };
+            }
+        },
+        FunctionDeclaration {
+            @Override
+            public SourceProvider<FunctionDeclarationDescriptor> getSourceProvider() {
+                return new SourceProvider<>() {
+                    @Override
+                    public String getName(FunctionDeclarationDescriptor descriptor) {
+                        return descriptor.getLocalFqn();
+                    }
+
+                    @Override
+                    public Optional<FileLocation> getSourceLocation(FunctionDeclarationDescriptor descriptor) {
+                        return TypeScriptElement.getCodeCoordinateFileLocation(descriptor);
+                    }
+                };
+            }
+        },
+        VariableDeclaration {
+            @Override
+            public SourceProvider<VariableDeclarationDescriptor> getSourceProvider() {
+                return new SourceProvider<>() {
+                    @Override
+                    public String getName(VariableDeclarationDescriptor descriptor) {
+                        return descriptor.getLocalFqn();
+                    }
+
+                    @Override
+                    public Optional<FileLocation> getSourceLocation(VariableDeclarationDescriptor descriptor) {
+                        return TypeScriptElement.getCodeCoordinateFileLocation(descriptor);
+                    }
+                };
+            }
+        };
+
+        @Override
+        public String getLanguage() {
+            return "TypeScript";
+        }
+
+        private static Optional<FileLocation> getCodeCoordinateFileLocation(CodeCoordinateDescriptor descriptor) {
+            FileLocation.FileLocationBuilder builder = FileLocation.builder();
+            builder.fileName(descriptor.getFileName());
+            builder.startLine(Optional.of(descriptor.getStartLine()));
+            builder.endLine(Optional.of(descriptor.getEndLine()));
+            return Optional.of(builder.build());
+        }
+    }
+}
