Frodo is an android library inspired by Jake Wharton's Hugo, mainly used for logging RxJava Observables and Subscribers outputs on the logcat.
It generates and weaves code based on annotations only on debug versions of the application where the plugin is applied, for instance, it is safe to persist any Frodo annotation in the codebase.
Main Features -----------------
- @RxLogObservable: Annotated methods which return
rx.Observableswill print the following information on android logcat when emitting items:
@RxLogObservable
public Observable<List<MyDummyClass>> list() {
return Observable.just(buildDummyList());
}- **@RxLogSubscriber:** Annotated classes which are of type ```rx.Subscriber``` will print the following information on android logcat when receiving items from an ```rx.Observable```:
@RxLogSubscriber
public class MySubscriberBackpressure extends Subscriber<Integer> {
@Override
public void onStart() {
request(40);
}
@Override
public void onNext(Integer value) {
//empty
}
@Override
public void onError(Throwable throwable) {
//empty
}
@Override
public void onCompleted() {
if (!isUnsubscribed()) {
unsubscribe();
}
}
}Enabling Frodo ----------------- To enable Frodo, a gradle plugin must be applied in your ```build.gradle```:
buildscript {
repositories {
jcenter()
}
dependencies {
classpath "com.fernandocejas.frodo:frodo-plugin:${latest_version}"
}
}
apply plugin: 'com.android.application'
apply plugin: 'com.fernandocejas.frodoUnder the hoods -----------------
Aspect Oriented Programming in Android
Known issues -----------------
1 - Multi module setup (application + android library) will not log annotated methods/classes from Android Library Module but will do it on Android Application Module. The reason behind this, is that the Android Gradle Plugin will build all Android Libraries as release versions, for instance, Frodo is not able to weave any code on the annotated methods/classes (Remember that only weaves in debug versions). There is a workaround for forcing debug versions of your Android Libraries (just be careful in case this is forgotten and you end up shipping a version of your app with RxJava Logging enabled) by adding this line in your build.gradle file:
android {
defaultPublishConfig "debug"
}Local Development -----------------
Here are some useful Gradle commands for executing and installing the library:
./install_frodo.sh- One time execution command for installing frodo library and dependencies../gradlew installFrodoApi- Installs Frodo Api dependencies../gradlew installFrodoRuntime- Installs Frodo Runtime dependencies../gradlew installFrodoPlugin- Installs Frodo gradle plugin../gradlew installFrodoAndroidSample- Build and installs everything plus android application sample../gradlew runUnitTests- Run unit tests.
Code style -----------------
Here you can download and install the java codestyle. https://github.com/android10/java-code-styles
License -----------------
Copyright 2015 Fernando Cejas
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.