🔖 release v8.0.1 (#625)

* ⬆️ update dependencies and linters (#615) * 📝 update build_runner reference in readme (#616) * 📄 create symlink to chopper/LICENSE (#617) * 👥 update/fix contributors (#618) * 🔒 add Security Policy (#619) * 🐛 Fix null body converter (#623) * 📦 directly export `qs.ListFormat` instead of internal wrapper (#624) --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Job Guldemeester <[email protected]>
lejard-h · Jun 30, 2024 · 3d17471 · 3d17471
1 parent df9801a
commit 3d17471
Show file tree

Hide file tree

Showing 27 changed files with 454 additions and 69 deletions.
diff --git a/.all-contributorsrc b/.all-contributorsrc
@@ -1,44 +1,67 @@
 {
+  "projectName": "chopper",
+  "projectOwner": "lejard-h",
   "files": [
     "README.md"
   ],
   "imageSize": 100,
   "commit": false,
   "contributors": [
-  "imageSize": 64,
-  "commit": false,
-  "contributors": [
-      {
+    {
       "login": "Vovanella95",
-      "name": "Uladzimir_Paliukhovich",
+      "name": "Uladzimir Paliukhovich",
       "avatar_url": "https://avatars.githubusercontent.com/u/11267533?v=4",
       "profile": "https://github.com/Vovanella95",
       "contributions": [
         "code"
-        ]
-        },
-   {
+      ]
+    },
+    {
       "login": "fryette",
       "name": "Eugeny Sampir",
       "avatar_url": "https://avatars.githubusercontent.com/u/3999503?v=4",
       "profile": "http://[email protected]",
       "contributions": [
         "code"
-        ]
-        },
+      ]
+    },
+    {
+      "login": "Guldem",
+      "name": "Job Guldemeester",
+      "avatar_url": "https://avatars.githubusercontent.com/u/11982796?v=4",
+      "profile": "https://github.com/Guldem",
+      "contributions": [
+        "code",
+        "review",
+        "test",
+        "doc"
+      ]
+    },
     {
       "login": "JEuler",
       "name": "Ivan Terekhin",
       "avatar_url": "https://avatars.githubusercontent.com/u/231950?v=4",
       "profile": "https://www.upwork.com/freelancers/~01192eefd8a1c267f7",
-            "contributions": [
+      "contributions": [
         "code",
         "review",
         "test",
         "doc"
       ]
-      },
-{
+    },
+    {
+      "login": "techouse",
+      "name": "Klemen Tusar",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1174328?v=4",
+      "profile": "https://github.com/techouse",
+      "contributions": [
+        "code",
+        "review",
+        "test",
+        "doc"
+      ]
+    },
+    {
       "login": "stewemetal",
       "name": "István Juhos",
       "avatar_url": "https://avatars.githubusercontent.com/u/5860632?v=4",
@@ -49,8 +72,8 @@
         "test",
         "doc"
       ]
-},
-{
+    },
+    {
       "login": "lejard-h",
       "name": "Hadrien Lejard",
       "avatar_url": "https://avatars.githubusercontent.com/u/7336262?v=4",
@@ -63,10 +86,8 @@
       ]
     }
   ],
-  "contributorsPerLine": 7,
-  "projectName": "chopper",
-  "projectOwner": "lejard-h",
   "repoType": "github",
+  "contributorsPerLine": 7,
   "repoHost": "https://github.com",
   "skipCi": true
 }
diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md
@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[[email protected]](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,111 @@
+# Contributing
+
+Thank you for your interest in contributing to this project. This project relies on the help of volunteer developers for
+its development and maintenance.
+
+Before making any changes to this repository, please first discuss the proposed changes with the repository owners
+through an issue, email, or any other appropriate method of communication.
+
+Please note that a [code of conduct](CODE-OF-CONDUCT.md) is in place and should be adhered to during all interactions
+related to the project.
+
+## Dart version support
+
+Currently, the package supports Dart versions 3.0 and above. Once a new Dart version is released, we will aim to support
+it as soon as possible. If you encounter any issues with a new Dart version, please create an issue in the repository.
+
+## Flutter support
+
+This package is designed to work with Flutter 3.10 and above. We prioritize and are dedicated to maintaining
+compatibility with these versions for a smooth user experience.
+
+## Testing
+
+Given the critical nature of correctly generating HTTP requests and handling API responses in the Chopper package, and
+the potential for security vulnerabilities if this is not done correctly or consistently across platforms and versions
+of Dart and Flutter, thorough testing is of utmost importance. Please remember to write tests for any new code you
+create, using the [test](https://pub.dev/packages/test) package for all test cases.
+
+### Running the test suite
+
+To run the test suite, follow these commands:
+
+```bash
+git clone https://github.com/lejard-h/chopper.git
+
+pushd chopper
+dart pub get
+dart test --platform vm
+dart test --platform chrome
+popd
+
+pushd chopper_generator
+dart pub get
+dart test --platform vm
+dart test --platform chrome
+popd
+
+pushd chopper_built_value
+dart pub get
+dart test --platform vm
+dart test --platform chrome
+popd
+```
+
+### Running the test suite with coverage
+
+```bash
+pushd chopper
+make show_test_coverage
+popd
+
+pushd chopper_generator
+make show_test_coverage
+popd
+
+pushd chopper_built_value
+make show_test_coverage
+popd
+```
+
+## Submitting changes
+
+To contribute to this project, please submit a new pull request and provide a clear list of your changes. For guidance
+on creating pull requests, you can refer to this resource. When sending a pull request, we highly appreciate the
+inclusion of tests, as we strive to enhance our test coverage.
+Following our coding conventions is essential, and it would be ideal if you ensure that each commit focuses on a single
+feature. For commits, please write clear log messages. While concise one-line messages are suitable for small changes,
+more substantial modifications should follow a format similar to the example below:
+
+```bash
+git commit -m "A brief summary of the commit
+> 
+> A paragraph describing what changed and its impact."
+```
+
+## Coding standards
+
+Prioritizing code readability and conciseness is essential. To achieve this, we recommend using `dart format` for code
+formatting. Once your work is deemed complete, it is advisable to run the following command:
+
+```bash
+pushd chopper
+dart format lib test --output=none --set-exit-if-changed .
+dart analyze lib test --fatal-infos
+popd
+
+pushd chopper_generator
+dart format lib test --output=none --set-exit-if-changed .
+dart analyze lib test --fatal-infos
+popd
+
+pushd chopper_built_value
+dart format lib test --output=none --set-exit-if-changed .
+dart analyze lib test --fatal-infos
+popd
+```
+
+This command runs the Dart analyzer to identify any potential issues or inconsistencies in your code. By following these
+guidelines, you can ensure a high-quality codebase.
+
+Thanks!
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1 @@
+chopper/LICENSE
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Chopper
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-5-orange.svg?style=flat-square)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-7-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 [![pub package](https://img.shields.io/pub/v/chopper.svg)](https://pub.dartlang.org/packages/chopper)
 [![Dart CI](https://github.com/lejard-h/chopper/workflows/Dart%20CI/badge.svg)](https://github.com/lejard-h/chopper/actions?query=workflow%3A%22Dart+CI%22)
@@ -37,12 +37,13 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="https://github.com/lejard-h"><img src="https://avatars.githubusercontent.com/u/7336262?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hadrien Lejard</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=lejard-h" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3Alejard-h" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=lejard-h" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=lejard-h" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://github.com/stewemetal"><img src="https://avatars.githubusercontent.com/u/5860632?v=4?s=100" width="100px;" alt=""/><br /><sub><b>István Juhos</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=stewemetal" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3Astewemetal" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=stewemetal" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=stewemetal" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/lejard-h"><img src="https://avatars.githubusercontent.com/u/7336262?v=4&s=100" width="100px;" alt=""/><br /><sub><b>Hadrien Lejard</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=lejard-h" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3Alejard-h" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=lejard-h" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=lejard-h" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/stewemetal"><img src="https://avatars.githubusercontent.com/u/5860632?v=4&s=100" width="100px;" alt=""/><br /><sub><b>István Juhos</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=stewemetal" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3Astewemetal" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=stewemetal" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=stewemetal" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/techouse"><img src="https://avatars.githubusercontent.com/u/1174328?v=4" width="100px;" alt=""/><br /><sub><b>Klemen Tusar</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=techouse" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3Atechouse" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=techouse" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=techouse" title="Documentation">📖</a></td>
-    <td align="center"><a href="https://www.upwork.com/freelancers/~01192eefd8a1c267f7"><img src="https://avatars.githubusercontent.com/u/231950?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ivan Terekhin</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=JEuler" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3AJEuler" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=JEuler" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=JEuler" title="Documentation">📖</a></td>
-    <td align="center"><a href="http://[email protected]"><img src="https://avatars.githubusercontent.com/u/3999503?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Eugeny Sampir</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=fryette" title="Code">💻</a></td>
-    <td align="center"><a href="https://github.com/Vovanella95"><img src="https://avatars.githubusercontent.com/u/11267533?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Uladzimir_Paliukhovich</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=Vovanella95" title="Code">💻</a></td>
+    <td align="center"><a href="https://www.upwork.com/freelancers/~01192eefd8a1c267f7"><img src="https://avatars.githubusercontent.com/u/231950?v=4&s=100" width="100px;" alt=""/><br /><sub><b>Ivan Terekhin</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=JEuler" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3AJEuler" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=JEuler" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=JEuler" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/Guldem"><img src="https://avatars.githubusercontent.com/u/11982796?v=4&s=100" width="100px;" alt=""/><br /><sub><b>Job Guldemeester</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=Guldem" title="Code">💻</a> <a href="https://github.com/lejard-h/chopper/pulls?q=is%3Apr+reviewed-by%3AGuldem" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/lejard-h/chopper/commits?author=Guldem" title="Tests">⚠️</a> <a href="https://github.com/lejard-h/chopper/commits?author=Guldem" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://[email protected]"><img src="https://avatars.githubusercontent.com/u/3999503?v=4&s=100" width="100px;" alt=""/><br /><sub><b>Eugeny Sampir</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=fryette" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/Vovanella95"><img src="https://avatars.githubusercontent.com/u/11267533?v=4&s=100" width="100px;" alt=""/><br /><sub><b>Uladzimir Paliukhovich</b></sub></a><br /><a href="https://github.com/lejard-h/chopper/commits?author=Vovanella95" title="Code">💻</a></td>
   </tr>
 </table>