Merge pull request #9 from ben-gibson/add-tests

dev: Refactoring and added tests

Author: ben-gibson

build.gradle

@@ -7,10 +7,13 @@ apply plugin: 'java'
 
 repositories {
     jcenter()
+    mavenCentral()
 }
 
 dependencies {
     testCompile "org.mockito:mockito-core:1.+"
+    testCompile group: 'junit', name: 'junit', version: '4.12'
+    testCompile group: 'com.tngtech.java', name: 'junit-dataprovider', version: '1.10.0'
 }
 
 sourceSets {
@@ -36,4 +39,4 @@ intellij {
     pluginName 'RemoteRepositoryMapper'
     updateSinceUntilBuild false
     sameSinceUntilBuild false
-}
+}

remote-repository-mapper.iml

@@ -121,9 +121,11 @@
     <orderEntry type="library" exported="" name="Gradle: com.jetbrains:remote-servers-git:14.1.4" level="project" />
     <orderEntry type="library" exported="" name="Gradle: com.jetbrains:trilead-ssh2:14.1.4" level="project" />
     <orderEntry type="library" exported="" scope="RUNTIME" name="Gradle: com.jetbrains:tools:14.1.4" level="project" />
-    <orderEntry type="library" exported="" name="Gradle: com.jetbrains:resources_en:14.1.4" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.mockito:mockito-core:1.10.19" level="project" />
-    <orderEntry type="library" scope="TEST" name="Gradle: org.hamcrest:hamcrest-core:1.1" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.objenesis:objenesis:2.1" level="project" />
+    <orderEntry type="library" exported="" name="Gradle: com.jetbrains:resources_en:14.1.4" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: junit:junit:4.12" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: com.tngtech.java:junit-dataprovider:1.10.0" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: org.hamcrest:hamcrest-core:1.3" level="project" />
   </component>
 </module>

resources/META-INF/plugin.xml

@@ -1,31 +1,27 @@
 <idea-plugin version="2">
   <id>uk.co.ben-gibson.remote.repository.mapper</id>
   <name>Remote Repository Mapper</name>
-  <version>1.1</version>
+  <version>1.2</version>
   <vendor url="h">https://github.com/ben-gibson/remote-repository-mapper</vendor>
 
   <description><![CDATA[
-      Opens a local file under git version control in its remote origin repository.
-      <br />
-      <br />
-      This is a really simple plugin that provides a way to quickly share some source code via its remote repository.
+      This is a really simple plugin that provides a convenient shortcut to open a git version controlled file from
+      PhpStorm in its origin repository. This can be useful, for example, if you need to share the code with someone or
+      just get quick access to it in the remote repository.
       <br />
       <br />
       After installing select your remote repository provider in Settings &rarr; Other Settings &rarr; Remote Repository Mapper
       (currently supports GitHub, Stash, BitBucket, GitLab).
       <br />
       <br />
       To use, open a file that is under git version control in the editor and select File &rarr; Open in remote repository
-      (the current checked out branch is used unless it does not track a remote branch, in which case it defaults to using master).
-      <br />
-      <br />
-      The resulting link can be copied to the clipboard depending on your preference in the settings.
+      (the active branch is used unless it does not track a remote branch in which case it defaults to using master).
     ]]></description>
 
   <change-notes><![CDATA[
     <ul>
-      <li>Added BitBucket as a provider</li>
-      <li>Added GitLab as a provider</li>
+      <li>Added support for BitBucket</li>
+      <li>Added support for GitLab</li>
      </ul>
     ]]>
   </change-notes>

src/uk/co/ben_gibson/repositorymapper/Context/Context.java

@@ -96,7 +96,7 @@ public String getBranch()
      * @return String
      */
     @NotNull
-    public String getRepositoryRelativeFilePath()
+    public String getFilePathRelativeToRepository()
     {
         return this.file.getPath().substring(this.repository.getRoot().getPath().length());
     }

src/uk/co/ben_gibson/repositorymapper/OpenContextAction.java

@@ -19,7 +19,6 @@
 import com.intellij.openapi.project.Project;
 import uk.co.ben_gibson.repositorymapper.UrlFactory.UrlFactoryProvider;
 import java.awt.*;
-import java.awt.datatransfer.Clipboard;
 import java.awt.datatransfer.StringSelection;
 import java.net.URL;
 
