SavedGames: eclipse scripts, comments, strings, and some fixes

Author: samtstern

BasicSamples/SavedGames/src/main/java/com/google/example/games/savedgames/MainActivity.java

@@ -29,7 +29,13 @@
 import com.google.android.gms.plus.Plus;
 import com.google.example.games.basegameutils.BaseGameUtils;
 
-
+/**
+ * SavedGames.  A sample that demonstrates how to migrate from the Cloud Save (AppState) API to the
+ * newer Saved Games (Snapshots) API.  The app allows load/update to both services as well as an
+ * example of migrating data from AppState to Snapshots.
+ *
+ * @author Sam Stern ([email protected])
+ */
 public class MainActivity extends Activity implements View.OnClickListener,
         GoogleApiClient.ConnectionCallbacks, GoogleApiClient.OnConnectionFailedListener {
 
@@ -137,7 +143,7 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
                     SnapshotMetadata selected = Games.Snapshots.getSnapshotFromBundle(bundle);
                     if (selected == null) {
                         // No snapshot in the Intent bundle, display error message
-                        displayMessage("Failed to select Saved Game data.", true);
+                        displayMessage(getString(R.string.saved_games_select_failure), true);
                         setData(null);
                         displaySnapshotMetadata(null);
                     } else {
@@ -148,7 +154,7 @@ protected void onActivityResult(int requestCode, int resultCode, Intent data) {
                 }
             } else {
                 // User canceled the select intent or it failed for some other reason
-                displayMessage("No Saved Game selected.", true);
+                displayMessage(getString(R.string.saved_games_select_cancel), true);
                 setData(null);
                 displaySnapshotMetadata(null);
             }
@@ -217,8 +223,19 @@ public void onClick(View v) {
         }
     }
 
+    /**
+     * Start the sign-in process after the user clicks the sign-in button.
+     */
     private void beginUserInitiatedSignIn() {
         Log.d(TAG, "beginUserInitiatedSignIn");
+        // Check to see the developer who's running this sample code read the instructions :-)
+        // NOTE: this check is here only because this is a sample! Don't include this
+        // check in your actual production app.
+        if (!BaseGameUtils.verifySampleSetup(this, R.string.app_id)) {
+            Log.w(TAG, "*** Warning: setup problems detected. Sign in may not work!");
+        }
+
+        showProgressDialog("Signing in.");
         mSignInClicked = true;
         mGoogleApiClient.connect();
     }
