Merge 'improve-parameter-fixed-checkboxes' into maint

pavoljuhas · pavoljuhas · commit 289d00dfed17 · 2018-12-14T17:20:17.000-05:00
* take empty parameter-fixed value as False * improve behavior of parameter-fixed checkboxes * add tests to cover changed methods * fix spurious call to needsSave * support execution of wx GUI on travis Closes #32.
diff --git a/.travis.yml b/.travis.yml
@@ -31,6 +31,7 @@ addons:
     - python-dev
     - python-numpy
     - python-setuptools
+    - python-wxtools
 
 before_install:
   - MYNAME=diffpy.pdfgui
@@ -95,8 +96,17 @@ install:
         exit 1;
     fi
 
+before_script:
+  # provide shell functions to execute coverage with GUI support
+  - case ${TRAVIS_OS_NAME} in
+    linux)
+        guicoverage() { xvfb-run coverage "$@"; } ;;
+    osx)
+        guicoverage() { pythonw -m coverage "$@"; } ;;
+    esac
+
 script:
-  - coverage run --source ${MYNAME} -m ${MYNAME}.tests.rundeps
+  - guicoverage run --source ${MYNAME} -m ${MYNAME}.tests.rundeps
 
 after_success:
   - pip install $MYPIPFLAGS codecov
diff --git a/src/diffpy/pdfgui/gui/parameterspanel.py b/src/diffpy/pdfgui/gui/parameterspanel.py
@@ -141,29 +141,26 @@ def refresh(self):
         self.grid_parameters.AutoSizeColumns()
         self.grid_parameters.EndBatch()
 
-    # FIXME
-    # When selecting a block, this should be bypassed.
-    #
-    # I've tried really hard. I can't get it to work right.
-    #
-    # The problem: A left-click also generates a range-select event.  When an
-    # actual range is selected, it generates two selection events, one at the
-    # start and one at the end of the selection.  However, the one at the start
-    # of the selection does not highlight a cell, and therefore gives no
-    # coordinates.
+
     def onCellLeftClick(self, event): # wxGlade: ParametersPanel.<event_handler>
-        """Toggle a fix/free cell when it is selected."""
-        # Toggle the check box if it is selected
+        """Toggle a fix/free cell when clicked."""
         r = event.GetRow()
         c = event.GetCol()
-        if c == 1:
-            self.grid_parameters.SelectBlock(r,c,r,c)
-            self.onPopupFixFree(event)
-            # Don't actually select the cell until we're sure its not part of a
-            # block. This is handled by onGridRangeSelect.
-        event.Skip()
+        # Only proceed if there is no selection and
+        # this click has no keyboard modifiers.
+        ignorethis = (c != 1 or self.grid_parameters.IsSelection() or
+                      event.ShiftDown() or event.ControlDown())
+        if ignorethis:
+            # do standard click event handling
+            event.Skip()
+            return
+        # We consume the event here.  This prevents focusing the clicked
+        # cell after a click, but that is not necessary for a checkbox.
+        state = int(self.grid_parameters.GetCellValue(r, c) or 0)
+        self.applyCellChange(r, c, not state)
         return
 
+
     def onGridRangeSelect(self, event): # wxGlade: ParametersPanel.<event_handler>
         """Handle range selections.
 
@@ -256,19 +253,16 @@ def applyCellChange(self, row, col, value):
                 self.mainFrame.needsSave()
 
         elif col == 1:  # flag "fixed"
-            try:
-                temp = self.parameters[key].fixed
-                value = bool(int(value))
-                if temp != value:
-                    self.parameters[key].fixed = value
-                    self.grid_parameters.SetCellValue(row,1,str(int(value)))
-                    self.mainFrame.needsSave()
-            except ValueError:
-                pass
+            temp = bool(self.parameters[key].fixed)
+            value = bool(int(value))
+            if temp is not value:
+                self.parameters[key].fixed = value
+                self.grid_parameters.SetCellValue(row,1,str(int(value)))
+                self.mainFrame.needsSave()
 
-        self.mainFrame.needsSave()
         return
 
+
     def popupMenu(self, window, x, y):
         """Opens a popup menu
 
@@ -337,11 +331,8 @@ def onPopupFixFree(self, event):
             indices = self.getSelectedParameters()
             for row in indices:
                 state = self.grid_parameters.GetCellValue(row,1)
-                # This might be triggered when we enter into edit mode, but the
-                # grid cell will have a '' value. Check for that and ignore it.
-                if state:
-                    state = bool(int(state))
-                    seldict[row] = state
+                state = bool(int(state.strip() or "0"))
+                seldict[row] = state
 
             # Find the majority state
             nfixed = seldict.values().count(True)
