Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactoring. From Singleton to Factory #6

Closed
wants to merge 12 commits into from
Closed

Refactoring. From Singleton to Factory #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
a04092d
Removing todo since PaperDbException is already throws
libraua Jul 2, 2015
395adba
Refactoring. From Singleton to Static Factory
libraua Jul 2, 2015
3f91fa9
Merge remote-tracking branch 'origin/master'
libraua Jul 3, 2015
a88911b
Refactoring. From Singleton to Static Factory
libraua Jun 29, 2015
e5b1b6c
Merge branch 'master' of https://github.com/libraua/Paper
libraua Jul 3, 2015
be48ef7
Refactoring. From Singleton to Static Factory
libraua Jul 5, 2015
6d429c4
Merge remote-tracking branch 'origin/master'
libraua Jul 5, 2015
ec87d68
Refactoring. From Singleton to Static Factory
libraua Jul 5, 2015
c6b9fd5
Refactoring. From Singleton to Static Factory
libraua Jul 5, 2015
e6c6493
Refactoring. From Singleton to Static Factory
libraua Jul 5, 2015
64e4f92
ReadMe updated
libraua Jul 6, 2015
6562eb4
Visibility of parameter changed for test purposes
libraua Jul 6, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,39 +22,39 @@ Save data object. Your custom classes must have no-arg constructor.
Paper creates separate data file for each key.

```java
Paper.put("city", "Lund"); // Primitive
Paper.put("task-queue", queue); // LinkedList
Paper.put("countries", countryCodeMap); // HashMap
Paper.book().write("city", "Lund"); // Primitive
Paper.book().write("task-queue", queue); // LinkedList
Paper.book().write("countries", countryCodeMap); // HashMap
```

