[RFC] add statusline widget for back/forward indicator #2738

blueyed · 2017-06-18T13:05:49Z

TODO:

tests

This change is

The-Compiler · 2017-06-19T07:49:27Z

qutebrowser/mainwindow/statusbar/backforward.py

+    """Shows navigation indicator (if you can go backward and/or forward)."""
+
+    def on_tab_changed(self, tab):
+        self.tab = tab


I'm not entirely happy with saving the tab here, but it's a bit of a tricky situation - what about connecting the signal above like tabs.cur_url_changed.connect(functools.partial(status.backforward.on_url_changed, tabs=tabs)), then taking a tabs in on_url_changed, and use tabs.currentWidget() to get the current tab? I haven't tested it, but I think it should work and it seems less error-prone to me.

Seems to work well.

The-Compiler · 2017-06-19T07:49:42Z

qutebrowser/mainwindow/statusbar/backforward.py

@@ -0,0 +1,42 @@
+# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
+
+# Copyright 2015-2017 Florian Bruhin (The Compiler) <mail@qutebrowser.org>


nitpick: 2017 instead of 2015-2017

blueyed · 2017-06-19T21:44:21Z

I've also added the @pyqtSlot() decorator, not sure if it is necessary? Maybe useful just for documentation / introspection alone?!

blueyed · 2017-06-19T21:51:48Z

Any pointer for the tests?
A new file in tests/unit/mainwindow/statusbar/?
How can I mock / provide tabs there?

The-Compiler · 2017-06-20T13:10:13Z

qutebrowser/mainwindow/statusbar/backforward.py

+
+    """Shows navigation indicator (if you can go backward and/or forward)."""
+
+    @pyqtSlot()


@pyqtSlot() on methods connected to PyQt signals is usually used because it has a memory/performance benefit (and also works around some bugs in older PyQt versions).

Here you're connecting a functools.partial object however, and never connect to the method directly - so I'd rather remove it.

The-Compiler · 2017-06-20T13:24:23Z

Yeah, a new file there sounds good. When it has 100% coverage, please also add it to scripts/dev/check_coverage.py (like the other statusbar files there).

As for mocking tabs: There's a TabbedBrowserStub in stubs.py, which you can access via a stubs fixture.

In 994e8c6 I just did some changes related to that as I discovered there were various other TabbedBrowser stubs, so I merged them into one. If you're comfortable with git rebase, I suggest you rebase on the newest master first.

The-Compiler · 2017-06-20T21:07:56Z

Just as a heads-up: I'm scheduled to have a (planned) eye surgery, so I probably won't respond to this anymore until somewhen next week.

blueyed · 2017-06-20T22:42:55Z

@The-Compiler
Thanks for notifying me, and good luck with that!
Take care!

blueyed · 2017-06-30T18:06:06Z

What do you think about having some additional indicator on how far you can go forward/backwards, e.g. the number if it is > 1, and < 10, and using << / >> in case it is > 10?

The-Compiler · 2017-06-30T21:11:01Z

Dunno. It doesn't sound too useful I think, and it's not very intuitive what it'd mean. Either way, I don't think you can get this information easily with the API we get from QtWebKit/QtWebEngine.

The-Compiler · 2017-07-05T11:09:54Z

Any update, @blueyed?

blueyed · 2017-07-05T12:40:16Z

No, I am using this myself, but otherwise I have to find the time to finish this, i.e. write the tests.

The-Compiler · 2017-07-05T13:50:08Z

I felt like writing some tests, so here they are:

From b6cd620a8635aad1cec325e9ef3cbfd15bec1766 Mon Sep 17 00:00:00 2001
From: Florian Bruhin <git@the-compiler.org>
Date: Wed, 5 Jul 2017 15:45:23 +0200
Subject: [PATCH 4/4] Add statusbar.backforward tests

