Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement possibility to specify custom prefix for page object templates #2

Merged
merged 1 commit into from
Dec 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .run/Debug_ Attach to JVM method.run.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="Debug: Attach to JVM method" type="Remote">
<module name="podegen-core" />
<option name="USE_SOCKET_TRANSPORT" value="true" />
<option name="SERVER_MODE" value="false" />
<option name="SHMEM_ADDRESS" />
<option name="HOST" value="localhost" />
<option name="PORT" value="8005" />
<option name="AUTO_RESTART" value="false" />
<RunnerSettings RunnerId="Debug">
<option name="DEBUG_PORT" value="8005" />
<option name="LOCAL" value="false" />
</RunnerSettings>
<method v="2" />
</configuration>
</component>
12 changes: 12 additions & 0 deletions .run/Debug_ Listen to JVM method.run.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<component name="ProjectRunConfigurationManager">
<configuration default="false" name="Debug: Listen to JVM method" type="Remote">
<module name="podegen" />
<option name="USE_SOCKET_TRANSPORT" value="true" />
<option name="SERVER_MODE" value="true" />
<option name="SHMEM_ADDRESS" />
<option name="HOST" value="localhost" />
<option name="PORT" value="8005" />
<option name="AUTO_RESTART" value="false" />
<method v="2" />
</configuration>
</component>

This file was deleted.

This file was deleted.

28 changes: 21 additions & 7 deletions core/pom.xml → podegen-core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,27 @@
</parent>
<modelVersion>4.0.0</modelVersion>

<artifactId>core</artifactId>
<artifactId>podegen-core</artifactId>
<packaging>jar</packaging>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.6.1</version>
<configuration>
<compilerArgs>
<arg>--add-exports</arg>
<arg>jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED</arg>
<arg>--add-exports</arg>
<arg>jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED</arg>
</compilerArgs>
</configuration>
</plugin>
</plugins>
</build>

<properties>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

<dependencies>
<dependency>
Expand All @@ -31,7 +45,7 @@
<dependency>
<groupId>com.fasterxml.jackson.dataformat</groupId>
<artifactId>jackson-dataformat-yaml</artifactId>
<version>2.14.2</version>
<version>2.16.0</version>
</dependency>
<dependency>
<groupId>com.squareup</groupId>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
package com.github.kotvertolet.podegen;
package com.github.kotvertolet.podegen.core;

import com.github.kotvertolet.podegen.annotations.PageObject;
import com.github.kotvertolet.podegen.builder.CodeGeneratorBuilder;
import com.github.kotvertolet.podegen.data.PageObjectTemplate;
import com.github.kotvertolet.podegen.data.enums.Extension;
import com.github.kotvertolet.podegen.parsers.JsonParser;
import com.github.kotvertolet.podegen.parsers.Parser;
import com.github.kotvertolet.podegen.parsers.YamlParser;
import com.github.kotvertolet.podegen.utils.Config;
import com.github.kotvertolet.podegen.core.annotations.PageObject;
import com.github.kotvertolet.podegen.core.builder.CodeGeneratorBuilder;
import com.github.kotvertolet.podegen.core.data.PageObjectTemplate;
import com.github.kotvertolet.podegen.core.data.enums.Extension;
import com.github.kotvertolet.podegen.core.parsers.JsonParser;
import com.github.kotvertolet.podegen.core.parsers.Parser;
import com.github.kotvertolet.podegen.core.parsers.YamlParser;
import com.github.kotvertolet.podegen.core.utils.Config;
import com.google.auto.service.AutoService;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.TypeSpec;
Expand All @@ -24,16 +24,14 @@
import java.io.IOException;
import java.util.Set;


