Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hosuaby/inject-resources

Simple and convenient way to read content of resource in Java.
https://github.com/hosuaby/inject-resources

gson jackson java json jsonl junit jupiter load loading parse parse-resources parsing resource resources snakeyaml spring tests text yaml

Last synced: about 2 hours ago
JSON representation

Simple and convenient way to read content of resource in Java.

Host: GitHub
URL: https://github.com/hosuaby/inject-resources
Owner: hosuaby
License: apache-2.0
Created: 2020-02-19T21:39:55.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-08-16T17:31:41.000Z (3 months ago)
Last Synced: 2024-08-17T18:19:48.703Z (3 months ago)
Topics: gson, jackson, java, json, jsonl, junit, jupiter, load, loading, parse, parse-resources, parsing, resource, resources, snakeyaml, spring, tests, text, yaml
Language: Java
Homepage: http://inject-resources.hosuaby.io
Size: 694 KB
Stars: 54
Watchers: 5
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # @InjectResources

[![CI](https://github.com/hosuaby/inject-resources/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/hosuaby/inject-resources/actions/workflows/ci.yml)

[![Coverage Status](https://coveralls.io/repos/github/hosuaby/inject-resources/badge.svg?branch=master)](https://coveralls.io/github/hosuaby/inject-resources?branch=master)

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.hosuaby/inject-resources-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.hosuaby/inject-resources-core)

[![User guide](https://img.shields.io/badge/User%20guide-1.0.0-red)](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/)

[![Core Javadoc](https://img.shields.io/badge/Core%20Javadoc-1.0.0-orange)](https://javadoc.io/doc/io.hosuaby/inject-resources-core/1.0.0)

[![Spring Javadoc](https://img.shields.io/badge/Spring%20Javadoc-1.0.0-green)](https://javadoc.io/doc/io.hosuaby/inject-resources-spring/1.0.0)

[![JUnit Jupiter Javadoc](https://img.shields.io/badge/JUnit%20Jupiter%20Javadoc-1.0.0-blueviolet)](https://javadoc.io/doc/io.hosuaby/inject-resources-junit-jupiter/1.0.0)

[![JUnit 4 Javadoc](https://img.shields.io/badge/JUnit%204%20Javadoc-1.0.0-yellow)](https://javadoc.io/doc/io.hosuaby/inject-resources-junit-vintage/1.0.0)

*Reading content of resource files in Java is harder that it should be*. Great libraries like

[Guava](https://github.com/google/guava) or [Spring](https://github.com/spring-projects/spring-framework) made it much

easier, but it's time to make another step forward. Use `@InjectResources` is the easiest and most convenient way to load

and parse content of resources without boilerplate code that opens/closes streams and handles I/O exceptions. This library

made of [inject-resources-core](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/#inject-resources-core),

fluid Java DSL, and of extensions for

[Spring](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/#inject-resources-spring),

[JUnit5](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/#inject-resources-junit-jupiter) and

[JUnit4](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/#inject-resources-junit-vintage) that allow to do

that with simple annotations.

## Examples

### Core

```java

var text = resource()

        .onClassLoaderOf(this.getClass())

        .withPath("/io/hosuaby/junit/jupiter", "resource.txt")

        .text();

```

Check [Core](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/#inject-resources-core) user guide for more information and examples.

### With Spring

```java

@Component

public class MyBean {

    // Field 'text' is injected with content of '/io/hosuaby/junit/jupiter/resource.txt'

    @TextResource("/io/hosuaby/junit/jupiter/resource.txt")

    private String text;

}

```

Check [Spring extension](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/#inject-resources-spring) user guide for more information and examples.

### With JUnit

#### JUnit5

```java

@TestWithResources

class InjectTextResourcesTests {

    @GivenTextResource("/io/hosuaby/junit/jupiter/resource.txt")

    String instanceField;

    @Test

    public void testInjectTextIntoStringInstanceField() {

        assertThat(instanceField)

                .isEqualTo("The quick brown fox jumps over the lazy dog.");

    }

}

```

Check [JUnit5 extension](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/#inject-resources-junit-jupiter) user guide for more information and examples.

#### JUnit4

```java

class MyTestClass {

    @Rule

    public ResourceRule textResource = givenResource()

            .text("/io/hosuaby/junit/jupiter/resource.txt")

            .withCharset(StandardCharsets.UTF_8);

    @Test

    public void testWithTextResource() {

        assertThat(textResource.get())

                .isEqualTo("The quick brown fox jumps over the lazy dog.");

    }

}

```

Check [JUnit4 extension](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/#inject-resources-junit-vintage) user guide for more information and examples.

## Supported formats

- Binary

- Text

- Java properties

- JSON & JSON Lines

- YAML & YAML Documents

## News

- 2024-08-16: Release `v1.0.0`. Ensure compatibility. Java: up to 22, Spring Boot: up to 3.3, JUnit Jupiter: up to 5.11,

Jackson: up to 2.17, Gson: up to 2.11, Snakeyaml: up to 2.2. :warning: Major change in package names: 

`com.adelean` -> `io.hosuaby`.

- 2023-05-28: Release `v0.3.3`. Removed dependency on deprecated InstantiationAwareBeanPostProcessorAdapter.

- 2022-04-07: Release `v0.3.2`. Upgrade `org.reflections` to `0.10.2`.

- 2022-03-23: Release `v0.3.1`. Limit classpath search for `TestsAdvice`s.

- 2021-09-04: Release `v0.3.0`. Fix source compatibility (Gradle). JUnit (5/4) modules now depends on core. 

Implementation no longer relies on classpath scan to find annotations of the project.

- 2021-05-10: Release `v0.2.2`. Use reflexions.org instead of JUnit ReflectionSupport

- 2021-04-23: Release `v0.2.1`. Fix reflexion on annotations on JDK 1.8 

- 2021-03-07: Release `v0.2.0`. Publish to Maven Central.

- 2020-08-13: Release `v0.1.0`. This release includes Spring extension.

- 2020-07-29: Release `v0.1.0-beta`. This release contains support of YAML files (Snakeyaml) and JUnit 4 extension.

- 2020-06-20: Release `v0.1.0-alpha`. The first ever release. Contains only module `core` and JUnit 5 extension.

Support files in formats: binary, text, java properties and JSON.

## Documentation

### User guides

- [Core](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/#inject-resources-core),

- [Spring extension](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/#inject-resources-spring),

- [JUnit5 extension](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/#inject-resources-junit-jupiter),

- [JUnit4 extension](https://hosuaby.github.io/inject-resources/1.0.0/asciidoc/#inject-resources-junit-vintage)

### Javadoc

- [Core](https://javadoc.io/doc/io.hosuaby/inject-resources-core/1.0.0),

- [Spring extension](https://javadoc.io/doc/io.hosuaby/inject-resources-spring/1.0.0),

- [JUnit5 extension](https://javadoc.io/doc/io.hosuaby/inject-resources-junit-jupiter/1.0.0),

- [JUnit4 extension](https://javadoc.io/doc/io.hosuaby/inject-resources-junit-vintage/1.0.0)