[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-edu-devel
Subject:    Re: Review Request 120126: Refactor Parley as preparation for future work
From:       "Inge Wallin" <inge () lysator ! liu ! se>
Date:       2014-09-12 21:31:02
Message-ID: 20140912213102.8756.26040 () probe ! kde ! org
[Download RAW message or body]

--===============0354704184299318872==
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit


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

(Updated Sept. 12, 2014, 9:30 p.m.)


Status
------

This change has been marked as submitted.


Review request for KDE Edu, Amarvir Singh 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


--===============0354704184299318872==
MIME-Version: 1.0
Content-Type: text/html; charset="utf-8"
Content-Transfer-Encoding: 7bit




<html>
 <body>
  <div style="font-family: Verdana, Arial, Helvetica, Sans-Serif;">
   <table bgcolor="#f9f3c9" width="100%" cellpadding="12" style="border: 1px #c9c399 \
solid; border-radius: 6px; -moz-border-radius: 6px; -webkit-border-radius: 6px;">  \
<tr>  <td>
      This is an automatically generated e-mail. To reply, visit:
      <a href="https://git.reviewboard.kde.org/r/120126/">https://git.reviewboard.kde.org/r/120126/</a>
  </td>
    </tr>
   </table>
   <br />




<table bgcolor="#e0e0e0" width="100%" cellpadding="12" style="border: 1px gray solid; \
border-radius: 6px; -moz-border-radius: 6px; -webkit-border-radius: 6px;">  <tr>
  <td>
   <h1 style="margin: 0; padding: 0; font-size: 10pt;">This change has been marked as \
submitted.</h1>  </td>
 </tr>
</table>
<br />


<table bgcolor="#fefadf" width="100%" cellspacing="0" cellpadding="12" style="border: \
1px #888a85 solid; border-radius: 6px; -moz-border-radius: 6px; \
-webkit-border-radius: 6px;">  <tr>
  <td>

<div>Review request for KDE Edu, Amarvir Singh and Andreas Xavier.</div>
<div>By Inge Wallin.</div>


<p style="color: grey;"><i>Updated Sept. 12, 2014, 9:30 p.m.</i></p>









<div style="margin-top: 1.5em;">
 <b style="color: #575012; font-size: 10pt;">Repository: </b>
parley
</div>


<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Description </h1>
 <table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" \
style="border: 1px solid #b8b5a0">  <tr>
  <td>
   <pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">This patch moves a number of files and renames a few \
of them. The reason for the refactoring is:<br style="padding: 0;text-rendering: \
                inherit;margin: 0;line-height: inherit;white-space: normal;" />
 - We want to separate the data from the views<br style="padding: 0;text-rendering: \
                inherit;margin: 0;line-height: inherit;white-space: normal;" />
 - 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.</p> <p \
style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: \
inherit;">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.</p> <p style="padding: 0;text-rendering: inherit;margin: \
0;line-height: inherit;white-space: inherit;">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.</p> <p style="padding: \
0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: inherit;">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.</p> <p style="padding: 0;text-rendering: \
inherit;margin: 0;line-height: inherit;white-space: inherit;">There are a few small \
name changes to make things clearer but no actual code changes.</p> <p \
style="padding: 0;text-rendering: inherit;margin: 0;line-height: inherit;white-space: \
inherit;">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.</p></pre>  </td>
 </tr>
</table>


<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Testing </h1>
<table width="100%" bgcolor="#ffffff" cellspacing="0" cellpadding="10" style="border: \
1px solid #b8b5a0">  <tr>
  <td>
   <pre style="margin: 0; padding: 0; white-space: pre-wrap; white-space: \
-moz-pre-wrap; white-space: -pre-wrap; white-space: -o-pre-wrap; word-wrap: \
break-word;"><p style="padding: 0;text-rendering: inherit;margin: 0;line-height: \
inherit;white-space: inherit;">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.</p></pre>  </td>
 </tr>
</table>


<h1 style="color: #575012; font-size: 10pt; margin-top: 1.5em;">Diffs</b> </h1>
<ul style="margin-left: 3em; padding-left: 0;">

 <li>src/vocabulary/vocabularydelegate.h <span style="color: \
grey">(cc4967c)</span></li>

 <li>src/vocabulary/vocabularydelegate.cpp <span style="color: \
grey">(2544dc1)</span></li>

 <li>src/vocabulary/vocabularymimedata.h <span style="color: \
grey">(99b367c)</span></li>

 <li>src/vocabulary/vocabularymimedata.cpp <span style="color: \
grey">(d071b1f)</span></li>

 <li>src/vocabulary/vocabularymodel.h <span style="color: grey">(73be813)</span></li>

 <li>src/vocabulary/vocabularymodel.cpp <span style="color: \
grey">(6867b82)</span></li>

 <li>src/vocabulary/wordtypemodel.h <span style="color: grey">(0c26f64)</span></li>

 <li>src/vocabulary/wordtypemodel.cpp <span style="color: grey">(c35d141)</span></li>

 <li>src/welcomescreen/barwidget.h <span style="color: grey">(bcefa6f)</span></li>

 <li>src/welcomescreen/barwidget.cpp <span style="color: grey">(593cd71)</span></li>

 <li>src/welcomescreen/buttondelegate.h <span style="color: \
grey">(4e3b123)</span></li>

 <li>src/welcomescreen/buttondelegate.cpp <span style="color: \
grey">(c7e72c7)</span></li>

 <li>src/welcomescreen/collectionwidget.h <span style="color: \
grey">(814ece6)</span></li>

 <li>src/welcomescreen/collectionwidget.cpp <span style="color: \
grey">(573e928)</span></li>

 <li>src/welcomescreen/gradereferencewidget.h <span style="color: \
grey">(5098ad3)</span></li>

 <li>src/welcomescreen/gradereferencewidget.cpp <span style="color: \
grey">(62a7002)</span></li>

 <li>src/welcomescreen/welcomescreen.h <span style="color: \
grey">(9c636f5)</span></li>

 <li>src/welcomescreen/welcomescreen.cpp <span style="color: \
grey">(793e00e)</span></li>

 <li>src/welcomescreen/welcomescreen.ui <span style="color: \
grey">(daeed06)</span></li>

 <li>src/welcomescreen/welcomescreenui.rc <span style="color: \
grey">(4268999)</span></li>

 <li>autotests/CMakeLists.txt <span style="color: grey">(3317490)</span></li>

 <li>src/CMakeLists.txt <span style="color: grey">(2c244f8)</span></li>

 <li>src/collection/containermimedata.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/containermimedata.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/containermodel.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/containermodel.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/entryfilter.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/entryfilter.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/entryfilter.ui <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/lessonmodel.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/lessonmodel.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/readonlycontainermodel.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/readonlycontainermodel.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/testentry.h <span style="color: grey">(PRE-CREATION)</span></li>

 <li>src/collection/testentry.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/vocabularymimedata.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/vocabularymimedata.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/vocabularymodel.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/vocabularymodel.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/wordclassmodel.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/collection/wordclassmodel.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/dashboard/barwidget.h <span style="color: grey">(PRE-CREATION)</span></li>

 <li>src/dashboard/barwidget.cpp <span style="color: grey">(PRE-CREATION)</span></li>

 <li>src/dashboard/buttondelegate.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/dashboard/buttondelegate.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/dashboard/collectionwidget.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/dashboard/collectionwidget.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/dashboard/dashboard.h <span style="color: grey">(PRE-CREATION)</span></li>

 <li>src/dashboard/dashboard.cpp <span style="color: grey">(PRE-CREATION)</span></li>

 <li>src/dashboard/dashboard.ui <span style="color: grey">(PRE-CREATION)</span></li>

 <li>src/dashboard/dashboardui.rc <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/dashboard/gradereferencewidget.h <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/dashboard/gradereferencewidget.cpp <span style="color: \
grey">(PRE-CREATION)</span></li>

 <li>src/editor/editor.h <span style="color: grey">(b9f9fe8)</span></li>

 <li>src/editor/editor.cpp <span style="color: grey">(93a345c)</span></li>

 <li>src/editor/latexwidget.cpp <span style="color: grey">(5e7dd76)</span></li>

 <li>src/editor/summarywordwidget.h <span style="color: grey">(c5aaaa7)</span></li>

 <li>src/editor/summarywordwidget.cpp <span style="color: grey">(43d1191)</span></li>

 <li>src/parleydocument.cpp <span style="color: grey">(c5c4bbd)</span></li>

 <li>src/parleymainwindow.h <span style="color: grey">(507b3ea)</span></li>

 <li>src/parleymainwindow.cpp <span style="color: grey">(084d031)</span></li>

 <li>src/practice/entryfilter.h <span style="color: grey">(7122ef6)</span></li>

 <li>src/practice/entryfilter.cpp <span style="color: grey">(614981f)</span></li>

 <li>src/practice/entryfilter.ui <span style="color: grey">(c5f3e4e)</span></li>

 <li>src/practice/testentry.h <span style="color: grey">(572cb26)</span></li>

 <li>src/practice/testentry.cpp <span style="color: grey">(04ba8b9)</span></li>

 <li>src/scripts/scripting/parley.cpp <span style="color: grey">(41fa815)</span></li>

 <li>src/statistics/statisticsmodel.h <span style="color: grey">(d577d13)</span></li>

 <li>src/vocabulary/basiccontainermodel.h <span style="color: \
grey">(ce07178)</span></li>

 <li>src/vocabulary/basiccontainermodel.cpp <span style="color: \
grey">(16c6f92)</span></li>

 <li>src/vocabulary/containermimedata.h <span style="color: \
grey">(6ce4bba)</span></li>

 <li>src/vocabulary/containermimedata.cpp <span style="color: \
grey">(9a81aa0)</span></li>

 <li>src/vocabulary/containermodel.h <span style="color: grey">(35e9973)</span></li>

 <li>src/vocabulary/containermodel.cpp <span style="color: \
grey">(96e16c8)</span></li>

 <li>src/vocabulary/lessonmodel.h <span style="color: grey">(8f5ffa0)</span></li>

 <li>src/vocabulary/lessonmodel.cpp <span style="color: grey">(72335c4)</span></li>

 <li>src/vocabulary/vocabularycolumnsdialog.cpp <span style="color: \
grey">(a961b7b)</span></li>

</ul>

<p><a href="https://git.reviewboard.kde.org/r/120126/diff/" style="margin-left: \
3em;">View Diff</a></p>






  </td>
 </tr>
</table>




  </div>
 </body>
</html>


--===============0354704184299318872==--



_______________________________________________
kde-edu mailing list
kde-edu@mail.kde.org
https://mail.kde.org/mailman/listinfo/kde-edu


[prev in list] [next in list] [prev in thread] [next in thread] 

Configure | About | News | Add a list | Sponsored by KoreLogic