@SupportedSourceVersion(SourceVersion.RELEASE_17)
@SupportedAnnotationTypes({
"com.github.kotvertolet.podegen.annotations.PageObject"
"com.github.kotvertolet.podegen.core.annotations.PageObject"
})
@AutoService(javax.annotation.processing.Processor.class)
public class Processor extends AbstractProcessor {

public final static String SUPPORTED_FILE_PREFIX = "POGE_";
public final static String SUPPORTED_FORMATS_PATTERN = "(\\.yaml|\\.yml|\\.json)";
public final static String POGE_FILES_PATTERN = String.format("^.*(%s.*%s)", SUPPORTED_FILE_PREFIX, SUPPORTED_FORMATS_PATTERN);
private Types typeUtils;
private Elements elementUtils;
private Filer filer;
Expand All @@ -53,27 +51,30 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
var annotationsSet = roundEnv.getElementsAnnotatedWith(PageObject.class);
if (!annotationsSet.isEmpty()) {
if (annotationsSet.size() > 1) {
throw new RuntimeException("More than one PageObject annotations aren't allowed");
throw new Error("More than one PageObject annotations aren't allowed");
}
Config.initConfig(annotationsSet.stream().findAny().get().getAnnotation(PageObject.class));

ScanResult scanResult = new ClassGraph().acceptModules().disableJarScanning().disableNestedJarScanning()
.disableRuntimeInvisibleAnnotations().scan();
Config.initConfig(annotationsSet.stream().findAny().get());
ScanResult scanResult = new ClassGraph()
.acceptModules()
.disableJarScanning()
.disableNestedJarScanning()
.scan();
try (scanResult) {
scanForPodegenFiles(scanResult).stream().map(this::processPageObjTemplateFile).forEach(this::generateCode);
searchForPageObjectTemplateFiles(scanResult).stream().map(this::processPageObjTemplateFile).forEach(this::generateCode);
}
return true;
}
return false;
}

private ResourceList scanForPodegenFiles(ScanResult scanResult) {
private ResourceList searchForPageObjectTemplateFiles(ScanResult scanResult) {
ResourceList rawPageFiles = scanResult.getAllResources().filter(resource ->
resource.getPath().matches(POGE_FILES_PATTERN));
resource.getPath().matches(Config.getInstance().getSupportedFilesPattern())
);
if (!rawPageFiles.isEmpty()) {
return rawPageFiles;
} else {
throw new RuntimeException("No suitable page object files were found");
throw new Error("No suitable page object template files were found");
}
}

Expand All @@ -85,7 +86,7 @@ private void generateCode(PageObjectTemplate pageObjectTemplate) {
.addPageObjectTemplate(pageObjectTemplate)
.generateCode();
try {
JavaFile.builder(this.getClass().getPackageName() + "." + pageObjectTemplate.packages(), pageObjectClass)
JavaFile.builder(conf.getOwnerPackage() + "." + pageObjectTemplate.packages(), pageObjectClass)
.build()
.writeTo(filer);
} catch (IOException e) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package com.github.kotvertolet.podegen.annotations;
package com.github.kotvertolet.podegen.core.annotations;

import com.github.kotvertolet.podegen.data.enums.Flavours;
import com.github.kotvertolet.podegen.data.enums.Strategies;
import com.github.kotvertolet.podegen.core.data.enums.Flavours;
import com.github.kotvertolet.podegen.core.data.enums.Strategies;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
Expand All @@ -16,4 +16,6 @@

Strategies strategy() default Strategies.PageFactory;

String prefix() default "";

}
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package com.github.kotvertolet.podegen.builder;
package com.github.kotvertolet.podegen.core.builder;

import com.github.kotvertolet.podegen.data.PageObjectTemplate;
import com.github.kotvertolet.podegen.flavours.Flavourable;
import com.github.kotvertolet.podegen.strategies.Strategy;
import com.github.kotvertolet.podegen.core.data.PageObjectTemplate;
import com.github.kotvertolet.podegen.core.flavours.Flavourable;
import com.github.kotvertolet.podegen.core.strategies.Strategy;
import com.squareup.javapoet.TypeSpec;

import java.lang.reflect.InvocationTargetException;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package com.github.kotvertolet.podegen.data;
package com.github.kotvertolet.podegen.core.data;


import com.github.kotvertolet.podegen.data.enums.LocatorType;
import com.github.kotvertolet.podegen.core.data.enums.LocatorType;

