v 0.5.2

Update Readme
Clean
Manage release in Github

Author: afaucogney

Diff for: CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.5.2
+- Remove JCenter
+- Update README.md
+
 # 0.5.1
 - Migrate to AGP 7.0.3
 - Migrate sample App to Android 12
@@ -36,5 +40,5 @@
 
 # 0.1.0
 - First implementation
-- Add Activities
+- Add ActivitiesGener
 - Add Fragments

Diff for: README.md

@@ -1,69 +1,83 @@
 # Android Object LifeCycle / BackStack Flipper Plugin 
 
-## What you get
+## What you get ?
 
-This Flipper plugin is an app introspection plugin focus on Android Sdk mains objects and their life cycle.
+This library is an app introspection plugin for the [Flipper](https://github.com/facebook/flipper) tool. It does focus on Android Sdk mains objects and their life cycle inspection.
+
+It enables to see the **big internal picture** of your running app in a side tool. Meaning that :
 
-It enable to see the "big internal picture" of your running app in a side tool. Meaning that :
  - trough running the app as a user
- - you can kee an eye on internals as a developer
+ - you can keep an eye on internals as a developer
+ - see the dynamic of objects evolution
+ - without struggling with debugger
+
+## Status :
+
+ - The plugin is **under development**
+ - The plugin **name** is not sealed (ideas are welcome)
+ - The **private Api** is not sealed at all (it will change in the future)
+ - The **public Api** is simple : future breaking change will be easy to handle
+
+## Availability :
+
+You can get the Android plugin with the Gradle dependency from Jitpack :
 
-## Status
+- [https://jitpack.io/#afaucogney/flipper-backstack]()
+- [![](https://jitpack.io/v/afaucogney/flipper-backstack.svg)](https://jitpack.io/#afaucogney/flipper-backstack)
 
-The plugin is under development
-Name is not sealed (ideas are welcome)
+Current version is `5.0.2`
 
-## Availability
+## Vision
 
-You can get the Android plugin with the Gradle dependency from Jitpack
-- https://jitpack.io/#afaucogney/flipper-backstack
+The idea behind this plugin is to enable understanding of what is happening during the usage of an Android Application by :
 
-## Content
+ - seeing logs about object life cycle changes
+ - seeing internal Android object structure (limited to a set of specific architecture)
+ - seeing objects stacks (FragmentManager BackStack, Jetpack Navigation Stack)
+ - seeing current running objects
+ - seeing objects destroyed (in Trash)
+
+## Show me a ScreenShot !
 
 ![alt text](./screenshot/flipper_android_lifecyle_4.1.0.png)
 
-### Left part 
-
-You can :
-
-- see the app object structure
- - application
- - activities
- - fragments
- - viewModels (with reflexion)
- - viewModel members (liveDatas) (with reflexion)
- - jobs (not yet available)
- - services (not yet available)
- - trash (objects destroyed)
- - backstack (legacy)
- - backstack (jetpack navigation)
+### What is in the Left part ?
+
+You can see the app object structure :
+
+ - Application
+ - Activities
+ - Fragments
+ - ViewModels (with reflexion)
+ - ViewModel members (LiveDatas) (with reflexion)
+ - Jobs (not yet available)
+ - Services (not yet available)
+ - Trash (objects destroyed)
+ - FragmentManager BackStack (legacy, only for activity)
+ - JetPack Navigation BackStack
 
- The object structure is view as a tree, where each instance of an object has is dedicated object category.
+The object structure is viewed as a tree, where each instance of an object has is dedicated object category.
 
  - `HomeFragment` parent is `fragments`
  - `HomeFragment` children are running instances of `HomeFragment`
 
-- filter objects in the tree (not yet available) 
-
-### Right part
-
-You can :
+### What is in the Right part ?
 
-- see the object lifeCycle events for
+You can see the object lifeCycle events for :
   - activities
   - fragments
 
-- filter those event categories 
- - created/destroyed
- - started, stopped
- - paused, resumed
- - attached/ detached
- - ViewCreated
+You can filter those event categories :
+ - created / destroyed
+ - started / stopped
+ - paused / resumed
+ - attached / detached
+ - view-created / view-destroyed
  - SaveInstanceState     
 
 ## Installation
 
-### Android
+### Step 1 : Add the JitPack repository to your build file
 
 Add it in your root build.gradle at the end of repositories:
 
@@ -73,17 +87,41 @@ Add it in your root build.gradle at the end of repositories:
 			maven { url 'https://jitpack.io' }
 		}
 	}
-Step 2. Add the dependency
+
+### Step 2 : Add the dependency
 
 	dependencies {
-	        implementation 'com.github.afaucogney:flipper-backstack:b1329a419a'
+		debugImplementation 'com.github.afaucogney:flipper-backstack:-SNAPSHOT'
 	}
+	
+### Step 3 : Add Flipper to your app
+
+Follow the [Getting Started](https://fbflipper.com/docs/getting-started/android-native) section of the Flipper documentation
+
+### Step 4 : Add the Android-Object-LifeCycle plugin to Flipper
+
+In your application, register the plugin the Flipper configuration.
+
+    val client: FlipperClient = AndroidFlipperClient.getInstance(this)
+    with(client) {
+        addPlugin(
+            InspectorFlipperPlugin(
+                this@App,
+                DescriptorMapping.withDefaults()
+            )
+        )
+        ... 
+        addPlugin(BackStackFlipperPlugin(this@App))
+        start()
+    }	
+	
+Be careful, to not embed this library in production !
 
-### Flipper Desktop
+### Step 5 : Add the Android-Object-LifeCycle plugin to Flipper-Desktop
 
 Install the plgin in Flipper, it is called `lifecycle` [Npm page](https://www.npmjs.com/package/flipper-plugin-lifecycle)
 
-## What can you achieve with the plugin 
+## What can you achieve with the plugin ?
 
  - identify runtime object instances and structure
  - identify leaks (remaining objects)
@@ -93,19 +131,32 @@ Install the plgin in Flipper, it is called `lifecycle` [Npm page](https://www.np
  - lifeCycle issues
  - backStack issues
 
+## Consideration
+
+- This plugin (as Flipper) must not be shipped in Production
+- This plugin may doing lot of work, so please consider disabling it if you are not using it. I have not yet done measurement to evalute it resource requirement. But from the `5.0.0` version
+ - It should run on Background tread thank to Rx
+ - However, data structure of the app is kept in memory, so it may be a problem for some App or some low memory devices
+- The Plugin uses Reflection for accessing privage properties or functions
+
 ## TODO
 
 - [ ] Be able to filter object in structure
- - [ ] Save option in client (duplex)
  - [ ] Impact event filtering from object
 - [ ] Evaluate saving data in db / shareprefs
 - [ ] Handle clean versioning / release
 - [ ] Generate docs
-- [ ] Embed Desktop Code Source here 
-- [ ] Impl Jobs
-- [ ] Impl Services
+- [ ] Impl Jobs support
+- [ ] Impl Services support
 - [ ] See bundle / saveinstance state
 - [ ] See App lifecycle
+- [ ] Evaluated StateFlow support (on going PR)
+- [ ] Imp BlackStack for ChildFragmentManager
+- [ ] Highligh duplicate object in the tree if you click on it (see link between framgnet in stack...)
+
+## ISSUES
+
+- [ ] At first start, the tree is not updated ! You need to change screen to update the plugin.
 
 
 

Diff for: app/src/main/java/fr/afaucogney/mobile/android/flipper/flipperandroidbackstack/App.kt

@@ -12,9 +12,7 @@ class App : Application() {
     override fun onCreate() {
         super.onCreate()
 
-//        if (BuildConfig.DEBUG) {
         SoLoader.init(this, false)
-//            if (FlipperUtils.shouldEnableFlipper(this)) {
         val client: FlipperClient = AndroidFlipperClient.getInstance(this)
         with(client) {
             addPlugin(

Diff for: flipper-backstack/build.gradle

@@ -61,7 +61,7 @@ afterEvaluate {
                 // You can then customize attributes of the publication as shown below.
                 groupId = 'fr.afaucogney.mobile.flipper'
                 artifactId = 'android-objects-lifecycle'
-                version = '0.5.1'
+                version = '0.5.2'
             }
         }
     }