flaskbb-plugin-vote 1.0.0__tar.gz

flaskbb_plugin_vote-1.0.0/.gitignore

@@ -0,0 +1,43 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+.pytest_cache/
+.ruff_cache/
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+*.log
+
+.vscode
+.venv/

flaskbb_plugin_vote-1.0.0/LICENSE

@@ -0,0 +1,31 @@
+Copyright (c) 2026 by Peter Justin and contributors. See AUTHORS for more
+details.
+
+Some rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+
+* The names of the contributors may not be used to endorse or
+  promote products derived from this software without specific
+  prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

flaskbb_plugin_vote-1.0.0/PKG-INFO

@@ -0,0 +1,43 @@
+Metadata-Version: 2.4
+Name: flaskbb-plugin-vote
+Version: 1.0.0
+Summary: A polls plugin for FlaskBB - attach single or multiple choice polls to topics and posts
+Project-URL: Homepage, https://github.com/flaskbb/flaskbb-plugin-vote
+Project-URL: Repository, https://github.com/flaskbb/flaskbb-plugin-vote
+Project-URL: Issues, https://github.com/flaskbb/flaskbb-plugin-vote/issues
+Project-URL: Changelog, https://github.com/flaskbb/flaskbb-plugin-vote/blob/master/CHANGELOG.md
+Author-email: Peter Justin <peter.justin@outlook.com>
+Maintainer-email: Peter Justin <peter.justin@outlook.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Keywords: flaskbb,plugin,poll,polls,vote
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Flask
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: flaskbb>=3.0.0
+Description-Content-Type: text/markdown
+
+Vote
+====
+
+A polls plugin for FlaskBB. Lets a user create polls in a topic or post.
+
+
+Installation
+------------
+
+Install *flaskbb-plugin-vote* with
+``pip install flaskbb-plugin-vote``
+
+License
+-------
+This project is licensed under the terms of the [BSD License](/LICENSE).

flaskbb_plugin_vote-1.0.0/README.md

@@ -0,0 +1,15 @@
+Vote
+====
+
+A polls plugin for FlaskBB. Lets a user create polls in a topic or post.
+
+
+Installation
+------------
+
+Install *flaskbb-plugin-vote* with
+``pip install flaskbb-plugin-vote``
+
+License
+-------
+This project is licensed under the terms of the [BSD License](/LICENSE).

flaskbb_plugin_vote-1.0.0/pyproject.toml

@@ -0,0 +1,90 @@
+[project]
+name = "flaskbb-plugin-vote"
+version = "1.0.0"
+dependencies = [
+    "FlaskBB>=3.0.0",
+]
+requires-python = ">=3.12"
+authors = [
+  {name = "Peter Justin", email = "peter.justin@outlook.com"},
+]
+maintainers = [
+  {name = "Peter Justin", email = "peter.justin@outlook.com"}
+]
+description = "A polls plugin for FlaskBB - attach single or multiple choice polls to topics and posts"
+readme = "README.md"
+license = "BSD-3-Clause"
+license-files = ["LICEN[CS]E"]
+keywords = ["flaskbb", "plugin", "vote", "poll", "polls"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Framework :: Flask",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Software Development :: Libraries :: Python Modules"
+]
+[project.urls]
+Homepage = "https://github.com/flaskbb/flaskbb-plugin-vote"
+Repository = "https://github.com/flaskbb/flaskbb-plugin-vote"
+Issues = "https://github.com/flaskbb/flaskbb-plugin-vote/issues"
+Changelog = "https://github.com/flaskbb/flaskbb-plugin-vote/blob/master/CHANGELOG.md"
+
+[project.entry-points.'flaskbb_plugins']
+vote = 'vote'
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "hatch",
+    "Babel",
+    "pytest",
+    "ruff",
+]
+
+[tool.hatch.build.targets.sdist]
+only-include = ["vote", "tests"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["vote"]
+
+[tool.uv]
+package = true
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.basedpyright]
+include = ["vote"]
+exclude = ["**/node_modules", "**/resources", "**/__pycache__", "**/docs"]
+defineConstant = { DEBUG = true }
+reportIgnoreCommentWithoutRule = false
+reportMissingImports = "error"
+reportMissingTypeStubs = false
+reportUnusedCallResult = false
+reportUnannotatedClassAttribute = false
+reportUnusedParameter = false
+reportAny = false
+reportExplicitAny = false
+
+[tool.pytest]
+minversion = "9.0"
+addopts = [
+    "-vvl",
+    "--strict-markers",
+    "--capture", "fd",
+    "--tb", "short",
+    "--pythonwarnings",  "error::flaskbb.deprecation.FlaskBBDeprecation",
+    "--dist", "load"
+]
+testpaths = [
+    "tests",
+]

