From 8690e9aa0790ee2867da852b2c3e157a90bc88f7 Mon Sep 17 00:00:00 2001 From: Maxime Richez Date: Tue, 22 Sep 2026 11:13:55 +0200 Subject: [PATCH] Add stock_conversion module Closes #14806 --- .gitlab-ci-modules.yml | 17 + doc/stock.rst | 3 + modules/stock_conversion/CHANGELOG | 1 + modules/stock_conversion/COPYRIGHT | 17 + modules/stock_conversion/LICENSE | 674 ++++++++++++++++++ modules/stock_conversion/README.rst | 1 + modules/stock_conversion/__init__.py | 2 + modules/stock_conversion/doc/conf.py | 111 +++ modules/stock_conversion/doc/design.rst | 76 ++ modules/stock_conversion/doc/index.rst | 11 + modules/stock_conversion/doc/releases.rst | 7 + .../stock_conversion/doc/requirements-doc.txt | 3 + modules/stock_conversion/exceptions.py | 8 + modules/stock_conversion/ir.py | 16 + modules/stock_conversion/message.xml | 16 + modules/stock_conversion/product.py | 19 + modules/stock_conversion/product.xml | 12 + modules/stock_conversion/pyproject.toml | 59 ++ modules/stock_conversion/stock.py | 618 ++++++++++++++++ modules/stock_conversion/stock.xml | 164 +++++ modules/stock_conversion/tests/__init__.py | 2 + .../tests/scenario_stock_conversion.rst | 133 ++++ modules/stock_conversion/tests/test_module.py | 11 + .../stock_conversion/tests/test_scenario.py | 8 + modules/stock_conversion/tox.ini | 24 + modules/stock_conversion/tryton.cfg | 21 + .../stock_conversion/view/product_form.xml | 10 + .../view/stock_configuration_form.xml | 10 + .../view/stock_conversion_form.xml | 49 ++ .../view/stock_conversion_list.xml | 15 + .../view/stock_conversion_rule_form.xml | 14 + .../view/stock_conversion_rule_list.xml | 9 + .../view/stock_location_form.xml | 10 + modules/stock_lot/stock.py | 50 ++ modules/stock_lot/stock.xml | 13 + .../tests/scenario_stock_lot_conversion.rst | 99 +++ modules/stock_lot/tests/test_module.py | 2 +- modules/stock_lot/tryton.cfg | 5 + .../stock_lot/view/stock_conversion_form.xml | 14 + .../stock_lot/view/stock_conversion_list.xml | 11 + 40 files changed, 2344 insertions(+), 1 deletion(-) create mode 100644 modules/stock_conversion/CHANGELOG create mode 100644 modules/stock_conversion/COPYRIGHT create mode 100644 modules/stock_conversion/LICENSE create mode 120000 modules/stock_conversion/README.rst create mode 100644 modules/stock_conversion/__init__.py create mode 100644 modules/stock_conversion/doc/conf.py create mode 100644 modules/stock_conversion/doc/design.rst create mode 100644 modules/stock_conversion/doc/index.rst create mode 100644 modules/stock_conversion/doc/releases.rst create mode 100644 modules/stock_conversion/doc/requirements-doc.txt create mode 100644 modules/stock_conversion/exceptions.py create mode 100644 modules/stock_conversion/ir.py create mode 100644 modules/stock_conversion/message.xml create mode 100644 modules/stock_conversion/product.py create mode 100644 modules/stock_conversion/product.xml create mode 100644 modules/stock_conversion/pyproject.toml create mode 100644 modules/stock_conversion/stock.py create mode 100644 modules/stock_conversion/stock.xml create mode 100644 modules/stock_conversion/tests/__init__.py create mode 100644 modules/stock_conversion/tests/scenario_stock_conversion.rst create mode 100644 modules/stock_conversion/tests/test_module.py create mode 100644 modules/stock_conversion/tests/test_scenario.py create mode 100644 modules/stock_conversion/tox.ini create mode 100644 modules/stock_conversion/tryton.cfg create mode 100644 modules/stock_conversion/view/product_form.xml create mode 100644 modules/stock_conversion/view/stock_configuration_form.xml create mode 100644 modules/stock_conversion/view/stock_conversion_form.xml create mode 100644 modules/stock_conversion/view/stock_conversion_list.xml create mode 100644 modules/stock_conversion/view/stock_conversion_rule_form.xml create mode 100644 modules/stock_conversion/view/stock_conversion_rule_list.xml create mode 100644 modules/stock_conversion/view/stock_location_form.xml create mode 100644 modules/stock_lot/tests/scenario_stock_lot_conversion.rst create mode 100644 modules/stock_lot/view/stock_conversion_form.xml create mode 100644 modules/stock_lot/view/stock_conversion_list.xml diff --git a/.gitlab-ci-modules.yml b/.gitlab-ci-modules.yml index 07c870f37a..954e03f119 100644 --- a/.gitlab-ci-modules.yml +++ b/.gitlab-ci-modules.yml @@ -3048,6 +3048,23 @@ test-modules-stock_consignment-postgresql: PACKAGE: modules/stock_consignment TAG_PATTERN: '/^stock_consignment-.*/' +check-doc-modules-stock_conversion: + extends: .check-doc + variables: + PACKAGE: modules/stock_conversion + +test-modules-stock_conversion-sqlite: + extends: .test-sqlite + variables: + PACKAGE: modules/stock_conversion + TAG_PATTERN: '/^stock_conversion-.*/' + +test-modules-stock_conversion-postgresql: + extends: .test-postgresql + variables: + PACKAGE: modules/stock_conversion + TAG_PATTERN: '/^stock_conversion-.*/' + check-doc-modules-stock_ethanol: extends: .check-doc variables: diff --git a/doc/stock.rst b/doc/stock.rst index 9460530747..ee907977f0 100644 --- a/doc/stock.rst +++ b/doc/stock.rst @@ -14,6 +14,9 @@ Stock :doc:`Consignment ` Manage consignment stock from supplier or at customer warehouse. +:doc:`Conversion ` + Transform one product into another. + :doc:`Ethanol ` Track ethanol in stock. diff --git a/modules/stock_conversion/CHANGELOG b/modules/stock_conversion/CHANGELOG new file mode 100644 index 0000000000..f8a032f215 --- /dev/null +++ b/modules/stock_conversion/CHANGELOG @@ -0,0 +1 @@ +Initial release diff --git a/modules/stock_conversion/COPYRIGHT b/modules/stock_conversion/COPYRIGHT new file mode 100644 index 0000000000..1cc83d192f --- /dev/null +++ b/modules/stock_conversion/COPYRIGHT @@ -0,0 +1,17 @@ +Copyright (C) 2026 B2CK SRL +Copyright (C) 2026 Cédric Krier +Copyright (C) 2026 Maxime Richez +Copyright (C) 2026 SALUC SA + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . diff --git a/modules/stock_conversion/LICENSE b/modules/stock_conversion/LICENSE new file mode 100644 index 0000000000..94a9ed024d --- /dev/null +++ b/modules/stock_conversion/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/modules/stock_conversion/README.rst b/modules/stock_conversion/README.rst new file mode 120000 index 0000000000..176d9c2695 --- /dev/null +++ b/modules/stock_conversion/README.rst @@ -0,0 +1 @@ +doc/index.rst \ No newline at end of file diff --git a/modules/stock_conversion/__init__.py b/modules/stock_conversion/__init__.py new file mode 100644 index 0000000000..4effdfa4a2 --- /dev/null +++ b/modules/stock_conversion/__init__.py @@ -0,0 +1,2 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. diff --git a/modules/stock_conversion/doc/conf.py b/modules/stock_conversion/doc/conf.py new file mode 100644 index 0000000000..113ef99f15 --- /dev/null +++ b/modules/stock_conversion/doc/conf.py @@ -0,0 +1,111 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +import os + +base_url = os.environ.get('DOC_BASE_URL') +if base_url: + modules_url = base_url + '/modules-{module}/' + trytond_url = base_url + '/server/' +else: + modules_url = ( + 'https://docs.tryton.org/{series}/modules-{module}/') + trytond_url = 'https://docs.tryton.org/{series}/server/' + + +def get_info(): + import configparser + import json + import subprocess + + module_dir = os.path.dirname(os.path.dirname(__file__)) + + config = configparser.ConfigParser() + config.read_file(open(os.path.join(module_dir, 'tryton.cfg'))) + info = dict(config.items('tryton')) + + metadata_cmd = 'python3 -m build -qq --metadata' + if os.environ.get('DOC_NO_ISOLATION'): + metadata_cmd += ' --no-isolation' + metadata = subprocess.check_output( + metadata_cmd, shell=True, encoding='utf-8', cwd=module_dir).strip() + metadata = json.loads(metadata) + info['name'] = metadata['name'] + info['description'] = metadata['summary'] + major_version, minor_version, _ = metadata['version'].split('.', 2) + major_version = int(major_version) + minor_version = int(minor_version) + if minor_version % 2: + info['series'] = 'latest' + info['branch'] = 'branch/default' + else: + info['series'] = '.'.join(metadata['version'].split('.', 2)[:2]) + info['branch'] = 'branch/' + info['series'] + + for key in {'depends', 'extras_depend'}: + info[key] = info.get(key, '').strip().splitlines() + info['modules'] = set(info['depends'] + info['extras_depend']) + info['modules'] -= {'ir', 'res'} + + return info + + +info = get_info() + +html_theme = 'sphinx_book_theme' +html_theme_options = { + 'logo': { + 'alt_text': "Tryton Documentation", + 'image_light': 'https://docs.tryton.org/logo-light.svg', + 'image_dark': 'https://docs.tryton.org/logo-dark.svg', + 'link': base_url, + }, + 'home_page_in_toc': True, + 'repository_provider': 'gitlab', + 'repository_url': 'https://code.tryton.org/tryton', + 'repository_branch': info['branch'], + 'use_source_button': True, + 'use_edit_page_button': True, + 'use_repository_button': True, + 'use_download_button': False, + 'path_to_docs': 'modules/stock_conversion/doc', + } +html_title = info['description'] +master_doc = 'index' +project = info['name'] +release = version = info['series'] +default_role = 'ref' +highlight_language = 'none' +exclude_patterns = ['**/*.inc.rst'] +extensions = [ + 'sphinx_copybutton', + 'sphinx.ext.intersphinx', + ] +intersphinx_mapping = { + 'trytond': (trytond_url.format(series=version), None), + } +intersphinx_mapping.update({ + m: (modules_url.format( + module=m.replace('_', '-'), series=version), None) + for m in info['modules'] + }) +linkcheck_ignore = [r'/.*', r'https://demo.tryton.org/*'] +linkcheck_request_headers = { + 'User-Agent': ( + 'TrytonBot/0.0 (https://www.tryton.org/foundation) ' + 'sphinx-linkcheck/0.0'), + 'Accept-Encoding': 'gzip', + } +linkcheck_workers = 1 + +try: + with open(os.path.join( + os.path.dirname(__file__), + 'linkcheck_ignore.json'), 'r') as f: + import json + linkcheck_ignore.extend(json.load(f)) + del json +except FileNotFoundError: + pass + +del get_info, info, base_url, modules_url, trytond_url diff --git a/modules/stock_conversion/doc/design.rst b/modules/stock_conversion/doc/design.rst new file mode 100644 index 0000000000..63226afe39 --- /dev/null +++ b/modules/stock_conversion/doc/design.rst @@ -0,0 +1,76 @@ +****** +Design +****** + +The *Stock Conversion Module* introduces or extends the following concepts. + +.. _model-stock.conversion.rule: + +Conversion Rule +=============== + +A conversion rule specifies the process by which one `Product +` can be converted into another. + + +.. _model-stock.conversion: + +Conversion +========== + +A *Conversion* is an order to instantly transform a specific quantity of a +`Product ` in place into another product. +The resulting quantity is calculated using the corresponding `Rule +`. + +.. seealso:: + + The conversions can be found using the main menu item: + + |Inventory & Stock --> Conversions|__ + + .. |Inventory & Stock --> Conversions| replace:: :menuselection:`Inventory & Stock --> Conversions` + __ https://demo.tryton.org/model/stock.conversion + +.. _model-stock.configuration: + +Configuration +============= + +When the *Stock Conversion Module* is activated, the configuration gains a +property to store the sequence used to number the `Conversions +`. + +.. seealso:: + + The `Configuration ` concept is + introduced by the :doc:`Stock Module `. + +.. _model-stock.location: + +Location +======== + +When the *Stock Conversion Module* is activated, warehouses gain an extra +location property for :guilabel:`Conversion` which is used as the default value +when converting products. + +.. seealso:: + + The `Location ` concept is introduced by the + :doc:`Stock Module `. + +.. _model-product.product: + +Product +======= + +When the *Stock Conversion Module* is activated, products gain an additional +property in the form of a list of `Conversion Rules +` which defines the products to which they can be +converted. + +.. seealso:: + + The `Product ` concept is introduced by the + :doc:`Product Module `. diff --git a/modules/stock_conversion/doc/index.rst b/modules/stock_conversion/doc/index.rst new file mode 100644 index 0000000000..af4dbe6673 --- /dev/null +++ b/modules/stock_conversion/doc/index.rst @@ -0,0 +1,11 @@ +####################### +Stock Conversion Module +####################### + +The *Stock Conversion Module* transforms one product into another with ease. + +.. toctree:: + :maxdepth: 2 + + design + releases diff --git a/modules/stock_conversion/doc/releases.rst b/modules/stock_conversion/doc/releases.rst new file mode 100644 index 0000000000..21b13c4745 --- /dev/null +++ b/modules/stock_conversion/doc/releases.rst @@ -0,0 +1,7 @@ +.. _releases-index: + +============= +Release notes +============= + +.. include:: ../CHANGELOG diff --git a/modules/stock_conversion/doc/requirements-doc.txt b/modules/stock_conversion/doc/requirements-doc.txt new file mode 100644 index 0000000000..06b8565f6b --- /dev/null +++ b/modules/stock_conversion/doc/requirements-doc.txt @@ -0,0 +1,3 @@ +build +sphinx_book_theme +sphinx_copybutton diff --git a/modules/stock_conversion/exceptions.py b/modules/stock_conversion/exceptions.py new file mode 100644 index 0000000000..94b5d97fc3 --- /dev/null +++ b/modules/stock_conversion/exceptions.py @@ -0,0 +1,8 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +from trytond.exceptions import UserError + + +class ConversionError(UserError): + pass diff --git a/modules/stock_conversion/ir.py b/modules/stock_conversion/ir.py new file mode 100644 index 0000000000..e2182b4e6c --- /dev/null +++ b/modules/stock_conversion/ir.py @@ -0,0 +1,16 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +from trytond.pool import PoolMeta + + +class Cron(metaclass=PoolMeta): + __name__ = 'ir.cron' + + @classmethod + def __setup__(cls): + super().__setup__() + cls.method.selection.extend([ + ('stock.conversion|set_cost_from_moves', + "Set Cost from Conversion Moves"), + ]) diff --git a/modules/stock_conversion/message.xml b/modules/stock_conversion/message.xml new file mode 100644 index 0000000000..adcf3d8082 --- /dev/null +++ b/modules/stock_conversion/message.xml @@ -0,0 +1,16 @@ + + + + + + The output of each conversion must be unique for each input. + + + You cannot process conversion "%(conversion)s" because location "%(location)s" is missing %(quantity)s of product "%(product)s" + + + You cannot change the products nor the quantities of a conversion rule which is already used in a conversion. + + + diff --git a/modules/stock_conversion/product.py b/modules/stock_conversion/product.py new file mode 100644 index 0000000000..5adbce42af --- /dev/null +++ b/modules/stock_conversion/product.py @@ -0,0 +1,19 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +from trytond.model import fields +from trytond.pool import PoolMeta +from trytond.pyson import Eval + + +class Product(metaclass=PoolMeta): + __name__ = 'product.product' + + conversion_rules = fields.One2Many( + 'stock.conversion.rule', 'input_product', "Conversion Rules", + states={ + 'invisible': Eval('type') != 'goods', + }) + reverse_conversion_rules = fields.One2Many( + 'stock.conversion.rule', 'output_product', "Reverse Conversion Rules", + readonly=True) diff --git a/modules/stock_conversion/product.xml b/modules/stock_conversion/product.xml new file mode 100644 index 0000000000..db4a307dda --- /dev/null +++ b/modules/stock_conversion/product.xml @@ -0,0 +1,12 @@ + + + + + + product.product + + product_form + + + diff --git a/modules/stock_conversion/pyproject.toml b/modules/stock_conversion/pyproject.toml new file mode 100644 index 0000000000..44bce3edb9 --- /dev/null +++ b/modules/stock_conversion/pyproject.toml @@ -0,0 +1,59 @@ +[build-system] +requires = ['hatchling >= 1', 'hatch-tryton'] +build-backend = 'hatchling.build' + +[project] +name = 'trytond_stock_conversion' +dynamic = ['version', 'dependencies', 'optional-dependencies', 'authors', 'readme'] +requires-python = '>=3.10' +maintainers = [ + {name = "Tryton", email = "foundation@tryton.org"}, + ] +description = "Goods conversion for Tryton" +license = 'GPL-3.0-or-later' +license-files = ['LICENSE', 'icons/LICENSE', 'COPYRIGHT'] +keywords = ["tryton", "stock"] +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Environment :: Plugins", + "Framework :: Tryton", + "Topic :: Office/Business", + "Topic :: Software Development :: Libraries :: Python Modules", + ] + +[project.entry-points.'trytond.modules'] +stock_conversion = 'trytond.modules.stock_conversion' + +[project.urls] +homepage = "https://www.tryton.org/" +documentation = "https://docs.tryton.org/modules-stock-conversion/" +changelog = "https://docs.tryton.org/modules-stock-conversion/releases.html" +forum = "https://www.tryton.org/forum" +issues = "https://bugs.tryton.org/tryton" +repository = "https://code.tryton.org/tryton" +funding = "https://www.tryton.org/donate" + +[tool.hatch.build] +include = [ + '**/tryton.cfg', + '**/*.py', + '**/*.xml', + 'view/**/*.xml', + 'locale/**/*.po', + '**/*.fodt', + 'icons/**/*.svg', + 'tests/**/*.rst', + 'tests/**/*.json', + ] +exclude = ['doc'] + +[tool.hatch.build.targets.wheel.sources] +"" = "trytond/modules/stock_conversion" + +[tool.hatch.metadata.hooks.tryton] +dependencies = [] +copyright = 'COPYRIGHT' +readme = 'README.rst' + +[tool.hatch.metadata.hooks.tryton.tryton-optional-dependencies] +test = ['proteus'] diff --git a/modules/stock_conversion/stock.py b/modules/stock_conversion/stock.py new file mode 100644 index 0000000000..9f3ca560e1 --- /dev/null +++ b/modules/stock_conversion/stock.py @@ -0,0 +1,618 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +from decimal import Decimal +from itertools import groupby + +from sql import Literal, Null +from sql.functions import CharLength +from sql.operators import Equal + +from trytond.i18n import gettext +from trytond.model import ( + DeactivableMixin, Exclude, ModelSQL, ModelView, Workflow, fields) +from trytond.model.exceptions import AccessError +from trytond.modules.company.model import employee_field, set_employee +from trytond.modules.product import round_price +from trytond.pool import Pool, PoolMeta +from trytond.pyson import Eval, Id, If +from trytond.transaction import Transaction + +from .exceptions import ConversionError + + +class Configuration(metaclass=PoolMeta): + __name__ = 'stock.configuration' + + conversion_sequence = fields.MultiValue(fields.Many2One( + 'ir.sequence', "Conversion Sequence", required=True, + domain=[ + ('company', 'in', + [Eval('context', {}).get('company', -1), None]), + ('sequence_type', '=', + Id('stock_conversion', 'sequence_type_conversion')), + ], + help="Used to generate the number given to conversion.")) + + @classmethod + def multivalue_model(cls, field): + pool = Pool() + if field == 'conversion_sequence': + return pool.get('stock.configuration.sequence') + return super().multivalue_model(field) + + @classmethod + def default_conversion_sequence(cls, **pattern): + return cls.multivalue_model( + 'conversion_sequence').default_conversion_sequence() + + +class ConfigurationSequence(metaclass=PoolMeta): + __name__ = 'stock.configuration.sequence' + + conversion_sequence = fields.Many2One( + 'ir.sequence', "Conversion Sequence", required=True, + domain=[ + ('company', 'in', [Eval('company', -1), None]), + ('sequence_type', '=', + Id('stock_conversion', 'sequence_type_conversion')), + ]) + + @classmethod + def default_conversion_sequence(cls): + pool = Pool() + ModelData = pool.get('ir.model.data') + try: + return ModelData.get_id('stock_conversion', 'sequence_conversion') + except KeyError: + return None + + +class Location(metaclass=PoolMeta): + __name__ = 'stock.location' + + conversion_location = fields.Many2One( + 'stock.location', "Conversion", + states={ + 'invisible': Eval('type') != 'warehouse', + 'required': Eval('type') == 'warehouse', + }, + domain=[ + ('type', '=', 'production'), + ], + help="Used to convert goods.") + + +class StockConversionRule(DeactivableMixin, ModelSQL, ModelView): + __name__ = 'stock.conversion.rule' + + input_product = fields.Many2One( + 'product.product', "Input Product", + required=True, ondelete='CASCADE', + domain=[ + ('type', '=', 'goods'), + ('id', '!=', Eval('output_product', -1)), + ]) + input_quantity = fields.Float( + "Input Quantity", digits='input_unit', required=True, + domain=[ + ('input_quantity', '>', 0), + ]) + input_unit = fields.Function( + fields.Many2One('product.uom', "Input Unit"), + 'on_change_with_input_unit') + output_product = fields.Many2One( + 'product.product', "Output Product", + required=True, ondelete='RESTRICT', + domain=[ + ('type', 'in', ['goods', 'assets']), + ('id', '!=', Eval('input_product', -1)), + ]) + output_quantity = fields.Float( + "Output Quantity", digits='output_unit', required=True, + domain=[ + ('output_quantity', '>', 0), + ]) + output_unit = fields.Function( + fields.Many2One('product.uom', "Output Unit"), + 'on_change_with_output_unit') + + @classmethod + def __setup__(cls): + super().__setup__() + t = cls.__table__() + cls._sql_constraints = [ + ('input_output_unique', + Exclude(t, + (t.input_product, Equal), + (t.output_product, Equal), + where=(t.active == Literal(True))), + 'stock_conversion.msg_conversion_rule_input_output_unique'), + ] + + @classmethod + def default_input_quantity(cls): + return 1 + + @classmethod + def default_output_quantity(cls): + return 1 + + @fields.depends('input_product', '_parent_input_product.default_uom') + def on_change_with_input_unit(self, name=None): + return self.input_product.default_uom if self.input_product else None + + @fields.depends('output_product', '_parent_output_product.default_uom') + def on_change_with_output_unit(self, name=None): + return self.output_product.default_uom if self.output_product else None + + def get_rec_name(self, name): + return ( + f"{self.input_product.rec_name} " + "\N{black rightwards arrow} " + f"{self.output_product.rec_name}") + + @classmethod + def search_rec_name(cls, name, clause): + _, operator, operand, *extra = clause + if operator.startswith('!') or operator.startswith('not '): + bool_op = 'AND' + else: + bool_op = 'OR' + return [bool_op, + ('input_product', operator, operand, *extra), + ('output_product', operator, operand, *extra), + ] + + @classmethod + def check_modification(cls, mode, rules, values=None, external=False): + pool = Pool() + StockConversion = pool.get('stock.conversion') + super().check_modification( + mode, rules, values=values, external=external) + if mode == 'write': + if values.keys() & { + 'input_product', 'input_quantity', + 'output_product', 'output_quantity'}: + conversions = StockConversion.search([ + ('conversion_rule', 'in', [r.id for r in rules]), + ], + limit=1, order=[]) + if conversions: + raise AccessError(gettext( + 'stock_conversion.' + 'msg_conversion_rule_change_product_quantity')) + + def convert(self, quantity): + return self.output_unit.floor( + quantity * self.output_quantity / self.input_quantity) + + +class StockConversion(Workflow, ModelSQL, ModelView): + __name__ = 'stock.conversion' + _rec_name = 'number' + + number = fields.Char("Number", required=True, readonly=True) + date = fields.Date("Date", + states={ + 'readonly': Eval('state') != 'draft', + 'required': Eval('state') == 'done', + }) + company = fields.Many2One('company.company', "Company", required=True, + states={ + 'readonly': Eval('state') != 'draft', + }) + warehouse = fields.Many2One( + 'stock.location', "Warehouse", required=True, + domain=[ + ('type', '=', 'warehouse'), + ], + states={ + 'readonly': Eval('state') != 'draft', + }) + location = fields.Many2One( + 'stock.location', "Location", required=True, + domain=[ + ('type', '=', 'storage'), + ('parent', 'child_of', [Eval('warehouse', -1)]), + ], + states={ + 'readonly': Eval('state') != 'draft', + }) + + input_product = fields.Many2One( + 'product.product', "Input Product", required=True, + ondelete='CASCADE', + domain=[ + If((Eval('state') == 'draft') & Eval('output_product', None), + ('conversion_rules.output_product', + '=', Eval('output_product', -1)), + ()), + ('type', '=', 'goods'), + ('id', '!=', Eval('output_product', -1)), + ], + states={ + 'readonly': Eval('state') != 'draft', + }, + context={ + 'company': Eval('company', -1), + }, + depends={'company'}) + input_unit = fields.Function( + fields.Many2One('product.uom', "Input Unit"), + 'on_change_with_input_unit') + input_quantity = fields.Float( + "Input Quantity", digits='input_unit', required=True, + domain=[ + ('input_quantity', '>', 0), + ], + states={ + 'readonly': Eval('state') != 'draft', + }) + conversion_rule = fields.Many2One( + 'stock.conversion.rule', "Conversion Rule", + required=True, ondelete='RESTRICT', + domain=[ + If(Eval('input_product', None), + ('input_product', '=', Eval('input_product', -1)), + ()), + If(Eval('output_product', None), + ('output_product', '=', Eval('output_product', -1)), + ()), + ], + states={ + 'readonly': Eval('state') != 'draft', + }) + output_product = fields.Many2One( + 'product.product', "Output Product", required=True, + domain=[ + If((Eval('state') == 'draft') & Eval('input_product', None), + ('reverse_conversion_rules.input_product', + '=', Eval('input_product', -1)), + ()), + ('type', 'in', ['goods', 'assets']), + ('id', '!=', Eval('input_product', -1)), + ], + context={ + 'company': Eval('company', -1), + }, + depends={'company'}) + output_quantity = fields.Function( + fields.Float("Output Quantity", digits='output_unit'), + 'on_change_with_output_quantity') + output_unit = fields.Function( + fields.Many2One('product.uom', "Output Unit"), + 'on_change_with_output_unit') + + moves = fields.One2Many( + 'stock.move', 'origin', "Moves", readonly=True, + domain=['OR', + [ + ('product', '=', Eval('input_product', -1)), + ('from_location', '=', Eval('location', -1)), + ('to_location.type', '=', 'production'), + ], + [ + ('product', '=', Eval('output_product', -1)), + ('from_location.type', '=', 'production'), + ('to_location', '=', Eval('location', -1)), + ] + ], + states={ + 'invisible': ~Eval('moves', None), + }) + + done_by = employee_field("Done By") + state = fields.Selection([ + ('draft', 'Draft'), + ('done', 'Done'), + ('cancelled', 'Cancelled'), + ], "State", readonly=True, sort=False) + + @classmethod + def __setup__(cls): + cls.number.search_unaccented = False + super().__setup__() + cls._order = [ + ('date', 'DESC NULLS FIRST'), + ('id', 'DESC'), + ] + cls._transitions |= set(( + ('draft', 'cancelled'), + ('draft', 'done'), + ('done', 'cancelled'), + )) + cls._buttons.update({ + 'cancel': { + 'invisible': ( + (Eval('state') == 'cancelled') + | ((Eval('state') == 'done') + & ~Id('stock', + 'group_stock_cancellation').in_( + Eval('context', {}).get('groups', [])) + & ~Eval('context', {}).get( + 'administrator', False))), + 'depends': ['state'], + }, + 'do': { + 'invisible': Eval('state') != 'draft', + 'depends': ['state'], + }, + }) + + @classmethod + def order_number(cls, tables): + table, _ = tables[None] + return [ + ~((table.state == 'cancelled') & (table.number == Null)), + CharLength(table.number), table.number] + + @classmethod + def default_date(cls): + return Pool().get('ir.date').today() + + @classmethod + def default_company(cls): + return Transaction().context.get('company') + + @classmethod + def default_warehouse(cls): + Location = Pool().get('stock.location') + return Location.get_default_warehouse() + + @fields.depends('input_product') + def on_change_with_input_unit(self, name=None): + if self.input_product: + return self.input_product.default_uom + + @fields.depends('conversion_rule', 'input_quantity') + def on_change_with_output_quantity(self, name=None): + if self.input_quantity is not None and self.conversion_rule: + return self.conversion_rule.convert(self.input_quantity) + + @fields.depends('output_product') + def on_change_with_output_unit(self, name=None): + if self.output_product: + return self.output_product.default_uom + + @fields.depends( + 'input_product', 'output_product', 'conversion_rule', + methods=['on_change_with_output_quantity']) + def set_conversion_rule(self): + pool = Pool() + Rule = pool.get('stock.conversion.rule') + if self.input_product and self.output_product: + rule = self.conversion_rule + if (not rule + or rule.input_product != self.input_product + or rule.output_product != self.output_product): + try: + self.conversion_rule, = Rule.search([ + ('input_product', '=', self.input_product), + ('output_product', '=', self.output_product), + ], limit=1) + except ValueError: + pass + self.output_quantity = self.on_change_with_output_quantity() + + @fields.depends(methods=['set_conversion_rule']) + def on_change_input_product(self): + self.set_conversion_rule() + + @fields.depends(methods=['set_conversion_rule']) + def on_change_output_product(self): + self.set_conversion_rule() + + @fields.depends('conversion_rule') + def on_change_conversion_rule(self): + if self.conversion_rule: + self.input_product = self.conversion_rule.input_product + self.output_product = self.conversion_rule.output_product + + @classmethod + def default_state(cls): + return 'draft' + + @property + def input_moves(self): + moves = [] + for move in self.moves: + if move.from_location == self.location: + moves.append(move) + return moves + + @property + def output_moves(self): + moves = [] + for move in self.moves: + if move.to_location == self.location: + moves.append(move) + return moves + + def _move(self, type): + pool = Pool() + Move = pool.get('stock.move') + move = Move(**Move.default_get(with_rec_name=False)) + move.origin = self + move.company = self.company + move.effective_date = self.date + if type == 'input': + move.product = self.input_product + move.unit = self.input_unit + move.quantity = self.input_quantity + move.from_location = self.location + move.to_location = self.warehouse.conversion_location + elif type == 'output': + move.product = self.output_product + move.unit = self.output_unit + move.quantity = self.output_quantity + move.from_location = self.warehouse.conversion_location + move.to_location = self.location + move.currency = self.company.currency + else: + raise ValueError(f"unsupported type {type}") + move.unit_price_required = move.on_change_with_unit_price_required() + if move.unit_price_required: + if type == 'input': + move.unit_price = move.product.cost_price + elif type == 'output': + cost_price = ( + Decimal(str(self.input_quantity)) + * self.input_product.cost_price) + cost_price /= Decimal(str(self.output_quantity)) + move.unit_price = round_price(cost_price) + if self.company: + move.currency = self.company.currency + else: + move.unit_price = None + move.currency = None + return move + + @classmethod + def preprocess_values(cls, mode, values): + pool = Pool() + Configuration = pool.get('stock.configuration') + config = Configuration(1) + values = super().preprocess_values(mode, values) + if mode == 'create': + if not values.get('number'): + values['number'] = config.conversion_sequence.get() + return values + + @classmethod + def copy(cls, conversions, default=None): + default = default.copy() if default is not None else {} + default.setdefault('number') + default.setdefault('done_by') + default.setdefault('moves') + return super().copy(conversions, default=default) + + @classmethod + @ModelView.button + @Workflow.transition('done') + @set_employee('done_by') + def do(cls, conversions): + pool = Pool() + Date = pool.get('ir.date') + Move = pool.get('stock.move') + Lang = pool.get('ir.lang') + lang = Lang.get() + + for company, c_conversions in groupby( + conversions, key=lambda c: c.company): + with Transaction().set_context(company=company.id): + today = Date.today() + cls.write([c for c in c_conversions if not c.date], { + 'date': today, + }) + + moves = [] + for conversion in conversions: + moves.append(conversion._move('input')) + moves.append(conversion._move('output')) + Move.save(moves) + + for conversion in conversions: + if not Move.assign_try(conversion.input_moves, with_childs=False): + quantity = sum( + m.quantity for m in conversion.input_moves + if m.state not in ['assigned', 'done', 'cancelled']) + raise ConversionError(gettext( + 'stock_conversion.msg_stock_conversion_missing_qty', + conversion=conversion.rec_name, + location=conversion.location.rec_name, + product=conversion.input_product.rec_name, + quantity=lang.format_number_symbol( + quantity, conversion.input_unit))) + Move.do(moves) + cls.set_cost(conversions) + + @classmethod + @ModelView.button + @Workflow.transition('cancelled') + def cancel(cls, conversions): + pool = Pool() + Move = pool.get('stock.move') + Move.cancel([m for c in conversions for m in c.moves]) + + @property + def cost(self): + return round_price(sum( + m.cost_price * Decimal(str(m.internal_quantity)) + for m in self.input_moves + if m.cost_price and m.state != 'cancelled')) + + @classmethod + def set_cost_from_moves(cls): + pool = Pool() + Move = pool.get('stock.move') + conversions = set() + moves = Move.search([ + ('conversion_cost_price_updated', '=', True), + ('origin', 'like', 'stock.conversion,%'), + ], + order=[('effective_date', 'ASC')]) + for move in moves: + if move.origin not in conversions: + cls.__queue__.set_cost([move.origin]) + conversions.add(move.origin) + Move.write(moves, {'conversion_cost_price_updated': False}) + + @classmethod + def set_cost(cls, conversions): + pool = Pool() + Move = pool.get('stock.move') + UoM = pool.get('product.uom') + + moves = [] + for conversion in conversions: + cost = conversion.cost + quantity = sum( + m.internal_quantity for m in conversion.output_moves + if m.state != 'cancelled' + and m.product == conversion.output_product) + if quantity: + unit_price = cost / Decimal(str(quantity)) + else: + unit_price = Decimal(0) + for move in conversion.output_moves: + if move.product == conversion.output_product: + m_unit_price = round_price(UoM.compute_price( + move.product.default_uom, unit_price, move.unit)) + else: + m_unit_price = Decimal(0) + if (move.unit_price_required + and (move.unit_price != m_unit_price + or move.currency != conversion.company.currency)): + move.unit_price = m_unit_price + move.currency = conversion.company.currency + moves.append(move) + Move.save(moves) + + +class Move(metaclass=PoolMeta): + __name__ = 'stock.move' + + conversion_cost_price_updated = fields.Boolean( + "Conversion Cost Price Updated", readonly=True) + + @classmethod + def __setup__(cls): + super().__setup__() + cls._allow_modify_closed_period.add('conversion_cost_price_updated') + + @classmethod + def _get_origin(cls): + return [*super()._get_origin(), 'stock.conversion'] + + @classmethod + def on_modification(cls, mode, moves, field_names=None): + pool = Pool() + Conversion = pool.get('stock.conversion') + super().on_modification(mode, moves, field_names=field_names) + if mode == 'write' and 'cost_price' in field_names: + cls.write( + [m for m in moves + if m.state == 'done' + and isinstance(m.origin, Conversion)], + {'conversion_cost_price_updated': True}) diff --git a/modules/stock_conversion/stock.xml b/modules/stock_conversion/stock.xml new file mode 100644 index 0000000000..21e80efdd2 --- /dev/null +++ b/modules/stock_conversion/stock.xml @@ -0,0 +1,164 @@ + + + + + + stock.configuration + + stock_configuration_form + + + + Stock Conversion + + + + + + + + stock.location + + stock_location_form + + + + stock.conversion.rule + form + stock_conversion_rule_form + + + + stock.conversion.rule + tree + stock_conversion_rule_list + + + + stock.conversion.rule + + + + + + + + stock.conversion.rule + + + + + + + + + stock.conversion + tree + stock_conversion_list + + + + stock.conversion + form + stock_conversion_form + + + + Conversions + stock.conversion + + + + + + + + + + + + + + Draft + + + + + + + All + + + + + + + + User in companies + stock.conversion + + + + + + + + + stock.conversion + + + + + + + stock.conversion + + + + + + + + + stock.conversion + cancel + Cancel + Are your sur you want to cancel the conversion? + + + + stock.conversion + do + Do + + + + + Stock Conversion + + + + + Conversion + CONV + production + + + + + + + stock.conversion|set_cost_from_moves + + days + + + diff --git a/modules/stock_conversion/tests/__init__.py b/modules/stock_conversion/tests/__init__.py new file mode 100644 index 0000000000..4effdfa4a2 --- /dev/null +++ b/modules/stock_conversion/tests/__init__.py @@ -0,0 +1,2 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. diff --git a/modules/stock_conversion/tests/scenario_stock_conversion.rst b/modules/stock_conversion/tests/scenario_stock_conversion.rst new file mode 100644 index 0000000000..24f82aa329 --- /dev/null +++ b/modules/stock_conversion/tests/scenario_stock_conversion.rst @@ -0,0 +1,133 @@ +========================= +Stock Conversion Scenario +========================= + +Imports:: + + >>> from decimal import Decimal + + >>> from proteus import Model + >>> from trytond.modules.company.tests.tools import create_company + >>> from trytond.tests.tools import activate_modules, assertEqual, assertIsNotNone + +Activate modules:: + + >>> config = activate_modules('stock_conversion', create_company) + + >>> Inventory = Model.get('stock.inventory') + >>> Location = Model.get('stock.location') + >>> Product = Model.get('product.product') + >>> ProductTemplate = Model.get('product.template') + >>> ProductUom = Model.get('product.uom') + >>> StockConversion = Model.get('stock.conversion') + +Create products:: + + >>> unit, = ProductUom.find([('name', '=', "Unit")]) + + >>> template_box = ProductTemplate() + >>> template_box.name = "Product Box" + >>> template_box.default_uom = unit + >>> template_box.type = 'goods' + >>> template_box.save() + >>> product_box, = template_box.products + >>> product_box.cost_price = Decimal('50.0000') + >>> product_box.save() + + >>> template = ProductTemplate() + >>> template.name = "Product" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.save() + >>> product, = template.products + +Define a conversion rule:: + + >>> conversion_rule = product_box.conversion_rules.new() + >>> conversion_rule.input_quantity = 1 + >>> assertEqual(conversion_rule.input_unit, unit) + >>> conversion_rule.output_product = product + >>> conversion_rule.output_quantity = 6 + >>> assertEqual(conversion_rule.output_unit, unit) + >>> product_box.save() + >>> conversion_rule, = product_box.conversion_rules + +Setup an inventory:: + + >>> storage, = Location.find([('code', '=', 'STO')], limit=1) + + >>> inventory = Inventory() + >>> inventory.location = storage + >>> inventory_line = inventory.lines.new(product=product_box) + >>> inventory_line.quantity = 100 + >>> inventory.click('confirm') + >>> inventory.state + 'done' + +Try to convert without enough quantity in stock:: + + >>> conversion = StockConversion() + >>> conversion.location = storage + >>> conversion.input_product = product_box + >>> conversion.input_quantity = 120 + >>> conversion.output_product = product + >>> assertEqual(conversion.conversion_rule, conversion_rule) + >>> conversion.output_quantity + 720.0 + >>> conversion.save() + >>> assertIsNotNone(conversion.number) + + >>> conversion.click('do') + Traceback (most recent call last): + ... + ConversionError: ... + +Change converted quantity for the stock:: + + >>> conversion.input_quantity = 10 + >>> conversion.output_quantity + 60.0 + >>> conversion.click('do') + >>> conversion.state + 'done' + >>> len(conversion.moves) + 2 + >>> input_move, = [m for m in conversion.moves if m.product == product_box] + >>> input_move.cost_price + Decimal('50.0000') + >>> output_move, = [m for m in conversion.moves if m.product == product] + >>> output_move.unit_price + Decimal('8.3333') + +Check stock quantities:: + + >>> with config.set_context(location=storage.id): + ... product_box = Product(product_box.id) + ... product = Product(product.id) + >>> product_box.quantity + 90.0 + >>> product.quantity + 60.0 + +Cancel conversion:: + + >>> conversion.click('cancel') + >>> conversion.state + 'cancelled' + +Check stock quantities:: + + >>> product_box.reload() + >>> product_box.quantity + 100.0 + >>> product.reload() + >>> product.quantity + 0.0 + +Check conversion rule modification is forbidden once used:: + + >>> conversion_rule.input_quantity = 2 + >>> conversion_rule.save() + Traceback (most recent call last): + ... + AccessError: ... diff --git a/modules/stock_conversion/tests/test_module.py b/modules/stock_conversion/tests/test_module.py new file mode 100644 index 0000000000..df331852dc --- /dev/null +++ b/modules/stock_conversion/tests/test_module.py @@ -0,0 +1,11 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from trytond.tests.test_tryton import ModuleTestCase + + +class StockConversionTestCase(ModuleTestCase): + "Test Stock Conversion module" + module = 'stock_conversion' + + +del ModuleTestCase diff --git a/modules/stock_conversion/tests/test_scenario.py b/modules/stock_conversion/tests/test_scenario.py new file mode 100644 index 0000000000..dc1d23e7e5 --- /dev/null +++ b/modules/stock_conversion/tests/test_scenario.py @@ -0,0 +1,8 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +from trytond.tests.test_tryton import load_doc_tests + + +def load_tests(*args, **kwargs): + return load_doc_tests(__name__, __file__, *args, **kwargs) diff --git a/modules/stock_conversion/tox.ini b/modules/stock_conversion/tox.ini new file mode 100644 index 0000000000..c38fcae4aa --- /dev/null +++ b/modules/stock_conversion/tox.ini @@ -0,0 +1,24 @@ +[tox] +envlist = {py310,py311,py312,py313,py314}-{sqlite,postgresql} + +[testenv] +changedir = {env_site_packages_dir} +extras = test +commands = + coverage run --rcfile={toxinidir}/tox.ini --source=trytond.modules.stock_conversion --omit=*/tests/* -m xmlrunner discover -s trytond.modules.stock_conversion {posargs} +commands_post = + coverage report --rcfile={toxinidir}/tox.ini + coverage xml --rcfile={toxinidir}/tox.ini -o {package_root}/coverage.xml +deps = + coverage + unittest-xml-reporting + postgresql: psycopg[pool,binary] >= 3 +passenv = * +setenv = + sqlite: TRYTOND_DATABASE_URI={env:SQLITE_URI:sqlite://} + postgresql: TRYTOND_DATABASE_URI={env:POSTGRESQL_URI:postgresql://} + sqlite: DB_NAME={env:DB_NAME::memory:} + postgresql: DB_NAME={env:DB_NAME:test} + +[coverage:run] +relative_files = true diff --git a/modules/stock_conversion/tryton.cfg b/modules/stock_conversion/tryton.cfg new file mode 100644 index 0000000000..e3b9136874 --- /dev/null +++ b/modules/stock_conversion/tryton.cfg @@ -0,0 +1,21 @@ +[tryton] +version=8.1.0 +depends: + ir + product + stock +xml: + product.xml + stock.xml + message.xml + +[register] +model: + ir.Cron + product.Product + stock.Configuration + stock.ConfigurationSequence + stock.Location + stock.StockConversionRule + stock.StockConversion + stock.Move diff --git a/modules/stock_conversion/view/product_form.xml b/modules/stock_conversion/view/product_form.xml new file mode 100644 index 0000000000..a6f4dcc41d --- /dev/null +++ b/modules/stock_conversion/view/product_form.xml @@ -0,0 +1,10 @@ + + + + + + + + + diff --git a/modules/stock_conversion/view/stock_configuration_form.xml b/modules/stock_conversion/view/stock_configuration_form.xml new file mode 100644 index 0000000000..e0f640f1f8 --- /dev/null +++ b/modules/stock_conversion/view/stock_configuration_form.xml @@ -0,0 +1,10 @@ + + + + + + + diff --git a/modules/stock_conversion/view/stock_conversion_form.xml b/modules/stock_conversion/view/stock_conversion_form.xml new file mode 100644 index 0000000000..0e7efb50d6 --- /dev/null +++ b/modules/stock_conversion/view/stock_conversion_form.xml @@ -0,0 +1,49 @@ + + +
+