---
 scripts/dev/check_coverage.py                      |  2 +
 tests/helpers/stubs.py                             | 20 ++++++++-
 .../unit/mainwindow/statusbar/test_backforward.py  | 50 ++++++++++++++++++++++
 3 files changed, 71 insertions(+), 1 deletion(-)
 create mode 100644 tests/unit/mainwindow/statusbar/test_backforward.py

diff --git a/scripts/dev/check_coverage.py b/scripts/dev/check_coverage.py
index 7e5a2d47a..b03fb7ef4 100644
--- a/scripts/dev/check_coverage.py
+++ b/scripts/dev/check_coverage.py
@@ -117,6 +117,8 @@ PERFECT_FILES = [
         'mainwindow/statusbar/textbase.py'),
     ('tests/unit/mainwindow/statusbar/test_url.py',
         'mainwindow/statusbar/url.py'),
+    ('tests/unit/mainwindow/statusbar/test_backforward.py',
+        'mainwindow/statusbar/backforward.py'),
     ('tests/unit/mainwindow/test_messageview.py',
         'mainwindow/messageview.py'),
 
diff --git a/tests/helpers/stubs.py b/tests/helpers/stubs.py
index 0551f5a86..788d3ace3 100644
--- a/tests/helpers/stubs.py
+++ b/tests/helpers/stubs.py
@@ -222,6 +222,22 @@ class FakeWebTabScroller(browsertab.AbstractScroller):
         return self._pos_perc
 
 
+class FakeWebTabHistory(browsertab.AbstractHistory):
+
+    def __init__(self, tab, *, can_go_back, can_go_forward):
+        super().__init__(tab)
+        self._can_go_back = can_go_back
+        self._can_go_forward = can_go_forward
+
+    def can_go_back(self):
+        assert self._can_go_back is not None
+        return self._can_go_back
+
+    def can_go_forward(self):
+        assert self._can_go_forward is not None
+        return self._can_go_forward
+
+
 class FakeWebTab(browsertab.AbstractTab):
 
     """Fake AbstractTab to use in tests."""
@@ -229,12 +245,14 @@ class FakeWebTab(browsertab.AbstractTab):
     def __init__(self, url=FakeUrl(), title='', tab_id=0, *,
                  scroll_pos_perc=(0, 0),
                  load_status=usertypes.LoadStatus.success,
-                 progress=0):
+                 progress=0, can_go_back=None, can_go_forward=None):
         super().__init__(win_id=0, mode_manager=None, private=False)
         self._load_status = load_status
         self._title = title
         self._url = url
         self._progress = progress
+        self.history = FakeWebTabHistory(self, can_go_back=can_go_back,
+                                         can_go_forward=can_go_forward)
         self.scroller = FakeWebTabScroller(self, scroll_pos_perc)
         wrapped = QWidget()
         self._layout.wrap(self, wrapped)
diff --git a/tests/unit/mainwindow/statusbar/test_backforward.py b/tests/unit/mainwindow/statusbar/test_backforward.py
new file mode 100644
index 000000000..15de7442f
--- /dev/null
+++ b/tests/unit/mainwindow/statusbar/test_backforward.py
@@ -0,0 +1,50 @@
+# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:
+
+# Copyright 2017 Florian Bruhin (The Compiler) <mail@qutebrowser.org>
+#
+# This file is part of qutebrowser.
+#
+# qutebrowser 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.
+#
+# qutebrowser 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 qutebrowser.  If not, see <http://www.gnu.org/licenses/>.
+
+
+"""Test Progress widget."""
+
+import pytest
+
+from qutebrowser.mainwindow.statusbar import backforward
+
+
+@pytest.fixture
+def backforward_widget(qtbot):
+    widget = backforward.Backforward()
+    qtbot.add_widget(widget)
+    return widget
+
+
+@pytest.mark.parametrize('can_go_back, can_go_forward, expected_text', [
+    (False, False, ''),
+    (True, False, '<'),
+    (False, True, '>'),
+    (True, True, '<>'),
+])
+def test_backforward_widget(backforward_widget, stubs,
+                            fake_web_tab, can_go_back, can_go_forward,
+                            expected_text):
+    """Ensure the Backforward widget shows the correct text."""
+    tab = fake_web_tab(can_go_back=can_go_back, can_go_forward=can_go_forward)
+    tabbed_browser = stubs.TabbedBrowserStub()
+    tabbed_browser.current_index = 1
+    tabbed_browser.tabs = [tab]
+    backforward_widget.on_url_changed(tabbed_browser)
+    assert backforward_widget.text() == expected_text
-- 
2.13.2