flaskbb_plugin_vote-1.0.0/tests/conftest.py

@@ -0,0 +1,36 @@
+import pytest
+from flaskbb.forum.models import Post
+from tests.fixtures.app import *
+from tests.fixtures.forum import *
+from tests.fixtures.user import *
+
+from vote.models import Poll, PollOption
+
+
+def _reply(topic, user):
+    """A reply post in ``topic`` - polls attach to this, not the first
+    post, so cascade-delete tests don't get entangled with Post.delete()
+    redirecting to Topic.delete() for a topic's first post."""
+    return Post(content="Test reply").save(user=user, topic=topic)
+
+
+@pytest.fixture
+def poll(topic, user):
+    post = _reply(topic, user)
+    poll = Poll(post_id=post.id, question="Favorite color?", poll_type="single")
+    poll.save()
+    PollOption(poll_id=poll.id, text="Red", position=0).save()
+    PollOption(poll_id=poll.id, text="Green", position=1).save()
+    PollOption(poll_id=poll.id, text="Blue", position=2).save()
+    return Poll.get(Poll.id == poll.id)
+
+
+@pytest.fixture
+def multi_poll(topic, user):
+    post = _reply(topic, user)
+    poll = Poll(post_id=post.id, question="Favorite toppings?", poll_type="multiple")
+    poll.save()
+    PollOption(poll_id=poll.id, text="Cheese", position=0).save()
+    PollOption(poll_id=poll.id, text="Pepperoni", position=1).save()
+    PollOption(poll_id=poll.id, text="Mushroom", position=2).save()
+    return Poll.get(Poll.id == poll.id)

flaskbb_plugin_vote-1.0.0/tests/test_vote_integration.py