diff --git a/src/diffpy/pdfgui/tests/TestParametersPanel.py b/src/diffpy/pdfgui/tests/TestParametersPanel.py
@@ -0,0 +1,139 @@
+#!/usr/bin/env python
+##############################################################################
+#
+# diffpy.pdfgui     Complex Modeling Initiative
+#                   (c) 2018 Brookhaven Science Associates,
+#                   Brookhaven National Laboratory.
+#                   All rights reserved.
+#
+# File coded by:    Pavol Juhas
+#
+# See AUTHORS.txt for a list of people who contributed.
+# See LICENSE.txt for license information.
+#
+##############################################################################
+
+"""
+Unit tests for ParametersPanel class
+"""
+
+import unittest
+
+import wx.grid
+
+from diffpy.pdfgui.gui.parameterspanel import ParametersPanel
+from diffpy.pdfgui.control.parameter import Parameter
+from diffpy.pdfgui.gui.pdfguiglobals import dbopts
+
+# ----------------------------------------------------------------------------
+
+class TestParametersPanel(unittest.TestCase):
+
+    def setUp(self):
+        self._save_noerrordialog = dbopts.noerrordialog
+        dbopts.noerrordialog = True
+        self.app = wx.App()
+        self.frame = wx.Frame(None)
+        self.panel = ParametersPanel(self.frame, -1)
+        self.panel.parameters.update([
+            (1, Parameter(1, 0.1)),
+            (5, Parameter(5, 0.5)),
+        ])
+        self.panel.refresh()
+        self.panel.mainFrame = _TMainFrame()
+        self.frame.window = self.panel
+        return
+
+    def tearDown(self):
+        self.frame.Close()
+        dbopts.noerrordialog = self._save_noerrordialog
+        return
+
+
+    def _leftclickcell(self, row, col, **kw):
+        gp = self.panel.grid_parameters
+        eventtype = wx.grid.EVT_GRID_CELL_LEFT_CLICK.typeId
+        e = wx.grid.GridEvent(gp.Id, eventtype, gp, row, col, **kw)
+        gp.ProcessEvent(e)
+        return
+
+
+    def test_onPopupFixFree(self):
+        "Check ParametersPanel.onPopupFixFree"
+        # event is not used, we just generate and reuse dummy event.
+        e = wx.PyCommandEvent(wx.EVT_MENU.typeId, wx.ID_ANY)
+        panel = self.panel
+        gp = self.panel.grid_parameters
+        plist = list(self.panel.parameters.values())
+        gp.SetCellValue(0, 1, "")
+        self.assertTrue(all(not p.fixed for p in plist))
+        gp.SelectAll()
+        panel.onPopupFixFree(e)
+        self.assertTrue(all(p.fixed for p in plist))
+        self.assertEqual("1", gp.GetCellValue(0, 1))
+        panel.onPopupFixFree(e)
+        self.assertTrue(all(not p.fixed for p in plist))
+        gp.DeselectRow(0)
+        panel.onPopupFixFree(e)
+        self.assertFalse(plist[0].fixed)
+        self.assertTrue(plist[1].fixed)
+        return
+
+
+    def test_applyCellChange(self):
+        "Check ParametersPanel.applyCellChange"
+        gp = self.panel.grid_parameters
+        mf = self.panel.mainFrame
+        panel = self.panel
+        self.assertFalse(mf.altered)
+        panel.applyCellChange(0, 0, 0.1)
+        self.assertFalse(mf.altered)
+        panel.applyCellChange(0, 0, 1.5)
+        self.assertTrue(mf.altered)
+        self.assertEqual("1.5", gp.GetCellValue(0, 0))
+        self.assertEqual(1.5, panel.parameters[1].initialValue())
+        return
+
+
+    def test_onCellLeftClick(self):
+        "Check click handling on the Parameters grid."
+        gp = self.panel.grid_parameters
+        p = self.panel.parameters[1]
+        self.assertFalse(self.panel.mainFrame.altered)
+        self.assertEqual("0", gp.GetCellValue(0, 1))
+        self.assertFalse(p.fixed)
+        self._leftclickcell(0, 1)
+        self.assertEqual("1", gp.GetCellValue(0, 1))
+        self.assertTrue(p.fixed)
+        self.assertTrue(self.panel.mainFrame.altered)
+        self._leftclickcell(0, 1)
+        self.assertEqual("0", gp.GetCellValue(0, 1))
+        self._leftclickcell(0, 1, control=True)
+        self.assertEqual("0", gp.GetCellValue(0, 1))
+        self._leftclickcell(0, 1, shift=True)
+        self.assertEqual("0", gp.GetCellValue(0, 1))
+        gp.SelectAll()
+        self._leftclickcell(0, 1)
+        self.assertEqual("0", gp.GetCellValue(0, 1))
+        gp.ClearSelection()
+        self._leftclickcell(0, 1)
+        self.assertEqual("1", gp.GetCellValue(0, 1))
+        return
+
+# End of class TestParametersPanel
+
+# Local Helpers --------------------------------------------------------------
+
+class _TMainFrame(object):
+    "Think mockup of the used MainFrame methods."
+
+    altered = False
+
+    def needsSave(self):
+        self.altered = True
+        return
+
+# ----------------------------------------------------------------------------
+
+if __name__ == '__main__':
+    unittest.main()
