https://github.com/pragmatic-objects/oo-atom

A Java polyfill for better code design
https://github.com/pragmatic-objects/oo-atom

elegantobjects java oop polyfill solid

Last synced: 2 months ago
JSON representation

A Java polyfill for better code design

• Host: GitHub
• URL: https://github.com/pragmatic-objects/oo-atom
• Owner: pragmatic-objects
• License: mit
• Created: 2017-05-01T10:03:58.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2021-07-28T05:22:12.000Z (over 4 years ago)
• Last Synced: 2025-07-06T06:51:34.763Z (9 months ago)
• Topics: elegantobjects, java, oop, polyfill, solid
• Language: Java
• Homepage:
• Size: 826 KB
• Stars: 23
• Watchers: 5
• Forks: 2
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# OO-atom

[![Build Status (Travis)](https://img.shields.io/travis/pragmatic-objects/oo-atom/master.svg)](https://travis-ci.org/pragmatic-objects/oo-atom)

[![Build status (AppVeyor)](https://ci.appveyor.com/api/projects/status/sumvi0c7teo9oq94?svg=true)](https://ci.appveyor.com/project/skapral/oo-atom)

[![Codecov](https://codecov.io/gh/pragmatic-objects/oo-atom/branch/master/graph/badge.svg)](https://codecov.io/gh/pragmatic-objects/oo-atom)

## NOTICE

OO-Atom support is currenty suspended in favour of its successor --- [OO-Equivalence](https://github.com/pragmatic-objects/oo-equivalence). OO-Equivalence serves the same purpose as OO-Atom, deriving the most of the source code and ideology from it, but uses the brand new approach.

OO-Equivalence is backward-compatible with OO-Atom on source code level: if your project works with OO-Atom, it will work the same way after being recompiled with OO-Equivalence. For any issues with OO-Atom to OO-Equivalence migration, report to [OO-Equivalence issue tracker](https://github.com/pragmatic-objects/oo-equivalence/issues).

## Intro

OO-atom is a desperate attempt to make Java programming more predictable and transparent.

Instead of fighting the boilerplate code by hiding it, introducing hidden coupling, like it is done by Java EE, Spring, 

Hibernate and other "magical" solutions, OO-atom greets clean and open design by taking the most from Java SE, and the

best from OOP.

The project is built around the term named "Atom". Atom is a Java class, which strictly follows a set 

of [requirements](docs/ATOM_SPECIFICATION.md). Requirements were selected in such way that declarative object composition 

for the Atoms is trivial and common approach. Object composition is used as a main instrument for composing application

from a small cohesive classes, instead of dependencies injection by means of DI containers.

Also, for all Atoms, OO-atom seeks for the best ways of improving quality, maintainability, test coverage 

and performance.

The project is inspired by the guidelines from the books "[Elegant Objects](http://www.yegor256.com/elegant-objects.html)",

written by Yegor Bugayenko, and the materials from his [blog](http://www.yegor256.com/tag/oop.html).

However, several changes and additions were made to initial concept - see [this](docs/ATOMS_VS_EO.md) page for the 

list of differences.

OO-atom project is designed on the following principles:

- it is transparent. It never dictates the architecture of your applications.

- it is flexible. You are free to use it with any solution from a large Java ecosystem

- it operates at compile-time only. It never brings ad-hoc runtime dependencies to your application.

## Quick start with Maven

Add `atom-maven-plugin` to your project's pom file:

```

    com.pragmaticobjects.oo.atom

    atom-maven-plugin

    x.y.z

    

        

            

                generate-annotations

                instrument

                instrument-tests

            

        

    

```