Skip to content

Commit

Permalink
[IMP] fieldservice_stage_validation: pre-commit auto fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
peluko00 committed Apr 18, 2024
1 parent 85eda03 commit 670032d
Show file tree
Hide file tree
Showing 12 changed files with 49 additions and 50 deletions.
44 changes: 22 additions & 22 deletions fieldservice_stage_validation/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,27 @@ FSM Stage Validation
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Ffield--service-lightgray.png?logo=github
:target: https://github.com/OCA/field-service/tree/16.0/fieldservice_stage_validation
:target: https://github.com/OCA/field-service/tree/17.0/fieldservice_stage_validation
:alt: OCA/field-service
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/field-service-16-0/field-service-16-0-fieldservice_stage_validation
:target: https://translation.odoo-community.org/projects/field-service-17-0/field-service-17-0-fieldservice_stage_validation
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/field-service&target_branch=16.0
:target: https://runboat.odoo-community.org/builds?repo=OCA/field-service&target_branch=17.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

As the stage of a field service document progresses, it may be important for
specific fields of the document be completed.
As the stage of a field service document progresses, it may be important
for specific fields of the document be completed.

For example, when a field service order enters the 'Complete' stage, the
fields for 'Actual End Date' and/or 'Resolution Notes' should be set.

This module allows you to raise a Validation Error if the designated fields
are not set when moving to a new stage. Since stages can be used for field
service orders, workers, locations, or equipments, this logic is available
to be applied to each document type.
This module allows you to raise a Validation Error if the designated
fields are not set when moving to a new stage. Since stages can be used
for field service orders, workers, locations, or equipments, this logic
is available to be applied to each document type.

**Table of contents**

Expand All @@ -47,48 +47,48 @@ to be applied to each document type.
Configuration
=============

* Go to Field Service > Configuration > Stages
* Create or select a stage
* Select one or more fields to be validated
- Go to Field Service > Configuration > Stages
- Create or select a stage
- Select one or more fields to be validated

Usage
=====

* Follow steps outlined in Configuration.
* User will receive validation error if a field is not set when
attempting to move to a new stage.
- Follow steps outlined in Configuration.
- User will receive validation error if a field is not set when
attempting to move to a new stage.

Known issues / Roadmap
======================

The roadmap of the Field Service application is documented on
`Github <https://github.com/OCA/field-service/issues/1>`_.
`Github <https://github.com/OCA/field-service/issues/1>`__.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/field-service/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/field-service/issues/new?body=module:%20fieldservice_stage_validation%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/field-service/issues/new?body=module:%20fieldservice_stage_validation%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
~~~~~~~
-------

* Brian McMaster

Contributors
~~~~~~~~~~~~
------------

* Brian McMaster <[email protected]>
- Brian McMaster <[email protected]>

Maintainers
~~~~~~~~~~~
-----------

This module is maintained by the OCA.

Expand All @@ -111,6 +111,6 @@ Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:

|maintainer-brian10048| |maintainer-max3903|