@@ -0,0 +1,205 @@
+"""
+End-to-end tests for the flaskbb_form_topic/flaskbb_form_post +
+flaskbb_event_post_save_after hook chain that turns a submitted poll_data
+payload into a real Poll row. This only works if the `vote` package is
+installed into flaskbb's environment (so its entry point is discovered by
+create_app() and its hookimpls actually run) - see README.md.
+"""
+
+import json
+from contextlib import contextmanager
+
+from flaskbb.core.settings import flaskbb_config
+from flaskbb.extensions import pluggy
+from flaskbb.forum.forms import EditTopicForm, NewTopicForm, ReplyForm
+
+import vote as vote_plugin
+from vote.models import Poll, PollOption
+
+
+def poll_json(**overrides):
+    data = {
+        "question": "Favorite color?",
+        "type": "single",
+        "options": ["Red", "Blue"],
+    }
+    data.update(overrides)
+    return json.dumps(data)
+
+
+def new_topic_form(**kwargs):
+    # flaskbb_form_topic is only invoked by NewTopic.form()/EditTopic.form()
+    # in flaskbb/forum/views.py, once per request - never automatically -
+    # so a test constructing NewTopicForm() directly has to trigger it
+    # first, exactly like those views do.
+    pluggy.hook.flaskbb_form_topic(form=NewTopicForm)
+    return NewTopicForm(**kwargs)
+
+
+def reply_form(**kwargs):
+    pluggy.hook.flaskbb_form_post(form=ReplyForm)
+    return ReplyForm(**kwargs)
+
+
+@contextmanager
+def topics_only(enabled):
+    # default_settings (pulled in transitively by the forum/topic fixtures)
+    # already seeds vote's settings group, so this is just a normal update.
+    original = flaskbb_config["VOTE_TOPICS_ONLY"]
+    flaskbb_config["VOTE_TOPICS_ONLY"] = enabled
+    try:
+        yield
+    finally:
+        flaskbb_config["VOTE_TOPICS_ONLY"] = original
+
+
+def test_new_topic_form_has_poll_data_field(request_context):
+    assert hasattr(new_topic_form(), "poll_data")
+
+
+def test_reply_form_has_poll_data_field(request_context, default_settings):
+    # reply_form() now reads the TOPICS_ONLY setting, which needs the
+    # settings table to exist.
+    assert hasattr(reply_form(), "poll_data")
+
+
+def test_submitting_a_new_topic_with_poll_data_creates_a_poll(
+    request_context, forum, user
+):
+    form = new_topic_form(
+        title="A topic with a poll", content="See the attached poll", track_topic=False
+    )
+    form.poll_data.data = poll_json()
+
+    topic = form.save(user, forum)
+
+    poll = Poll.get(Poll.post_id == topic.first_post.id)
+    assert poll is not None
+    assert poll.question == "Favorite color?"
+    assert [o.text for o in poll.options] == ["Red", "Blue"]
+
+
+def test_submitting_a_new_topic_without_poll_data_creates_no_poll(
+    request_context, forum, user
+):
+    form = new_topic_form(
+        title="A plain topic", content="No poll here", track_topic=False
+    )
+
+    topic = form.save(user, forum)
+
+    assert Poll.get(Poll.post_id == topic.first_post.id) is None
+
+
+def test_submitting_a_reply_with_poll_data_creates_a_poll(request_context, topic, user):
+    form = reply_form(content="A reply with a poll", track_topic=False)
+    form.poll_data.data = poll_json(question="Pick one", options=["A", "B", "C"])
+
+    post = form.save(user, topic)
+
+    poll = Poll.get(Poll.post_id == post.id)
+    assert poll is not None
+    assert poll.question == "Pick one"
+    assert [o.text for o in poll.options] == ["A", "B", "C"]
+
+
+def test_editing_a_reply_with_poll_data_creates_no_poll(request_context, topic, user):
+    """ReplyForm is shared between NewPost and EditPost - poll_data is only
+    ever meant to be honored for a brand new post (see the comment on
+    flaskbb_tpl_form_new_post_after in vote/__init__.py). Simulating an
+    edit here by passing obj=<an existing post> exercises the is_new=False
+    guard in flaskbb_event_post_save_after directly, regardless of
+    whether the template actually renders the field for edits.
+    """
+    existing_post = topic.first_post
+    form = reply_form(obj=existing_post, content="Edited content", track_topic=False)
+    form.poll_data.data = poll_json()
+
+    form.save(user, topic)
+
+    assert Poll.get(Poll.post_id == existing_post.id) is None
+
+
+def test_malformed_poll_data_does_not_prevent_topic_creation(
+    request_context, forum, user
+):
+    form = new_topic_form(
+        title="A topic with junk poll data", content="Still works", track_topic=False
+    )
+    form.poll_data.data = "not json"
+
+    topic = form.save(user, forum)
+
+    assert topic is not None
+    assert topic.id is not None
+    assert Poll.get(Poll.post_id == topic.first_post.id) is None
+
+
+def test_topics_only_removes_poll_data_from_reply_form(
+    request_context, default_settings
+):
+    with topics_only(True):
+        assert not hasattr(reply_form(), "poll_data")
+
+
+def test_topics_only_does_not_affect_new_topic_form(request_context, default_settings):
+    with topics_only(True):
+        assert hasattr(new_topic_form(), "poll_data")
+
+
+def test_topics_only_disabled_again_restores_the_field(
+    request_context, default_settings
+):
+    with topics_only(True):
+        assert not hasattr(reply_form(), "poll_data")
+    with topics_only(False):
+        assert hasattr(reply_form(), "poll_data")
+
+
+def test_topics_only_prevents_a_reply_poll_end_to_end(request_context, topic, user):
+    with topics_only(True):
+        form = reply_form(content="Trying to attach a poll anyway")
+        assert not hasattr(form, "poll_data")
+
+        post = form.save(user, topic)
+
+        assert Poll.get(Poll.post_id == post.id) is None
+
+
+def test_editing_a_reply_shows_its_poll_read_only(request_context, poll):
+    form = reply_form(obj=poll.post, content="Edited content")
+
+    html = vote_plugin.flaskbb_tpl_form_new_post_after(form)
+
+    assert html is not None
+    assert poll.question in html
+    assert 'name="option_id"' not in html
+
+
+def test_editing_a_reply_without_a_poll_renders_nothing(request_context, topic, user):
+    from flaskbb.forum.models import Post
+
+    post = Post(content="No poll here").save(user=user, topic=topic)
+    form = reply_form(obj=post, content="Edited content")
+
+    assert vote_plugin.flaskbb_tpl_form_new_post_after(form) is None
+
+
+def test_editing_a_topic_shows_its_poll_read_only(request_context, topic, user):
+    poll = Poll(post_id=topic.first_post.id, question="Best pizza?", poll_type="single")
+    poll.save()
+    PollOption(poll_id=poll.id, text="Margherita", position=0).save()
+    PollOption(poll_id=poll.id, text="Pepperoni", position=1).save()
+
+    form = EditTopicForm(obj=topic.first_post, title=topic.title)
+    html = vote_plugin.flaskbb_tpl_form_new_topic_after(form)
+
+    assert html is not None
+    assert "Best pizza?" in html
+    assert 'name="option_id"' not in html
+
+
+def test_editing_a_topic_without_a_poll_renders_nothing(request_context, topic):
+    form = EditTopicForm(obj=topic.first_post, title=topic.title)
+
+    assert vote_plugin.flaskbb_tpl_form_new_topic_after(form) is None