I'll also add some more line comments.

The-Compiler · 2017-07-05T13:51:25Z

qutebrowser/mainwindow/statusbar/backforward.py

+
+    """Shows navigation indicator (if you can go backward and/or forward)."""
+
+    def on_url_changed(self, tabs):


It's a bit confusing still calling this on_url_changed I think - maybe a simple update_text or so would be better.

It is still called through tabs.cur_url_changed?!

Yes, but if something is called on_url_changed, I'd expect it to be directly connected to a url_changed signal and get a QUrl as argument.

on_tab_cur_url_changed then maybe?
I think it is better to have some explicit name, instead of update_text?!

Works for me 😉

The-Compiler · 2017-07-05T13:52:42Z

qutebrowser/mainwindow/statusbar/backforward.py

+
+    def on_url_changed(self, tabs):
+        """Called on URL changes."""
+        tab = tabs.currentWidget()


On Travis looks like this was invoked while tabs.currentWidget() was None and caused it to raise. I'm not 100% sure why it happened, but I think it'd be a good idea to add a:

if tab is None: return

The-Compiler · 2017-07-05T13:53:50Z

qutebrowser/mainwindow/statusbar/backforward.py

+            text += '<'
+        if tab.history.can_go_forward():
+            text += '>'
+        self.setText(text)


Maybe add [] around the text so it fits in with the other statusbar widgets?

It takes away some more space then, and IIRC the current behavior is what you see in Vimperator, too - but I will change it.

The-Compiler · 2017-07-05T13:54:11Z

qutebrowser/mainwindow/mainwindow.py

@@ -469,6 +469,7 @@ def _connect_signals(self):
        tabs.tab_index_changed.connect(status.tabindex.on_tab_index_changed)

        tabs.cur_url_changed.connect(status.url.set_url)
+        tabs.cur_url_changed.connect(functools.partial(status.backforward.on_url_changed, tabs=tabs))