@@ -57,8 +56,7 @@ public void actionPerformed(AnActionEvent event)
             URL url = urlFactoryProvider.getUrlFactoryForProvider(settings.getRepositoryProvider()).getUrlFromContext(context);
 
             if (settings.getCopyToClipboard()) {
-                Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
-                clipboard.setContents(new StringSelection(url.toString()), null);
+                Toolkit.getDefaultToolkit().getSystemClipboard().setContents(new StringSelection(url.toString()), null);
             }
 
             BrowserLauncher.getInstance().browse(url.toURI());
@@ -111,6 +109,8 @@ public Context getContext(@NotNull Project project)
 
         Integer caretPosition = editor.getCaretModel().getLogicalPosition().line + 1;
 
-        return new Context(new Repository(repository, "master"), file, caretPosition);
+        Repository repositoryWrapper = new Repository(repository, "master");
+
+        return new Context(repositoryWrapper, file, caretPosition);
     }
 }

src/uk/co/ben_gibson/repositorymapper/Repository/Exception/BranchNotFoundException.java

@@ -22,7 +22,7 @@ public BranchNotFoundException(String message)
 
 
     /**
-     * Could not find active branch with a remote.
+     * Could not find active branch that tracked a remote branch.
      *
      * @return BranchNotFoundException
      */
@@ -31,4 +31,4 @@ public static BranchNotFoundException activeBranchWithRemoteTrackingNotFound()
     {
         return new BranchNotFoundException("Could not find an active branch that tracked a remote branch");
     }
-}
+}

src/uk/co/ben_gibson/repositorymapper/Repository/Exception/RemoteNotFoundException.java

@@ -22,19 +22,21 @@ public RemoteNotFoundException(String message)
 
 
     /**
-     * Could not find the remote 'origin'
+     * Could not find 'origin'
      *
      * @return RemoteNotFoundException
      */
     @NotNull
-    public static RemoteNotFoundException remoteOriginNotFound()
+    public static RemoteNotFoundException originNotFound()
     {
         return new RemoteNotFoundException("Could not find the remote 'origin'");
     }
 
 
     /**
-     * Could not find the url associated with the remote
+     * Could not find a url associated with the remote
+     *
+     * @param remote The remote that had no url.
      *
      * @return RemoteNotFoundException
      */

src/uk/co/ben_gibson/repositorymapper/Repository/Remote.java

@@ -2,22 +2,23 @@
 
 import git4idea.repo.GitRemote;
 import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
+import uk.co.ben_gibson.repositorymapper.Repository.Exception.RemoteNotFoundException;
 
 /**
- * Wrapper for a git remote.
+ * Decorates the git remote.
  */
 public class Remote
 {
 
+    @NotNull
     GitRemote remote;
 
     /**
      * Constructor.
      *
-     * @param remote the git remote to wrap
+     * @param remote The git remote to decorate
      */
-    public Remote(GitRemote remote)
+    public Remote(@NotNull GitRemote remote)
     {
         this.remote = remote;
     }
@@ -36,9 +37,15 @@ public String getName()
     /**
      * {@inheritDoc}
      */
-    @Nullable
-    public String getFirstUrl()
+    @NotNull
+    public String getFirstUrl() throws RemoteNotFoundException
     {
-        return remote.getFirstUrl();
+        String url = this.remote.getFirstUrl();
+
+        if (url == null) {
+            throw RemoteNotFoundException.urlNotFoundForRemote(this);
+        }
+
+        return url;
     }
 }

src/uk/co/ben_gibson/repositorymapper/Repository/Repository.java

