Merge lp:~tlnd/financisto/csv-export into lp:~financisto-dev/financisto/trunk

[tlnd]

CSV export: Custom value separator and persistent preferences

Hey,

I tackled the blueprint to "Allow custom separator for values in CSV export". Besides the comma, the user now can also select a semicolon or a tabulator. Additionally, he can choose whether the headers should be exported. Furthermore, the selection is persistent, thus the user does not have to reselect his preferences every time he does an export.

It would be great if somebody could review the code. If necessary, I'm willing to rework it to get it merged eventually.

Regards,
Timo

[Denis Solonenko (denis-solonenko)]

Looks good, thank you! Please integrate into trunk.

review: Approve

=== modified file 'assets/credits.htm'
--- assets/credits.htm	2010-09-04 22:15:18 +0000
+++ assets/credits.htm	2010-09-18 00:44:43 +0000
@@ -31,7 +31,7 @@
 </p>
 <p><b>Contributors</b></p>
 <p>
-tlnd<br/>
+Timo Lindhorst<br/>
 </p>
 <p><b>Localizators</b></p>
 <p>

=== modified file 'res/layout/csv_export.xml'
--- res/layout/csv_export.xml	2010-06-02 15:22:10 +0000
+++ res/layout/csv_export.xml	2010-09-18 00:44:43 +0000
@@ -19,33 +19,46 @@
 		android:text="@string/period"></TextView>
 	<Button android:layout_height="wrap_content" android:id="@+id/bPeriod"
 		android:layout_width="fill_parent"></Button>
+	<View android:layout_height="1dp" android:background="@drawable/divider_horizontal_dark"
+		android:layout_width="fill_parent" android:layout_marginLeft="10dp"
+		android:layout_marginRight="10dp" />
+		
 	<TableLayout android:layout_height="wrap_content"
-		android:layout_width="fill_parent">
-		<TableRow android:layout_width="wrap_content"
-			android:layout_height="wrap_content">
-			<TextView android:layout_height="wrap_content"
-				android:layout_width="fill_parent" android:layout_marginLeft="3dp"
-				android:text="@string/decimals" android:layout_weight="1"></TextView>
-			<TextView android:layout_height="wrap_content"
-				android:layout_width="fill_parent" android:layout_marginLeft="3dp"
-				android:layout_weight="1" android:text="@string/decimal_separator"></TextView>
-			<TextView android:layout_height="wrap_content"
-				android:layout_width="fill_parent" android:layout_marginLeft="3dp"
-				android:layout_weight="1" android:text="@string/group_separator"></TextView>
-		</TableRow>
-		<TableRow android:layout_width="wrap_content"
-			android:layout_height="wrap_content">
-			<Spinner android:layout_height="wrap_content" android:id="@+id/spinnerDecimals"
-				android:entries="@array/decimals" android:layout_width="wrap_content"
-				android:layout_weight="1"></Spinner>
-			<Spinner android:layout_height="wrap_content"
-				android:layout_width="wrap_content" android:layout_weight="1"
-				android:id="@+id/spinnerDecimalSeparators" android:entries="@array/decimal_separators"></Spinner>
-			<Spinner android:layout_height="wrap_content"
-				android:layout_width="wrap_content" android:layout_weight="1"
-				android:id="@+id/spinnerGroupSeparators" android:entries="@array/group_separators"></Spinner>
+		android:layout_width="fill_parent"
+		android:stretchColumns="*">
+		<TableRow>
+			<TextView android:layout_marginLeft="3dp"
+				android:text="@string/decimals"></TextView>
+			<TextView android:layout_marginLeft="3dp"
+				android:text="@string/decimal_separator"></TextView>
+			<TextView android:layout_marginLeft="3dp"
+				android:text="@string/group_separator"></TextView>
+		</TableRow>
+		<TableRow>
+			<Spinner android:id="@+id/spinnerDecimals"
+				android:entries="@array/decimals"></Spinner>
+			<Spinner android:id="@+id/spinnerDecimalSeparators"
+				android:entries="@array/decimal_separators"></Spinner>
+			<Spinner android:id="@+id/spinnerGroupSeparators"
+				android:entries="@array/group_separators"></Spinner>
+		</TableRow>
+		<View android:layout_height="1dp" android:background="@drawable/divider_horizontal_dark"
+			android:layout_width="fill_parent" android:layout_marginLeft="10dp"
+			android:layout_marginRight="10dp" />
+		<TableRow>
+			<TextView android:layout_marginLeft="3dp"
+				android:text="@string/field_separator"></TextView>
+			<TextView android:layout_marginLeft="3dp"
+				android:text="@string/include_header"></TextView>
+		</TableRow>
+		<TableRow>
+			<Spinner android:id="@+id/spinnerFieldSeparator"
+				android:entries="@array/field_separators"></Spinner>
+			<CheckBox android:id="@+id/checkboxIncludeHeader"
+				android:checked="true"></CheckBox>
 		</TableRow>
 	</TableLayout>
