Merge lp:~thisfred/u1db/u1todo-2 into lp:u1db

[Eric Casteleijn]

Initial UI: adding editing and deleting tasks works. Done status and tags not so much.

Initial UI: adding editing and deleting tasks works. Done status and tags not so much.

to test, run:

PYTHONPATH=. python u1todo/ui.py

from the checkout root.

[Lucio Torre (lucio.torre)]

173 +class UIMainWindow(object):
174 + def setupUi(self, MainWindow):

This function scares me a bit. I dont know the desktop+ prefences about it, but i was expecting some declarative thing taking care of that. Is that reasonable?

[Lucio Torre (lucio.torre)]

i know its a bit premature, but i would get some time from the people from design to get a very minimal but useful UX for the todo list. :)

[Eric Casteleijn (thisfred)]

> 173 +class UIMainWindow(object):
> 174 + def setupUi(self, MainWindow):
>
> This function scares me a bit. I dont know the desktop+ prefences about it,
> but i was expecting some declarative thing taking care of that. Is that
> reasonable?

I don't really know: I used QtDesigner to get off the ground, and that is what it generated. Maybe I should put it back in a separate module so that nobody thinks of it as part of the example code. ;)

[Roberto Alsina (ralsina)]

> > 173 +class UIMainWindow(object):
> > 174 + def setupUi(self, MainWindow):
> >
> > This function scares me a bit. I dont know the desktop+ prefences about it,
> > but i was expecting some declarative thing taking care of that. Is that
> > reasonable?
>
> I don't really know: I used QtDesigner to get off the ground, and that is what
> it generated. Maybe I should put it back in a separate module so that nobody
> thinks of it as part of the example code. ;)

Talk to me when I start working and I'll show you the problem with that :-)

[Roberto Alsina (ralsina)]

> > 173 +class UIMainWindow(object):
> > 174 + def setupUi(self, MainWindow):
> >
> > This function scares me a bit. I dont know the desktop+ prefences about it,
> > but i was expecting some declarative thing taking care of that. Is that
> > reasonable?
>
> I don't really know: I used QtDesigner to get off the ground, and that is what
> it generated. Maybe I should put it back in a separate module so that nobody
> thinks of it as part of the example code. ;)

Oh, well, should not look at code before waking up, I guess. Lucio, that's generated code.

[Lucio Torre (lucio.torre)]

That does not make it better.
The project has the generated code and no ui file, and the code already includes some functions which were not generated.
I would really prefer to read some static definition in runtime that we can also open back with qtdesigner.

[John A Meinel (jameinel)]

On 4/20/2012 1:23 PM, Roberto Alsina wrote:
>>> 173 +class UIMainWindow(object):
>>> 174 + def setupUi(self, MainWindow):
>>>
>>> This function scares me a bit. I dont know the desktop+ prefences about it,
>>> but i was expecting some declarative thing taking care of that. Is that
>>> reasonable?
>>
>> I don't really know: I used QtDesigner to get off the ground, and that is what
>> it generated. Maybe I should put it back in a separate module so that nobody
>> thinks of it as part of the example code. ;)
>
> Oh, well, should not look at code before waking up, I guess. Lucio, that's generated code.

Note that usually there are 2 ways to deal with QtDesigner. One is that
you create an XML (.ui) file that has the widget layout, which then gets
loaded by the Qt runtime and has objects instantiated.

The other is that it generates python/c++/$lang code directly rather
than a .ui file, and that essentially has the same code as would have
been run when loading the .ui file.

The difficulty in both is how you attach your own functionality to it. I
believe with the .ui file you have to have a proxy object, while with
the .py file you subclass it and add methods to your subclass, and just
regenerate the super class using QtDesigner from time to time.

John
=:->

[John A Meinel (jameinel)]

On 4/20/2012 1:40 PM, Lucio Torre wrote:
> That does not make it better.
> The project has the generated code and no ui file, and the code already includes some functions which were not generated.
> I would really prefer to read some static definition in runtime that we can also open back with qtdesigner.
>
>

I haven't looked at the code, but yes, if a given file is generated, it
should not be modified in place. Instead a separate file should inherit
from that one to provide the custom functionality.

John
=:->

[lp:~thisfred/u1db/u1todo-2]

251. By Eric Casteleijn on 2012-04-20

dynamically load the ui.

[Roberto Alsina (ralsina)]

Eric, we should make the code follow the standards we have for the rest of Desktop team's projects. I amnot going to suggest pylint, but try to make pyflakes and pep8 do a clean run on the code, please.

Other than that, it looks pretty good now, there are some missing docstrings though ;-)

review: Needs Information

[lp:~thisfred/u1db/u1todo-2]

252. By Eric Casteleijn on 2012-04-20

added docstrings

253. By Eric Casteleijn on 2012-04-23

moar docstrings

[Roberto Alsina (ralsina)]

+1

review: Approve

[lp:~thisfred/u1db/u1todo-2]

254. By Eric Casteleijn on 2012-04-23

remerged trunk

