Build Order Updates (#4855)

* Add new BuildLine model

- Represents an instance of a BOM item against a BuildOrder

* Create BuildLine instances automatically

When a new Build is created, automatically generate new BuildLine items

* Improve logic for handling exchange rate backends

* logic fixes

* Adds API endpoints

Add list and detail API endpoints for new BuildLine model

* update users/models.py

- Add new model to roles definition

* bulk-create on auto_allocate

Save database hits by performing a bulk-create

* Add skeleton data migration

* Create BuildLines for existing orders

* Working on building out BuildLine table

* Adds link for "BuildLine" to "BuildItem"

- A "BuildItem" will now be tracked against a BuildLine
- Not tracked directly against a build
- Not tracked directly against a BomItem
- Add schema migration
- Add data migration to update links

* Adjust migration 0045

- bom_item and build fields are about to be removed
- Set them to "nullable" so the data doesn't get removed

* Remove old fields from BuildItem model

- build fk
- bom_item fk
- A lot of other required changes too

* Update BuildLine.bom_item field

- Delete the BuildLine if the BomItem is removed
- This is closer to current behaviour

* Cleanup for Build model

- tracked_bom_items -> tracked_line_items
- untracked_bom_items -> tracked_bom_items
- remove build.can_complete
- move bom_item specific methods to the BuildLine model
- Cleanup / consolidation

* front-end work

- Update javascript
- Cleanup HTML templates

* Add serializer annotation and filtering

- Annotate 'allocated' quantity
- Filter by allocated / trackable / optional / consumable

* Make table sortable

* Add buttons

* Add callback for building new stock

* Fix Part annotation

* Adds callback to order parts

* Allocation works again

* template cleanup

* Fix allocate / unallocate actions

- Also turns out "unallocate" is not a word..

* auto-allocate works again

* Fix call to build.is_over_allocated

* Refactoring updates

* Bump API version

* Cleaner implementation of allocation sub-table

* Fix rendering in build output table

* Improvements to StockItem list API

- Refactor very old code
- Add option to include test results to queryset

* Add TODO for later me

* Fix for serializers.py

* Working on cleaner implementation of build output table

* Add function to determine if a single output is fully allocated

* Updates to build.js

- Button callbacks
- Table rendering

* Revert previous changes to build.serializers.py

* Fix for forms.js

* Rearrange code in build.js

* Rebuild "allocated lines" for output table

* Fix allocation calculation

* Show or hide column for tracked parts

* Improve debug messages

* Refactor "loadBuildLineTable"

- Allow it to also be used as output sub-table

* Refactor "completed tests" column

* Remove old javascript

- Cleans up a *lot* of crusty old code

* Annotate the available stock quantity to BuildLine serializer

- Similar pattern to BomItem serializer
- Needs refactoring in the future

* Update available column

* Fix build allocation table

- Bug fix
- Make pretty

* linting fixes

* Allow sorting by available stock

* Tweak for "required tests" column

* Bug fix for completing a build output

* Fix for consumable stock

* Fix for trim_allocated_stock

* Fix for creating new build

* Migration fix

- Ensure initial django_q migrations are applied
- Why on earth is this failing now?

* Catch exception

* Update for exception handling

* Update migrations

- Ensure inventreesetting is added

* Catch all exceptions when getting default currency code

* Bug fix for currency exchange rates update

* Working on unit tests

* Unit test fixes

* More work on unit tests

* Use bulk_create in unit test

* Update required quantity when a BuildOrder is saved

* Tweak overage display in BOM table

* Fix icon in BOM table

* Fix spelling error

* More unit test fixes

* Build reports

- Add line_items
- Update docs
- Cleanup

* Reimplement is_partially_allocated method

* Update docs about overage

* Unit testing for data migration

* Add "required_for_build_orders" annotation

- Makes API query *much* faster now
- remove old "required_parts_to_complete_build" method
- Cleanup part API filter code

* Adjust order of fixture loading

* Fix unit test

* Prevent "schedule_pricing_update" in unit tests

- Should cut down on DB hits significantly

* Unit test updates

* Improvements for unit test

- Don't hard-code pk values
- postgresql no likey

* Better unit test

docs/docs/build/allocate.md

@@ -82,9 +82,9 @@ Stock can be manually allocated to the build as required, using the *Allocate st
 
 Stock allocations can be manually adjusted or deleted using the action buttons available in each row of the allocation table.
 
-### Unallocate Stock
+### Deallocate Stock
 
-The *Unallocate Stock* button can be used to remove all allocations of untracked stock items against the build order.
+The *Deallocate Stock* button can be used to remove all allocations of untracked stock items against the build order.
 
 ## Automatic Stock Allocation
 

docs/docs/build/bom.md

@@ -23,12 +23,6 @@ A BOM for a particular assembly is comprised of a number (zero or more) of BOM "
 | Optional | A boolean field which indicates if this BOM Line Item is "optional" |
 | Note | Optional note field for additional information
 
-!!! missing "Overage"
-    While the overage field exists, it is currently non-functional and has no effect on BOM operation
-
-!!! missing "Optional"
-    The Optional field is currently for indication only - it does not serve a functional purpose (yet)
-
 ### Consumable BOM Line Items
 
 If a BOM line item is marked as *consumable*, this means that while the part and quantity information is tracked in the BOM, this line item does not get allocated to a [Build Order](./build.md). This may be useful for certain items that the user does not wish to track through the build process, as they may be low value, in abundant stock, or otherwise complicated to track.

docs/docs/build/build.md

@@ -26,7 +26,7 @@ To navigate to the Build Order display, select *Build* from the main navigation
 {% include "img.html" %}
 {% endwith %}
 
-#### Tree Vieww
+#### Tree View
 
 *Tree View* also provides a tabulated view of Build Orders. Orders are displayed in a hierarchical manner, showing any parent / child relationships between different build orders.
 

docs/docs/report/build.md

@@ -18,8 +18,11 @@ In addition to the default report context variables, the following context varia
 | --- | --- |
 | build | The build object the report is being generated against |
 | part | The [Part](./context_variables.md#part) object that the build references |
+| line_items | A shortcut for [build.line_items](#build) |
+| bom_items | A shortcut for [build.bom_items](#build) |
+| build_outputs | A shortcut for [build.build_outputs](#build) |
 | reference | The build order reference string |
-| quantity | Build order quantity |
+| quantity | Build order quantity (number of assemblies being built) |
 
 #### build
 
@@ -29,7 +32,9 @@ The following variables are accessed by build.variable
 | --- | --- |
 | active | Boolean that tells if the build is active |
 | batch | Batch code transferred to build parts (optional) |
-| bom_items | A query set with all BOM items for the build |
+| line_items | A query set with all the build line items associated with the build |
+| bom_items | A query set with all BOM items for the part being assembled |
+| build_outputs | A queryset containing all build output ([Stock Item](../stock/stock.md)) objects associated with this build |
 | can_complete | Boolean that tells if the build can be completed. Means: All material allocated and all parts have been build. |
 | are_untracked_parts_allocated | Boolean that tells if all bom_items have allocated stock_items. |
 | creation_date | Date where the build has been created |
@@ -42,7 +47,8 @@ The following variables are accessed by build.variable
 | notes | Text notes |
 | parent | Reference to a parent build object if this is a sub build |
 | part | The [Part](./context_variables.md#part) to be built (from component BOM items) |
-| quantity | Build order quantity |
+| quantity | Build order quantity (total number of assembly outputs) |
+| completed | The number out outputs which have been completed |
 | reference | Build order reference (required, must be unique) |
 | required_parts | A query set with all parts that are required for the build |
 | responsible | Owner responsible for completing the build. This can be a user or a group. Depending on that further context variables differ |
@@ -59,19 +65,38 @@ The following variables are accessed by build.variable
 As usual items in a query sets can be selected by adding a .n to the set e.g. build.required_parts.0
 will result in the first part of the list. Each query set has again its own context variables.
 
+#### line_items
+
+The `line_items` variable is a list of all build line items associated with the selected build. The following attributes are available for each individual line_item instance:
+
+| Attribute | Description |
+| --- | --- |
+| .build | A reference back to the parent build order |
+| .bom_item | A reference to the BOMItem which defines this line item |
+| .quantity | The required quantity which is to be allocated against this line item |
+| .part | A shortcut for .bom_item.sub_part |
+| .allocations | A list of BuildItem objects which allocate stock items against this line item |
+| .allocated_quantity | The total stock quantity which has been allocated against this line |
+| .unallocated_quantity | The remaining quantity to allocate |
+| .is_fully_allocated | Boolean value, returns True if the line item has sufficient stock allocated against it |
+| .is_overallocated | Boolean value, returns True if the line item has more allocated stock than is required |
+
 #### bom_items
 
-| Variable | Description |
+| Attribute | Description |
 | --- | --- |
 | .reference | The reference designators of the components |
-| .quantity | The number of components |
+| .quantity | The number of components required to build |
+| .overage | The extra amount required to assembly |
+| .consumable | Boolean field, True if this is a "consumable" part which is not tracked through builds |
 | .sub_part | The part at this position |
 | .substitutes.all | A query set with all allowed substitutes for that part |
+| .note | Extra text field which can contain additional information |
 
 
 #### allocated_stock.all
 
-| Variable | Description |
+| Attribute | Description |
 | --- | --- |
 | .bom_item | The bom item where this part belongs to |
 | .stock_item | The allocated [StockItem](./context_variables.md#stockitem) |