+	
 	<include layout="@layout/ok_cancel_buttons" />
 
-</LinearLayout>
+</LinearLayout>
\ No newline at end of file

=== modified file 'res/values-de/strings.xml'
--- res/values-de/strings.xml	2010-08-24 11:39:10 +0000
+++ res/values-de/strings.xml	2010-09-18 00:44:43 +0000
@@ -177,9 +177,11 @@
     <string name="is_default">Standard</string>
     <string name="is_included_into_totals">Bei Gesamtrechnung berücksichtigen</string>
     <string name="is_included_into_totals_summary">Berücksichtigt die Transaktionen dieses Kontos in der Gesamtrechnung</string>
-    <string name="decimals">\nDezimal</string>
-    <string name="decimal_separator">Dezimal\ntrenner</string>
-    <string name="group_separator">Gruppen\nstrenner</string>
+    <string name="decimals">Dezimal-\nstellen</string>
+    <string name="decimal_separator">Dezimal-\ntrenner</string>
+    <string name="group_separator">Gruppen-\ntrenner</string>
+    <string name="field_separator">Feld-\ntrenner</string>
+    <string name="include_header">Spalten-\nüberschriften</string>
     <string name="delete_account_confirm">Konto löschen?</string>
     <string name="delete_transaction_confirm">Transaktion löschen?</string>
     <string name="delete_budget_confirm">Budget löschen?</string>

=== modified file 'res/values/common.xml'
--- res/values/common.xml	2010-09-12 11:06:23 +0000
+++ res/values/common.xml	2010-09-18 00:44:43 +0000
@@ -56,6 +56,11 @@
 		<item>\' \'</item>		
 		<item>\'\'</item>
 	</string-array>
+	<string-array name="field_separators">
+		<item>\',\'</item>
+		<item>\';\'</item>
+		<item>\'\t\'</item>
+	</string-array>
 	<string-array name="sort_order_entities">
 		<item>1</item>
 		<item>2</item>

=== modified file 'res/values/strings.xml'
--- res/values/strings.xml	2010-09-12 11:06:23 +0000
+++ res/values/strings.xml	2010-09-18 00:44:43 +0000
@@ -209,6 +209,8 @@
 	<string name="decimals">\nDecimals</string>
 	<string name="decimal_separator">Decimal\nseparator</string>
 	<string name="group_separator">Group\nseparator</string>
+	<string name="field_separator">Field\nseparator</string>
+	<string name="include_header">Include\nheader</string>
 	<string name="delete_account_confirm">Delete account?</string>
 	<string name="delete_transaction_confirm">Delete transaction?</string>
 	<string name="delete_budget_confirm">Delete budget?</string>

=== modified file 'src/ru/orangesoftware/financisto/activity/CsvExportActivity.java'
--- src/ru/orangesoftware/financisto/activity/CsvExportActivity.java	2010-06-06 08:16:58 +0000
+++ src/ru/orangesoftware/financisto/activity/CsvExportActivity.java	2010-09-18 00:44:43 +0000
@@ -21,10 +21,12 @@
 import ru.orangesoftware.financisto.utils.DateUtils.PeriodType;
 import android.app.Activity;
 import android.content.Intent;
+import android.content.SharedPreferences;
 import android.os.Bundle;
 import android.view.View;
 import android.view.View.OnClickListener;
 import android.widget.Button;