Please break this after the partial( or so.

The-Compiler · 2017-07-05T13:54:20Z

qutebrowser/mainwindow/statusbar/backforward.py

+
+"""Navigation (back/forward) indicator displayed in the statusbar."""
+
+from PyQt5.QtCore import pyqtSlot


unused import

Why is F401 (this error) in .flake8? (since the beginning in 91e6f4c)

Because it's already checked by pylint and I don't want to do ignores twice everywhere for imports which aren't actually unused.

Because pylint takes care of that?

I don't understand what you're asking? Yes, pylint shows an unused import error, see my link above.

Yes, pylint does, but I was using only flake8 in the editor (which I will change for the project).
I think I answered my own question: F401 from flake8 is ignored, since pylint is supposed to lint this part.

blueyed · 2017-07-09T11:53:43Z

@The-Compiler
Pushed some updates.
I assume we'll squash this altogether in the end, so I've just added your tests, without your authorship?!

Remaining: the renaming of the hook.

blueyed · 2017-07-09T16:39:02Z

Why does Travis not run the PR?

The-Compiler · 2017-07-09T17:37:45Z

Good question... let me try to close and reopen it.

The-Compiler

I'm fine with squashing things, yeah.

The-Compiler · 2017-07-09T20:17:45Z

tests/helpers/stubs.py

@@ -222,19 +222,37 @@ def pos_perc(self):
        return self._pos_perc


+class FakeWebTabHistory(browsertab.AbstractHistory):
+


My bad, but this needs a docstring (something like """Fake for Web{Kit,Engine}History.""" or so)

The-Compiler · 2017-07-09T20:18:09Z

qutebrowser/mainwindow/statusbar/backforward.py

+    def on_url_changed(self, tabs):
+        """Called on URL changes."""
+        tab = tabs.currentWidget()
+        if tab is None:


Hmm, probably needs a # pragma: no cover as it doesn't always happen.

Fixes qutebrowser#2737.

The-Compiler · 2017-07-09T21:29:29Z

Thanks!

blueyed · 2017-07-09T21:30:59Z

You're welcome!
Thank you for helping me get this in!

The-Compiler · 2017-07-10T07:45:20Z

Pushed two small changes:

5fb6cb7 because the gap when there's no history started to annoy me
e81dccc to add a test for the if tab is None: case.

blueyed force-pushed the backforward branch from 0e955fe to 01cb7ce Compare June 18, 2017 14:05

blueyed changed the title ~~[WIP] add statusline widget for back/forward indicator~~ [RFC] add statusline widget for back/forward indicator Jun 18, 2017

The-Compiler requested changes Jun 19, 2017

View reviewed changes

The-Compiler added PR: needs tests labels Jun 19, 2017

The-Compiler reviewed Jun 20, 2017

View reviewed changes

blueyed force-pushed the backforward branch from e96fe38 to 54781df Compare June 28, 2017 08:39

The-Compiler requested changes Jul 5, 2017

View reviewed changes

blueyed force-pushed the backforward branch from 54781df to 6065811 Compare July 9, 2017 11:31

The-Compiler closed this Jul 9, 2017

The-Compiler reopened this Jul 9, 2017

The-Compiler requested changes Jul 9, 2017

View reviewed changes

The-Compiler removed the PR: needs tests label Jul 9, 2017

Add statusline widget for back/forward indicator

b3a9e09

Fixes qutebrowser#2737.

blueyed force-pushed the backforward branch from c749d1b to b3a9e09 Compare July 9, 2017 20:38

blueyed closed this Jul 9, 2017

blueyed reopened this Jul 9, 2017

The-Compiler approved these changes Jul 9, 2017

View reviewed changes

The-Compiler merged commit b3a9e09 into qutebrowser:master Jul 9, 2017

blueyed deleted the backforward branch July 9, 2017 21:31

qutebrowser-bot added the status: stale label Dec 20, 2017

		@@ -0,0 +1,42 @@
		# vim: ft=python fileencoding=utf-8 sts=4 sw=4 et:

		# Copyright 2015-2017 Florian Bruhin (The Compiler) <mail@qutebrowser.org>


		"""Shows navigation indicator (if you can go backward and/or forward)."""

		@pyqtSlot()


		"""Shows navigation indicator (if you can go backward and/or forward)."""

		def on_url_changed(self, tabs):


		"""Navigation (back/forward) indicator displayed in the statusbar."""

		from PyQt5.QtCore import pyqtSlot

		@@ -222,19 +222,37 @@ def pos_perc(self):
		return self._pos_perc


		class FakeWebTabHistory(browsertab.AbstractHistory):

[RFC] add statusline widget for back/forward indicator #2738

[RFC] add statusline widget for back/forward indicator #2738

Conversation

blueyed commented Jun 18, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blueyed commented Jun 19, 2017

blueyed commented Jun 19, 2017

Choose a reason for hiding this comment

The-Compiler commented Jun 20, 2017

The-Compiler commented Jun 20, 2017

blueyed commented Jun 20, 2017

blueyed commented Jun 30, 2017

The-Compiler commented Jun 30, 2017

The-Compiler commented Jul 5, 2017

blueyed commented Jul 5, 2017

The-Compiler commented Jul 5, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

blueyed commented Jul 9, 2017

blueyed commented Jul 9, 2017

The-Compiler commented Jul 9, 2017

The-Compiler left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

The-Compiler commented Jul 9, 2017

blueyed commented Jul 9, 2017

The-Compiler commented Jul 10, 2017

blueyed commented Jun 18, 2017 •

edited