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

# 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.calendar.num.timetype.timetype import NumTimeType
from timelinelib.config.dotfile import Config
from timelinelib.test.cases.unit import UnitTestCase
from timelinelib.wxgui.frames.mainframe.mainframecontroller import MainFrameController
from timelinelib.wxgui.frames.mainframe.mainframe import MainFrame



[docs]class describe_mainframe_controller(UnitTestCase):


[docs]    def test_uses_db_open_function_to_create_timeline(self):
        self.controller._open_or_create_timeline("foo.timeline")
        self.db_open.assert_called_with("foo.timeline", timetype=None)



[docs]    def test_uses_db_open_function_to_create_numeric_timeline(self):
        timetype = NumTimeType()
        self.controller._open_or_create_timeline("foo.timeline", timetype=timetype)
        self.db_open.assert_called_with("foo.timeline", timetype=timetype)



[docs]    def test_displays_opened_timeline(self):
        timeline = Mock()
        self.db_open.return_value = timeline
        self.controller._open_or_create_timeline("foo.timeline")
        self.main_frame.DisplayTimeline.assert_called_with(timeline)



[docs]    def test_saves_current_timeline_data_when_opening_new_timeline(self):
        self.controller._open_or_create_timeline("foo.timeline")
        self.main_frame.main_panel.save_view_properties.assert_called_with()



[docs]    def test_does_not_save_current_timeline_data_when_reloading_from_disk(self):
        self.controller._open_or_create_timeline("foo.timeline")
        self.main_frame.reset_mock()
        self.controller._reload_from_disk()
        self.assertFalse(self.main_frame.main_panel.save_view_properties.called)



[docs]    def test_adds_opened_timeline_to_recently_opened_list(self):
        self.controller._open_or_create_timeline("foo.timeline")
        self.config.append_recently_opened.assert_called_with("foo.timeline")
        self.main_frame.UpdateOpenRecentSubmenu.assert_called_with()



[docs]    def test_handles_open_timeline_failure(self):
        self.error_message = None
        def err(message, yesno=False):
            self.error_message = message
        self.controller.set_error_dialog(err)
        self.db_open.side_effect = Exception("file corrupt")
        self.controller._open_or_create_timeline("foo.timeline")
        self.assertEqual(self.error_message,
                         "⟪Unable to open timeline 'foo.timeline'.⟫\n\nfile corrupt\n\n⟪Show more details?⟫")



[docs]    def setUp(self):
        self.main_frame = Mock(MainFrame)
        self.main_frame.main_panel = Mock()
        self.main_frame.main_panel.timeline_panel = Mock()
        self.main_frame.main_panel.timeline_panel.timeline_canvas = Mock()
        self.db_open = Mock()
        self.config = Mock(Config)
        self.config.get_date_format.return_value = "yyyy-mm-dd"
        self.controller = MainFrameController(self.main_frame, self.db_open,
                                              self.config)