Source code for unit.wxgui.dialogs.editcategory.controller

# Copyright (C) 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018  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/>.


from unittest.mock import Mock

from timelinelib.canvas.data.memorydb.db import MemoryDB
from timelinelib.test.cases.unit import UnitTestCase
from timelinelib.wxgui.dialogs.editcategory.controller import EditCategoryDialogController
from timelinelib.wxgui.dialogs.editcategory.view import EditCategoryDialog


class EditCategoryDialogControllerTestCase(UnitTestCase):

    def setUp(self):
        self.db = MemoryDB()
        self.foo = self.db.new_category(name="foo").save()
        self.foofoo = self.db.new_category(
            name="foofoo",
            color=(255, 0, 0),
            font_color=(0, 255, 0),
            parent=self.foo
        ).save()
        self.bar = self.db.new_category(name="bar").save()
        self.view = Mock(EditCategoryDialog)
        self.save_listener = Mock()
        self.db.listen_for_any(self.save_listener)
        self.controller = EditCategoryDialogController(self.view)


class describe_editing_a_new_category(EditCategoryDialogControllerTestCase):

    def setUp(self):
        EditCategoryDialogControllerTestCase.setUp(self)
        self.controller.on_init(self.db, None)

    def test_categories_are_populated(self):
        self.view.PopulateCategories.assert_called_with(exclude=None)

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

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

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

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


class describe_editing_an_existing_category(EditCategoryDialogControllerTestCase):

    def setUp(self):
        EditCategoryDialogControllerTestCase.setUp(self)
        self.controller.on_init(self.db, self.foofoo)

    def test_category_can_be_retrieved(self):
        self.assertIs(self.controller.get_edited_category(), self.foofoo)

    def test_categories_are_populated(self):
        self.view.PopulateCategories.assert_called_with(exclude=self.foofoo)

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

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

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

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


class describe_saving_a_category(EditCategoryDialogControllerTestCase):

    def setUp(self):
        EditCategoryDialogControllerTestCase.setUp(self)
        self.controller.on_init(self.db, None)
        self.view.GetName.return_value = "new_cat"
        self.view.GetColor.return_value = (255, 44, 0)
        self.view.GetFontColor.return_value = (0, 44, 255)
        self.view.GetParent.return_value = self.foo
        self.controller.on_ok_clicked(None)

    def _getSavedCategory(self):
        self.assertTrue(self.save_listener.called)
        return self.controller.get_edited_category()

    def test_saved_category_has_name_from_view(self):
        self.assertEqual("new_cat", self._getSavedCategory().get_name())

    def test_saved_category_has_color_from_view(self):
        self.assertEqual((255, 44, 0), self._getSavedCategory().get_color())

    def test_saved_category_has_font_color_from_view(self):
        self.assertEqual((0, 44, 255),
                         self._getSavedCategory().get_font_color())

    def test_saved_category_has_parent_from_view(self):
        self.assertEqual(self.foo, self._getSavedCategory()._get_parent())

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


class describe_saving_a_category_with_an_invalid_name(EditCategoryDialogControllerTestCase):

    def setUp(self):
        EditCategoryDialogControllerTestCase.setUp(self)
        self.controller.on_init(self.db, None)
        self.view.GetName.return_value = ""
        self.controller.on_ok_clicked(None)

    def test_the_category_is_not_saved_to_db(self):
        self.assertFalse(self.save_listener.called)

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

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


class describe_saving_a_category_with_a_used_name(EditCategoryDialogControllerTestCase):

    def setUp(self):
        EditCategoryDialogControllerTestCase.setUp(self)
        self.controller.on_init(self.db, None)
        self.view.GetName.return_value = "foo"
        self.controller.on_ok_clicked(None)

    def test_the_category_is_not_saved_to_db(self):
        self.assertFalse(self.save_listener.called)

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

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