Kor

A Clean Architecture Implementation core library.

What is Kor?

Kor is the skeleton of a clean-ish architecture implementation. There are many ways of implementing a clean architecture:

Ports and adapters
Hexagonal Architecture
VIPER Architecture

The aim of Kor is to provide a fast implementation of a proper architecture where the developer can iterate quickly and and with the ability to use good practices as SOLID and TDD from day 0.

Kor is not meant to be a canonical implementation of such architecture, but a personal interpretation of how it should be.

Basic Setup

Make sure to have the latest version of JDK 1.8 installed.

Add the dependencies into the project's build.gradle

dependencies {
    compile 'com.sefford:kor-usecases:4.3.2'
    compile 'com.sefford:kor-repositories:4.3.2'
    compile 'com.sefford:kor-repositories-extensions:4.3.2' // optional 
    compile 'com.sefford:kor-repositories-gson-converter:4.3.2' 
    compile 'com.sefford:kor-repositories-moshi-converter:4.3.2'
}

How is Kor structured?

Read more particular documentation in any of the modules that Kor provides

Use Cases: Abstractions to apply use cases and interactors concepts to your architecture
Repositories: Repository pattern to abstract cache and persistence
Repositories Extensions: Basic implementations of policies for specialized repositories (optional)
Repositories Gson Converter: Simple Gson Json converter for json-based repositories (optional)
Repositories Moshi Converter: Simple Gson Moshi converter for json-based repositories (optional)

Migrating to 4.0.0

Many breaking changes were done in 4.0.0, mostly related to how the core works.

Now all Kor is separated in individual modules
All old Interactor system got deprecated. All delegates must be chopped and separated on each phase.
Now Use cases can return Either<Error,Response>. If you use the Postable-compatible method, your Postable will keep receiving these separated response.
Save and Get Repository methods will receive an Either<RepositoryError, V> response instead of a null; so the receiving class can have a little information of what went wrong.
In order to ease the long signatures and known problems with the error log grouping, you will need to log manually each of the errors.

Interesting literature

Martin, Robert Cecil: The Clean Architecture

Cockburn, Alistair: Hexagonal Architecture

VIPER Architecture

License

Copyright 2014 Sefford.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.