=== modified file 'u1todo/test_u1todo.py'
--- u1todo/test_u1todo.py	2012-04-18 20:09:57 +0000
+++ u1todo/test_u1todo.py	2012-04-23 13:27:17 +0000
@@ -1,3 +1,5 @@
+"""Tests for u1todo example application."""
+
 from testtools import TestCase
 from u1todo import Task, TodoStore, INDEXES, EMPTY_TASK, DONE, NOT_DONE
 from u1db.backends import inmemory
@@ -50,7 +52,21 @@
         store = TodoStore(self.db)
         task = store.new_task()
         self.assertTrue(isinstance(task, Task))
-        self.assertIsNotNone(task.document.doc_id)
+        self.assertIsNotNone(task.task_id)
+
+    def test_new_task_with_title(self):
+        """Creates a new task."""
+        store = TodoStore(self.db)
+        title = "Un task muy importante"
+        task = store.new_task(title=title)
+        self.assertEqual(title, task.title)
+
+    def test_new_task_with_tags(self):
+        """Creates a new task."""
+        store = TodoStore(self.db)
+        tags = ['foo', 'bar', 'bam']
+        task = store.new_task(tags=tags)
+        self.assertEqual(tags, task.tags)
 
     def test_save_task_get_task(self):
         """Saves a modified task and retrieves it from the db."""
@@ -58,9 +74,21 @@
         task = store.new_task()
         task.title = "This is the title."
         store.save_task(task)
-        task_copy = store.get_task(task.document.doc_id)
+        task_copy = store.get_task(task.task_id)
         self.assertEqual(task.title, task_copy.title)
 
+    def test_get_non_existant_task(self):
+        """Saves a modified task and retrieves it from the db."""
+        store = TodoStore(self.db)
+        self.assertRaises(KeyError, store.get_task, "nonexistant")
+
+    def test_delete_task(self):
+        """Deletes a task by id."""
+        store = TodoStore(self.db)
+        task = store.new_task()
+        store.delete_task(task)
+        self.assertRaises(KeyError, store.get_task, task.task_id)
+
 
 class TaskTestCase(TestCase):
     """Tests for Task."""
@@ -77,6 +105,11 @@
         self.assertEqual([], task.tags)
         self.assertEqual(False, task.done)
 
+    def test_task_id(self):
+        """Task id is set to document id."""
+        task = Task(self.document)
+        self.assertEqual(self.document.doc_id, task.task_id)
+
     def test_set_title(self):
         """Changing the title is persistent."""
         task = Task(self.document)

=== modified file 'u1todo/u1todo.py'
--- u1todo/u1todo.py	2012-04-18 20:09:57 +0000
+++ u1todo/u1todo.py	2012-04-23 13:27:17 +0000
@@ -1,3 +1,5 @@
+"""u1todo example application."""
+
 import json
 
 DONE = 'true'
@@ -18,6 +20,7 @@
         self.db = db
 
     def initialize_db(self):
+        """Initialize the database."""
         db_indexes = dict(self.db.list_indexes())
         for name, expression in INDEXES.items():
             if name not in db_indexes:
@@ -40,14 +43,31 @@
         document = self.db.get_doc(task_id)
         if document is None:
             raise KeyError("No task with id '%s'." % (task_id,))
+        if document.content is None:
+            raise KeyError("Task with id %s was deleted." % (task_id,))
         return Task(document)
 
-    def new_task(self):
-        document = self.db.create_doc(content=EMPTY_TASK)
+    def delete_task(self, task):
+        """Delete a task from the database."""
+        self.db.delete_doc(task._document)
+
+    def new_task(self, title=None, tags=None):
+        """Create a new task document."""
+        # Create the document in the u1db database
+        content = EMPTY_TASK
+        if title or tags:
+            content_object = json.loads(content)
+            content_object['title'] = title
+            content_object['tags'] = tags
+            content = json.dumps(content_object)
+        document = self.db.create_doc(content=content)
+        # Wrap the document in a Task object.
         return Task(document)
 
     def save_task(self, task):
         """Save task to the database."""
+        # Get the u1db document from the task object, and save it to the
+        # database.
         self.db.put_doc(task.document)
 
 
@@ -58,6 +78,11 @@
         self._document = document
         self._content = json.loads(document.content)
 
+    @property
+    def task_id(self):
+        """The u1db id of the task."""
+        return self._document.doc_id
+
     def _get_title(self):
         """Get the task title."""
         return self._content['title']
@@ -75,6 +100,7 @@
         return True if self._content['done'] == DONE else False
 
     def _set_done(self, value):
+        """Set the done status."""
         # Indexes on booleans are not currently possible, so we convert to and
         # from strings.
         self._content['done'] = DONE if value else NOT_DONE
@@ -86,11 +112,13 @@
         return self._content['tags']
 
     def _set_tags(self, tags):
+        """Set tags associated with the task."""
         self._content['tags'] = list(set(tags))
 
     tags = property(_get_tags, _set_tags, doc="Task tags.")
 
     def add_tag(self, tag):
+        """Add a single tag to the task."""
         tags = self._content['tags']
         if tag in tags:
             # Tasks cannot have the same tag more than once, so ignore the
