add README, remove logs and update/create workflow

Author: m.r

.github/workflows/build.yaml

@@ -25,7 +25,7 @@ jobs:
  uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0
 
  - name: Build with Gradle
- run: ./gradlew build
+ run: ./gradlew -b build-github.gradle build
 
  - name: Upload build artifacts
  uses: actions/upload-artifact@v4

.github/workflows/gradle-publish.yml

@@ -0,0 +1,49 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will build a package using Gradle and then publish it to GitHub packages when a release is created
+# For more information see: https://github.com/actions/setup-java/blob/main/docs/advanced-usage.md#Publishing-using-gradle
+
+name: Manually Gradle Package
+on:
+ workflow_dispatch:
+ inputs:
+ branch:
+ description: 'Test Branch'
+ required: true
+ default: 'main'
+
+jobs:
+ build:
+
+ runs-on: ubuntu-latest
+ permissions:
+ contents: read
+ packages: write
+
+ steps:
+ - uses: actions/checkout@v4
+ - name: Set up JDK 11
+ uses: actions/setup-java@v4
+ with:
+ java-version: '11'
+ distribution: 'temurin'
+ server-id: github # Value of the distributionManagement/repository/id field of the pom.xml
+ settings-path: ${{ github.workspace }} # location for the settings.xml file
+
+ # - name: Setup Gradle
+ # uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0
+ - name: Setup Gradle
+ uses: gradle/actions/setup-gradle@v4
+
+ - name: Build with Gradle
+ run: ./gradlew -b build-github.gradle build
+
+ # The USERNAME and TOKEN need to correspond to the credentials environment variables used in
+ # the publishing section of your build.gradle
+ - name: Publish to GitHub Packages
+ run: ./gradlew -b build-github.gradle publish
+ env:
+ USERNAME: ${{ github.actor }}
+ TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -0,0 +1,89 @@
+# MR Excel
+
+MR Excel is a tool for generating Excel files. The implementation of this library is similar to ["`MR Excel JavaScript`"](https://github.com/mohammadrezaeicode/mr-excel-repo). You can use the documentation from that repository for reference. [example](https://github.com/mohammadrezaeicode/mr-excel-java-example-gallery) Requirement:**`JDK 11+`**
+
+## Related Projects
+
+The following list includes new repositories related to this project. Documentation and improvements for these projects can be found in the repositories below.
+
+- **`MR Excel Java`**:A similar project using Java is in development. The release version is coming soon; currently, it is available as a snapshot version.["`repository`"](https://github.com/mohammadrezaeicode/mr-excel-java)
+
+- **`MR Excel Editor`**: An editor that utilizes the library is currently under development. At present, it only generates simple results.["`repository`"](https:///github.com/mohammadrezaeicode/mr-excel-editor)["`Demo`"](https://mohammadrezaeicode.github.io/mr-excel-editor/)
+
+## Import in `Maven` project
+
+To use the dependency, follow the structure below:
+
+1. `Generate a GitHub token` with access to `read:packages` and add the server to `~/.m2/setting.xml`. You can find the exact structure in this [link](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-with-a-personal-access-token).
+
+```xml
+<servers>
+ <server>
+ <id></id>
+ <username></username>
+ <password></password>
+ </server>
+</servers>
+```
+
+2. Add the repository to your `pom.xml` file:
+
+```xml
+<repositories>
+ <repository>
+ <id>github</id>
+ <url>https://maven.pkg.github.com/mohammadrezaeicode/excel</url>
+ <releases>
+ <enabled>true</enabled>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </repository>
+</repositories>
+```
+
+3. Add the library to your `dependencies`:
+
+```xml
+<dependency>
+ <groupId>io.github.mohammadrezaeicode</groupId>
+ <artifactId>excel</artifactId>
+ <version>0.1-SNAPSHOT</version>
+</dependency>
+```
+
+## Import in `Gradle` project
+
+To use the dependency, follow the structure below:
+
+1. **Generate a GitHub token** with access to `read:packages` and configure your `~/.gradle/gradle.properties` file:
+
+```properties
+gpr.user=YOUR_GITHUB_USERNAME
+gpr.token=YOUR_GITHUB_TOKEN
+```
+
+2. **Add the repository to your `build.gradle` file**:
+
+```groovy
+repositories {
+ maven {
+ url = uri("https://maven.pkg.github.com/mohammadrezaeicode/excel")
+ credentials {
+ username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
+ password = project.findProperty("gpr.token") ?: System.getenv("TOKEN")
+ }
+ }
+}
+```
+
+3. **Add the library to your dependencies**:
+
+```groovy
+dependencies {
+ implementation 'io.github.mohammadrezaeicode:excel:0.1-SNAPSHOT'
+}
+```
+
+

build-github.gradle

@@ -0,0 +1,97 @@
+plugins {
+ id 'java-library'
+ id 'maven-publish'
+
+}
+compileJava {
+ options.encoding = "UTF-8"
+}
+compileTestJava {options.encoding = "UTF-8"}
+
+
+group = 'io.github.mohammadrezaeicode'
+version = '0.1-SNAPSHOT'
+
+java {
+ withJavadocJar()
+ withSourcesJar()
+}
+
+repositories {
+ mavenCentral()
+}
+
+dependencies {
+ testImplementation platform('org.junit:junit-bom:5.9.1')
+ testImplementation 'org.junit.jupiter:junit-jupiter'
+ testImplementation 'org.junit.jupiter:junit-jupiter:5.8.1'
+ testImplementation 'org.junit.jupiter:junit-jupiter:5.8.1'
+ compileOnly 'org.projectlombok:lombok:1.18.36'
+ annotationProcessor 'org.projectlombok:lombok:1.18.36'
+}
+
+publishing {
+ publications {
+ gpr(MavenPublication) {
+ artifactId = "excel"
+ from components.java
+ versionMapping {
+ usage('java-api') {
+ fromResolutionOf('runtimeClasspath')
+ }
+ usage('java-runtime') {
+ fromResolutionResult()
+ }
+ }
+ pom {
+ name = 'MR Excel'
+ description = 'A versatile Java library for effortlessly generating .xlsx files from input objects. Seamlessly create Excel spreadsheets with data, formatting, formulas, and more.'
+ url = 'https://github.com/mohammadrezaeicode/mr-excel-java'
+// properties = [
+// myProp: "value",
+// "prop.with.dots": "anotherValue"
+// ]
+ licenses {
+ license {
+ name = 'The Apache License, Version 2.0'
+ url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+ }
+ }
+ developers {
+ developer {
+ id = 'MohammadR'
+ name = 'Mohammad Rezaei'
+ email = 'mohammadrezaeicode@gmail.com'
+ }
+ }
+ scm {
+ connection = 'scm:git:https://github.com/mohammadrezaeicode/mr-excel-java.git'
+ developerConnection = 'scm:git:git@github.com:mohammadrezaeicode/mr-excel-java.git'
+ url = 'https://github.com/mohammadrezaeicode/mr-excel-java'
+ }
+ repositories {
+ maven {
+ name = "GitHubPackages"
+ url = uri("https://maven.pkg.github.com/mohammadrezaeicode/mr-excel-java") // replace OWNER and REPOSITORY with your GitHub username and your repository name
+ credentials {
+ username = project.findProperty("gpr.user") ?: System.getenv("USERNAME")
+ password = project.findProperty("gpr.key") ?: System.getenv("TOKEN")
+ }
+ }
+ }
+ }
+ }
+ }
+}
+
+test {
+ useJUnitPlatform()
+}
+tasks.withType(JavaCompile) {
+ options.encoding = 'UTF-8'
+}
+javadoc {
+ if(JavaVersion.current().isJava9Compatible()) {
+ options.addBooleanOption('html5', true)
+ }
+}

src/main/java/io/github/mohammadrezaeicode/excel/Main.java

@@ -13,7 +13,6 @@
 
 public class Main {
  public static void main(String[] args) throws IOException, InvocationTargetException, IllegalAccessException {
- System.out.println(Optional.ofNullable(null).isPresent());
 
 // ExcelTable1 excelTable1= ExcelTable1.builder()
 // .sheet(Arrays.asList(

src/main/java/io/github/mohammadrezaeicode/excel/function/GenerateExcel.java

@@ -26,7 +26,7 @@
 import static io.github.mohammadrezaeicode.excel.util.CommentUtil.commentConvertor;
 
 public class GenerateExcel {
- public static <T> Result generateHeaderAndGenerateExcel(List<SheetGenerator<T>> sheetData, ExcelTableOption options) throws InvocationTargetException, IllegalAccessException, IOException {
+ public static <T> Result generateHeaderAndGenerateExcel(List<SheetGenerator<T>> sheetData, ExcelTableOption options) throws InvocationTargetException, IllegalAccessException, IOException, NoSuchMethodException {
  List<Sheet1> sheetList = new ArrayList<>();
  for (SheetGenerator<T> sheet : sheetData) {
  sheetList.add(SheetGeneratorUtils.generateSheet(sheet.getData(), sheet.getHeaderClass(), sheet.getApplyHeaderOptionFunction()));
@@ -42,7 +42,7 @@ public static <T> Result generateHeaderAndGenerateExcel(List<SheetGenerator<T>>
  return generateExcel(exOb, "");
  }
 
- public static <T> Result generateHeaderAndGenerateExcel(List<T> data, ExcelTableOption options, Class headerClass, Function<List<Header>, List<Header>> applyHeaderOptionFunction) throws InvocationTargetException, IllegalAccessException, IOException {
+ public static <T> Result generateHeaderAndGenerateExcel(List<T> data, ExcelTableOption options, Class headerClass, Function<List<Header>, List<Header>> applyHeaderOptionFunction) throws InvocationTargetException, IllegalAccessException, IOException, NoSuchMethodException {
  var exOb = ExcelTable1.builder()
  .sheet(
  Collections.singletonList(SheetGeneratorUtils.<T>generateSheet(data, headerClass, applyHeaderOptionFunction))

src/main/java/io/github/mohammadrezaeicode/excel/util/ColumnUtils.java

@@ -13,12 +13,8 @@ public static ShapeRC getColRowBaseOnRefString(
  List<String> cols
  ){
  String column = refString.replaceAll("[0-9]", "");
- int row = 0;
- try {
- row= Integer.parseInt(refString.substring(column.length()));
- }catch (NumberFormatException exception){
- System.out.println("");
- }
+ int row = Integer.parseInt(refString.substring(column.length()));
+
  row = Math.max(0, row - 1);
  int colIndex = cols.indexOf(column);
  if (colIndex < 0) {

src/main/java/io/github/mohammadrezaeicode/excel/util/Process.java

@@ -12,14 +12,11 @@
 import java.util.List;
 
 public class Process {
- public static List<Header> findAnnotation(Class headerClass) {
+ public static List<Header> findAnnotation(Class headerClass) throws NoSuchMethodException, SecurityException {
  Class<? extends Object> cls = headerClass;
  List<Field> presentField = new ArrayList<>();
  List<String> textName = new ArrayList<>();
  List<String> methodName = new ArrayList<>();
- Method[] methods = cls.getDeclaredMethods();
- System.out.println(methods.length);
- System.out.println(methods[0].getName());
  Field[] fields = cls.getDeclaredFields();
 // Map<String,String> fieldVsMethod=new HashMap<>();
  for (Field field : fields) {
@@ -43,7 +40,6 @@ public static List<Header> findAnnotation(Class headerClass) {
  if (field.isAnnotationPresent(Options.class)) {
  Options options = field.getAnnotation(Options.class);
  String anTitle = new String(options.title().getBytes(), StandardCharsets.UTF_8);
- System.out.println(anTitle);
  if (anTitle.length() > 0) {
  title = anTitle;
  }
@@ -52,22 +48,17 @@ public static List<Header> findAnnotation(Class headerClass) {
  methodName.add(getterMethodName);
  presentField.add(field);
 // fieldVsMethod.put(getterMethodName,fieldName);
- } else {
- System.out.println("field been excluded" + field.getName());
- }
+ } 
  }
  List<Header> header = new ArrayList<>();
  int index = 0;
  for (String name : methodName) {
 
- try {
- Method m = cls.getMethod(name);
- header.add(new Header(presentField.get(index).getName(), textName.get(index), m));
+ Method m = cls.getMethod(name);
+ header.add(new Header(presentField.get(index).getName(), textName.get(index), m));
 // String result= (String) m.invoke(obj);
 // System.out.println(result);
- } catch (NoSuchMethodException error) {
- System.out.println("method not found");
- }
+
  index++;
  }
  return header;

src/main/java/io/github/mohammadrezaeicode/excel/util/SheetGeneratorUtils.java

@@ -9,7 +9,7 @@
 import java.util.function.Function;
 
 public class SheetGeneratorUtils {
- public static <T> Sheet1 generateSheet(List<T> data, Class headerClass, Function<List<Header>,List<Header>> applyHeaderOptionFunction){
+ public static <T> Sheet1 generateSheet(List<T> data, Class headerClass, Function<List<Header>,List<Header>> applyHeaderOptionFunction) throws NoSuchMethodException {
  List<Header> headers=new ArrayList<>();
  if(data.size()>0){
  var firstRecord=data.get(0);