Filelize for java/kotlin

Filelize is a lightweight library designed to simplify writing and reading data into human-readable files, requiring just one line of code.

One of the biggest advantages is in the annotations and methods provided, eliminating the need for repetitive boilerplate code. Additionally, it offers flexibility with options for both single and multiple file storage, giving an easy way to work with very large collections distributed among multiple files. Filelize is most commonly used to save files as json for Test Data Setup.

Usage

To integrate Filelizer into your project, add the following dependency to your pom.xml

<dependency>
  <groupId>io.github.filelize</groupId>
  <artifactId>filelize-java</artifactId>
  <version>0.9.3</version>
</dependency>

For Gradle, you can use:

implementation 'io.github.filelize:filelize-java:0.9.3'

Ref: Publish your artifact to the Maven Central Repository using GitHub Actions

Getting started

Initialize a Filelizer with your preferred location of your files. (For subdirectories you can add them directly on your domain object)

Filelizer filelizer = new Filelizer("src/test/resources/");

Save an object

var id = filelizer.save(something);

SaveAll objects in one or multiple file(s):

var ids = filelizer.saveAll(somethings);

Find a object

var something = filelizer.find("id1", Something.class);

FindAll objects:

var somethings = filelizer.findAll(Something.class);

Saving to a single file

To save an object to a single file, annotate your model class with @Filelize and set the type parameter to FilelizeType.SINGLE_FILE. Additionally, mark the identifying attribute with @Id.

import io.github.filelize.Filelize;
import io.github.filelize.Id;

@Filelize(name = "something_single", type = FilelizeType.SINGLE_FILE, directory = "something_single")
public class Something {
    @Id
    private String id;
    private String name;
    ...
}

Saving to multiple files

For saving objects to multiple files, follow the same steps as for single-file saving, but set the type parameter to FilelizeType.MULTIPLE_FILES.

import io.github.filelize.Filelize;
import io.github.filelize.Id;

@Filelize(name = "my_something", type = FilelizeType.MULTIPLE_FILES, directory = "something_multiple/mydirectory")
public class Something {
    @Id
    private String id;
    private String name;
    ...
}

Filelize in Spring Boot

Spring Boot applications typically leverage annotations and configuration classes for managing beans and functionalities. Here's how you can use Filelizer in a Spring Boot application:

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.stereotype.Service;
import io.github.filelize.FilelizeType;
import io.github.filelize.Filelizer;

@Service
public class FilelizerService {

    private final ObjectMapper objectMapper;
    private final Filelizer filelizer;

    public FilelizerService(ObjectMapper objectMapper) {
        this.objectMapper = objectMapper;
        this.filelizer = new Filelizer("src/main/resources/", objectMapper, FilelizeType.OBJECT_FILE);
    }
    
    public void updateName(String id, String name){
        var something = filelizer.find(id, Something.class);
        something.setName(name);
        filelizer.save(something);
    }
}

Filelize for Test Data Setup

So you are working on setting up test data scenario for your unit test. This manual process is typically involving alot of boilerplate code. This is especially true when working on complex classes that contain many fields and collections. What we usually need is the presence of an object, where only a few values are important to be able to make a meaningful test. Here are some steps you could take to setup your test data:

1. Create a Filelizer service that saves your objects or collections to a test data folder

Filelizer filelizer = new Filelizer("src/test/resources/testdata");

2. Run the application with the scenarios that you wanna test. Make sure to save the result for each scenario, e.g. filelizer.save("somethingTest1", something);
3. Now you should have some test data files in your testdata folder like: .../testdata/somethingTest1.json and .../testdata/somethingTest2.json
4. Create a test and load your test data

@Test
public void testSomething() {
    var something = filelizer.find("somethingTest2", Something.class);
    assertEquals("somethingTest2", something.getId());
}

Contribute

Contributions are welcomed! Feel free to create a pull request to contribute.