https://github.com/ololx/cranberry
The cranberry is a java library that allows to write less code - it's automatically plugs into your project build and sweets up your java.
https://github.com/ololx/cranberry
annotation-processing annotation-processor annotation-tool annotations code-generation java java-library javac maven
Last synced: 5 months ago
JSON representation
The cranberry is a java library that allows to write less code - it's automatically plugs into your project build and sweets up your java.
- Host: GitHub
- URL: https://github.com/ololx/cranberry
- Owner: ololx
- License: apache-2.0
- Created: 2020-04-17T15:23:09.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-09-18T17:59:12.000Z (about 2 years ago)
- Last Synced: 2025-05-11T17:58:49.732Z (5 months ago)
- Topics: annotation-processing, annotation-processor, annotation-tool, annotations, code-generation, java, java-library, javac, maven
- Language: Java
- Homepage:
- Size: 6.07 MB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Cranberry
```
___/\\ /\
/ _//| \ /
/ / / |/ \__ 000 000
|/ / / / 000 000
00 00 _/ |/ 000 ^ 000
00 ^ 00 | 000 < * > 000
00< * > 00 0 0 000 v 000
00 v 00 0 * 0 000 000
00 00 0 0 000 000
________________________________________
Cranberry
```
The Cranberry is a java library that allows to write less routine code. It's automatically plugs into you build during compilation and sweets up your project.
[](https://search.maven.org/search?q=g:%22io.github.ololx.cranberry%22) [](https://search.maven.org/search?q=g:%22io.github.ololx.cranberry%22)
[](https://search.maven.org/search?q=g:%22io.github.ololx.cranberry%22) [](https://javadoc.io/doc/io.github.ololx.cranberry)
[](https://github.com/ololx/cranberry/tags) [](https://github.com/ololx/cranberry/releases)
[](OSSMETADATA) [](https://github.com/ololx/cranberry/commits) [](https://github.com/ololx/cranberry/releases)
[](https://deepsource.io/gh/ololx/cranberry/?ref=repository-badge) [](https://www.codacy.com/gh/ololx/cranberry/dashboard?utm_source=github.com&utm_medium=referral&utm_content=ololx/cranberry&utm_campaign=Badge_Grade)
[](LICENCE) [](CODE_OF_CONDUCT.md) [](https://app.fossa.com/projects/git%2Bgithub.com%2Fololx%2Fcranberry?ref=badge_shield)
   
[](https://www.oracle.com/java/technologies/javase-jdk8-downloads.html)
## đ Table of Contents
- [About](#about)
- [Demo](#demo)
- [Features](#feature)
- [Getting Started](#getting-started)
- [Built With](#built-with)
- [Contributing](#contributing)
- [Code of Conduct](#code-of-conduct)
- [Versioning](#versioning)
- [Authors](#authors)
- [Licensing](#licensing)
## đ About
The Cranberry is a java library that allows to write less routine code. It's automatically plugs into you build during compilation and sweets up your project.
### Motivation
Sometimes it wants frequently used code to be generated automatically. Especially if such code is not generated by existing libraries.
### Modules
The cranberry project includes the follows modules:
- [cranberry commons](cranberry-commons/README.md) - this module provides a general realisation of simple tools and wrappers which are used in another cranberry modules for the automatically code generating during compilation;
- [cranberry muffin](cranberry-muffin/README.md) - this module is designed to combine the possibilities of thematically grouped modules into one common library;
- [cranberry statement](cranberry-statement/README.md) - this module provides an api for the statements validation (such as not null and e.t.c.). This module includes an annotations for the injecting methods of this api into code during compilation;
- [cranberry logging](cranberry-logging/README.md) - this module provides an api for the loggint method params;
- [cranberry data](cranberry-data/README.md) - this module provides an api for the java data manipulations: varianbles modifiers, default values, e.t.c. This module includes an annotations for the injecting methods of this api into code during compilation;
- [cranberry tests](cranberry-tests/README.md) - this module contains the unit tests for the remaining modules of the cranberry project.
## đ¸ Demo
The demonstration shows how `cranberry` helps to write less code on the checking parameters implementation example for non-emptiness via usage of the `@ NotEmpty` annotation from the `cranberry-statement` module. This is one of opportunities which cranberry provides.
## đ Features
- The api for the statements validation about not null values of the `Object` type;
- The api for the statements validation about not empty values of the `Map` type, the `Collection` type, the `Array` and the `String` type;
- The api for the statements validation about not blank values of the `String` type;
- The api for the loggint method params;
- The annotations for the injecting methods of this api into code during compilation.
### To Do
- For more information on an upcoming development, please read the [todo](TODO.md) list.
### Changelog
- For more information on a releases, a features and a changes, please read the [changelog](CHANGELOG.md) notes.
## đĻ Getting Started
These instructions allow to get a copy of this project and run it on a local machine.
### Prerequisites
Before using it, make sure that follows software are installed on the local machine:
- **[Oracle JDK 8+](https://www.oracle.com/java/technologies/javase-downloads.html)** - the java development kit.
### Installing
#### Using Maven
In order to add cranberry to your project it is quite simple to:
1 - Add this dependency to classpath in pom:
```xml
io.github.ololx.cranberry
${module-name}
${version}
```
_Example of dependency for installing `cranberry-muffin` module with version `0.5.3` is presented bellow_
```xml
io.github.ololx.cranberry
cranberry-muffin
0.5.3
provided
```
2 - Execute this with goal
```bash
clean install
```
### Cloning
For the cloning this repository to a local machine, just use the follows link:
```https
https://github.com/ololx/cranberry
```
### Using
The simple example below presents the the checking of a parameters on `not null` value without the specific exception message returns and `not blank` value with the specific exception message returns.
```java
...
//Add the checking statements for method params
public List findSomeDetailbyUidAndTypeCode(@NotNull Long uid,
@NotEmpty("The Type Code must be not empty") String typeCode) {
return Collections.EMPTY_LIST;
}
...
```
The simple example below presents the the logging of a parameters of method with the specific message.
```java
...
/**
* The example of {@code @LogParam} annotation usage on {@code List param}.
*
* When this method is called, the parameters will be displayed in the log;
* Messages in the log will label the format {@char "message param"} for each parameter.
*/
@LogParam(message = "Start execution with param =")
public static void runWithCustomMessage(List param) {
param.stream()
.forEach(eachParam -> {
System.out.println(eachParam);
});
}
...
```
## đ Built With
- **[Maven](https://maven.apache.org/)** - Dependency Management.
## đ Contributing
If you want to contribute this project - you are welcome and have fun.
Please visit the [contributing](CONTRIBUTING.md) section for details on this code of conduct, and the process for submitting pull requests.
## đ Code of Conduct
In order to ensure that all is welcoming, please review and abide by the [code of conduct](CODE_OF_CONDUCT.md).
## đ Versioning
For the versioning is used [Semantic Versioning](http://semver.org/). For the versions available, see the [changelog](CHANGELOG.md) or the tags on this repository.
## Šī¸ Authors
* **Alexander A. Kropotin** - *Initial work* - [ololx](https://github.com/ololx).
## đ Licensing
This project is licensed under the Apache license version 2.0 - see the [lisence](LICENSE) document for details.
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fololx%2Fcranberry?ref=badge_large)