Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dgroup/laconic-velocity
Laconic API for Apache Velocity
https://github.com/dgroup/laconic-velocity
apache-velocity elegantobjects java java-library oop oop-library oop-principles velocity-template
Last synced: 3 months ago
JSON representation
Laconic API for Apache Velocity
- Host: GitHub
- URL: https://github.com/dgroup/laconic-velocity
- Owner: dgroup
- License: mit
- Created: 2018-09-28T16:17:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-03-10T16:40:30.000Z (almost 3 years ago)
- Last Synced: 2024-10-10T17:22:26.244Z (3 months ago)
- Topics: apache-velocity, elegantobjects, java, java-library, oop, oop-library, oop-principles, velocity-template
- Language: Java
- Homepage:
- Size: 86.9 KB
- Stars: 10
- Watchers: 3
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
[](https://mvnrepository.com/artifact/com.github.dgroup/laconic-velocity)
[](http://www.javadoc.io/doc/com.github.dgroup/laconic-velocity)
[](./license.txt)
[](https://github.com/dgroup/laconic-velocity/graphs/commit-activity)
[](https://hitsofcode.com/view/github/dgroup/laconic-velocity)
[](https://travis-ci.org/dgroup/laconic-velocity)
[](http://www.0pdd.com/p?name=dgroup/laconic-velocity)
[](https://requires.io/github/dgroup/laconic-velocity/requirements/?branch=dev)
[](https://snyk.io/org/dgroup/project/58b731a9-6b07-4ccf-9044-ad305ad243e6/?tab=dependencies&vulns=vulnerable)
[](http://www.rultor.com/p/dgroup/laconic-velocity)
[](http://www.elegantobjects.org/#principles)
[](https://www.jetbrains.com/idea/)
[](http://www.qulice.com/)
[](https://sonarcloud.io/dashboard?id=com.github.dgroup%3Alaconic-velocity)
[](https://codebeat.co/projects/github-com-dgroup-laconic-velocity-master)
[](https://www.codacy.com/app/dgroup/laconic-velocity?utm_source=github.com&utm_medium=referral&utm_content=dgroup/laconic-velocity&utm_campaign=Badge_Grade)
[](https://codecov.io/gh/dgroup/laconic-velocity)
**ATTENTION**: We're still in a very early alpha version, the API
may and _will_ change frequently. Please, use it at your own risk,
until we release version 1.0.
Maven:
```xml
com.github.dgroup
laconic-velocity
```
Gradle:
```groovy
dependencies {
compile 'com.github.dgroup:laconic-velocity:'
}
```
## Get started
**Generate the text/sql/xml/markdown/json/etc based on Apache Velocity [template](/src/main/java/com/github/dgroup/velocity/Template.java).**
1. Define velocity template `query.sql`
```sql
select 1 from dual
#if ($flag)
union
select 2 from dual
#end
```
in
```
velocity $ tree
...
|-- src
| |-- main
| | |-- ...
| |
| `-- test
| |-- java
| | `-- ...
| `-- resources
| `-- velocity
| |-- ...
| |-- query.sql
| |-- ...
...
```
2. Define instance of velocity template using
- full path to template
```java
@Test
public void transformSql() throws TemplateException {
MatcherAssert.assertThat(
new Text("query.sql", "src/test/resources/velocity").compose(
new ArgOf("flag", true)
),
Matchers.equalTo(
"select 1 from dual\nunion\nselect 2 from dual\n"
)
);
}
```
See [more](/src/test/java/com/github/dgroup/velocity/template/TextTest.java).
- hierarchical search
```java
@Test
public void hierarchical() throws TemplateException {
MatcherAssert.assertThat(
new Text("query.sql", "src/test/resources").compose(
new ArgOf("flag", true)
),
Matchers.equalTo(
"select 1 from dual\nunion\nselect 2 from dual\n"
)
);
}
```
You can also specify the multiple roots ([more](/src/main/java/com/github/dgroup/velocity/template/Text.java#L64)).
- classpath template
```java
@Test
public void classpath() throws TemplateException {
MatcherAssert.assertThat(
new Text(new RelativePath("velocity/query.sql")).compose(
new ArgOf("flag", true)
),
Matchers.equalTo(
"select 1 from dual\nunion\nselect 2 from dual\n"
)
);
}
```
See [more](/src/test/java/com/github/dgroup/velocity/template/ClasspathTest.java#L124).