import java.util.Objects;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.github.kotvertolet.podegen.data;
package com.github.kotvertolet.podegen.core.data;

import java.util.List;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.github.kotvertolet.podegen.data.enums;
package com.github.kotvertolet.podegen.core.data.enums;

import java.util.HashMap;
import java.util.Map;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package com.github.kotvertolet.podegen.data.enums;
package com.github.kotvertolet.podegen.core.data.enums;

import com.github.kotvertolet.podegen.flavours.Flavourable;
import com.github.kotvertolet.podegen.flavours.SelenideFlavour;
import com.github.kotvertolet.podegen.flavours.SeleniumFlavour;
import com.github.kotvertolet.podegen.core.flavours.Flavourable;
import com.github.kotvertolet.podegen.core.flavours.SelenideFlavour;
import com.github.kotvertolet.podegen.core.flavours.SeleniumFlavour;

public enum Flavours {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.github.kotvertolet.podegen.data.enums;
package com.github.kotvertolet.podegen.core.data.enums;

import java.util.HashMap;
import java.util.Map;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
package com.github.kotvertolet.podegen.data.enums;
package com.github.kotvertolet.podegen.core.data.enums;

import com.github.kotvertolet.podegen.strategies.PageFactoryStrategy;
import com.github.kotvertolet.podegen.strategies.PageObjectStrategy;
import com.github.kotvertolet.podegen.strategies.Strategy;
import com.github.kotvertolet.podegen.core.strategies.PageFactoryStrategy;
import com.github.kotvertolet.podegen.core.strategies.PageObjectStrategy;
import com.github.kotvertolet.podegen.core.strategies.Strategy;

public enum Strategies {

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.github.kotvertolet.podegen.flavours;
package com.github.kotvertolet.podegen.core.flavours;

import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.TypeName;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.github.kotvertolet.podegen.flavours;
package com.github.kotvertolet.podegen.core.flavours;

import com.codeborne.selenide.ElementsCollection;
import com.codeborne.selenide.SelenideElement;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package com.github.kotvertolet.podegen.flavours;
package com.github.kotvertolet.podegen.core.flavours;

import com.squareup.javapoet.ClassName;
import com.squareup.javapoet.ParameterizedTypeName;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
package com.github.kotvertolet.podegen.parsers;
package com.github.kotvertolet.podegen.core.parsers;

import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.databind.node.ArrayNode;
import com.github.kotvertolet.podegen.data.Element;
import com.github.kotvertolet.podegen.data.PageObjectTemplate;
import com.github.kotvertolet.podegen.data.enums.LocatorType;
import com.github.kotvertolet.podegen.utils.Path;
import com.github.kotvertolet.podegen.core.data.Element;
import com.github.kotvertolet.podegen.core.data.PageObjectTemplate;
import com.github.kotvertolet.podegen.core.data.enums.LocatorType;
import com.github.kotvertolet.podegen.core.utils.PathUtils;
import io.github.classgraph.Resource;

import java.io.IOException;
Expand All @@ -20,16 +20,16 @@
public class JsonParser extends JsonDeserializer<List> implements Parser {
@Override
public PageObjectTemplate parse(Resource resource) {
Path path = new Path(resource.getPath());
PathUtils pathUtils = new PathUtils(resource.getPath());
List<Element> elementList;
try {
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.registerModule(new SimpleModule().addDeserializer(List.class, this));
elementList = objectMapper.readValue(resource.getContentAsString(), List.class);
} catch (IOException e) {
throw new RuntimeException(e);
throw new Error(e);
}
return new PageObjectTemplate(path.getClassName(), path.getPackage(), elementList);
return new PageObjectTemplate(pathUtils.getClassName(), pathUtils.getPackage(), elementList);
}

@Override
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package com.github.kotvertolet.podegen.core.parsers;

import com.github.kotvertolet.podegen.core.data.PageObjectTemplate;
import io.github.classgraph.Resource;

public interface Parser {

PageObjectTemplate parse(Resource resource);
}
Loading