Merge lp:~facundo/magicicada-gui/stop-rezero into lp:magicicada-gui

[Facundo Batista]

Reuse current Operations TreeStore instead of clearing and filling from scratch.

Reuse current Operations TreeStore instead of clearing and filling from scratch.

This has two important effects:

1) Much much more efficient when handling changes in big trees.

2) Stop resetting to zero the transfers when changes go in.

Tests adjusted and created.

[lp:~facundo/magicicada-gui/stop-rezero]

139. By Facundo Batista on 2013-11-27

Small fixes.

[Natalia Bidart (nataliabidart)]

Looks great!

review: Approve

=== modified file 'magicicada/gui/gtk/operations.py'
--- magicicada/gui/gtk/operations.py	2012-09-19 23:28:39 +0000
+++ magicicada/gui/gtk/operations.py	2013-11-27 18:36:06 +0000
@@ -122,6 +122,15 @@
         row_key = None
         transfer_ops = []
         show_transfer = False
+        current_children = []
+
+        if parent_iter is None:
+            # parent being None complicates how the children are get
+            nch = self.ops_store.iter_n_children(None)
+            current_children = [self.ops_store[i] for i in range(nch)]
+        else:
+            # get the items at this level (chidren from parent)
+            current_children = list(self.ops_store[parent_iter].iterchildren())
 
         if row_info is not None:
             transfer_ops = filter(lambda op: op[1] in TRANSFER_OPS,
@@ -132,8 +141,17 @@
             all_done = all(op[2][queue_content.DONE] for op in transfer_ops)
             show_transfer = not all_done
 
-        row = row + (0, show_transfer, '')
-        tree_iter = self.ops_store.append(parent_iter, row)
+        for child in current_children:
+            if row[0] == child[0].decode("utf8"):
+                # row in current children, let's just modify it
+                child[1] = row[1]
+                child[6] = show_transfer
+                tree_iter = child.iter
+                break
+        else:
+            # not there in current children, let's add it
+            row = row + (0, show_transfer, '')
+            tree_iter = self.ops_store.append(parent_iter, row)
 
         if row_key is not None:
             self._store_idx[row_key] = tree_iter
@@ -173,20 +191,21 @@
             else:
                 self._append_file_row(child_name, child_info, parent)
 
-    def on_node_ops_changed(self, items, *args, **kwargs):
+    def on_node_ops_changed(self, items, clear=False):
         """Callback'ed when syncadaemon's node ops info changed."""
         if not items:
             items = []
 
         self.ops_view.set_model(None)
-        self.ops_store.clear()
+        if clear:
+            self.ops_store.clear()
         self._can_clear = False
 
         for root_kind, root_info in items:
             icon_name = (HOME_ICON_NAME
                          if root_kind == queue_content.ROOT_HOME
                          else REMOTE_ICON_NAME)
-            row = ('', '', None, icon_name, Gtk.IconSize.LARGE_TOOLBAR)
+            row = (root_kind, '', None, icon_name, Gtk.IconSize.LARGE_TOOLBAR)
             parent = self._append_row(None, row)
             self._append_root_row(root_info, parent)
 
@@ -201,7 +220,7 @@
     def on_clear_button_clicked(self, button):
         """The clear button was clicked, remove all complete operations."""
         self.sd.queue_content.clear()
-        self.load()
+        self.on_node_ops_changed(self.sd.queue_content.node_ops, clear=True)
 
     def load(self):
         """Update UI based on SD current state."""

=== modified file 'magicicada/gui/gtk/tests/test_operations.py'
--- magicicada/gui/gtk/tests/test_operations.py	2012-09-19 23:28:39 +0000
+++ magicicada/gui/gtk/tests/test_operations.py	2013-11-27 18:36:06 +0000
@@ -100,9 +100,9 @@
 
         root = [u'', u'', None, operations.HOME_ICON_NAME,
                 Gtk.IconSize.LARGE_TOOLBAR]
-        yada = [u'', u'', None, operations.REMOTE_ICON_NAME,
+        yada = [u'Yadda', u'', None, operations.REMOTE_ICON_NAME,
                 Gtk.IconSize.LARGE_TOOLBAR]
-        yoda = [u'', u'', None, operations.REMOTE_ICON_NAME,
+        yoda = [u'Yodda', u'', None, operations.REMOTE_ICON_NAME,
                 Gtk.IconSize.LARGE_TOOLBAR]
 
         self.assert_store_correct([(root, []), (yada, []), (yoda, [])])
@@ -116,7 +116,7 @@
         sd_items = [(u'Yadda', {node.name: node})]
         self.sd.on_node_ops_changed_callback(sd_items)
 
-        yada = [u'', u'', None, operations.REMOTE_ICON_NAME,
+        yada = [u'Yadda', u'', None, operations.REMOTE_ICON_NAME,
                 Gtk.IconSize.LARGE_TOOLBAR]
         node_row = [node.name, u'', None,
                     operations.FOLDER_ICON_NAME, Gtk.IconSize.SMALL_TOOLBAR]
@@ -143,7 +143,7 @@
         sd_items = [(u'Yadda', {node.name: node})]
         self.sd.on_node_ops_changed_callback(sd_items)
 
-        yada = [u'', u'', None, operations.REMOTE_ICON_NAME,
+        yada = [u'Yadda', u'', None, operations.REMOTE_ICON_NAME,
                 Gtk.IconSize.LARGE_TOOLBAR]
         node_row = [node.name, u'', None,
                     operations.FOLDER_ICON_NAME, Gtk.IconSize.SMALL_TOOLBAR]
@@ -171,7 +171,7 @@
         sd_items = [(u'Yadda', {file_node.name: file_node})]
         self.sd.on_node_ops_changed_callback(sd_items)
 
-        yada = [u'', u'', None, operations.REMOTE_ICON_NAME,
+        yada = [u'Yadda', u'', None, operations.REMOTE_ICON_NAME,
                 Gtk.IconSize.LARGE_TOOLBAR]
         op_name = u'foo, bar, ' + long_op_name
         op_name = op_name[:operations.MAX_OP_LEN - len(operations.ELLIPSIS)]
@@ -202,9 +202,18 @@
                     (u'Yadda', {}), (u'Yodda', {})]
         self.sd.on_node_ops_changed_callback(sd_items)
 
-        self.sd.on_node_ops_changed_callback([])
+        self.sd.on_node_ops_changed_callback([], clear=True)
         self.assertEqual(len(self.ui.ops_store), 0)
 
+    def test_model_is_not_cleared_before_updating(self):
+        """The model is not cleared before upadting with a new set of data."""
+        sd_items = [(operations.queue_content.ROOT_HOME, {}),
+                    (u'Yadda', {}), (u'Yodda', {})]
+        self.sd.on_node_ops_changed_callback(sd_items)
+
+        self.sd.on_node_ops_changed_callback([])
+        self.assertEqual(len(self.ui.ops_store), 3)
+
     def test_load(self):
         """Calling load will query the backend."""
         expected = object()
@@ -217,7 +226,7 @@
 
     def test_clear_button_clicked(self):
         """When the clear button was clicked, the store is cleared."""
-        self.patch(self.ui, 'load', self._set_called)
+        self.patch(self.ui, 'on_node_ops_changed', self._set_called)
         sd_items = [(operations.queue_content.ROOT_HOME, {}),
                     (u'Yadda', {}), (u'Yodda', {})]
         self.sd.on_node_ops_changed_callback(sd_items)
@@ -225,7 +234,7 @@
         self.ui.clear_button.clicked()
 
         self.assertEqual(len(self.ui.sd.queue_content), 0)
-        self.assertEqual(self._called, ((), {}))
+        self.assertEqual(self._called, (([],), {'clear': True}))
 
     def test_on_transfers_bad_data(self):
         """Something informed that's not there."""

=== modified file 'magicicada/queue_content.py'
--- magicicada/queue_content.py	2012-09-05 16:09:39 +0000
+++ magicicada/queue_content.py	2013-11-27 18:36:06 +0000
@@ -27,7 +27,7 @@
 KIND_UNKNOWN, KIND_FILE, KIND_DIR = "Unknown File Dir".split()
 
 # type of roots (so far, only home)
-ROOT_HOME = "Root"
+ROOT_HOME = ""  # this string will appear next to the home icon in the GUI
 
 # action that happened with the operation
 ACTION_ADDED, ACTION_REMOVED = "Added Removed".split()

=== modified file 'magicicada/syncdaemon.py'
--- magicicada/syncdaemon.py	2012-09-19 23:28:39 +0000
+++ magicicada/syncdaemon.py	2013-11-27 18:36:06 +0000
@@ -40,17 +40,17 @@
 TRANSFER_POLL_INTERVAL = 5
 
 # status of the node
-CHANGED_LOCAL = u"uploading"
-CHANGED_NONE = u"synchronized"
-CHANGED_SERVER = u"downloading"
+CHANGED_LOCAL = u"UPLOADING"
+CHANGED_NONE = u"SYNCHRONIZED"
+CHANGED_SERVER = u"DOWNLOADING"
 
 # state of SD
-STATE_CONNECTING = u"connecting"
-STATE_DISCONNECTED = u"disconnected"
-STATE_IDLE = u"idle"
-STATE_STARTING = u"starting"
-STATE_STOPPED = u"stopped"
-STATE_WORKING = u"working"
+STATE_CONNECTING = u"CONNECTING"
+STATE_DISCONNECTED = u"DISCONNECTED"
+STATE_IDLE = u"IDLE"
+STATE_STARTING = u"STARTING"
+STATE_STOPPED = u"STOPPED"
+STATE_WORKING = u"WORKING"
 
 
 def mandatory_callback(function_name):
@@ -66,8 +66,10 @@
 class State(object):
     """Hold the state of SD."""
 
-    _attrs = ['name', 'description', 'is_error', 'is_connected',
-              'is_online', 'queues', 'connection', 'is_started', 'state']
+    _attrs = {'name', 'description', 'is_error', 'is_connected',
+              'is_online', 'queues', 'connection', 'is_started', 'state'}
+    _toshow = ['name', 'is_error', 'is_connected',
+               'is_online', 'queues', 'connection', 'is_started', 'state']
 
     def __init__(self):
         # starting defaults
@@ -100,7 +102,8 @@
         result = []
         for attr in self._attrs:
             result.append("%s=%s" % (attr, getattr(self, attr)))
-        return "<%s>" % ", ".join(result)
+        return "<State %s>" % ", ".join(result)
+    __repr__ = __str__
 
 
 class Poller(object):

=== modified file 'magicicada/tests/test_syncdaemon.py'
--- magicicada/tests/test_syncdaemon.py	2012-09-19 23:28:39 +0000
+++ magicicada/tests/test_syncdaemon.py	2013-11-27 18:36:06 +0000
@@ -605,7 +605,7 @@
             "is_online=False",
             "queues='IDLE'",
             "connection='connection'",
-            "state=u'idle'",
+            "state=u'IDLE'",
         )
         self.assertTrue(self.hdlr.check_debug(*should))
 

=== removed file 'pylintrc'
--- pylintrc	2011-06-19 15:08:44 +0000
+++ pylintrc	1970-01-01 00:00:00 +0000
@@ -1,306 +0,0 @@
-# lint Python modules using external checkers.
-#
-# This is the main checker controlling the other ones and the reports
-# generation. It is itself both a raw checker and an astng checker in order
-# to:
-# * handle message activation / deactivation at the module level
-# * handle some basic but necessary stats'data (number of classes, methods...)
-#
-[MASTER]
-
-# Specify a configuration file.
-#rcfile=
-
-# Python code to execute, usually for sys.path manipulation such as
-# pygtk.require().
-#init-hook=
-
-# Profiled execution.
-profile=no
-
-# Add <file or directory> to the black list. It should be a base name, not a
-# path. You may set this option multiple times.
-#ignore=<somedir>
-
-# Pickle collected data for later comparisons.
-persistent=no
-
-# List of plugins (as comma separated values of python modules names) to load,
-# usually to register additional checkers.
-load-plugins=
-
-
-[MESSAGES CONTROL]
-
-# Enable only checker(s) with the given id(s). This option conflicts with the
-# disable-checker option
-#enable-checker=
-
-# Enable all checker(s) except those with the given id(s). This option
-# conflicts with the enable-checker option
-#disable-checker=
-
-# Enable the message(s) with the given id(s).
-#enable=
-
-# Disable the message(s) with the given id(s).
-# W0142: Used * or ** magic
-# W0613: Unused argument 'yyy'
-# E1103: Generator 'accept_share' has no 'addCallbacks' member (but some 
-#        types could not be inferred). Disabled because it always complains
-#        when using the deferred returned by an inlineCallbacks
-# E1101: Disable 'member' control, it always complains about reactor.callLater
-disable=R,I,W0142,W0613,E1103,E1101
-
-
-[REPORTS]
-
-# Set the output format. Available formats are text, parseable, colorized, msvs
-# (visual studio) and html
-output-format=colorized
-
-# Include message's id in output
-include-ids=yes
-
-# Put messages in a separate file for each module / package specified on the
-# command line instead of printing them on stdout. Reports (if any) will be
-# written in a file name "pylint_global.[txt|html]".
-files-output=no
-
-# Tells whether to display a full report or only the messages
-reports=no
-
-# Python expression which should return a note less than 10 (10 is the highest
-# note). You have access to the variables errors warning, statement which
-# respectively contain the number of errors / warnings messages and the total
-# number of statements analyzed. This is used by the global evaluation report
-# (R0004).
-evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
-
-# Add a comment according to your evaluation note. This is used by the global
-# evaluation report (R0004).
-comment=no
-
-# Enable the report(s) with the given id(s).
-#enable-report=
-
-# Disable the report(s) with the given id(s).
-#disable-report=
-
-
-# try to find bugs in the code using type inference
-#
-[TYPECHECK]
-
-# Tells whether missing members accessed in mixin class should be ignored. A
-# mixin class is detected if its name ends with "mixin" (case insensitive).
-ignore-mixin-members=yes
-
-# List of classes names for which member attributes should not be checked
-# (useful for classes with attributes dynamically set).
-ignored-classes=
-
-# When zope mode is activated, add a predefined set of Zope acquired attributes
-# to generated-members.
-zope=no
-
-# List of members which are set dynamically and missed by pylint inference
-# system, and so shouldn't trigger E0201 when accessed.
-generated-members=REQUEST,acl_users,aq_parent
-
-
-# checks for
-# * unused variables / imports
-# * undefined variables
-# * redefinition of variable from builtins or from an outer scope
-# * use of variable before assignment
-#
-[VARIABLES]
-
-# Tells whether we should check for unused import in __init__ files.
-init-import=yes
-
-# A regular expression matching names used for dummy variables (i.e. not used).
-dummy-variables-rgx=_|dummy
-
-# List of additional names supposed to be defined in builtins. Remember that
-# you should avoid to define new builtins when possible.
-additional-builtins=
-
-
-# checks for :
-# * doc strings
-# * modules / classes / functions / methods / arguments / variables name
-# * number of arguments, local variables, branches, returns and statements in
-# functions, methods
-# * required module attributes
-# * dangerous default values as arguments
-# * redefinition of function / method / class
-# * uses of the global statement
-#
-[BASIC]
-
-# Required attributes for module, separated by a comma
-required-attributes=
-
-# Regular expression which should only match functions or classes name which do
-# not require a docstring
-no-docstring-rgx=(__.*__|setUp|tearDown)
-
-# Regular expression which should only match correct module names
-module-rgx=([a-z_][a-z0-9_]*)$
-
-# Regular expression which should only match correct module level names
-const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$
-
-# Regular expression which should only match correct class names
-class-rgx=[A-Z_][a-zA-Z0-9]+$
-
-# Regular expression which should only match correct function names
-function-rgx=[a-z_][a-z0-9_]{2,79}$
-
-# Regular expression which should only match correct method names
-method-rgx=([a-z_][a-z0-9_]{2,79}$|setUp|tearDown)
-
-# Regular expression which should only match correct instance attribute names
-attr-rgx=[a-z_][a-z0-9_]{1,50}$
-
-# Regular expression which should only match correct argument names
-argument-rgx=[a-z_][a-z0-9_]{1,30}$
-
-# Regular expression which should only match correct variable names
-variable-rgx=[a-z_][a-z0-9_]{0,30}$
-
-# Regular expression which should only match correct list comprehension /
-# generator expression variable names
-inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
-
-# Good variable names which should always be accepted, separated by a comma
-good-names=f,logger,_
-
-# Bad variable names which should always be refused, separated by a comma
-bad-names=foo,bar,baz,toto,tutu,tata
-
-# List of builtins function names that should not be used, separated by a comma
-bad-functions=apply,input
-
-
-# checks for sign of poor/misdesign:
-# * number of methods, attributes, local variables...
-# * size, complexity of functions, methods
-#
-[DESIGN]
-
-# Maximum number of arguments for function / method
-max-args=5
-
-# Maximum number of locals for function / method body
-max-locals=15
-
-# Maximum number of return / yield for function / method body
-max-returns=6
-
-# Maximum number of branch for function / method body
-max-branchs=12
-
-# Maximum number of statements in function / method body
-max-statements=50
-
-# Maximum number of parents for a class (see R0901).
-max-parents=7
-
-# Maximum number of attributes for a class (see R0902).
-max-attributes=7
-
-# Minimum number of public methods for a class (see R0903).
-min-public-methods=2
-
-# Maximum number of public methods for a class (see R0904).
-max-public-methods=20
-
-
-# checks for :
-# * methods without self as first argument
-# * overridden methods signature
-# * access only to existent members via self
-# * attributes not defined in the __init__ method
-# * supported interfaces implementation
-# * unreachable code
-#
-[CLASSES]
-
-# List of interface methods to ignore, separated by a comma. This is used for
-# instance to not check methods defines in Zopes Interface base class.
-#ignore-iface-methods=isImplementedBy,deferred,extends,names,namesAndDescriptions,queryDescriptionFor,getBases,getDescriptionFor,getDoc,getName,getTaggedValue,getTaggedValueTags,isEqualOrExtendedBy,setTaggedValue,isImplementedByInstancesOf,adaptWith,is_implemented_by,providedBy
-
-# List of method names used to declare (i.e. assign) instance attributes.
-defining-attr-methods=__init__,__new__,setUp
-
-
-# checks for
-# * external modules dependencies
-# * relative / wildcard imports
-# * cyclic imports
-# * uses of deprecated modules
-#
-[IMPORTS]
-
-# Deprecated modules which should not be used, separated by a comma
-deprecated-modules=regsub,string,TERMIOS,Bastion,rexec
-
-# Create a graph of every (i.e. internal and external) dependencies in the
-# given file (report RP0402 must not be disabled)
-import-graph=
-
-# Create a graph of external dependencies in the given file (report RP0402 must
-# not be disabled)
-ext-import-graph=
-
-# Create a graph of internal dependencies in the given file (report RP0402 must
-# not be disabled)
-int-import-graph=
-
-
-# checks for :
-# * unauthorized constructions
-# * strict indentation
-# * line length
-# * use of <> instead of !=
-#
-[FORMAT]
-
-# Maximum number of characters on a single line.
-max-line-length=79
-
-# Maximum number of lines in a module
-max-module-lines=2000
-
-# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
-# tab).
-indent-string='    '
-
-
-# checks for similarities and duplicated code. This computation may be
-# memory / CPU intensive, so you should disable it if you experiments some
-# problems.
-#
-[SIMILARITIES]
-
-# Minimum lines number of a similarity.
-min-similarity-lines=4
-
-# Ignore comments when computing similarities.
-ignore-comments=yes
-
-# Ignore docstrings when computing similarities.
-ignore-docstrings=yes
-
-
-# checks for:
-# * warning notes in the code like FIXME, XXX
-# * PEP 263: source code with non ascii character but no encoding declaration
-#
-[MISCELLANEOUS]
-
-# List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO,fixme,xxx,todo

=== modified file 'test'
--- test	2012-09-06 19:36:44 +0000
+++ test	2013-11-27 18:36:06 +0000
@@ -26,6 +26,5 @@
 
 echo "Running test suite for ""$MODULE"
 `which xvfb-run` trial -r gi "$MODULE"
-pylint magicicada
 rm -rf _trial_temp
 rm -rf _logs_temp