Standardize controllers (#59)

This commit standardizes the MachineController to make it has the union of its children's methods.
We keep MachineController as it were and add 'CarControllerBase'
for car-formed machines such as the car form of Nxt / Ev3 and Pile robots,
and rename NxtController after it (NxtCarController).
By this change, the previous block classes and resources related to the car-formed machines
can be moved in 'main' variant and we decide to keep them in 'car' package for readability
(StopForSecBlock is not moved because it doesn't depend on the car-formed machines' method).

This commit also cleans string resources.

* TL;DR
** Background
We talked over the design of controllers again and again offline, and we had two options;

- Make controllers for each machine (Nxt, Ev3, Pile, etc.) so that they have their specific methods
(e.g., Pile Robot doesn't have ColorSensor, thus it doesn't have getColorSensorValue or something like that)
and keep the MachineController as it is.
- Make the common MachineController that has the union of methods of these controllers.

They actually have pros & cons and our opinions conflicted. But finally, at present, we decided to choose the latter.

** Pros & Cons of the former
*** Pros
- Straightforward way and thus readable. This is very important for developers.
- They can be easily tested.

*** Cons
- There will be many duplications of codes because these controllers use [our library](https://github.com/PileProject/drivecommand)'s
MachineBase that provides the same interface to control machines (so, we will have very similar codes in blocks like
[ForwardSecBlock](https://github.com/PileProject/drive/blob/develop/app/src/nxt/java/com/pileproject/drive/programming/visual/block/sequence/ForwardSecBlock.java)
in each build variant) but we currently can't make the most of it because of the design.
- It doesn't follow the design of [our library](https://github.com/PileProject/drivecommand). But we can fix that of our library easily.

** Pros & Cons of the latter
*** Pros
- It follows the design of [our library](https://github.com/PileProject/drivecommand).
- It commonizes the blocks through MachineController interface. Thus, it reduces the duplicated codes not only *.java but also *.xml.
- Easy to maintain because the codes are unified.

*** Cons
- It is difficult to test each variant.
- Not straightforward way.
- Users can't know what kinds of methods each controller has, and make it worse,
calling wrong methods lead to RuntimeError not CompileError.
- Poor extensibility. We should add/remove a method to/from MachineController itself if new machines with new methods.
So, maybe we should make an another layer for other machines something
like MachineController -> CarController, DroneController (i.e., not use the MachineController as the current NxtController's parent).

** Why we chose the latter
This was a very difficult problem for us but we took the pros of the latter.
Maintaining duplicated codes *.java and *.xml is very annoying
and we can easily change our mind when a new type of machine comes
if we keep the unified codes clean.

Author: tiwanari

.idea/copyright/pileproject.xml

@@ -17,6 +17,8 @@
 
 import android.support.test.runner.AndroidJUnit4;
 
+import com.pileproject.drive.machine.CarControllerBase;
+import com.pileproject.drive.machine.NxtCarController;
 import com.pileproject.drivecommand.machine.device.input.LineSensor;
 import com.pileproject.drivecommand.machine.device.input.SoundSensor;
 import com.pileproject.drivecommand.machine.device.input.TouchSensor;
@@ -30,6 +32,8 @@
 import org.mockito.Mock;
 import org.mockito.internal.util.reflection.Whitebox;
 
+import static com.pileproject.drive.machine.CarControllerBase.MotorKind.LeftMotor;
+import static com.pileproject.drive.machine.CarControllerBase.MotorKind.RightMotor;
 import static junit.framework.Assert.assertEquals;
 import static junit.framework.Assert.assertFalse;
 import static junit.framework.Assert.assertTrue;
@@ -38,10 +42,11 @@
 import static org.mockito.Mockito.verify;
 
 @RunWith(AndroidJUnit4.class)
-public class NxtControllerTest {
+public class NxtCarControllerTest {
 
     @Mock NxtMachine machine;
-    @InjectMocks NxtController controller;
+    @InjectMocks
+    NxtCarController controller;
 
     @Mock TouchSensor touchSensor;
     @Mock SoundSensor soundSensor;
@@ -53,7 +58,7 @@ public class NxtControllerTest {
     @Before
     public void setUp() {
         machine = mock(NxtMachine.class);
-        controller = new NxtController(machine);
+        controller = new NxtCarController(machine);
 
         touchSensor = mock(TouchSensor.class);
         soundSensor = mock(SoundSensor.class);
@@ -76,38 +81,38 @@ private void setUpMotors() {
     public void whenTouchSensorIsNull_thenReturnFalse() throws Exception {
         Whitebox.setInternalState(controller, "mTouchSensor", null);
 
-        assertFalse(controller.getTouchSensorValue());
+        assertFalse(controller.isTouchSensorTouched());
     }
 
     @Test
     public void whenTouchSensorIsNotNull_andTouchSensorIsTouched_thenReturnTrue() throws Exception {
         Whitebox.setInternalState(controller, "mTouchSensor", touchSensor);
         doReturn(true).when(touchSensor).isTouched();
 
-        assertTrue(controller.getTouchSensorValue());
+        assertTrue(controller.isTouchSensorTouched());
     }
 
     @Test
     public void whenTouchSensorIsNotNull_andTouchSensorIsNotTouched_thenReturnFalse() throws Exception {
         Whitebox.setInternalState(controller, "mTouchSensor", touchSensor);
         doReturn(false).when(touchSensor).isTouched();
 
-        assertFalse(controller.getTouchSensorValue());
+        assertFalse(controller.isTouchSensorTouched());
     }
 
     @Test
     public void whenSoundSensorIsNull_thenReturnNegative() throws Exception {
         Whitebox.setInternalState(controller, "mSoundSensor", null);
 
-        assertEquals(controller.getSoundSensorValue(), -1);
+        assertEquals(controller.getSoundSensorDb(), -1);
     }
 
     @Test
     public void whenSoundSensorIsNotNull_thenReturnProperValue() throws Exception {
         Whitebox.setInternalState(controller, "mSoundSensor", soundSensor);
         doReturn(10).when(soundSensor).getDb();
 
-        assertEquals(10, controller.getSoundSensorValue());
+        assertEquals(10, controller.getSoundSensorDb());
     }
 
     @Test
@@ -181,16 +186,16 @@ public void whenMotorSpeedsAreNotInitialized_thenMovesForwardWithDefaultValue()
 
         controller.moveForward();
 
-        verify(leftMotor).setSpeed(NxtController.INIT_MOTOR_POWER);
-        verify(rightMotor).setSpeed(NxtController.INIT_MOTOR_POWER);
+        verify(leftMotor).setSpeed(CarControllerBase.MotorProperty.INIT_MOTOR_POWER);
+        verify(rightMotor).setSpeed(CarControllerBase.MotorProperty.INIT_MOTOR_POWER);
     }
 
     @Test
     public void whenSetMotorPowerCalled_thenMovesForwardWithTheValue() throws Exception {
         setUpMotors();
 
-        controller.setMotorPower(NxtController.MotorKind.LeftMotor, 10);
-        controller.setMotorPower(NxtController.MotorKind.RightMotor, 10);
+        controller.setMotorPower(LeftMotor, 10);
+        controller.setMotorPower(RightMotor, 10);
 
         controller.moveForward();
 
@@ -202,8 +207,8 @@ public void whenSetMotorPowerCalled_thenMovesForwardWithTheValue() throws Except
     public void whenSetMotorPowerCalledWithOverUpperBoundValue_thenMovesForwardWithUpperBoundValue() throws Exception {
         setUpMotors();
 
-        controller.setMotorPower(NxtController.MotorKind.LeftMotor, 200);
-        controller.setMotorPower(NxtController.MotorKind.RightMotor, 200);
+        controller.setMotorPower(LeftMotor, 200);
+        controller.setMotorPower(RightMotor, 200);
 
         controller.moveForward();
 
@@ -215,8 +220,8 @@ public void whenSetMotorPowerCalledWithOverUpperBoundValue_thenMovesForwardWithU
     public void whenSetMotorPowerCalledWithUnderLowerBoundValue_thenMovesForwardWithLowerBoundValue() throws Exception {
         setUpMotors();
 
-        controller.setMotorPower(NxtController.MotorKind.LeftMotor, -10);
-        controller.setMotorPower(NxtController.MotorKind.RightMotor, -10);
+        controller.setMotorPower(LeftMotor, -10);
+        controller.setMotorPower(RightMotor, -10);
 
         controller.moveForward();
 

.idea/gradle.xml

@@ -24,10 +24,7 @@
 import com.yahoo.squidb.sql.Table;
 
 /**
- * Implementation of SquidDatabase for this app.
- *
- * @author <a href="mailto:tatsuyaw0c@gmail.com">Tatsuya Iwanari</a>
- * @version 1.0 3-April-2016
+ * The implementation of SquidDatabase for this app.
  */
 public class DriveDatabase extends SquidDatabase {
     private static final int VERSION = 1;

…t/drive/execution/NxtControllerTest.java …rive/execution/NxtCarControllerTest.javaapp/src/androidTest/java/com/pileproject/drive/execution/NxtControllerTest.java renamed to app/src/androidTest/java/com/pileproject/drive/execution/NxtCarControllerTest.java app/src/androidTest/java/com/pileproject/drive/execution/NxtControllerTest.java renamed to app/src/androidTest/java/com/pileproject/drive/execution/NxtCarControllerTest.java

@@ -30,14 +30,11 @@
 import java.util.Collections;
 
 /**
- * Program Data manager
- *
- * @author <a href="mailto:tatsuyaw0c@gmail.com">Tatsuya Iwanari</a>
- * @version 2.0 2-April-2016
+ * A manger of {@link ProgramData}.
  */
 public class ProgramDataManager {
     private static ProgramDataManager mInstance = new ProgramDataManager();
-    private DriveDatabase mDriveDatabase = null;
+    private DriveDatabase mDriveDatabase;
 
     // the number of execution programs should be less than or equals to 1
     private static final Query EXECUTION_PROGRAM =
@@ -71,29 +68,29 @@ public static ProgramDataManager getInstance() {
     }
 
     /**
-     * Save program data temporarily to execute it
+     * Saves a program temporarily to execute it.
      *
-     * @param BlockSpaceLayout The programming space that has blocks
+     * @param layout The programming space that has blocks
      */
     public boolean saveExecutionProgram(BlockSpaceLayout layout) {
         return saveProgram(Program.EXECUTION, Program.EXECUTION, layout);
     }
 
     /**
-     * Save a sample program data
+     * Saves a sample program.
      *
-     * @param String the name of a new program
-     * @param BlockSpaceLayout the programming space that has blocks
+     * @param programName the name of a new program
+     * @param layout the programming space that has blocks
      */
     public boolean saveSampleProgram(String programName, BlockSpaceLayout layout) {
         return saveProgram(programName, Program.SAMPLE, layout);
     }
 
     /**
-     * Save a user program data
+     * Saves a user program.
      *
-     * @param String the name of a new program
-     * @param BlockSpaceLayout the programming space that has blocks
+     * @param programName the name of a new program
+     * @param layout the programming space that has blocks
      */
     public boolean saveUserProgram(String programName, BlockSpaceLayout layout) {
         return saveProgram(programName, Program.USER, layout);
@@ -141,29 +138,29 @@ private boolean saveProgram(String programName, String programType, BlockSpaceLa
     }
 
     /**
-     * Load an execution program's block data (Sorted)
+     * Loads an execution program's block data (sorted).
      *
-     * @return ArrayList<BlockBase> loaded data
+     * @return loaded data as {@link ArrayList<BlockBase>}
      */
     public ArrayList<BlockBase> loadExecutionProgram() {
         return loadProgram(Program.EXECUTION, Program.EXECUTION);
     }
 
     /**
-     * Load a sample program's block data (Sorted)
+     * Loads a sample program's block data (sorted).
      *
-     * @param String the name of program
-     * @return ArrayList<BlockBase> loaded data
+     * @param programName the name of program
+     * @return loaded data as {@link ArrayList<BlockBase>}
      */
     public ArrayList<BlockBase> loadSampleProgram(String programName) {
         return loadProgram(programName, Program.SAMPLE);
     }
 
     /**
-     * Load a user program's block data
+     * Loads a user program's block data
      *
-     * @param String the name of program
-     * @return ArrayList<BlockBase> loaded data
+     * @param programName the name of program
+     * @return loaded data as {@link ArrayList<BlockBase>}
      */
     public ArrayList<BlockBase> loadUserProgram(String programName) {
         return loadProgram(programName, Program.USER);
@@ -217,18 +214,18 @@ private ArrayList<BlockBase> loadBlocks(SquidCursor<ProgramData> c) {
     }
 
     /**
-     * Load all sample program names
+     * Loads all the sample program names.
      *
-     * @return ArrayList<String> the names of sample programs
+     * @return the names of sample programs as {@link ArrayList<String>}
      */
     public ArrayList<String> loadSampleProgramNames() {
         return loadProgramNames(Program.SAMPLE);
     }
 
     /**
-     * Load all user program names
+     * Loads all user program names
      *
-     * @return ArrayList<String> the names of user programs
+     * @return the names of user programs as {@link ArrayList<String>}
      */
     public ArrayList<String> loadUserProgramNames() {
         return loadProgramNames(Program.USER);
@@ -256,24 +253,24 @@ else if (programType.equals(Program.SAMPLE)) {
     }
 
     /**
-     * Delete an execution program
+     * Deletes an execution program.
      */
     public void deleteExecutionProgram() {
         deleteProgram(Program.EXECUTION, Program.EXECUTION);
     }
 
     /**
-     * Delete a sample program with 'programName'
+     * Deletes a sample program with <code>programName</code>.
      *
-     * @param String the name of a sample program
+     * @param programName the name of a sample program
      */
     public void deleteSampleProgram(String programName) {
         deleteProgram(programName, Program.SAMPLE);
     }
     /**
-     * Delete a user program with 'programName'
+     * Deletes a user program with <code>programName</code>.
      *
-     * @param String the name of a user program
+     * @param programName the name of a user program
      */
     public void deleteUserProgram(String programName) {
         deleteProgram(programName, Program.USER);

app/src/main/java/com/pileproject/drive/database/DriveDatabase.java

@@ -21,9 +21,6 @@
 
 /**
  * Specification for "program_data" table
- *
- * @author <a href="mailto:tatsuyaw0c@gmail.com">Tatsuya Iwanari</a>
- * @version 1.0 22-March-2016
  */
 @TableModelSpec(className="ProgramData", tableName="program_data",
                 tableConstraint = "FOREIGN KEY(programId) references programs(_id) ON DELETE CASCADE")

app/src/main/java/com/pileproject/drive/database/ProgramDataManager.java

@@ -22,9 +22,6 @@
 
 /**
  * Specification for "programs" table
- *
- * @author <a href="mailto:tatsuyaw0c@gmail.com">Tatsuya Iwanari</a>
- * @version 1.0 22-March-2016
  */
 @TableModelSpec(className="Program", tableName="programs")
 public class ProgramSpec {

app/src/main/java/com/pileproject/drive/database/ProgramDataSpec.java

@@ -35,6 +35,7 @@
 import com.pileproject.drive.comm.CommunicatorProvider;
 import com.pileproject.drive.comm.RxMachineConnector;
 import com.pileproject.drive.database.ProgramDataManager;
+import com.pileproject.drive.machine.MachineProvider;
 import com.pileproject.drive.util.bluetooth.BluetoothUtil;
 import com.pileproject.drive.util.development.DeployUtils;
 import com.pileproject.drive.util.fragment.AlertDialogFragment;

app/src/main/java/com/pileproject/drive/database/ProgramSpec.java

@@ -17,6 +17,7 @@
 
 import android.os.Bundle;
 
+import com.pileproject.drive.machine.MachineController;
 import com.pileproject.drive.programming.visual.block.BlockBase;
 
 import java.util.List;