+import android.widget.CheckBox;
 import android.widget.Spinner;
 
 public class CsvExportActivity extends Activity {
@@ -34,6 +36,8 @@
 	public static final String CSV_EXPORT_GROUP_SEPARATOR = "CSV_EXPORT_GROUP_SEPARATOR";
 	public static final String CSV_EXPORT_DATE_FORMAT = "CSV_EXPORT_DATE_FORMAT";
 	public static final String CSV_EXPORT_TIME_FORMAT = "CSV_EXPORT_TIME_FORMAT";
+	public static final String CSV_EXPORT_FIELD_SEPARATOR = "CSV_EXPORT_FIELD_SEPARATOR";
+	public static final String CSV_EXPORT_INCLUDE_HEADER = "CSV_EXPORT_INCLUDE_HEADER";
 
 	private final WhereFilter filter = WhereFilter.empty();
 
@@ -47,8 +51,6 @@
 		
 		df = DateUtils.getShortDateFormat(this);
 		
-		final Spinner groupSeparators = (Spinner)findViewById(R.id.spinnerGroupSeparators);
-		groupSeparators.setSelection(1);
 		filter.put(new DateTimeCriteria(PeriodType.THIS_MONTH));
 		
 		bPeriod = (Button)findViewById(R.id.bPeriod);
@@ -67,6 +69,9 @@
 			public void onClick(View view) {
 				Spinner decimals = (Spinner)findViewById(R.id.spinnerDecimals);
 				Spinner decimalSeparators = (Spinner)findViewById(R.id.spinnerDecimalSeparators);
+				Spinner groupSeparators = (Spinner)findViewById(R.id.spinnerGroupSeparators);
+				Spinner fieldSeparators = (Spinner)findViewById(R.id.spinnerFieldSeparator);
+				CheckBox includeHeader = (CheckBox)findViewById(R.id.checkboxIncludeHeader);
 
 				Intent data = new Intent();
 				filter.toIntent(data);
@@ -74,6 +79,8 @@
 				data.putExtra(CSV_EXPORT_DECIMALS, 2-decimals.getSelectedItemPosition());
 				data.putExtra(CSV_EXPORT_DECIMAL_SEPARATOR, decimalSeparators.getSelectedItem().toString());
 				data.putExtra(CSV_EXPORT_GROUP_SEPARATOR, groupSeparators.getSelectedItem().toString());
+				data.putExtra(CSV_EXPORT_FIELD_SEPARATOR, fieldSeparators.getSelectedItem().toString().charAt(1));
+				data.putExtra(CSV_EXPORT_INCLUDE_HEADER, includeHeader.isChecked());
 				
 				setResult(RESULT_OK, data);
 				finish();
@@ -92,6 +99,52 @@
 		updatePeriod();
 	}
 
+	@Override
+	protected void onPause() {
+		super.onPause();
+		savePreferences();
+	}
+
+	@Override
+	protected void onResume() {
+		super.onResume();
+		restorePreferences();
+	}
+	
+	private void savePreferences() {
+		Spinner decimals = (Spinner)findViewById(R.id.spinnerDecimals);
+		Spinner decimalSeparators = (Spinner)findViewById(R.id.spinnerDecimalSeparators);
+		Spinner groupSeparators = (Spinner)findViewById(R.id.spinnerGroupSeparators);
+		Spinner fieldSeparators = (Spinner)findViewById(R.id.spinnerFieldSeparator);
+		CheckBox includeHeader = (CheckBox)findViewById(R.id.checkboxIncludeHeader);
+
+		SharedPreferences.Editor editor = getPreferences(MODE_PRIVATE).edit();
+		
+		editor.putInt(CSV_EXPORT_DECIMALS, decimals.getSelectedItemPosition());
+		editor.putInt(CSV_EXPORT_DECIMAL_SEPARATOR, decimalSeparators.getSelectedItemPosition());
+		editor.putInt(CSV_EXPORT_GROUP_SEPARATOR, groupSeparators.getSelectedItemPosition());
+		editor.putInt(CSV_EXPORT_FIELD_SEPARATOR, fieldSeparators.getSelectedItemPosition());
+		editor.putBoolean(CSV_EXPORT_INCLUDE_HEADER, includeHeader.isChecked());
+		
+		editor.commit();
+	}
+	
+	private void restorePreferences() {
+		Spinner decimals = (Spinner)findViewById(R.id.spinnerDecimals);
+		Spinner decimalSeparators = (Spinner)findViewById(R.id.spinnerDecimalSeparators);
+		Spinner groupSeparators = (Spinner)findViewById(R.id.spinnerGroupSeparators);
+		Spinner fieldSeparators = (Spinner)findViewById(R.id.spinnerFieldSeparator);
+		CheckBox includeHeader = (CheckBox)findViewById(R.id.checkboxIncludeHeader);
+
+		SharedPreferences prefs = getPreferences(MODE_PRIVATE);
+		
+		decimals.setSelection(prefs.getInt(CSV_EXPORT_DECIMALS, 0));
+		decimalSeparators.setSelection(prefs.getInt(CSV_EXPORT_DECIMAL_SEPARATOR, 0));
+		groupSeparators.setSelection(prefs.getInt(CSV_EXPORT_GROUP_SEPARATOR, 1));
+		fieldSeparators.setSelection(prefs.getInt(CSV_EXPORT_FIELD_SEPARATOR, 0));
+		includeHeader.setChecked(prefs.getBoolean(CSV_EXPORT_INCLUDE_HEADER, true));
+	}
+
 	private void updatePeriod() {
 		DateTimeCriteria c = filter.getDateTime();
 		if (c == null) {

=== modified file 'src/ru/orangesoftware/financisto/activity/MainActivity.java'
--- src/ru/orangesoftware/financisto/activity/MainActivity.java	2010-09-12 11:06:23 +0000
+++ src/ru/orangesoftware/financisto/activity/MainActivity.java	2010-09-18 00:44:43 +0000
@@ -145,18 +145,20 @@
 			if (resultCode == RESULT_OK) {
 				WhereFilter filter = WhereFilter.fromIntent(data);
 				Currency currency = new Currency();
+				char fieldSeparator = data.getCharExtra(CsvExportActivity.CSV_EXPORT_FIELD_SEPARATOR, ',');
+				boolean includeHeader = data.getBooleanExtra(CsvExportActivity.CSV_EXPORT_INCLUDE_HEADER, true);
 				currency.symbol = "$";
 				currency.decimals = data.getIntExtra(CsvExportActivity.CSV_EXPORT_DECIMALS, 2);
 				currency.decimalSeparator = data.getStringExtra(CsvExportActivity.CSV_EXPORT_DECIMAL_SEPARATOR);
 				currency.groupSeparator = data.getStringExtra(CsvExportActivity.CSV_EXPORT_GROUP_SEPARATOR);
-				doCsvExport(filter, currency);
+				doCsvExport(filter, currency, fieldSeparator, includeHeader);
 			}
 		}
 	}
 	
-	private void doCsvExport(WhereFilter filter, Currency currency) {
+	private void doCsvExport(WhereFilter filter, Currency currency, char fieldSeparaotr, boolean includeHeader) {
 		ProgressDialog d = ProgressDialog.show(this, null, getString(R.string.csv_export_inprogress), true);
-		new CsvExportTask(d, filter, currency).execute((String[])null);
+		new CsvExportTask(d, filter, currency, fieldSeparaotr, includeHeader).execute((String[])null);
 	}
 	
 	private void initialLoad() {
@@ -499,16 +501,21 @@
 		
 		private final WhereFilter filter; 
 		private final Currency currency;
+		private final char fieldSeparator;
+		private final boolean includeHeader;
 		
-		public CsvExportTask(ProgressDialog dialog, WhereFilter filter, Currency currency) {
+		public CsvExportTask(ProgressDialog dialog, WhereFilter filter, Currency currency, 
+				char fieldSeparator, boolean includeHeader) {
 			super(MainActivity.this, dialog, null);
 			this.filter = filter;
 			this.currency = currency;
+			this.fieldSeparator = fieldSeparator;
+			this.includeHeader = includeHeader;
 		}
 		
 		@Override
 		protected Object work(Context context, DatabaseAdapter db, String...params) throws Exception {
-			CSVExport export = new CSVExport(db, filter, currency);
+			CSVExport export = new CSVExport(db, filter, currency, fieldSeparator, includeHeader);
 			return export.export();
 		}
 

=== modified file 'src/ru/orangesoftware/financisto/export/CSVExport.java'
--- src/ru/orangesoftware/financisto/export/CSVExport.java	2010-09-12 11:06:23 +0000
+++ src/ru/orangesoftware/financisto/export/CSVExport.java	2010-09-18 00:44:43 +0000
@@ -33,12 +33,21 @@
 
 	private final DatabaseAdapter db;
 	private final WhereFilter filter;
-	private final NumberFormat f; 
+	private final NumberFormat f;
+	private final char fieldSeparator;
+	private final boolean includeHeader;
 	
-	public CSVExport(DatabaseAdapter db, WhereFilter filter, Currency currency) {
+	public CSVExport(DatabaseAdapter db, WhereFilter filter, Currency currency,
+			char fieldSeparator, boolean includeHeader) {
 		this.db = db;
 		this.filter = filter;
 		this.f = CurrencyCache.createCurrencyFormat(currency);
+		this.fieldSeparator = fieldSeparator;
+		this.includeHeader = includeHeader;
+	}
+	
+	public CSVExport(DatabaseAdapter db, WhereFilter filter, Currency currency) {
+		this(db, filter, currency, ',', true);
 	}
 	
 	@Override
@@ -48,12 +57,17 @@
 
 	@Override
 	protected void writeHeader(BufferedWriter bw) throws IOException  {
-		bw.write("date,time,account,amount,currency,category,parent,location,project,note\n");
+		if (includeHeader) {
+			Csv.Writer w = new Csv.Writer(bw).delimiter(fieldSeparator);
+			w.value("date").value("time").value("account").value("amount").value("currency");
+			w.value("category").value("parent").value("location").value("project").value("note");
+			w.newLine();
+		}
 	}
 
 	@Override
 	protected void writeBody(BufferedWriter bw) throws IOException {
-		Csv.Writer w = new Csv.Writer(bw).delimiter(',');
+		Csv.Writer w = new Csv.Writer(bw).delimiter(fieldSeparator);
 		try {
 			HashMap<Long, Category> categoriesMap = db.getAllCategoriesMap(false);
 			Cursor c = db.getBlotter(filter);