@@ -99,6 +127,7 @@
         tags.append(tag)
 
     def remove_tag(self, tag):
+        """Remove a single tag from the task."""
         tags = self._content['tags']
         if tag not in tags:
             # Can't remove a tag that the task does not have.
@@ -107,5 +136,6 @@
 
     @property
     def document(self):
+        """The u1db document representing this task."""
         self._document.content = json.dumps(self._content)
         return self._document

=== added file 'u1todo/u1todo.ui'
--- u1todo/u1todo.ui	1970-01-01 00:00:00 +0000
+++ u1todo/u1todo.ui	2012-04-23 13:27:17 +0000
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>MainWindow</class>
+ <widget class="QMainWindow" name="MainWindow">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>334</width>
+    <height>834</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>MainWindow</string>
+  </property>
+  <widget class="QWidget" name="centralwidget">
+   <layout class="QVBoxLayout" name="verticalLayout">
+    <item>
+     <widget class="QListWidget" name="list_widget"/>
+    </item>
+    <item>
+     <layout class="QHBoxLayout" name="horizontalLayout">
+      <item>
+       <widget class="QLineEdit" name="line_edit"/>
+      </item>
+      <item>
+       <widget class="QPushButton" name="edit_button">
+        <property name="text">
+         <string>Add/Edit</string>
+        </property>
+       </widget>
+      </item>
+      <item>
+       <widget class="QPushButton" name="delete_button">
+        <property name="text">
+         <string>Delete</string>
+        </property>
+       </widget>
+      </item>
+     </layout>
+    </item>
+   </layout>
+  </widget>
+  <widget class="QMenuBar" name="menubar">
+   <property name="geometry">
+    <rect>
+     <x>0</x>
+     <y>0</y>
+     <width>334</width>
+     <height>21</height>
+    </rect>
+   </property>
+  </widget>
+  <widget class="QStatusBar" name="statusbar"/>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>

=== added file 'u1todo/ui.py'
--- u1todo/ui.py	1970-01-01 00:00:00 +0000
+++ u1todo/ui.py	2012-04-23 13:27:17 +0000
@@ -0,0 +1,94 @@
+"""User interface for the u1todo example application."""
+
+from u1db.backends import inmemory
+from u1todo import TodoStore
+import os
+import sys
+from PyQt4 import QtGui, QtCore, uic
+
+
+class UITask(QtGui.QListWidgetItem):
+    """Task list item."""
+
+    def __init__(self, task):
+        super(UITask, self).__init__()
+        self.task = task
+        self.setText(self.task.title)
+        self.setCheckState(
+            QtCore.Qt.Checked if task.done else QtCore.Qt.Unchecked)
+
+
+class Main(QtGui.QMainWindow):
+    """Main window of our application."""
+
+    def __init__(self):
+        super(Main, self).__init__()
+        uifile = os.path.join(os.path.abspath(os.path.dirname(__file__)),
+                              'u1todo.ui')
+        uic.loadUi(uifile, self)
+        db = inmemory.InMemoryDatabase("u1todo")
+        self.store = TodoStore(db)
+        self.connect_events()
+        self.item = None
+        self.delete_button.setEnabled(False)
+
+    def connect_events(self):
+        """Hook up all the signal handlers."""
+        self.connect(
+            self.edit_button, QtCore.SIGNAL("clicked()"), self.update)
+        self.connect(
+            self.delete_button, QtCore.SIGNAL("clicked()"), self.delete)
+        self.connect(
+            self.list_widget, QtCore.SIGNAL("currentRowChanged(int)"),
+            self.row_changed)
+
+    def update(self):
+        """Either add a new task or update an existing one."""
+        text = unicode(self.line_edit.text(), 'utf-8')
+        if not text:
+            return
+        if self.item is None:
+            self.add_item(text)
+        else:
+            self.update_item(text)
+        self.line_edit.clear()
+        self.item = None
+
+    def delete(self):
+        """Delete a todo item."""
+        item = self.list_widget.takeItem(self.list_widget.currentRow())
+        self.store.delete_task(item.task)
+        if self.list_widget.count() == 0:
+            self.delete_button.setEnabled(False)
+
+    def add_item(self, text):
+        """Add a new todo item."""
+        task = self.store.new_task(text)
+        item = UITask(task)
+        self.list_widget.addItem(item)
+        self.delete_button.setEnabled(True)
+
+    def update_item(self, text):
+        """Edit an existing todo item."""
+        self.item.task.title = text
+        self.item.setText(text)
+        self.store.save_task(self.item.task)
+
+    def row_changed(self, index):
+        """Edit item when row changes."""
+        if index == -1:
+            self.line_edit.clear()
+            return
+        self.edit_item(self.list_widget.item(index))
+
+    def edit_item(self, item):
+        """Edit item in line edit box."""
+        self.item = item
+        self.line_edit.setText(item.task.title)
+
+
+if __name__ == "__main__":
+    app = QtGui.QApplication(sys.argv)
+    main = Main()
+    main.show()
+    app.exec_()