https://github.com/mkdika/jeneric
A tiny library for collection of custom yet frequently used function and helper, build on top of Java 8 Standard API
https://github.com/mkdika/jeneric
helper-functions java8
Last synced: 7 months ago
JSON representation
A tiny library for collection of custom yet frequently used function and helper, build on top of Java 8 Standard API
- Host: GitHub
- URL: https://github.com/mkdika/jeneric
- Owner: mkdika
- License: apache-2.0
- Created: 2018-04-20T07:33:53.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-02T02:24:53.000Z (over 6 years ago)
- Last Synced: 2023-07-01T14:46:19.415Z (almost 2 years ago)
- Topics: helper-functions, java8
- Language: Java
- Homepage:
- Size: 143 KB
- Stars: 4
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Jeneric
[](/LICENSE)
[](https://travis-ci.org/mkdika/jeneric)
[](https://codecov.io/gh/mkdika/jeneric)
[](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.mkdika%22%20AND%20a%3A%22jeneric%22)
[](https://www.javadoc.io/doc/com.mkdika/jeneric)
A tiny library for collection of custom yet frequently used function and helper.
Build on top of Java 8 standard API, no external libraries is needed.
## Overview
The main idea behind creating of this another helper and common use function library,
is to ease the usage of specific and frequently functions call, that the practical usage
may not available on other library. Furthermore, Jeneric also provide a high level access
from Java `static` method call or expression, so it does not require to instance certain
object prior usage. And as the result, functions supposed to be able to directly use and practical.
Jeneric is also a tiny library, the release size are relatively small (just less than `30 KB`), and
used only Java 8 standard API. So, it may suit to any Java 8 project or mobile development (Android).
The collection of each functions are organize within parent class that base on its expected __return types__.
There are several parent class such as `StringFun`, `BooleanFun`, `DateFun`, `IntegerFun`, etc.
For more explanation and code examples, please visit [User Guide](/docs/user-guide.md).
## Used Tool and Library
- [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/java-archive-javase8-2177648.html)
- [Maven3](https://maven.apache.org/index.html), as build system and dependency management.
- __Unit Testing__:
- [JUnit4](https://junit.org/junit4/), as unit testing framework.
- [Java Hamcrest](http://hamcrest.org/JavaHamcrest/), for ease matcher and more human readable equality test.
- [JUnitParams](https://github.com/Pragmatists/JUnitParams), for ease parameterized test.
- [Mockito](http://site.mockito.org/), a mock test framework.
- [Jacoco](https://www.eclemma.org/jacoco/), a code coverage library.
- [Pitest](http://pitest.org/), State of the art mutation testing system for the JVM.
## Quickstart
### Setting up dependency
#### Maven
```xml
com.mkdika
jeneric
1.0.0
```
#### Gradle
```groovy
dependencies {
compile 'com.mkdika:jeneric:1.0.0'
}
```
### Usage
This is a sample usage of Jeneric's function:
```java
import com.mkdika.jeneric.function.DateFun;
import com.mkdika.jeneric.function.StringFun;
import java.util.Date;
public class JenericTest {
public static void main(String[] args) {
Date d1 = DateFun.of(2018, 4, 28, 19, 35, 25); // 28 Apr 2018 19:35:25
Date d2 = DateFun.of(2018, 5, 23, 12, 30, 45); // 23 May 2018 12:30:45
System.out.println(StringFun.elapsedTime(d1, d2));
// print: 24 days 16 hours 55 minutes 20 seconds 0 milliseconds
}
}
```
## Build, Testing and Install
### Pre-requirement
- Install Java 8 JDK.
- [Install Maven3](https://maven.apache.org/install.html).
### Build
To build from source, run this from project root:
```console
mvn clean package
```
Check `target` folder, and search for `jeneric-.jar`, for built file.
### Test
#### Unit Test and Coverage Test
Run this from project root:
```console
mvn test
```
Check folder and open file `target/site/jacoco/index.html`, for Jacoco coverage test result.
#### Mutation Test
Additionally after built the project you can run the mutation test as well (please note it may need some time to finish), run this from project root:
```console
mvn org.pitest:pitest-maven:mutationCoverage
```
Check folder and open file `target/pit-reports//index.html`, for PiTest mutation test result.
### Install in Local Maven Repository
To install into local Maven repository for development testing purpose, run this from project root:
```console
mvn install
```
## Documentation
- For online host most recent version javadoc, please visit [Javadoc](https://www.javadoc.io/doc/com.mkdika/jeneric/1.0.0).
- For user guide, please visit [User Guide](/docs/user-guide.md).
## Maintainer
- [Maikel Chandika](https://github.com/mkdika)
- [Reja](https://github.com/zigic88)
Contributions are very welcome, please read [How to contribute](/docs/CONTRIBUTING.md).
## License
Licensed under the Apache License, Version 2.0. See [LICENSE](/LICENSE) file.