Merge pull request #133 from ToxicBakery/feature/build-config-plugin

#132 Added BuildConfig plugin

Author: Kritarie

README.md

@@ -70,6 +70,7 @@ debugImplementation 'com.willowtreeapps.hyperion:hyperion-crash:0.9.23'
 debugImplementation 'com.willowtreeapps.hyperion:hyperion-shared-preferences:0.9.23'
 debugImplementation 'com.willowtreeapps.hyperion:hyperion-geiger-counter:0.9.23'
 debugImplementation 'com.willowtreeapps.hyperion:hyperion-timber:0.9.23'
+debugImplementation 'com.willowtreeapps.hyperion:hyperion-build-config:0.9.23'
 ```
 
 ## Adding Plugins
@@ -94,6 +95,7 @@ The following is a list of all plugins that integrate with Hyperion. Please make
 - [Hyperion-Geiger-Counter](https://github.com/willowtreeapps/Hyperion-Android/tree/develop/hyperion-geiger-counter) - Check animation performance by listening for dropped frames. Please turn up the media volume. Haptic feedback is also supported. Inspired by [KMCGeigerCounter](https://github.com/kconner/KMCGeigerCounter).
 - [Hyperion-Timber](https://github.com/willowtreeapps/Hyperion-Android/tree/develop/hyperion-timber) - View Timber recorded log messages.
 - [Hyperion-Shared-Preferences](https://github.com/willowtreeapps/Hyperion-Android/tree/develop/hyperion-shared-preferences) - View and edit your app\'s key-value storage.
+- [Hyperion-Build-Config](https://github.com/willowtreeapps/Hyperion-Android/tree/develop/hyperion-build-config) - View application BuildConfig values.
 
 ## License
 Hyperion is available under the MIT license. See the LICENSE file for more info.

hyperion-build-config/.gitignore

@@ -0,0 +1 @@
+/build

hyperion-build-config/README.md

@@ -0,0 +1,10 @@
+# Build Config
+Plugin for viewing the BuildConfig values of the application.
+
+## Notes
+If minification is enabled for your debug builds, you will likely want to update proguard to keep your BuildConfig class.  
+
+Update to match your package name.
+```
+-keep class com.willowtreeapps.hyperion.sample.BuildConfig { *; }
+```

hyperion-build-config/build.gradle

@@ -0,0 +1,35 @@
+apply plugin: 'com.android.library'
+apply from: '../publish.gradle'
+
+group = project.libraryGroup
+version = project.libraryVersion
+
+android {
+    compileSdkVersion project.compileSdkVersion
+    buildToolsVersion project.buildToolsVersion
+
+    defaultConfig {
+        minSdkVersion project.minSdkVersion
+        targetSdkVersion project.targetSdkVersion
+        versionCode buildVersionCode()
+        versionName version
+
+        testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
+    }
+
+    lintOptions {
+        abortOnError false
+    }
+
+    resourcePrefix 'hbc_'
+}
+
+dependencies {
+    testImplementation "junit:junit:4.12"
+    api project(':hyperion-plugin')
+    implementation "com.android.support:appcompat-v7:${project.versionSupportLibrary}"
+    annotationProcessor "com.google.auto.service:auto-service:${project.versionAutoService}"
+    implementation "com.android.support:recyclerview-v7:${project.versionSupportLibrary}"
+    implementation "com.android.support:design:${project.versionSupportLibrary}"
+    implementation 'com.android.support.constraint:constraint-layout:1.1.2'
+}

hyperion-build-config/src/main/AndroidManifest.xml

@@ -0,0 +1,11 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.willowtreeapps.hyperion.buildconfig">
+
+    <application>
+        <activity
+            android:name=".list.BuildConfigListActivity"
+            android:theme="@style/hbc_BuildConfigActivityTheme"
+            android:windowSoftInputMode="stateHidden" />
+    </application>
+
+</manifest>

hyperion-build-config/src/main/java/com/willowtreeapps/hyperion/buildconfig/BuildConfigPlugin.java

@@ -0,0 +1,18 @@
+package com.willowtreeapps.hyperion.buildconfig;
+
+import android.support.annotation.Nullable;
+
+import com.google.auto.service.AutoService;
+import com.willowtreeapps.hyperion.plugin.v1.Plugin;
+import com.willowtreeapps.hyperion.plugin.v1.PluginModule;
+
+@AutoService(Plugin.class)
+public class BuildConfigPlugin extends Plugin {
+
+    @Nullable
+    @Override
+    public PluginModule createPluginModule() {
+        return new BuildConfigPluginModule();
+    }
+
+}

hyperion-build-config/src/main/java/com/willowtreeapps/hyperion/buildconfig/BuildConfigPluginModule.java

@@ -0,0 +1,28 @@
+package com.willowtreeapps.hyperion.buildconfig;
+
+import android.content.Intent;
+import android.support.annotation.NonNull;
+import android.support.annotation.Nullable;
+import android.view.LayoutInflater;
+import android.view.View;
+import android.view.ViewGroup;
+
+import com.willowtreeapps.hyperion.buildconfig.list.BuildConfigListActivity;
+import com.willowtreeapps.hyperion.plugin.v1.PluginModule;
+
+class BuildConfigPluginModule extends PluginModule implements View.OnClickListener {
+
+    @Nullable
+    @Override
+    public View createPluginView(@NonNull LayoutInflater layoutInflater, @NonNull ViewGroup parent) {
+        View view = layoutInflater.inflate(R.layout.hbc_item_plugin, parent, false);
+        view.setOnClickListener(this);
+        return view;
+    }
+
+    @Override
+    public void onClick(View v) {
+        Intent intent = new Intent(getContext(), BuildConfigListActivity.class);
+        getContext().startActivity(intent);
+    }
+}

hyperion-build-config/src/main/java/com/willowtreeapps/hyperion/buildconfig/list/BuildConfigListActivity.java

@@ -0,0 +1,69 @@
+package com.willowtreeapps.hyperion.buildconfig.list;
+
+import android.os.Bundle;
+import android.support.annotation.Nullable;
+import android.support.v7.app.ActionBar;
+import android.support.v7.app.AppCompatActivity;
+import android.support.v7.widget.LinearLayoutManager;
+import android.support.v7.widget.RecyclerView;
+import android.support.v7.widget.Toolbar;
+import android.util.Log;
+
+import com.willowtreeapps.hyperion.buildconfig.R;
+import com.willowtreeapps.hyperion.buildconfig.model.BuildConfigValue;
+import com.willowtreeapps.hyperion.plugin.v1.HyperionIgnore;
+
+import java.lang.reflect.Field;
+import java.lang.reflect.Modifier;
+import java.util.LinkedList;
+import java.util.List;
+
+@HyperionIgnore
+public class BuildConfigListActivity extends AppCompatActivity {
+
+    private static final String TAG = "BuildConfig";
+
+    @Override
+    protected void onCreate(@Nullable Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        setContentView(R.layout.hbc_activity_build_config_list);
+        setSupportActionBar((Toolbar) findViewById(R.id.tmb_toolbar));
+        ActionBar actionBar = getSupportActionBar();
+        if (actionBar != null) {
+            actionBar.setDisplayHomeAsUpEnabled(true);
+        }
+
+        RecyclerView recyclerView = findViewById(R.id.hbc_recycler);
+        recyclerView.setLayoutManager(new LinearLayoutManager(this));
+        recyclerView.setAdapter(new BuildConfigListAdapter(getBuildConfigValues()));
+    }
+
+    @Override
+    public boolean onSupportNavigateUp() {
+        onBackPressed();
+        return true;
+    }
+
+    private List<BuildConfigValue> getBuildConfigValues() {
+        List<BuildConfigValue> buildConfigValues = new LinkedList<>();
+        try {
+            Class<?> buildConfigClass = Class.forName(getPackageName() + ".BuildConfig");
+            Log.d(TAG, "Checking BuildConfig " + buildConfigClass.getName());
+            Field[] declaredFields = buildConfigClass.getDeclaredFields();
+            for (Field declaredField : declaredFields) {
+                Log.d(TAG, "Inspecting " + declaredField.toString());
+                if (Modifier.isStatic(declaredField.getModifiers())) {
+                    Class<?> fieldType = declaredField.getType();
+                    String name = declaredField.getName() + " (" + fieldType.getSimpleName() + ")";
+                    String value = declaredField.get(null).toString();
+                    buildConfigValues.add(new BuildConfigValue(name, value));
+                }
+            }
+        } catch (Exception e) {
+            Log.e(TAG, "Failed to read BuildConfig", e);
+        }
+
+        return buildConfigValues;
+    }
+
+}

hyperion-build-config/src/main/java/com/willowtreeapps/hyperion/buildconfig/list/BuildConfigListAdapter.java

@@ -0,0 +1,41 @@
+package com.willowtreeapps.hyperion.buildconfig.list;
+
+import android.support.annotation.NonNull;
+import android.support.v7.widget.RecyclerView;
+import android.view.LayoutInflater;
+import android.view.View;
+import android.view.ViewGroup;
+
+import com.willowtreeapps.hyperion.buildconfig.R;
+import com.willowtreeapps.hyperion.buildconfig.model.BuildConfigValue;
+
+import java.util.ArrayList;
+import java.util.List;
+
+class BuildConfigListAdapter extends RecyclerView.Adapter<BuildConfigViewHolder> {
+
+    private final List<BuildConfigValue> buildConfigValues;
+
+    BuildConfigListAdapter(List<BuildConfigValue> buildConfigValues) {
+        this.buildConfigValues = new ArrayList<>(buildConfigValues);
+    }
+
+    @NonNull
+    @Override
+    public BuildConfigViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
+        final View itemView = LayoutInflater.from(parent.getContext())
+                .inflate(R.layout.hbc_value_row, parent, false);
+        return new BuildConfigViewHolder(itemView);
+    }
+
+    @Override
+    public void onBindViewHolder(@NonNull BuildConfigViewHolder holder, int position) {
+        BuildConfigValue buildConfigValue = buildConfigValues.get(position);
+        holder.bind(buildConfigValue);
+    }
+
+    @Override
+    public int getItemCount() {
+        return buildConfigValues.size();
+    }
+}

hyperion-build-config/src/main/java/com/willowtreeapps/hyperion/buildconfig/list/BuildConfigViewHolder.java

@@ -0,0 +1,26 @@
+package com.willowtreeapps.hyperion.buildconfig.list;
+
+import android.support.v7.widget.RecyclerView;
+import android.view.View;
+import android.widget.TextView;
+
+import com.willowtreeapps.hyperion.buildconfig.R;
+import com.willowtreeapps.hyperion.buildconfig.model.BuildConfigValue;
+
+class BuildConfigViewHolder extends RecyclerView.ViewHolder {
+
+    private final TextView logDateTextView;
+    private final TextView logMsgTextView;
+
+    BuildConfigViewHolder(View itemView) {
+        super(itemView);
+        logDateTextView = itemView.findViewById(R.id.hbc_name);
+        logMsgTextView = itemView.findViewById(R.id.hbc_value);
+    }
+
+    void bind(BuildConfigValue buildConfigValue) {
+        logDateTextView.setText(buildConfigValue.getName());
+        logMsgTextView.setText(buildConfigValue.getValue());
+    }
+
+}