Merge branch 'architecture-doc-update-aleksi' of https://github.com/tmc-cli/tmc-cli into architecture-doc-update-aleksi

Author: Aleksi Salmela

src/main/java/fi/helsinki/cs/tmc/cli/CliContext.java

@@ -16,7 +16,7 @@
 
 public class CliContext {
 
-    private WorkDir workDir;//TODO make this final
+    private final WorkDir workDir;
     private final Io io;
 
     private Application application;
@@ -29,16 +29,15 @@ public class CliContext {
     private HashMap<String, String> properties;
     private final boolean inTest;
 
-    /*TODO some of the constructors could be removed */
     public CliContext(Io io) {
-        this(io, new WorkDir(), null);
+        this(io, null);
     }
 
     public CliContext(Io io, TmcCore core) {
-        this(io, new WorkDir(), core);
+        this(io, core, new WorkDir());
     }
 
-    public CliContext(Io io, WorkDir workDir, TmcCore core) {
+    public CliContext(Io io, TmcCore core, WorkDir workDir) {
         inTest = (io != null);
         if (!inTest) {
             io = new TerminalIo(System.in);
@@ -52,22 +51,27 @@ public CliContext(Io io, WorkDir workDir, TmcCore core) {
         this.workDir = workDir;
         this.properties = SettingsIo.loadProperties();
         this.tmcCore = core;
-        this.hasLogin = false;
+        this.hasLogin = (core != null);
         this.courseInfo = null;
     }
 
     /*TODO create reset method for removing all cached data that is called
-     * when working directory is changed or by users demand also use it in
+     * when working directory is changed or by user's demand, also use it in
      * constructor.
      */
 
     protected void setApp(Application app) {
         this.application = app;
     }
 
+    /**
+     * Get singleton Application object.
+     *
+     * @return application object
+     */
     public Application getApp() {
         if (application == null) {
-            throw new RuntimeException("Application isn't usually set in tests.");
+            throw new RuntimeException("Application isn't set in some tests.");
         }
         return application;
     }
@@ -78,28 +82,63 @@ public boolean inTests() {
         return inTest;
     }
 
+    /**
+     * Get singleton Io object.
+     *
+     * @return io object
+     */
     public Io getIo() {
         return io;
     }
 
+    public boolean hasLogin() {
+        return hasLogin;
+    }
+
+    /**
+     * Get singleton WorkDir object.
+     *
+     * @return singleton work dir object
+     */
     public WorkDir getWorkDir() {
-        return this.workDir;
+        return workDir;
     }
 
+    /**
+     * Create local course info file after download.
+     *
+     * @param course local copy of course object
+     * @return cached course data object
+     */
     public CourseInfo createCourseInfo(Course course) {
         return new CourseInfo(settings, course);
     }
 
+    /**
+     * Get map of the properties.
+     *
+     * @return the whole mutable map
+     */
     public HashMap<String, String> getProperties() {
         // Loads properties from the global configuration file in .config/tmc-cli/
         return this.properties;
     }
 
-    public Boolean saveProperties() {
+    /**
+     * Save the properties map into the a file.
+     *
+     * @return true if success
+     */
+    public boolean saveProperties() {
         // Saves properties to the global configuration file in .config/tmc-cli/
         return SettingsIo.saveProperties(properties);
     }
 
+    /**
+     * Lazy load the course info from course directory.
+     *
+     * @return local course info
+     */
     public CourseInfo getCourseInfo() {
         if (courseInfo != null) {
             return courseInfo;
@@ -112,33 +151,43 @@ public CourseInfo getCourseInfo() {
             io.println("Course configuration file "
                     + workDir.getConfigFile().toString()
                     + "is invalid.");
-            //TODO add a way to rewrite the course config file.
+            //TODO add a way to rewrite the corrupted course config file.
             return null;
         }
         return this.courseInfo;
     }
 
-    // Method is used to help testing
-    public void setTmcCore(TmcCore tmcCore) {
-        this.tmcCore = tmcCore;
+    /**
+     * Getter of TmcCore for TmcUtil class.
+     * This method should never be used except in TmcUtil class.
+     *
+     * @return global tmcutil
+     */
+    public TmcCore getTmcCore() {
+        if (this.tmcCore == null) {
+            throw new RuntimeException("The loadBackend* method was NOT called");
+        }
+        return this.tmcCore;
     }
 
+    /**
+     * Initialize the tmc-core and other cached info.
+     * Use this method if you need i
+     * @return true if success
+     */
     public boolean loadBackend() {
-        return loadBackend(true);
-    }
-
-    public boolean loadBackend(boolean useInternet) {
         if (this.tmcCore != null) {
             return true;
         }
 
-        if (!createTmcCore()) {
+        if (! createTmcCore()) {
             return false;
         }
 
-        if (useInternet && !hasLogin) {
-            // If no settings are present
+        //Bug: what if we have wrong login?
+        if (!hasLogin) {
             if (courseInfo == null) {
+                // if user is not in course folder.
                 io.println("You are not logged in. Log in using: tmc login");
             } else {
                 io.println("You are not logged in as " + courseInfo.getUsername()
@@ -149,24 +198,31 @@ public boolean loadBackend(boolean useInternet) {
         return true;
     }
 
-    public TmcCore getTmcCore() {
-        if (this.tmcCore == null) {
-            throw new RuntimeException("The loadBackend method was NOT called");
+    /**
+     * Initialize the cached data, but don't fail if there is not login.
+     *
+     * @return true if success
+     */
+    public boolean loadBackendWithoutLogin() {
+        if (this.tmcCore != null) {
+            return true;
         }
-        return this.tmcCore;
+
+        return createTmcCore();
     }
 
+    /**
+     * Copy login info from different settings object and them.
+     * TODO: separate settings object and login info.
+     * @param settings login info
+     */
     public void useSettings(Settings settings) {
         if (this.tmcCore == null) {
             createTmcCore(settings);
         }
         this.settings.set(settings);
     }
 
-    public void restoreSettings() {
-        this.settings.set(settings);
-    }
-
     private void createTmcCore(Settings settings) {
         TaskExecutor tmcLangs;
 
@@ -188,6 +244,8 @@ private boolean createTmcCore() {
                         courseInfo.getServerAddress());
             }
         } else {
+            // Bug: if we are not inside course directory
+            // then we may not correctly guess the correct settings.
             cachedSettings = SettingsIo.load();
         }
 

src/main/java/fi/helsinki/cs/tmc/cli/command/CourseInfoCommand.java

@@ -11,7 +11,6 @@
 import fi.helsinki.cs.tmc.cli.io.Color;
 import fi.helsinki.cs.tmc.cli.io.Io;
 import fi.helsinki.cs.tmc.cli.tmcstuff.CourseInfo;
-import fi.helsinki.cs.tmc.cli.tmcstuff.CourseInfoIo;
 import fi.helsinki.cs.tmc.cli.tmcstuff.TmcUtil;
 import fi.helsinki.cs.tmc.cli.tmcstuff.WorkDir;
 
@@ -26,6 +25,7 @@
 
 @Command(name = "info", desc = "Show info about the current directory")
 public class CourseInfoCommand extends AbstractCommand {
+
     private Course course;
     private Exercise exercise;
     private CourseInfo info;
@@ -47,7 +47,7 @@ public void run(CommandLine args, Io io) {
 
         boolean fetchFromInternet = args.hasOption("i");
 
-        if (! ctx.loadBackend()) {
+        if (!ctx.loadBackendWithoutLogin()) {
             return;
         }
 
@@ -62,6 +62,11 @@ public void run(CommandLine args, Io io) {
             return;
         }
 
+        if (!ctx.hasLogin()) {
+            io.println("Loading course from internet requires login.");
+            return;
+        }
+
         course = TmcUtil.findCourse(ctx, stringArgs[0]);
         if (course == null) {
             io.println("The course " + stringArgs[0] + " doesn't exist on this server.");