Source code for unit.wxgui.frames.mainframe.menucontroller

# 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
import wx

from timelinelib.canvas.data.memorydb.db import MemoryDB
from timelinelib.test.cases.unit import UnitTestCase
from timelinelib.wxgui.frames.mainframe.menucontroller import MenuController



[docs]class describe_menu_controller(UnitTestCase):


[docs]    def test_menu_requiering_update_is_disabled_when_no_timeline_exists(self):
        self.given_no_timeline_exists()
        self.given_menu_item_requires_update()
        self.when_menu_state_possibly_has_changed()
        self.menu_item.Enable.assert_called_with(False)



[docs]    def test_menu_requiering_update_is_enabled_when_timeline_is_updateable(self):
        self.given_menu_item_requires_update()
        self.given_timeline_is_updateable()
        self.when_menu_state_possibly_has_changed()
        self.menu_item.Enable.assert_called_with(True)



[docs]    def test_menu_requiering_update_is_disabledd_when_timeline_is_read_only(self):
        self.given_menu_item_requires_update()
        self.given_timeline_is_read_only()
        self.when_menu_state_possibly_has_changed()
        self.menu_item.Enable.assert_called_with(False)



[docs]    def test_menu_requiering_timeline_is_disabled_when_no_timeline_exists(self):
        self.given_no_timeline_exists()
        self.given_menu_item_requires_timeline()
        self.when_menu_state_possibly_has_changed()
        self.menu_item.Enable.assert_called_with(False)



[docs]    def test_menu_requiering_timeline_is_enabled_when_timeline_exists(self):
        self.given_timeline_exists()
        self.given_menu_item_requires_timeline()
        self.when_menu_state_possibly_has_changed()
        self.menu_item.Enable.assert_called_with(True)



[docs]    def test_menu_requiering_timeline_view_is_disabled_when_no_timeline_exists(self):
        self.given_no_timeline_exists()
        self.given_menu_item_requires_timeline_view()
        self.when_menu_state_possibly_has_changed()
        self.menu_item.Enable.assert_called_with(False)



[docs]    def test_menu_requiering_timeline_view_is_disabled_when_no_timeline_view_exists(self):
        self.given_timeline_exists()
        self.given_no_timeline_view_exists()
        self.given_menu_item_requires_timeline_view()
        self.when_menu_state_possibly_has_changed()
        self.menu_item.Enable.assert_called_with(False)



[docs]    def test_menu_requiering_timeline_view_is_enabled_when_timeline_view_exists(self):
        self.given_timeline_exists()
        self.given_timeline_view_exists()
        self.given_menu_item_requires_timeline_view()
        self.when_menu_state_possibly_has_changed()
        self.menu_item.Enable.assert_called_with(True)



[docs]    def setUp(self):
        self.menu_controller = MenuController(Mock(wx.MenuBar))
        self.menu_item = Mock(wx.MenuItem)
        self.timeline = Mock(MemoryDB)
        self.menu_controller.on_timeline_change(self.timeline)
        self.timeline_panel_visible = False



[docs]    def given_menu_item_requires_update(self):
        self.menu_controller.add_menu_requiring_writable_timeline(self.menu_item)



[docs]    def given_menu_item_requires_timeline(self):
        self.menu_controller.add_menu_requiring_timeline(self.menu_item)



[docs]    def given_menu_item_requires_timeline_view(self):
        self.menu_controller.add_menu_requiring_visible_timeline_view(self.menu_item)



[docs]    def given_no_timeline_exists(self):
        self.menu_controller.on_timeline_change(None)



[docs]    def given_timeline_exists(self):
        self.menu_controller.on_timeline_change(self.timeline)



[docs]    def given_no_timeline_view_exists(self):
        self.timeline_panel_visible = False



[docs]    def given_timeline_view_exists(self):
        self.timeline_panel_visible = True



[docs]    def given_timeline_is_updateable(self):
        self.timeline.is_read_only.return_value = False



[docs]    def given_timeline_is_read_only(self):
        self.timeline.is_read_only.return_value = True



[docs]    def given_timeline_panel_is_visible(self):
        self.timeline_panel_visible = True



[docs]    def when_menu_state_possibly_has_changed(self):
        self.menu_controller._enable_disable_menus(self.timeline_panel_visible)