Review Request: Porting MessageFilters

David Edmundson kde at davidedmundson.co.uk
Tue May 1 14:39:35 UTC 2012


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://git.reviewboard.kde.org/r/104803/#review13201
-----------------------------------------------------------


I'm very impressed! Especially with documentation and testing, this isn't the Lasath I know! 

Few comments, though generally I'm happy with it.
However, do _NOT_ merge this into master until 0.4 is branched. I will talk to mck182 about this.

(so a suspended ship-it! from me)


filters/emoticons/emoticon-filter.h
<http://git.reviewboard.kde.org/r/104803/#comment10317>

    You don't /need/ to use d-pointers in the filters.
    
    If you prefer to use them, go ahead - but you don't need to maintain binary compatibility as it's not a library people will link against.



filters/emoticons/ktptextui_message_filter_emoticons.desktop
<http://git.reviewboard.kde.org/r/104803/#comment10318>

    Should plugins be versioned with KTp or separately?
    
    I.e do we start at 0.1?.. I'm not sure. I can't decide either way. Talk to either George K or Dario. (just message the ML)



filters/emoticons/ktptextui_message_filter_emoticons.desktop
<http://git.reviewboard.kde.org/r/104803/#comment10319>

    That's not a valid link.
    



lib/ktptxtui_message_filter.desktop
<http://git.reviewboard.kde.org/r/104803/#comment10327>

    What is this file for?
    



lib/message-processor.cpp
<http://git.reviewboard.kde.org/r/104803/#comment10322>

    This is just in any random order.
    
    Needs fixing long term. If you write code you know needs fixing add a "//FIXME" or "//TODO" so it's not forgotten.



lib/message.h
<http://git.reviewboard.kde.org/r/104803/#comment10321>

    Don't say it's thread safe unless it actually is.
    
    Which I'm not sure this is.



lib/message.h
<http://git.reviewboard.kde.org/r/104803/#comment10320>

    I assume "to block?"



tests/message-processor-basic-tests.h
<http://git.reviewboard.kde.org/r/104803/#comment10323>

    try and call member variables m_something.
    
    
    it will be make it clearer.
    
    also don't write "this->" everywhere.


- David Edmundson


On May 1, 2012, 8:43 a.m., Lasath Fernando wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://git.reviewboard.kde.org/r/104803/
> -----------------------------------------------------------
> 
> (Updated May 1, 2012, 8:43 a.m.)
> 
> 
> Review request for Telepathy and David Edmundson.
> 
> 
> Description
> -------
> 
> I'm starting do make some headway on my project (despite being swamped by Uni work at the moment), so I thought I may as well review what I've done so far.
> 
> Firstly, I gave MessageProcessor a KPluginLoader. I then cleaned it up, removed unneeded #includes, gave AbstractMessageFilter a camel case header etc.
> 
> Before I started porting the three existing filters to be KPlugins, I decided I should write unit tests for them. I'm not really sure on what the conventions are for tests because, well I haven't seen any on this project. So I made a few QTests and stuck them in a directory called tests.
> 
> I've ported EscapeFilter and EmoticonFilter. I just wrote tests for UrlFilter, but haven't got to port it yet. 
> 
> I also started documenting my work, in the hope that it'll make things easier to maintain. Currently, the Message class is more or less documented. 
> If at all possible, I'd like someone who isn't familiar with how these work internally to read it and tell me if that documentation is clear.
> 
> 
> Diffs
> -----
> 
>   CMakeLists.txt e5dc102 
>   filters/CMakeLists.txt PRE-CREATION 
>   filters/emoticons/CMakeLists.txt PRE-CREATION 
>   filters/emoticons/emoticon-filter.h PRE-CREATION 
>   filters/emoticons/emoticon-filter.cpp PRE-CREATION 
>   filters/emoticons/ktptextui_message_filter_emoticons.desktop PRE-CREATION 
>   filters/escape/CMakeLists.txt PRE-CREATION 
>   filters/escape/escape-filter.h PRE-CREATION 
>   filters/escape/escape-filter.cpp PRE-CREATION 
>   filters/escape/ktptextui_message_filter_escape.desktop PRE-CREATION 
>   lib/CMakeLists.txt e94a432 
>   lib/KTp/AbstractMessageFilter PRE-CREATION 
>   lib/abstract-message-filter.h PRE-CREATION 
>   lib/abstract-message-filter.cpp PRE-CREATION 
>   lib/emoticon-filter.cpp 0e37aab 
>   lib/escape-filter.cpp c366410 
>   lib/filters.h 6059ea2 
>   lib/ktptxtui_message_filter.desktop PRE-CREATION 
>   lib/message-processor.h d6228b5 
>   lib/message-processor.cpp a9b409e 
>   lib/message.h c9d4340 
>   lib/message.cpp ae947d2 
>   tests/CMakeLists.txt PRE-CREATION 
>   tests/message-processor-basic-tests.h PRE-CREATION 
>   tests/message-processor-basic-tests.cpp PRE-CREATION 
>   tests/sync-processor.h PRE-CREATION 
>   tests/sync-processor.cpp PRE-CREATION 
> 
> Diff: http://git.reviewboard.kde.org/r/104803/diff/
> 
> 
> Testing
> -------
> 
> THERE ARE UNIT TESTS!! :D
> 
> 
> Thanks,
> 
> Lasath Fernando
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-telepathy/attachments/20120501/d09b4afb/attachment-0001.html>


More information about the KDE-Telepathy mailing list