Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lenguyenthanh/nimble
Nimble is a small, quick and flexible Model-View-Presenter(MVP) library for Android.
https://github.com/lenguyenthanh/nimble
android android-library mvp
Last synced: 4 months ago
JSON representation
Nimble is a small, quick and flexible Model-View-Presenter(MVP) library for Android.
- Host: GitHub
- URL: https://github.com/lenguyenthanh/nimble
- Owner: lenguyenthanh
- License: apache-2.0
- Created: 2016-02-23T00:30:21.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-05-09T14:32:41.000Z (over 8 years ago)
- Last Synced: 2023-07-28T09:18:27.529Z (over 1 year ago)
- Topics: android, android-library, mvp
- Language: Java
- Homepage: http://lenguyenthanh.github.io/nimble/
- Size: 285 KB
- Stars: 24
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nimble [](https://maven-badges.herokuapp.com/maven-central/cz.jirutka.rsql/rsql-parser) [](https://travis-ci.org/lenguyenthanh/nimble) [](https://codecov.io/github/lenguyenthanh/nimble?branch=master)
Nimble is a small, quick and flexible Model-View-Presenter library for Android
If you do not know much about MVP, please read [MVP Definition and best practices](http://lenguyenthanh.com/model-view-presentermvp-definitions-and-best-practices/).
Or read more about [Nimble](https://github.com/lenguyenthanh/nimble/wiki/Nimble).
### Why Nimble
* Nimble provides simple base classes to implement [MVP](https://github.com/lenguyenthanh/nimble/wiki/MVP) simple. You can get it from maven center or copy and paste few lines of code.
* Nimble is simple has less than 500 lines of code. So it is easy to read and understand. You cat get familiar with it in just 30 minutes.
* Nimble has well tested code (more than 89% code [coverage](https://codecov.io/github/lenguyenthanh/nimble?branch=master)) so you can confident when using it.
* Nimble is designed to be flexible. So you can use it any way you. It can be used perfectly with Dagger or you can manage it manually.
* Nimble provides mechanism to manage the life cycle of the view for you.
* Nimble provides mechanism to save data when activity/fragment/view is recreated throws Bundle class.
### Example
Nimble has two simple examples in this repository: [Nimble-exaple](https://github.com/lenguyenthanh/nimble/tree/master/nimble-example) and [Nimble example with Dagger 2](https://github.com/lenguyenthanh/nimble/tree/master/nimble-dagger2). There is more complete example for Nimble is [Snowball](https://github.com/lenguyenthanh/Snowball) which is a well tested sample project.
### Usage
Nimble has two basic interfaces [NimbleView](https://github.com/lenguyenthanh/nimble/blob/master/nimble-core/src/main/java/com/lenguyenthanh/nimble/NimbleView.java) and [NimblePresenter](https://github.com/lenguyenthanh/nimble/blob/master/nimble-core/src/main/java/com/lenguyenthanh/nimble/NimblePresenter.java). They are base interfaces for ant views and presenters.
You should follow these steps to create a MVP component in your application:
1. Create a View interface which must extents NimbleView:
```java
public interface MainView extends NimbleView {
void showUser(User user);
}
```
2. Create a Presenter interface which must extent [NimblePresenter](https://github.com/lenguyenthanh/nimble/blob/master/nimble%2Fsrc%2Fmain%2Fjava%2Fcom%2Flenguyenthanh%2Fnimble%2FNimblePresenter.java) with View generic like:
```java
public interface MainPresenter extends NimblePresenter {
void getUser();
}
```
3. Implement your Presenter which should extent [BasePresenter](https://github.com/lenguyenthanh/nimble/blob/master/nimble-core/src/main/java/com/lenguyenthanh/nimble/BasePresenter.java):
```java
public class MainPresenterImpl extends BasePresenter implements MainPresenter {
public void getUser(){
User user = ...
getView().showUser(user);
}
}
```
4. Implement your View which should extent base a Nimble Views such as [NimbleActivity](https://github.com/lenguyenthanh/nimble/blob/master/nimble-core/src/main/java/com/lenguyenthanh/nimble/view/NimbleActivity.java) and implments your View interface:
```java
public class MainActivity extends NimbleActivity implements MainView {
private MainPresenter presenter;
@Override
protected MainPresenter presenter() {
if(presenter == null){
presenter = new MainPresenter();
}
return presenter;
}
void onButtonClicked(){
presenter().getUser();
}
}
```
Congratulation!!! You have a MVP component now.
### Inspiration
Nimble has a lot of inspiration from other great MVP libraries for Android:
* Mortar - https://github.com/square/mortar
* Nucleus - https://github.com/konmik/nucleus
* Mosby - https://github.com/sockeqwe/mosby
### Installation
```gradle
compile 'com.lenguyenthanh.nimble:nimble:0.5.1'
```
### License
Copyright (C) 2016 Thanh Le
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.