flaskbb_plugin_vote-1.0.0/tests/test_vote_models.py

@@ -0,0 +1,61 @@
+from vote.models import Poll, PollOption, PollVote
+
+
+def test_poll_total_votes_with_no_votes(poll):
+    assert poll.total_votes == 0
+
+
+def test_poll_total_votes_counts_across_options(poll, user, admin_user):
+    red, green = poll.options[0], poll.options[1]
+    PollVote(poll_option_id=red.id, user_id=user.id).save()
+    PollVote(poll_option_id=green.id, user_id=admin_user.id).save()
+
+    poll = Poll.get(Poll.id == poll.id)
+    assert poll.total_votes == 2
+
+
+def test_option_vote_count(poll, user):
+    red = poll.options[0]
+    PollVote(poll_option_id=red.id, user_id=user.id).save()
+
+    assert red.vote_count == 1
+    assert poll.options[1].vote_count == 0
+
+
+def test_option_ids_voted_by_returns_only_that_users_votes(poll, user, admin_user):
+    red, green = poll.options[0], poll.options[1]
+    PollVote(poll_option_id=red.id, user_id=user.id).save()
+    PollVote(poll_option_id=green.id, user_id=admin_user.id).save()
+
+    assert poll.option_ids_voted_by(user.id) == [red.id]
+    assert poll.option_ids_voted_by(admin_user.id) == [green.id]
+
+
+def test_option_ids_voted_by_empty_for_nonvoter(poll, admin_user):
+    assert poll.option_ids_voted_by(admin_user.id) == []
+
+
+def test_is_multiple_choice(poll, multi_poll):
+    assert poll.is_multiple_choice is False
+    assert multi_poll.is_multiple_choice is True
+
+
+def test_deleting_post_cascades_to_poll_and_options(poll):
+    post = poll.post
+    option_ids = [option.id for option in poll.options]
+    poll_id = poll.id
+
+    post.delete()
+
+    assert Poll.get(Poll.id == poll_id) is None
+    assert PollOption.get_all(PollOption.id.in_(option_ids)) == []
+
+
+def test_deleting_option_cascades_to_votes(poll, user):
+    red = poll.options[0]
+    vote = PollVote(poll_option_id=red.id, user_id=user.id).save()
+    vote_id = vote.id
+
+    red.delete()
+
+    assert PollVote.get(PollVote.id == vote_id) is None