@@ -237,13 +254,13 @@ private void cloudSaveLoad() {
             public void onResult(StateResult stateResult) {
                 if (stateResult.getStatus().isSuccess()) {
                     // Successfully loaded data from App State
-                    displayMessage("Loaded from Cloud Save", false);
+                    displayMessage(getString(R.string.cloud_save_load_success), false);
                     byte[] data = stateResult.getLoadedResult().getLocalData();
                     setData(new String(data));
                     displayAppStateMetadata(stateResult.getLoadedResult().getStateKey());
                 } else {
                     // Failed to load data from App State
-                    displayMessage("Failed to load from Cloud Save", true);
+                    displayMessage(getString(R.string.cloud_save_load_failure), true);
                     clearDataUI();
                 }
 
@@ -272,9 +289,9 @@ private void cloudSaveUpdate() {
             @Override
             public void onResult(StateResult stateResult) {
                 if (stateResult.getStatus().isSuccess()) {
-                    displayMessage("Saved to Cloud Save", false);
+                    displayMessage(getString(R.string.cloud_save_update_success), false);
                 } else {
-                    displayMessage("Failed to save to Cloud Save", true);
+                    displayMessage(getString(R.string.cloud_save_update_failure), true);
                 }
 
                 dismissProgressDialog();
@@ -301,7 +318,6 @@ private void cloudSaveMigrate() {
         final String snapshotName = makeSnapshotName(APP_STATE_KEY);
         final String description = "Saved game #" + APP_STATE_KEY;
         final long playedTimeMillis = 60 * 60 * 1000;
-        final byte[] data = getData().getBytes();
         final Bitmap bitmap = BitmapFactory.decodeResource(getResources(), R.drawable.ic_launcher);
 
         AsyncTask<Void, Void, Boolean> migrateTask = new AsyncTask<Void, Void, Boolean>() {
@@ -312,6 +328,17 @@ protected void onPreExecute() {
 
             @Override
             protected Boolean doInBackground(Void... params) {
+                // Get AppState Data
+                StateResult load = AppStateManager.load(mGoogleApiClient, APP_STATE_KEY).await();
+
+                if (!load.getStatus().isSuccess()) {
+                    Log.w(TAG, "Could not load App State for migration.");
+                    return false;
+                }
+
+                // Get Data from AppState
+                byte[] data = load.getLoadedResult().getLocalData();
+
                 // Open the snapshot, creating if necessary
                 OpenSnapshotResult open = Games.Snapshots.open(
                         mGoogleApiClient, snapshotName, createIfMissing).await();
@@ -341,18 +368,16 @@ protected Boolean doInBackground(Void... params) {
                     return false;
                 }
 
-                // TODO(samstern): Delete data from appstate?
-
                 // No failures
                 return true;
             }
 
             @Override
             protected void onPostExecute(Boolean result) {
                 if (result) {
-                    displayMessage("Migrated to Saved Games.", false);
+                    displayMessage(getString(R.string.cloud_save_migrate_success), false);
                 } else {
-                    displayMessage("Failed to migrate to Saved Games.", true);
+                    displayMessage(getString(R.string.cloud_save_migrate_failure), true);
                 }
 
                 dismissProgressDialog();
@@ -384,12 +409,12 @@ private void savedGamesLoad(String snapshotName) {
             @Override
             public void onResult(OpenSnapshotResult openSnapshotResult) {
                 if (openSnapshotResult.getStatus().isSuccess()) {
-                    displayMessage("Loaded from Saved Games", false);
+                    displayMessage(getString(R.string.saved_games_load_success), false);
                     byte[] data = openSnapshotResult.getSnapshot().readFully();
                     setData(new String(data));
                     displaySnapshotMetadata(openSnapshotResult.getSnapshot().getMetadata());
                 } else {
-                    displayMessage("Failed to load from Saved Games", true);
+                    displayMessage(getString(R.string.saved_games_load_failure), true);
                     clearDataUI();
                 }
 
@@ -462,9 +487,9 @@ protected Boolean doInBackground(Void... params) {
             @Override
             protected void onPostExecute(Boolean result) {
                 if (result) {
-                    displayMessage("Saved to Saved Games", false);
+                    displayMessage(getString(R.string.saved_games_update_success), false);
                 } else {
-                    displayMessage("Failed to save to Saved Games", true);
+                    displayMessage(getString(R.string.saved_games_update_failure), true);
                 }
 
                 dismissProgressDialog();
@@ -483,19 +508,26 @@ private String makeSnapshotName(int appStateKey) {
         return "Snapshot-" + String.valueOf(appStateKey);
     }
 
+    /**
+     * Display either the signed-in or signed-out view, depending on the user's state.
+     */
     private void updateUI() {
         // Show signed in or signed out view
         if (isSignedIn()) {
             findViewById(R.id.layout_signed_in).setVisibility(View.VISIBLE);
             findViewById(R.id.layout_signed_out).setVisibility(View.GONE);
-            displayMessage("Signed in.", false);
+            displayMessage(getString(R.string.message_signed_in), false);
         } else {
             findViewById(R.id.layout_signed_in).setVisibility(View.GONE);
             findViewById(R.id.layout_signed_out).setVisibility(View.VISIBLE);
             displayMessage(getString(R.string.message_sign_in), false);
         }
     }
 
+    /**
+     * Replace the data displaying in the EditText.
+     * @param data the String to display.
+     */
     private void setData(String data) {
         EditText dataEditText = (EditText) findViewById(R.id.edit_game_data);
 
@@ -506,11 +538,20 @@ private void setData(String data) {
         }
     }
 
+    /**
+     * Get the data from the EditText.
+     * @return the String in the EditText, or "" if empty.
+     */
     private String getData() {
         EditText dataEditText = (EditText) findViewById(R.id.edit_game_data);
         return dataEditText.getText().toString();
     }
 
+    /**
+     * Display a status message for the last operation at the bottom of the screen.
+     * @param msg the message to display.
+     * @param error true if an error occurred, false otherwise.
+     */
     private void displayMessage(String msg, boolean error) {
         // Set text
         TextView messageView = (TextView) findViewById(R.id.text_message);
@@ -524,6 +565,10 @@ private void displayMessage(String msg, boolean error) {
         }
     }
 
+    /**
+     * Display metadata about AppState save data,
+     * @param stateKey the slot stateKey of the AppState.
+     */
     private void displayAppStateMetadata(int stateKey) {
         TextView metaDataView = (TextView) findViewById(R.id.text_metadata);
         metaDataView.setText("");
@@ -533,6 +578,10 @@ private void displayAppStateMetadata(int stateKey) {
         metaDataView.setText(metadataStr);
     }
 
+    /**
+     * Display metadata about Snapshot save data.
+     * @param metadata the SnapshotMetadata associated with the saved game.
+     */
     private void displaySnapshotMetadata(SnapshotMetadata metadata) {
         TextView metaDataView = (TextView) findViewById(R.id.text_metadata);
         metaDataView.setText("");
@@ -550,6 +599,9 @@ private void displaySnapshotMetadata(SnapshotMetadata metadata) {
         metaDataView.setText(metadataStr);
     }
 
+    /**
+     * Clear the data and metadata displays.
+     */
     private void clearDataUI() {
         // Clear the Game Data field and the Metadata field
         EditText dataEditText = (EditText) findViewById(R.id.edit_game_data);
@@ -559,10 +611,18 @@ private void clearDataUI() {
         metaDataView.setText("");
     }
 
+    /**
+     * Determine if the Google API Client is signed in and ready to access Games APIs.
+     * @return true if client exits and is signed in, false otherwise.
+     */
     private boolean isSignedIn() {
         return (mGoogleApiClient != null && mGoogleApiClient.isConnected());
     }
 
+    /**
+     * Show a progress dialog for asynchronous operations.
+     * @param msg the message to display.
+     */
     private void showProgressDialog(String msg) {
         if (mProgressDialog == null) {
             mProgressDialog = new ProgressDialog(this);
@@ -573,6 +633,9 @@ private void showProgressDialog(String msg) {
         mProgressDialog.show();
     }
 
+    /**
+     * Hide the progress dialog, if it was showing.
+     */
     private void dismissProgressDialog() {
         if (mProgressDialog != null && mProgressDialog.isShowing()) {
             mProgressDialog.dismiss();

BasicSamples/SavedGames/src/main/res/values/strings.xml

@@ -2,14 +2,25 @@
 <resources>
 
     <string name="app_name">SavedGames</string>
-    <string name="hello_world">Hello world!</string>
-    <string name="action_settings">Settings</string>
-    <string name="message_sign_in">Sign-in to begin.</string>
     <string name="update">Update</string>
     <string name="load">Load</string>
     <string name="migrate">Migrate</string>
+    <string name="select">Select</string>
     <string name="signin_other_error">There was an error during sign in.</string>
     <string name="signin_failure">Unable to sign in.  Please check your connection and try again,</string>
-    <string name="select">Select</string>
+    <string name="message_sign_in">Sign-in to begin.</string>
+    <string name="message_signed_in">Signed in.</string>
+    <string name="saved_games_load_success">Loaded from Saved Games.</string>
+    <string name="saved_games_load_failure">Failed to load from Saved Games.</string>
+    <string name="saved_games_update_success">Saved to Saved Games.</string>
+    <string name="saved_games_update_failure">Failed to save to Saved Games</string>
+    <string name="saved_games_select_failure">Failed to select from Saved Games.</string>
+    <string name="saved_games_select_cancel">No Saved Game selected.</string>
+    <string name="cloud_save_load_success">Loaded from Cloud Save.</string>
+    <string name="cloud_save_load_failure">Failed to load from Cloud Save.</string>
+    <string name="cloud_save_update_success">Saved to Cloud Save.</string>
+    <string name="cloud_save_update_failure">Failed to save to Cloud Save.</string>
+    <string name="cloud_save_migrate_success">Migrated to Saved Games.</string>
+    <string name="cloud_save_migrate_failure">Failed to migrate to Saved Games.</string>
 
 </resources>

Scripts/make_eclipse_compat

@@ -9,7 +9,7 @@ fi
 echo "Making eclipse-compatible projects..."
 mkdir -p eclipse_compat
 
-for i in BeGenerous ButtonClicker TypeANumber CollectAllTheStars2 TrivialQuest TrivialQuest2 SkeletonTbmp libraries/BaseGameUtils; do
+for i in BeGenerous ButtonClicker TypeANumber CollectAllTheStars2 TrivialQuest TrivialQuest2 SkeletonTbmp SavedGames libraries/BaseGameUtils; do
     echo "Preparing $i..."
     mkdir -p eclipse_compat/$i
     cp BasicSamples/$i/src/main/AndroidManifest.xml eclipse_compat/$i

Scripts/make_eclipse_compat.cmd

@@ -12,7 +12,7 @@ if NOT exist eclipse_compat mkdir eclipse_compat
 
 echo "Converting each sample"
 
-for %%i in (BeGenerous ButtonClicker TypeANumber CollectAllTheStars2 TrivialQuest TrivialQuest2 SkeletonTbmp libraries\BaseGameUtils) do (
+for %%i in (BeGenerous ButtonClicker TypeANumber CollectAllTheStars2 TrivialQuest TrivialQuest2 SkeletonTbmp SavedGames libraries\BaseGameUtils) do (
     echo "Preparing %%i..."
     if NOT exist  eclipse_compat\%%i mkdir  eclipse_compat\%%i
     copy BasicSamples\%%i\src\main\AndroidManifest.xml eclipse_compat\%%i