Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/specs/CategoryEditor.py
blob: 30e47a55c18d51c5524d02e650709b0d26ffa138 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# Copyright (C) 2009, 2010, 2011  Rickard Lindberg, Roger Lindberg
#
# This file is part of Timeline.
#
# Timeline is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Timeline is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Timeline.  If not, see <http://www.gnu.org/licenses/>.


import unittest

from mock import Mock

from timelinelib.db.exceptions import TimelineIOError
from timelinelib.db.objects import Category
from timelinelib.editors.category import CategoryEditor
from timelinelib.repositories.interface import CategoryRepository
from timelinelib.wxgui.dialogs.categoryeditor import WxCategoryEdtiorDialog


class CategoryEditorBaseFixture(unittest.TestCase):

    def setUp(self):
        # Category configuration:
        # foo
        #   foofoo
        # bar
        self.category_repository = Mock(CategoryRepository)
        self.foo = Category("foo", (255, 0, 0), None, True, parent=None)
        self.foofoo = Category("foofoo", (255, 0, 0), (0, 255, 0), True, parent=self.foo)
        self.bar = Category("bar", (255, 0, 0), None, True, parent=None)
        self.category_repository.get_all.return_value = [self.foo, self.foofoo, self.bar]
        def get_tree_mock(remove):
            if remove is None:
                return [
                    (self.bar, []),
                    (self.foo, [
                        (self.foofoo,
                            [])
                    ])
                ]
            elif remove is self.foofoo:
                return [
                    (self.bar, []),
                    (self.foo, [])
                ]
            else:
                return []
        self.category_repository.get_tree.side_effect = get_tree_mock
        self.view = Mock(WxCategoryEdtiorDialog)

    def _initializeControllerWith(self, category):
        self.controller = CategoryEditor(self.view)
        self.controller.edit(category, self.category_repository)


class WhenEditingANewCategory(CategoryEditorBaseFixture):

    def setUp(self):
        CategoryEditorBaseFixture.setUp(self)
        self._initializeControllerWith(None)

    def test_all_categories_in_db_are_listed_as_possible_parents(self):
        self.view.set_category_tree.assert_called_with([
            (self.bar, []),
            (self.foo, [
                (self.foofoo, [])
            ])
        ])

    def test_name_is_initialized_to_empty_string(self):
        self.view.set_name.assert_called_with("")

    def test_color_is_initialized_to_red(self):
        self.view.set_color.assert_called_with((255, 0, 0))

    def test_font_color_is_initialized_to_black(self):
        self.view.set_font_color.assert_called_with((0, 0, 0))

    def test_parent_is_initialized_to_none(self):
        self.view.set_parent.assert_called_with(None)


class WhenEditingAnExistingCategory(CategoryEditorBaseFixture):

    def setUp(self):
        CategoryEditorBaseFixture.setUp(self)
        self._initializeControllerWith(self.foofoo)

    def test_all_categories_in_db_except_the_one_being_edited_are_possible_parents(self):
        self.view.set_category_tree.assert_called_with([
            (self.bar, []),
            (self.foo, [])
        ])

    def test_name_is_initialized_from_edited_category(self):
        self.view.set_name.assert_called_with("foofoo")

    def test_color_is_initialixed_from_edited_category(self):
        self.view.set_color.assert_called_with((255, 0, 0))

    def test_font_color_is_initialixed_from_edited_category(self):
        self.view.set_font_color.assert_called_with((0, 255, 0))

    def test_parent_is_initialized_from_edited_category(self):
        self.view.set_parent.assert_called_with(self.foo)


class WhenTryingToEditACategoryButDbRaisesException(CategoryEditorBaseFixture):

    def setUp(self):
        CategoryEditorBaseFixture.setUp(self)
        self.category_repository.get_tree.side_effect = TimelineIOError
        self._initializeControllerWith(None)

    def test_error_is_handled_by_view(self):
        self.assertTrue(self.view.handle_db_error.called)

    def test_the_dialog_is_not_closed(self):
        self.assertFalse(self.view.close.called)


class WhenSavingACategory(CategoryEditorBaseFixture):

    def setUp(self):
        CategoryEditorBaseFixture.setUp(self)
        self._initializeControllerWith(None)
        self.view.get_name.return_value = "new_cat"
        self.view.get_color.return_value = (255, 44, 0)
        self.view.get_font_color.return_value = (0, 44, 255)
        self.view.get_parent.return_value = self.foo
        self.controller.save()

    def _getSavedCategory(self):
        if not self.category_repository.save.called:
            self.fail("No category was saved.")
        return self.category_repository.save.call_args_list[0][0][0]

    def test_saved_category_has_name_from_view(self):
        self.assertEquals("new_cat", self._getSavedCategory().name)

    def test_saved_category_has_color_from_view(self):
        self.assertEquals((255, 44, 0), self._getSavedCategory().color)

    def test_saved_category_has_font_color_from_view(self):
        self.assertEquals((0, 44, 255), self._getSavedCategory().font_color)

    def test_saved_category_has_parent_from_view(self):
        self.assertEquals(self.foo, self._getSavedCategory().parent)

    def test_the_dialog_is_closed(self):
        self.assertTrue(self.view.close.called)


class WhenTryingToSaveACategoryButDbRaisesException(CategoryEditorBaseFixture):

    def setUp(self):
        CategoryEditorBaseFixture.setUp(self)
        self._initializeControllerWith(None)
        self.view.get_name.return_value = "foobar"
        self.category_repository.save.side_effect = TimelineIOError
        self.controller.save()

    def test_error_is_handled_by_view(self):
        self.assertTrue(self.view.handle_db_error.called)

    def test_the_dialog_is_not_closed(self):
        self.assertFalse(self.view.close.called)


class WhenSavingACategoryWithAnInvalidName(CategoryEditorBaseFixture):

    def setUp(self):
        CategoryEditorBaseFixture.setUp(self)
        self._initializeControllerWith(None)
        self.view.get_name.return_value = ""
        self.controller.save()

    def test_the_category_is_not_saved_to_db(self):
        self.assertFalse(self.category_repository.save.called)

    def test_the_view_shows_an_error_message(self):
        self.assertTrue(self.view.handle_invalid_name.called)

    def test_the_dialog_is_not_closed(self):
        self.assertFalse(self.view.close.called)


class WhenSavingACategoryWithAUsedName(CategoryEditorBaseFixture):

    def setUp(self):
        CategoryEditorBaseFixture.setUp(self)
        self._initializeControllerWith(None)
        self.view.get_name.return_value = "foo"
        self.controller.save()

    def test_the_category_is_not_saved_to_db(self):
        self.assertFalse(self.category_repository.save.called)

    def test_the_view_shows_an_error_message(self):
        self.assertTrue(self.view.handle_used_name.called)

    def test_the_dialog_is_not_closed(self):
        self.assertFalse(self.view.close.called)