Frodo


Source link: https://github.com/android10/frodo

Frodo

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.Observables will print the following information when emitting items:

 @RxLogObservable
  public Observable<List<MyDummyClass>> list() {

return Observable.just(buildDummyList());

  
}

- **@RxLogObservable.Scope Options:** It is possible to narrow down the debug information shown by adding a debugging scope to @RxLogObservable annotation.
 -  **Scope.EVERYTHING:** Logs stream data, schedulers and rx.Observable events. Default.  -  **Scope.STREAM:** Logs rx.Observable emitted items plus total execution time.  -  **Scope.SCHEDULERS:** Logs schedulers where the annotated rx.Observable operates on.  -  **Scope.EVENTS:** Logs rx.Observable events only.  -  **Scope.NOTHING:** Turns off logging for the annotated rx.Observable. 
 @RxLogObservable(Scope.STREAM)
  public Observable<List<MyDummyClass>> list() {

return Observable.just(buildDummyList());

  
}

- **@RxLogSubscriber:** Annotated classes which are of type ```rx.Subscriber``` will print the following information 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.frodo'  //By default frodo is ON on debug build variants, although //we can enable-disable it with this configuration. frodo {

enabled = true 
}

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" 
}

Frodo WIKI ----------------- For complete information, features and usage, refer to the [WIKI]( https://github.com/android10/frodo/wiki): - [@RxLogObservable]( https://github.com/android10/frodo/wiki/@RxLogObservable) - [@RxLogSubscriber]( https://github.com/android10/frodo/wiki/@RxLogSubscriber) - [Release Notes]( https://github.com/android10/frodo/wiki/Release-Notes) - [Development]( https://github.com/android10/frodo/wiki/Development) - [Frodo under the hoods]( https://github.com/android10/frodo/wiki/Under-the-hoods)
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. 

Resources

Info-dumper is a Stetho plugin which shows your android application's information.

Spinner2 is a re-implementation of the default Android's spinner, with a simple way for control selection behavior.

A Page Indicator Library which is realized in a different way.

A powerful android view looper library with animation.

Material letter icon with circle background. Replicates android L contacts icon view.

Android library to inform EU users of the use of cookies. The alert can be shown via dialog or an overlay view.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes