Seluj78 / flask-utils

Various Flask utilities that I find useful in my projects
GNU General Public License v3.0
2 stars 1 forks source link

Utils: Added is_it_true utility function #24

Closed Seluj78 closed 1 month ago

Seluj78 commented 1 month ago

Also added documentation and tests to go along with it


📚 Documentation preview 📚: https://flask-utils--24.org.readthedocs.build/en/24/

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The updates primarily focus on enhancing the flask_utils module by adding a new utility function is_it_true and updating dependencies to support newer Flask versions. Documentation has been expanded to include this new utility, and the test suite has been updated accordingly. Changes to the GitHub workflow and tox.ini file ensure compatibility with these updates and streamline testing across different Python and Flask versions.

Changes

Files Change Summaries
.github/workflows/tests.yml Modified TOX_ENV variable setting to dynamically retrieve available tox environments.
docs/requirements.txt, requirements.txt Updated Flask version requirement from >=2.0.0 to >=2.2.0.
docs/source/api.rst Added a new section for flask_utils.utils in the documentation.
flask_utils/__init__.py Updated module version to "0.4.0" and added is_it_true function import.
flask_utils/utils.py Introduced is_it_true(value: str) -> bool function to determine truthiness of string values.
tests/test_utils.py Added test cases for is_it_true function and a fixture to set up a Flask route for testing.
tox.ini Updated envlist to remove older Flask versions and adjusted dependencies for newer versions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FlaskApp
    participant is_it_true

    User->>FlaskApp: Send request with query parameter
    FlaskApp->>is_it_true: Call is_it_true with query parameter value
    is_it_true-->>FlaskApp: Return boolean result
    FlaskApp-->>User: Return JSON response with boolean result

Poem

In the land of code so bright, A rabbit hops with pure delight. 🐇 New truths in Flask now we see, With is_it_true, clarity! Tests and docs, all in line, Version bumps, oh so fine. Tox and workflows, all set right, CodeRabbit brings the light! 🌟


Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.