@@ -10,19 +10,22 @@
 import java.net.URL;
 
 /**
- * Wraps up a GitRepository to add some behaviour.
+ * Decorates the git repository.
  */
 public class Repository
 {
 
+    @NotNull
     private GitRepository repository;
+
+    @NotNull
     private String defaultBranch;
 
 
     /**
      * Constructor.
      *
-     * @param repository    The repository.
+     * @param repository    The git repository.
      * @param defaultBranch The default branch.
      */
     public Repository(@NotNull GitRepository repository, @NotNull String defaultBranch)
@@ -33,7 +36,7 @@ public Repository(@NotNull GitRepository repository, @NotNull String defaultBran
 
 
     /**
-     * Get default branch.
+     * Get the default branch.
      *
      * @return String
      */
@@ -46,35 +49,40 @@ public String getDefaultBranch()
 
 
     /**
-     * Get the active branch which tracks a remote or default to master.
+     * Get the active branch if it tracks a remote branch.
      *
      * @return String
      */
     @NotNull
     public String getActiveBranchWithRemote() throws BranchNotFoundException
     {
         if (this.repository.getCurrentBranch() != null && this.repository.getCurrentBranch().findTrackedBranch(this.repository) != null) {
-           return this.repository.getCurrentBranch().getName();
+            return this.repository.getCurrentBranch().getName();
         }
 
         throw BranchNotFoundException.activeBranchWithRemoteTrackingNotFound();
     }
 
 
     /**
-     * Get a url from a remote.
+     * Get the canonical origin url
      *
      * @return URL
      */
     public URL getOriginUrl() throws RemoteNotFoundException, MalformedURLException
     {
-        Remote origin = this.getOrigin();
+        return this.getRemoteUrl(this.getOrigin());
+    }
 
-        if (origin.getFirstUrl() == null) {
-            throw RemoteNotFoundException.urlNotFoundForRemote(origin);
-        }
 
-        String url = StringUtil.trimEnd(origin.getFirstUrl(), ".git");
+    /**
+     * Get the canonical url from a remote.
+     *
+     * @return URL
+     */
+    public URL getRemoteUrl(Remote remote) throws MalformedURLException, RemoteNotFoundException
+    {
+        String url = StringUtil.trimEnd(remote.getFirstUrl(), ".git");
 
         url = url.replaceAll(":\\d{1,4}", ""); // remove port
 
@@ -92,21 +100,20 @@ public URL getOriginUrl() throws RemoteNotFoundException, MalformedURLException
 
 
     /**
-     * Fetch the remote origin
+     * Get origin.
      *
      * @return Remote
      */
     @NotNull
-    public Remote getOrigin() throws RemoteNotFoundException
+    private Remote getOrigin() throws RemoteNotFoundException
     {
-
         for (GitRemote remote : this.repository.getRemotes()) {
             if (remote.getName().equals("origin")) {
                 return new Remote(remote);
             }
         }
 
-        throw RemoteNotFoundException.remoteOriginNotFound();
+        throw RemoteNotFoundException.originNotFound();
     }
 
 

src/uk/co/ben_gibson/repositorymapper/RepositoryProvider/RepositoryProvider.java

@@ -1,7 +1,7 @@
 package uk.co.ben_gibson.repositorymapper.RepositoryProvider;
 
 /**
- * Represents different remote repository providers that we support.
+ * Represents different remote repository providers that are supported.
  */
 public enum RepositoryProvider
 {
@@ -16,7 +16,7 @@ public enum RepositoryProvider
     /**
      * Constructor.
      *
-     * @param name The name.
+     * @param name The repository provider name.
      */
     RepositoryProvider(String name)
     {

src/uk/co/ben_gibson/repositorymapper/Settings/Configuration.java

@@ -4,7 +4,6 @@
 import com.intellij.openapi.ui.ComboBox;
 import com.intellij.openapi.util.Comparing;
 import com.intellij.ui.EnumComboBoxModel;
-import com.intellij.ui.IdeBorderFactory;
 import com.intellij.ui.components.JBCheckBox;
 import com.intellij.ui.components.JBLabel;
 import com.intellij.openapi.components.ServiceManager;
@@ -31,7 +30,7 @@ public class Configuration implements Configurable
     /**
      * Constructor.
      *
-     * @param project  The project.
+     * @param project The project.
      */
     public Configuration(Project project)
     {
@@ -47,6 +46,7 @@ public Configuration(Project project)
      *
      * @return JPanel
      */
+    @Override
     public JComponent createComponent()
     {
         this.reset();
@@ -81,8 +81,9 @@ public JComponent createComponent()
     /**
      * {@inheritDoc}
      *
-     * This determines if the 'apply' button should be disabled.
+     * Determines if the 'apply' button should be disabled.
      */
+    @Override
     public boolean isModified()
     {
         return !Comparing.equal(this.copyToClipboardCheckBox.isSelected(), this.settings.getCopyToClipboard()) ||
@@ -95,6 +96,7 @@ public boolean isModified()
      *
      * Saves the changes.
      */
+    @Override
     public void apply() throws ConfigurationException
     {
         this.settings.setCopyToClipboard(this.copyToClipboardCheckBox.isSelected());

src/uk/co/ben_gibson/repositorymapper/Settings/Settings.java

@@ -73,7 +73,7 @@ public RepositoryProvider getRepositoryProvider()
     /**
      * Set the repository provider.
      *
-     * @param repositoryProvider  The repository provider.
+     * @param repositoryProvider The repository provider.
      */
     public void setRepositoryProvider(@NotNull RepositoryProvider repositoryProvider)
     {