{"id":16514499,"url":"https://github.com/victorhsr/hermes-builder","last_synced_at":"2025-10-28T04:32:32.596Z","repository":{"id":218468587,"uuid":"565640123","full_name":"victorhsr/hermes-builder","owner":"victorhsr","description":"A library that automates the creation of fluent object builders and DSL in Java","archived":false,"fork":false,"pushed_at":"2025-01-20T02:03:51.000Z","size":76,"stargazers_count":4,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-01T11:34:55.930Z","etag":null,"topics":["annotation-processing","domain-specific-language","dsl","java","kotlin","maven"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/victorhsr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-11-14T01:57:35.000Z","updated_at":"2024-01-26T19:48:57.000Z","dependencies_parsed_at":"2024-01-24T02:20:18.799Z","dependency_job_id":"805db0fd-a472-4e23-8a33-90ba2b9e4c8d","html_url":"https://github.com/victorhsr/hermes-builder","commit_stats":null,"previous_names":["victorhsr/hermes-maven-plugin","victorhsr/hermes-builder"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorhsr%2Fhermes-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorhsr%2Fhermes-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorhsr%2Fhermes-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/victorhsr%2Fhermes-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/victorhsr","download_url":"https://codeload.github.com/victorhsr/hermes-builder/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238597386,"owners_count":19498396,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["annotation-processing","domain-specific-language","dsl","java","kotlin","maven"],"created_at":"2024-10-11T16:12:45.894Z","updated_at":"2025-10-28T04:32:32.569Z","avatar_url":"https://github.com/victorhsr.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Hermes Builder\n[![Maven Build](https://github.com/victorhsr/hermes-builder/workflows/Maven%20Build/badge.svg)](https://github.com/victorhsr/hermes-builder/actions?query=workflow%3A\"Maven+Build\")\n[![Coverage Status](https://coveralls.io/repos/github/victorhsr/hermes-builder/badge.svg)](https://coveralls.io/github/victorhsr/hermes-builder)\n[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/mit)\n[![](https://jitpack.io/v/victorhsr/hermes-builder.svg)](https://jitpack.io/#victorhsr/hermes-builder)\n\nHermes is a library designed to streamline the generation of fluent object builders for your Java classes. Employing a declarative approach, it produces a straightforward Domain Specific Language (DSL) to facilitate the construction of object instances.\n\n## Adding Hermes to your pom file\n\n```xml\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003cid\u003ejitpack.io\u003c/id\u003e\n        \u003curl\u003ehttps://jitpack.io\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n\n\u003cdependencies\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003ecom.github.victorhsr\u003c/groupId\u003e\n        \u003cartifactId\u003ehermes-builder\u003c/artifactId\u003e\n        \u003cversion\u003e1.1.0-beta\u003c/version\u003e\n    \u003c/dependency\u003e\n\u003c/dependencies\u003e\n```\n\n## Usage\n\nSuppose we have classes `Person`, `Address` and `MetaDataWrapper` annotated with `@DSLRoot` and `@DSLProperty`:\n\n```Java\n@DSLRoot\npublic class Person {\n\n    private String name;\n    private Integer age;\n    private Address address;\n    @DSLProperty(\"metaData\")\n    private MetaDataWrapper\u003cString, String\u003e metaDataWrapper;\n\n    // getters and setters...\n}\n\n@DSLRoot\npublic class Address {\n\n    private String street;\n    private Integer houseNumber;\n\n    // getters and setters...\n}\n\n@DSLRoot\npublic class MetaDataWrapper\u003cK, V\u003e {\n\n    private K key;\n    private V value;\n\n    // getters and setters...\n}\n```\n\nOnce you compile your project, the library will generate the classes `PersonDSL`, `AddressDSL` and `MataDataWrapperDSL` which are the builders. With it we can succinctly create an instance of `Person`:\n```Java\nPerson personFromDsl = \n    person(\n        name(\"Victor\"),\n        age(99),\n        address(\n            street(\"Foo street\"),\n            houseNumber(99)\n        ),\n        metaData(\n            key(\"LAST_LOGIN\"),\n            value(\"01-01-2024\")\n        )\n    );\n````\n\nNote that there's no need to instantiate `Address` or `MetaDataWrapper`, and more descriptive names for Person's fields can be used. All the building methods are static methods and high order functions.\n\n## Annotations\n\n- **@DSLRoot** - Indicates the intention to create a builder for the annotated class;\n- **@DSLProperty** - Customizes the method name generated for a specific field. The default is the original field name;\n- **@DSLIgnore** - Marks a field to be excluded when generating DSL code;\n\n## Prerequisites\n\nThe Hermes builder requires elements annotated with **@DSLRoot** to have a public default constructor. Only attributes with a public setter method will have a higher-order function created.\n\n## Lombok Support\n\nThe Hermes builder is compatible with the Lombok plugin. It recognizes the **@Data** and **@Setter** annotations from Lombok and uses their generated methods to compose the sources generated by Hermes Builder.\n\n# Comparison with Traditional Java Classes\n\nThe equivalent implementation in traditional Java code involves a considerable amount of boilerplate:\n\n```Java\n\nprivate Person buildPerson() {\n    Person person = new Person();\n    person.setAge(99);\n    person.setName(\"Victor\");\n    person.setAddress(buildAddress());\n    person.setMetaDataWrapper(buildMetaDataWrapper());\n\n    return person;\n}\n\nprivate MetaDataWrapper\u003cString, String\u003e buildMetaDataWrapper() {\n    MetaDataWrapper\u003cString, String\u003e metaData = new MetaDataWrapper\u003c\u003e();\n    metaData.setKey(\"LAST_LOGIN\");\n    metaData.setValue(\"01-01-2024\");\n\n    return characteristics;\n\n}\n\nprivate Address buildAddress() {\n    Address address = new Address();\n    address.setHouseNumber(99);\n    address.setStreet(\"Foo street\");\n\n    return address;\n}\n```\nThat's a lot of code, almost twice the lines of our previous implementation. The Hermes Builder significantly reduces this boilerplate, providing a more concise and readable alternative.\n\n# Using Lombok for comparison\n\nAn alternative approach using Lombok involves a cleaner syntax but may lack readability and customization\n\n```Java\npublic Person buildPerson() {\n    return Person.builder()\n            .name(\"Victor\")\n            .age(99)\n            .address(buildAddress())\n            .setMetaDataWrapper(buildMetaDataWrapper())\n            .build();\n}\n\nprivate MetaDataWrapper\u003cString, String\u003e buildMetaDataWrapper() {\n    return MetaDataWrapper\n            .builder()\n            .key(\"LAST_LOGIN\")\n            .value(\"01-01-2024\")\n            .build()\n\n}\n\nprivate Address buildAddress() {\n    return Address.builder()\n            .houseNumber(99)\n            .street(\"Foo street\")\n            .build()\n}\n```\nIn summary, the Hermes Builder strikes a balance between conciseness and customization, offering a powerful solution for building objects in a declarative manner.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictorhsr%2Fhermes-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvictorhsr%2Fhermes-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvictorhsr%2Fhermes-builder/lists"}