This module is part of the `OCA/field-service <https://github.com/OCA/field-service/tree/16.0/fieldservice_stage_validation>`_ project on GitHub.
This module is part of the `OCA/field-service <https://github.com/OCA/field-service/tree/17.0/fieldservice_stage_validation>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions fieldservice_stage_validation/pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[build-system]
requires = ["whool"]
build-backend = "whool.buildapi"
3 changes: 3 additions & 0 deletions fieldservice_stage_validation/readme/CONFIGURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Go to Field Service \> Configuration \> Stages
- Create or select a stage
- Select one or more fields to be validated
3 changes: 0 additions & 3 deletions fieldservice_stage_validation/readme/CONFIGURE.rst

This file was deleted.

1 change: 1 addition & 0 deletions fieldservice_stage_validation/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Brian McMaster \<<[email protected]>\>
1 change: 0 additions & 1 deletion fieldservice_stage_validation/readme/CONTRIBUTORS.rst

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
As the stage of a field service document progresses, it may be important for
specific fields of the document be completed.
As the stage of a field service document progresses, it may be important
for specific fields of the document be completed.

For example, when a field service order enters the 'Complete' stage, the
fields for 'Actual End Date' and/or 'Resolution Notes' should be set.

This module allows you to raise a Validation Error if the designated fields
are not set when moving to a new stage. Since stages can be used for field
service orders, workers, locations, or equipments, this logic is available
to be applied to each document type.
This module allows you to raise a Validation Error if the designated
fields are not set when moving to a new stage. Since stages can be used
for field service orders, workers, locations, or equipments, this logic
is available to be applied to each document type.
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
The roadmap of the Field Service application is documented on
`Github <https://github.com/OCA/field-service/issues/1>`_.
[Github](https://github.com/OCA/field-service/issues/1).
3 changes: 3 additions & 0 deletions fieldservice_stage_validation/readme/USAGE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- Follow steps outlined in Configuration.
- User will receive validation error if a field is not set when
attempting to move to a new stage.
3 changes: 0 additions & 3 deletions fieldservice_stage_validation/readme/USAGE.rst

This file was deleted.

18 changes: 9 additions & 9 deletions fieldservice_stage_validation/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -369,15 +369,15 @@ <h1 class="title">FSM Stage Validation</h1>
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:9b151ff66d87078952dbeea942b63732c5f353f6b4a6177b5121eceee261f2a0
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/field-service/tree/16.0/fieldservice_stage_validation"><img alt="OCA/field-service" src="https://img.shields.io/badge/github-OCA%2Ffield--service-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/field-service-16-0/field-service-16-0-fieldservice_stage_validation"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/field-service&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>As the stage of a field service document progresses, it may be important for
specific fields of the document be completed.</p>
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/field-service/tree/17.0/fieldservice_stage_validation"><img alt="OCA/field-service" src="https://img.shields.io/badge/github-OCA%2Ffield--service-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/field-service-17-0/field-service-17-0-fieldservice_stage_validation"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/field-service&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>As the stage of a field service document progresses, it may be important
for specific fields of the document be completed.</p>
<p>For example, when a field service order enters the ‘Complete’ stage, the
fields for ‘Actual End Date’ and/or ‘Resolution Notes’ should be set.</p>
<p>This module allows you to raise a Validation Error if the designated fields
are not set when moving to a new stage. Since stages can be used for field
service orders, workers, locations, or equipments, this logic is available
to be applied to each document type.</p>
<p>This module allows you to raise a Validation Error if the designated
fields are not set when moving to a new stage. Since stages can be used
for field service orders, workers, locations, or equipments, this logic
is available to be applied to each document type.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
Expand Down Expand Up @@ -419,7 +419,7 @@ <h1><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/field-service/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/field-service/issues/new?body=module:%20fieldservice_stage_validation%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/field-service/issues/new?body=module:%20fieldservice_stage_validation%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
Expand All @@ -445,7 +445,7 @@ <h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
promote its widespread use.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainers</a>:</p>
<p><a class="reference external image-reference" href="https://github.com/brian10048"><img alt="brian10048" src="https://github.com/brian10048.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/max3903"><img alt="max3903" src="https://github.com/max3903.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/field-service/tree/16.0/fieldservice_stage_validation">OCA/field-service</a> project on GitHub.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/field-service/tree/17.0/fieldservice_stage_validation">OCA/field-service</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,13 +137,9 @@ def setUpClass(cls):
def get_validate_message(self, stage):
stage_name = stage.name
field_name = fields.first(stage.validate_field_ids).name
return 'Cannot move to stage "%s" until the "%s" field is set.' % (
stage_name,
field_name,
)
return f"Cannot move to stage {stage_name} until the {field_name} field is set."

def test_fsm_stage_validation(self):

# Validate the stage computes the correct model type
self.assertEqual(
self.stage_order.stage_type_model_id,
Expand Down

0 comments on commit 670032d

Please sign in to comment.