Merge pull request willowtreeapps#74 from ToxicBakery/feature/alphabetical-sort

willowtreeapps#73 Alphabetically sort modules in the hyperion list

Author: Kritarie

hyperion-core/src/main/java/com/willowtreeapps/hyperion/core/internal/HyperionPluginView.java

@@ -20,7 +20,9 @@
 import com.willowtreeapps.hyperion.plugin.v1.MenuState;
 import com.willowtreeapps.hyperion.plugin.v1.PluginModule;
 
+import java.util.Comparator;
 import java.util.Set;
+import java.util.TreeSet;
 
 import javax.inject.Inject;
 
@@ -98,7 +100,10 @@ public void call(Try<Plugins> result) {
     private void populatePluginList(Try<Plugins> result) {
         try {
             final Plugins plugins = result.get();
-            modules = plugins.createModules();
+            final Comparator<PluginModule> comparator = new AlphabeticalComparator(getContext());
+            final Set<PluginModule> sortedModules = new TreeSet<>(comparator);
+            sortedModules.addAll(plugins.createModules());
+            this.modules = sortedModules;
         } catch (Throwable t) {
             // TODO
             t.printStackTrace();
@@ -125,4 +130,26 @@ protected void onDetachedFromWindow() {
         }
         pluginExtension.setHyperionMenu(null);
     }
+
+    private static final class AlphabeticalComparator implements Comparator<PluginModule> {
+
+        private final Context context;
+
+        private AlphabeticalComparator(Context context) {
+            this.context = context;
+        }
+
+        @Override
+        public int compare(PluginModule left, PluginModule right) {
+            String leftName = getName(left);
+            String rightName = getName(right);
+            return leftName.compareTo(rightName);
+        }
+
+        private String getName(PluginModule pluginModule) {
+            int resName = pluginModule.getName();
+            if (resName == R.string.hype_module_name) return pluginModule.getClass().getSimpleName();
+            else return context.getString(resName);
+        }
+    }
 }

hyperion-plugin/src/main/java/com/willowtreeapps/hyperion/plugin/v1/PluginModule.java

@@ -3,10 +3,13 @@
 import android.content.Context;
 import android.support.annotation.NonNull;
 import android.support.annotation.Nullable;
+import android.support.annotation.StringRes;
 import android.view.LayoutInflater;
 import android.view.View;
 import android.view.ViewGroup;
 
+import com.willowtreeapps.hyperion.plugin.R;
+
 public abstract class PluginModule {
 
     private PluginExtension extension;
@@ -18,6 +21,16 @@ public final void create(PluginExtension extension, Context context) {
         onCreate();
     }
 
+    /**
+     * The name of the plugin module. This should be the same name as displayed by the returned plugin view.
+     *
+     * @return the name of the plugin module
+     */
+    @StringRes
+    public int getName() {
+        return R.string.hype_module_name;
+    }
+
     protected void onCreate() {
 
     }

hyperion-plugin/src/main/res/values/strings.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+<string name="hype_module_name">Hyperion Plugin</string>
+</resources>