pnu refactoring project by team 9

app/build.gradle

@@ -46,6 +46,8 @@ android {
         applicationId 'com.kabouzeid.gramophone'
         versionCode 179
         versionName '1.3.5'
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+
     }
     signingConfigs {
         release {
@@ -126,4 +128,11 @@ dependencies {
     implementation 'org.eclipse.mylyn.github:org.eclipse.egit.github.core:2.1.5'
 
     implementation 'com.github.AdrienPoupa:jaudiotagger:2.2.3'
+
+// Required -- JUnit 4 framework
+    testImplementation 'junit:junit:4.12'
+    // Optional -- Robolectric environment
+    testImplementation 'androidx.test:core:1.0.0'
+    // Optional -- Mockito framework
+    testImplementation 'org.mockito:mockito-core:1.10.19'
 }

app/src/main/java/com/kabouzeid/gramophone/dialogs/AddToPlaylistDialog.java

@@ -40,11 +40,8 @@ public static AddToPlaylistDialog create(List<Song> songs) {
     @Override
     public Dialog onCreateDialog(Bundle savedInstanceState) {
         final List<Playlist> playlists = PlaylistLoader.getAllPlaylists(getActivity());
-        CharSequence[] playlistNames = new CharSequence[playlists.size() + 1];
-        playlistNames[0] = getActivity().getResources().getString(R.string.action_new_playlist);
-        for (int i = 1; i < playlistNames.length; i++) {
-            playlistNames[i] = playlists.get(i - 1).name;
-        }
+        CharSequence[] playlistNames = getPlaylistNames(playlists);
+
         return new MaterialDialog.Builder(getActivity())
                 .title(R.string.add_playlist_title)
                 .items(playlistNames)
@@ -62,4 +59,13 @@ public Dialog onCreateDialog(Bundle savedInstanceState) {
                 })
                 .build();
     }
+
+    private CharSequence[] getPlaylistNames(List<Playlist> playlists){
+        CharSequence[] playlistNames = new CharSequence[playlists.size() + 1];
+        playlistNames[0] = getActivity().getResources().getString(R.string.action_new_playlist);
+        for (int i = 1; i < playlistNames.length; i++) {
+            playlistNames[i] = playlists.get(i - 1).name;
+        }
+        return playlistNames;
+    }
 }

app/src/main/java/com/kabouzeid/gramophone/dialogs/BlacklistFolderChooserDialog.java

@@ -23,47 +23,11 @@
 /**
  * @author Aidan Follestad (afollestad), modified by Karim Abou Zeid
  */
-public class BlacklistFolderChooserDialog extends DialogFragment implements MaterialDialog.ListCallback {
 
-    private File parentFolder;
-    private File[] parentContents;
-    private boolean canGoUp = false;
+public class BlacklistFolderChooserDialog extends ChooserDialog implements MaterialDialog.ListCallback {
 
     private FolderCallback callback;
 
-    String initialPath = Environment.getExternalStorageDirectory().getAbsolutePath();
-
-    private String[] getContentsArray() {
-        if (parentContents == null) {
-            if (canGoUp) {
-                return new String[]{".."};
-            }
-            return new String[]{};
-        }
-        String[] results = new String[parentContents.length + (canGoUp ? 1 : 0)];
-        if (canGoUp) {
-            results[0] = "..";
-        }
-        for (int i = 0; i < parentContents.length; i++) {
-            results[canGoUp ? i + 1 : i] = parentContents[i].getName();
-        }
-        return results;
-    }
-
-    private File[] listFiles() {
-        File[] contents = parentFolder.listFiles();
-        List<File> results = new ArrayList<>();
-        if (contents != null) {
-            for (File fi : contents) {
-                if (fi.isDirectory()) {
-                    results.add(fi);
-                }
-            }
-            Collections.sort(results, new FolderSorter());
-            return results.toArray(new File[results.size()]);
-        }
-        return null;
-    }
 
     public static BlacklistFolderChooserDialog create() {
         return new BlacklistFolderChooserDialog();
@@ -72,10 +36,8 @@ public static BlacklistFolderChooserDialog create() {
     @NonNull
     @Override
     public Dialog onCreateDialog(Bundle savedInstanceState) {
-        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M
-                && ActivityCompat.checkSelfPermission(
-                getActivity(), Manifest.permission.READ_EXTERNAL_STORAGE)
-                != PackageManager.PERMISSION_GRANTED) {
+        if (isSDKAboveAndroidMarshmallow
+                && isNotGrantedPermissionToReadExternalStorage) {
             return new MaterialDialog.Builder(getActivity())
                     .title(R.string.md_error_label)
                     .content(R.string.md_storage_perm_error)
@@ -88,18 +50,20 @@ public Dialog onCreateDialog(Bundle savedInstanceState) {
         if (!savedInstanceState.containsKey("current_path")) {
             savedInstanceState.putString("current_path", initialPath);
         }
-        parentFolder = new File(savedInstanceState.getString("current_path", File.pathSeparator));
+
+        setParentFolder(new File(savedInstanceState.getString("current_path", File.pathSeparator)));
+
         checkIfCanGoUp();
-        parentContents = listFiles();
+        setParentContents(listFiles());
         MaterialDialog.Builder builder =
                 new MaterialDialog.Builder(getActivity())
-                        .title(parentFolder.getAbsolutePath())
+                        .title(getParentFolder().getAbsolutePath())
                         .items((CharSequence[]) getContentsArray())
                         .itemsCallback(this)
                         .autoDismiss(false)
                         .onPositive((dialog, which) -> {
                             dismiss();
-                            callback.onFolderSelection(BlacklistFolderChooserDialog.this, parentFolder);
+                            callback.onFolderSelection(BlacklistFolderChooserDialog.this, getParentFolder());
                         })
                         .onNegative((materialDialog, dialogAction) -> dismiss())
                         .positiveText(R.string.add_action)
@@ -110,37 +74,21 @@ public Dialog onCreateDialog(Bundle savedInstanceState) {
     @Override
     public void onSelection(MaterialDialog materialDialog, View view, int i, CharSequence s) {
         if (canGoUp && i == 0) {
-            parentFolder = parentFolder.getParentFile();
-            if (parentFolder.getAbsolutePath().equals("/storage/emulated")) {
-                parentFolder = parentFolder.getParentFile();
+            setParentFolder(getParentFolder().getParentFile());
+            if (getParentFolder().getAbsolutePath().equals("/storage/emulated")) {
+                setParentFolder(getParentFolder().getParentFile());
             }
             checkIfCanGoUp();
         } else {
-            parentFolder = parentContents[canGoUp ? i - 1 : i];
+            setParentFolder(getParentContents()[canGoUp ? i - 1 : i]);
             canGoUp = true;
-            if (parentFolder.getAbsolutePath().equals("/storage/emulated")) {
-                parentFolder = Environment.getExternalStorageDirectory();
+            if (getParentFolder().getAbsolutePath().equals("/storage/emulated")) {
+                setParentFolder(Environment.getExternalStorageDirectory());
             }
         }
         reload();
     }
 
-    private void checkIfCanGoUp() {
-        canGoUp = parentFolder.getParent() != null;
-    }
-
-    private void reload() {
-        parentContents = listFiles();
-        MaterialDialog dialog = (MaterialDialog) getDialog();
-        dialog.setTitle(parentFolder.getAbsolutePath());
-        dialog.setItems((CharSequence[]) getContentsArray());
-    }
-
-    @Override
-    public void onSaveInstanceState(Bundle outState) {
-        super.onSaveInstanceState(outState);
-        outState.putString("current_path", parentFolder.getAbsolutePath());
-    }
 
     public void setCallback(FolderCallback callback) {
         this.callback = callback;
@@ -150,11 +98,5 @@ public interface FolderCallback {
         void onFolderSelection(@NonNull BlacklistFolderChooserDialog dialog, @NonNull File folder);
     }
 
-    private static class FolderSorter implements Comparator<File> {
 
-        @Override
-        public int compare(File lhs, File rhs) {
-            return lhs.getName().compareTo(rhs.getName());
-        }
-    }
 }

app/src/main/java/com/kabouzeid/gramophone/dialogs/ChangelogDialog.java

@@ -10,7 +10,6 @@
 import androidx.annotation.NonNull;
 import androidx.fragment.app.DialogFragment;
 
-import android.util.Log;
 import android.view.InflateException;
 import android.view.LayoutInflater;
 import android.view.View;
@@ -61,6 +60,11 @@ public Dialog onCreateDialog(Bundle savedInstanceState) {
                 })
                 .build();
 
+        loadWebView(customView);
+        return dialog;
+    }
+
+    private void loadWebView(View customView) {
         final WebView webView = customView.findViewById(R.id.web_view);
         try {
             // Load from phonograph-changelog.html in the assets folder
@@ -84,7 +88,6 @@ public Dialog onCreateDialog(Bundle savedInstanceState) {
         } catch (Throwable e) {
             webView.loadData("<h1>Unable to load</h1><p>" + e.getLocalizedMessage() + "</p>", "text/html", "UTF-8");
         }
-        return dialog;
     }
 
     public static void setChangelogRead(@NonNull Context context) {

app/src/main/java/com/kabouzeid/gramophone/dialogs/ChooserDialog.java

@@ -0,0 +1,111 @@
+package com.kabouzeid.gramophone.dialogs;
+
+import android.Manifest;
+import android.content.pm.PackageManager;
+import android.os.Build;
+import android.os.Bundle;
+import android.os.Environment;
+
+import androidx.core.app.ActivityCompat;
+import androidx.fragment.app.DialogFragment;
+
+import com.afollestad.materialdialogs.MaterialDialog;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
+
+public class ChooserDialog extends DialogFragment{
+    String initialPath = Environment.getExternalStorageDirectory().getAbsolutePath();
+    private File parentFolder;
+    private File[] parentContents;
+
+    protected File getParentFolder() {
+        return parentFolder;
+    }
+
+    protected void setParentFolder(File parentFolder) {
+        this.parentFolder = parentFolder;
+    }
+
+    protected File[] getParentContents() {
+        return parentContents;
+    }
+
+    protected void setParentContents(File[] parentContents) {
+        this.parentContents = parentContents;
+    }
+
+    protected boolean isCanGoUp() {
+        return canGoUp;
+    }
+
+    protected void setCanGoUp(boolean canGoUp) {
+        this.canGoUp = canGoUp;
+    }
+
+    protected boolean canGoUp = false;
+
+    protected final boolean isSDKAboveAndroidMarshmallow = Build.VERSION.SDK_INT >= Build.VERSION_CODES.M;
+    protected final boolean isNotGrantedPermissionToReadExternalStorage = ActivityCompat.checkSelfPermission(
+            getActivity(), Manifest.permission.READ_EXTERNAL_STORAGE)
+            != PackageManager.PERMISSION_GRANTED;
+
+    protected String[] getContentsArray() {
+        if (parentContents == null) {
+            if (canGoUp) {
+                return new String[]{".."};
+            }
+            return new String[]{};
+        }
+        String[] results = new String[parentContents.length + (canGoUp ? 1 : 0)];
+        if (canGoUp) {
+            results[0] = "..";
+        }
+        for (int i = 0; i < parentContents.length; i++) {
+            results[canGoUp ? i + 1 : i] = parentContents[i].getName();
+        }
+        return results;
+    }
+
+    protected File[] listFiles() {
+        File[] contents = parentFolder.listFiles();
+        List<File> results = new ArrayList<>();
+        if (contents != null) {
+            for (File fi : contents) {
+                if (fi.isDirectory()) {
+                    results.add(fi);
+                }
+            }
+            Collections.sort(results, new FolderSorter());
+            return results.toArray(new File[results.size()]);
+        }
+        return null;
+    }
+
+    protected void checkIfCanGoUp() {
+        canGoUp = parentFolder.getParent() != null;
+    }
+
+    protected void reload() {
+        parentContents = listFiles();
+        MaterialDialog dialog = (MaterialDialog) getDialog();
+        dialog.setTitle(parentFolder.getAbsolutePath());
+        dialog.setItems((CharSequence[]) getContentsArray());
+    }
+
+    @Override
+    public void onSaveInstanceState(Bundle outState) {
+        super.onSaveInstanceState(outState);
+        outState.putString("current_path", parentFolder.getAbsolutePath());
+    }
+
+    protected static class FolderSorter implements Comparator<File> {
+        @Override
+        public int compare(File lhs, File rhs) {
+            return lhs.getName().compareTo(rhs.getName());
+        }
+    }
+}

app/src/main/java/com/kabouzeid/gramophone/dialogs/CreatePlaylistDialog.java

@@ -62,13 +62,7 @@ public Dialog onCreateDialog(Bundle savedInstanceState) {
                     if (!name.isEmpty()) {
                         if (!PlaylistsUtil.doesPlaylistExist(getActivity(), name)) {
                             final long playlistId = PlaylistsUtil.createPlaylist(getActivity(), name);
-                            if (getActivity() != null) {
-                                //noinspection unchecked
-                                List<Song> songs = getArguments().getParcelableArrayList(SONGS);
-                                if (songs != null && !songs.isEmpty()) {
-                                    PlaylistsUtil.addToPlaylist(getActivity(), songs, playlistId, true);
-                                }
-                            }
+                            addSongsToPlayList(playlistId);
                         } else {
                             Toast.makeText(getActivity(), getActivity().getResources().getString(
                                     R.string.playlist_exists, name), Toast.LENGTH_SHORT).show();
@@ -77,4 +71,14 @@ public Dialog onCreateDialog(Bundle savedInstanceState) {
                 })
                 .build();
     }
+
+    private void addSongsToPlayList(long playlistId) {
+        if (getActivity() != null) {
+            //noinspection unchecked
+            List<Song> songs = getArguments().getParcelableArrayList(SONGS);
+            if (songs != null && !songs.isEmpty()) {
+                PlaylistsUtil.addToPlaylist(getActivity(), songs, playlistId, true);
+            }
+        }
+    }
 }