#### Read
Read data objects. Paper instantiates exactly the classes which has been used in saved data. The limited backward and forward compatibility is supported. See [Handle data class changes](#handle-data-structure-changes).

```java
String city = Paper.get("city");
LinkedList queue = Paper.get("task-queue");
HashMap countryCodeMap = Paper.get("countries");
String city = Paper.book().read("city");
LinkedList queue = Paper.book().read("task-queue");
HashMap countryCodeMap = Paper.book().read("countries");
```

Use default values if object doesn't exist in the storage.

```java
String city = Paper.get("city", "Kyiv");
LinkedList queue = Paper.get("task-queue", new LinkedList());
HashMap countryCodeMap = Paper.get("countries", new HashMap());
String city = Paper.book().read("city", "Kyiv");
LinkedList queue = Paper.book().read("task-queue", new LinkedList());
HashMap countryCodeMap = Paper.book().read("countries", new HashMap());
```

#### Delete
Delete data for one key.

```java
Paper.delete("countries");
Paper.book().delete("countries");
```

Completely clear Paper storage. Doesn't require to call init() before usage.

```java
Paper.clear(context);
Paper.book().clear(context);
```

#### Handle data structure changes
Expand Down Expand Up @@ -113,7 +113,7 @@ Paper is based on the following assumptions:
- Saved data on mobile are relatively small;
- Random file access on flash storage is very fast.

So each data object is saved in separate file and put/get operations write/read whole file.
So each data object is saved in separate file and write/read operations write/read whole file.

The [Kryo](https://github.com/EsotericSoftware/kryo) is used for object graph serialization and to provide data compatibility support.

Expand Down
14 changes: 7 additions & 7 deletions paperdb/src/androidTest/java/io/paperdb/CompatibilityTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ public class CompatibilityTest {

@Before
public void setUp() throws Exception {
Paper.clear(getTargetContext());
Paper.init(getTargetContext());
Paper.book().destroy();
}

@Test
Expand All @@ -34,10 +34,10 @@ public void testChangeClass()
testClass.timestamp = 123;

// Save original class. Only class name is changed to TestClassNew
Paper.put("test", testClass);
Paper.book().write("test", testClass);

// Read and instantiate a modified class TestClassNew based on saved data in TestClass
TestClassNew newTestClass = Paper.get("test");
TestClassNew newTestClass = Paper.book().read("test");
// Check original value is restored despite new default value in TestClassNew
assertThat(newTestClass.name).isEqualTo("original");
// Check default value for new added field
Expand All @@ -51,9 +51,9 @@ public void testNotCompatibleClassChanges() throws Exception {
TestClass testClass = getClassInstanceWithNewName(TestClass.class,
TestClassNotCompatible.class.getName());
testClass.timestamp = 123;
Paper.put("not-compatible", testClass);
Paper.book().write("not-compatible", testClass);

Paper.<TestClassNotCompatible>get("not-compatible");
Paper.book().<TestClassNotCompatible>read("not-compatible");
}

@Test
Expand All @@ -62,9 +62,9 @@ public void testTransientFields() throws Exception {
tc.timestamp = 123;
tc.transientField = "changed";

Paper.put("transient-class", tc);
Paper.book().write("transient-class", tc);

TestClassTransient readTc = Paper.get("transient-class");
TestClassTransient readTc = Paper.book().read("transient-class");
assertThat(readTc.timestamp).isEqualTo(123);
assertThat(readTc.transientField).isEqualTo("default");
}
Expand Down
24 changes: 12 additions & 12 deletions paperdb/src/androidTest/java/io/paperdb/DataTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,47 +23,47 @@
import static org.assertj.core.api.Assertions.assertThat;

/**
* Tests List put/get API
* Tests List write/read API
*/
@RunWith(AndroidJUnit4.class)
public class DataTest {

@Before
public void setUp() throws Exception {
Paper.clear(getTargetContext());
Paper.init(getTargetContext());
Paper.book().destroy();
}

@Test
public void testPutEmptyList() throws Exception {
final List<Person> inserted = genPersonList(0);
Paper.put("persons", inserted);
assertThat(Paper.<List>get("persons")).isEmpty();
Paper.book().write("persons", inserted);
assertThat(Paper.book().<List>read("persons")).isEmpty();
}

@Test
public void testPutGetList() {
final List<Person> inserted = genPersonList(10000);
Paper.put("persons", inserted);
List<Person> persons = Paper.get("persons");
Paper.book().write("persons", inserted);
List<Person> persons = Paper.book().read("persons");
assertThat(persons).isEqualTo(inserted);
}

@Test
public void testPutMap() {
final Map<Integer, Person> inserted = genPersonMap(10000);
Paper.put("persons", inserted);
Paper.book().write("persons", inserted);

final Map<Integer, Person> personMap = Paper.get("persons");
final Map<Integer, Person> personMap = Paper.book().read("persons");
assertThat(personMap).isEqualTo(inserted);
}

@Test
public void testPutPOJO() {
final Person person = genPerson(1);
Paper.put("profile", person);
Paper.book().write("profile", person);

final Person savedPerson = Paper.get("profile");
final Person savedPerson = Paper.book().read("profile");
assertThat(savedPerson).isEqualTo(person);
assertThat(savedPerson).isNotSameAs(person);
}
Expand Down Expand Up @@ -134,8 +134,8 @@ public void testPutSynchronizedList() {
}

private Object testReadWriteWithoutClassCheck(Object originObj) {
Paper.put("obj", originObj);
Object readObj = Paper.get("obj");
Paper.book().write("obj", originObj);
Object readObj = Paper.book().read("obj");
assertThat(readObj).isEqualTo(originObj);
return readObj;
}
Expand Down
89 changes: 48 additions & 41 deletions paperdb/src/androidTest/java/io/paperdb/PaperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,110 +20,117 @@ public class PaperTest {

@Before
public void setUp() throws Exception {
Paper.clear(getTargetContext());
Paper.init(getTargetContext());
Paper.book().destroy();
}

@Test
public void testExist() throws Exception {
assertFalse(Paper.exist("persons"));
Paper.put("persons", TestDataGenerator.genPersonList(10));
assertTrue(Paper.exist("persons"));
assertFalse(Paper.book().exist("persons"));
Paper.book().write("persons", TestDataGenerator.genPersonList(10));
assertTrue(Paper.book().exist("persons"));
}

@Test
public void testDelete() throws Exception {
Paper.put("persons", TestDataGenerator.genPersonList(10));
assertTrue(Paper.exist("persons"));
Paper.delete("persons");
assertFalse(Paper.exist("persons"));
Paper.book().write("persons", TestDataGenerator.genPersonList(10));
assertTrue(Paper.book().exist("persons"));
Paper.book().delete("persons");
assertFalse(Paper.book().exist("persons"));
}

@Test
public void testDeleteNotExisted() throws Exception {
assertFalse(Paper.exist("persons"));
Paper.delete("persons");
assertFalse(Paper.book().exist("persons"));
Paper.book().delete("persons");
}

@Test
public void testClear() throws Exception {
Paper.put("persons", TestDataGenerator.genPersonList(10));
Paper.put("persons2", TestDataGenerator.genPersonList(20));
assertTrue(Paper.exist("persons"));
assertTrue(Paper.exist("persons2"));
Paper.book().write("persons", TestDataGenerator.genPersonList(10));
Paper.book().write("persons2", TestDataGenerator.genPersonList(20));
assertTrue(Paper.book().exist("persons"));
assertTrue(Paper.book().exist("persons2"));

Paper.clear(getTargetContext());
Paper.book().destroy();
// init() call is not required after clear()
assertFalse(Paper.exist("persons"));
assertFalse(Paper.exist("persons2"));
assertFalse(Paper.book().exist("persons"));
assertFalse(Paper.book().exist("persons2"));

// Should be possible to continue to use Paper after clear()
Paper.put("persons3", TestDataGenerator.genPersonList(30));
assertTrue(Paper.exist("persons3"));
assertThat(Paper.<List>get("persons3")).hasSize(30);
Paper.book().write("persons3", TestDataGenerator.genPersonList(30));
assertTrue(Paper.book().exist("persons3"));
assertThat(Paper.book().<List>read("persons3")).hasSize(30);
}

@Test
public void testPutGetNormal() {
Paper.put("city", "Lund");
String val = Paper.get("city", "default");
Paper.book().write("city", "Lund");
String val = Paper.book().read("city", "default");
assertThat(val).isEqualTo("Lund");
}

@Test
public void testPutGetNormalAfterReinit() {
Paper.put("city", "Lund");
String val = Paper.get("city", "default");
Paper.book().write("city", "Lund");
String val = Paper.book().read("city", "default");
Paper.init(getTargetContext());// Reinit Paper instance
assertThat(val).isEqualTo("Lund");
}

@Test
public void testGetNotExisted() {
String val = Paper.get("non-existed");
String val = Paper.book().read("non-existed");
assertThat(val).isNull();
}

@Test
public void testGetDefault() {
String val = Paper.get("non-existed", "default");
String val = Paper.book().read("non-existed", "default");
assertThat(val).isEqualTo("default");
}

@Test
public void testPutNull() {
Paper.put("city", "Lund");
String val = Paper.get("city");
Paper.book().write("city", "Lund");
String val = Paper.book().read("city");
assertThat(val).isEqualTo("Lund");

Paper.put("city", null);
String nullVal = Paper.get("city");
Paper.book().write("city", null);
String nullVal = Paper.book().read("city");
assertThat(nullVal).isNull();
}

@Test
public void testReplace() {
Paper.put("city", "Lund");
Paper.put("city", "Kyiv");
assertThat(Paper.get("city")).isEqualTo("Kyiv");
Paper.book().write("city", "Lund");
assertThat(Paper.book().read("city")).isEqualTo("Lund");
Paper.book().write("city", "Kyiv");
assertThat(Paper.book().read("city")).isEqualTo("Kyiv");
}

@Test
public void testValidKeyNames() {
Paper.put("city", "Lund");
assertThat(Paper.get("city")).isEqualTo("Lund");
Paper.book().write("city", "Lund");
assertThat(Paper.book().read("city")).isEqualTo("Lund");

Paper.put("city.dasd&%", "Lund");
assertThat(Paper.get("city.dasd&%")).isEqualTo("Lund");
Paper.book().write("city.dasd&%", "Lund");
assertThat(Paper.book().read("city.dasd&%")).isEqualTo("Lund");

Paper.put("city-ads", "Lund");
assertThat(Paper.get("city-ads")).isEqualTo("Lund");
Paper.book().write("city-ads", "Lund");
assertThat(Paper.book().read("city-ads")).isEqualTo("Lund");
}

@Test(expected=PaperDbException.class)
public void testInvalidKeyNameBackslash() {
Paper.put("city/ads", "Lund");
assertThat(Paper.get("city/ads")).isEqualTo("Lund");
Paper.book().write("city/ads", "Lund");
assertThat(Paper.book().read("city/ads")).isEqualTo("Lund");
}

@Test(expected=PaperDbException.class)
public void testBookname() {
Paper.book().write("city", "Lund");
assertThat(Paper.book().read("city")).isEqualTo("Lund");
Paper.book(Paper.DEFAULT_DB_NAME).write("city", "Lund");
}
}
14 changes: 7 additions & 7 deletions paperdb/src/androidTest/java/io/paperdb/benchmark/Benchmark.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ public class Benchmark extends AndroidTestCase {
@Test
public void testReadWrite500Contacts() throws Exception {
final List<Person> contacts = TestDataGenerator.genPersonList(500);
Paper.clear(getTargetContext());
Paper.init(getTargetContext());
Paper.book().destroy();
long paperTime = runTest(new PaperReadWriteContactsTest(), contacts, REPEAT_COUNT);

Hawk.init(getTargetContext());
Expand All @@ -45,8 +45,8 @@ public void testReadWrite500Contacts() throws Exception {
@Test
public void testWrite500Contacts() throws Exception {
final List<Person> contacts = TestDataGenerator.genPersonList(500);
Paper.clear(getTargetContext());
Paper.init(getTargetContext());
Paper.book().destroy();
long paperTime = runTest(new PaperWriteContactsTest(), contacts, REPEAT_COUNT);

Hawk.init(getTargetContext());
Expand All @@ -59,8 +59,8 @@ public void testWrite500Contacts() throws Exception {
@Test
public void testRead500Contacts() throws Exception {
final List<Person> contacts = TestDataGenerator.genPersonList(500);
Paper.clear(getTargetContext());
Paper.init(getTargetContext());
Paper.book().destroy();
runTest(new PaperWriteContactsTest(), contacts, REPEAT_COUNT); //Prepare
long paperTime = runTest(new PaperReadContactsTest(), contacts, REPEAT_COUNT);

Expand Down Expand Up @@ -93,8 +93,8 @@ private class PaperReadWriteContactsTest implements TestTask<List<Person>> {
@Override
public void run(int i, List<Person> extra) {
String key = "contacts" + i;
Paper.put(key, extra);
Paper.<List<Person>>get(key);
Paper.book().write(key, extra);
Paper.book().<List<Person>>read(key);
}
}

Expand All @@ -111,7 +111,7 @@ private class PaperWriteContactsTest implements TestTask<List<Person>> {
@Override
public void run(int i, List<Person> extra) {
String key = "contacts" + i;
Paper.put(key, extra);
Paper.book().write(key, extra);
}
}

Expand All @@ -127,7 +127,7 @@ private class PaperReadContactsTest implements TestTask<List<Person>> {
@Override
public void run(int i, List<Person> extra) {
String key = "contacts" + i;
Paper.<List<Person>>get(key);
Paper.book().<List<Person>>read(key);
}
}

Expand Down
Loading