Review Request 120126: Refactor Parley as preparation for future work

Tue Sep 9 23:17:00 UTC 2014

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/120126/
-----------------------------------------------------------

(Updated Sept. 9, 2014, 11:16 p.m.)

Review request for KDE Edu and Andreas Xavier.

Repository: parley

Description
-------

This patch moves a number of files and renames a few of them. The reason for the refactoring is:
 - We want to separate the data from the views
 - The work to make the "words due" feature work is much more complex than I first thought and this is a necessary step if we don't want to lose the structure.

This patch only moves things around and I want to get it out of the way before I do any real code changes. Otherwise it might be very difficult to find the actual changes in the huge diff that will result from a combined move-around and actual code changes.

This patch creates a new subdirectory "src/collection/". It will contain the actual data inside parley, i.e. the part of the current ParleyDocument class that is not involved with user interaction. It will also contain a class called Collection (as yet unwritten) which will wrap a KEduVocDocument and provide a number of convenience functions that are relevant to Parley. These will be things like list of training items, etc.

In addition I have moved the QItemModels from src/vocabulary/ which contained a number of models and views. The views will most likely move to the editor in the future since they are only used there.

There are a few small name changes to make things clearer but no actual code changes.

NOTE: This patch is done for the KDE/4.14 branch and will be merged into master after it is applied to KDE/4.14. The reason for this is to minimize the difference between KDE/4.14 and master so that future bugfixes will be possible to forward merge with as few problems as possible.

Diffs
-----

  src/vocabulary/vocabularydelegate.h cc4967c 
  src/vocabulary/vocabularydelegate.cpp 2544dc1 
  src/vocabulary/vocabularymimedata.h 99b367c 
  src/vocabulary/vocabularymimedata.cpp d071b1f 
  src/vocabulary/vocabularymodel.h 73be813 
  src/vocabulary/vocabularymodel.cpp 6867b82 
  src/vocabulary/wordtypemodel.h 0c26f64 
  src/vocabulary/wordtypemodel.cpp c35d141 
  src/welcomescreen/barwidget.h bcefa6f 
  src/welcomescreen/barwidget.cpp 593cd71 
  src/welcomescreen/buttondelegate.h 4e3b123 
  src/welcomescreen/buttondelegate.cpp c7e72c7 
  src/welcomescreen/collectionwidget.h 814ece6 
  src/welcomescreen/collectionwidget.cpp 573e928 
  src/welcomescreen/gradereferencewidget.h 5098ad3 
  src/welcomescreen/gradereferencewidget.cpp 62a7002 
  src/welcomescreen/welcomescreen.h 9c636f5 
  src/welcomescreen/welcomescreen.cpp 793e00e 
  src/welcomescreen/welcomescreen.ui daeed06 
  src/welcomescreen/welcomescreenui.rc 4268999 
  autotests/CMakeLists.txt 3317490 
  src/CMakeLists.txt 2c244f8 
  src/collection/containermimedata.h PRE-CREATION 
  src/collection/containermimedata.cpp PRE-CREATION 
  src/collection/containermodel.h PRE-CREATION 
  src/collection/containermodel.cpp PRE-CREATION 
  src/collection/entryfilter.h PRE-CREATION 
  src/collection/entryfilter.cpp PRE-CREATION 
  src/collection/entryfilter.ui PRE-CREATION 
  src/collection/lessonmodel.h PRE-CREATION 
  src/collection/lessonmodel.cpp PRE-CREATION 
  src/collection/readonlycontainermodel.h PRE-CREATION 
  src/collection/readonlycontainermodel.cpp PRE-CREATION 
  src/collection/testentry.h PRE-CREATION 
  src/collection/testentry.cpp PRE-CREATION 
  src/collection/vocabularymimedata.h PRE-CREATION 
  src/collection/vocabularymimedata.cpp PRE-CREATION 
  src/collection/vocabularymodel.h PRE-CREATION 
  src/collection/vocabularymodel.cpp PRE-CREATION 
  src/collection/wordclassmodel.h PRE-CREATION 
  src/collection/wordclassmodel.cpp PRE-CREATION 
  src/dashboard/barwidget.h PRE-CREATION 
  src/dashboard/barwidget.cpp PRE-CREATION 
  src/dashboard/buttondelegate.h PRE-CREATION 
  src/dashboard/buttondelegate.cpp PRE-CREATION 
  src/dashboard/collectionwidget.h PRE-CREATION 
  src/dashboard/collectionwidget.cpp PRE-CREATION 
  src/dashboard/dashboard.h PRE-CREATION 
  src/dashboard/dashboard.cpp PRE-CREATION 
  src/dashboard/dashboard.ui PRE-CREATION 
  src/dashboard/dashboardui.rc PRE-CREATION 
  src/dashboard/gradereferencewidget.h PRE-CREATION 
  src/dashboard/gradereferencewidget.cpp PRE-CREATION 
  src/editor/editor.h b9f9fe8 
  src/editor/editor.cpp 93a345c 
  src/editor/latexwidget.cpp 5e7dd76 
  src/editor/summarywordwidget.h c5aaaa7 
  src/editor/summarywordwidget.cpp 43d1191 
  src/parleydocument.cpp c5c4bbd 
  src/parleymainwindow.h 507b3ea 
  src/parleymainwindow.cpp 084d031 
  src/practice/entryfilter.h 7122ef6 
  src/practice/entryfilter.cpp 614981f 
  src/practice/entryfilter.ui c5f3e4e 
  src/practice/testentry.h 572cb26 
  src/practice/testentry.cpp 04ba8b9 
  src/scripts/scripting/parley.cpp 41fa815 
  src/statistics/statisticsmodel.h d577d13 
  src/vocabulary/basiccontainermodel.h ce07178 
  src/vocabulary/basiccontainermodel.cpp 16c6f92 
  src/vocabulary/containermimedata.h 6ce4bba 
  src/vocabulary/containermimedata.cpp 9a81aa0 
  src/vocabulary/containermodel.h 35e9973 
  src/vocabulary/containermodel.cpp 96e16c8 
  src/vocabulary/lessonmodel.h 8f5ffa0 
  src/vocabulary/lessonmodel.cpp 72335c4 
  src/vocabulary/vocabularycolumnsdialog.cpp a961b7b 

Diff: https://git.reviewboard.kde.org/r/120126/diff/

Testing
-------

Tested after each individual move that it builds and that there was no behavioural change.  This patch only moves things around, and in a few cases renames. Nothing else.

Thanks,

Inge Wallin

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-edu/attachments/20140909/07faa8ae/attachment.html>